ADCON T E L E M E T R Y Base Station Telemetry Gateway A840 and Wireless Modem A440 User Guide SMART WIRELESS SOLUTIONS
ADCON T E L E M E T R Y A D C O N T E L E M E T RY A G INKUSTRASSE 24 A-3400 KLOSTERNEUBURG A U S T R I A TEL: +43 (2243) 38 280-0 FAX: +43 (2243) 38 280-6 h t t p : / / w w w. a d c o n . a t ADCON TELEMETRY INC 1 0 0 1 YA M A T O R O A D SUITE #305, BOCA RATON F L 3 3 4 3 1 U S A TEL: +1 (561) 989-5309 FAX: +1 (561) 989-5310 h t t p : / / w w w. a d c o n . c o m A D C O N T E L E M E T RY S R L BD.
Table of Contents Chapter 1. Introduction _________________________________7 Chapter 2.
Changing Passwords ________________________________ Losing a Password __________________________________ Software Upgrades__________________________________ Upgrading the bootloader ________________________ To upgrade the system ___________________________ 19 20 21 21 22 Operations at the Application Level ______________________ Commands Accepted by the emu3ap Emulator_________ Configuration Commands____________________________ INSERT _________________________________________ REPLACE ___________________
B ______________________________________________ RB _____________________________________________ RBLIST _________________________________________ RSET ___________________________________________ Error Messages_____________________________________ Frame Types _______________________________________ The A730MD frames _____________________________ Type 9__________________________________________ The A720 (addIT) Frames _________________________ Type 38 ________________________________________ The A723 (add
Chapter 1. Introduction This manual describes the use of the A840 Telemetry Gateway and A440 Wireless Modem combination. Due to their general nature, either unit can also be used independently, but such uses are beyond the scope of this manual. The manual teaches you how to use the telemetry gateway and the wireless modem as a base station for an Adcon wireless network.
CHAPTER 1 Introduction provides the telemetry gateway with at least 24 hours of operation without mains power. The A440 Wireless Modem is a low-power, narrow-band data transceiver operating in the 70-cm band. It implements Adcon’s lowspeed radio protocol and is therefore compatible with all Adcon RTUs. In addition the A440 modem supports a high-speed wireless protocol that will be used by future Adcon devices. The A440 has an 8-bit Flash-based microcontroller that can also be upgraded in the field.
Chapter 2. System Setup Package Contents Before proceeding to the installation of your base station, first verify that you received all of the following components: • • • • • • • The A840 Telemetry Gateway The A440 Wireless Modem The 30 m (100 ft) connection cable between the A840 and the A440 devices A power cord A twisted-pair ethernet cable (not used at this time, but included in the package) A serial null modem cable A whip antenna If any of the above items is missing, contact your dealer.
CHAPTER 2 System Setup Before proceeding with the installation, take a moment to plan your network. First, it is essential to realize the importance of selecting a good location for the base station. You must consider several factors, some of them quite contradictory, when you select this location: • • • • • • From a radio perspective, the height of the receiving antenna is essential: the higher the antenna, the greater the range of communication.
CHAPTER 2 Installation tion. Some typical examples of the achieved distances, under various conditions, are shown in Table 1. Table 1. Communication Between Base Station and A730MD/A733 Receiving antenna height Typical distances achieved 6 m (18 ft) 5 km (3 miles) 10 m (31 ft) 8 km (5 miles) 20 m (62 ft) 16 km (10 miles) 30 m (92 ft) 24 km (15 miles) The addIT RTU, however, uses low-power technology and was not designed to communicate over large distances.
CHAPTER 2 System Setup To use the telemetry gateway and wireless modem, you need to do the following: • • • Install the outdoor unit. Install the indoor unit. Initialize the base station. Installing the Outdoor Unit Install the outdoor unit on the rooftop of the house where the base station will be located or on top of a nearby mast. After unpacking the components of the base station, identify the device marked “Wireless Modem A440.
CHAPTER 2 Installation Figure 1. Outdoor Unit Installation Note: The cable supplied to connect the outdoor unit to the A840 Telemetry Gateway is 30 m long and cannot be extended. Extending the cable will make your wireless modem inoperable due to the voltage loss on the additional cable length. You can, however, install an outdoor antenna and use a coaxial cable (max. 30 m) between the A440 unit and the antenna, giving you a total of 60 m distance between the indoor unit and the outdoor antenna.
CHAPTER 2 System Setup Figure 2. Indoor Unit Installation If you plan to use the base station as a standalone unit (that is, without a computer), you need a telephone line that must be connected to the modem jack of the A840 gateway. Note: Before you operate the base station, Adcon recommends that you let the internal battery charge to a level where it can sustain the operation of the gateway.
CHAPTER 2 LED Indicators If this is a new installation, you need to install the RTUs in the field and configure them in addVANTAGE. Refer to the addVANTAGE software and respective RTU user manuals for additional details. LED Indicators The A840 Telemetry Gateway has five LED indicators on its panel. The indicators have a different significance based on whether the device is operating in the usual Linux mode or in hermit mode (for upgrading software and in other unusual circumstances).
CHAPTER 2 System Setup PWR Table 2 summarizes the PWR LED significance: Table 2. The PWR LED Indicator Mains PWR LED Battery Present ON unknown Not present ON 15/OFF 1 (2 sec) Full ON 8/OFF 8 (2 sec) Half full ON 1/OFF 15 (2 sec) Almost empty When the mains is not present, the PWR LED blinks at a 2-second rate. The on/off state of the blink shows you how much power is left in the battery.
Chapter 3. Advanced Functions This chapter describes some advanced functions that you can perform on your new base station. If you find that certain functions are too complicated or you don’t understand them, your distributor can do what you need for you.
CHAPTER 3 Advanced Functions Stopping and Starting the telemetry gateway The telemetry gateway has a built-in rechargeable battery that is software controlled. If for some reason you need to stop the telemetry gateway (for example, shipping for service or storing for longer time spans), you need to shut it down by switching off the battery internally, then unplugging the power cable. Proceed as follows: 1.
CHAPTER 3 Administrative Tasks at the System Level To start the unit, plug the mains cable into the power outlet. After the boot procedure finishes (which takes about 20 seconds), the unit is fully operational. Changing Passwords For security reasons you might want to change the password of your gateway. The unit comes from the factory with only two users: root and adv. The root user is intended only for administrative tasks, while adv is used by the addVANTAGE software.
CHAPTER 3 Advanced Functions hardware and softwre must be identical, or addVANTAGE will not be able to download data from the base station. Note: Only addVANTAGE 3.45 is compatible with the A840 Telemetry Gateway. If your software is not up to date (check the File–>About menu in addVANTAGE), download the latest update from Adcon’s web server (http://www.adcon.com). The updater will update only version 3.40, so if you have an older version, you’ll need to contact your Adcon representative.
CHAPTER 3 Administrative Tasks at the System Level stty igncr cd /etc /etc/rc.sysinit 5. 6. Now you can change the root password as described in Step 2 through Step 4 of “Changing Passwords” on page 19. After you get the “Password changed” message, type exec /bin/init. The Linux login prompt is displayed. Now you can log in with your new root password. Software Upgrades Both components of your base station have their software stored in Flash EEPROMs.
CHAPTER 3 Advanced Functions 7. 8. 9. The system waits for a file to be sent using the Y-modem protocol. Configure your terminal program to send via the Ymodem protocol, switch your communication program to Send, and send the .hmt file from your computer. After a series of messages, the system asks for confirmation. Press Y. The bootloader will now be replaced. Restart the gateway by typing linux After Linux finishes booting, the gateway is again ready for use. To upgrade the system 1. 2. 3. 4.
CHAPTER 3 Operations at the Application Level 10. After a series of messages, the system asks for confirmation. Press Y. The system software will now be replaced. The procedure can take several minutes. Note: Do not switch the system off during this time! 11. When the procedure is finished and you see the hermit> prompt again, restart the gateway by typing linux 12. While the system is booting, return your terminal’s speed to 19200. After Linux finishes booting, the gateway is again ready for use.
CHAPTER 3 Advanced Functions • • • • Configuration (including the SET commands) Data Administrative Direct radio Configuration Commands This category includes commands that configure various parameters of the emu3ap software. INSERT DESCRIPTION Inserts a new device in the gateway’s internal list. PARAMETERS The device ID number. RETURNS OK or an error message. REMARKS A device is a remote measuring station (for example, A730MD, A720, A723, or A733).
CHAPTER 3 Operations at the Application Level PARAMETERS The device ID. RETURNS OK or an error message. REMARKS None. EXAMPLE delete 2046 OK ROUTE DESCRIPTION Sets a route for the target device. PARAMETERS The device ID and the route description (composed of the routing devices’ IDs). To clear a route, provide only the target device ID (in other words, a null route). RETURNS OK or an error message. REMARKS The ROUTE command updates the internal descriptors for the specified target device.
CHAPTER 3 Advanced Functions route 2333 OK MASTER DESCRIPTION Set/resets the master flag of a specific device. PARAMETERS The device ID and the flag value (on/off). RETURNS OK or an error message. REMARKS When a station has a master flag set, the gateway uses that station for date/time synchronization. It is important to understand that each remote station has an internal real-time clock, used to stamp the stored data.
CHAPTER 3 Operations at the Application Level of the SET commands have a get form, in which only the subcommand is typed and the emu3ap application returns the requested information. SET TIME DESCRIPTION Sets the internal real-time clock of the emu3ap. PARAMETERS The time in the following format: dd/mm/yyyy hh:mm:ss (24-hour clock format). RETURNS OK or an error message.
CHAPTER 3 Advanced Functions SET OWNID This command is deprecated in emu3ap. It has been included for compatibility purposes, but always returns OK. The radio network ID is programmed at the factory and resides in the A440 Wireless Modem (as for all RTUs, the network ID is the serial number printed on the RTU’s label). SET SLOT DESCRIPTION Sets the request rate in seconds (the default is 900, or 15 minutes).
CHAPTER 3 Operations at the Application Level delay Interruption delay is 7200 seconds OK SET ECHO/NOECHO This command is deprecated in emu3ap. It has been included for compatibility purposes, but always returns OK. The behavior of the emu3ap software is that ECHO is always on. You can also PING and REQUEST data even for devices that are not shown in the devices list. Data Commands This category included commands that return data from the remote stations.
CHAPTER 3 Advanced Functions 8110010075021905641002361509DECAF8000056AA800F18004F 02AA800F010055021905641011361509D8C1F8000056AA7D0F16 004D02AA7E0F010055021905641020361509D2BBF8000056A87F 0F13004002A8800F01004602190564102F361509DBB2F8000056 A97E0F19005102A97F0F010059021905641102361509CAB9F800 0056A97C0F1E004501A97C0F01004E021905641111361509C6B1 F8000055A6840F1A001F01A6840F010020011905641120361509 D7C3F8000055A4870F11001101A4870F01001101190564112F36 1509D1C1F8000055A4870F13001601A4870F0000170119056412 0
CHAPTER 3 Operations at the Application Level Administrative Commands This category describes the commands that return certain status information. VER DESCRIPTION Returns the current version of the emu3ap software. PARAMETERS None. RETURNS OK or an error message. REMARKS None. EXAMPLE ver Adcon Telemetry emu3ap, version 3.02 OK TYPE DESCRIPTION Returns the hardware platform of the emu3ap. PARAMETERS None. RETURNS OK or an error message. REMARKS None.
CHAPTER 3 Advanced Functions UPTIME DESCRIPTION Returns the amount of time the A440 Wireless Modem connected to the gateway has been operational. PARAMETERS None. RETURNS The amount of time the wireless modem has been in operation. REMARKS None. EXAMPLE uptime Up 230 day(s), 10 hour(s), 14 minute(s) OK NOP This command is deprecated in emu3ap. It has been included for compatibility purposes, but always returns OK. The A840 Telemetry Gateway’s software is stored in its internal Flash EEPROM.
CHAPTER 3 Operations at the Application Level The direct radio commands return by default results such as OK or a specific error number. Complete details about the direct radio commands can be found in the user manuals for the respective devices (A730MD, A720, A723, and A733). PING DESCRIPTION Returns information about the specified device such as the RF levels, the date and time of the internal real-time clock of the station, the software version in the station, and the number of reserved bytes.
CHAPTER 3 Advanced Functions Time Fri Jun 2 16:24:15 2000 Ver 22, clk 00, stk 00, cop 00 Uptime 396 day(s), 22 hour(s), 33 minute(s) Batt 6.9 volts, internal temp 31 Celsius Settings: RSSI 58, PMP 65 72, Slot 900 3 OK ping 9471 Type A733 Dev 9471: incoming RF 255, outgoing RF 166, Pout: 182 Time Fri Jun 2 16:27:12 2000 Ver 0F, clk 00, stk 00, cop 05 Uptime 143 day(s), 7 hour(s), 44 minute(s) Batt 7.
CHAPTER 3 Operations at the Application Level 04 01 OK Note: This is a forced time initialization of an RTU. In practice it is not needed, because the gateway does it automatically when it is itself initialized by means of the time command (see “SET TIME” on page 27).
CHAPTER 3 Advanced Functions PORT DESCRIPTION Acts upon the I/O ports of a remote device. PARAMETERS The RTU’s ID, the byte code, and parameters (for some forms of the command). All parameters are in decimal form (pay particular attention to the byte code because it must be translated to decimal). RETURNS Status result, depends on command. REMARKS This command is currently supported only by the A720 (series 2) and A723 (series 3) addITs and A733 addWAVE RTUs.
CHAPTER 3 Operations at the Application Level From From From From From OK 2646: incoming RF 188, outgoing RF 141 9474: incoming RF 255, outgoing RF 255 2419: incoming RF 255, outgoing RF 254 2464: incoming RF 255, outgoing RF 255 10843: incoming RF 255, outgoing RF 255 RB DESCRIPTION Forces the specified remote device to issue a broadcast request frame that forces all listening devices to answer. By subsequently using the RBLIST command, a list of all the stations heard from can be retrieved.
CHAPTER 3 Advanced Functions RSET DESCRIPTION Issues remote SET commands, which set parameters in the RTUs. Not all the RTUs support these commands, most notably the A730MD devices don’t support it. PARAMETERS The ID of the remote, the set-command, and its parameters. RETURNS OK or an error message. REMARKS Currently only the A720 (series 2), A723 (series 3) addIT, and the A733 addWAVE devices support this command.
CHAPTER 3 Operations at the Application Level Frame Types The information in this section is intended to programmers writing their own routines to interface with the A840 Telemetry Gateway. The A840/A440 combination can communicate with various types of RTUs. The distinctive frame type of each RTU makes no difference to the application software on the A840. The software stores the frame in the memory and retrieves it when needed—whatever its length is.
CHAPTER 3 Advanced Functions }; BYTE Analog6; BYTE Analog7; BYTE Analog8; BYTE Analog9; BYTE Analog10; BYTE Analog11; BYTE Analog12; BYTE Analog13; BYTE Analog14;
CHAPTER 3 Operations at the Application Level DESCRIPTION All values are 8 bits and must be converted accordingly, depending on the sensor connected. Figure 4 shows the placement of various inputs on the connectors.
CHAPTER 3 Advanced Functions The RF level is nonlinear and results from a table (which you can get from Adcon as an ASCII file). The value of the battery can be computed as follows: BatteryLevel • 20 Batt [ V ] = ---------------------------------------------255 The digibyte is essentially the reflection of several inputs or internal status bits on the A730MD; its structure is described below: B7 B6 S.C. AUX:4 B4 B3 RAI:3 RAI:4 B5 N.U. S.C. = Solar Cell status B2 B1 B0 AUX:2 AUX:3 AUX:5 N.
CHAPTER 3 Operations at the Application Level DESCRIPTION All values are 8 bits and must be converted accordingly, depending on the sensor connected. Figure 5 shows the placement of various inputs on the connectors. Power A720 Analog4 Analog5 DIG1 7 6 5 Power Analog1 Analog2 DIG0 7 1 6 5 2 4 3 PulseCounter1 Ground Analog6 1 2 4 3 PulseCounter0 Ground Analog3 I/O B I/O A Figure 5.
CHAPTER 3 Advanced Functions Also, the A723 contains two 16-bit pulse counters, that is, it has more data to send. Due to the limited space available and to minimize the radio traffic, the frames are slightly compressed, in that six 12-bit values are packed in 9 bytes. Type 39 SIZE 22 (including the type byte).
CHAPTER 3 Operations at the Application Level Note: Only Analog1 to Analog6 are packed; the 16-bit Pulse Counters are not. Figure 7 shows the placement of various inputs on the connectors. Power A723 Analog1 Analog2 DIG0 7 6 5 Power Analog4 Analog5 DIG1 7 1 6 5 2 4 3 PulseCounter0 Ground Analog3 1 2 4 3 PulseCounter1 Ground Analog6 I/O B I/O A Figure 7. A723 Connector Inputs The RF level is nonlinear and results from a table (which you can get from Adcon as an ASCII file).
CHAPTER 3 Advanced Functions Type 37 SIZE 31 (including the type byte). FORMAT struct tlg_type37 { BYTE RF_LevelIn; BYTE RF_LevelOut; BYTE DigiByte; WORD PulseCounter0; WORD PulseCounter1; WORD PulseCounter2; WORD PulseCounter3; BYTE BatteryLevel; BYTE Analog[18]; }; DESCRIPTION The analog values are 12 bits and must be converted accordingly, depending on the sensor connected, while the pulse counters are 16-bit values. Only the RF and battery levels are 8-bit values.
CHAPTER 3 Operations at the Application Level Figure 9 show the placement of various inputs on the connectors. Power A733 Analog1 Analog2 DIG0 7 6 5 Power 1 Analog3 7 6 5 Power Analog6 Analog10 Analog11 DIG3 1 7 6 5 2 4 3 PulseCounter2 Ground 2 4 3 I/O B Analog7 Analog8 DIG2 1 PulseCounter1 Ground I/O A Power 7 6 5 2 4 3 PulseCounter0 Ground Analog4 Analog5 DIG1 1 2 4 3 PulseCounter3 Ground Analog9 Analog12 I/O D I/O C Figure 9.
CHAPTER 3 Advanced Functions Frame Parsing Example To better understand how the retrieved frames must be processed, this section provides an example of such processing. Let’s suppose that we used the GETBLOCK command and retrieved a block of frames of type 37. After parsing the block, we separate it into individual frames as described in “GETBLOCK” on page 29. Because all the frames are treated identically, we will show you how to interpret only one of them from the block.
CHAPTER 3 Operations at the Application Level assume that a temperature sensor is connected to the Analog7 input. Then: 2669 u100 Temp [ °C ] = ------------------------- – 40 = 25.17 4095 Note that 2669 is A6D converted to decimal while the -40 was necessary because the standard Adcon temperature sensor has a range from -40 to 60 ºC. Similarly, the battery level can be computed as follows: 89 u20 Batt [ V ] = ---------------- = 6.
CHAPTER 3 Advanced Functions