Monnit Serial MODBUS Gateway
Contents
1. b As a condition to Monnit s obligations under the immediately preceding paragraphs Customer shall return Products to be examined and replaced to Monnit s facilities in shipping cartons which clearly display a valid RMA number provided by Monnit Customer acknowledges that replacement products may be repaired refurbished or tested and found to be complying Customer shall bear the risk of loss for such return shipment and shall bear all shipping costs Monnit shall deliver replacements for Products determined by Mon nit to be properly returned shall bear the risk of loss and such costs of shipment of repaired products or replacements and shall credit Customer s reasonable costs of shipping such returned Products against future purchases c Monnit s sole obligation under the warranty described or set forth here shall be to repair or replace non conforming products as set forth in the immediately preceding paragraph or to refund the documented purchase price for non conforming Products to Customer Mon nit s warranty obligations shall run solely to Customer and Monnit shall have no obligation to customers of Customer or other users of the Products Limitation of Warranty and Remedies THE WARRANTY SET FORTH HEREIN IS THE ONLY WARRANTY APPLICABLE TO PRODUCTS PURCHASED BY CUSTOMER ALL OTHER WARRANTIES EXPRESS OR IMPLIED INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE A2. 99 41596 The format of these records are Field Name Offset Description TIME_H 0 The System Time that the following data was posted to the FRR A write to offset O will zero out TIME L 1 the entire record 28 DATA _H 2 Data generated by wireless device The format for this data can be found in the Monnit Serial MOD DATA L 3 BUS Sensor Application Definition document Ref 7 Wireless Device Registers This section defines the location and function of all the remotely located registers available for access through the MODBUS inter face Every wireless device as been allotted 100 possible regis ters The table below enumerates the address allotment ADDRESS FORMULA 50000 100 WDL_ INDEX Example Register Name Address Register Name Address WDR 0 50000 WDR 99 59900 The following table represents the supported Wireless Device Registers They contain the pertinent data and configurations populated from the remote device Through these registers a user is capable of interpreting additional data setting new con figurations and sending other control related messages CNTL to the remote device Unknown or unused values are defaulted to 0x0000 Field Name Offset Description ID_H 0 Wireless device s globally unique identifier Combine a ID_H and ID_L to form full Ulnt32 ID L 1 number READ ONLY VER_MAJOR 2 Wireless device s firmware version number Regis
3. SMG 5 Wire Connector Red 4 5 36VDC Black Power ground Orange RS 232C TXD gateway s transmitter data connec tion Connect the MODBUS master s receiver RS 485 D Non inverting 485 transmitter receiver White Signal ground internally connected to power ground Green RS 232C RXD gateway s receiver data connection Connect the MODBUS master s transmitter RS 485 D Inverting 485 transmitter receiver 10 3 0 3 1 3 2 MODBUS Protocol Implementation See http modbus org docs Modbus_Application_Proto col_V1_1b pdf for details on the official protocol and func tion code The Serial MG supports 2 transmission modes RTU and ASCII MODBUS Interfaces will support the following commands FC refers to MODBUS Function Codes e FC 1 Read Coils e FC 5 Write Single Coil e FC 15 Write Multiple Coils e FC 3 Read Holding Registers e FC 6 Write Single Register e FC 16 Write Multiple Registers All other commands exceptions or other interface features are not supported Register Size MODBUS permits the use of a variety of register size spec ifications This device uses the standard 16 bit unsigned integer for its register size Additionally register data rep resentation can take the form of multi register data types i e 32 bit interger These will be specified specifically for all registers that require additional formatting Multi byte
4. Warranty Information Certifications FCC and IC MUGO03 1A www monnit com 2012 Monnit Corp 20 22 24 28 28 29 36 36 38 1 0 6 Serial MODBUS Gateway Overview The Monnit Serial MODBUS Gateway SMG acts as a data concentrator for Monnit wireless sensor networks This device allows you to connect up to 100 wireless sens ing devices per gateway to your existing serial MODBUS RS 232C and RS 485 sensing and control infrastructures Monnit has recognized the importance of using open stan dards like MODBUS allowing Monnit wireless sensors to be used in the majority of industrial applications MODBUS is often used to connect a supervisory computer with a remote terminal unit RTU in supervisory control and data acquisition SCADA systems MODBUS allows for com munication between many approximately 247 devices connected to the same wired network Therefore Monnit SMG s allows for seemingly unlimited wireless expansion of a traditional wired network A system incorporating a Monnit SMG would consists of the the following MODBUS Master PLC SCADA etc Existing RS 232C or RS 485 Infrastructure Monnit Serial MODBUS Gateway SMG Monnit Wireless Sensors RP SMA Antenna Durable Impact Resistant IP65 and NEMA Rated Enclosure 5 Wire Connection Contains FCC ID ZTL RFSC1 amp IC 9794A RFSC1 This device complies with Part 15 of the FCC Rules Operation is subject to the following two
5. cause interference and 2 this device must accept any interference including interference that may cause undesired operation of the device French Conform ment a la r glementation d Industrie Canada le pr sent metteur radio peut fonctionner avec une antenne d un type et d un gain maximal ou inf rieur approuv pour l metteur par Industrie Canada Dans le but de r duire les risques de brouillage radio lec trique l intention des autres utilisateurs il faut choisir le type d antenne et son gain de sorte que la puissance isotrope rayonn e quivalente p i r e ne d passe pas l intensit n cessaire l tablissement d une communication satisfaisante Le pr sent metteur radio IC 9794A RFSCT et IC 9794A RFUSB1 a t approuv par Industrie Canada pour fonctionner avec les types d antenne num r s ci dessous et ayant un gain admissible maximal et l imp dance requise pour chaque type d antenne Les types d antenne non inclus dans cette liste ou dont le gain est sup rieur au gain maximal indi qu sont strictement interdits pour l exploitation de l metteur Le pr sent appareil est conforme aux CNR d Industrie Canada applicables aux appareils radio exempts de licence L exploitation est autoris e aux deux conditions suivantes 1 l appareil ne doit pas produire de brouillage et 2 l utilisateur de l appareil doit accepter tout brouillage radio lectrique subi m me si le brouillage est susceptible d en
6. comprom ettre le fonctionnement MUG03 1A www monnit com 2012 Monnit Corp 39 For additional information on Monnit Wireless Sensors and Software please visit us on the web at www monnit com MONNIT Monnit Corporation 7304 South Cottonwood Suite 204 Midvale Utah 84047 www monnit com All trademarks are property of Monnit 2012 Monnit Corp All Rights Reserved MUG03 1A 8 12
7. designed gt to monitor various Water Leak O environmental conditions Monnit Serial MODBUS Gateway Specifications General Monnit APN Interface Support RFSC1 Module by Monnit Frequencies 433 868 and 900 MHz Future support for WiFi and 500 mW mod ules Antenna Connector SMA Gain 3 0 dBi Standard 3 Wire Communication Interface RS 232C RS 485 TXD OUT RXD IN and Ground Com mon D D and Ground Common Protocol Selector Switch for RS 232 and RS485 Power Input Voltage Range 5 5 36 0 VDC Minimum Current Required 100mA 500mA Recommended Mechanical Reset Feature Communication Factory Settings Reset Jumper Enclosure Durable Impact Resistant UV Stabilized Polycarbonate IP65 of IEC 529 and NEMA 1 2 4 4x 12 and 13 Rated Dimensions 179 603 x 90 678 x 41 30 mm Weight 16 ounces Environmental Operating Temperature Storage Temperature 40 to 85 C 40 to 185 F 40 to 85 C 40 to 185 F MUG03 1A www monnit com 2012 Monnit Corp 9 2 0 Connecting the Gateway Hardware This sections contains details on how to connect the Serial MODBUS Gateway SMG for testing and use The SMG has an interface protocol switch UP is RS 485 Down is RS 232C The SMG has a 5 wire connector already installed and ready for connection The table below shows the wire mapping
8. 600 115200 O O1 BR N Example Writing a value of 2 to this register will effectively change the baud rate to 9600 The COMMODE Gateway Register 40007 contains the following encoded options RTU 8 N 2 RTU 8 N 1 RTU 8 E 1 RTU 8 O 1 ASCII 7 N 2 ASCII 7 E 1 ASCII 7 O 1 O O1 BR N Example Writing a value of 2 to this register will effectively change the communication mode to RTU 8 E 1 The ADDRESS Gateway Register 40008 contains the address used by the MODBUS interface Values of 1 247 are permitted to be written Modification to these registers are applied after a power cycle or gateway reset sequence Please see Ref 4 for more information MUG03 1A www monnit com 2012 Monnit Corp 15 4 7 4 8 4 9 16 Viewing amp Modifying Gateway Time The TIME_H and TIME_L Gateway Register 40009 40010 contain a Ulnt32 representation of time in seconds If read this will report current time If written to this will set the time If this field is never set to reference any standard time format it will represent the time from last Gateway reset It is traditional to set these registers to reflect UNIX time or the number of seconds that have elapsed since January 1st 1970 However any custom reference can be used Viewing Registered Wireless Devices The WD_CNT Gateway Register 40003 contains the number of registered devices in the Wireless Device L
9. Formatting MODBUS has specified the use of Big Endian representa tion for addresses and data items This means that when a numerical quantity larger than a single byte is transmit ted the most significant byte is sent first MUG03 1A www monnit com 2012 Monnit Corp 11 3 3 3 4 3 5 12 Communication Defaults e Modbus slave ID or Modbus address 240 or OxFO e Modbus RTU 8 data bits No Parity 1 Stop bit 8 N 1 19200 baud Communication Settings Reset Jumper MUST OPEN ENCLOSURE TO ACCESS If the device s communications settings are unknown it is possible to reset the communication settings by placing a jumper on the RESET jumper position when the gateway is not powered This jumper is scanned at power up or reset e Open jumper Normal operation Wireless and MODBUS communications allowed to function e Closed jumper Communications interface reset If the jumper is detected closed the device must be power cycled with the jumper in the open position before the device is allowed to operate normally Factory Reset MUST OPEN ENCLOSURE TO ACCESS While in communication reset state if the device remains powered and the reset jumper is deliberately removed and replaced twice a factory reset will occur on the device Again the device must be power cycled with the jumper in the open position before the device is allowed to operate normally NOTE a factory reset will remove all known senso
10. MONNIT _ Monnit Wireless Sensors Serial MODBUS RTU ASCII Gateway User s Guide 2 Monnit Wireless Sensors Serial MODBUS RTU ASCII Gateway User s Guide MUG03 1A www monnit com 2012 Monnit Corp 3 Contents Serial MODBUS Gateway Overview Features Example Network Integration Monnit Serial MODBUS Gateway Specifications Connecting the Gateway Hardware MODBUS Protocol Implementation Register Size Multi byte Formatting Communication Defaults Communications Settings Reset Jumper Factory Reset Using the Gateway Coil and Register Map Verifying that the Wireless is Active Resetting the Gateway Resetting the Wireless Network Resetting to Default Communications Settings Reseting the Gateway to Factory Settings Viewing and Modifying MODBUS Communciations Viewing and Modifying Gateway Time Viewing Registered Wireless Devices Adding a Wireless Device to the Gateway Verifying Wireless Device Activity Viewing Wireless Device Data Fast Read Method Viewing Wireless Device Data Advanced Method Configuring Wireless Devices O O 10 11 11 11 12 12 13 13 14 14 14 15 16 16 17 18 19 Reference Section Ref 1 Gateway Coils Ref 2 Fast Read Exception Coils Ref 3 Wireless Device Coils Ref 4 Gateway Registers Ref 5 Wireless Device List Registers Ref 6 Fast Read Registers Ref 7 Wireless Device Registers Error Reporting Troubleshooting and Support
11. RE EXPRESSLY DISCLAIMED MONNIT S LIABIITY WHETHER IN CONTRACT IN TORT UNDER ANY WARRANTY IN NEGLIGENCE OR OTHERWISE SHALL NOT EXCEED THE PURCHASE PRICE PAID BY CUSTOMER FOR THE PRODUCT UNDER NO CIRCUMSTANCES SHALL MONNIT BE LIABLE FOR SPECIAL INDIRECT OR CONSEQUENTIAL DAM AGES THE PRICE STATED FOR THE PRODUCTS IS A CONSIDERATION IN LIMITING MONNIT S LIABILITY NO ACTION REGARDLESS OF FORM ARISING OUT OF THIS AGREEMENT MAY BE BROUGHT BY CUSTOMER MORE THAN ONE YEAR AFTER THE CAUSE OF ACTION HAS ACCRUED IN ADDITION TO THE WARRANTIES DISCLAIMED ABOVE MONNIT SPECIFICALLY DISCLAIMS ANY AND ALL LIABILITY AND WARRANTIES IMPLIED OR EXPRESSED FOR USES REQUIRING FAIL SAFE PERFORMANCE IN WHICH FAILURE OF A PROD UCT COULD LEAD TO DEATH SERIOUS PERSONAL INJURY OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE SUCH AS BUT NOT LIMITED TO LIFE SUPPORT OR MEDICAL DEVICES OR NUCLEAR APPLICATIONS PRODUCTS ARE NOT DESIGNED FOR AND SHOULD NOT BE USED IN ANY OF THESE APPLICATIONS MUG03 1A www monnit com 2012 Monnit Corp 37 Certifications United States FCC This equipment has been tested and found to comply with the limits for a Class B digital devices pursuant to Part 15 of the FCC Rules These limits are designed to provide reasonable protection against harmful interference in a residential installation This equipment generates uses and can radiate radio frequency energy and if not installed and used in accordance with the instructi
12. RR and Gateway Time Additionally if any gateway settings baud rate MODBUS address communi cation mode were modified this causes these settings to take effect Resetting the Wireless Network Write the RST_WNET Gateway Coil address 3 to TRUE The gateway will take approximately 30 seconds to complete the wireless network reset after the acknowl edging this command No serial commands will be ac knowledged during this time This operation optimizes the RF configurations for best performance and clears out all devices from the WDL The gateway will not be active until at least one wireless device is registered Resetting to Default Communications Settings Write the RST_COM Gateway Coil address 4 to TRUE After setting this coil to true a device reset com mand 4 3 must be issued or power cycling before any of the new settings will take effect Resets the baud rate mode and device ID back to defaults which are respectively 19200 RTU 8 N 1 240 Resetting the Gateway to Factory Settings Write the RST_FACTORY Gateway Coil address 5 to TRUE After setting this coil to true the device will reset automatically one second after the write coil command is acknowledged No manual reset is required 4 6 Viewing and Modifying MODBUS Communication Settings The BAUDRATE Gateway Register 40006 contains the baud rate setting Encoded options are 2400 4800 9600 19200 38400 57
13. T_TYPE_ 39 CALVAL_3_L CFG_INT_TYPE_ 40 CALVAL_4_H CFG_INT_TYPE_ 41 CALVAL_4_L CFG_TRG_TYPE_ 42 DETECT_TYPE Device Type Specific Parameter TRIGGER CFG_TRG_TYPE_ 43 TYPE DEVICE DETECT_PERIOD CFG TRG TYPE 44 Mode Control Values DETECT_COUNT See Note 1 for and explanation of these regis CFG_TRG_TYPE_ 45 ters DETECT_REARM i CFG_TRG_TYPE_ 46 DETECT_BI STABLE CNTL_COMMAND 47 CONTROL MESSAGE HANDLING Command value to send to the remote device When the COMMAND LENGTH and PAY LOAD values are prepared then a user sets the PENDING_CNTL Coil to signal the mes sage needs to be delivered to the remote unit See Note 1 for detailed explanation of possible command values 34 CNTL_LENGTH 48 CONTROL MESSAGE HANDLING Length of the payload bytes required to be delivered to device When the COMMAND LENGTH and PAY LOAD values are prepared then a user sets the PENDING_CNTL Coil to signal the mes sage needs to be delivered to the remote unit See Note 1 for detailed explanation of possible command values CNTL_PAYLOAD_0 49 CONTROL MESSAGE HANDLING CNTL PAYLOAD 1 50 The specific payload data that needs to accom CNTL_PAYLOAD_2 51 pany hecommand CNTEE FORD 394 When the COMMAND LENGTH and PAY CNTL_PAYLOAD_4 53 LOAD values are prepared then a user sets CNTL_PAYLOAD_5 54 the PENDING_CNTL Coil to signal the mes CNTL PAYLOAD 6 55 sage needs to be deli
14. access to the remote wireless device s most current exception status and data When new data is available from any Wireless device the DATA_READY gateway coil 1 is set This is a quick way to ascertain if there is any new data available in the FRR and FREC To get the exception data read the FREC WDL_SLOT This is a READ ONLY table A TRUE 1 coil represents that this specific device is currently in an exception state OFFLINE or Reporting an Alert State ADDRESS FORMULA 1000 WDL_SLOT Please see Ref 2 for more information on these coils The actual data delivered by the sensor can be quickly read by scanning the FRR Any write to the first address in the FRR will zero out the latest measurement and time These records consist of four 4 registers per wireless de vice The format of these records are TIME_H TIME_L DATA_H DATA_L ADDRESS FORMULA 41200 4 WDL_SLOT Please see Ref 6 for more information on these registers 4 12 Viewing Wireless Device Data 4 13 Advanced method For a user to see more data about a devices exception and activity status the ACTIVE coil WDC WDL_SLOT 0 and EXCEPTION coil WDC WDL_SLOT 1 can be queried ADDRESS FORMULA for WDC WDL_SLOT 2000 5 WDL_INDEX Offset Please see Ref 3 for more information on these coils For a user to see the detailed data from a device read register WOR WDL_SLOT offset 5 17 This will return last time of measurement dev
15. ch non conformance and ii the non conforming Product provided however if in its opinion Monnit cannot repair or replace on commercially reasonable terms it may choose to refund the purchase price Repair parts and replacement products may be reconditioned or new All replacement products and parts become the property of Monnit Repaired or replacement products shall be subject to the warranty if any remains originally applicable to the product repaired or replaced Customer must obtain from Monnit a Return Material Authorization Number RMA prior to returning any Products to Monnit Products returned under this Warranty must be unmodified Customer may return all Products for repair or replacement due to defects in original mate rials and workmanship if Monnit is notified within ninety 90 days of customer s receipt of the product Monnit reserves the right to repair or replace products at its own and complete discretion Customer must obtain from Monnit a Return Material Authorization Number RMA prior to returning any products to Monnit Products returned under this Warranty must be unmodified and in original packaging Monnit reserves the right to refuse warranty repairs or replacements for any products that are damaged or not in original form For products outside the ninety day warranty period repair services are available at Monnit at standard labor rates for a period of one year from the Customer s original date of receipt 36
16. conditions 1 this device may not cause harmful interference and 2 this device must accept any interference received including interference that may cause undesired operation This device has been designed to operate with an approved antenna listed on page 11 and having a maximum gain of 5 1 dBi Antennas not included in this list or having a gain greater than 5 1 dBi are strictly prohibited for use with this device The required antenna impedance is 50 ohms To reduce potential radio interference to other users the antenna type and its gain should be so chosen that the equivalent isotropically radiated power EIRP is not more than that required for successful communication FCC Approval USA Refer To Page 34 for FCC Requirements IC Approval Canada Refer To Page 35 MUGO3 1A www monnit com 2012 Monnit Corp T 8 Features e Works with Monnit 900 868 and 433MHz Sensor Networking Solutions e Communicates with MODBUS RTU ASCII Protocols e Supports RS 232C RS 485 Interfacing e 3 LED Indicators System Wired and Wireless e NEMA 4X 1P65 Rated Enclosure e RP SMA Antenna Connector Antenna Included Example Network Integration Monnit wireless sensors integrate with existing MODBUS systems allowing for additional environmental variables to be monitored NS Monnit Serial MODBUS GW Pump Valve Control Tank 3 gt Over 30 unique C voltage types of wireless sensors
17. d sufficiently to communicate to the sensor False 0 denotes that the Wireless sys tem is not active Causes for this include e No Registered Sensors DATA_READY 1 True 1 denotes that new data has been written to the FRR False 0 denotes that no new data has been written to the FRR FRR Fast Read Records a contiguous sensor data report block RST_DEVICE 2 Writing True 1 to this coil will force a device reset and cleans out all current status Always read as False 0 20 RST_WNET 3 Writing True 1 to this coil will force a Wireless Network Reset and reform the operating network setting based on CHANM and NETID in Gateway Regis ters Always read as False 0 RST_COM 4 Writing True 1 to this coil will force the ADDRESS COMMODE and BAU DRATE to defaults Always read as False 0 After setting this coil to true a device reset command must be issued before any of the new settings will take effect RST_FACTORY 5 Writing True 1 to this coil will force all settings to Factory defaults Always read as False 0 After setting this coil to true the device will automatically reset so the new settings will take effect REG_DEVICE_NOW 6 Writing True 1 to this coil will cause the register values located in WDREG_ ID_H L and WOREG_CODE1 2 3 4 5 6 to be evaluated If the values are correct the device specified will be added to the Wireless Device List at the next a
18. e input cor rectly and to add the wireless device If successful the coil write will also be successful If the codes are incorrect the coil write will return a Modbus IO error message If registering the first wireless device wait 30 seconds before adding additional devices Please see Ref 4 for more information Verifying Wireless Device Activity After a device is registered the slot or index it was reg istered at can be found by reading the WDL Once the slot is know a user can read the WDC WDL_SLOT WDR WDL_SLOT FREC WDL_SLOT and FRR WDL_ SLOT associated with the wireless device If a wireless device is registered but is not actively com municating The FREC WDL_SLOT coil will be true Ad ditionally the ACTIVE coil WDCfslot 0 will be false When a wireless device is actively communicating the ACTIVE coil WDC WDL_SLOT 0 will be true and the FREC WDL_SLOT coil will reflect the wireless device s actual exception state MUG03 1A www monnit com 2012 Monnit Corp 17 4 11 Viewing Wireless Device Data 18 Fast Read Method All Monnit Wireless Device have two pieces of commonly useful data 1 ifathreshold is breached or if the device is in and exception state 2 the acquired data measurement Using the FREC and FRR a user can quickly collect new data generated by multiple devices registered on the gate way The purpose of these coils and registers is to allow for efficient
19. evices are registered READ ONLY EXCEPTION 1 True 1 denotes that device is in an exception state data threshold breached or sensor state and the device s wireless report interval is gov erned by INTERVAL_EXCEPTION in WDR False 0 denotes that no exception state is currently noted on the wireless device There fore the wireless report interval is governed by INTERVAL_STANDARD in WDR READ ONLY PENDING_CFG 2 True 1 denotes that one or more registers have been modified from their original values located on the remote device False 0 denotes that the no local registers contain configurations that are different from the remote device Writing True 1 to this coil will cause the local configuration parameters contained in the gate way to be sent to the remote device FORCE OVERWRITE Writing False 0 to this coil will be ignored Coil resets automatically when remote configu ration changes have been confirmed It is recommended to only make 1 configuration change at a time MUG03 1A www monnit com 2012 Monnit Corp 23 PENDING_CNTL 3 True 1 denotes that a Control Message is pending delivery the the remote wireless device False 0 denotes that the no Control Message is pending delivery Writing True 1 to this coil will cause the gateway to send a CNTL message defined by the CNTL_COMMAND and CNTL_DATA_x registers in WDR Writing False 0 will cause a
20. g security code unique to a specific Monnit Wireless Device ID This value is cross referenced against the device ID reg isters to successfully add the device to the gateway s Wireless Device List Every entry is null terminated 0 or decimal value of 0 Example IMARVD CODE_1 I 0 0x4900 CODE_2 M 0 0x4D00 CODE_3 A 0 0x4100 CODE_4 R 0 0x5200 CODE_5 V 0 0x5600 CODE_6 D 0 0x4400 MUG03 1A www monnit com 2012 Monnit Corp 27 Ref 5 Wireless Device List Registers The WDL register store the serial identifier of the registered wire less devices The serial identifiers are formatted as a Ulnt32 therefore two contiguous registers must be read to extract the full value ADDRESS FORMULA 41000 2 INDEX List entries can be as follows OxFFFFFFFF EMPTY 0x00000000 ERASED Unusable until a Network Reset Otherwise a real device is registered Example Register Name Address Register Name Address WDL 0 41000 WD 99 41198 Ref 6 Fast Read Registers The purpose of these registers is to allow for efficient access to the remote wireless device s most current data Any write to the first address in the FRR will zero out the latest measurement and time These records consist of four 4 registers per wireless device ADDRESS FORMULA 41200 4 WDL_SLOT Example Record Name Address Record Name Address FRR 0 41200 FRR
21. ice battery voltage signal strength and specific status and data from the device Please see Ref 7 for more details on these registers Configuring Wireless Devices Standard Requests For a user to view and modify wireless device settings read write to register WDRIWDL_ SLOT 18 25 These registers contain information and settings relating to com munication intervals retry and failure recovery behaviors Please see Ref 7 for more details on these registers After changes are made to these registers the user can use the PENDING_CFG coil WDC WDL_SLOT 2 to check the status of these changes When this coil is true the pending changes have not been communicated with the wireless device When this coil is reset to false the wireless device has been updated with the change We recommend 1 update at a time MUG03 1A www monnit com 2012 Monnit Corp 19 Reference Section Complete Gateway Features and Resource Mapping Reference Through the Modbus interface the following features are avail able for access by a modbus master All coils and registers are available for read or write access through the MODBUS address mapping presented here Ref 1 Gateway Coils The following table represents the supported gateway specific coils These are intended to report the status control the state or trigger events on the gateway Coil Name Address Description WACTIVE 0 True 1 denotes that the system is con figure
22. is forced to used the specified value Do not write a value greater than 254 After this register is modified the RST_WNET coil must be set to true to reform the network and select new OP_NETID and OP_CHAN settings CHANM_H 40012 CHANM_L 40013 The configurable channel mask is a Uint32 bit field that represents the allowed channels the wireless is allowed to establish a network Default value contains a 1 for every pos sible channel all channels are allowed If the value is 0x00000011 then the network is only allowed to be established on channels 0 and 4 After these registers are modified the RST_WNET coil must be set to true to reform the network and select new OP_NETID and OP_CHAN settings 26 RESET_CNTR 40014 Internal Reset Counter Register When a standard reset or watchdog event occurs meaning the device stalled for 0 9 seconds a device reset will occur and this value will be incremented by one A write to this register will replace the current value with the one specified WDREG_ID_H 40015 WDREG_ID_L 40016 Wireless Device s Identification Number of a device that will be registered to the gateway s Wireless Device List UInt32 value Example 5005145 _H 0x004C L Ox5F59 WDREG_CODE_1 40017 WDREG_CODE_2 40018 WDREG_CODE_3 40019 WDREG_CODE 4 40020 WDREG_CODE 5 WDREG_CODE 6 40021 40022 A strin
23. isotropically radiated power EIRP is not more than that required for successful communication Approved Antennas The following antennas are approved for use with FCC ID ZTL RFSC1 e Hyperlink HG905RD RSP 5 1 dBi Rubber Duck e Pulse W1063 3 0 dBi Rubber Duck e ChangHong GSM 09 2 0 dBi Rubber Duck e Specialized Manufacturing MC ANT 20 4 0C 4 whip FCC ID ZTL RFUSB1 This device has been designed to operate with the attached non removable antenna 38 Canada IC English Under Industry Canada regulations this radio transmitter may only operate using an antenna of a type and maximum or lesser gain approved for the transmitter by Industry Canada To reduce potential radio interference to other users the antenna type and its gain should be so chosen that the equivalent isotropically radiated power e i r p is not more than that necessary for successful communication This radio transmitter IC 9794A RFSC1 and IC 9794A RFUSB1 has been approved by Industry Canada to operate with the antenna types listed below with the maximum permis sible gain and required antenna impedance for each antenna type indicated Antenna types not included in this list having a gain greater than the maximum gain indicated for that type are strictly prohibited for use with this device This device complies with Industry Canada licence exempt RSS standard s Operation is subject to the following two conditions 1 this device may not
24. ist WDL A Value of 0 here denotes that no devices are reg istered and the wireless is disabled The WDL consists of 100 set of 2 paired registers that rep resents the Serial Identifier SID for the register device These registers can be read to discover the location of a specific device in the list WDL_SLOT If any of these registers are written to the corresponding device entry will be erased and these registers will be zeroed out Please see Ref 5 for more information Adding a Wireless Device to the Gateway Each Monnit device had a 32 bit serial identifier SID and a 6 digit verification code Write to the following registers and coil to add a new wireless device to a gateway e Registers WOREG_ID_H and WDREG_ID_L 40015 40016 need to be loaded with the wireless devices SID e Registers WDREG_CODE_1 through WDREG _ CODE_6 40017 40022 need to be loaded with the 6 digit check code The format of these entries is the ASCII charactor followed by an ASCII null terminator 0 or decimal value of 0 4 10 Example SID 5005145 CODE IMARVD WDREG_ID_H 0x004C WDREG_ID_L 0x5F59 WDREG_CODE_1 NO gt 0x4900 WDREG_CODE_2 M 0 0x4D00 WDREG_CODE_3 A 0 0x4100 WDREG_CODE_4 R 0 0x5200 WDREG_CODE_5 V 0 0x5600 WDREG_CODE 6 D 0 gt 0x4400 e e e e e e e e Then write a true to the REG_DEVICE_NOW Gateway Coil 6 to verify that the ID and CODES wer
25. mmunications have occurred with the devices for this specified amount of time the ACTIVE coil is reset to FALSE 30 CFG_CHANM_H CFG_CHANM_L 20 Configurable Channel Mask is a Ulnt32 bit field that represents the allowed channels the wireless device is permitted to use to search for gateways If the value is written to 0x00000011 then the network is only allowed to be established on channels 1 and 5 CFG_INTERVAL_ LINK 21 Configurable Interval Link represents the device s link state sleep time If the device dis connects from its current network e g failures reset it will scan permitted channels for a new link If no gateway is found then this specified period of time is waited before attempting to relink This value is a Ulnt16 that is interpreted as follows e CFG_LINKHB lt 18 value is in hours 1 18 HRS e CFG_LINKHB gt 100 value is in minutes 105 5 MIN e If 0 or Otherwise 2HR default CFG_ INTERVAL STANDARD 22 Configurable Interval for Standard Reports is the regular check in interval for the wireless device based on timer not events Format Ulnt16 number of seconds to wait before checking in See Notes 1 amp 2 CFG_INTERVAL_ EXCEPTION 23 Configurable Interval for Exception Reports is the check in interval used during exception cases based on timer not events Format Ulnt16 number of seconds to wait before checking in See No
26. ny pending message not to be sent No modification to the CNTL_COMMAND and CNTL_DATA x registers in WDR are permit ted while this coil is true FORCE _ REMOTE 4 Always read as False 0 If set to True 1 SYNC then the wireless device s local registers will be cleared and the remote configurations will be retrieved Ref 4 Gateway Registers The following table represents the supported gateway settings and their corresponding properties Register Name Address Description VERSION 40000 Designates the FW Version of the Gateway READ ONLY Example Value 0x3136 ASCII characters Version 1 6 ID_H 40001 Gateway s globally unique identifier READ ONLY Combine a ID_H and ID_L to form UInt32 IDL 40002 24 WD_CNT 40003 Wireless Device Count Value that can be read to discover the number of registered sen sors are configured to operate on the gate way A value 0 100 is permitted READ ONLY Example Value 0 no sensors registered fac tory reset condition Example Value 10 10 Registered device OP_NETID 40004 Operating network identifier used in the wire less system Value of 1 254 is permitted READ ONLY OP_CHAN 40005 Operating channel designator reports the wireless channel in use Value of 0 25 is permitted READ ONLY BAUDRATE 40006 Designates the baud rate used by the MOD BUS interface After modifing this register a ga
27. on manual may cause harmful interference to radio communications However there is no guarantee that interference will not occur in a particular installation If this equipment does cause harmful interference to radio or television reception which can be determined by turning the equipment off and on the user is encouraged to try to correct the interference by one of more of the following measures e Reorient or relocate the receiving antenna e Increase the separation between the equipment and receiver e Connect the equipment into an outlet on a circuit different from that to which the receiver is connected e Consult the dealer or an experienced radio TV technician for help Warning Changes or modifications not expressly approved by Monnit could void the user s authority to operate the equipment RF Exposure WARNING To satisfy FCC RF exposure requirements for mobile transmitting devices the antenna used for this transmitter must not be co located in conjunction with any other antenna or transmitter FCC ID ZTL RFSC1 This device has been designed to operate with an approved antenna listed below and having a maximum gain of 5 1 dBi Antennas not included in this list or having a gain greater than 5 1 dBi are strictly prohibited for use with this device The required antenna impedance is 50 ohms To reduce potential radio interference to other users the antenna type and its gain should be so chosen that the equivalent
28. rs and settings from the device 4 0 4 1 Using the Gateway Coil and Register Map This device has various coils and registers that allow the user to access gateway and wireless device feature Here is a brief listing of the accessible coil and register map Resource Name Acronym Address Gateway Coils GWC 0 5 Fast Read Exception FREC 0 thru 1000 1099 Coils 100 total FREC 99 Wireless Device Coils WDC 0 thru 2000 2499 100 total sets of 5 coils WDC 99 Gateway Registers GWR 40000 40022 Wireless Device List 100 WDL 0 thru 41000 41199 total sets of 2 registers WDL 99 Fast Read Registers 100 FRR 0 thru 41200 41925 total sets of 4 registers FRR 99 Wireless Device Regis WDR 0 thru 50000 59999 ters 100 total sets of 100 WDR 99 registers Please see the reference section for more detailed information Verifying that the Wireless is Active Read the WACTIVE Gateway Coil address 0 A true coil denotes that the system is configured sufficiently to communicate to wireless device s A false coil means the gateway does not have any registered wireless devices WDL is empty MUGO03 1A www monnit com 2012 Monnit Corp 13 4 2 4 3 4 4 4 5 14 Resetting the Gateway Write the RST_DEVICE Gateway Coil address 2 to TRUE The device will reset one second after receiving this command This resets all non volatile memory fields i e FREC F
29. t instead of waiting for the report interval Value of 1 250 permissible Minimum granularity of 1 sec maximum sample rate See Note 1 32 CFG_INT TYPE 28 HYSTERESIS_H CFG INT TYPE 29 HYSTERESIS_L Device Type Specific Parameter INTERVAL TYPE DEVICE Hysteresis represents the amount of observed variance must occur to permit a device that has registered an exception to remove the excep tion notification See Note 1 CFG_INT TYPE 30 THRESH_MIN_H CFG INT TYPE 31 THRESH_MIN_L Device Type Specific Parameter INTERVAL TYPE DEVICE Minimum Threshold represents the amount of device specific observed signal can be reduced before an exception is registered and reported See Note 1 CFG_INT_TYPE_ 32 THRESH_MAX_H CFG_INT_TYPE_ 33 THRESH_MAX_L Device Type Specific Parameter INTERVAL TYPE DEVICE Maximum Threshold represents the amount of device specific observed signal can be in creased before an exception is registered and reported See Note 1 MUG03 1A www monnit com 2012 Monnit Corp 33 CFG_INT TYPE 34 CALVAL_1_H Device Type Specific Parameter INTERVAL CFG_INT_TYPE_ 35 TYPE DEVICE CALVAL_1_L Ree CFG_INT_TYPE_ 36 Calibration Control Values CALVAL_2_H See Note 1 for and explanation of these regis CFG_INT TYPE 37 tors CALVAL_2_L l CFG_INT_TYPE_ 38 CALVAL_3_H CFG_IN
30. ters VER_MAJOR VER_MINOR to be interpreted as ASCII characters with the follow VER MINOR 3 ing format MO M1 m0 m1 Example VER 0x3230 0x3136 Version 2 0 1 6 READ ONLY MUG03 1A www monnit com 2012 Monnit Corp 29 TYPE Device Type value that is used to interpret the sensor specific portions of this record READ ONLY See note 1 LAST COMM _H LAST COMM _L Current Julian date time value UInt32 for the last time the remote device reported data READ ONLY VOLTAGE Current Voltage reported from the remote de vice Value formatted in milli volts READ ONLY Example 301 3 01 Volts RSSI Current Received Signal Strength Indicator Formatted as Int16 Values of 20 to 106 dBm typical The less negative the number the more signal there was on the last communica tion READ ONLY STATUS Current Status reported from the remote de vice READ ONLY See note 1 DATA _0 10 DATA 1 11 The current data reported by the remote de vice OUT DATA_2 12 DATA_3 13 See Note 1 for and explanation of these regis DATA_4 14 ters DATA_5 15 DATA_6 16 READ ONLY DATA_7 17 INACTIVITY_ TIME 18 Timeout in 5 min steps Values of 1 to 216 5 min to 18 hrs permitted If the device has communicated within the amount of time speci fied here the ACTIVE coil is set to TRUE If No co
31. tes 1 amp 2 MUGO03 1A www monnit com 2012 Monnit Corp 31 CFG_ RETRIES 24 Configurable Retry Limit represents the num ber of attempts made by the device to deliver its data when the primary attempt fails Value of 0 10 inclusive are permitted CFG_ RELINK 25 Configurable Relink Limit represents the num ber of report attempts can fail consecutively before the sensor drops current gateway con nection and re scans for a better connection Value of 1 10 inclusive are permitted for the relink behavior If value is 0 then this behavior is disabled and only a power cycle can reset the device s link settings CFG_ PROFILE_ TYPE 26 Value that selects what profile specific de vice type is recognized by the remote device READ ONLY Write attempts are ignored INTERVAL TYPE DEVICE 1 Primarily governed by a timer When it is time to deliver data the wireless device trans mits the data to the gateway TRIGGER TYPE DEVICE 2 Primarily governed by the occurrence of an event If an event is detect OR the CFG_IN TERVAL_STANDARD is reached then the wireless device transmits the data to the gateway CFG_INT_TYPE_ MEAS_PER_RPT 27 Device Type Specific Parameter INTERVAL TYPE DEVICE Measurements Per Report represents the number of measurements that will be taken for every given wireless report If a exception is noted then the device will immediately repor
32. teway reset must be performed before changes can take effect Value Represented Baud Selected 2400 1 4800 2 DEFAULT 9600 3 19200 4 38400 5 57600 6 115200 COMMODE 40007 Designates the operating mode used by the MODBUS interface After modifing this regis ter a gateway reset must be performed before changes can take effect Value Represented Meaning RTU 8 N 2 DEFAULT RTU 8 N 1 RTU 8 E 1 RTU 8 0 1 ASCII 7 N 2 ASCII 7 E 1 ASCII 7 O 1 OO O1 ND MUG03 1A www monnit com 2012 Monnit Corp 25 ADDRESS 40008 Designates the MODBUS Address used in the communications interface Values range from 1 247 Default value is 240 Modifying this register will result in a gateway reset TIME_H 40009 TIME_L 40010 Current Time Field in seconds If this field is never set to reference any standard time format it will represent the time from last Gateway reset It is traditional to set these registers to reflect UNIX time or the number of seconds that have elapsed since January 1st 1970 If read this will report current time If written to this will set the time Default value is 0000 0000 and is loaded at every power on reset NETID 40011 The Network ID value represented here is used to configure the wireless network De fault 0 meaning that the wireless is allowed to scan and use a free network identifier If value is 1 254 the wireless
33. ts in materials and workmanship for a period of one 1 year from the date of delivery with respect to hardware and will materially conform to their published specifications for a period of one 1 year with respect to software Monnit may resell sensors manufactured by other entities and are subject to their individual warranties Monnit will not enhance or extend those warranties Monnit does not warrant that the software or any portion thereof is error free Monnit will have no warranty obligation with respect to Products subjected to abuse misuse negli gence or accident If any software or firmware incorporated in any Product fails to conform to the warranty set forth in this Section Monnit shall provide a bug fix or software patch correcting such non conformance within a reasonable period after Monnit receives from Customer i notice of such non conformance and ii sufficient information regarding such non conformance so as to permit Monnit to create such bug fix or software patch If any hardware component of any Product fails to conform to the warranty in this Section Monnit shall at its option refund the purchase price less any discounts or repair or replace non conforming Products with conforming Products or Products having substantially identical form fit and function and deliver the repaired or replacement Product to a carrier for land shipment to customer within a reasonable period after Monnit receives from Customer i notice of su
34. vailable slot Always read as False 0 MUG03 1A www monnit com 2012 Monnit Corp 21 Ref 2 Fast Read Exception Coils FREC The purpose of these coils is to allow for efficient access to the remote wireless device s most current exception status This is a READ ONLY table A TRUE 1 coil represents that the specified device is currently in an exception state OFFLINE or Reporting an Alert State ADDRESS FORMULA 1000 WDL_SLOT Example Coil Name Address Coil Name Address FREC 0 1000 FREC 99 1099 Ref 3 Wireless Device Coils This section defines the location and function of all the remotely located coils available for access through the MODBUS interface Every wireless device as been allotted 5 possible coils The table below enumerates the address allotment ADDRESS FORMULA 2000 5 WDL_INDEX Example Register Name Address Register Name Address WDC 0 2000 WDC 99 2495 The following table represents the specific Wireless Device Coils These are intended to report the status control the state or trigger events on the remotely connected devices Coil Name Offset ACTIVE 0 Description True 1 denotes that the remote wireless de vice is actively synchronized with the gateway False 0 denotes that the device is considered offline by the gateway No communications have occurred with the devices for INACTIV ITY_TIMEOUT in WDR amount of time value This is 0 if no d
35. vered to the remote unit ENT SFAN ORELT e See Note 1 for detailed explanation of possible command values CNTL_LAST_STA 57 The status report of the last CNTL command TUS execution Success 0 Error 0 See Note 1 for detailed explanation of possible error values Notes 1 See Monnit s Serial MODBUS Sensor Application Definition document for more information on field definitions enumera tion and usage for these specific registers 2 An Interval that specifies under 10 minutes must consider the battery power usage and wireless network load the gate way may experience if the CFG_INTERVAL parameters a set too low It is recommended to keep then network load to at most 10 device reports per minute The maximum interval for communications is 12 hrs 43200 seconds MUG03 1A www monnit com 2012 Monnit Corp 35 Error Reporting Troubleshooting and Support For technical support and troubleshooting tips please visit our support library online at http www monnit com support If you are unable to solve your issue using our online support email Monnit support at support monnit com with your contact information and a description of the problem and a support representative will call you within one business day For error reporting please email a full description of the error to support monnit com Warranty Information a Monnit warrants that Monnit branded products will be free from defec
Download Pdf Manuals
Related Search