Upload
others
View
1
Download
0
Embed Size (px)
Citation preview
WiYZGateway
WiYZ
Remote
MDS 05-4954A01, Rev. C
OCT 2012
A system manual covering WiYZ Gateway and Remote Products
MDS WiYZIntelligent Data Acquisition and Networking
Need setup instructions for these products?
Please refer to publications 05-4888A01 (Gateway) and 05-4953A01 (Remote).
All documentation is available online at www.gemds.com
MDS 05-4954A01, Rev. C WiYZ Technical Manual iii
TABLE OF CONTENTS
1.0 INTRODUCTION .................................................................................................................. 1
1.1 Conventions Used in This Manual .................................................................................................2
Software & Menu Notations ......................................................................................................2
Model Number Notations ..........................................................................................................2
Authorization Features ..............................................................................................................2
2.0 PRODUCT DESCRIPTION................................................................................................... 3
2.1 WiYZ Gateway Description ...........................................................................................................3
Connectors and Indicators ........................................................................................................3
Key Gateway Product Features ................................................................................................4
Network Security .......................................................................................................................5
Accessories and Spares............................................................................................................5
2.2 Remote Description .......................................................................................................................6
Remote External Ports and Indicators ......................................................................................6
WiYZ Remote—Key Product Features .....................................................................................7
Accessories and Spares............................................................................................................9
2.3 Gateway Menu Overview ..............................................................................................................9
2.4 WiYZ ISA100.11a Mesh Network Introduction ............................................................................12
3.0 NETWORKING APPLICATIONS ....................................................................................... 17
3.1 Mesh Data Reported with Data Reporting Service (DRS) ...........................................................17
3.2 Cellular Network Routing & Port Forwarding ...............................................................................19
3.3 Digital Event Reporting to Gateway .............................................................................................20
3.4 Digital Event Reporting: Remote to Remote ................................................................................21
3.5 I/O Replication From Remote to Remote ....................................................................................23
4.0 INSTALLATION PLANNING .............................................................................................. 24
4.1 Gateway Installations ..................................................................................................................25
Mounting Options ....................................................................................................................25
Antennas .................................................................................................................................29
DC Power Connection.............................................................................................................30
Reverse Polarity Protection Limitations ..................................................................................30
Grounding Considerations ......................................................................................................31
Serial Data Interfaces..............................................................................................................31
Ethernet Data Interface (RJ-45) ..............................................................................................35
4.2 Remote Installations ....................................................................................................................37
Remote PCB Connector/Switch Locations..............................................................................37
Input/Output Information .........................................................................................................38
Wiring Information ...................................................................................................................39
I/O Transient Protection ..........................................................................................................45
Power Configurations..............................................................................................................46
Battery Back-up Operational Considerations ..........................................................................47
MDS 05-4954A01, Rev. C WiYZ Technical Manual iv
Non-Rechargeable Battery Considerations.............................................................................47
Remote I/O Connection Circuit Examples...............................................................................49
................................................................................................................................................54
Sensor Remote I/O Connections ............................................................................................54
4.3 WiYZ Wireless Interfaces ............................................................................................................55
MDS Mesh Network ................................................................................................................55
Optimizing for Range and Performance..................................................................................56
MDS entraNET Backhaul ........................................................................................................60
802.11x Wi-Fi Short-Range Backhaul .....................................................................................60
Cellular Router Long-Range Backhaul....................................................................................60
Network Bridge Planning.........................................................................................................60
4.4 WiYZ Gateway Installation ..........................................................................................................61
4.5 WiYZ Remote Installation ............................................................................................................65
4.6 Initial System Configuration .........................................................................................................67
Web Browser Connection .......................................................................................................67
4.7 Initial Startup & Checkout ............................................................................................................75
4.8 Wireless Sensors Network Settings ............................................................................................77
Provisioning Recap .................................................................................................................77
Profiles ....................................................................................................................................77
Router vs. I/ODevice Designation ...........................................................................................79
Remote Types and Template Profiles .....................................................................................80
Enabling or Disabling Periodic Readings (Publish).................................................................81
Engineering Unit Conversion ..................................................................................................81
4.9 Serial Data via COM2 Support ....................................................................................................81
4.10 Data Reporting Service .............................................................................................................82
Infrastructure Requirements....................................................................................................82
Naming Convention.................................................................................................................83
Operational Notes ...................................................................................................................83
Scheduling ..............................................................................................................................84
Network Interface Assignment ................................................................................................84
4.11 MODBUS Access ......................................................................................................................84
Modbus Operational Considerations.......................................................................................85
4.12 SNMP MIB Files ........................................................................................................................86
4.13 EntraNET Configuration Concepts ............................................................................................87
4.14 EntraNet 2400 and Wi-Fi Setup Considerations .......................................................................88
5.0 WiYZ System Setup Topics.............................................................................................. 90
5.1 Mesh Network Provisioning and Setup .......................................................................................90
Provisioning the WiYZ Gateway..............................................................................................93
Provisioning the WiYZ Remote ...............................................................................................94
5.2 MODBUS Setup ..........................................................................................................................96
5.3 Port Forwarding for Modbus Polling ..........................................................................................101
Port Forwarding of Modbus from Cell Network to LAN .........................................................101
5.4 Serial Data Transport via the Mesh ...........................................................................................103
Description ............................................................................................................................103
Setup.....................................................................................................................................103
Operation ..............................................................................................................................104
Limitations .............................................................................................................................105
MDS 05-4954A01, Rev. C WiYZ Technical Manual v
6.0 SYSTEM MANAGEMENT REFERENCE DATA .............................................................. 107
6.1 Screen Structure ........................................................................................................................107
6.2 Security Certificate Introduction ................................................................................................107
6.3 Menu Navigation .......................................................................................................................109
Overview-Summary Screen ..................................................................................................109
Using the Menu .....................................................................................................................109
6.4 Logging Out of the Web Interface ..............................................................................................109
6.5 Device Manager Summary ........................................................................................................ 110
Overview-Summary Screen .................................................................................................. 110
Setup Wizards....................................................................................................................... 112
Configuration Screens........................................................................................................... 113
Mesh Network .......................................................................................................................147
Device Information Summary................................................................................................151
Profile Configuration..............................................................................................................152
Modbus Register Map ...........................................................................................................154
Local-loop Connections.........................................................................................................154
7.0 TROUBLESHOOTING ..................................................................................................... 166
7.1 WiYZ Remote Communication Basics .......................................................................................166
7.2 WiYZ Gateway System Configuration Basics ............................................................................167
WiYZ Gateway Support Package..........................................................................................168
WiYZ Gateway Ping Utility ....................................................................................................169
Troubleshooting Using the Web GUI Interface......................................................................170
Starting Information Screen...................................................................................................171
Packet Statistics Menu ..........................................................................................................172
7.3 Using Logged Operation Events ................................................................................................172
7.4 Alarm and Event Conditions ......................................................................................................172
7.5 Correcting Alarm Conditions .....................................................................................................176
7.6 Logged Events ...........................................................................................................................176
7.7 Troubleshooting with the WiYZ Gateway Command Line .........................................................178
7.8 Factory Assistance ...................................................................................................................182
8.0 TECHNICAL REFERENCE.............................................................................................. 183
8.1 Technical Specifications ............................................................................................................184
8.2 Data Reporting Service Usage Information ...............................................................................188
Customer Infrastructure Requirements .................................................................................188
Operation ..............................................................................................................................188
Directory and File Management ............................................................................................189
Format...................................................................................................................................190
DRS Output File Sample.......................................................................................................193
8.3 NOTES ON SNMP ....................................................................................................................195
Overview ...............................................................................................................................195
SNMPv3 Support ..................................................................................................................195
SNMPv3 Accounts ................................................................................................................195
Context Names .....................................................................................................................196
Password-Mode Management Changes...............................................................................196
MDS 05-4954A01, Rev. C WiYZ Technical Manual vi
9.0 GLOSSARY OF TERMS & ABBREVIATIONS ................................................................ 199
10.0 APPENDIX A—WiYZ Release Notes............................................................................ 202
10.1 WiYZ System Firmware - Version 2.2.3 ...................................................................................202
Introduction ...........................................................................................................................202
Features ................................................................................................................................203
Changes since last release ...................................................................................................203
Issues resolved since last release ........................................................................................203
Unsupported Features ..........................................................................................................203
Operational Notes .................................................................................................................204
Known Errata ........................................................................................................................206
10.2 WiYZ System Firmware - Version 1.5.5 ...................................................................................207
Introduction ...........................................................................................................................208
Features ................................................................................................................................208
Changes since last release ...................................................................................................208
Issues Resolved last release ................................................................................................209
Unsupported Features ..........................................................................................................209
Operational Notes .................................................................................................................210
Known Errata ........................................................................................................................210
11.0 Appendix B—GNU General Public License Notice .................................................... 212
Preamble...............................................................................................................................212
GNU General Public License ................................................................................................213
MDS 05-4954A01, Rev. C WiYZ Technical Manual vii
LIST OF FIGURES
Figure 1. MDS WiYZ Remote and Gateway ................................................................................1
Figure 2. Gateway General Safety Connectors .............................................................................3
Figure 3. Gateway Class 1 Div 2 / ATEX Zone 2 Connectors .....................................................3
Figure 4. Gateway LED Status Indicators ....................................................................................3
Figure 5. Remote Front View .......................................................................................................6
Figure 6. Remote Ports Bottom View Example ...........................................................................7
Figure 7. Remote LED Status Indicators ......................................................................................7
Figure 8. Mesh Architecture of an ISA100.11a Compliant Network .........................................14
Figure 9. Mesh and Cellular Scenario ........................................................................................18
Figure 10. Mesh and Wi-Fi Client Scenario ...............................................................................18
Figure 11. Mesh and entraNET Remote Scenario ......................................................................19
Figure 12. Cellular Network Routing & Port Forwarding Example ...........................................20
Figure 13. Digital Event Reporting Remote-to-Remote Configuration Example ......................22
Figure 14. I/O Replication Configuration Example ....................................................................23
Figure 15. Example System Installation .....................................................................................24
Figure 16. Wall Mounting Plate Dimensions .............................................................................25
Figure 17. Mounting Plate Dimensions (Inches) ........................................................................26
Figure 18. Mast/Pole Mounting Bracket .....................................................................................26
Figure 19. Remote Mast/Pole Mounting Bracket Dimensions ...................................................27
Figure 20. Gateway Mast/Pole Mounting Bracket Dimensions .................................................28
Figure 21. Gateway Whip Antennas ...........................................................................................29
Figure 22. Typical Yagi Antenna (mounted to mast) .................................................................30
Figure 23. DC Power Connector .................................................................................................30
Figure 24. COM1 Connector (DB-9F) .......................................................................................31
Figure 25. COM1 Wiring for PC Management ..........................................................................32
Figure 26. COM2 Connector (DB-9F) .......................................................................................33
Figure 27. RS-422/485 Wiring Arrangements ............................................................................35
Figure 28. Ethernet Port (RJ-45) Pinout .....................................................................................35
Figure 29. PCB Connector/Switch Locations .............................................................................38
Figure 30. Voltage Low Single Ended PCB ...............................................................................40
Figure 31. Voltage Low Differential PCB - Future ....................................................................41
Figure 32. Voltage High PCB .....................................................................................................42
Figure 33. Current Input PCB .....................................................................................................43
Figure 34. Current Output PCB ..................................................................................................44
Figure 35. Transient Protection Scheme for Digital and Analog Circuits ..................................46
Figure 36. Battery Life Graph .....................................................................................................48
Figure 37. Typical WiYZ Remote Installation ...........................................................................56
Figure 38. RF signal level changes with distance and antenna height .......................................57
Figure 39. Gateway Whip Antennas ...........................................................................................62
Figure 40. Gateway Class 1 Div 2 / ATEX Zone 2 Connectors .................................................63
Figure 41. Preferred Gateway Installation ..................................................................................64
MDS 05-4954A01, Rev. C WiYZ Technical Manual viii
Figure 42. Alternate Gateway Installation ..................................................................................64
Figure 43. WiYZ Remote Terminal Strip ...................................................................................66
Figure 44. Remote Installation Examples ...................................................................................66
Figure 45. Login Screen ..............................................................................................................68
Figure 46. Setup Wizard-Serial Communication ........................................................................68
Figure 47. Serial Wizard Screen .................................................................................................69
Figure 48. Setup Wizard-Initial Screen Example .......................................................................70
Figure 49. Setup - SIM Card Installation ....................................................................................71
Figure 50. Setup Wizard - Cellular Service Providers ................................................................71
Figure 51. Setup Wizard - AT&T Default Setup ........................................................................72
Figure 52. Setup Wizard - Other Setup .......................................................................................72
Figure 53. Setup Wizard - Other Setup .......................................................................................73
Figure 54. Setup Wizard - Confirm Changes .............................................................................73
Figure 55. Setup Wizard - Verizon Activate Confirmation ........................................................74
Figure 56. Gateway LED Status Indicators ................................................................................75
Figure 57. Remote LED Status Indicators ..................................................................................76
Figure 58. Device Profile Page ...................................................................................................78
Figure 59. Profile Configuration .................................................................................................79
Figure 60. Overview-Summary Screen ......................................................................................90
Figure 61. WiYZ Gateway Information Label Example ............................................................92
Figure 62. WiYZ Remote Information Label Example ..............................................................92
Figure 63. WiYZ Remote Cabling ..............................................................................................96
Figure 64. Auto Re-Assign ALL dialog .....................................................................................97
Figure 65. MODBUS Map WebUI Page ....................................................................................98
Figure 66. MODBUS Map WebUI Page -Registers Modified, but Not Applied ......................99
Figure 67. MODBUS Function Codes Help Dialog ...................................................................99
Figure 68. MODBUS TCP Configuration WebUI Frame ........................................................100
Figure 69. MODBUS Forwarding Example .............................................................................101
Figure 70. HTTPS Forwarding Example ..................................................................................101
Figure 71. HTTPS via WAN example ......................................................................................102
Figure 72. Serial Data Transport via the Mesh .........................................................................103
Figure 73. Mesh Network Terminal Servers ............................................................................103
Figure 74. Mesh Network—Profile Configuration ...................................................................104
Figure 75. Direct Connect Example .........................................................................................134
MDS 05-4954A01, Rev. C WiYZ Technical Manual ix
LIST OF TABLES
Table 1. WiYZ Gateway Accessories & Spare Items .................................................... 5
Table 2. Remote Accessories & Spare Items ................................................................. 9
Table 3. Menu Overview.............................................................................................. 10
Table 4. ISA100.11A Device Roles ............................................................................. 14
Table 5. ISA100.11A Device Roles ............................................................................ 15
Table 6. Related Application Bulletins Available*...................................................... 19
Table 7. Gateway & Remote Mast/Pole Mount Bracket Key Dimensions.................. 27
Table 8. WiYZ Gateway Antenna Types ..................................................................... 29
Table 9. COM1 Pin Descriptions—Gateway.............................................................. 32
Table 10. COM2 Pin Descriptions — Gateway in RS-232 Mode ............................... 34
Table 11. COM2 Pin Descriptions—Gateway in RS-485 Mode ................................. 34
Table 12. Ethernet Port (IP/Ethernet) Pinouts.............................................................. 35
Table 13. VLTerminal Strip (J201) Connections......................................................... 40
Table 14. VLTerminal Strip (J201) Connections......................................................... 41
Table 15. VH Terminal Strip (J201) Connections ....................................................... 42
Table 16. CI Terminal Strip (J201) Connections ......................................................... 43
Table 17. CO Terminal Strip (J201) Connections ....................................................... 44
Table 18. Projected Battery Life .................................................................................. 48
Table 19. “On” Time Extension for Sensors................................................................ 49
Table 20. Related Application Bulletins Available...................................................... 54
Table 21. RF Range vs Gateway/Remote antenna height............................................ 59
Table 22. Gateway LED Descriptions.......................................................................... 75
Table 23. Remote LED Descriptions ........................................................................... 77
Table 24. DRS Parameters ........................................................................................... 83
Table 25. SNMP MIB Files ......................................................................................... 86
Table 26. MDS entraNET 2400 Frequencies ............................................................... 89
Table 27. Wi-Fi Channels ............................................................................................ 89
Table 28. MDS entraNET vs. Wi-Fi Channel Selections ............................................ 89
Table 29. Customer ID Information........................................................................... 130
Table 30. Modbus Auto-Assigned Register Ranges .................................................. 156
Table 31. Remote Communications Troubleshooting ............................................... 167
Table 32. Gateway Communications Troubleshooting.............................................. 169
Table 33. Basic Troubleshooting ............................................................................... 170
Table 34. Event Classifications.................................................................................. 172
Table 35. Alarm Conditions ....................................................................................... 173
Table 36. Event Conditions........................................................................................ 173
Table 37. Correcting Alarm Conditions—Alphabetical Order .................................. 176
Table 38. Non-Critical Events—Alphabetical Order................................................. 176
Table 39. Gateway Command Line Information ...................................................... 178
Table 40. CSV File Naming Convention ................................................................... 189
x WiYZ Technical Manual MDS 05-4954A01, Rev. C
Table 41. Data Reporting Service Output Data File Format...................................... 190
Table 42. CSV File Line 1 Description...................................................................... 190
Table 43. Device Header............................................................................................ 191
Table 44. Device Data................................................................................................ 191
Table 45. CSV File Data Entry Values ...................................................................... 192
Table 46. SNMP Traps (Sorted by Code) .................................................................. 197
MDS 05-4954A01, Rev. C WiYZ Technical Manual xi
GE MDS Copyright Notice
Copyright 2012, GE MDS. All rights reserved.
This publication is protected by copyright law to the extent available. GE MDS does not claim copyright to the subject matter that is explicitly stated to be covered herein under the GNU Copy-right Notice provided below.
GNU Copyright Notice
GE MDS L.L.C WiYZ Series products include free software, listed below, which are released under the GNU General Public License Version 2. A copy of the license can be found in the Appendix and can also be found at http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
• Linux kernel - Copyright ©, The Kernel.Org Organization, Inc. (http://www.kernel.org)
• u-boot - Copyright ©, 2000-2005 Wolfgang Denk, DENX Software Engineering (mailto:[email protected])
• JQuery – (http://docs.jquery.com/License)
• SQLite – Copyright © Hipp, Wyrick, & Company, Inc. (http://www.sqlite.org/)
If you would like a copy of the GPL source code contained in this product, you may download it free-of-charge from the GE MDS website (http://gemds.com) on the WiYZ Software/Firmware Downloads page. Alternatively, a copy of the GPL source code contained in this product may be shipped to you on CD for a nominal charge of which will be no more than the cost of preparing and mailing a CD to you. For more information, contact [email protected].
ISO 9001 Registration
GE MDS adheres to the internationally-accepted ISO 9001 quality system standard.
Product Test Data Sheets
Test Data Sheets showing the original factory test results for this product are available upon request from the GE MDS Quality Leader. Contact the factory using the information at the back of this manual. Serial numbers must be provided for each product where a Test Data Sheet is required.
OPERATIONAL & SAFETY NOTICES
To comply with RF exposure requirements, the antenna shall be installed to ensure a minimum separation distance of 20 cm from persons. The antenna may not be collocated or operated in conjunction with other trans-mitting devices. To reduce potential radio interference to other users, the antenna type and its gain should be so chosen that the Equivalent Isotropi-cally Radiated Power (EIRP) is not more than that permitted for successful communication.
Only approved antennas may be used on the unit's RF output connectors, as listed below. The use of non-approved antennas may result in a violation of FCC rules, and subject the user to FCC enforcement action.
Warning: Changes or modifications not expressly approved by the manu-facturer could void the user’s authority to operate the equipment.
RF Exposure
xii WiYZ Technical Manual MDS 05-4954A01, Rev. C
Safety Notices
UL/c Notice
The WiYZ Gateway and WiYZ Remote products are approved for use in Class 1, Division 2, Groups A, B, C & D Hazardous Locations.
Such locations are defined in Article 500 of the National Fire Protection Association (NFPA) pub-lication NFPA 70, otherwise known as the National Electrical Code.
These products have been recognized for use in these hazardous locations by Underwriter Labs (UL) which also issues the Canada mark of approval (UL/C). The CSA Certification is in accor-dance with CSA STD C22.2 No. 213-M1987.
\The antenna feedline(s), DC power cable and interface cable must be routed through conduit in accordance with the National Electrical Code.
Installation, operation and maintenance of the transceiver should be in accordance with the trans-ceiver's installation manual, and the National Electrical Code.
Tampering or replacement with non-factory components may adversely affect the safe use of the transceiver in hazardous locations, and may void the approval.
A power connector with screw-type retaining screws as supplied by GE MDS must be used.
Do not disconnect equipment unless power has been switched off or the area
is known to be non-hazardous.
Refer to Articles 500 through 502 of the National Electrical Code (NFPA 70) for
further information on hazardous locations and approved Division 2 wiring
methods.
EXPLOSIONHAZARD!
MDS 05-4954A01, Rev. C WiYZ Technical Manual xiii
ATEX Directive Compliance Information
The WIYZ Gateway and Remote products are ATEX Compliant with the “Zone 2, Cat 3" require-ments pending the proper installation requirements listed below.
Class 1 Div. 2 for USA use, and EU, ATEX Zone 2 connections
“WARNING - DO NOT OPEN WHEN EQUIPMENT IS ENERGIZED.”
“WARNING -POTENTIAL ELECTROSTATIC CHARGING HAZARD”
ATEX Connections for Safe Use
• To connect the metal conduit fitting you must use an IP54 rated interconnect (or better) to maintain ATEX, Zone 2 Cat 3 compliance. The Conduit fittings are industry standard ¾" with 14 TPI, (MHUB2).
• If metric threads are required - install an thread adapter using IP54 sealing methods.
• Do not contact the LED display, or rubber hole plug during normal use, the display and the rubber hole plug must not be contacted in normal use and may only be cleaned or wiped with a damp cloth.
ATEX Ground bonding connections
Earth chassis Ground bonds are supplied, The WIYZ is a NEC Class 2 grounded chassis, the DC return is Chassis ground. The chassis mounting holes are at ground potential and should be con-nected to ground. Also accessible on the WiYZ Remote internal conduit fittings is a ground bond screw and can be used when the Chassis is unable to be connected to Earth Ground.
WiYZ Gateway
C1D2/ATEX Configuration
WiYZ Remote
C1D2/ATEX Configuration
xiv WiYZ Technical Manual MDS 05-4954A01, Rev. C
The following photos show internal and external grounding connections to meet ATEX requir-ments for the WiYZ Remote unit. (The ground wire for the Remote internal grounding is supplied by the installer.)
The following photo illustrates internal and external grounding connections to meet ATEX requir-ments for the WiYZ Gateway unit. The Gateway provides an internal grounding wire (green) coming through the NPT hub to be connected as required by code. The front panel grounding stud, below the COM1 port, is required to be connected to local ground.
MDS 05-4954A01, Rev. C WiYZ Technical Manual xv
ATEX GATEWAY USB/Serial connections
The USB and Serial connectors are for configuration or diagnostic setup ONLY and shall not be connected in normal ATEX hazardous location zone use. These are for diagnostic and configura-tion purposes only. The USB and Serial connector covers MUST remain in place AT ALL TIMES in an ATEX Zone 2 hazardous location.
The WIYZ Gateway and WiYZ Remote products were evaluated based on the following ratings:
- II 3 G
- Ex ic nA IIC Gc
- Amb -40°C to +70°C
- Gateway: T5
- Remote: T6
xvi WiYZ Technical Manual MDS 05-4954A01, Rev. C
FCC Part 15 Notices
This Equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference in which case users will be required to correct the interference at their own expense.
This device complies with Part 15 of the FCC Rules. Operation is subject to the following two con-ditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received; including interference that may cause undesired operation.
Gateway
• Mesh Radio:
- FCC ID: E5MDS-MESH2400
- IC ID: 101D-MESH2400
• WiFi Radio:
- FCC ID: M4Y-ZCN722MV1
- IC ID: 3195A-ZCN722MV1
• Cell Radio:
- FCC ID: AU792U04A22740
- IC ID(CDMA) : 125A-0010
- IC ID (GSM) : 125A-0011
• MDS Radio (900 MHz) :
- FCC ID: E5MDS-MDSEL806
- IC ID: 3738A-MDSEL806
• MDS Radio (2400Mhz) :
- FCC ID: E5MDS-MDSEL806-24
- IC ID: 3738A-MDSEL80624
Remote
• FCC ID: E5MDS-MESH2400
• IC ID: 101D-MESH2400
Industry Canada Notices
Operation is subject to the following two conditions: (1) this device may not cause interference, and (2) this device must accept any interference, including interference that may cause undesired operation of the device.
To reduce potential radio interference to other users, the antenna type and its gain should be chosen so that the Equivalent Isotropic Radiated Power (EIRP) is not more than that permitted for suc-cessful communication.
MDS 05-4954A01, Rev. C WiYZ Technical Manual xvii
This device has been designed to operate with the antennas listed in this manual. Antennas not included here are strictly prohibited for use with this device. The required antenna impedance is 50 ohms.
This Class A digital apparatus complies with Canadian ICES-003.
Cet appareil numérique de la classe A est conforme à la norme NMB-003 du Canada.
xviii WiYZ Technical Manual MDS 05-4954A01, Rev. C
Manual Revision and Accuracy
This manual was prepared to cover a specific version of firmware code. Accordingly, some screens and features may differ from the actual unit you are working with. While every reasonable effort has been made to ensure the accuracy of this guide, product improvements may result in minor dif-ferences between the manual and the product shipped to you. If you have additional questions or need an exact specification for a product, please contact our Customer Service Team using the information at the back of this guide. In addition, manual updates can often be found on the GE MDS Web site at www.gemds.com.
Environmental Information
The manufacture of this equipment has required the extraction and use of natural resources. Improper disposal may contaminate the environment and present a health risk due to hazardous substances contained within. To avoid dissemination of these substances into our environment, and to limit the demand on natural resources, we encourage you to use the appropriate recycling sys-tems for disposal. These systems will reuse or recycle most of the materials found in this equipment in a sound way. Please contact GE MDS or your supplier for more information on the proper dis-posal of this equipment.
Battery Disposal—This product may contain a battery. Batteries must be disposed of properly,
and may not be disposed of as unsorted municipal waste in the European Union. See the product
documentation for specific battery information. Batteries are marked with a symbol, which may
include lettering to indicate cadmium (Cd), lead (Pb), or mercury (Hg). For proper recycling
return the battery to your supplier or to a designated collection point. For more information see:
www.weeerohsinfo.com
MDS 05-4954A01, Rev. C WiYZ Technical Manual 1
1.0 INTRODUCTION
MDS WiYZ products combine technology and function to provide a comprehensive range of solutions for data acquisition and networking requirements. Whether your application requires the collection of data from remote, unpowered sensors or deployment in areas with obstructed communication paths or a bridge for data using the cellular infrastruc-ture to your enterprise network, the WiYZ products provide simple, reli-able and cost-effective solutions.
• Self-powered Remotes connect off-the-shelf sensors, instruments and switches
• Reduced deployment costs with standard-based mesh networking
• Eliminate added cabling, power and infrastructure costs at remote locations
• Seamless connection to multiple public and private wireless solu-tions
• Ethernet and serial data collection with Modbus TCP and Mod-bus RTU on Serial port COM2
• Automatic mesh network creation insures wireless reliability and performance
• Automatic re-routing of communication in the event of a device failure or path obstruction
• Global unlicensed use in 2.4 GHz band and public GSM and CDMA cellular technology
For basic installation instructions, refer also to the MDS WiYZ Gateway Setup Guide (05-4888A01) and the MDS WiYZ Remote Setup Guide (05-4953A01). Electronic copies of all user documents and data sheets are available free of charge at www.gemds.com.
Figure 1. MDS WiYZ Remote and Gateway
2 WiYZ Technical Manual MDS 05-4954A01, Rev. C
1.1 Conventions Used in This Manual
Software & Menu Notations
This product is designed for software control via a connected PC. To show the names of software commands, keyboard entries, or other infor-mation displayed on a PC screen, a distinctive, bolded font is used as fol-lows:
Bolded font example (used for software commands and keyboard entries)
To show the navigation path leading to a particular menu, this same font is used with forward-pointing arrows between menu names. For example, to show how you would access the device’s Performance menu, the navigation string would appear as follows:
Maintenance & Status Menu>>Performance>>Packet Statistics
NOTE: The menu screens shown in this manual were obtained from aWiYZ Gateway operating in a lab environment. They areprovided as examples only. The parameters and settingsdisplayed may not reflect actual field service conditions.
Model Number Notations
The term “WiYZ” or “WiYZ Series” is used in this manual to denote all models in the WiYZ product line. Specific model types such as “Current In Remote” and “Current Out Remote” are used only when necessary to reference model-specific features.
Authorization Features
Some features of the WiYZ Gateway and Remote are dependent on pur-chased options and applicable regulatory constraints. A “key” icon is shown near the heading of any such features. If your WiYZ Gateway or Remote is not currently authorized for a needed feature, contact your factory representative for information on obtaining a new authorization code/key.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 3
2.0 PRODUCT DESCRIPTION
2.1 WiYZ Gateway Description
Connectors and Indicators
Figure 2 and Figure 3 shows the WiYZ Gateway’s connectors, and Figure 4 shows its LED status indicators. These items are referenced in various locations in this manual. The unit’s LED functions are described in Table 22 on Page 75.
Figure 2. Gateway General Safety Connectors
Figure 3. Gateway Class 1 Div 2 / ATEX Zone 2 Connectors
Figure 4. Gateway LED Status Indicators
4 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Key Gateway Product Features
The WiYZ Gateway is a wireless multifunction network product that provides connectivity between local Ethernet networks, serial devices or wireless data collection nodes, and a remote data center or host system. It is ideally suited for demanding applications where range and reli-ability are important. The WiYZ Gateway is equipped with an integral cellular modem for connectivity to the public cellular infrastructure.
The WiYZ Gateway supports the following connection types:
• 802.11b/g Wi-Fi for short-range, backhaul communication
• CDMA, GSM/GPRS, or EDGE Cellular Router for long range, backhaul communication
• MDS entraNET support for backhaul or MODBUS read/write of I/O data
• Serial command line for basic provisioning and diagnostics
• Web-based user interface
• Routing and bridging Ethernet networks onto the cellular infra-structure
• MDS mesh radios for data collection from directly connected sensors and signaling devices when remote data acquisition is needed:
- Frequency: 2.4 GHz
- Supports up to 50 nodes
- Maximum mesh depth of four hops
The WiYZ Gateway’s service allows inputs or outputs of a particular WiYZ Remote to be read or written by the SCADA host. This service is used in conjunction with the Modbus RTU/TCP data access service.
The WiYZ Gateway also supports configuration of remotes to provide I/O extension (regeneration) capabilities. This allows the outputs of one WiYZ Remote to be driven by the inputs of another WiYZ Remote.
The WiYZ Gateway provides a Data Reporting Service (DRS), allowing the data stored in an I/O database on the WiYZ Gateway to be sent peri-odically to an FTP or SFTP server. See “Data Reporting Service Usage Information” on Page 188.
This unique mix of wireless technology and data connectivity types offers new solutions for users requiring reliable communication with remote networks and monitoring devices where communication or power is limited.
NOTE: Some features may not be available on all units, depending on theoptions purchased and regulatory constraints for the region in whichitwill operate.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 5
Network Security
The WiYZ Gateway provides security for the entire network, including encryption and password access, as well as networking support for DHCP, Port Forwarding, and NAT.
WiYZ Gateway Model Number Codes
The Gateway's label contains model identification, serial number, EUI64, and regulatory information for the radios contained within. The GE MDS configuration information is also shown.
Additional unit details are available through the Device Information Menu, described later in this manual.
Accessories and Spares
Table 1 lists common accessories and spare items for the WiYZ Gateway. GE MDS also offers an Accessories Selection Guide listing an array of additional items that may be used with the product. Contact your factory representative or visit www.gemds.com to obtain a copy of the guide.
Table 1. WiYZ Gateway Accessories & Spare Items
Description Part Number
Antenna, 2400-2483.5 MHz, 12 dBi Omni, N-F w/ mounting (for entraNET 2400)
97-4278A06
Antenna, 2400-2485 MHz, 10 dBi Yagi w/ 18" jumper, N-F & mounting (for entraNET 2400)
97-4278A01
Antenna, 2400-2485 MHz, 14 dBi Yagi w/ 36" jumper, N-F & mounting (for entraNET 2400)
97-4278A02
Antenna, 2400-2500 MHz, 2 dBi Omni, N-M (for Mesh or Wi-Fi) 93-4278A48
Antenna, 806-960 / 1710-1990 MHz, 2 dB Omni, N-M (for Cellular)
93-4278A47
Antenna, 902-928 MHz, 7 dBd Omni w/ 16" jumper, N-M & mounting (for entraNET 900)
97-3194A17
Antenna, 902-960 MHz, 10 dBd Yagi, N-F w/ mounting (for entraNET 900)
97-3194A14
Antenna, 902-960 MHz, 6.4 dBd Yagi, N-F w/ mounting (for entraNET 900)
97-3194A13
Bracket Kit, Mast/Pole Mount 03-6542A01
Cable assembly, RJ45 CAT5 Straight, 6 ft. 97-1870A20
Cable assembly, Superflex jumper, N-M, 20 ft. 97-1677A118
Cable hanger kit (10 per kit) 97-1677A15
Cable ties (50 per set) 97-1677A42
Cable, LDF4-50A 1/2” foam (per foot) 97-1677A103
Cable, LMR-400 standard outdoor (per foot) 97-3675A10
Cable, LMR-400 Ultraflex (per foot) 97-3675A11
Cable, LMR-400 Watertight (per foot) 97-3675A12
Connector Kit, LDF4, N-M w/ bulkhead mount - up to 1 GHz 97-1677A189
6 WiYZ Technical Manual MDS 05-4954A01, Rev. C
2.2 Remote Description
Remote External Ports and Indicators
A WiYZ Remote is designed to be a NEMA 4X complient device suit-able for outdoor installations in both general safety and hazadous loca-tions (C1D2/ ATEX Zone2). Figure 5and Figure 6 show the Remote and an example of external ports with NPT and cable gland.Figure 7 shows the WiYZ Remote’s LED status indicators. These items are referenced in various locations in this manual. The Remote’s LED functions are described in Table 23 on Page 77.
Invisible place holder
Invisible place holder
Figure 5. Remote Front View
Connector Kit, LDF4, N-M w/ flange mount - up to 1 GHz 97-1677A170
Connector Kit, LMR400, N-M w/ bulkhead mount - up to 1 GHz 97-3675A88
Connector Kit, LMR400, N-M w/ flange mount - up to 1 GHz 97-3675A79
Connector, DB9 to RJ45 adapter 73-2434A12
Connector, LDF4-50A crimp connector, N male 97-1677A55
Connector, LMR-400 crimp connector, N male 97-3675A13
Filter, 902-927 MHz, BP 26 MHz 20-2822A02
Ground kit for LDF4-50A 97-1677A04
Ground kit for LMR-400 97-3675A65
Surge protector, 700-2700 MHz, Polyphaser DSXL, bulkhead mount w/ NM-NF
97-1680A24
Weatherproofing kit 97-3675A66
Table 1. WiYZ Gateway Accessories & Spare Items (Continued)
Description Part Number
MDS 05-4954A01, Rev. C WiYZ Technical Manual 7
Figure 6. Remote Ports Bottom View Example
Figure 7. Remote LED Status Indicators
WiYZ Remote—Key Product Features
The WiYZ Remote is an industrial wireless solution for monitoring dis-crete and analog signals from directly connected sensors and other sig-naling devices. It provides robust, versatile communications even in harsh environments and at sites with limited power and communication facilities.
8 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Key features of the WiYZ Remote include:
• MDS Mesh technology for self-organizing, self routing commu-
nication within a network:
- Frequency Range: 2.4 to 2.4835 GHz
- Carrier Power: 3.2 mW (5 dBm)
- Receiver Sensitivity: -95 dBm
• Configurable to provide ultra-low power consumption, for 5-year
self-powered battery operation
• Rapid deployment and low setup cost—minimal manual config-
uration required
• RS-232/485 serial data interface (MODBUS RTU)
• Fully packaged assembly including an antenna, battery, RF trans-ceiver and NEMA-4 enclosure
The unit’s self-contained design allows for quick installation and
deployment without the need for additional accessories. The WiYZ
Remote automatically determines communication routes with the WiYZ
Gateway.
Each WiYZ Remote features two digital inputs, two digital outputs, and
two analog inputs and/or outputs. All Remotes support an RS-232/485
serial port for connecting intelligent instruments and devices. The WiYZ Remote provides an I/O data tunneling service used to transmit
legacy protocol data between a sensor connected to the WiYZ Remote
and a remote SCADA host, using the ISA100.11a network.
The WiYZ Remote supports over-the-air firmware upgrades from the
WiYZ Gateway.
The WiYZ Remote also supports I/O extension (regeneration), allowing
the outputs of one WiYZ Remote to be driven by the inputs of another
WiYZ Remote.
NOTE: Some features may not be available on all units, depending on theoptions purchased and regulatory constraints for the region in whichthe WiYZ Gateway will operate.
Remote Label Information
The Remote’s model number is printed on the inside cover and side
labels. Additional unit details are available through the unit’s Device
Information Menu, described later in this manual.
The Outside label contains Model identification, serial number, EUI64,
and regulatory information. The interior labels (located inside the
Remote’s door) contain wiring specifics and factory configuration infor-
mation.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 9
Accessories and Spares
Table 2 lists common accessories and spare items for the Remote. GE MDS also offers an Accessories Selection Guide listing an array of addi-tional items that may be used with the product. Contact your factory rep-resentative or visit www.gemds.com to obtain a copy of the guide.
2.3 Gateway Menu Overview
Table 3 shows the available selections and hierarchy of the WiYZ Gateway’s Device Manager which provides complete configuration, maintenance, and system monitoring using a web browser. For instruc-tions on connecting to the Gateway and initial log-in, refer to “Web Browser Connection” on Page 67.
Table 2. Remote Accessories & Spare Items
Description Part Number
Antenna, 2300-2500 MHz, 13 dBi Panel w/ 12" RG58/U & N-F 97-4278A16
Antenna, 2400-2485 MHz, 10 dBi Yagi w/ 18" jumper, N-F 97-4278A01
Antenna, 2400-2485 MHz, 14 dBi Yagi w/ 36" jumper, N-F 97-4278A02
Antenna, 2400-2500 MHz, 2 dBi Omni, N-M (for Mesh or Wi-Fi) 93-4278A48
Antenna, 2400-2500 MHz, 4 dBi Omni, N-M (for Mesh) 93-4278A72
Bracket Kit, Mast/Pole -Mount 03-6542A02
Remote Battery Holder 82-4908A01
Battery Pack, 10.8 V 28-1575A08
Bracket, wall mount 82-4918A01
Cable hanger kit (10 per kit) 97-1677A15
Cable ties (50 per set) 97-1677A42
Cable, 8 conductor flex 03-3356A03
Connector Kit, LDF4, N-M w/ bulkhead mount - up to 1 GHz 97-1677A189
Connector Kit, LDF4, N-M w/ flange mount - up to 1 GHz 97-1677A170
Connector Kit, LMR400, N-M w/ bulkhead mount - up to 1 GHz 97-3675A88
Connector Kit, LMR400, N-M w/ flange mount - up to 1 GHz 97-3675A79
Filter, 902-927 MHz, BP 26 MHz 20-2822A02
Ground kit for LDF4-50A 97-1677A04
Ground kit for LMR-400 97-3675A65
Power Supply, 12v-30 W w/ AC/DC Switch 01-3682A02
Power Supply, 12v-30 W, 110/220 VAC, AC-DC 01-3682A01
Power Supply, 12 Vdc-12 Vdc 03-2435A07
Power Supply, 230/240 VAC-12 Vdc, AC-DC 03-2435A06
Surge protector, 700-2700 MHz, Polyphaser DSXL, bulkhead mount w/ NM-NF
97-1680A24
Weatherproofing kit 97-3675A66
10 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Detailed explanations of menu screens are provided in “SYSTEM MANAGEMENT REFERENCE DATA” on Page 107.
To protect against unauthorized use, a unique password should be set for the menu system as soon as possible after the equipment is received. The factory default password (admin) is intended for initial login by a new user, and should be changed using the Security Configuration page.
Table 3. Menu Overview
Top Level Menu Sub-Path Title Menu Title
Overview Summary WiYZ Summary
-- -- Health & Maintenance Summary
-- -- IP Address Summary
-- -- Configuration Summary
Setup Wizards
Basic Wizards Serial Configuration
-- -- Setup Wizards
Configuration Identity & Time Device Information
-- -- Date & Time Configuration
-- Radio Interfaces Wi-Fi Status
-- -- Wi-Fi Configuration
-- -- MDS Radio Configuration
-- -- Cellular Status
-- IP & Networking Bridge
-- -- LAN Port
-- -- MDS Radio
-- -- Wi-Fi
-- -- Cellular
-- -- VPN
-- -- Routing and Firewall Config.
-- -- Firewall Rule Table
-- Services TFTP Configuration
-- -- SNMP Configuration
-- -- Data Reporting Service
-- -- VPN Configuration
-- -- Modbus TCP Configuration
-- -- Modbus IO Registers Map
-- -- Export Modbus IO Registers Map
-- Security Management Configuration
-- -- Authentication
-- -- RADIUS Configuration
-- -- Certificate Import
MDS 05-4954A01, Rev. C WiYZ Technical Manual 11
-- -- Authorization
Maintenance& Status
Events & Alarms Active Alarms
-- -- Alerts Log
-- -- Export Alerts Log
-- -- System Log
-- Performance Network Statistics
-- -- Wi-Fi Status
-- -- Serial Statistics
-- -- MDS Radio Statistics
-- -- Bridge Status
-- Diagnostics Ping Test
-- -- Generate Support Package
-- Configuration Files Export Database Configuration
-- -- Import Database Configuration
-- -- Reset Database Configuration
-- Firmware Utilities Version Information
-- -- Firmware Reprogramming
-- -- Copy Image
-- -- Verify Image
-- -- Device Reboot
Mesh Network
Provisioning Mesh Networking
-- -- Device Access Control List
-- Status Devices
-- Manage FieldDevices
Device Information Summary
-- -- Profile Configuration
-- -- Modbus Register Map
-- -- Local-Loop Connections
-- Device Profiles Manage Profiles
-- -- Import/Export Profiles
-- MODBUS Map Manage MODBUS Registers Map
-- -- Export Modbus IO Registers Map
-- I/O Database I/O Database Graphing
-- -- I/O Database Information
-- -- Export I/O Database Information
-- Diagnostics Wireless Device Summary
Table 3. Menu Overview
Top Level Menu Sub-Path Title Menu Title
12 WiYZ Technical Manual MDS 05-4954A01, Rev. C
2.4 WiYZ ISA100.11a Mesh Network Introduction
The GE WiYZ contains an implementation of the ISA100.11a open wireless networking technology standard developed by the International Society of Automation (ISA). As defined by the ISA organization:
"This ISA standard is intended to provide reliable and secure wireless operation for non-critical monitoring, alerting, supervisory control, open loop control, and closed loop control applications. It defines the protocol suite, system management, gateway, and security specifica-tions for low-data-rate wireless connectivity with fixed, portable, and moving devices supporting very limited power consumption require-ments. The application focus is to address the performance needs of applications such as monitoring and process control where latencies on the order of 100 ms can be tolerated, with optional behavior for shorter latency.
To meet the needs of industrial wireless users and operators, this stan-dard provides robustness in the presence of interference found in harsh industrial environments and with legacy non-ISA100 compliant wireless systems. As described in Clause 4, this standard addresses coexistence with other wireless devices anticipated in the industrial workspace, such as cell phones and devices based on IEEE 802.11x, IEEE 802.15x, IEEE 802.16x, and other relevant standards. Furthermore, this standard allows for interoperability of ISA100 devices, as described in Clause 5.
This standard does not define or specify plant infrastructure or its secu-rity or performance characteristics. However, it is important that the security of the plant infrastructure be assured by the end user."
-- -- Channel Status
-- -- Neighbor Health List
-- -- Neighbor Graph List
-- -- Superframe List
-- -- Superframe Links List
-- Terminal Servers Device Terminal Server
-- Device Firmware Device Firmware Upgrade
-- Network Map Mesh Network Map
End of Menu Overview
Table 3. Menu Overview
Top Level Menu Sub-Path Title Menu Title
MDS 05-4954A01, Rev. C WiYZ Technical Manual 13
ISA100.11a Overview
Figure 8 on Page 14 describes the ISA100.11a wireless network archi-tecture along with devices supporting various roles defined in next sec-tion. It depicts the communication areas addressed by this standard, as well as those areas (shaded in blue) that are not in scope of this standard.
In Figure 8 , circular objects represent field devices (sensors, valves, actuators, etc.) and rectangular objects represent infrastructure devices that communicate to other network devices via an interface to the net-work infrastructure backbone network. A backbone is a data network (preferably high data rate) that is not defined by this standard. This back-bone could be an industrial Ethernet, IEEE 802.11, or any other network within the facility interfacing to the plants network.
A complete network consists of one or more field networks that may be connected by an infrastructure device to a plant network. A field net-work consists of a collection of field devices that wirelessly communi-cate using a protocol stack defined by this standard. As shown in Figure 8, some field devices may have routing capabilities, enabling them to forward messages from other devices.
A transit network consists of infrastructure devices on a backbone, such as backbone routers, gateways, system managers, and security man-agers. A backbone router has both a field network interface and a back-bone interface. A gateway has at least one network interface (either backbone or field network) and a plant network interface.
All addressing, routing, and transport is limited to the scope of the field network. All devices within such a network are identified by a 16-bit local unique ID and are globally identified by a 128-bit address.
14 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Figure 8. Mesh Architecture of an ISA100.11a Compliant Network
Roles
A role defines a collection of functions and capabilities. The ISA100.11a standard defines all the roles necessary for the network to operate properly, including system manager, security manager, gateway, backbone router, system time source, provisioning, router, and I/O device. All devices conforming to the standard implement at least one role. However, a device may implement many roles.
Table 4. ISA100.11A Device Roles
Role Description
I/O
A device with the I/O role provides (sources) data to or utilizes (consumes) data from other devices (and may both provide and utilize data) and has at least one user application process (UAP) object. The I/O role provides no mechanism for the forwarding of messages or routing for any other device.
Router
A device with the router role has routing capability,acts as a proxy, and has clock propagation capability. These de-vices can provide range extension for a network and path redundancy and may provide different levels of QoS on a message-by-message basis.
Provisioning
A device with the provisioning role (Provisioning device) is able to provision a device set to factory defaults. The provisioning device inserts the required configuration data into a device to allow a device to join a specific net-work.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 15
WiYZ ISA100.11a Implementation
The WiYZ system fulfills the roles of the ISA100.11a as shown below and detailed in the information in the rest of this document.
Table 5. ISA100.11A Device Roles
Backbone Rout-er
A device with the backbone router role has the routing ca-pability via the backbone, and acts as a proxy using the backbone. Backbone routers enable external networks to carry native protocol by encapsulating the PDUs for transport.
Gateway
The gateway role provides an interface between the sen-sor network and the plant network, or directly to an end application on a plant network. More generally, a gateway marks the transition between communications compliant to this standard and other communications and acts as a protocol translator between the application layer of this standard and other application layers.
System Manager
The system manager is a specialized function that gov-erns the network, devices, and communications. The sys-tem manager performs policy-based control of the network runtime configuration, monitors and reports on communication configuration, performance, and opera-tional status, and provides time-related services.
Security Manag-er
The system security management function, or security manager, is a specialized function that works in conjunc-tion with the system manager and optional external secu-rity systems to enable secure system operation.
System Time Source
A device implementing the system time source role imple-ments the master time source for the system. A sense of time is an important aspect of the ISA100.11a standard; it is used to manage device operation. The system time source provides a sense of time for the entire system.
Role Description
I/O WiYZ Remote - (Default mode with battery)
RouterWiYZ Remote - (Default mode with line power) - Also does I/O data collection
ProvisioningUser (via serial on WiYZ Remote - Web GUI on the WiYZ Gateway)
Backbone Router WiYZ Gateway
Gateway WiYZ Gateway
System Manager WiYZ Gateway
Security Manager WiYZ Gateway
System Time Source
WiYZ Gateway
Role Description
16 WiYZ Technical Manual MDS 05-4954A01, Rev. C
WiYZ Mesh Operational Considerations
• The WiYZ system supports a maximum of 50 WiYZ Remotes.
• WiYZ Remotes are NOT interoperable with other ISA100.11a systems.
• WiYZ Remotes should not be nested (hops) greater than 5 levels.
• Battery powered but unprovisioned remotes will enter a perma-nent low power state.
• Battery powered WiYZ Remotes that cannot join a network will enter low power mode after 5 minutes and power up to join every 6 hours.
• Routing WiYZ Remotes support a maximum of 8 connected field devices.
• WiYZ mesh range is highly dependent on antenna locations and environmental factors. (seeinformation in section 4.3 on page 55 below)
• Optimal mesh configurations may require the addition of extra routing field devices.
• 3rd Party ISA100.11a I/O devices may be configured to join the WiYZ Gateway but data gathering and configuration are not sup-ported.
• Line Powered remotes may require up to 10 minutes to join Gate-way.
• Remotes in low power configurations may require at least 6 hours or more to join the Gateway. (If the “sleeping” remote misses the beacon it will retry every 6 hours.)
• Changes to the time of day or format on the WiYZ Gateway causes the Mesh to restart to resynchronize the timekeeping.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 17
3.0 NETWORKING APPLICATIONSThis section describes some common scenarios in which the WiYZ Gateway and Remote may be employed. A number of variations are possible, and if you have unique requirements not covered here, it is rec-ommended that you consult a support specialist at GE MDS. Contact information is provided at the back of this manual.
3.1 Mesh Data Reported with Data Reporting
Service (DRS)
In this scenario, the customer is measuring the level of liquid contained in a number of tanks. Each tank has a level sensor connected to a WiYZ Remote unit. Each Remote measures and transmits data to the WiYZ Gateway at a rate called the publish interval. The WiYZ Gateway com-piles the data from all Remotes in the network and uploads the data to an SFTP server every 128 k bytes of data using the cellular modem, Wi-Fi, or MDS entraNET radio interfaces, respectively,as shown in Figure 9, Figure 10, and Figure 11.
The WiYZ Gateway supports the development of profiles that define all the behavior of Remotes (field devices). A profile specifies the type of field device, how often to sample digital and/or analog signals, data pub-lish frequency, among other settings. Once created a single profile may be applied any number of Remotes. Each WiYZ Remote requires a pro-file be applied to begin any I/O data publishing.
For this scenario, a single profile is created and applied to each Current Input field device to publish the input data every 15 minutes.
The WiYZ Gateway receives this information and records the readings it receives. The cellular modem has a constant connection as a network interface for the WiYZ Gateway. For example, every time 128 k bytes of data is collected it is gathered into a compressed, uniquely formatted CSV file (See “Data Reporting Service Usage Information” on Page 188). The file is transferred via FTP or SFTP using the cellular modem to a configured server.
18 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Figure 9. Mesh and Cellular Scenario
Figure 10. Mesh and Wi-Fi Client Scenario
MDS 05-4954A01, Rev. C WiYZ Technical Manual 19
Figure 11. Mesh and entraNET Remote Scenario
3.2 Cellular Network Routing & Port Forwarding
The Gateway supports routing of TCP/UDP/IP data from the Cellular WAN network interface to any of the other network interfaces including Wi-Fi, wired LAN, or MDS entraNET using network address and port translation (NAPT) feature and to the COM2 serial port using the ter-minal server feature.
For these routing scenarios, the WAN interface should be set as Cellular (default), the firewall should be enabled (in “Deny” mode), and NAT translation should be enabled. The firewall rules should be added to route specific traffic coming from the WAN to network devices con-nected to the other interfaces (i.e., LAN, Wi-Fi, entraNET) of the Gateway. Note that the default gateway on the destination device should be set to the WiYZ Gateway.
* Application bulletins are available in the documentation section of the GE MDS website for WiYZ.
Table 6. Related Application Bulletins Available*
Bulletin No. Description
AB11001 GE MDS WiYZ Cellular Connectivity
20 WiYZ Technical Manual MDS 05-4954A01, Rev. C
NOTE: Prior to enabling the Firewall in "DENY/DROP" mode(default) be sure to add a rule to allow incoming HTTPS fromthe WAN to the unit (refer to section 5.3). Failure to do so willprevent use of the GUI user interface from the WAN networkinterface when the Firewall enable is “committed.”
Example: Cellular Network Modbus/TCP Port Forwarding
Figure 12 below shows a scenario where incoming Modbus/TCP data on WAN interface of Gateway needs to be forwarded to a device (address 172.16.0.2) on a LAN network.
Invisible place holder
Figure 12. Cellular Network Routing & Port Forwarding Example
3.3 Digital Event Reporting to Gateway
Digital transitions can be detected on one WiYZ Remote (the source) and show up in the I/O database of the WiYZ Gateway. The source Remote can be battery powered. To set up the system for this scenario, the source Remote is configured with a profile that sets up a digital input in “Event” mode which is published to the Gateway. This mode only supports active HIGH input.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 21
The remote (even in low power mode) will wake on the detection of the Low-to-High transition of the digital signal. An event and value of “1” is transmitted to the Gateway for the configured input channel. At worst case with heavy traffic, message latency may be up to 8 seconds. In a lightly loaded system this latency is more typically 2 seconds.
A minimum of 250 ms later if the line has changed state, a message to the Gateway with the value of “0” is transmitted (with the same latency constraints). There is no guarantee of pulse timing replication.
3.4 Digital Event Reporting: Remote to Remote
A digital transition can be detected on one WiYZ Remote (the source) and replicated on a destination Remote. The source Remote can be low-power enabled while the destination must be continuously pow-ered. To set up the system for this scenario, the source Remote is con-figured with a profile that sets up a digital input to support “Event Mode” and the publish destination of the WiYZ Gateway which passes the message to the destination Remote. The destination Remote is con-figured with a profile that sets up an output channel to subscribe to the input channel of the source Remote. This mode only supports active HIGH input and there is no guarantee of pulse timing replication.
The Remote (even in low power mode) will wake on the detection of the Low-to-High transition of the digital signal. An event and value of “1” will be transmitted to the Gateway which then replicates this signal to the destination remote causing the output to change to a “High” or “1.” At worst case with heavy traffic, the message latency may be up to 30 seconds. In a lightly loaded system this latency is more typically 10-20 seconds. A minimum of 250 ms later the destination remote forces the output value back to a “0”.
Figure 13, “Digital Event Reporting Remote-to-Remote Configuration Example,” on page 22 is an example configuration for Digital Event Reporting from a source remote to a designation remote. In the first table the source remote’s first Digital Input (DI1) is configured to generate (“publish”) an event to the Gateway when the value transitions from 0 to 1. In the second table the first Digital Output (DO1) of the destination remote “subscribes” to receive the event from the Digital Input 1 of the source remote. Note that at initialization DO1 will be set to “OPEN”.
22 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Figure 13. Digital Event Reporting Remote-to-Remote Configuration Example
MDS 05-4954A01, Rev. C WiYZ Technical Manual 23
3.5 I/O Replication From Remote to Remote
An analog or digital value can “replicated” from one WiYZ Remote (the source) to another destination Remote. The source Remote can be bat-tery powered while the destination must be line-powered. To set up the system for this scenario, the “source” remote is configured with a profile that sets up an input (analog or digital) to publish the value to a specific remote “destination.” The destination remote is configured with a pro-file that sets up an output channel to subscribe to the input channel of the source remote. There is no guarantee of pulse timing replication.
The source Remote (even in low power mode) will periodically publish the value directly to the destination Remote. This mode supports publish frequencies of 64 seconds and less. These messages go directly from the source Remote to the destination Remote with a low latency of 1 to 2 seconds. These messages are not acknowledged and may be lost due to interference or other transmission difficulties.
Figure 14. I/O Replication Configuration Example
24 WiYZ Technical Manual MDS 05-4954A01, Rev. C
4.0 INSTALLATION PLANNING
Careful planning of the installation site will help achieve optimal perfor-mance from the Gateway, Remotes, and other system components. This section discusses the factors that should be considered prior to installing the Gateway and Remotes. Step-by-step installation procedures begin on Page 61.
The specific details at an installation site may vary, but there are four main requirements for installing the WiYZ system in all cases:
• Adequate and stable primary power for the Gateway
• Properly installed antennas at the Gateway and Remotes
• Correct interface connections between the Remotes and moni-tored devices
• Correct connections between the Gateway and the desired hard-wired or wireless network interfaces
Figure 15. Example System Installation
Remote
Remote
Remote
WiYZGateway
WiFi
PC
Cellular
PublicInfrastructure
Ethernet
PublicInfrastructure
WiYZRemotes
RTU
Serial
PLC Control
Tank LevelMonitoring
OEMInstruments
entraNET
RTU
EIA-232
EIA-232
TCP/IP
COM2
PWR
LINK
COM1
COM2
PWR
LINK
COM1
COM2
PWR
LINK
COM1
SerialDevice
EthernetDeviceWAN
GE MDS Private Network (Long Range)
GE MDS Mesh Technology
MDS 05-4954A01, Rev. C WiYZ Technical Manual 25
4.1 Gateway Installations
Mounting Options
Wall Mounting Plate Use the Wall Mounting Plate to install the Gateway as shown in Figure 16. Detailed dimensions for the mounting plate are provided in Figure 17.
Figure 16. Wall Mounting Plate Dimensions
Using screws longer than 1/4 inch (6 mm) to attach the mounting plate to the Gateway can cause internal damage. Use only the supplied screws.
CAUTIONPOSSIBLE
EQUIPMENT
DAMAGE
26 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Invisible place holder
Figure 17. Mounting Plate Dimensions (Inches)
Mast/Pole Mount Bracket Kits
A Mast/Pole Mount Bracket kit (Figure 18) is available for securing the Gateway (03-6542A01) or Remote (03-6542A02) to a mounting sup-port. These brackets attach to the back of the WiYZ units with the four screws provided. The Gateway and Remote brackets are similar in appearance, but the Gateway bracket is larger.
For small mast mounting (i.e., conduit tubing, pipe, etc.), two U-clamps may be placed through the holes at the top and bottom of the bracket, and then secured around the mast. For larger mounts (i.e., a wooden utility pole), strapping may be used, by running it through the cutouts provided in the top and bottom of the bracket and then around the mast.
Figure 18. Mast/Pole Mounting Bracket
Screw Holes (4) forAttaching to Device
U-Clamp Holes forSmall Mast Mounting
Strapping Cutout forLarge Pole Mounting
Carabiner Hole(for carrying)
MDS 05-4954A01, Rev. C WiYZ Technical Manual 27
Figure 19. Remote Mast/Pole Mounting Bracket Dimensions
Table 7. Gateway & Remote Mast/Pole Mount Bracket Key
Dimensions
Measurement Parameter Specification
U-clamp holes, center-to-center distance
2.4 in
U-clamp holes, diameter 0.438 in
Strapping cutout width 1.93 in
Overall bracket length 15 in (Gateway)10 in (Remote)
28 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Figure 20. Gateway Mast/Pole Mounting Bracket Dimensions
MDS 05-4954A01, Rev. C WiYZ Technical Manual 29
Antennas
The recommended omnidirectional antennas, shown in Figure 21, pro-vide adequate multidirectional coverage for most applications. A number of other antenna styles may be used when a particular coverage pattern is required. The exact style and gain factor depend on the layout of your system and the distance between the Gateway and the nearest Remote(s). Typically, the MDS Radio Antenna Port is connected to a Yagi (directional) antenna, as shown in Figure 22 on Page 30.
Figure 21. Gateway Whip Antennas
Table 8. WiYZ Gateway Antenna Types
NOTE: All antenna connections are made to the WiYZ Gateway usinga coaxial Type-N connector.
Connector(Type-N)
Allowed Antennas (GE MDS Part Number)
Mesh Omni (2.4 GHz), 2 dBi 97-4278A48
Mesh Omni (2.4 GHz), 4 dBi 93-4278A72
Wi-Fi (2.4 GHz) 97-4278A48
Cellular 97-4278A47
eNET (900 MHz)
eNET (2.4 GHz)
97-4278A49 (Omni)97-3194A14 (Yagi)
30 WiYZ Technical Manual MDS 05-4954A01, Rev. C
A directional Yagi antenna (Figure 22) is generally used on the entraNET portion of the Gateway to minimize interference between neighboring wireless systems and maximize range. An RF coaxial feed line is required with this antenna. The equipment necessary for this type of installation is available from GE MDS. Contact your local sales rep-resentative for details.
Figure 22. Typical Yagi Antenna (mounted to mast)
DC Power Connection
Power the Gateway with any well-filtered 10 to 30 Vdc power source capable of providing 15 watts. See “NOTES ON SNMP” on Page 195 for full power consumption specifications.
The WiYZ Gateway includes a 6-foot power cable suitable for indoor or outdoor use when properly connected.
The DC power connector is keyed, and a proper connection is made when the white dots on the plug and receptacle are lined up. Rotate the collar ¼ turn clockwise to lock the plug in place.
Invisible place holder
Figure 23. DC Power Connector
NOTE: The Gateway is designed for use in negative ground systemsonly.
Reverse Polarity Protection Limitations
As with all installations there is a possibility that when power is con-nected to the WiYZ Gateway it can made in reverse polarity. While the WiYZ Gateway contains limited protection from this mistake the pro-tection can be overwhelmed if the power supply provides a significant
MDS 05-4954A01, Rev. C WiYZ Technical Manual 31
amount of current. It is therefore recommended to use power sources
with maximum current limiting to 2.5 A. This limitations stems from the
design required to withstand significant power surges (2000 V for 50
msec) in an industrial environment.
Grounding Considerations
The Gateway is designed to be adequately grounded if it is mounted to
a well-grounded metal surface using the supplied flat mounting bracket.
If the Gateway is not mounted to a grounded metal surface, a safety
ground wire attached to one of the screws on the Gateway’s mounting
plate is recommended.
To minimize the chance of damage to the Gateway and any connected
equipment, an NEC Class 2 compliant safety ground is recommended.
A compliant safety ground electrically connects the Gateway, power
supply, connected data equipment, and antenna system (if antennas
other than the included omni antennas are used) to a single-point
ground. It is recommended that all ground leads be kept as short as pos-
sible.
For tower-mounted antennas, a lightning protector is recommended
where the antenna cable enters the building. Connect the lightning pro-
tector to the tower ground, if possible.
Serial Data Interfaces
The Gateway’s COM1 and COM2 connectors serve as the serial interface
ports for Gateway console and payload data, respectively. The following
sections identify the pin functions used on each interface. The COM2
port is user-configurable for specific applications.
NOTE: Not all PCs include a serial port. If one is not available, a USBport may be used with a USB-to-Serial adapter and appropriatedriver software. These devices are available from severalmanufacturers.
COM1 (Management) Connections
The Gateway’s COM1 port (Figure 24) is the backup interface for PC
management or diagnostics of the Gateway. It can be used at the time of
installation to set basic parameters such as IP address and authorization
codes. PC connection and terminal setup details are given in “Initial
System Configuration” on Page 67.
Figure 24. COM1 Connector (DB-9F)
As viewed from outside the unit
5
9 6
1
32 WiYZ Technical Manual MDS 05-4954A01, Rev. C
For typical applications, use a straight-through DB-9 cable for PC man-agement. If desired, a cable may be constructed as shown in Figure 25, using Pins 2 (RXD), 3 (TXD), and 5 (Ground). Table 9 lists all COM1
pins.
The Gateway’s COM1 port supports a serial data rate of 115200 bps, 8N1.
Figure 25. COM1 Wiring for PC Management
RXD
TXD
GND
2
3
5
RXD
TXD
GND
2
3
5
>
<
DB-9 FEMALE(COMPUTER)
DB-9 MALE(RADIO SIDE)
Table 9. COM1 Pin Descriptions—Gateway
PinNumber
Input/Output Pin Description
1 OUT DCD (Data Carrier Detect)
2 OUT RXD (Received Data)—Supplies received data to the connected device.
3 IN TXD (Transmitted Data)—Accepts TX data from the connected device.
4 IN DTR (Data Terminal Ready)
5 -- Ground—Connects to ground (negative supply potential) on chassis.
6 OUT DSR (Data Set Ready)
7 IN RTS (Request to Send)
8 OUT CTS (Clear to Send)
9 -- No function in most applications—User I/O for special applications
MDS 05-4954A01, Rev. C WiYZ Technical Manual 33
COM2 (Data) Connections
Although it may be configured differently, the COM2 port (Figure 26) is the primary interface for connecting the Gateway to an external DTE serial device supporting the RS-232 or RS-485 serial data format. The Gateway’s COM2 port supports a serial data rate of 1200, 2400, 4800, 9600, 19200, 38400, 57600, and 115200 bps (asynchronous only). Sup-ported data formats of:
• 8N1 - 8 char bits, no parity, 1 stop bit (DEFAULT)
• 8N2 - 8 char bits, no parity, 2 stop bits
• 8O1 - 8 char bits, odd parity, 1 stop bit
• 8O2 - 8 char bits, odd parity, 2 stop bits
• 8E1 - 8 char bits, even parity, 1 stop bit
• 8E2 - 8 char bits, even parity, 2 stop bits
• 7N1 - 7 char bits, no parity, 1 stop bit
• 7N2 - 7 char bits, no parity, 2 stop bits
• 7O1 - 7 char bits, odd parity, 1 stop bit
• 7O2 - 7 char bits, odd parity, 2 stop bits
• 7E1 - 7 char bits, even parity, 1 stop bit
• 7E2 - 7 char bits, even parity, 2 stop bits
Pin Descriptions:RS-232 and RS-422/485 Mode
Table 10 and Table 11 provide detailed pin descriptions for the COM2
data port in RS-232 mode and RS-485 modes, respectively.
NOTE: The Gateway is hard-wired as a DCE device.
Figure 26. COM2 Connector (DB-9F)
As viewed from outside the unit
5
9 6
1
34 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Table 10. COM2 Pin Descriptions — Gateway in RS-232 Mode
PinNumber
Input/Output Pin Description
1 -- Reserved—User I/O for special applications
2 OUT RXD (Received Data)—Supplies received data to the connected device.
3 IN TXD (Transmitted Data)—Accepts TX data from the connected device.
4 -- Reserved—User I/O for special applications
5 -- Signal Ground—Connects to ground (negative supply potential) on chassis.
6 -- Reserved—User I/O for special applications
7 IN RTS (Request-to-Send)—Keys the transmitter.
8 OUT CTS (Clear-to-Send)—Goes “high” after the programmed CTS delay time has elapsed (DCE), or keys another connected device when RF data arrives (CTS KEY).
9 -- Reserved—User I/O for special applications
Table 11. COM2 Pin Descriptions—Gateway in RS-485 Mode
PinNumber
Input/Output Pin Description
1 -- Reserved—User I/O for special applications
2 OUT TX- (TXA) (Transmitted Data +)—Inverting driver output. Supplies received payload data to the connected device.
3 IN RXD-/RXA (Received Data +)— Inverting receiver input. Accepts payload data from the connected device.
4 -- --
5 -- Ground—Connects to ground (negative supply potential) on the device’s PC board.
6 -- Reserved—User I/O for special applications
7 IN RX+/RXB (Received Data -)— Non-inverting receiver input
8 OUT TXD+/TXB (Transmitted Data -)—Non-inverting driver output.
9 -- Reserved—User I/O for special applications
MDS 05-4954A01, Rev. C WiYZ Technical Manual 35
COM2 PORT NOTES & WIRING ARRANGEMENTS:
• RXD+ / RXB and RXD– / RXA are data sent into the Gateway to be transmitted out
• RXD+ / RXB is positive with respect to RXD– / RXA when the line input is a “0”
• TXD+ / TXB and TXD– / TXA are data received by the Gateway and sent out
• TXD+ / TXB is positive with respect to the TXD– / TXA when the line output is a “0”
Invisible place holder
Figure 27. RS-422/485 Wiring Arrangements
Ethernet Data Interface (RJ-45)
The WiYZ Gateway Ethernet port is used to connect to an external Ethernet device. The port has built-in MDIX (auto-sensing) capability, allowing either a straight-through or crossover cable to be used. Figure 28 and Table 12 show pinout data for the Ethernet port. The port supports both device management and payload data transport.
Connecting to the Gateway using Telnet/SSH supports Gateway man-agement and provides the same limited user interface available using the serial COM1 port.
Various options are available for passing Ethernet data, allowing system administrators to optimize the configuration for maximum narrowband efficiency, based on the operating characteristics of the system.
Figure 28. Ethernet Port (RJ-45) Pinout
(As viewed from the outside of the unit)
Table 12. Ethernet Port (IP/Ethernet) Pinouts
Pin Functions Ref.
1 Transmit Data (TX) High
2 Transmit Data (TX) Low
3 Receive Data (RX) High
4 Unused
5 Unused
6 Receive Data (RX) Low
8 1234567
36 WiYZ Technical Manual MDS 05-4954A01, Rev. C
7 Unused
8 Unused
Table 12. Ethernet Port (IP/Ethernet) Pinouts (Continued)
Pin Functions Ref.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 37
4.2 Remote Installations
Remote PCB Connector/Switch Locations
Refer to Figure 29 for component locations.
• ON/OFF switch (SW201) – Enables/disables battery power to the unit. Units with a battery ship from the factory with this switch in the OFF position. (This switch is omitted in Remotes with an A07 or greater suffix.)
• Antenna mount (N-Connector) – is designed for use with omni-directional antennas (up to 4 dBi gain). A Yagi antenna may be used as shown in Table 2 on Page 9 but omni antennas are rec-ommended for best “mesh” capabilities.
• Fuse (FH501) – A 2-Ampere fuse.
• Terminal Strip (J201)– I/O Analog/Digital signals connector.
• LED Ribbon Cable Connector (J604) – is under the battery bracket. The ribbon cable to the LEDs attaches here, metal side up.
• Status Switch (SW600) – Used to wake the Remote, re-enable the J602 (diagnostics) port, and activate the LEDs.
• Battery Connector (J208) – Keyed battery connector.
• COM1 Console (J602) – RJ11 diagnostic port with command line interface for initial provisioning and setup (115200 bps, 8N1).
NOTE: Use only Pins 4, 5, and 6 on COM1. Undesired operation,including reboot hang-ups, may occur if other pins are used.This also applies to RJ11-to-DB9 converters connected toCOM1.
• COM2 Data (J601) – RJ45 data port for serial connection (RS232/RS-485) to external devices.
• Non-Isolation Jumper (J203) – Disables isolation when jump-ered.
38 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Invisible place holder
Figure 29. PCB Connector/Switch Locations
Input/Output Information
You can order the WiYZ Remote with four different hardware I/O con-figurations:
Voltage Low The single-ended device supports a low voltage I/O set:
• Two digital inputs (0, 5 Vdc to 24 Vdc)
• Two digital outputs (2 A at 24 Vdc)
• Two analog voltage inputs (0 to 100 mVdc)
• Two analog voltage outputs (0 to 5 Vdc)
• One 6V (40 mA) sensor power supply output
The differnential device supports a low voltage I/O set:- FUTURE
• Two digital inputs (0, 5 Vdc to 24 Vdc)
• Two digital outputs (2 A at 24 Vdc)
• Two differential analog voltage inputs (0 to 100 mVdc)
• One 10.1 V (40 mA) sensor power supply output
MDS 05-4954A01, Rev. C WiYZ Technical Manual 39
Voltage High This device supports a high voltage I/O set:
• Two digital inputs (0, 5 Vdc to 24 Vdc)
• Two digital outputs (2 A at 24 Vdc)
• Two analog voltage inputs (0 to 5 Vdc)
• Two analog voltage Outputs (0 to 5 Vdc)
• One 10.1 V (40 mA) sensor power supply output
Current In This device supports a current input I/O set:
• Two digital inputs (0, 5 Vdc to 24 Vdc)
• Two digital outputs (2 A at 24 Vdc)
• Two analog current inputs (0 to 22 mA)
• One 24 V (40 mA) sensor power supply output
Current Out This device supports a current output I/O set:
• Two digital inputs (0, 5 Vdc to 24 Vdc)
• Two digital outputs (2 A at 24 Vdc)
• Two analog current outputs (0 to 22 mA)
• One 24 V (40 mA) sensor power supply output
See “NOTES ON SNMP” on Page 195 - for more detailed information
Wiring Information
The following pages describe each of the four board/connection types: Voltage Low, Voltage High, Current Input, and Current Output.
40 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Voltage Low Single Ended
Invisible place holder
Figure 30. Voltage Low Single Ended PCB
Table 13. VLTerminal Strip (J201) Connections
Pin Signal Description
1 DIGITAL IN 1 Digital Input 1
2 DIGITAL IN 2 Digital Input 2
3 DIGITAL IN COM Digital Input Common
4 ISO GND Isolated Ground
5 DIGITAL OUT 1 Digital Output 1
6 DIGITAL OUT 2 Digital Output 2
7 DIGITAL OUT COM Digital Output Common
8 GND Ground
9 V IN 1 Analog Voltage Input 1
10 V IN 2 Analog Voltage Input 2
11 GND Ground
12 V OUT 1 Analog Voltage Output 1
13 V OUT 2 Analog Voltage Output 2
14 + VDC IN (7-30) Power In
15 VDC IN GND VDC Ground
16 + 6 VDC OUT Sensor Power Supply Output
MDS 05-4954A01, Rev. C WiYZ Technical Manual 41
Voltage Low - Differential
Invisible place holder
Figure 31. Voltage Low Differential PCB - Future
Table 14. VLTerminal Strip (J201) Connections
Pin Signal Description
1 DIGITAL IN 1 Digital Input 1
2 DIGITAL IN 2 Digital Input 2
3 DIGITAL IN COM Digital Input Common
4 ISO GND Isolated Ground
5 DIGITAL OUT 1 Digital Output 1
6 DIGITAL OUT 2 Digital Output 2
7 DIGITAL OUT COM Digital Output Common
8 GND Ground
9 +mV IN 1+ Analog Voltage Input 1+
10 -mV IN 1- Analog Voltage Input 1-
11 GND Ground
12 +mV IN 2+ Analog Voltage Input 2+
13 -mV IN 2- Analog Voltage Input 2-
14 + VDC IN (7-30) Power In
15 VDC IN GND VDC Ground
16 + 10.1 VDC OUT Sensor Power Supply Output
42 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Voltage High Invisible place holder
Figure 32. Voltage High PCB
LV
1 2 3 4 5 6 7 8 11 141312 15 16109
vv
Table 15. VH Terminal Strip (J201) Connections
Pin Signal Description
1 DIGITAL IN 1 Digital Input 1
2 DIGITAL IN 2 Digital Input 2
3 DIGITAL IN COM Digital Input Common
4 ISO GND Isolated Ground
5 DIGITAL OUT 1 Digital Output 1
6 DIGITAL OUT 2 Digital Output 2
7 DIGITAL OUT COM Digital Output Common
8 GND Ground
9 V IN 1 Analog Voltage Input 1
10 V IN 2 Analog Voltage Input 2
11 GND Ground
12 V OUT 1 Analog Voltage Output 1
13 V OUT 2 Analog Voltage Output 2
14 + VDC IN (7-30) Power In
15 VDC IN GND VDC Ground
16 + 10.1 VDC OUT Sensor Power Supply Output
MDS 05-4954A01, Rev. C WiYZ Technical Manual 43
Current Input Invisible place holder
Figure 33. Current Input PCB
LV
1 2 3 4 5 6 7 8 11 141312 15 16109
vv
Table 16. CI Terminal Strip (J201) Connections
Pin Signal Description
1 DIGITAL IN 1 Digital Input 1
2 DIGITAL IN 2 Digital Input 2
3 DIGITAL IN COM Digital Input Common
4 ISO GND Isolated Ground
5 DIGITAL OUT 1 Digital Output 1
6 DIGITAL OUT 2 Digital Output 2
7 DIGITAL OUT COM Digital Output Common
8 GND Ground
9 +mA IN 1 Analog Current Input 1+
10 -mA IN 1 Analog Current Input 1-
11 GND Ground
12 +mA IN 2 Analog Current Input 2+
13 -mA IN 2 Analog Current Input 2-
14 +VDC IN (7-30) Power In
15 VDC IN GND VDC Ground
16 +24 VDC OUT Sensor Power Supply Output
44 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Current Output Invisible place holder
Figure 34. Current Output PCB
1 2 3 4 5 6 7 8 11 141312 15 16109
vv
Table 17. CO Terminal Strip (J201) Connections
Pin Signal Description
1 DIGITAL IN 1 Digital Input 1
2 DIGITAL IN 2 Digital Input 2
3 DIGITAL IN COM Digital Input Common
4 ISO GND Isolated Ground
5 DIGITAL OUT 1 Digital Output 1
6 DIGITAL OUT 2 Digital Output 2
7 DIGITAL OUT COM Digital Output Common
8 GND Ground
9 +mA OUT 1 Analog Current Output 1+
10 -mA OUT 1 Analog Current Output 1-
11 GND Ground
12 +mA OUT 2 Analog Current Input 2+
13 -mA OUT 2 Analog Current Input 2-
14 +VDC (7-30) Power In
15 VDC IN GND VDC Ground
16 +24 VDC OUT Sensor Power Supply Output
MDS 05-4954A01, Rev. C WiYZ Technical Manual 45
COM1 (J602) RS232 Diagnostic Pinouts
COM2 (J601) RS232 Mode Payload Pinouts
COM2 (J601) RS-485 Mode Payload Pinouts
BATT (J208) Pinouts
I/O Transient Protection
The input lines of the Remote are protected by clamping diodes that pro-tect all lines from high voltage and energy “spike” transients. Figure 35 shows the protection scheme for all Remote types. The transient protec-tion scheme connected to the digital circuitry canbe connected to an Iso-lated ground (Pin 4 on J201) when the Non-Isolation Jumper (J203) is removed.
RJ11 Pin Signal Direction
1 Reserved—Do not connect --
4 Transmit Data (TXD) Output
5 Receive Data (RXD) Input
6 Ground (GND) --
RJ45 Pin Signal Direction
4 Ground (GND) --
5 Received Data (RXD) Output
6 Transmitted Data (TXD) Input
7 Clear to Send (CTS) Output
8 Request to Send (RTS) Input
RJ45 Pin Signal Direction
4 Ground (GND) --
5 TX+ (TXB) Output
6 RX+ (RXB) Input
7 TX- (TXA) Output
8 RX- (RXA) Input
Pin Signal Direction
1 VBatt+ --
2 VBatt- --
46 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Invisible place holder
Figure 35. Transient Protection Scheme for Digital and Analog Circuits
Power Configurations
Vdc Input The WiYZ Remote accepts 7 to 30 volts from a DC source, and provides power to the circuitry as well as the sensor power supply. The input voltage has reverse voltage and over-voltage protection. The voltage is sampled by monitoring Pins 14 and 15 on J201.
Battery Input The Remote may be powered by a factory-supplied internal battery pack which connects to the unit via connector J208. For proper operation, only the factory-supplied battery should be used. The battery can power the Remote unit for up to five years under the following conditions:
• Input (0-5 V) readings (analogs and/or digitals)
• Publish interval is configured for 15 minutes
• Sensor load equivalent to 1K Ohm
• Effective battery cell capacity is 14-Amp hours (ampere-hour, Ah)
A battery-powered Remote disables all digital and analog outputs when it goes into idle (low power) mode. When the battery voltage is low, the Remote sends a “battery low” alarm message to the Gateway. A Remote in this configuration defaults as a field device.
NOTE: When exiting sleep mode, analog outputs may briefly switchon and then off over an 8-10 ms period.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 47
Battery Back-up Operational Considerations
A WiYZ Remote can utilize the non-rechargeable battery pack to pro-vide for a back-up power source in the event the loss of line power. There is no specific user settings required. There are some limitations and caveats for this mode.
• The unit may reboot to when switching between power sources.
• When line power (7-30 Vdc) is present the remote defaults as a Router.
• When operating on battery power the unit defaults as an I/O (non-routing) node.
• The operation mode may be set to a specific mode in the device profile regardless of the physical hardware arrangement of the Vdc and/or battery.
• For A06 remotes Line power voltage should be at least 2 V higher than battery voltage. (13V or more) to avoid sourcing power from the battery.
• For A07 remotes line power voltage (>1.5 Vdc) will prevent the battery from powering the unit. Thus a “brown out” of line volt-age will NOT switch to the battery - even if the available voltage is inadequate to power the unit (< 7 Vdc)
Non-Rechargeable Battery Considerations
The non-rechargeable battery option for the WiYZ Remote provides a low power mode of operation by default when it is the power source. The battery is a 14 ampere-hour lithium-ion pack that provides 10 Vdc via a special connector (J208) attached to the processor board of the WiYZ Remote.
When the battery is the sole power source of the WiYZ Remote, it is rated at up to 5 years of operation using a 15 minute publish rate while reading one or more input channels (analog or discrete). In low-power mode (sometimes referred to as “sleeping”) the WiYZ remote draws less than 120 uA of current. In this mode all outputs are disabled. (i.e., Vext, Analog and Digital outputs).
48 WiYZ Technical Manual MDS 05-4954A01, Rev. C
There are many factors that affect projected battery life. Key among them is duty cycle—the amount of time the device is on versus the amount of time it is in low-power mode. The following charts provide “rules-of-thumb” for estimation purposes.
Invisible place holder
Figure 36. Battery Life Graph
The WiYZ Remote provides the capability to extend the duration of the sampling period for sensors that require time to stabilize when power is applied using the Vext power output. The following table illustrates the estimated effect of extending the “on” time and is based on the best case 15 min. sample/publish rates:
Table 18. Projected Battery Life
Publish Rate Months Years
0.25 s 0.5 --
0.5s 1 --
1 s 2 --
2 s 3 --
4 s 7 --
8 s 12 --
16 s 21 1.8
32 s 32 2.7
64 s 43 3.6
5 min. 60 5.0
15 min. 63 5.3
30 min. 65 5.4
1 hr. 65 5.4
2 hr. 66 5.5
6 hr. 66 5.5
0.5 1 2 3
7
12
21
32
43
6063
65 65 66 66
0.25 s 0.5 s 1 s 2 s 4 s 8 s 16 s 32 s 64 s 5 min 15 min 30 min 1 hr 2 hr 6 hr
Months
Months
MDS 05-4954A01, Rev. C WiYZ Technical Manual 49
This table illustrates that,with a sensor drawing approximately 6 mA, a hold times of 1 to 4 seconds has a minor effect on battery life. How-ever, above 4 seconds, the power consumption during the “hold time” starts to dominate and the battery lifetime is significantly affected.
Remote I/O Connection Circuit Examples
The following are example wiring diagrams that should assist when con-necting external sensors and actuators to the WiYZ Remote.
WiYZ Voltage Input Wiring Examples
Table 19. “On” Time Extension for Sensors
Sampling Rate(minutes)
Sensor Hold Time(sec)
Estimated BatteryLifetime (years)
15 0.25 6.7
15 1 6.3
15 4 5
15 10 3.6
50 WiYZ Technical Manual MDS 05-4954A01, Rev. C
MDS 05-4954A01, Rev. C WiYZ Technical Manual 51
52 WiYZ Technical Manual MDS 05-4954A01, Rev. C
WiYZ Digital Input Wiring Examples
MDS 05-4954A01, Rev. C WiYZ Technical Manual 53
WiYZ Current Output Wiring Examples
NOTE: During WiYZ Remote low power operation ALL outputs aredisabled. This is default mode when operating from battery.
54 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Sensor Remote I/O Connections
Application bulletins are available from GE MDS to assist users with connecting sensors to WiYZ Remotes. At the time of publication, the bulletins listed in Table 20 are available, and may be accessed from our web site at www.gemds.com. Additional bulletins will be added over time, so users should check the web site for future updates.
Table 20. Related Application Bulletins Available
Bulletin No. Description
AB11002 Connecting 0-5 Vdc Devices to a WiYZ Remote
AB11003 Connecting 4-20 mA Devices to a WiYZ Remote
MDS 05-4954A01, Rev. C WiYZ Technical Manual 55
4.3 WiYZ Wireless Interfaces
MDS Mesh Network
Do the following to maximize performance between the Gateway and Remotes:
• Keep metal or conductive objects as far away from the antennas as possible.
• Make sure the 2.4 GHz antenna is connected to the correct port on the Gateway, upper left hand corner connector when looking at front status panel of Gateway.
• If the Remote unit is mounted to a pole and the signal level is too low, try rotating the unit up to 30 degrees in either direction to improve the signal.
• If the Remote mesh antennas can be moved, try moving the Remote antenna up or down 1 foot (30cm) or less for best receive signal level.
• Try to get the best line-of-sight path between the Gateway and as many of the Remotes as possible.
• In general, the higher the Gateway and Remote antennas are installed, the greater the range.
• If mounting the Mesh antenna away from the Gateway or the remote, Use low loss coaxial cable designed for 2.4 GHz opera-tion.
56 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Optimizing for Range and Performance
A typical WiYZ mesh radio system consists of one Gateway and several Remote units to control or monitor numerous points in a system or pro-cess. The Gateway unit should be centrally located as practically as pos-sible to all the Remote units to improve data quality and throughput. A typical installation with one of many Remote units and a Gateway unit is shown in Figure 37 :
Figure 37. Typical WiYZ Remote Installation
A practical understanding on how low power, short range, and low antenna height propagation works will allow for a better system design and effective troubleshooting. Looking at Figure 37, the line labeled LOS represents the “line of sight” RF signal radiating from the Gateway antenna to the Remote antenna which is the preferred and predictable RF propagation path. The Remote unit can also receive a ground reflected signal formed by an RF signal represented by the lines d1-d2. The sum of the LOS and reflected signals at the Remote antenna can range from adding in phase to produce a 6 dB signal improvement to adding out of phase, effectively canceling the receive signal entirely. Both the dis-tance between the Remote and Gateway units along with the height the Remote unit is above the ground affects whether the RF signals add or cancel. Figure 38 shows the Rx signal level received at the Remote when the distance (d) and the Remote antenna high (hr) varies. The “RX Threshold” line represents the minimum signal level required for the Remote unit to work with 50% reliability.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 57
Figure 38. RF signal level changes with distance and antenna height
The graph depicts the expected RF signal level at the Remote unit when the Gateway mesh antenna is 10 feet off the ground (hg=10 ft) and dis-tance between the Remote and Gateway unit is varied. The black line is for a Remote unit that is 5 feet off the ground or hr=5 feet as depicted in Figure 37. The “RX Threhold” line represents the minimum signal level required for the Remote unit to work 50% reliability. For example, at a distance of 127 feet and 253 feet, the Remote unit will not be able to work at all due to the recieve signal level dips below the red minimum required recieve level line. At distances of 100, 166 and dis-tances greater than 300 feet, the Remote unit will work better than 80% of the cases because the signal level is more than 8 dB above the “RX Threhold” line. If Remote unit needed to be at a distance between 240 and 270 feet, the Remote unit could be moved to a height of 4 feet or 6 feet as represented by the blue and magenta lines respectively, to increase the RF signal level for a usable RF link. Moving the Remote unit horizontally to get out of the RF signal null could take up to 50 feet or more depending on Gateway antenna height.
Stated simply: Move the Remote unit antenna up and down for the best signal level before permanently mounting the Remote and/or antenna.
58 WiYZ Technical Manual MDS 05-4954A01, Rev. C
From an RF point of view, the Gateway unit/antenna should be mounted up to 20 feet above the ground with the antennas mounted above and a way from metal objects. Preferably, the mesh antenna should be attached to the Gateway RF connector or remotely mounting the mesh antenna above the Gateway unit using low loss RF cable for use at 2.4GHz. A clear line of sight between the Gateway antenna and most, if not all of the Remote units is preferred. The Gateway antenna height should be only as high as needed to communicate to all the Remote units reliably.
The Remote units preferably should be mounted 3 to 5 feet off the ground with the antenna mounted to the box. It may be necessary to increase the height of the Remote antenna (hr) by either mounting the Remote unit higher or remotely mount the associated antenna higher to achieve a reliable RF link.
Determining the approximate Gateway and Remote antenna heights for the typical application is an easy step by step process.
1. Determine the maximum required distance between the Gateway and the Remote units. From Table 21, choose the minimum Gateway antenna height to achieve this required distance for a usable Remote antenna height. The Gateway antenna height is now fixed and should not move.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 59
Table 21. RF Range vs Gateway/Remote antenna height
2. Set height of all Remote units to that determined in Table 21as a general rule
3. During installation and system verification, optimize all Remote unit mounting heights for highest recieve signal strength.
As referred to above the WiYZ system can be configured to support having several hops between the Gateway and Remote units using routing nodes. This range extension strategy, using up to 5 routing nodes, does not significantly impact packet latency and a range of sev-eral thousand feet can be achieved.
Remote
G
ate
way
Antenna Height
(ft) 3 4 5 6 7 8 9 10
5 823 902 960 1008 1050 1108 1152 1176
10 1006 1124 1178 1240 1288 1334 1347 786
15 1142 1236 1308 744 808 866 916 964
20 1250 1322 792 869 938 1003 1064 1125
25 694 1347 882 973 1051 1134 1206 918
30 749 858 967 1068 1154 902 959 1022
35 801 938 1046 1152 904 979 1046 1118
40 857 997 1136 1253 975 1052 1144 1210
Maximum distance between Gateway & Remote (ft)
Remote
G
ate
way
Antenna Height (m) 0.9 1.2 1.5 1.8 2.1 2.4 2.7 3.0
1.5 251 275 293 307 320 338 351 358
3.0 307 343 359 378 393 407 411 240
4.6 348 377 399 227 246 264 279 294
6.1 381 403 241 265 286 306 324 343
7.6 212 411 269 297 320 346 368 280
9.1 228 262 295 326 352 275 292 312
10.7 244 286 319 351 276 298 319 341
12.2 261 304 346 382 297 321 349 369
Maximum distance between Gateway & Remote (m)
60 WiYZ Technical Manual MDS 05-4954A01, Rev. C
NOTE: WiYZ Remotes that are configured to operate as RoutingNodes, should use the same antenna mounting guidelines asfor the Gateway.
MDS entraNET Backhaul
Do the following to maximize performance between the Gateway and entraNET transceiver:
• Make sure the antenna feed line is connected to the correct port on the Gateway.
• Ensure the Yagi antenna is properly aimed (if applicable) and “line of sight” to the intended tranceiver.
• In general, the higher the antenna is installed, the greater the range.
802.11x Wi-Fi Short-Range Backhaul
Do the following to maximize performance between the Gateway and the Wi-Fi access point:
• Make sure the 2.4 GHz antenna is connected to the correct port on the Gateway.
•
• In general, the higher the Gateway is installed (up to 20 feet), the greater the range.
Cellular Router Long-Range Backhaul
Do the following to maximize performance between the Gateway and the cellular tower:
• Make sure the antenna is connected to the correct port on the Gateway.
• Check the cellular signal strength in the area with a cell phone on the same network.
• In general, the higher the Gateway is physically installed, the bet-ter chance of making a cell connection. Small movements of the mounting position often have a strong effect on signal strength.
Network Bridge Planning
The default WiYZ system configuration has the LAN, entraNET, and Wi-Fi networks bridged. Network interfaces that are “in the bridge” means that traffic on one network can be available on another network. For example, if the LAN and Wi-Fi interfaces are in the bridge, data traffic not destined for the WiYZ Gateway can pass freely from one to the other.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 61
For security and bandwidth considerations, a user might want to remove networks from the bridge so, for example, data packets coming into Wi-Fi are not directed out the low-bandwidth entraNET connection. Removal from the bridge makes each network interface independent, and therefore networks not in the bridge can access only the WiYZ Gateway.
Advanced details of Networking concepts such as Routing and Bridging are outside the scope of this manual but are available from Cisco and the Cisco Certified Network Associate (CCNA) program.
NOTE: Using the routing capabilities of the WiYZ Gateway canprovide and control traffic moving between network interfacesnot in the bridge. The Cellular modem by its nature can neverbe added to the bridge.
NOTE: The entraNET radio is a low-bandwidth device and will droptraffic when subjected to requests for high volumetraffic. Itshould be removed from bridge if the bridge will be handlinghigh volume traffic.
4.4 WiYZ Gateway Installation
1. Mount the WiYZ Gateway. The unit can be mounted using a wall mount plate, a pole mount, or strapped to a mast.
2. As needed, attach the appropriate radio antennas:
• Upper left - Mesh Radio 2.4 GHz
• Upper right - Cellular Modem
• Lower Left - Wi-Fi 2.4 GHz
• Lower Right - MDS Proprietary - 900 MHz or 2.4 GHz
See Figure 39 on Page 62. Connector details and part numbers for these antennas can be found in Table 8 on Page 29.
62 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Invisible place holder
Figure 39. Gateway Whip Antennas
(MDSRadio antenna is typically a Yagi type; see Table 8 on Page 29)
3. Connect the Ethernet Cable to the WiYZ Gateway.
4. If using a serial connection for initial IP configuration, connect a PC to the COM1 port on the WiYZ Gateway.
The only user configurable parameters from this interface, via the command line, are the IPv4 address, and subnet mask (all of which are also available from the web interface). The IP address defaults to 192.168.1.1 and the mask to 255.255.255.0
The COM1 port supports serial connection of a host computer in the RS-232 format. The Gateway supports a data rate of 115200 bps, 8N1 (asynchronous only).
5. Serial Data Interface If the system requires an additional serial device, connect it to COM2 on the WiYZ Gateway. (This is for data only; the Gateway cannot be managed via the COM2 port.)
6. Connect DC power to the WiYZ Gateway. The WiYZ Gateway requires 10 to 30 Vdc.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 63
7. Establish wireless interfaces with the WiYZ Gateway:
• Mesh: See “Mesh Network Provisioning and Setup” on Page 90.
• Wi-Fi: See “Wi-Fi Configuration” on Page 115.
• entraNET: See “MDS Radio” on Page 122.
NOTE: Some PCs do not offer a serial port. In these cases, aUSB-to-Serial adapter (with appropriate driver software) maybe used. These adapters are available from a number of manu-facturers.
Figure 40. Gateway Class 1 Div 2 / ATEX Zone 2 Connectors
(General safety version also available see Figure 2 on Page 3)
NOTE: To connect to the metal conduit fitting you must use a IP54 (orbetter) rated interconnect to maintain ATEX Zone 2 Cat 3compliance.
8. Install /Mount the Gateway. See the Figure 41 and Figure 42 for examples/guidance:
64 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Gateway Installation Guidance:
Figure 41. Preferred Gateway Installation
Figure 42. Alternate Gateway Installation
The WiYZ Gateway should be securely fastened to a mounting structure such as a wall, building, pole, etc. using appropriate mountings, as depicted in Figure 41. Preferred installation height of gateway is 5 to 20 feet off the ground to provide RF coverage of all radio systems in use. The mounting structure should be below and away from the Gateway eNET and cellular modem antennas to ensure optimal RF system perfor-mance.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 65
An alternative installation may be required if Gateway is to be mounted at a low elevation. For best system performance, use low-loss coaxial cable designed for 2.4GHz or higher frequency range and the length should be as short as possible to reduce loss. Keep WiFi and Mesh radio antennas as far apart as practical to reduce interference.
The WiFi antenna can be mounted on the Gateway and near mounting structure if range is restricted to close to Gateway operation. If general coverage operation is required, remote mounting of WiFi antenna will be required and as shown for alternative Mesh radio antenna installation.
eNET radio antenna should be a Yagi antenna for maximum range and if possible, provide line of sight to intended AP or remote ENET radio.
4.5 WiYZ Remote Installation
During the following steps refer to Figure 43, as required:
1. Attach the antenna. The recommended omnidirectional antenna provides adequate multidirectional coverage for most applications. A number of other antenna styles may be used when a particular coverage pattern is required. The exact style and gain factor depend on the layout of your system and the distance to the nearest Remote(s) or Gateway. For recommended antennas, see “Antennas” on Page 29.
NOTE: All antenna connections are made to the Gateway using acoaxial N connector.
2. Mount the WiYZ Remote units. Can be mounted using a wall mount plate, a pole mount, or strapped to a mast.
3. Connect the sensors and/or actuators being monitored to the I/O connector. For more information, refer to Figure 29 on Page 38 and “NOTES ON SNMP” on Page 195.
4. For units with a battery, ensure that Switch SW201 (on HW ver-sion A06 and below) is in the ON position. Units with a battery ship from the factory with SW201 in the OFF position. There may also be a film over the switches (used in the manufacturing process) that you can remove, if necessary.
66 WiYZ Technical Manual MDS 05-4954A01, Rev. C
5. Optional: Connect DC power to the Remote units. The WiYZ Remote requires 7 to 30 Vdc.
Figure 43. WiYZ Remote Terminal Strip
6. Install /Mount the Remote. See the Figure 44 for examples/guid-ance:
Remote Installation Guidance:
Figure 44. Remote Installation Examples
MDS 05-4954A01, Rev. C WiYZ Technical Manual 67
The remote unit should be securely fastened to a mounting structure
such as a wall, machine, well pipe, pole, etc., using appropriate sized
fasteners and mounting bracket as depicted by “Preferred Installation”
Figure 44. The mounting structure should be below and away from the
remote antenna to ensure maximum RF system performance. The
remote antenna height should typically be within 6 feet (or 2 meters) of
the ground to reduce receive signal cancellation due ground reflections.
If the Remote unit cannot be mounted at this preferred height, the
“Alternate Installation” in Figure 44 can be utilized which maintains the
Remote antenna height above the ground but allows the Remote enclo-
sure to be installed as the situation warrants. The RF cable that connects
the antenna to the Remote unit should be a low loss coaxial cable design
for 2.4GHz or higher frequency range the length should be as short as
possible to reduce loss. Use of RF connector adapters should be mini-
mized to reduce RF signal loss which affects system range performance.
4.6 Initial System Configuration
Web Browser Connection
This section describes connection and use of the unit’s built-in Device
Manager. To connect to the unit and manage it via the Device Manager,
you will need the following:
• A PC with a web browser program installed and on the same sub-
net as the WiYZ Gateway. Most common browser platforms are
supported, including recent releases of HTML 5 Internet
Explorer, Mozilla Firefox, Opera, Safari, and Google Chrome.
• An Ethernet cable connected between the PC’s Ethernet jack, and
the WiYZ Gateway’s Ethernet jack. (Alternatively, a network
connection may be used, as long as the Gateway can be reached
via its IP address.)
• The WiYZ Gateway’s IP address. Check with your Network
Administrator, or determine the address from the Gateway’s
Overview-Summary screen. The default address for a factory
shipped new Gateway is 192.168.1.1.
If the IP address is not known, the web-based menu system cannot
be used to manage the WiYZ Gateway. It will be necessary to log
into the serial console menu to locate or modify the IP address.
• The user name and password for the WiYZ Gateway. Check with
your Network Administrator or, if a user name and password have
not been set, use the factory defaults of admin for both entries.
(For security, a new password should be established as soon as
possible after login.)
68 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Logging On 1. Connect the WiYZ Gateway to a PC via an Ethernet connection.
2. Configure your PC network settings to an IP address on the same subnet as the WiYZ Gateway. The default subnet mask is 255.255.255.0. Check with your system administrator if the mask is not set to the default string.
3. Enter the Gateway’s IP address in a web browser window, just as you would enter a web site address. When the login screen appears (Figure 45), enter the User Name and Password for the Gateway. The default entries for a new Gateway are both admin. Click Login.
Invisible place holder
Figure 45. Login Screen
If trouble is encountered when trying to connect via a web browser, refer to the warning messages for various browser programs, beginning on Page 107 of this manual.
COM2 Serial Data Setup
The COM2 Serial Port can be usedfor a variety of purposeswhen moving information to and from the serial port in RS-232 or RS-485 mode. These modes are configured using the Serial Wizard.
Invisible place holder
Figure 46. Setup Wizard-Serial Communication
The WiYZ Gateway allows the setup of the COM2 port as a terminal server that passes data to/from the serial port to network interfaces. The serial port must be configured to do this, not only for baud rate and data format, but also how the serial port parses the incoming data stream into packets for delivery to the network. Packets are identified by size (in bytes) or by the lack of bytes being transmitted in a specified amount of time. Generally, the terminal server ignores the data content but when configured to Modbus option, the data is expected to contain Modbus header information that can be inspected and the packet directed as con-figured.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 69
Invisible place holder
Figure 47. Serial Wizard Screen
Configuring the COM2 Data port using the “Serial Wizard” provides for the following options:
• TCP Server – Defines a specific data port (30011 default) that any external host may connect to for data transmission as a TCP con-nection.
• TCP Client – Defines a host IP and port that the WiYZ Gateway will connect to as a TCP connection.
• TCP Client and Server – provides both of the above capabilities
• Unicast UDP – Defines a specific data port (30011 default) and external host info for unicast UDP packets.
• Multicast UDP – Defines a specific data port (30011 default) and external host info for multicast UDP packets.
• Modbus Passthrough – configures the port to pass Modbus mes-sages from a network connection to/from the serial port. Packets with the WiYZ Gateway slave Id will not be passed but operated on and responded to.
• Modbus Slave – configures the port to pass Modbus messages into the Gateway from the serial port, and if not destined for the WiYZ Gateway passed to a Modbus TCP connection. Packets with the WiYZ Gateway slave Id will not be passed but operated on and responded to.
The Basic Setup Wizard for serial Terminal Service communication (Figure 46) May be started by selecting Setup Wizards>>Basic Wizards, and then clicking the Serial Wizard button. The Wizard displays a series of screens with key selections as follows:
• IP Protocol
• TCP/UDP Communication Type• IP Port Assignments
• Talkback Mode
• Data Format• Inter-Packet Delay
• Transceiver Line Mode
70 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Continue through each wizard screen until all selections have been made. (You may back up to previous screens if required, to review or change settings.) If you are unsure about a required setting, contact your Network Administrator for assistance. At the conclusion of the wizard, click Commit.
Cell Modem Setup The Cellular modem is also configured using a wizard. The WiYZ Gateway supports both Verizon and GSM cellular modem setup based on the configuration ordered. Figure 48 is the initial screen.
Figure 48. Setup Wizard-Initial Screen Example
As shown in Figure 50 select the service provider from the drop down list. Use Verizon if the WiYZ Gateway has been configured to contain a Verizon cellular modem. Otherwise, for the GSM modem, install the SIM card supplied by the service provider using the modem port on the side of the Gateway. See Figure 49 for the sequence for installing a SIM card. After installation select a provider (or use Other) from the drop-down list that supplied the SIM card and enter and/or modify the infor-mation.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 71
Figure 49. Setup - SIM Card Installation
Figure 50. Setup Wizard - Cellular Service Providers
For example in Figure 51, selecting AT&T as the cellular service pro-vider and pressing Next automatically fills in the APN, username and password fields. Edit the fields if necessary.
72 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Figure 51. Setup Wizard - AT&T Default Setup
When using a cellular service provider that is not one of the available choices select "Other", press Next, and fill in the APN, username and password fields obtained from the provider.
Figure 52. Setup Wizard - Other Setup
When using a cellular service provider that is not one of the available choices select "Other", press Next, and fill in the APN, username and password fields obtained from the provider.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 73
Figure 53. Setup Wizard - Other Setup
At the conclusion of cell modem setup Confirm activation of the Yes all the selected changes. Exiting the wizard prior to this step will lose all information entered on previous screens
Figure 54. Setup Wizard - Confirm Changes
When setting up Verizon cell modem, after commit of the information and if it is the first time the modem is being configured, the wizard will request to proceed with activation by entering the MDN (phone number received from the Verizon). See Figure 55. After activation the first time, this screen will always appear if cell modem is enabled again. Choose No if the modem has already been activated.
74 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Figure 55. Setup Wizard - Verizon Activate Confirmation
Provisioning with the Network Device Manager
You should define the network prior to the start of system installation. This includes the network id, join keys, specific Remotes, and so on. The Gateway and Remotes must be provisioned (configured) with the defined information prior to system operation.
Provisioning consists of providing the Remote with information regarding the Gateway it will communicate with, and providing the Gateway with information regarding each Remote that it is authorized to exchange data with. See “WiYZ System Setup Topics” on Page 90 for specific details on provisioning screens and other menu details.
NOTE: When a Remote successfully connects to the Gateway, theLINK LED illuminates. On the Gateway, the MESH LED lightsred when the internal mesh communication is ready, and lightsgreen when one or more Remote units link successfully.
After the system (Gateway and Remotes) have had basic provisioning and have communications, you can then define how and what informa-tion the Remotes will deliver to the WiYZ Gateway, and to an upstream host. The WiYZ Gateway contains this definition data, and it controls the information that configures the operation of the Remote units.
The WiYZ Gateway supports the development of profiles that are applied to the connected Remotes. Profiles are generic templates that define the parameters required for the Remotes (field devices). A profile specifies the type of field device it can be applied to, how often to sample and publish digital and/or analog signals, and so on. This defined profile is applied by the user to each Remote. More information on pro-files can be found on Page 77.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 75
4.7 Initial Startup & Checkout
Gateway Startup In-service operation of the WiYZ Gateway is completely automatic. The only operator actions required are to apply power and check the front panel LEDs for proper indications as described in Table 22.
NOTE: When the WiYZ Gateway is first powered on, the LEDs flashin a distinctive pattern during the power-up process. Allow 10to 30 sec for normal LED operation.
Figure 56. Gateway LED Status Indicators
Table 22. Gateway LED Descriptions
LED Name Function
Power Off—Power not applied.
On—Power applied.
Blinking—Alarms present.
Mesh Off—Mesh disabled.
Red—Mesh enabled, no connected Remotes.
Green—Mesh enabled, at least one connected Remote.
Wi-Fi Station Operation or Ad-Hoc Operation:• Off—No connection.• Solid green—Connected with “good” signal (RSSI stronger than -48
dBm).• Solid amber—Connected with “medium” signal (RSSI between -49
dBm and -69 dBm).• Solid red—Connected with “weak” signal (RSSI less than -70 dBm).
AP Mode:• Off—Wi-Fi disabled.• Solid green—One or more connected clients.• Solid red—No connected clients.
Cell Off—No cellular connection.
Solid green—Cellular connection with a good signal (RSSI stronger than -80 dBm).
Solid amber—Cellular connection with a medium signal (RSSI between -90 dBm and -80 dBm).
Solid red—Cellular connection with a weak signal (RSSI less than -90 dBm).
76 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Remote Startup After initial provisioning, the in-service operation of the WiYZ Remote is completely automatic. The only operator actions required are to apply power and check the front panel LEDs for proper indications as described in Table 23.
NOTE: When the WiYZ Remote is first powered on, the LEDs flash ina distinctive pattern during the power-up process. Allow 5 to15 sec for normal LED operation.
Figure 57. Remote LED Status Indicators
eNET entraNET Remote Operation:• Off—No connection.• Solid green—Connected with “good” signal (RSSI stronger than -75
dBm).• Solid amber—Connected with “medium” signal (RSSI between -76
dBm and -95 dBm).• Solid red—Connected with “weak” signal (RSSI less than -96 dBm).
entraNET Direct-Mode Node Operation:• Off—Disabled.• Solid green—One or more Remotes connected to a direct mode Root.• Solid red—No Remotes connected to a direct mode Root.
entraNET Direct-Mode Root Operation:• Off—Disabled.• Solid green—Available for connected Remotes.
LAN Off—No Ethernet link.
On—Ethernet link established.
Flash—Ethernet data on interface.
COM1 Blinks if TX or RX data is present on the COM1 interface.
COM2 Blinks if TX or RX data is present on the COM2 interface.
LED Name Function
MDS 05-4954A01, Rev. C WiYZ Technical Manual 77
Table 23. Remote LED Descriptions
When the Remote is in low power mode, press the Status Switch for approximately 1 second to enable the LED status indicators for 5 min-utes.
4.8 Wireless Sensors Network Settings
Provisioning Recap
As shown in the previous procedures, at installation time the WiYZ Remotes are provisioned with information about the Gateway they com-municate with, and the WiYZ Gateway is provided with information about each Remote.
A subnet ID is required for the system in order to uniquely identify the Gateway and all the Remotes operating in a network. If networks are co-located, each network has this unique identification that prevents inadvertent connections to another network.
The Access Control List (ACL) is a list on the WiYZ Gateway that iden-tifies all authorized Remotes whose devices are in the same Subnet ID. A Remote that attempts to connect with a valid Subnet ID but is not in the ACL is not provided access or configured.
Profiles
The WiYZ system supports a maximum of 50 field devices for each WiYZ Gateway unit. All data, alerts, management commands, and so on must fit within this limitation. For example, if the maximum allowed bandwidth is 1 Kbytes/sec, then 50 field devices could send a theoretical maximum of 5 bytes/sec, or approximately one analog reading per second.
LED Name Function
Power • Off: No power to unit
• Solid Red (with other LEDs flashing red): System booting
• Solid Green: Powered on and system normal
• Fast Blink/Red: If immediately after power up, this indicates a radio failure. Otherwise, errors are reported to the Gateway unit.
Link • Off: Not connected to any network
• Solid: Connected to a network
Signal • Off: Not joined to any network
• Solid Green: Connected with good signal (greater than -48 dBm)
• Solid Amber: Connected with medium signal (-48 dBm to -69 dBm)
• Solid Red: Connected with weak signal (less than -70 dBm)
Data • Off: no input or output configured
• On: at least one input or output configured
78 WiYZ Technical Manual MDS 05-4954A01, Rev. C
As discussed previously, the WiYZ Gateway supports the development of profiles that define all behavior of Remotes (field devices). A profile specifies the type of field device, how often to sample and publish dig-ital and/or analog signals, and so on. Once defined, this profile can be applied to one or more Remotes. This greatly simplifies the setup of a WiYZ system consisting of a number of similar Remotes.
Assigning Profiles Once a profile has been successfully created and saved, you can assign it to one or more Remotes of the same type. As the profile is assigned to each Remote, the system calculates the impact on the system in terms of communication bandwidth. If the available bandwidth used exceeds that which is supported by the system, the profile assignment will fail.
Modifying an Active Profile
The recommended way to modify an active profile is to save it to a new inactive profile, or create a new one, and then modify and save it before applying it to the devices that require it.
A profile committed to one or more field devices can be modified while in use, but this is not recommended because the user needs to manually re-commit the profile to all devices using it. In such a case, a warning is displayed before the modified active profile can be saved.
Use the “Device Profiles” page to select the profile to create a new pro-file or copy an existing profile by saving one with a new name.
Figure 58. Device Profile Page
MDS 05-4954A01, Rev. C WiYZ Technical Manual 79
Once the profile is created you can apply this profile to Remotes on the Manage Field Devices page.
Select a Joined Remote to manage. Select the Profile Configuration tab, and then click the Apply Profile button to configure the Remote with the selected profile settings.
Figure 59. Profile Configuration
You can apply a profile to one or more Remote field devices. Because the system must balance and validate the network traffic load, this pro-cess requires applying the profile to one Remote at a time, with a suc-cessful response.
NOTE: Remember that each Apply to a Remote field device affectssystem bandwidth usage. The successful application of aprofile to one Remote does not imply that the same profile canbe applied to all Remotes.
Since the system can accommodate over 50 unique profiles, it provides enough space to have several versions of each profile as needed.
Router vs. I/ODevice Designation
Remotes operate in two modes: as an I/O device or as a router. As an I/O device, the Remote can be battery powered or line-powered. The battery-power/ line-power mode is determined by detecting the voltage input on the battery or line power connections.
80 WiYZ Technical Manual MDS 05-4954A01, Rev. C
If an end-device is battery powered, it will enter a low-power mode automatically to conserve battery life. By default, line powered devices do not enter low power mode. However, line power mode can be over-ridden in the profile to allow the device to enter low power mode. This is useful in solar applications where the voltage is coming from a external battery pack that is recharged with a solar panel.
When a Remote is designated as a router, it passes data from other I/O devices, and is required to be line-powered. A router does not enter low power mode. Note that Remotes operating in low power mode do not support Digital or Analog Outputs to optimize battery life.
The automatic battery power operation mode (when input power is attached to the battery connector) is “Low Power - Routing Disabled.” This mode of operation provides the best battery life. It doesn't pass data from other remotes so battery life is directly related to the publish interval. Note that when entering low power mode all output power is disabled and the LED remains off after an initial startup period. This behavior can be selected even if the unit has power on the black J201 connector.
A selectable operation mode is “Low Power - Routing Enabled.” This mode provides better battery life but since it passes data from other remotes, battery life is not only related to the publish interval butalso the network traffic that may wake the remote up to pass data. This behavior can be selected even if the unit has power on the black J201 connector.
When powered by “line power” from the black connector, the remote's automatic operational mode acts as “Normal Power - Routing Enabled.” This remote in this mode passes data from other remotes, the outputs and LEDs are always active. This behavior cannot be selected if the unit is battery powered.
Finally, the operation mode “Normal Power - Routing Disabled” is available. As above, this mode of operation is not recommended for bat-tery operation because although it doesn't pass data from other remotes, and outputs and LEDs are always active. This behavior can be selected even if the unit has power on the white battery connector. This mode might be used to effect mesh setup.
Remote Types and Template Profiles
Asdiscussed in previous sections a Remote field device is available in four unique hardware configurations to support Current Input, Cur-rent Output, Voltage High (0-5 Vdc) or Voltage Low (0-100 mV). Four template profiles are available to be tailored into unique settings for each type or up to 50 unique profiles—one for each Remote field device. The template profiles generate no data and may be used as a “parking spot” for Remote field devices that are not yet assigned or in transition between profiles.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 81
Enabling or Disabling Periodic Readings (Publish)
Remote field devices can be configured to sample and then publish data on a set schedule:
• Milliseconds: 250, 500
• Seconds: 1, 2, 4, 8, 16, 32, 64
• Minutes: 5, 15, 30
• Hours: 1, 2, 6
For publish times selected to be less than or equal to 64 seconds, every effort is made to deliver the data to the WiYZ Gateway or selected WiYZ Remote device, but is subject to loss due to interference or com-munications problems.
NOTE: Remember that each Apply to a Remote field device affectssystem bandwidth usage. The successful application of aprofile to one Remote does not imply that the same profile canbe applied to all Remotes.
Selected publish periods of 5 minutes and above are published to the WiYZ Gateway and use an acknowledged protocol that verifies that the data was successfully delivered.
NOTE: 250 and 500 ms publish rates are intended for use in smallnetworks of 10 or fewer Remotes, with only 3-4 operating atthese rates.
Engineering Unit Conversion
I/O data collected from the Remote field devices can be displayed or collected in a human-readable format by applying an engineering unit conversion to the data. A linear conversion is available for each input and output which provides a minimum value that reflects the value at 0 counts, and a maximum value at full scale.
NOTE: If sensor normalization was applied at the Remote field devicethat will need to be taken into account when applying engi-neering unit conversions.
Digital inputs also allow for a unit (typically something simple such as ON/OFF) to provide a more intuitive interpretation of the input’s state.
4.9 Serial Data via COM2 Support
The Remote can support limited transport of serial data to/from client operating through the WiYZ Gateway. There are limitations to this sup-port as follows:
82 WiYZ Technical Manual MDS 05-4954A01, Rev. C
1. Gateway Terminal Server Setup – to pass packets to Remote COM2 serial port.
2. Auto message fragmentation/defragmentation is not supported.
3. Packets can be no larger than 69 bytes.
Additionally, this service may be utilized on a battery-powered Remote in low power modes with these additional constraints/behaviors:
1. Waking the Remote from a low power state causes the first byte of a message to be lost.
2. The remote re-enters low power mode as soon as a packet is deliv-ered out the serial port.
4.10 Data Reporting Service
The Data Reporting Service (DRS) on the Gateway allows the data col-lected from the Remotes and stored in I/O database to be sent periodi-cally to a FTP or SFTP server formatted in a special report form of a comma-separated-variable (CSV) ASCII file as shown in “Data Reporting Service Usage Information” on Page 188.
This service generates sequential output data files when a temporary file size exceeds the selected file size threshold. The output file format is tracked by a sequence number. By default, output files are compressed. Total accumulated output is managed by size, and configurable criteria that governs output wrap around.
Infrastructure Requirements
1. Deploy FTP or SFTP (SSH protocol version 2.0) servers.
2. If SFTP, create an SSH account and configure the DRS service with its username and password. (FTP also requires a user name and password, but not an SSH account.)
MDS 05-4954A01, Rev. C WiYZ Technical Manual 83
Naming Convention
The file name contains a sequence number, time-stamp, unit name, and version. The format is as follows:
<DRS Customer-ID>_uuuuuuuuuu_xxxxxxx_yyyymmddhhmmss_xxxxx.dat
Operational Notes
The DRS service attempts transfer of all output data files every time it creates a new output data file.
The DRS service attempts to transfer an output data file for a maximum of four times (first attempt, plus three retries) every 1 minute. In case all attempts are unsuccessful, DRS service waits until the creation of a new output data file to attempt transfer again.
When the DRS service is disabled, any pending file transfers are can-celled and the temporary files deleted.
Table 24. DRS Parameters
Name Segment Definition Description
[DRS Customer-ID] Customer ID The configured Customer ID. This field is be displayed as a 4-character ASCII string. Leading underscore characters (‘_’) are applied. Example, GEWA or _KRR.
[uuuuuuuuuu] Unit name The first 10 characters of the configured unit name. This field is displayed as 10-character ASCII string. Leading zeros are applied. Example TANKGW0100
[xxxxxxx] Unit serial Number
The serial number of the Gateway. This field is displayed as 7-digit number. Example 1947017
[yyyymmddhhmmss] Time The time of the LAST record in the file. This is system time, which is synchronized with NTP server. The value is displayed as a 14-character ASCII string. Leading zeros are applied. Example 20060118131034
[xxxxx] Sequence Number
A 2-byte value with a range of 0 to 65535. The value is displayed as a 5-character ASCII string. Leading zeros are applied. Example 00035, not 0x00023.
This is the sequence number of the last entry in file.
Example: GEWA_TANKGW0100_1234567_20080506141020_0004.dat
84 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Scheduling
Transfer of collected data is triggered based on the user configured amount of data collected, which can range from 8 KB to 5 MB. Based on the amount of data and frequency of collection for a given system, the user cancontrol the size, and thus the frequency of transfer.
Network Interface Assignment
Data Reporting will transfer files to any network interface that supports the configured port and address information configured on the Configu-ration >> Services page in the Data Reporting Service section. When selecting the transfer network, keep in mind the bandwidth of the selected interface compared to the amount of data to be transferred. For example, a 5 MB file will require a significant transfer time on a 9600 bps link compared to a 10 Mbps direct-wire Ethernet link.
4.11 MODBUS Access
The WiYZ Gateway implements a subset of the Modicon MODBUS TCP communication standard. The WiYZ Gateway is always a slave unit; it cannot be programmed as a master. Computers or PLCs are com-monly programmed as masters. Monitoring, programming, and control functions are performed with read/write register commands.
A Modbus master can communicate with a WiYZ Gateway using MODBUS TCP protocol over cellular, Wi-Fi, entraNET or Ethernet interfaces or via the serial port using MODBUS RTU protocol.
To set up the Gateway for MODBUS TCP operation, refer to the infor-mation and screen examples beginning on Page 134.
“Standard” or “Enhanced” Modbus behavior may be selected as fol-lows:
• Standard—Return error for unavailable registers of range request.
• Enhanced—Return user value for unavailable registers of range request.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 85
“Enhanced Modbus” has the following traits/behaviors:
• Return user value for unavailable registers of range request
• Failed Binary Return Value
• Multi-Access (Binary Discrete or Coil registers)
• Error exception for failed access
• Binary preset value is used for each special return value.
• All registers use the same global setting.
• Failed Analog Return Value
• Multi-Access (Analog Input or Holding registers)
• Error exception for failed access to one of the register within range
• This analog preset value is used for each special return value
• All registers use the same global settings.
The Modbus mapping table is automatically generated based on various Input/Output channel settings contained in a device profile that is man-ually created. The device profile is then applied to a configured WiYZ Remote field device.
The Modbus mapping table candidate list is generated by adding a device to the ACL table. The resulting set of registers may be generated based on various defined Input/Output channels for the device type. Registers can be automatically or manually assigned a Modbus register identifier profile. MODBUS registers may be assigned by the user or automatically generated within the address range of 1 to 65535. Automat-ically assigned registers follow the numbering illustrated in Table 30 on Page 156.
Modbus Operational Considerations
All Modbus modes of data access in the WiYZ Gateway behave the same way. Read requests of Analog/Digital Inputs result in a database query that provides the last published reading of the associated Modbus register that is present in the I/O database.
Analog/Digital Output Reads&Writes are forwarded via ISA100.11a Mesh out to the Remote Field device. These transactions can take up to 20 seconds to complete because of ISA100 network latencies. Modbus clients will need to support this timeout duration.
If a WiYZ Remote is unavailable (unjoined) the WiYZ Gateway it will immediately respond with a Modbus error (or failsafe value if set to enhanced multi-read mode)
86 WiYZ Technical Manual MDS 05-4954A01, Rev. C
The Gateway supports three different Modbus protocol settings including Modbus TCP, Modbus Pass-through Mode, and Modbus Slave Mode using Modbus RTU/ASCII protocols. Modbus RTU/ASCII utilize the COM2 data port that is set up using the Serial Wizard.
• Modbus TCP—These transactions are supported by any of the Network interfaces that are enabled (LAN, WAN, MDS Proprie-tary, Wi-Fi, etc). There is support of up to 128 Modbus masters connecting to port 502 (default).
• Modbus Pass-Through Mode—The Modbus TCP messages that have Unit IDs not matching those of the WiYZ Gateway are for-warded out the COM2 serial port. Responses from the Com2 serial port areforwarded back to the requesting network device.
• Modbus Slave Mode—This mode supports a Modbus Master on the COM2 serial port that can issue Modbus requests. The Gate-way responds to serial requests matching its unitID and any TCP requests (unitID ignored, same as 'Modbus TCP' mode).
Combinations are supported of:
- Simultaneous TCP and serial queries with serial configured as slave (TCP ignores unitID)
- Respond to queries with our unitID with serial configured as TCP (passthrough)
NOTE: Although having multiple Modbus masters accessing thesingle COM2 port in pass-though mode is supported, it canresult in data collisions and undefined behavior if not wellcontrolled.
4.12 SNMP MIB Files
The Gateway contains over 100 custom SNMP-manageable objects as well as the IETF standard RFC1213 for protocol statistics, also known as MIB II. You can use off-the-shelf SNMP managers to access the transceiver’s SNMP Agent’s MIB, such as Castle Rock Computing SNMPc™ and Hewlett Packard OpenView™. The Gateway’s SNMP agent supports SNMPv1, v2, and v3.
The objects are split into nine MIB files for use with your SNMP man-ager. There are textual conventions, common files, and specific files. This allows the flexibility to change areas of the MIB and not affect other existing installations or customers.
Table 25. SNMP MIB Files
MDS 05-4954A01, Rev. C WiYZ Technical Manual 87
NOTE: SNMP management requires that the proper IP address,network, and Gateway addresses be configured in each associ-ated network transceiver. In addition, some managementsystems might require that you compile the MIB files in theorder shown above.
4.13 EntraNET Configuration Concepts
The WiYZ Gateway supports the optional inclusion of a long range MDS entraNET remote radio in either the global license-free band of 900 MHz or 2.4 GHz and 2.4 GHz-ETSI frequency bands. The remote entraNET contained within the WiYZ Gateway can communicate using Ethernet packets with an entraNET AP or other entraNET remotes.
The MDS entraNET is a long range, industrial wireless IP/Ethernet solu-tion, with a high level of cyber-security. It allows the connection of Ethernet and/or serial devices to an IP network. This includes mis-sion-critical, revenue-generating remote devices monitoring and con-trolling fixed assets such as oil and gas wells, compressor stations, pipelines, fluid storage tanks and utility meters.
Exceptional range of up to 30 miles in the 900 MHz band and 15 miles in the 2.4 GHz band combined with IP/Ethernet and transparent serial communication on the same network, make this a very flexible platform. It allows multiple users, multiple applications and multiple protocols to be used on the same network simultaneously.
The wireless LAN is a common application of the entraNET system. It consists of a central control station (AP) and one or more associated Remote radios. A LAN provides communications between a central LAN/WAN, like that provided by the WiYZ Gateway and Remote Ethernet endpoints. The operation of the radio system is transparent to the computer equipment connected to it. As such, the system behaves just as it would in a hardwired arrangement, with respect to data format and integrity. Over-the-air messages are exchanged at the Ethernet level, including all types of IP traffic.
mdsreg.mib MDS sub-tree registration
mds_comm.mibMDS Common MIB definitions for objects and events common to the entire product family
wiyz_reg.mib MDS sub-tree registrations
wiyz_trv1.mib SNMPv1 enterprise-specific traps
wiyz_trv2.mib SNMPv2 enterprise-specific traps
wiyz_comm.mib MIB definitions for objects and events common
wiyz_sec.mibFor security management of the WiYZ Gateway system
88 WiYZ Technical Manual MDS 05-4954A01, Rev. C
In the WiYZ Gateway, the entraNET participates on the network bridge by default, and data can flow between all devices on the bridge. By its nature, if the entraNET radio is on the bridge, then all Ethernet data that is broadcast will be sent across the link. This can be problematic if the LAN or Wi-Fi networks are on the bridge and handling a large amount of traffic such that the entraNET will self-protect and quit sending data when it is overrun.
A better choice in that situation would be to remove the entraNET from the bridge and set up specific routing rules that apply only to data bound to/from networks that the entraNET is connected to.
4.14 EntraNet 2400 and Wi-Fi Setup Considerations
The WiYZ Gateway can be configured to contain up to three trans-ceivers that operate within the 2400 to 2483.5 MHz band: An entraNET 2400 long-range frequency hopping radio, Wi-Fi 802.11b/g module, and MDS Mesh ISA100.11a radio. The 2400 to 2483.5 MHz band is available in both North America and Europe under FCC and ETSI rules, respectively. Since the transceivers operate independently, but are con-tained within the WiYZ Gateway enclosure, there is a potential for radio interference due to modulation and phase noise created by the transmit-ters generating sideband noise at the same frequency of adjacent RF channels.
The Mesh and Wi-Fi radios “hop” between frequencies and, due to the standards on which they are based, are designed to interoperate with little interference. If operating with the entraNET 2400, there is a poten-tial for interference if the Wi-Fi module is operating at or near the same frequency. To minimize interference there are several options that can be used alone or in combination with each other. Here are some sugges-tions:
1. Reduce RF output power of the transceiver(s). This also reduces the transmission range of the transceiver, so the power must be high enough to maintain reliable communications.
2. Increase the distance between 2.4 GHz antennas by attaching one or two of them to a length of double-shielded coaxial cable. (e.g., placing the long range entraNET radio antenna 10 feet (3.05 meters) above the WiYZ Gateway to decrease interference. (This has the additional benefit of increasing communication range.)
3. Optimize the frequency spacing or channel selection between the transceivers as follows:
The Wi-Fi radio and entraNET radios should be user-configured to opti-mize operations and reduce possible interference. For the entraNET 2400, Table 26 below relates the Band selection to the frequency ranges:
MDS 05-4954A01, Rev. C WiYZ Technical Manual 89
For the Wi-Fi module, channels are set up as shown in Table 27 below:
The WiYZ Wi-Fi module supports Channels 1-11 to be globally compliant. Table 28 below contains suggestions for user configurations based on the supported frequencies and configurable settings. As a starting point, set the entraNET 2400 radio to use band C and Wi-Fi module to use channel 1.
Table 26. MDS entraNET 2400 Frequencies
MDS entraNET 2400Frequency Range
Band Selection
2401.6 - 2427.0 A
2427.2 - 2452.6 B
2452.8 - 2478.2 C
Table 27. Wi-Fi Channels
Wi-FiChannel
1 2 3 4 5 6 7 8 9 10 11 12 13 14
Frequency (MHz)
241
2
241
7
242
2
242
7
243
2
243
7(d
efa
ult)
244
2
244
7
245
2
245
7
246
2
246
7
247
2
248
4
Table 28. MDS entraNET vs. Wi-Fi Channel Selections
entraNET 2400 MHz Band Selection
Suggested Wi-Fi Channels
A 5,6,7,8,9,10,11
B 1,2,3, 10,11
C(default)
1,2,3,4,5,6,7,8
90 WiYZ Technical Manual MDS 05-4954A01, Rev. C
5.0 WIYZ SYSTEM SETUP TOPICS
This section covers how to configure a WiYZ system for desired opera-tions. It provides explanations and screen images of items to configure and explains how to accomplish a specific goal. For comprehensive screen and parameter options, refer also to Section 6.0.
The subsection titled “Initial System Configuration” on Page 67 explains how to log into the menu system and access the web-based Device Manager (see Figure ). Review this previous section if you have not yet established a PC connection with the WiYZ Gateway.
Figure 60. Overview-Summary Screen
(Entry point for all Gateway menus and screens)
5.1 Mesh Network Provisioning and Setup
Provisioning the WiYZ data acquisition system consists of providing the WiYZ Gateway and all WiYZ Remotes with information that will allow for secure information exchanges. (This provisioning is largely dictated by the ISA100.11a standard.) Remotes are provisioned within-formation about the Gateway.The Gateway requires information about each remote that will be allowed to join. Basic communications between the Gateway and Remotes requires three data parameters – EUI-64, Subnet Identifier (SubnetID) and a “Join Key”
MDS 05-4954A01, Rev. C WiYZ Technical Manual 91
• The EUI-64 is a unique identifier assigned to network interfaces for communications on the physical network segment. In other contexts the EUI-64 might also be known as an Ethernet Hard-ware Address (EHA), hardware address, or physical address. The System Manager function in the WiYZ Gateway and WiYZ Remote require the EUI-64 of each other inorder to establisha secure communications connection.
• The Subnet Identifier is used to allow multiple Gateways to oper-ate within proximity of each other.
• The “Join Key” is a 32-character hexadecimal value that must be entered on both the Remote and Gateway. The join key is used as an encryption mechanism and may be the same or unique for each Remote. It can be thought of as a pre-shared key (PSK) similar to that used in Wi-Fi security schemes. A simple example of a join key is: C0C1C2C3C4C5C6C7C8C9CACBCCCDCECF.
The WiYZ Gateway contains a specific EUI-64 of the internal System Manager with needed by each remote that may join. Also, the Subnet ID is defined and configured in the Gateway. Then information for each Remote is entered, consisting of: Remote type, EUI-64, and join key. The type and EUI-64 are available on the exterior white label of each Remote.
Each WiYZ Remote requires the EUI-64 of the Gateway System Man-ager, the Subnet ID, and join key.
Information for performing the provisions steps can be found on the external labels of the WiYZ Gateway and WiYZ Remote - as shown in Figure 61 and Figure 62 below.
92 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Figure 61. WiYZ Gateway Information Label Example
Figure 62. WiYZ Remote Information Label Example
MDS 05-4954A01, Rev. C WiYZ Technical Manual 93
See below for detailed steps and examples of how to accomplish provi-sioning.
NOTE: Because of the complexity of entering an 32-character valuefor each remote, the Gateway user interface automatically fillsin the last join key entered. Soone join key for a subnet only-needs to be entered once on the Gateway.
Provisioning of WiYZ Gateway requires the following:
1. EUI-64 Address of each Remote allowed to join the Gateway (console command: prov remui64).
2. User-selected join key.
3. User-selected Subsystem Identifier (subnet ID).
4. Join key of each Remote (may be the same for all Remotes in the system).
Provisioning of WiYZ Remotes is performed at the time of installation using:
1. EUI-64 Address of the System Manager on the WiYZ Gateway (Mesh Networking >> Provisioning screen).
2. User-selected Subsystem Identifier.
3. User-selected join key (same as Item 2 from the preceding Gateway provisioning steps).
Each WiYZ Remote is required to be registered in the Access Control List (ACL) of the WiYZ Gateway. Each Remote has a unique identifier (EUI-64) and a user assigned join key. Typically a WiYZ system will only use a single join key for all Remotes on the network. Optionally, you may use a unique join key for each Remote.
Provisioning the WiYZ Gateway
The steps for provisioning the WiYZ Gateway are:
1. After installing the WiYZ Gateway as described in “WiYZ Gateway Installation” on Page 61, log into the Gateway.
2. Configure network security parameters:
a. Enter your assigned subnet ID for the System Manager on the Mesh Network>>Provisioning screen. The System Manager’s EUI-64 address can also be verified on that screen.
94 WiYZ Technical Manual MDS 05-4954A01, Rev. C
3. Click the Add New Entry button to enter the Network information for each Remote as appropriate:
a. Enter a name string to identify a Remote.
b. Enter the assigned EUI-64 address
c. Enter the Join Key
d. Select the I/O Type of the Remote device
e. Enter the Location string (optional)
f. Enter the Description string (optional)
g. Click OK to add entry into the ACL table
Provisioning the WiYZ Remote
The steps for provisioning the WiYZ Remote are as follows:
1. Change the security settings of the WiYZ Remote:
a. If the Remote is a battery powered unit, press the STATUS switch on the PCBto wake the unit. The Remote remains awake for 5 minutes. (Refer to Figure 29 on Page 38 for switch location.)
b. Connect a serial cable to COM1 (115200 baud, 8N1).
c. Log into the Remote using the command line. Press Enter to get Login Prompt. Default Login: admin Default Password: admin
d. Read the current provisioning info by entering prov read <Enter>. The message Mesh Radio not yet communicating might display for up to 4 seconds. Once the Remote establishes communication, it responds:WiYZ> prov readSMEUI64: FFFF:FFFF:FFFF:FFFFJOINKEY: 0SUBNETID: 1
e. Change the network join key to match the value entered at the WiYZ Gateway (32-character hexadecimal value). Enter prov joinkey <Enter>. An example join key is: C0C1C2C3C4C5C6C7C8C9CACBCCCDCECF
For security purposes, the Remote asks you to RETYPE the JOIN-KEY, as follows:WiYZ> prov joinkeyEnter the 32 character hexadecimal JOINKEYJOINKEY>********************************
MDS 05-4954A01, Rev. C WiYZ Technical Manual 95
RETYPE the JOINKEYJOINKEY>********************************JOINKEY: ****************** (* validated key)
f. Enter the Gateway’s System Manager EUI-64 by entering prov smeui64 in the format xxxx:xxxx:xxxx:xxxx.Example: prov smeui64 00C0:6903:0194:8291 <Enter>
g. Enter the four-digit SubNet ID of the WiYZ Gateway System Manager by typing prov subnetid 4321 <Enter>.
h. Commit the new information to the device by entering prov commit <Enter>. If the join key has not been input into the WiYZ Remote, the commit command returns prov commit failure. If successful, the commit command returns Radio provisioning successful.
i. Read back and verify that the provisioning is correct by entering prov read <Enter>.On the next Power-On Reset (POR) of the Remote, the prov read command returns, for example:SMEUI64: 00C0:6903:0194:8291JOINKEY: 0SUBNETID: 4321
NOTE: Notice that the JOINKEY value is 0. For security purposed theJOINKEY is hidden from users.
j. If required, enter any specific sensor normalization for the attached sensors.
2. Check for normal operation, using the front panel LEDs. You might need to press the STATUS switch to activate the LEDs.
3. Close the cover and secure the 1/4-turn captive screws.
NOTE: If it is difficult to close the cover, check to be sure that therubber gasket on the door is pressed into its retaining channel.
96 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Figure 63. WiYZ Remote Cabling
5.2 MODBUS Setup
As described in “MODBUS Access” on Page 84, the WiYZ Gateway implements a subset of the Modicon MODBUS TCP communication standard. Monitoring, programming, and control functions are per-formed with read/write register commands by a Modbus master commu-nicating with a WiYZ Gateway using MODBUS TCP protocol over cellular, Wi-Fi, entraNET or Ethernet interfaces. The following describes the screens and approaches for configuring device registers in the WiYZ system for Modbus masters to query.
MODBUS Map WebUI page
Two MODBUS features are available in WiYZ products as follows:
1. A Web UI page is provided to allow users to assign/un-assign IO channels to/from MODBUS registers within the address range of 1 to 65535. Note that due to underlying code limitations, only one consolidated address range is implemented (as opposed to four separate ranges to support four different types of MODBUS registers).
2. Users are allowed to configure between a “standard Modbus” and “enhanced Modbus” behavior.
The new Web UI page MODBUS Map under the Mesh Network web menu provides user's interface items to manage or customize on the MODBUS Map (see Figure 64).
The Manage MODBUS Registers Map WebUI frame contains some UI buttons and two tables of configuration and status information. The top table contains unassigned registers whereas the bottom table contains assigned registers.
The top row of buttons interact with the WiYZ Gateway Server. When nothing is locally modified, only the first three buttons are available. After any local changes, the fourth Apply Changes button appears (as well as a warning message.)
MDS 05-4954A01, Rev. C WiYZ Technical Manual 97
1. Auto Re-Assign ALL—Clicking this button starts a process of automatic registers assignment grouped by MODBUS types. A dialog appears asking for an input of the register bases for four different types of MODBUS registers. (See Figure 64 on Page 97) The Channel Group has options of ALL Channels or Enabled Channels Only. Click OK to commit. Click OK after the confirmation dialog appears, indicating Server completion or errors.
Figure 64. Auto Re-Assign ALL dialog
2. Unassign ALL—Clicking this button starts the automated process of unassigning all MODBUS registers. Any assigned registers will dis-appear from the bottom table and all un-assigned registers appear in the top table.
3. Undo—Undoes any local changes. The warning message and the Apply Changes button are removed.
4. Apply Changes—commit all registers assignment changes to the WiYZ Gateway MODBUS server.
Individual Actions buttons inside the two tables may be used, as well as the group selection buttons below the right table corner, to customize the MODBUS map locally. After you are satisfied with all local changes, click the Apply Changes button to save the changes to the WiYZ Gateway MODBUS server.
98 WiYZ Technical Manual MDS 05-4954A01, Rev. C
The two “? MODBUS Function Codes” buttons pop up a dialog box con-taining a reference table of MODBUS function codes per type of MODBUS register.
The Export Modbus IO Registers Map is the same WebUI menu frame from the Configuration-Services WebUI page. This allows you to export the configured registers map.
Invisible place holder
Figure 65. MODBUS Map WebUI Page
MDS 05-4954A01, Rev. C WiYZ Technical Manual 99
Invisible place holder
Figure 66. MODBUS Map WebUI Page -Registers Modified, but Not Applied
Invisible place holder
Figure 67. MODBUS Function Codes Help Dialog
Enhanced MODBUS Mode
As described earlier, WiYZ supports (by default) the original Modicon standard “Modbus Application Protocol 1.1b.” (See specifications and more information at www.modbus.org/specs.php.)
100 WiYZ Technical Manual MDS 05-4954A01, Rev. C
This standard dictates that Modbus commands that read/write multiple registers return an error code for the command if a device register is “unavailable” (not defined or not accessible). However, Modbus “Enhanced Mode” allows the user to define default values that will be returned for unavailable registers for binary or analog read. The fol-lowing is an overview of how to select and configure this mode of oper-ation.
The modified WebUI frame menu in the Configuration->Services page contains the following added items to support the enhanced Modbus (Multi-Access Failed Return) behavior (see Figure 68).
1) Multi-Access Failed Return—Two radio buttons to switch between Enabled or Disabled modes. Enabled means enhanced Modbus behavior.
2) Failed Binary Return Value—For enhanced Modbus behavior, instead of a Multi-Access (Binary Discrete or Coil registers) error exception for failed access to one of the registers within range, this binary preset value is used for each special return value. All registers will use the same global setting.
3) Failed Analog Return Value—For enhanced Modbus behavior, this analog preset value is returned instead of an error. All registers use the same global setting.
Invisible place holder
Figure 68. MODBUS TCP Configuration WebUI Frame
MDS 05-4954A01, Rev. C WiYZ Technical Manual 101
5.3 Port Forwarding for Modbus Polling
Port Forwarding of Modbus from Cell Network to LAN
A typical forwarding scenario is represented by the following descrip-
tion: Forwarding of ModbusTCP (port 502) and HTTPS (port 443)
incoming at WiYZ B (Gateway) to WiYZ A, ports 502 and 443 respec-
tively. NAT is enabled and required (WiYZ B) for this to work. Default
Firewall Policy is DENY/DROP. WiYZ A requires either a default route or
a 192.168.1.0/24 route with WiYZ B (172.16.0.1) as the Gateway.
NOTE: Prior to enabling the Firewall in "DENY/DROP" mode(default) be sure to add a rule to allow incoming HTTPS fromthe WAN to the unit (refer to section 5.3). Failure to do so willprevent use of the GUI user interface from the WAN networkinterface when the Firewall enable is “committed.”
Modbus forwarding rule screen:
Figure 69. MODBUS Forwarding Example
HTTPS forwarding rule screen:
Figure 70. HTTPS Forwarding Example
102 WiYZ Technical Manual MDS 05-4954A01, Rev. C
HTTPS via WAN rule screen:
Figure 71. HTTPS via WAN example
MDS 05-4954A01, Rev. C WiYZ Technical Manual 103
5.4 Serial Data Transport via the Mesh
Description
The terminal server feature enables transport of serial data received on the Remote's COM2 port to the customer applications server (and vice versa) connected to the Gateway using a TCP/IP network. The serial data is transported between Remote and Gateway over the ISA100.11a network and then between Gateway and customer applications server over TCP/IP. See Figure 72 for an overview of this scheme.
Figure 72. Serial Data Transport via the Mesh
Setup
On the Gateway, each Remote is mapped to a specific TCP port as shown in Figure 73. This port can be changed by clicking on the edit symbol.
Figure 73. Mesh Network Terminal Servers
In addition, the COM2 port needs to be enabled on the Remote by applying a profile that has COM2 Data ON as shown in Figure 74.
WiYZ Gateway
TCP/IP Applications
Server
Customer Network
WiYZ
Remote
RS-232(COM2)
Cellular (GSM/CDMA)
Wi-Fi
MDS EntraNET
Ethernet
ISA100.11a
Mesh Network
Serial Data Transport over ISA100.11a Mesh NetworkSerial Data Transport over TCP/IP network via various backhaul interfaces
104 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Invisible place holder
Figure 74. Mesh Network—Profile Configuration
Packets are determined using the maximum number of receive charac-ters (MAX Rx Packet chars) value and also the Inter-Gap time (Inter-Gap chars) between receive characters. Committed and Excess Burst values set up the contract bandwidth for the terminal service.
The physical COM2 port set-up is done at the Remote console command line as follows:
1. Set data baud-rate
2. Set data format
3. Set port mode (RS-232/RS-485)
4. Set RS-485 duplex mode (Full/Half)
Operation
The application that needs to exchange data with a serial device (con-nected to Remote's COM2 port) should connect to the TCP port corre-sponding to the Remote. The TCP/IP payload data received on this connection is transported to Remote's COM2 port and vice versa.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 105
Limitations
The terminal server can transport packets of size up to a maximum of 69 bytes. Customer applications requiring larger packet sizes need to seg-ment the data into 69 byte segments and reassemble them on the peer receiving side.
NOTE: The terminal service is a best effort service over theISA100.11a mesh network and customer applications shouldhandle end-to-end reliability of application data.
106 WiYZ Technical Manual MDS 05-4954A01, Rev. C
MDS 05-4954A01, Rev. C WiYZ Technical Manual 107
6.0 SYSTEM MANAGEMENT REFERENCE DATA
This section serves as a reference for the screens and parameters that can be configured using the Gateway's web-based Device Manager. The Device Manager is the primary interface for managing the WiYZ system. A chart is shown listing commonly-needed tasks and the appro-priate menu(s) to refer to.
No attempt has been made to show every possible submenu of the Gateway in this section. The objective is to explain how to locate the proper menu for a specific task and what selections to use once you are there.
6.1 Screen Structure
The Gateway screens are arranged in a hierarchal format based on the major tasks that can be performed. An overall view of the menu system is shown in section 6.5 on page 110.
NOTE: Available selections will vary on some screens depending onthe mode selected.
6.2 Security Certificate Introduction
By default, the WiYZ Gateway provides a self-signed security certifi-cate. When initially connecting to the WiYZ Gateway the browser reads the WiYZ certificate and if it does not recognize it from the list of cer-tificates that have been verified, it issues an alert message. Depending on your web browser you may see one of the messages below. This is an expected response and accepting the certificate from WiYZ will allow access. See sample browser warnings below.
Internet Explorer 8:
108 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Firefox:
Chrome:
WiYZ provides the user the ability to import SSL security certificates in the PKCS#12 format. If the private key is protected with a pass-phrase then that pass-phrase must be entered when importing the certificate.
SSL makes use of public key cryptography (PKI). With public key cryp-tography, two keys are created, one public and one private. Anything that was encrypted with either key can only be decrypted with its corre-sponding key. A message or data stream encrypted with the server's pri-vate key, can be decrypted using only its corresponding public key, thus ensuring the data could only have come from the server.
The PKCS #12 format defined by the Personal Information Exchange Syntax Standard which specifies a file format commonly used to store private keys with accompanying public key certificates, protected with a password-based symmetric key. This container format can contain multiple embedded objects, such as multiple certificates. These objects are protected/encrypted with the private key pass-phrase
MDS 05-4954A01, Rev. C WiYZ Technical Manual 109
For internal use or testing a “self-signed” certificate can be generated in PKCS#12 format and used to secure communications with the WiYZ Gateway. There are many tools available to create these (for example using the openssl toolkit). Your Network Administrator should be able to provide assistance.
Below is the screen that allows uploading (via HTTP) of the certificate file:
6.3 Menu Navigation
Overview-Summary Screen
When you first login to the menu system, the Overview-Summary screen appears with a listing of current operating conditions.
Using the Menu
Access the specific screen you need by clicking the links on the left side of the screen. This will either expand the menu revealing additional sub-menus, or it will open the desired screen. On most screens, any or all parameters may be changed as desired, and then applied in a single step by clicking the Commit button. Also, changes may be cancelled (prior to committing them) by clicking the Undo button.
6.4 Logging Out of the Web Interface
To exit the menu system, either click Logout, or close the browser window.
NOTE: To maintain security, it is best to log-out of the menu systemas soon as you are done working with it. If you do not log out,the session automatically ends after 10 minutes of inactivity(or configured time). Configure the session timeout lengthunder the Configuration >> Security menu.
110 WiYZ Technical Manual MDS 05-4954A01, Rev. C
6.5 Device Manager Summary
The WiYZ Gateway is designed for rapid installation with a minimum number of configuration steps. Nevertheless, proper use of the Device Manager allows you to configure the Gateway for optimal performance, and to observe several key status points in real time.
This section shows each screen used in the Device Manager. Some of these might be performed at the time of installation, while others are intended for later management, programming or maintenance activities. Descriptions are provided for configurable information, as well as read-only information when necessary for understanding the parame-ters.
Overview-Summary Screen
Upon logging into the menu system, the Overview - Summary screen appears (see below). This screen is read-only, and provides key informa-tion about the current operating conditions of the WiYZ system. While changes cannot be made here, some of the entries are determined by information entered on other screens.
WiYZ Summary
• Model—MDS WiYZ Gateway
• Device Name—User Entered String
• Serial Number—Unique Factory assigned serial number.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 111
Health & Maintenance Summary
• Device Status—System status indication as follows: Normal = “Operational.”
• Uptime—Time since last reboot – format: XX days/hours, XX hours/minutes
• Firmware Version—Version number of active/running firmware - format: x.x.x
• Hardware Version—Version number of hardware – format: x.x.x
IP Address Summary
• Bridge— IP (IPv4) address via DHCP or User assigned – format xxx.xxx.xxx.xxx (Initial Value = 192.168.1.1)
• LAN Port—IP (IPv4) address of external Ethernet port via DHCP or User assigned – format xxx.xxx.xxx.xxx (Initial Value = 192.168.2.1 – Bridged value = 0.0.0.0 <default>)
• Wi-Fi Radio—IP (IPv4) address of internal Wi-Fi module via DHCP or User assigned – format xxx.xxx.xxx.xxx (Initial Value = 192.168.5.1<default> - Bridged value = 0.0.0.0)
• Cellular Radio—IP (IPv4) address of internal Cellular Modem assigned automatically by the carrier. This is not user configu-rable.
• MDS Radio—IP (IPv4) address of MDS Radio via DHCP or User assigned – format xxx.xxx.xxx.xxx (Initial Value = 192.168.4.1 <default> - Bridged value = 0.0.0.0)
NOTE: A “Network Bridge” is a device that allows the connection oftwo or more individual networks and permits network trafficbetween them, much the same way that a traditional vehicularbridge allows traffic to pass between land masses. Devices“attached” to the internal Network Bridge have an IP addresswhich is equal to the bridge address. Cellular cannot bebridged.
Configuration Summary(Each of these items will show not authorized if feature is not authorized.)
• Mesh Network—Enabled/Disabled – based on user enable/disable in Radio Interfaces.
• Wi-Fi—Enabled/Disabled – based on user enable/disable in Radio Interfaces.
• Cellular—Enabled/Disabled – based on user enable/disable in Radio Interfaces.
• MDS Radio—Enabled/Disabled – based on user enable/disable in Radio Interfaces.
• VPN —Enabled/Disabled – based on user enable/disable in Ser-vices. (Note - VPN does not require authorization)
112 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Setup WizardsBasic Wizards Invisible place holder
• Com2 Status—Enabled or Disabled, as follows:Enabled – Enabled for use (configure with the Serial Wizard).Disabled – Device not in use.
• Cellular Modem Wizard—Used to configure cellular modem options of the Gateway unit. See image below for opening screen of wiz-ard (typical appearance).
MDS 05-4954A01, Rev. C WiYZ Technical Manual 113
Configuration ScreensIdentity & Time Invisible place holder
Device Information
• Device Name—User entered string up to 40 characters – displayed on Summary page.
• Contact—User entered string up to 40 characters.
• Location—User entered string up to 40 characters.
• Description—User entered string up to 40 characters.
Date & Time
• Date & Time Mode— Selects an option among various Date & Time modes as follows:- Get from WAN interface.- Custom SNTP server IP- Custom Date & Time
• SNTP Server Address (read-only when mode is SNTP server sup-plied via DHCP; writable when mode is Custom SNTP server IP)
• Nearest City- Sets pre-defined time zone based on location
• Date Format—Formatting options as follows:
US – MM-DD-YYYY
European – DD-MM-YYYY
Generic – DD-MMM-YYYY
• Date—User entered date - format: MM-DD-YYYY
• Time—User entered time - format: HH:MM
114 WiYZ Technical Manual MDS 05-4954A01, Rev. C
NOTE: Committing a change to the time settings will result in Meshnetwork restart (all mesh radios will un-join then rejoin) andyou may be logged off of the web interface.
When manually entering time and date do not use the Enterkey to move between fields or submit. Click and enter infor-mation in each box then press Commit.
Radio Interfaces Wi-Fi Status
The status screens for Wi-Fi will differ depending on which Wi-Fi mode is being used. A typical example is shown below.
• Connected Clients—Indicates the number of Wi-Fi clients con-nected in the system.
• Mac Address—Shows MAC (Hardware ID) address when a device has connected
• Signal—Signal Strength indication value in dBm
• Rate (in Mbps)—current connection rate as reported by MAC
• RX Bytes—Number of bytes received
• TX Bytes—Number of bytes transmitted
• Age—Seconds since last received frame
MDS 05-4954A01, Rev. C WiYZ Technical Manual 115
Wi-Fi Configuration
The status screens for Wi-Fi differ depending on which Wi-Fi mode is being used. Typical examples are shown below.
• Wi-Fi Mode—Connect to a Wi-Fi Access Point at another location. Drop-down window allows selecting Station, Ad Hoc, Access Point, or Disabled.
• Wi-Fi SSID—Service Set Identifier, the name of the wireless LAN to which to connect. This is equivalent to Network Name in GE MDS terminology.
• Wi-Fi Channel—Sets the 802.11 channel the device will use.
• Broadcast Wi-Fi SSID—Enable/Disable SSID broadcast.
• Wi-Fi Station Timeout—Idle Station time out value (drops connec-tion upon timeout).
• Tx Power—Transmit Power in dBm 1-18 dBm (15 dBm = default)
• Log Wi-Fi Events—Enable/Disable Wi-Fi event logging.
116 WiYZ Technical Manual MDS 05-4954A01, Rev. C
The Wi-Fi (802.11) Security Menu appears differently depending on which privacy mode is selected. The selections possible are listed at the end of these descriptions.
• Wi-Fi Privacy Mode—Determines which privacy mode is used as follows: [None, WEP, WPA-PSK, WPA Enterprise, WPA2 Personal, WPA2
Enterprise; None]
• Wi-Fi Encryption—Determines the strength of the WEP encryption. [64 Bit, 128 Bit]
• WEP Passphrase—A user-entered combination of characters that is used to generate a WEP Key.
• WEP Key—A security code that is generated using the Wired Equivalent Protocol. It is generated by the entry of a WEP Pass-phrase (see above). This key should be entered in hexadecimal format preceded by 0x. The key should be 13 or 26 hexadecimal characters. For example, 0x1a2b3c4d5e6f709a8b7c6d5e4f.
• WEP Auth Mode—Determines the authentication mode used by the radio [Disabled, Open, Shared key, Open and Shared; Disabled].
NOTE: The MDS WEP Generator uses a different hash from othernetwork standards (such as a Linksys router). As a result,entering the passphrase GEMDS14620 into the Linksys generates0x3F843524E28173A30F66D8D128, while the Gateway generates0x46829209DD27A6019B3FA76385. If using keys generated byother products, you must enter the WEP key into the Gatewayand ignore the passphrase.
NOTE: WEP is a legacy encryption algorithm. Researchers havepublished details of a way to break WEP security on Wi-Finetworks in under 60 seconds. Therefore it is highly recom-mended to use WPA or better.
Privacy modes and available options:
• WPA-PSK—This is for Wi-Fi Protected Access with a Preshared Key. The menu options for this privacy mode are as follows:
Wi-Fi WPA Encryption—The Wi-Fi Protected Access encryption method used by the radio as an Access Point (AP). CCMP is an AES-based algorithm [TKIP, CCMP]
Preshared Key—A user-generated combination of ASCII or hexa-decimal characters. The preshared key may be any length between 8 and 63 ASCII characters, but longer keys are consid-ered more secure. If using hexadecimal characters, it must be exactly 64 characters long.
NOTE: In “Station Mode” WPA encryption is not available as the APsets the encryption mode for the devices attached to it(TKIP/CCMP).
MDS 05-4954A01, Rev. C WiYZ Technical Manual 117
• WPA Enterprise—This differs, depending on whether the radio is configured as a Wi-Fi Access Point or a Wi-Fi Station. The menu options for this mode are:
WPA Enterprise as a Station (WiFi certificates required in STA mode):- Wi-Fi WPA Encryption—Same as described above (for
WPA-PSK). - EAP Method—The authentication framework used in WPA
Enterprise or WPA2 Enterprise mode. As of the date of pub-lishing, the only option is EAP-TLS.
WPA Enterprise as an Access Point:- The menu options are the same as described above for WPA
Encryption and EAP Method parameters. In addition, the RADIUS Configuration on the Security menu must be configured. The same RADIUS configuration is used for user and device authentication, as well as Wi-Fi WPA Enterprise or WPA2 Enterprise authentication.
When WPA Personal Privacy Mode is selected, the menu looks the same as for WPA-PSK, except the Wi-Fi Privacy Mode at the top shows WPA2
Personal. Both WPA2 Personal and WPA2 Enterprise use the new WPA2 Protocol.
When WPA2 Enterprise Privacy Mode is selected, the menu looks the same as WPA2 Enterprise with the exception of the Wi-Fi Privacy Mode at the top, which shows WPA2 Enterprise instead.
NOTE: Manage and Import Certificates on the “Security” page.
Certificate Import
Certificates can be imported with HTTP using a PKCS #12 standard which specifies a portable format for storing or transporting a user’s pri-vate keys, certificates, miscellaneous secrets, and so on. These private keys with accompanying public key certificates are imported to support web, VPN and Wi-Fi.
118 WiYZ Technical Manual MDS 05-4954A01, Rev. C
The supported format is PKCS #12 of the Personal Information Exchange Syntax Standard. This format defines a file format commonly used to store private keys with accompanying public key certificates, protected with a password-based symmetric key. This container format can contain multiple embedded objects, such as multiple certificates. These objects are protected/encrypted with the private key pass-phrase.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 119
MDS Radio Configuration
• Radio Mode:- Disabled—Power is removed from the internal radio module.- Remote—eNET (entraNET) infrastructure mode. The Remote
unit which can be associated with an AP unit.- Direct Root—eNET direct mode. The master which can link to
direct node units.- Direct Node—eNET direct mode. The slave which can be linked
to a direct root unit.
• Serial Number—Serial number of the installed internal radio mod-ule.
• Firmware Version—Software version of the installed internal radio module.
• Hardware Version—Hardware revision of the installed internal entraNET module (unused on entraNET will display 0.0.0).
• Synchronization Status—Synchronized/Not Synchronized.
• RSSI—Receive Signal Strength Indication for Remote radio.
• Association Status—Associated /Not Associated.
• Access Point ID—Unique identifier of entraNET Access Point.
• Radio Output Power—RF output power setting in decibels (dB). The range is 20-30 for non-ETSI 900 MHz radios, 20-27 for non-ETSI 2400 MHz radios, and 10-20 for ETSI 2400 MHz radios.
• Network Address—Unique network identifier (1-15 alphanumeric characters)
• Encryption Enable—Enable/Disable Encryption.
120 WiYZ Technical Manual MDS 05-4954A01, Rev. C
MDS entraNET Remote Mode Configuration
The following configuration settings set up the entraNET remote as a Direct Root node:
• HOPTIME= the time in milliseconds between frequency hops as follows: 7, 14, 28.
• Contention Minimum Windows 0: Min=0, 15: Max=15
• Contention Maximum Windows 0: Min=0, 15: Max=15
• Broadbase Repeat Count 0: Min=0, 15: Max=15
• Max Unicast Retry Count 0: Min=0, 15: Max=15
• Skipzones Binary Map. Binary Map (HEX: preceded by 0x) as fol-lows:
- bit0:ZONE1; 1=Skipped 0=Active- bit1:ZONE2; 1=Skipped 0=Active- bit2:ZONE3; 1=Skipped 0=Active- bit3:ZONE4; 1=Skipped 0=Active
- bit4:ZONE5; 1=Skipped 0=Active- bit5:ZONE6; 1=Skipped 0=Active- bit6:ZONE7; 1=Skipped 0=Active- bit7:ZONE8; 1=Skipped 0=Active
• Error Correction (Forward Error Correction) ON=FEC on, OFF=FEC off
Cellular Modem Cellular Status
• Conn. Status—Connected/Disconnected (IP address or IP traffic flowing over the cellular link)
• Reg. Status—Registration Status as follows:
NOT REGISTERED
REGISTERED
SEARCHING FOR BASE STATION
REGISTRATION DENIED
STATUS UNKNOWN
REGISTERED, ROAMING
• RSSI—Radio Signal Strength Indication (dBm.
• IMEI/ESN—Modem Equipment Identifier.
• MDN—10 digit Mobile Directory Number.
• H/W Version—Hardware Version information.
• S/W Version—Software version information.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 121
IP & Networking Bridge
• IP Address Mode:
Static—User assigns IP/netmask.
Dynamic—DHCP Enabled – get IP information from DHCP server.
• Static IP Address—This is a user-supplied IP Address—format is xxx.xxx.xxx.xxx.
• Static Netmask— This is a user-supplied Network Mask. Format is xxx.xxx.xxx.xxx
• DHCP Server Status—Enable /Disable DHCP server [Enabled, Dis-abled]
• DHCP Starting Address— Start of DHCP IP Address to serve
• DHCP Ending Address— End of DHCP IP Address to serve
• Bridge Priority—View/set the priority of the bridge in the spanning tree. [0-65535; 32769]
• Bridge Hello Time—View/set spanning tree hello time. This param-eter affects how often the bridge sends a spanning tree Bridge Protocol Data Unit (BPDU). [1-10 seconds; 2 seconds]
• Bridge Forward Delay—View/set spanning tree forwarding delay. Affects how long the bridge spends listening. [4-30 seconds; 5 seconds]
• Ethernet Address (MAC)—Hardware identifier – factory assigned.
• Current IP Address—IP address in use (may be from DHCP server).
• Current Netmask— Netmask in use (may be from DHCP server).
122 WiYZ Technical Manual MDS 05-4954A01, Rev. C
LAN Port
• Port Mode—Selection to Enable or Disable the Port Mode.
• Bridge Mode—Selection for Ethernet port Enabled /Disabled in the network bridge.
NOTE: Disabling this port while configuring the Gateway using theLAN port will result in a loss of communication to theGateway.
MDS Radio
• Bridge Mode—Selection for MDS Radio Interface Enabled /Dis-abled in the network bridge.
• IP Address Mode:
Static - User-assigned IP/netmask.
Dynamic - DHCP Enabled – get IP information from DHCP server.
• Static IP Address—User-supplied IP Address - format xxx.xxx.xxx.xxx.
• Static Netmask—User-supplied Network Mask - format xxx.xxx.xxx.xxx.
• DHCP Server Status—Enable /Disable DHCP server operations on this interface.
• Ethernet Address (MAC)—Hardware identifier – factory assigned.
• Current IP Address—IP address in use (may be from DHCP server).
• Current Netmask—Netmask in use (may be from DHCP server).
MDS 05-4954A01, Rev. C WiYZ Technical Manual 123
Wi-Fi
• Bridge Mode—Selection for Wi-Fi Network Interface Enabled /Disabled in the network bridge.
• Wi-Fi IP Address Mode—Selection for Static or Dynamic IP address mode.
• Static IP Address—Entry field for the unit’s valid IP address.
• DHCP Server Status—Enable /Disable DHCP server operations on this interface.
• Static Netmask—Entry field for the unit’s valid Static Netmask.
• Ethernet Address (MAC)—Read-only field showing the unit’s Ethernet MAC address.
• Current IP Address—IP address in use.• Current Netmask—Netmask in use.
Cellular
• Current IP Address—IP address in use (as automatically assigned by the carrier).
• Current Netmask—Netmask in use (as automatically assigned by the carrier).
VPN
• Current IP Address—IP address in use (may be from DHCP server).
• Current Netmask—Netmask in use (may be from DHCP server).
124 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Routing and Firewall Configuration
• Firewall/Routing Enable—Selection of enabled/disabled fire-wall/routing feature.
• WAN Interface—For selection of wide area network communica-tions interface.
• IP Default Route Interface—Drop-down selections provided for IP Gateway and default routing address.
• DNS Configuration—Drop-down window used to select source of DNS configuration.
• DNS Server 1—Address of DNS Server #1.
• DNS Server 2—Address of DNS Server #2.
• Domain Configuration—Drop-down window used to select source of domain configuration.
• Domain(s)—This field provided for entry of domain ID.
• Firewall Status—Read-only field showing firewall status.
• Default Route Interface—Read-only field showing default route interface.
• Current Default Route Interface—Designated WAN interface.• Current Default Gateway IP—Current IP address of Gateway.• Primary DNS Server—Current primary DNS Server IP address.• Secondary DNS Server—Current secondary DNS Server IP address.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 125
The Firewall Rule Table displays incoming packets by ID, indicates fire-wall action, current status, and so on.
Services TFTP Configuration
• TFTP Timeout—TFTP Server Connection Timeout.
• TFTP Block Size—Number of bytes per transfer block.
SNMP Configuration
The support of SNMP by the WiYZ Gateway is configured using the screen described below. In summary, the Gateway supports SNMP v1, SNMP v2c and SNMPv3. The screens are context sensitive and will expand the required parameters based on the selection of versions of SNMP support configured.
The intial setup screen shown below provides basic setup and the selec-tions available when support for v1-v2 is selected, v3 only, and v1-v2c-v3. Below that are individual set up windows.
126 WiYZ Technical Manual MDS 05-4954A01, Rev. C
• SNMP Mode—This specifies the mode of operation of the radio’s SNMP Agent. The choices are: disabled, v1-v2, v3, and v1-v2-v3. If the mode is disabled, the Agent does not respond to any SNMP traffic. If the mode is v3_only, the Agent responds only to that version of SNMP traffic. If the mode is v1-v2 or v1-v2-v3, the Agent responds to the specified version of SNMP traffic. [v1-v2-v3]
• Auth Trap Status—Indicates whether or not traps are generated for failed authentication of an SNMP PDU. [Disabled, Enabled; Dis-abled]
• Read Community—SNMP community name with SNMPv1/SNMPv2c read access. This string can contain up to 30 alpha-numeric characters.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 127
• Write Community—SNMP community name with SNMPv1/SNMPv2c write access. This string can contain up to 30 alpha-numeric characters.
Pressing the Add New Entry on the SNMP Configuration screens brings up the following based on the SNMP version selected:
• Name— Parameter Name
• Version—SNMP version support (SNMPv1, SNMPv2c, SNMPv3)
• Community—SNMP community name
• User —(SNMPv3) User name
• Security Level— (SNMPv3) noAuthNoPriv, authNoPriv, authPriv
128 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Pressing the Add USM Entry on the SNMP Configuration screens brings up the following based on the SNMP version selected:
• Name— User Based Security Model (USM) User name
• Engine ID—LocalID, RemoteID
• User Type—Read-Only , Read-Write
• Authentication Protocol —None, MD5, SHA
• Authentication Password — Authentication password stored in flash memory. This is used when the Agent is managing pass-words locally (or initially for all cases on reboot). This is the SNMPv3 password used for Authentication (currently, only MD5 is supported). This string can contain up to 30 alpha-numeric characters.
• Privacy Protocol — AES, DES
• Privacy Password — Privacy password stored in flash memory. Used when the SNMP Agent is managing passwords locally (or initially for all cases on reboot). This is the SNMPv3 password used for privacy (DES encryption). This string can contain between 8 and 30 alpha-numeric characters.
Pressing the Add Trap Entry on the SNMP Configuration screens brings up the following based on the SNMP version selected:
• Name— Parameter Name
• Version—SNMP version support (SNMPv1, SNMPv2c, SNMPv3)
• Community—SNMP community name
• User —(SNMPv3 only) User name
• Security Level— noAuthNoPriv, authNoPriv, authPriv
• Trap Community—SNMP community name with SNMPv1/SNMPv2c trap access. This string can contain up to 30 alpha-numeric characters.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 129
Data Reporting Service & Transfer Status
NOTE: For more information, see “Data Reporting Service UsageInformation” on Page 188.
• Service Enable—[Enabled, Disabled].
• Trigger Size—Minimum file-size threshold bytes trigger file trans-fer. [8K, 16K, 32K, 64K, 128K, 256K, 384K, 512K, 768K, 1M, 1.5M, 2M, 3M, 4M, 5M]
• Transfer Protocol—FTP (File Transfer Protocol) or SFTP (Secure File Transfer Protocol).
• Remote IP Address—IP Address of FTP or SFTP Server.
• Remote IP Port—IP Port of FTP or SFTP Server. Selecting 0 will result is using the default port for the selected protocol. [21-FTP, 22-SFTP]
• Remote Username—Username on FTP or SFTP Server.
• Remote Password—Password on FTP or SFTP Server.
• Remote File Path—File path from base location to store transferred file – 256 characters.
• Customer ID—User-specified 4-character ASCII string– added to filename.
Transfer Status:
• Last Transfer Status—Displays one of several values as follows:
Success
Bad URL Format
Couldn't Resolve Host
Couldn't Connect
Remote Access Denied
Upload Command Failed
Open/Read File Failed
Out of Memory
FTP PORT Failed
130 WiYZ Technical Manual MDS 05-4954A01, Rev. C
FTP REST Failed
Login Failed
Remote Disk Full
Remote File Exists
SSH Error
Unexpected Error
Transfer In Progress
• Send Collected Data Now button—Force the transmission of any data that has been collected since the last transfer.
• Send Test File button—Send a small test file to ensure the service is configured correctly. The file will be named as follows:wiyz-drs-testfile-YYYYMMDDhhmmss.
• Refresh Status button—Obtain the latest Last Transfer Status from the Gateway.
NOTE: The transferred file name contains a sequence number,time-stamp, unit name, and version. The format is as follows:<DRS Customer-ID>_uuuuuuuuuu_xxxxxxx_yyyymmddhhmmss_xxxxx.dat
Table 29. Customer ID Information
Name Segment
Definition Description
[DRS Customer-ID]
Customer ID
The configured Customer ID. This field will be displayed as a 4-character ASCII string. Leading underscore characters (‘_’) are applied. Example, GEWA or _KRR.
[uuuuuuuuuu]
Unit name The first 10 characters of the configured unit name. This field will be displayed as 10-character ASCII string. Leading zeros are applied. Example TANKGW0100
[xxxxxxx] Unit serial Number
The serial number of the Gateway. This field will be displayed as 7-digit number. Example 1947017
[yyyymmddhhmmss]
Time The time of the LAST record in the file. This is system time, which is synchronized with NTP server. The value will be displayed as a 14-character ASCII string. Leading zeros are applied. Example 20060118131034
[xxxxx] Sequence Number
A 2-byte value with a range of 0 to 65535. The value will be displayed as a 5-character ASCII string. Leading zeros are applied. Example 00035, not 0x00023.
This is the sequence number of the last entry in file.
Example: GEWA_TANKGW0100_1234567_20080506141020_0004.dat
MDS 05-4954A01, Rev. C WiYZ Technical Manual 131
VPN Configuration
• Enable—Select type of VPN to enable. [Disable, OpenVPN, IPsec]
• Mode—VPN mode selection: Server or Client.
• Operation Status—Shows current status of the unit.
• Current IP Address—IP Address assigned by the server.
• Current Netmask—This will always be 255.255.255.255, as it pertains to a point-to-point link.
• IP Protocol—UDP/TCP.
• Tunnel Mode—IP / Ethernet.
• Cipher—Selections:
BF-CBC (128 bit) AES-128-CBC (128 bit)AES-192-CBC (192 bit)AES-256-CBC (256 bit)DES_EDE-CBC (128 bit)DES_EDE3-CBC (192 bit)
132 WiYZ Technical Manual MDS 05-4954A01, Rev. C
• Compression—Disabled/LZO/ LZO-Auto.
• Ping Interval (in seconds)—Used to determine the state of the VPN tunnel, up or down.
• Ping Restart Interval (in seconds)—If the server has not received a ping from the client in the time limit specified, the tunnel will be marked as down.
• Listen Address—IP Address to listen on (0.0.0.0 means listen on all interfaces, otherwise use an IP address of a specific interface).
• Listen Port—IP Port to listen on (0 uses default…1194).
• Max. Clients—Maximum number of simultaneous connections.
• Network Address—Valid Network Address.
• Network Subnet—Valid Subnet.
• Client To Client—Enabled/Disabled.
• Push Default Route—Enabled/Disabled.
• Server Address—VPN Server IP address.• Server Port—VPN Server port number (default 1194).• Server Certificate/Type—Enabling this (Server Certificate Type)
requires the server certificate to be a “server only” certificate (this is an option when creating certificates).
• Push Route1, 2, 3 Network—Network Address pushed to clients enabling clients to reach devices on internal networks/interfaces. This requires forwarding to be enabled and access through the firewall (if enabled).
• Push Route1, 2, 3 Subnet—Network Mask for above.
WiYZ IPsec VPN
MDS 05-4954A01, Rev. C WiYZ Technical Manual 133
• Startup Mode—Two selections as follows:
- add: Tunnel is configured but not started. Use this if other end will initiate connection.
- start: Tunnel is started, attempts to initiate connection with remote end.
• Authentication Mode—Two selections as follows:
- secret: Private shared key.
- rsasig: RSA Signature, currently only certificate mode is sup-ported.
• Private Shared Key—Two selections as follows:
- Authentication Mode = secret
- Text phrase or generated key
• Remote Connection ID—Two selections as follows:
- Authentication Mode = rsasig, RSA Sig Type = certificate
- Remote Identification—Must match remote certificate subject - AltName or subject field(s).
- subjectAltName: types are IP, DNS, or e-mail...
• IP: dotted decimal notation, typically same as 'Remote IP Address' (below)
DNS: @mydomain.comemail: [email protected]
• subject: must match the entire subject field
- LDAP type:C=CH, O=strongSec GmbH, CN=wroclaw.strongsec.com
with commas replaced by forward slashes:
C=CH/O=strongSec GmbH/CN=wroclaw.strongsec.comThe latter is represen-tation returned by OpenSSL command:openssl x509 -in mycert.pem -noout -subject
• IKE / Phase 1 Encryption/Authentication—Any combination of Encryption, Authentication (Hash), and Key Group is allowed. Both sides of tunnel must match exactly if anything other than any is chosen.
• ESP / Phase 2 Encryption/Authentication—Any combination of Encryption, Authentication (Hash), and Key Group is allowed. Both sides of tunnel must match exactly if anything other than any is chosen.
• Local IP Address—The local address used for connection/tunnel
• Local Gateway Address—The local nexthop address for connection to public network. Can be all zero's for direct connection.
• Local Subnet Address/Local Subnet Netmask—Local private subnet routed through tunnel.
134 WiYZ Technical Manual MDS 05-4954A01, Rev. C
• Local Source IP Address—Local IP on the specified subnet. Enables units at remote end to communicate with this host. All zero's pre-vents this host from communicating via the tunnel. Address does not have to match actual local interface address on subnet. In the latter case the address is added to the connection interface (above) along with associated host route.
• Remote IP Address—The remote address used for connection/tun-nel.
• Remote Subnet Address/Remote Subnet Mask—The remote private subnet routed through tunnel.
A simple Direct Connect example (i.e., no gateway) is shown in Figure 75.
Invisible place holder
Figure 75. Direct Connect Example
172.16.0.100/16
192.168.5.10/24
192.168.5.20/24
192.168.5.1/24
172.16.0.200/24
192.168.3.10/24
192.168.3.20/24
192.168.3.1/24
Local IP Address : 172.16.0.100 Local Gateway Address : 0.0.0.0
Local Subnet Address : 192.168.5.0 Local Subnet Mask : 255.255.255.0
Local Source IP Address : 192.168.5.1Remote IP Address : 172.16.0.200
Remote Subnet Address : 192.168.3.0
Remote Subnet Mask : 255.255.255.0
Local IP Address : 172.16.0.100 Local Gateway Address : 0.0.0.0
Local Subnet Address : 192.168.5.0 Local Subnet Mask : 255.255.255.0
Local Source IP Address : 192.168.5.1Remote IP Address : 172.16.0.200
Remote Subnet Address : 192.168.3.0
Remote Subnet Mask : 255.255.255.0
MDS 05-4954A01, Rev. C WiYZ Technical Manual 135
Modbus TCP Configuration
• Enable — Enable/Disable Modbus support
• IP Port Number — IP Port to listen on (0 selects default, 502).
• Message Timeout — 0 to 65535 ms -when registers are unable to respond for any reason, this timeout will trigger a reply as an exception/error (or a failed return value, if enabled).
• Unit Id — Ignored in TCP configuration
• Connection Timeout — Timeout for Modbus TCP connection inac-tivity. The TCP connection will be closed when no activity detected for the specified timeout period.
• Enable Multi-Access Failed Return - Enhanced Mode Enable/Disable
• Failed Binary Return Value - 0-1 - default return value for Enhanced Mode
• Failed Analog Return Value - 0-65535 - default return value for Enhanced Mode
136 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Modbus IO Registers Map
Show Table— Clicking this button expands the page to display Modbus details. The Modbus “Register Address” is unassigned by default. To assign Modbus register addresses use the Mesh Network->Modbus Map page. See “MODBUS MAP” on Page 156
NOTE: In “Standard” mode a Modbus register may be defined for aRemote type but will respond with an error if not configured inthe device profile. “Enhanced” mode will respond with thedefault value assigned by the user.
Export Modbus IO Registers Map
• Export—This button expands the page to show “comma separated values” formatted for the Modbus map. As shown below:
MDS 05-4954A01, Rev. C WiYZ Technical Manual 137
Security Management Configuration
• Telnet Access—Telnet access Enabled/Disabled.
• SSH Access—SSH Access Enabled/Disabled.
• Web Session Timeout—Automatic Log out in specified minutes [1-9999].
Authentication
• User Auth Method:
Local—Use local user/password
RADIUS - Use RADIUS server specified in the configuration
• User Auth Fallback
None
Local
NOTE: If the RADIUS server is not accessible, use local user-name/password to “fall back” to local authentication.Many RADIUS servers do not respond to a failed loginattempt. To the Gateway, this appears the same as if the serveris not there. The consequence of this behavior is that after threefailed login attempts, the authentication will take place againstthe local user/password database if local fallback is enabled.
• Change Admin Password—Click this button to change the Admin password.
NOTE: If an authorization code is needed to reset the password, theGateway will be reset to its default values.
138 WiYZ Technical Manual MDS 05-4954A01, Rev. C
RADIUS Configuration
The Radius configuration screen provides for two Radius server config-urations that can be configured on the following screen.
• Server Address 1— RADIUS Server IPv4 address
• Server Port 1—RADIUS Server IP port
• Server Shared Secret 1—16 characters
• User Auth Mode 1—PAP/CHAP selection
• Server Address 2— RADIUS Server IPv4 address
• Server Port 2—RADIUS Server IP port
• Server Shared Secret 2—16 characters
• User Auth Mode 2—PAP/CHAP selection
Certificate Import
• Services to use this certificate for—Choices (one or more) of the fol-lowing:
Web serverVPNWi-Fi
• Private key pass phrase—Same key used when generating the cer-tificate (if used during key pass-phrase creation; otherwise leave blank).
MDS 05-4954A01, Rev. C WiYZ Technical Manual 139
Authorization
• Authorization Key—Enter the key supplied by the factory to enable features. Initially preset by factory prior to shipment. Only used to enable new features not originally purchased.[Yes: authorized; No: not authorized]
Maintenance & Status
Events & Alarms Active Alarms
• Show Table—Clicking this button shows the Active Alarms table. The table provides a list of alarms, their priority, timestamp, and other relevant information.
With the table displayed, click Refresh to see an updated listing, click
Show CVS Table to get a comma separated value (CSV) listing of the
table contents in a new browser window. Click Hide Table to collapse the
listing of events.
Alerts Log
• Show Table—Clicking this button shows the Alerts Log table. The table provides a list of alerts, their priority, timestamp, and other relevant information.
With the table displayed, click Refresh to see an updated listing or click
Show CVS Table to get a comma separated value (CSV) listing of the
table contents in a new browser window. Click Hide Table to collapse the
listing of alerts.
140 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Export Alerts Log
• Export—Presents a CSV list of the Alerts log.
Once the log is open, click the Exported Alerts File button to open a csvreport.csv file. Click Done to collapse the Export Alerts Log window.
System Log
• Syslog Server Address—IPv4 Address of host of Syslog Server.
Performance Network Statistics
This screen is mainly used for network diagnostics and troubleshooting. It presents a summary of packets received and transmitted, dropped packets, errors, overruns of the buffer, recieve data rate (bps), and so on for communications interfaces. Data may be cleared at any time by clicking Clear Statistics button. This screen only shows current, autho-rized, and enabled features.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 141
NOTE: Images below only show current, authorized, and enabledfeatures.
Wi-Fi Status
• Connected Clients—Number of connected devices.
• Client List—MAC address, signal strength, and age of the connec-tion for each client attached.
Serial Statistics
This screen is mainly used for network diagnostics and troubleshooting. The statistics are for the serial terminal service, and not only for the serial port itself. This screen presents a summary of configuration infor-mation, bytes received and transmitted, and so on for the COM2 inter-face. Data may be cleared at any time by clicking Clear Com 2 Statistics button. For more setup information see Figure 46 on Page 68 and accompanying text.
MDS Radio Statistics
142 WiYZ Technical Manual MDS 05-4954A01, Rev. C
This screen is mainly used for network diagnostics and troubleshooting of the MDS Radio interface. It presents a summary of versions, RSSI, a summary of bytes received and transmitted, failed packets, errors, over-runs of the buffer, recieve data rate (bps), and so on. A brief description of each screen item follows.
• RSSI—Receive Signal Strength Indicator (dBm).
• Overflow—TX packets with “LCP buffer overflow data” responses.
• No Ack—Number of packets that were sent but not acknowledged.
• Lost Data—TX packets lost; over-the-air retries exceeded.
• Timeout—TX data packets lost; contention timeout.
• No sync—Counts number of times the unit lost radio synchroniza-tion.
• Good Data—Data packets with CRC “good” responses.
• Sync packets—Counts number of radio synchronization packets.
• Failed—TX packets failed; data integrity failed.
• Over the Air Data—Data packets successfully delivered over the air.
• Frags—Total fragments of data received.
• Retries—Total number of times packets were re-transmitted.
• Diags—TX packets with “Remote not synchronized” data responses.
Bridge Status
This screen is mainly used for network diagnostics and troubleshooting. Clicking Show Table presents information for the bridge and devices con-nected to the bridge. The table is hidden by default.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 143
Diagnostics Ping Test
• Address to Ping—IPv4 Address to be “pinged.” The format is xxx.xxx.xxx.xxx.
• Count—Number of bytes for Ping test.
• Packet Size—Data packet size for Ping test.
Click Ping to start the test. Wait for some time for the ping test to com-plete depending on the number of ping packets, and whether or not the network is reachable.
Generate Support PackageFor assistance in troubleshooting issues with the WiYZ system, you might need to generate a support package. This package contains mul-tiple internal logs and configuration details that will be helpful to tech-nical services. Select the preferred transfer mechanism and click Generate.
• Transfer Protocol—Drop-down window for selection of the proto-col used to transfer Support Package data. [Options]
• Host—IP address of SFTP Server/FTP Server.• Remote Username—User name on the Server.• Remote Password—User password on the Server.• Remote File Path—Additional file path information.
• Generate—Clicking this button initiates generation of the Support Package.
Other ExamplesTFTP:
144 WiYZ Technical Manual MDS 05-4954A01, Rev. C
USB:
Configuration Files Export Database Configuration
Configuration Categories:
• Network—Ethernet settings, Bridging, Routing.
• Wisn—WiYZ System Network settings.
• Wi-Fi—802.11b/g settings.
• MDS Radio—MDS Radio (entraNET) settings.
• Cell—Cellular Network Interface settings.
• Serial—Data port settings.
• SNMP—Any standard IPv4 address.
• Other—Gateway setup information, Software versions, Service enable, and so on.
• AccessControlList—WiYZ Remote Authorized to connect to this WiYZ Gateway.
• Profiles—Stored settings that may be applied to configure data collection and publishing of connected WiYZ Remotes.
• ModbusMapping—MODBUS Register map of all I/O ports of WiYZ Remotes contained in the Access Control List.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 145
Other screen items:
• File Media—TFTP, USB, FTP, SFTP, HTTP.
• File Server Address—IPv4 of TFTP/FTP/SFTP Server.
• FTP/SFTP Server Port—IP port used for transfer (default = 21/22).
• File transfer username—Username to access FTP/SFTP Server.
• File transfer password—Password to access FTP/SFTP Server.
• Config Filename—Filename to transfer (default: cfgscript.txt).
Pressing the Export button in HTTP mode outputs the database in a new screen. Right-clicking the link and performing a “Save As” function can also be used to download the database.
Import Database Configuration
Select a file to upload when using HTTP. Available selections on this screen vary, depending on the File Media selection. Listed below are descriptions for all possible fields.
• File Media—TFTP, USB, FTP, SFTP, HTTP.
• File Server Address—IPv4 of TFTP/FTP/SFTP Server.
• FTP/SFTP Server Port—IP port used for transfer (default = 21/22).
• File transfer username—Username to access FTP/SFTP Server.
• File transfer password—Password to access FTP/SFTP Server.
• Config Filename—Filename to transfer (default: cfgscript.txt).
NOTE: If a USB drive (jump/flash drive) is used to load firmwareconfiguration files, it must be an unencrypted type. Encrypteddrives are not supported for reprogramming the Gateway.
Reset Database Configuration
The Gateway can be reset to the factory configuration by removing all user configured parameters and setup, including the user password, but not the LAN/Bridge IP information, which is needed for communication.
146 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Before performing this operation, it is recommended that you save the
system configuration by exporting the database config ur tion to a local
server.
Firmware Utilities Version Information
• Current Firmware—The currently running firmware is listed as active.
NOTE: New firmware uploads modify the non-“active” image.
Firmware Reprogramming
Available selections on this screen vary, depending on the File Media selection. Listed below are descriptions for all possible fields.
• File Media—TFTP, USB, FTP, SFTP, HTTP.
• File Server Address—IPv4 Address of TFTP/FTP/SFTP server.
• FTP/SFTP Server Port—Filled by default to port 21 (FTP) or 22 (SFTP). For security purposes, you can modify to another value.
• File transfer username—Username to access FTP/SFTP Server.
• File transfer password—Password to access FTP/SFTP Server.
• Firmware Filename—Filename to transfer.
Copy Image
The Gateway has two copies of firmware installed (1 and 2); one is Active and the other Inactive. When new firmware is downloaded to the unit, it is placed in the Inactive image bank. The Copy Image screen is used to copy the active image over the inactive image.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 147
Verify Image
The Verify Image screen allows checking of the integrity of the selected image. Select Image 1 or Image 2 firmware to verify the integrity of the firmware code.
Device Reboot
The Device Reboot screen allows restarting the WiYZ Gateway with the currently selected firmware image, or the other (currently inactive) image.
Mesh Network
Provisioning Mesh Networking
• Mesh Enable—Mesh network support. [Enabled, Disabled]
• Use Star Topology—Force all field devices to connect directly to the WiYZ Gateway. [Enabled, Disabled]
Device Access Control List
148 WiYZ Technical Manual MDS 05-4954A01, Rev. C
• Subnet ID—User-assigned value that must be used by all Remote field devices joining this Gateway.
• Name—Optional 40 characters for user – If left blank the Gateway will use last 6 digits of EUI64.
• Device EUI-64—Unique hardware identifier assigned by the factory to each Remote field device. Refer to label on Remote (required for security purposes).
• Join Key—User-selected 32 character encryption key used by each Remote (may be the same for all Remotes or different as desired but must match what is programmed into individual Remote field devices).
• I/O Type—Remote field device type – Low Voltage, High Voltage, Current In, Current Out – (required for security purposes).
• Location—Optional 40 characters for user.
• Description—Optional 40 characters for user.
NOTE: The pencil icon indicates Edit, and the trash can icon indicatesDelete. After you have finished adding or editing all devices,click Apply Changes to commit the changes to the database.
Click CSV Table to display a CSV-formatted table in a separate window.
• Delete All—Clear all entries.
Status Devices
Orange background shading indicates “unjoined”; yellow indicates “joining” or “joined but needs configuration.”
• Name—User programmed Remote Field Device Name.
• Profile—Name of configuration profile applied to Remote device.
• Status—Possible values listed below:
MDS 05-4954A01, Rev. C WiYZ Technical Manual 149
- Un-Joined- Security-Join-Request-Received - Security-Join-Response-Sent - Network-Join-Request-Received - Network-Join-Response-Sent - Join-Contract-Request-Received - Join-Contract-Response-Sent - Security-Confirm-Request-Received - Security-Confirm-Response-Received- Joined-Reading-Configuration - Joined-Configuration-Needed - Joined-Configuration-OK - Joined-Configuration-In-Progress
• Join Count—Number of times the devices had Joined/Rejoined the mesh network (increasing value may indicate communication problem)
• Mesh Type:
- System Manager—Internal Process Only – Note: EUI64 of Sys-tem Manager MUST be entered into Remote field device pro-visioning in order to communicate to the WiYZ Gateway.
- Gateway—Internal Process Only.- Backbone—Internal Process Only.- IO-Router—Remote field device collection I/O data and routing
other field device data to/from the Gateway – line powered or battery.
- IO—Remote field device collection I/O data and sending data to Gateway or routing field device data – typically battery powered.
• Last Status Time—Timestamp of last status communication with the Gateway.
The following parameters are additionally displayed after clicking the Advanced button:
• EUI-64 Address—Unique hardware identifier assigned by the fac-tory to each Remote field device. Refer to label on Remote (required for security purposes).
• Device Type:- Blank (for Sy stem Manager, Gateway, and Backbone only)- Lo-Volt (0-100 mV)- Hi-Volt (0-5 Vdc)- Curr-IN (0-22 mA)- Curr-OUT (0-22 mA)
• Operation Mode:- Automatic - Remote selects mode based on Line power/Battery
power connected. Available modes are as follows:
Low Power - Routing Disabled—Lowest Power usage - doesn't pass data from other remotes - longest battery life (default bat-tery operation).
Low Power - Routing Enabled—Low Power usage but passes data from other remotes - some impact on battery life based on net-work configuration.
150 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Normal Power - Routing Enabled—Normal Power usage - pass data from other remotes (default line power).
Normal Power - Routing Disabled—Normal Power usage - doesn't pass data from other remotes.
• Active Firmware (FW Version) — Firmware version executing on the Remote- Format: X.X.X
• Inactive Firmware (FW Version)— Alternate firmware version not executing on the Remote - Format: X.X.X
• Mesh Firmware (FW Version) - ISA100.11a stack version- GE_xx.xx.xx
NOTE: Click CSV Table button to get window containing Comma Sepa-rated Value format data.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 151
Manage Field Devices
Device Information Summary
• Device Name—Name assigned to device by user.
• EUI-64 Address—Unique address for Remote.
• IPv6 address—IPv6-compliant address.
• ISA device type—Selected entry (mesh type).
• Description—User-entered text field describing unit
• Location—User-entered text field describing installation site.
• Serial number—Factory assigned serial number of unit.
• Revision—Firmware revision level of the Mesh radio module.
• I/O profile name—The name of the currently applied profile.
• Device status—Indicates whether or not unit has joined the net-work and its operating status.
• Power type—Indicates line or battery powered operation.
• Last joined—Date/time unit last joined the network.
• Packets sent—Number of data packets sent by unit.
• Packets received—Number of data packets received by unit.
• Packets Tx loss / (%)—Percentage of lost (unsuccessful) transmitted data packets.
• Packets Rx loss / (%)—Percentage of lost (unsuccessful) received data packets.
152 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Profile Configuration
• Currently applied profile—Name of currently applied profile.
• Load other device profile—Select from drop-down list which device profile to load for editing.
• General Properties—This area of the screen has several items relat-ing to the profile definition.
- Name—User-assigned name for the profile.
- Operation Mode—Allows selection of unit operating mode as follows: Automatic, Low Power Routing Disabled, Low Power Rout-ing Enabled, Normal Power Routing Disabled.
- External Power—Allows defining whether or not power to an external sensor is used in this profile (Off, On).
- COM2 Data—Allows defining whether or not COM2 data is used in this profile (Off, On).
- Profile Users—Shows which Remote units are using the current profile.
- Max Rx Packet (Chars) - Maximum size of data packet (recom-mended to be less than or equal to 69)
- Inter-Gap (Chars) - minimum number of character times to delin-eate between packets.
- Committed Burst (sec): —Leave default 15 sec - only change with GE MDS assistance
- Excess Burst (sec)—Leave default 0.25 sec - only change with GE MDS assistance
- Description—Free-form field where the user can enter a descrip-tion of this profile.
- Last Saved—Date/Time when the profile was last saved.
- Device Type—Output type of device (i.e., Lo-Volt (0-100 mV), Hi-Volt (0-5V), Curr-IN (0-22 mA), Curr-OUT (0-22 mA).
MDS 05-4954A01, Rev. C WiYZ Technical Manual 153
- Save Profile button—Saves the displayed profile data.- Delete Profile button—Deletes the profile completely from the
system. If the profile is currently applied to a device, that device will continue to operate as defined by the deleted pro-file until a new profile is applied to the device, or the device detaches and re-joins the network.
- Create New Profile button—Brings up a new screen for defining a new profile.
- Apply Profile button—Applies the displayed profile to the unit.
• Lower screen (columnar) items:- Mode
- Off —Channel input disabled- Publish—Publish at specified rate to selected destination- Subscribe—Set output based on value from another source- Forced —Set output to specific value- Protocol —Set output based on protocol message (Modbus)- Event—Read based on digital transition.(0->1, 1->0)- No.—Channel Number (read only)
• Channel Type
- Based on Remote type: (read only) - Status – TEMP – Board Temperature- Status –VDC - Power Voltage reading- Status –RSSI – Received signal strength- Analog-VIN- Analog-VOUT- Analog-LVIN- Analog-LVOUT- Analog-CIN- Analog-COUT- Digital-IN- Digital-OUT
• Channel Name—User-entered 30 character name.
• Unit—User entered 5 character maximum unit string (dBM, PSI, ft, miles, and so on).
• Scale Min—Scaling low value.
• Scale Max—Scaling upper value (used to convert from counts to engineering units – assuming straight line).
• Failsafe Duration (Time-Sec.)• Failsafe Mode
- Pre-Set —Set output to specific value- Last Value—Set output to last set value (protocol mode)
• Failsafe Time (sec)—For Digital Event Output, this is the event pulse duration (limits to 0.001 second resolution). For other out-puts, this is the number of seconds for loss of signal before chosen failsafe value is applied to the outputs.
• Preset Value (Pre-set, Last Value)
• Publish Period —Publish Mode: 1-64 sec, Publish Gateway Only Mode: 5 min - 6 hours.
• Publish to/Subscribe from Device—Select Gateway (default) Or Joined/Configured Remote.
154 WiYZ Technical Manual MDS 05-4954A01, Rev. C
• Publisher Channel—Output Channel driven by selected device input channel:
- Temperature – Board temperature
- Volt DC In – Board Vdc reading
- RSSI dBm – Received signal strength
- ANALOG IN1
- ANALOG IN2
- DIGITAL IN1
- DIGITAL IN2
Modbus Register Map
This screen shows Modbus Register setup information, including the register ID number, I/O channel type, and channel number assigned to each Modbus entry in the list.
Local-loop Connections
This screen shows Local Loop (I/O Replication) connections status, and contains diagnostic tools. It shows the publishing and subscribing chan-nels of all field devices which are configured to operate in a local-loop mode (publish to or subscribe from a device other than the Gateway).
MDS 05-4954A01, Rev. C WiYZ Technical Manual 155
- If a row is red, the profile is configured incorrectly.- Place mouse over any row for a detailed explanation.- Channel Name is configurable in the previous sections.
Device Profiles Manage Profiles
This screen allows managing the profiles of all devices in the mesh net-work. Each device is listed at the top of the screen showing its name, number of devices using the profile, device type, and a free-form field where a description may be entered.
Below this, general properties for the specific device selected at the top of the screen are displayed. Operation Mode and External Power ON/OFF may be set here.
The bottom portion of the screen shows device-specific parameters for the various measurement channels, including units of measure, scale minimum/maximum settings, failsafe settings, and publish settings.
See “Profile Configuration” on Page 152 for a detailed explanation of each field.
156 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Import/Export Profiles
This screen allows importing or exporting configuration script profiles from a PC into the WiYZ Gateway. For importing, you first Choose File to locate the file, and then click the Import button. For exporting files to your computer, click the Export button.
MODBUS MAP Manage MODBUS Registers Map
This screens allows configuration of available channels on all remotes to be made available for MODBUS opereation.
Operating on the MODBUS tables presented are these button functions to assist in register managment:
• Use Unassign Selected to remove the channel from Modbus sup-port.
• Use the Unassign ALL to remove the
• Once in the Assigned list the registers may be adjusted individu-ally or auto assigned according to the Modbus default guidelines using the Auto Re-assign ALL button at the top of the page accord-ing to the algorithm shown in Table 30 on Page 156
As a reminder, the ? Modbus Function Code button pops up a reference table for the function codes to register type reference.
Table 30. Modbus Auto-Assigned Register Ranges
Modbus Register TypeAuto Assigned Register Number Range (decimal)
Digital Outputs (Coils or Discrete Outputs) 0001 to 0999
Digital Inputs (Status or Discrete Inputs) 1001 to 1999
Analog Outputs (Holding Registers) 4001 to 4999
Analog Inputs 2001 to 3999
MDS 05-4954A01, Rev. C WiYZ Technical Manual 157
Whereby, by example, the function codes :
• 1 - Read current Digital Output value - 0001 to 0999
• 2 - Read current Digital Input value - 1001 to 1999
• 3 - Read current Analog Output value - 4001 to 4999
• 4 - Read current Analog Input value - 2001 to 3999
• 5, 15 - Write single/multiple Digital Output- 0001 to 0999
• 6, 16 - Write single/multiple Analog Output - 4001 to 4999
This table allows contains channels selected to be accessible via Modbus. Select one by “clicking” on the line. Select multiple by holding the shift key while clicking on the next one. Select multiple individual lines by holding the <ctrl> key.
• Device Name—Name of the unit being managed.
• IO Channel—Local channel number on the unit.
• Register Type —The register type including input/output identifier.
• IO Channel Name—User assigned channel name.
• Device EUI-64—A unique hardware identifier assigned by the fac-tory to each Remote field device. Refer to label on Remote (required for security purposes).
• Status—Current status Enabled=available, Disabled=not avail-able.
158 WiYZ Technical Manual MDS 05-4954A01, Rev. C
• Pencil icon—Select Modbus register number for the selected channel.
Hint: Sort the list by Status to group all Enabled and Disabled channels. (Disabled channels are those with Off in the profile).
When changing the assignment of Modbus registers, another button Apply Changes will pop up with a red warning message "Warning: Changes have not been applied yet.". Press Apply Changes button after the temporary edited register assignments, which will permanently save the changes to the Gateway server database.
Press the Assign Selected button to start the process to enable Modbus data collection.
Enter a valid Modbus register base number to start the assignment. This can be overwritten individually or via automatic assignment.
Selected entries from the “Unassigned” list will move to the “Assigned” list.
• Register Address—Modbus register number for the channel.
• Device Name—Name of the unit being managed.
• IO Channel—Local channel number on the unit.
• Register Type —The register type including input/output identifier
• IO Channel Name—User assigned channel name.
• Device EUI-64—A unique hardware identifier assigned by the fac-tory to each Remote field device. Refer to label on Remote (required for security purposes).
• Status—Current status Enabled=available, Disabled=not avail-able.
• Pencil icon—Select Modbus register number for the selected channel.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 159
Import/Export Profiles
This screen allows importing or exporting configuration script profiles from a PC into the WiYZ Gateway. For importing, select Choose File to locate the file, and then click the Import button. For exporting files to your computer, click the Export button.
160 WiYZ Technical Manual MDS 05-4954A01, Rev. C
I/O Database
I/O Database Graphing
Multiple channels of collected data can be graphed directly from the I/O Database menu. To configure which data to graph, click Configure Graph. You will be presented with a list of all channels that have pub-lished data to the Gateway. You can select multiple channels at the same time as long as they all share a common unit.
The graph can be zoomed into a specific range of data by clicking in the graph, and dragging to the right or to the left.
I/O Database Information
MDS 05-4954A01, Rev. C WiYZ Technical Manual 161
• ID—Data Record Counter
• Device—Device Name (default or user input)
• Channel #—Channel number
• Channel Name—Channel Name (user input)
• Scaled—Value scaled from the raw value based on the entered min/max
• Unit—Engineering Units for converted value (user input)
• Raw—Unscaled raw counts received from Remote field device
• Status—Unit operating status as follows:- Bad
- Configuration error
- Device failure
- Sensor failure
- Out of service
- Uncertain?
- Sensor conversion inaccurate?
- Range limits exceeded?
- Normal
- Device New Config
- Device No Publish
- Value not present
NOTE: Status values with “?” at the end are Uncertain errors.
• Timestamp—System time when data was received
• EUI-64 Address—The EUI-64 address of the device which pub-lished the data
Export I/O Database Information
This screen allows exporting the complete I/O Database to a CSV file.
Diagnostics The following diagnostic screens are used for advanced troubleshooting of Mesh networks.
Wireless Device Summary
162 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Select alternative Remote field devices using the drop down list, and then click Refresh to update the displayed information.
Channel Status
This screen shows mesh channels in use.
NOTE: The remainder of the diagnostic screens shown below containread-only information on neighbor unit health and superframedata.
Neighbor Health List
A list of the Neighbors’ health information.
Neighbor Graph List
A list of the Neighbor’s graph routing route information.
Superframe List
A list of subnet superframe information managed by the system man-ager.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 163
Superframe Links List
A list of subnet superframe transmission links information.
Terminal Servers
The Mesh Network-Terminal Servers screen shows a summary of traffic flow and statistics for the Gateway’s active Terminal Servers. This information can be useful when troubleshooting system problems or checking the performance of bytes transmitted vs. received through one of the Terminal Servers.
Device Firmware The Device Firmware Upgrade screen allows you to select a unit for upgrade, and provides a progress panel at the bottom of the screen. Note that Remotes will only show on the screen if fully joined to the system.
164 WiYZ Technical Manual MDS 05-4954A01, Rev. C
• Name—Name of the unit being managed.
• Device EUI-64—A unique hardware identifier assigned by the fac-tory to each Remote field device. Refer to label on Remote (required for security purposes).
• Active F/W—The active (operating) firmware image.
• Inactive F/W—Displays the inactive firmware image.
• Pencil icon—Select firmware upgrade option for a device
• Reboot icon - Perform manual reboot to active or inactive image for the selected device.
• Reboot Selected Devices—This button initiates the reboot of the selected unit(s)
• Upgrade Selected Devices—This button initiates the upgrade of the selected unit(s)
• Remove Selected Progress Entries—This button clears the progress screen of any units displayed.
• Upgrade Progress Bar—This button shows units being pro-grammed.
• Status—Current download status information.
• Blue Trash Can icon—Cancel and delete upgrade of selected Remote.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 165
Network Map Allows you to upload a custom background graphic (.JPG, .PNG, .GIF, .BMP file formats) to the mesh network map web page (default back-ground is white). For example, you can upload a map showing where Gateway and Remotes are physically installed, and then move icons to the location depicting the Gateway and Remotes. Clicking a Gateway or Remote icon displays connection information for that device.
NOTE: Holding the right mouse button down and moving the mousemoves the underlying image. Also using a browser thatsupports HTML5 allows zooming in and out of the map usingthe mouse wheel. For best viewing Firefox or Chrome issuggested.
•••
• Map Type—Connectivity or data flow paths.• Icon Size—Scale icons smaller or larger.• Hide Labels—Remove detail Remote information.• Refresh—Reload information.• Choose File—HTTP selection of background image to display.• Upload—Start upload of selected image file.
166 WiYZ Technical Manual MDS 05-4954A01, Rev. C
7.0 TROUBLESHOOTINGTroubleshooting systems incorporating the WiYZ Gateway require a divide and conquer approach to isolate the unit or interface causing the issue. Begin troubleshooting at the WiYZ Gateway and work outward to the various interfaces being used. When you find communication prob-lems, it is good practice to begin by checking for simple causes. As a multiple network device, many WiYZ issues will be solved by modi-fying network interface configurations both at the Gateway and on the network devices communicating with the Gateway unit.
7.1 WiYZ Remote Communication Basics
The operation of the WiYZ Remote mesh sensor network is controlled by the WiYZ Gateway. At provisioning time the WiYZ Remote and WiYZ Gateway are provided the information required to establish basic communications (join key, subnet id and EUI64). At initial power up the WiYZ remote connects with the best quality radio link. After communi-cations is established connection information is delivered to the WiYZ Gateway System Manager. This may, over time, reorganize the mesh for optimal communications. If the WiYZ Remote is unable to establish communications with the WiYZ Gateway (via other Remotes as neces-sary) a Remote using battery power will attempt to communicate for 5 minutes. If communication cannot be established the WiYZ Remote wakes every 6 hours for 2 minutes and re-attempts communications. (Note: A non-provisioned device will be in low-power mode constantly until the reset button is pressed or power is cycled.)
MDS 05-4954A01, Rev. C WiYZ Technical Manual 167
Once communications with the WiYZ Gateway is established, the user-defined I/O profile assigned to the device is transmitted and then any defined I/O data transmission begins. Refer to the LED behavior as defined below in Table 31.
7.2 WiYZ Gateway System Configuration Basics
Other than functions related to the WiYZ Remote Mesh network man-agement and data collection, the WiYZ Gateway is a multiple network device that supports bridging, routing, firewalls, and other various secu-rity settings including two types of VPN (OpenVPN and IPsec) and RADIUS. Although complex in nature many issues will be solved by modifying network interface configurations both at the Gateway and on the network devices communicating with the Gateway. (Review the example application “Cellular Network Routing & Port Forwarding” on Page 19 of this manual)
Table 31. Remote Communications Troubleshooting
Symptom Recommended Action
“Power” LED not on a. Check line/battery connections
b. Check for line power (7-30V)/battery power (> 9V)
c. Press the internal button (wake from sleep mode)
“Power” LED blinking Indicates loss of communication with mesh radio – Call technical support
“Link” LED not on a. Check antenna connection
b. Verify provisioning information
Remote - Subnet, join key, SM EUI64
Gateway - Subnet, join key, Remote EUI64
c. Verify range – maximum 1200 feet (366 meters) from Gateway or connected routing Remote
All LEDs appear normal but no Gateway communications – Status screen indicates:
Un-Joined
Verify provisioning information
Remote - Subnet, join key, SM EUI64
Gateway - Subnet, join key, Remote EUI64
Gateway Status screen indicates:
Joined-Configuration-Needed
Verify that I/O Profile has been applied to Remote Re-apply if necessary
Status screen indicates:
High or increasing “Join Count”
a. Check for stable power source for Remote
b. Check signal strength (RSSI value >-80 dBm)
c. Check mesh path routing node, also increasing Join Counts
d. Verify number of routing nodes versus end-nodes.
168 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Because of the many user-configurable parameters in the WiYZ Gateway, GE MDS recommends creating an archive of the system’s profiles from the Maintenance & Status- Configuration Files both when first receiving your system and then again when your installation and config-uration is complete. These files can be loaded/saved via SFTP, FTP, TFTP, HTTP or a USB drive plugged in the Gateway USB port.
NOTE: The Gateway requires the USB device to be a WindowsFAT32 format and does not support USB drives with encryp-tion.
Reloading this file into the system is an easy way to restore units to their factory defaults or your saved unique configuration. The files are exported/imported in JSON-formated text files.
For details on creating and archiving Configuration Files, refer to “Con-figuration Files” on Page 144.
WiYZ Gateway Support Package
The WiYZ Gateway has the capability to generate a specially formatted file that collects internal diagnostic information into a single file that will be useful for Technical Services to troubleshoot complex system issues. The function is found on the “Maintenance & Status – Diag-nostics” page and the package is created and saved via SFTP, FTP, TFTP, HTTP or a USB drive plugged into the Gateway USB port.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 169
WiYZ Gateway Ping Utility
The WiYZ Gateway has the capability to generate a network “ping” to a network address. This can be useful in verifying network connectivity to external network devices. For example, being able to ping an external device while the external device cannot ping the Gateway could indicate a configuration problem with the firewall or routing rules.
Table 32. Gateway Communications Troubleshooting
Symptom Possible Cause/Corrective Action
PWR LED does not light a. Voltage too low—Check for the proper supply voltage at the power connector (10–30 Vdc) .
b. Indefinite Problem—Cycle the power and wait (approx. 30 seconds) for the unit to reboot. Then, recheck for normal operation.
PWR LED is blinking a. Blinking indicates that an alarm condition exists. View the Active Alarms on the Events and Alarms page (under Maintenance & Status) and correct the problem if possible. (See “Using Logged Operation Events” on Page 172)
b. Blinking continues until the source of the alarm is corrected, for example, a valid IP address is entered, etc.
LAN LED does not light a. Refer to LAN LED discussion in Table 22, “Gateway LED Descriptions,” on page 75
b. Check cable connection.
c. Check attached network device for power
LAN LED stays Red a. Significant Ethernet traffic
b. Possible Ethernet packet “storm”
c. Check IP address configuration
d. Check cable connections causing an Ethernet “loop”
LAN LED is blinking a. Good connection - passing traffic
MESH, WiFi, Cell, eNET LED does not light
a. Specific related network support not enabled.
b. Check proper antenna is installed
MESH LED stays red or changes from green to red
a. Subnet ID of Remote not identical to desired Gateway—Verify that the system has a unique Subnet ID.
b. Not yet associated with a Remote field device with the same subnet EUI joinkey. Check the “Status” of the unit’s process of associating with the Gateway. Check the status in the Gateway Mesh Network -> Status page.
c. EUI of Gateway/Remote is wrong
d. The join keys do not match.
e. Poor Antenna System—Check the antenna, feedline and connectors.
WiFi LED stays red a. Refer to Wi-Fi LED discussion in Table 22, “Gateway LED Descriptions,” on page 75.
b. Check SSID value, encryption and other setup information.
170 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Troubleshooting Using the Web GUI Interface
The Web-based Graphical User Interface (GUI) is the main interface to the WiYZ Gateway and contains both configuration settings and status related to each configured interface. Careful examination and cross checking with other network interface settings may provide the needed information to resolve a system problem. Refer to Table 33 below for more information on using the menu system as a troubleshooting tool.
Cell LED stays red a. Refer to Cell LED discussion in Table 22, “Gateway LED Descriptions,” on page 75.
b. Check configuration information.
c. If GSM modem, verify SIM card properly inserted/valid.
eNET LED stays red a. Refer to eNET LED discussion in Table 22, “Gateway LED Descriptions,” on page 75.
b. Check configuration information.
COM 1 LED does not blink
a. Only blinks on serial data transfer (otherwise off)
b. Check serial connections
c. Check baud rate /settings (115200 8N1)
COM 2 LED does not blink
a. Only blinks on serial data transfer (otherwise off)
b. Check serial connections
c. Check configured baud rate /settings (default 115200 8N1)
Table 33. Basic Troubleshooting
Symptom Possible Cause/Corrective Action
Password forgotten a. Connect to the unit using a terminal through the COM1 Port.
b. Obtain a password-resetting Authorization Key from your factory representative.NOTE: For security purposes, a "Password Reset" authorization code resets the system to factory defaults. It is a recommended practice to save an up-to-date configuration which can be used to re-configure a Gateway with user settings. (The bridge IP setting is not reset).
c. At the login prompt, try the user name and password authcode, and enter the Authorization Key when prompted. Entering the Authorization Key sets the password back to its factory default (admin).
Cannot pass IP data to WAN
a. Verify your IP settings.
b. Use the PING command to test communication with the transceivers in the local radio system.
c. If successful with local PING, attempt to PING an IP unit attached to a transceiver.
d. If successful with the LAN PINGs, try connecting to a known good unit in the WAN.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 171
The following is a summary of how you can use several screens in the Menu System as diagnostic tools. For information on how to connect to the Menu System, see “WiYZ Gateway Installation” on Page 61.
Starting Information Screen(See Figure on Page 90)
The Overview screen contains important information regarding the con-figuration and health of the Gateway. This includes system details, health, version, uptime, IP addresses, and current configuration of the system. Also there is a link that provides a “flat” model of all the con-figuration screens in a new window or tab. This can take some time to populate but can allow searches and scrolling between fields while debugging. One of the most important is the Device Status field. This item tells you if the unit is operational.
If the unit is in an Alarmed state, there may be a problem with the system. Refer to the Section 7.4 below. Consult a radio technician to deal with wireless communication issues.
eNET radio performance issues
Possible Radio Frequency Interference:
a. If omnidirectional antennas are used, consider changing to directional antennas. This usually limits interference to and from other stations.
b. The installation of a filter in the antenna feedline may be
necessary. Consult the factory for further assistance.
c. Try using an antenna with a downward tilt.
Table 33. Basic Troubleshooting (Continued)
Symptom Possible Cause/Corrective Action
172 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Packet Statistics Menu(Maintenance and Status >> Performance)
This screen provides detailed information on data exchanges between the unit being viewed and the network through the wireless and the Ethernet (data) layers. See Network Statistics on page 140
The most significant fields are the dropped, carrier, and errors. If the data values are more than 10% of their sent and received counterparts, or the carrier value is greater than a few dozen, there might be trouble with radio-frequency interference or a radio link of marginal strength.
If errors are excessive, check the aiming of the antenna system.
7.3 Using Logged Operation Events
The WiYZ Gateway monitors many operational parameters and logs them as various classes of events. If the event is one that affects perfor-mance, it is an alarm. There are also normal or routine events such as those marking the rebooting of the system, implementation of parameter changes, and external access to the Management System. Informational events are stored in temporary (RAM) memory that is lost in the absence of primary power, and Alarms are stored in permanent memory (Flash memory) until cleared by user request. Table 34 summarizes these classifications.
These events are stored in the unit’s Event Log and can be a valuable aid in troubleshooting unit problems or detecting attempts at breaching net-work security. Also the WiYZ Gateway supports configuration and log files via a Syslog Server whose address can be configured.
7.4 Alarm and Event Conditions
Table 35 lists the alarm conditions that may be reported by the WiYZ Gateway, and Table 36 lists the event conditions. Note that the SNMP Trap number equals the Event number +1 (i.e., Event 0 = SNMP Trap 1). Most events, classified as “critical” will cause the unit’s PWR LED
Table 34. Event Classifications
Level Description/Impact Storage
Alarm Unit has detected one or more alarm conditions
Flash Memory
Informational Normal operating activities Flash Memory
TemporaryInformational
Transient conditions or events RAM
Minor Does not affect unit operation RAM
Major Degraded unit performance but still capable of operation
RAM
Critical Prevents the unit from operating RAM
MDS 05-4954A01, Rev. C WiYZ Technical Manual 173
to blink, and will inhibit normal operation of the transceiver. The LED blinks until the corrective action is completed (see also “Logged Events” on Page 176).
Table 35. Alarm Conditions
Event ID
Event Name PWR LED Error Ind.
Good String Bad String SNMP Trap No.
0 IP Address BLINK Valid Invalid 1
1 IP Mask BLINK Valid Invalid 2
2 MAC Address BLINK Valid Invalid 3
3 System Error BLINK Cleared Please Reboot
4
4 Network Interface BLINK OK Error 5
5 MESH Initialization BLINK Complete Failed 6
6 MESH Alarm BLINK Cleared Set 7
7 CELL Initialization BLINK Complete Failed 8
8 CELL Alarm BLINK Cleared Set 9
9 Wi-Fi Initialization BLINK Complete Failed 10
10 Wi-Fi Alarm BLINK Cleared Set 11
11 ENET Initialization BLINK Complete Failed 12
12 ENET Alarm BLINK Cleared Set 13
13 Bootloader Active Image
BLINK Matches Mismatch 14
14 SNTPD No Time Sync
BLINK Cleared Set --
15 Boot Param Sync BLINK Cleared Set --
16 Factory Access BLINK Disabled Enabled --
17-32 Spares (unused) -- -- -- --
Table 36. Event Conditions
Event ID
Event Name PWR LED Error Ind.
String SNMP Trap No.
33 System Bootup -- -- 34
34 User Selected Reboot -- -- 35
35 Reprogramming -- Started 36
36 Reprogramming -- Complete 37
37 Reprogramming -- Failed 38
38 Telnet/SSH User -- Logged In/ Logged Out
39
39 HTTP User -- Logged In/ Logged Out
40
40 Event Log Cleared -- -- 41
41 DHCP Server -- Disabled --
174 WiYZ Technical Manual MDS 05-4954A01, Rev. C
42 DHCP Client -- Disabled 43
43 Obtained DHCP Address
-- -- --
44 Date/Time Not Set -- -- 45
45 Date/Time Changed by User
-- -- 46
46 Date/Time from Server -- -- 47
47 Console User -- Logged In/ Logged Out
48
48 HTTP Access -- -- 49
49 Parameter Changed -- -- 50
50 Configuration Script -- Received 51
51 Auth Key Entered -- Invalid/Valid 52
52 Not Applicable -- -- --
53 Not Applicable -- -- --
54 Internal Error -- -- 55
55 Image Copy -- Started 56
56 Image Copy -- Complete 57
57 Image Copy -- Failed 58
58 Proc filesystem access**
-- Failed 59
59 Proc file format** -- Unexpected 60
60 CSR Device Open** -- Failed 61
61 CSR ioctl status read** -- Failed 62
62 CSR ioctl gpio set** -- Failed 63
63 Not Applicable -- -- --
64 TFTP Connection to Client
-- Opened 65
65 TFTP Transfer to Client
-- Error 66
66 Not Applicable -- -- --
67 Not Applicable -- -- --
68 X.509 Certs -- Failure 69
69 Certificate Chain -- Invalid 70
70 Not Applicable—Reserved
-- -- --
71 802.11 Association -- Lost 72
72 802.11 Station -- Lost 73
73 Console Access -- Locked for 5 minutes
74
74 Image Verify -- Failed 75
Table 36. Event Conditions (Continued)
Event ID
Event Name PWR LED Error Ind.
String SNMP Trap No.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 175
** Not used in all implementations.
75 Web login failure -- Failed 76
76 Admin Password changed
-- -- 77
77 IP Address matches default
-- -- 78
78 New VPN X.509 certificate loaded
-- -- 79
79 New web X.509 certificate loaded
-- -- 80
80 New Wi-Fi X.509 certificate loaded
-- -- 81
81 BBR firmware update -- -- --
82 Device Config Needed -- -- --
83 Device Config Ok -- -- --
84 Device Join -- -- --
85 Device Join Failure -- -- --
86 Device Leave -- -- --
87 Publish Contract Failure
-- -- --
88 Digital Discrete -- -- --
89 Output Mode Change -- -- --
90 Device Low Battery -- -- --
91 Device Corrupt Image -- -- --
92 Device FW Update -- -- --
93 Login Attempt Failure -- Successful/ Failed
--
94 Device General -- -- --
10001 Database error BLINK -- --
10002 Database version mismatch
BLINK -- --
10003 Contract Establish -- -- --
10004 Contract Modify -- -- --
10005 Contract Fail -- -- --
10006 Contract Terminate -- -- --
10007 Terminal Server Started
-- -- --
10008 Terminal Server Stopped
-- -- --
Table 36. Event Conditions (Continued)
Event ID
Event Name PWR LED Error Ind.
String SNMP Trap No.
176 WiYZ Technical Manual MDS 05-4954A01, Rev. C
7.5 Correcting Alarm Conditions
Table 37 provides likely causes of events that inhibit the unit from oper-ating, and possible corrective actions. The Event Description column appears on the Event Log screen.
7.6 Logged Events
The following events allow the transceiver to continue operation and do not make the PWR LED blink. The left hand column, Event Log Entry, is what shows in the Event Log (see also “Logged Events” on Page 176).
Table 37. Correcting Alarm Conditions—Alphabetical Order
Event Log Entry Generating Condition Clearing Condition or Action
Bridge Down The Bridge fails to be initialized.
Contact factory Technical Services for assistance.
General System Error
Internal checks suggest unit is not functioning properly.
Reboot the transceiver.
Initialization Error Unit fails to complete boot cycle.
Contact factory Technical Services for assistance.
Invalid IP Address The IP address is either 0.0.0.0 or 127.0.0.1.
Program IP address to something other than 0.0.0.0 or 127.0.0.1.
Network Interface Error
Unit does not recognize the LAN interface.
Contact factory Technical Services for assistance.
Table 38. Non-Critical Events—Alphabetical Order
Event Log Entry Severity Description
802.11 Association MAJOR Self explanatory
802.11 Station MAJOR Self explanatory
Admin Password changed MAJOR Self explanatory
Auth Key Entered MAJOR Self explanatory
Auto Firmware Boot MAJOR Self explanatory
Auto Firmware Upgrade MAJOR Self explanatory
BBR firmware update CRITICAL Self explanatory
Certificate Chain CRITICAL Self explanatory
Configuration Script INFORM Self explanatory
Console Access MAJOR Self explanatory
Console User MAJOR Self explanatory
CSR Device Open MAJOR Self explanatory
CSR ioctl gpio set MAJOR Self explanatory
CSR ioctl status read MAJOR Self explanatory
Date/Time Changed by User INFORM Self explanatory
Date/Time from Server INFORM Self explanatory
MDS 05-4954A01, Rev. C WiYZ Technical Manual 177
Date/Time Not Set INFORM Self explanatory
Demo Authorization MAJOR Self explanatory
Device Config Needed CRITICAL Self explanatory
Device Config Ok INFORM Self explanatory
Device Corrupt Image CRITICAL Self explanatory
Device firmware update INFORM Self explanatory
Device General CRITICAL Self explanatory
Device Join INFORM Self explanatory
Device Join Failure MAJOR Self explanatory
Device Leave MINOR Self explanatory
Device Low Battery CRITICAL Self explanatory
DHCP Client INFORM Self explanatory
DHCP Server INFORM Self explanatory
Digital Discrete INFORM Self explanatory
Event Log Cleared INFORM Self explanatory
HTTP Access MAJOR Self explanatory
HTTP User MAJOR Self explanatory
Image Copy INFORM Self explanatory
Image Copy INFORM Self explanatory
Image Copy MAJOR Self explanatory
Image Verify MAJOR Self explanatory
Internal Error MAJOR Self explanatory
IP Address matches default MAJOR Self explanatory
Login Attempt INFORM Self explanatory
Max Demos CRITICAL Self explanatory
New VPN X.509 certificate loaded
MAJOR Self explanatory
New web X.509 certificate loaded
MAJOR Self explanatory
New Wi-Fi X.509 certificate loaded
MAJOR Self explanatory
Obtained DHCP Address MINOR Self explanatory
Output Mode Change CRITICAL Self explanatory
Parameter Changed INFORM Self explanatory
Proc file format MAJOR Self explanatory
Proc filesystem access MAJOR Self explanatory
Publish Contract Failure CRITICAL Self explanatory
Reprogramming Failed MAJOR Self explanatory
Reprogramming Complete INFORM Self explanatory
Table 38. Non-Critical Events—Alphabetical Order
178 WiYZ Technical Manual MDS 05-4954A01, Rev. C
7.7 Troubleshooting with the WiYZ Gateway
Command Line
If other troubleshooting methods do not resolve the problem, the WiYZ Gateway has limited command line support via the serial port, telnet or SSH. When network issues prevent IP access to the Gateway the COM1 diagnostic port may be used to view and correct network configuration problems. Login is controlled with the same username/ password as the Web interface (default password and username are both admin).
NOTE: Complete management of the WiYZ Gateway canonly be fullymanaged and configured using the Web interface. Commandline control should be used only if the web interface is unavail-able.
Table 39 lists command line command information for the WiYZ Gateway.
Reprogramming Start INFORM Self explanatory
Scheduled Reboot CRITICAL Self explanatory
Sleep Mode INFORM Self explanatory
System Bootup CRITICAL Self explanatory
Telnet/SSH User MAJOR Self explanatory
TFTP Connection to Client INFORM Self explanatory
TFTP Transfer to Client MAJOR Self explanatory
User Selected Reboot MAJOR Self explanatory
Web login failure MAJOR Self explanatory
X.509 Certs CRITICAL Self explanatory
Table 38. Non-Critical Events—Alphabetical Order
Table 39. Gateway Command Line Information
Command Function Usage Details
auth Set Authorization Key
Usage: auth key <authkey>
boot View Image number or perform system reset to image.
Usage: boot <image>
where <image> = the image number to boot to (1 or 2)
MDS 05-4954A01, Rev. C WiYZ Technical Manual 179
cfgscript cfgscript imports, exports, and transfers cfg files over the network
Usage: cfgscript <ARGS> [OPTIONS]
ARGS:
-c <cmd> command to perform:
• send - export and send a cfgscript to a remote server
• recv - receive and import a cfgscript from a remote server
• export - export a cfgscript to stdout or to a local file
• import - import a cfgscript from local file• list - print section names of cfgscript for
use in JSON mode to stdout
OPTIONS:
• -s <serverip> server ip to send/recv the file to and from. Default 192.168.1.1
• -t <timeout> Seconds to wait while trying to connect to <serverip>. Default 10 sec-onds
• -f <remoteFile> Path and filename of cfg-script file to send/recv. Default "cfg script.txt"
• -F <localFile> Keep a copy of imported/export file locally. Default NULL
• -a <accesslevel> import/export at this access level [CUST,ADMN*,FACT,ENGR]
• -x <protocol> TFTP*,FTP,SFTP• -u <username> username to use for
FTP,SFTP. Default "anonymous"• -p <password> password to use for
FTP,SFTP. Default "[email protected]"• -o <port> port to use for FTP,SFTP.
Default 21(FTP), 22(SFTP)• -m <mode> import/export using this mode:
param*,JSON• -b <blocksize> TFTP blocksize
(512*,1024,2048,4096,8129)• -i <"item1,..."> export only these sections
when using JSON mode• -v print application layer messages to std-
out
default Resets gateway configuration to factory defaults and reboots.
WARNING: your current configuration will be lost. You may want to back up your current configuration before proceeding
Usage: defaults <options> <command>
options:
• --noreboot - do not auto-reboot
commands:
• all - resets entire config except serial num-ber and mac addresses
• preserveIP - resets entire config except IP network, serial number and mac addresses
Table 39. Gateway Command Line Information
Command Function Usage Details
180 WiYZ Technical Manual MDS 05-4954A01, Rev. C
eui64 Display eui64 values for Gateway, Backbone Router, System Manager
(related to mesh radio system)
Usage: eui64
(other options are protected)
exit Logout of interface
Usage: exit
firewall Enable/Disable IP Routing and Firewall
Usage: firewall [disabled, enabled]
help Display list of commands
Usage: help
icopy Copy firmware image. Normally copies active image to inactive image. This behavior is reversed with the 's' option
Usage: icopy [s] [v]
where :
• s - copy inactive to active• v - verbose
info Displays current information as well as the hardware revision
Allow setting of info
Usage: info [<item> <value>]
where <item> is info item to change, one of:
• name• contact• location• description
Table 39. Gateway Command Line Information
Command Function Usage Details
MDS 05-4954A01, Rev. C WiYZ Technical Manual 181
ipconfig IP Configuration display/set
Usage:
ipconfig [<interface>] [<address>] [mask <netmask>] [static|dhcp] [<br yes|no>] [enable|disable]
interface - is the name of the interface:
• ipconfig dr <WAN| LAN| MDSRADIO| WIFI| CELL| VPN| BRIDGE>
• ipconfig gw <address>• ipconfig wan <LAN|MDSRA-
DIO|WIFI|CELL>• ipconfig dns <WAN|address1
<address2>>• ipconfig domain <WAN|string1
<string2>...>
where:
• address - the IP address• netmask - the IP netmask• static|dhcp - set whether interface uses
DHCP• br yes - adds the interface to the bridge• br no - removes the interface from the
bridge• enable|disable - to enable or disable the
interface
Called with only interface name - displays the interface's configuration.
Called with no arguments - displays all interface's configuration
joinkey display current settings of Gateway and Backbone router joinkeys (related to mesh radio system)
Usage: joinkey
macaddr displays current ethernet address
Usage: macaddr
ping Ping tool for external network devices
Usage:
ping [-LRUbdfnqrvVaA] [-c count] [-i interval] [-w deadline] [-p pattern] [-s packetsize] [-t ttl] [-I interface or address] [-M mtu discovery hint] [-S sndbuf] [ -T timestamp option ] [ -Q tos ] [hop1 ...] destination
portmode enabled or disable port interfaces
Usage: portmode lan [enabled, disabled]
Table 39. Gateway Command Line Information
Command Function Usage Details
182 WiYZ Technical Manual MDS 05-4954A01, Rev. C
7.8 Factory Assistance
If problems cannot be resolved using the guidance provided here, review the GE MDS web site’s technical support area for recent software/firm-ware updates, general troubleshooting help, and service information.
Additional help is available through our Technical Support Department (See “TECHNICAL ASSISTANCE” on the inside of the rear cover of this manual.)
reprogram Upload new software image
Usage:
reprogram [-x <xferprot> -u <username> -p <password> -o <port>] <serverip> <filepath> [v]
where :
• <xferprot> the transfer protocol [TFTP|FTP|SFTP|USB]
• <username> username if required (FTP|SFTP)
• <password> password if required (FTP|SFTP)
• <port> port if required (FTP|SFTP)• <serverip> is the IP address of a tftp
server• <filepath> is the file path on the server• v = verbose
sernum Display gateway serial number
Usage: sernum
subnetid Display/set mesh network subnet id value
Usage: subnetid [<id>]
where <id> is a valid subnet id (base 10)
No arguments will display current settings
support Generate support package - wizard
Usage: support generate
ver Display image version numbers
Usage: ver
webmode Enable web HTTP or HTTPS modes
Usage: webmode [ disabled, HTTP, HTTPS ]
wisn Enable/Disable the WiYZ Sensor network
Commit WiYZ Sensor network param changes (force restart)
Usage:
wisn [enable|disable]
wisn [commit]
Table 39. Gateway Command Line Information
Command Function Usage Details
MDS 05-4954A01, Rev. C WiYZ Technical Manual 183
8.0 TECHNICAL REFERENCE
184 WiYZ Technical Manual MDS 05-4954A01, Rev. C
8.1 Technical Specifications
GENERAL
Gateway Input Power: 10 to 30 Vdc, 15 W maximum
Remote Input Power: 7 to 30 Vdc, 2.5 W maximum
Temperature: -40°C to +70°C
Housing: Die-cast Aluminum
Area Approval: Class 1, Division 2, Groups A, B, C, D for hazard-ous locations
WiYZ GATEWAY
Size: 14.6 H x 4.14 W x 11.4 D cm5.75 H x 1.63 W x 4.5 D in.
Weight: 5 lbs
Ethernet Port: One RJ-45 10/100
Serial Port: Two DB9, RS-232COM1 speed: 115.2 kbpsCOM2 speed: 1.2 to 115.2 kbps
LAN Protocols: 802.3 (Ethernet)802.1D (Spanning Tree)TCP/IP, DHCP, ICMP, IGMP, FTP, TFTP, SFTP, UDP, SNMP v1/v2/v3
Networking: DHCP, Port Forwarding, NAT
Configuration: Serial console, SSH, Web, Configuration files
Security: Encryption, Password access, Radius
MESH SPECIFICATIONS
Frequency: 2.4 to 2.4835 GHz
Range: Up to 1,200 ft
Carrier Power: 3.2 mW (+5 dBm)
Data Latency: Remote to Gateway - 8 sec.; Periodic Data Remote to Remote - 8 sec.; Event Remote to Gate-way 8 sec.; Event Remote to Remote 30 sec
Receiver Sensitivity: -95 dBm
CELLULAR OPTIONS
GSM Specifications
EDGE: E-GPRS Class 12, Modulation & coding scheme MCS 1-9, Mobile station Class B
GPRS: GPRS Class 12, full PBCCH support, coding scheme 1 – 4, Mobile station Class B
Operating Environment: -30° to +65° C
Certifications: CE Mark, R&TTEEMC: FCC Part 2, 15, 22, 24, EN 55022, EN 55024Safety: cUL, EN 60950, UL 60950Network: PTCRB
CDMA Specifications
Packet Data Features: CDMA2000 1xRTT, up to 153K bps forward & reverse channels
MDS 05-4954A01, Rev. C WiYZ Technical Manual 185
Operating Environment -30° to +70° C (FCC certified from -30° to +50° C)
Certifications: EMC: FCC Part 2, 15, 22, 24, EN 55022, EN 55024Safety: cUL, EN 60950, UL 60950Network: CDG 1 & 2
Wi-Fi OPTION
Wi-Fi Remote: 802.11b/g
Network Modes: AP, STA, Ad Hoc
Radio Mode: 2.4 GHz
Encryption: 64/128 WEP, TKIP/AES
Authentication: WEP, WPA, WPA2
Standard: IEEE 802.11b/g/n (draft 5.0) Compliant
Chipset: Atheros AR9271; 1 TX, 1 RX Architecture
Modulation: DSS: CCK, DQPSK, DBPSKOFDM: BPSK, QPSK, 16-QAM, 64-QAM11n: BPSK, QPSK, 16-QAM, 64-QAM
RF Frequency: IEEE 802.11b/g ISM Band: 2.412 GHz - 2.462 GHz, 2.412GHz - 2.472 GHz, 2.412 GHz - 2.472 GHz
IEEE 802.11g/n 20MHz band: 2.412 GHz - 2.462 GHz, 2.412 GHz - 2.472 GHz, 2.412 GHz - 2.472 GHz
IEEE 802.11g/n 40MHz band: 2.422 GHz - 2.452 GHz, 2.422 GHz - 2.462 GHz, 2.412 GHz - 2.472 GHz
RF Output Power (± 2dB): IEEE 802.11b: 23 dBm,IEEE 802.11g: 23 dBm @ 6 Mbps; 21 dBm @ 54 Mbps,IEEE 802.11g/n: HT20 / HT40 = 23 dBm @ MCSO; 21 dBm @ MCS7
Receiver Sensitivity: -75 dBm @ 54 Mbps, -94 dBm @ 11 Mbps, -90
dBm @ HT20 (MCS0), -88 dBm @ HT40 (MCS0)
Access Points Clients (MAX) : 7 (simultaneous)
900 MHZ OPTION entraNET
Data Rate: 106 kbps (EB)
Frequency: 902 to 928 MHz ISM band
Mode: Frequency Hopping Spread Spectrum
Range: Up to 25 miles
Antenna: N-female
System Gain: 136 dB
Carrier Power: 0.1 to 1.0 watts (20 to 30 dBm)
Receiver Sensitivity: -106 dBm (1 x 10-6 BER) typical
2.4 GHZ OPTION entraNET
Data Rate: 106 kbps
Frequency: 2.4016 to 2.4778 GHz ISM band
Mode: Frequency Hopping
Channels: Band A, B, or C
Range FCC/IC: Up to 15 miles
Range ETSI: 2500 ft, 750 meters
Antenna: N-female
System Gain: 131 dB
186 WiYZ Technical Manual MDS 05-4954A01, Rev. C
FCC Carrier Power: 0.07 to 0.5 watts (17 to 27 dBm)
ETSI Carrier Power: 0.01 to 0.1 watts (10 to 20 dBm)
Receiver Sensitivity: -104 dBm (1 x 10-6 BER) typical
REMOTE
I/O Capacity: 2 AI, 2 AO, 2 DI, 2 DO
Size: 12.7 H x 13.46 W x 8.89 D cm5.0 H x 5.3 W x 3.5 D in.
Weight: 1 lb
Housing: Die cast Aluminum
Receiver Sensitivity: -95 dBm
I/O SPECIFICATIONS (General Ratings)
Digital InputsON range: 5 to 24 Vdc
Isolation: 1500 Vdc to chassis ground (with J203 removed)
Digital OutputsType: FET relay
Capacity: 24 Vdc
Load: 2 A continuous (per output)
Isolation: 1500 Vdc to chassis ground (with J203 removed)
Analog InputsA/D Resolution: 12 bit
Isolation: None
Analog OutputsA/D Resolution: 12 bit
Isolation: None
I/O SPECIFICATIONS—Voltage High PCB
I/O Capacity: 2 DI, 2 DO, 2 AI, 2 AO
Analog Inputs: Voltage range: 0 to 5 Vdc +/- 0.1% of rangeInput Impedance: >1M Ohm
Analog Outputs: Voltage range: 0 to 5 Vdc (4 mA max)+/- 0.1% of range
Sensor Power (Vext) Output: 10.1 Vdc +/-2%(40 mA max)
I/O SPECIFICATIONS—Voltage Low PCB - Single Ended
I/O Capacity: 2 DI, 2 DO, 2 AI, 2 A0
Analog Inputs: Voltage range: 0 to 100 mV
Accuracy: +/- 0.1% of range:Input Impedance: >1M Ohm
Analog Output: Voltage range: 0 to 5 Vdc (4 mA max) +/- 0.1% of range
Sensor Power (Vext) Output: 6Vdc +/-2% (40 mA max)
I/O SPECIFICATIONS—Voltage Low PCB - Differential - FUTURE
I/O Capacity: 2 DI, 2 DO, 2 AI
Analog Inputs: Voltage range: 0 to 100 mV (differential) Accuracy: +/- 0.1% of rangeInput Impedance: >1M Ohm
Sensor Power (Vext) Output: 10.1 Vdc +/-2% (40 mA max)
MDS 05-4954A01, Rev. C WiYZ Technical Manual 187
I/O SPECIFICATIONS—Current Input PCB
I/O Capacity: 2 DI, 2 DO, 2 AI
Analog Inputs: Current range: 0 to 22 mAAccuracy: 4-20mA +/- 0.1% of range
Accuracy: 0-4mA, 20-22mA +/- 1% of rangeInput Impedance: 100 Ohm
:Sensor Power (Vext) Output: 24 Vdc +/- 20% (40 mA max)
I/O SPECIFICATIONS—Current Output PCB
I/O Capacity: 2 DI, 2 DO, 2 AO
Analog Outputs: Current range: 0 to 22 mA Accuracy: 4-20 mA +/- 0.1% of rangeAccuracy: 0-4 mA, 20-22 mA +/- 1% of range
Sensor Power (Vext) Output: 24V +/- 20% (40 mA max)
APPROVALS
FCC:
� Gateway – Part 15
� Remote – Part 15
� Wi-Fi – M4Y-ZCN722MV1
� Cell Modem GSM – AU792U05E06800
� Cell Modem CDMA – AU792U04A22740
� Mesh* – E5MDS-MESH2400
� entraNET 900 – E5MDS-EL806
� entraNET 2400 – E5MDS-EL806-24
�
IC - Industry:
� Wi-Fi – 3195A-ZCN722MV1
� Cell Modem GSM – 125A-0011
� Cell Modem CDMA – 125A-0010
� Mesh* – 101D-MESH2400
� entraNET 900 – 3738A-MDSEL806
� entraNET 2400 – 3738A-MDSEL80624
�
ETSI/CE:
� Gateway – EN 300-328, 301-489, EN 55022, EN 61000
� Remote – EN 300-328, 301-489, EN 61326, IEC 61000,
EN 60950
UL: 4GP5 – General Safety Control Number
90U3 – Hazardous Location Control Number (C1D2)
* Mesh is the only radio type used in a Remote; Gateway may contain any or all of the
four radio types (Wi-Fi, Cell, Mesh, entraNET).
Specifications subject to change without notice or obligation.
188 WiYZ Technical Manual MDS 05-4954A01, Rev. C
8.2 Data Reporting Service Usage Information
The Data Reporting Service (DRS) on the WiYZ Gateway allows the data collected from the WiYZ Remotes and stored in an I/O database to be sent periodically to an FTP or SFTP server in the form of Comma Separated Variable (CSV) ASCII files.
This service generates sequential output data files when a temporary file size exceeds the file-size threshold selected by the user. The output file format is tracked by a format version number. By default, output files are compressed. Total accumulated output is managed by size, and con-figurable criteria exist that govern output wrap around.
Customer Infrastructure Requirements
• Customer must deploy FTP or SFTP (SSH protocol version 2.0) servers.
• FTP and SFTP requires a username and password
• SFTP requires an SSH account and the DRS service configure with its username and password.
Operation
1. On startup, the DRS service reads the user-defined configuration parameters and creates a zero-sized temporary file for data storage.
2. The DRS service reads the I/O database for the configured I/O data Remotes and I/O channels, and then writes that data to the tempo-rary file.
3. The DRS service closes the temporary file, compresses it, and then saves it to the output data file when the temporary file size exceeds the file-size threshold.
The file name contains a sequence number, time stamp, unit name, and version. The format is as follows - see details in Table 40:
<Customer-ID>_uuuuuuuuuu_mmddyyyyhhmmss_xxxxx.dat
MDS 05-4954A01, Rev. C WiYZ Technical Manual 189
4. The DRS service attempts transfer of all output data files every time it creates a new output data file.
5. The DRS service attempts to transfer an output data file for a max-imum of four times (first attempt plus three retries) every 1 minute. In case all attempts are unsuccessful, the DRS service waits until the creation of a new output data file before attempting the transfer again.
Directory and File Management
The output data files are saved in the following folder: /tmp/drs/.
This application increments the sequence number with each new file. Sequence numbers roll back to 00000 after the file corresponding to sequence 65535 is written.
The /tmp/drs folder size is monitored by the application, and if the size increases beyond a configured threshold, it deletes the oldest files until the size reduces by 50%.
Table 40. CSV File Naming Convention
Name Segment
Definition Description
[Customer-ID]
Customer ID
The configured Customer ID. This field is displayed as a 4-character ASCII string. Leading underscore characters ('_') are applied. For example, GEWA.
[uuuuuuuuuu]
Unit Name The first 10 characters of the configured unit name. This field is displayed as a 10-character ASCII string. Leading zeros are applied. For example, TANKGW0100.
[yyyymmddhhmmss]
Time The time of the last record in the file. This is system time, which is synchronized with the NTP server. The value is displayed as a 14-character ASCII string. Leading zeros are applied. For example, 01182006131034.
[xxxxx] Sequence Number
A 2-byte value with a range of 0 to 65535. The value is displayed as a 5-character ASCII string. Leading zeros are applied. For example, 00035 not 0x00023.
Example: _BAF_0000000TNK_1972580_20120914094842_00001.dat
190 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Format
The following describes the contents of the files generated. Output file examples are presented in “DRS Output File Sample” on Page 193.
Line 1
Table 41. Data Reporting Service Output Data File Format
DRS Output Data File Definition Version 1
Uncompressed ASCII Text Format (Comma Delimited Fields)
File Header
System Error Condition
Output Version,
DRS Customer ID String,
Unit ID String,
Serial #, Compression, Reserved, CompressedBytes,
Sequence Number
Number Devices
Device Header
EUI64 Device 1, Remote ID, comma separated list of I/O channel Names
EUI64 Device 2, Remote ID, comma separated list of I/O channel Names
EUI64 Device 3, Remote ID, comma separated list of I/O channel Names
a
EUI64 Device N, Remote ID, comma separated list of I/O channel Names
Device Data
Timestamp, EUI64 Device 1, Remote ID, comma delimited list of channel values
Timestamp, EUI64 Device 2, Remote ID, comma delimited list of channel values
Timestamp, EUI64 Device 3, Remote ID, comma delimited list of channel values
a
Timestamp, EUI64 Device N, Remote ID, comma delimited list of channel values
a
Table 42. CSV File Line 1 Description
Sequence Number Parameter Description
1 System Error Condition
This parameter indicates any system-wide error that is preventing proper operation of this service.
0 = No error
1 = I/O data monitoring service not configured
2 = Invalid configuration
2 Output Version This is the version of the output file format.
3 Customer ID Customer ID
4 Unit ID This field identifies the WiYZ Gateway by an ASCII name configured by the user.
5 Serial # The serial number of the Gateway. This field will be displayed as 7-digit number. Example 1947017
6 Compression 0 = Device Data is uncompressed
1 = Device Data is compressed
7 Reserved Reserved
8 Compressed Bytes Number of bytes to follow in the file starting from line 3. This field is used by de-compressor.
9 Sequence Number A 2-byte value with a range of 0 to 65535. The value will be displayed as a 5-character ASCII string. Leading zeros are applied. Example 00035, not 0x00023.
This is the sequence number of the last entry in file.
10 Number Devices The number of joined devices.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 191
Lines 2 + Number of Devices (N)
Lines (2+N) through EOF
Table 43. Device Header
Number Possible Values Description
1 Device EUI64 EUI64 device identifier (xxxx=changeable content)
0006:3DFF:xxxx:xxxx
For example, 0006:3dff:ff00:1122
2 Remote ID This field identifies the Remote filed device by an ASCII name configured by the user.
3-N Channel Number or Channel Name
These values will be blank for non-joined devices.
Channel numbers start at 1 and vary based on number of channels for the device type.
Customer assigned Channel names are substituted for those numbers that are assigned a channel name.
Non-publishing channels will not be enumerated.
Table 44. Device Data
Number Possible Values Description
1 Timestamp of data This is the value collected from an analog input I/O channel.
yyyymmddhhmmss
For example, 20100911231142
2 Device EUI64 EUI64 device identifier (xxxx=changeable content)
0006:3DFF:xxxx:xxxx
For example, 0006:3dff:ff00:1122
3 Remote ID This field identifies the Remote filed device by an ASCII name configured by the user.
4 Data
192 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Lines (2 + N devices +1) through EOF
After the header and device information, the lines contain comma sepa-rated values corresponding to the timestamp, EUI-64, Remote ID, and I/O channels in the same sequence as enumerated in the Device Header line. The possible values for each data entry are define in Table 45.
Compression Compression will be GNU zip (gzip) - http://www.gzip.org/
Table 45. CSV File Data Entry Values
Possible Values Description
ASCII representation of decimal float value represented in ASCII characters with maximum 2 decimal places.
This is the value collected from an analog input I/O channel.
For example, 23.22.
Binary 0 or 1 represented in ASCII character.
This is the value collected from a digital input I/O channel.
For example, 1.
‘NR’ This is the value reported for all the I/O channels of a device if it is not registered.
‘NC’ This is the value reported for all the I/O channels of a device if no publications are received from the device, although the device is still registered.
‘NV’ This is the value reported for one or more I/O channels of a device if invalid values are received for these I/O channels in the publication.
‘NS’ This is the value reported if no new sample is available during this write cycle of the data record. This can happen if data Remotes are configured to publish at different time periods.
‘BN’ Status bad, non-specific error
‘BC’ Status bad, configuration error
‘BD’ Status bad, device failure
‘BS’ Status bad, sensor failure
‘BO’ Status bad, out of service
‘UN’ Status uncertain, non-specific error
‘US’ Status uncertain, sensor conversion inaccurate
‘UL’ Status uncertain, range limits exceeded
‘GC’ Status good, new config
‘GD’ Status good, no data received
‘GP’ Status good, value not present
MDS 05-4954A01, Rev. C WiYZ Technical Manual 193
DRS Output File Sample
File Name _BAF_0000000TNK_1972580_20120914094842_00001.dat
Configuration Five data Remotes configured to publish every second: temperature, power, RSSI, digital inputs 1 & 2, and analog inputs 1 & 2.
Content The following output shows the content of the file generated with the above configuration:
0,1,_BAF,0000000TNK,1972580,1,0,8196,1,50006:3dff:ff04:4850,VH,Temp-HV,VDC-HV,RSSI-HV,A1-HV,A2-HV,D1-HV,D2-HV0006:3dff:ff04:4862,VH2,Temp-HV,VDC-HV,RSSI-HV,A1-HV,A2-HV,D1-HV,D2-HV0006:3dff:ff04:4c2c,VL,Temp-LV,VDC-LV,RSSI-LV,A1-LV,A2-LV,D1-LV,D2-LV0006:3dff:ff04:49a4,CI,Temp-CI,VDC-CI,RSSI-CI,A1-CI,A2-CI,D1-CI,D2-CI0006:3dff:ff04:4e51,CO,Temp-CO,VDC-CO,RSSI-CO,DI1-CO,DI2-CO20120914094817,0006:3dff:ff04:4e51,CO,NS,13.74,-27.90,0,020120914094818,0006:3dff:ff04:4862,VH2,77.81,13.78,-36.87,0.00,0.00,0,020120914094818,0006:3dff:ff04:4c2c,VL,74.21,13.70,-31.89,UL,UL,0,020120914094818,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094819,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094818,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,020120914094819,0006:3dff:ff04:4862,VH2,77.81,13.78,-36.87,0.00,0.00,0,020120914094819,0006:3dff:ff04:4c2c,VL,74.21,13.71,-31.89,UL,UL,0,020120914094819,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094820,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094819,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,020120914094820,0006:3dff:ff04:4862,VH2,77.81,13.77,-36.87,0.00,0.00,0,020120914094820,0006:3dff:ff04:4c2c,VL,74.21,13.70,-31.89,UL,UL,0,020120914094820,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094821,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094820,0006:3dff:ff04:4e51,CO,79.07,13.75,-27.90,0,020120914094821,0006:3dff:ff04:4862,VH2,77.81,13.77,-36.87,0.00,0.00,0,020120914094821,0006:3dff:ff04:4c2c,VL,74.39,13.71,-31.89,UL,UL,0,020120914094821,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094822,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094821,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,020120914094822,0006:3dff:ff04:4862,VH2,77.63,13.78,-36.87,0.00,0.00,0,020120914094822,0006:3dff:ff04:4c2c,VL,74.39,13.71,-31.89,UL,UL,0,020120914094822,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094823,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094822,0006:3dff:ff04:4e51,CO,79.07,13.75,-27.90,0,020120914094823,0006:3dff:ff04:4862,VH2,77.81,13.77,-36.87,0.00,0.00,0,020120914094823,0006:3dff:ff04:4c2c,VL,74.21,13.71,-31.89,UL,UL,0,020120914094823,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094824,0006:3dff:ff04:4850,VH,78.35,13.69,-28.90,0.00,0.00,0,020120914094823,0006:3dff:ff04:4e51,CO,79.07,13.75,-27.90,0,020120914094824,0006:3dff:ff04:4862,VH2,77.81,13.78,-36.87,0.00,0.00,0,020120914094824,0006:3dff:ff04:4c2c,VL,74.21,13.70,-31.89,UL,UL,0,020120914094824,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094825,0006:3dff:ff04:4850,VH,78.35,13.69,-28.90,0.00,0.00,0,020120914094824,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,020120914094825,0006:3dff:ff04:4862,VH2,77.81,13.78,-36.87,0.00,0.00,0,020120914094825,0006:3dff:ff04:4c2c,VL,74.39,13.71,-31.89,UL,UL,0,020120914094825,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094826,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094825,0006:3dff:ff04:4e51,CO,79.07,13.75,-27.90,0,020120914094826,0006:3dff:ff04:4862,VH2,77.81,13.78,-36.87,0.00,0.00,0,020120914094826,0006:3dff:ff04:4c2c,VL,74.21,13.70,-31.89,UL,UL,0,020120914094826,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094827,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094826,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,020120914094827,0006:3dff:ff04:4862,VH2,77.81,13.78,-36.87,0.00,0.00,0,020120914094827,0006:3dff:ff04:4c2c,VL,74.21,13.70,-31.89,UL,UL,0,020120914094827,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094828,0006:3dff:ff04:4850,VH,78.35,13.69,-28.90,0.00,0.00,0,020120914094827,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,020120914094828,0006:3dff:ff04:4862,VH2,77.63,13.77,-36.87,0.00,0.00,0,020120914094828,0006:3dff:ff04:4c2c,VL,74.39,13.70,-31.89,UL,UL,0,020120914094828,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094829,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094828,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,020120914094829,0006:3dff:ff04:4862,VH2,77.63,13.77,-36.87,0.00,0.00,0,020120914094829,0006:3dff:ff04:4c2c,VL,74.21,13.70,-31.89,UL,UL,0,020120914094829,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094830,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094829,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,0
194 WiYZ Technical Manual MDS 05-4954A01, Rev. C
20120914094830,0006:3dff:ff04:4862,VH2,77.81,13.78,-36.87,0.00,0.00,0,020120914094830,0006:3dff:ff04:4c2c,VL,74.21,13.70,-31.89,UL,UL,0,020120914094830,0006:3dff:ff04:49a4,CI,76.64,13.73,-49.82,0.01,0.01,0,020120914094831,0006:3dff:ff04:4850,VH,78.35,13.69,-28.90,0.00,0.00,0,020120914094830,0006:3dff:ff04:4e51,CO,79.07,13.75,-27.90,0,020120914094831,0006:3dff:ff04:4862,VH2,77.63,13.77,-36.87,0.00,0.00,0,020120914094831,0006:3dff:ff04:4c2c,VL,74.21,13.71,-31.89,UL,UL,0,020120914094832,0006:3dff:ff04:4850,VH,78.35,13.68,-28.90,0.00,0.00,0,020120914094831,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,020120914094832,0006:3dff:ff04:4862,VH2,77.63,13.78,-36.87,0.00,0.00,0,020120914094832,0006:3dff:ff04:4c2c,VL,74.39,13.70,-31.89,UL,UL,0,020120914094833,0006:3dff:ff04:4850,VH,78.35,13.69,-28.90,0.00,0.00,0,020120914094832,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,020120914094833,0006:3dff:ff04:4862,VH2,77.81,13.78,-36.87,0.00,0.00,0,020120914094833,0006:3dff:ff04:4c2c,VL,74.39,13.70,-31.89,UL,UL,0,020120914094833,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094834,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094833,0006:3dff:ff04:4e51,CO,79.07,13.75,-27.90,0,020120914094834,0006:3dff:ff04:4862,VH2,77.81,13.78,-36.87,0.00,0.00,0,020120914094834,0006:3dff:ff04:4c2c,VL,74.39,13.70,-31.89,UL,UL,0,020120914094834,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094835,0006:3dff:ff04:4850,VH,78.35,13.69,-28.90,0.00,0.00,0,020120914094834,0006:3dff:ff04:4e51,CO,79.25,13.74,-27.90,0,020120914094835,0006:3dff:ff04:4862,VH2,77.81,13.77,-36.87,0.00,0.00,0,020120914094835,0006:3dff:ff04:4c2c,VL,74.21,13.70,-31.89,UL,UL,0,020120914094835,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094836,0006:3dff:ff04:4850,VH,78.35,13.69,-28.90,0.00,0.00,0,020120914094835,0006:3dff:ff04:4e51,CO,79.07,13.75,-27.90,0,020120914094836,0006:3dff:ff04:4862,VH2,77.63,13.77,-36.87,0.00,0.00,0,020120914094836,0006:3dff:ff04:4c2c,VL,74.21,13.70,-31.89,UL,UL,0,020120914094836,0006:3dff:ff04:49a4,CI,76.46,13.74,-49.82,0.01,0.01,0,020120914094837,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094836,0006:3dff:ff04:4e51,CO,79.07,13.75,-27.90,0,020120914094837,0006:3dff:ff04:4862,VH2,77.81,13.78,-36.87,0.00,0.00,0,020120914094837,0006:3dff:ff04:4c2c,VL,74.21,13.70,-31.89,UL,UL,0,020120914094837,0006:3dff:ff04:49a4,CI,76.46,13.74,-49.82,0.01,0.01,0,020120914094838,0006:3dff:ff04:4850,VH,78.35,13.69,-28.90,0.00,0.00,0,020120914094837,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,020120914094838,0006:3dff:ff04:4862,VH2,77.81,13.77,-36.87,0.00,0.00,0,020120914094838,0006:3dff:ff04:4c2c,VL,74.39,13.70,-31.89,UL,UL,0,020120914094838,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,020120914094839,0006:3dff:ff04:4850,VH,78.35,13.69,-28.90,0.00,0.00,0,020120914094838,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,020120914094839,0006:3dff:ff04:4862,VH2,77.81,13.78,-36.87,0.00,0.00,0,020120914094839,0006:3dff:ff04:4c2c,VL,74.21,13.70,-31.89,UL,UL,0,020120914094840,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094839,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,020120914094841,0006:3dff:ff04:4850,VH,78.35,13.69,-28.90,0.00,0.00,0,020120914094840,0006:3dff:ff04:49a4,CI,76.64,13.74,-49.82,0.01,0.01,0,020120914094840,0006:3dff:ff04:4c2c,VL,74.21,13.70,-31.89,UL,UL,0,020120914094840,0006:3dff:ff04:4e51,CO,79.25,13.75,-27.90,0,020120914094841,0006:3dff:ff04:4862,VH2,77.81,13.77,-36.87,0.00,0.00,0,020120914094842,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094840,0006:3dff:ff04:4862,VH2,77.81,13.77,-36.87,0.00,0.00,0,020120914094841,0006:3dff:ff04:4c2c,VL,74.21,13.71,-31.89,UL,UL,0,020120914094841,0006:3dff:ff04:4e51,CO,79.07,13.75,-27.90,0,020120914094842,0006:3dff:ff04:4862,VH2,77.63,13.77,-36.87,0.00,0.00,0,020120914094843,0006:3dff:ff04:4850,VH,78.53,13.69,-28.90,0.00,0.00,0,020120914094842,0006:3dff:ff04:49a4,CI,76.46,13.73,-49.82,0.01,0.01,0,0
MDS 05-4954A01, Rev. C WiYZ Technical Manual 195
8.3 NOTES ON SNMP
NOTE: Refer also to “SNMP MIB Files” on Page 86 for additionalinformation on this topic.
Overview
The firmware release described in this manual contains changes to the transceiver’s SNMP Agent, several new MIB variables, and new Agent configuration options. This guide reviews the changes and shows how to properly configure the Agent to take advantage of these new features.
SNMPv3 Support
The WiYZ Gateway’s SNMP agent supports the SNMPv3 protocol using MD5/SHA-1 authentication and DES encryption. The SNMP agent has support for the USM User Table, and View-Based Access (refer to RFC2574 for full details). The SNMPv3 support in the Gateway is limited in the following areas:
• Only MD5 Authentication is supported (no SHA-1). SNMPv3 provides support for MD5 and SHA-1.
• Limited USM User Table Manipulation. The SNMP Agent starts with 5 default accounts. New accounts can be added (SNMPv3 adds new accounts by cloning existing ones), but they will be volatile (will not survive a power-cycle).
New views cannot be configured on the SNMP Agent. Views are inherited for new accounts from the account that was cloned.
The SNMP Agent uses one password pair (Authentication/Pri-vacy) for all accounts. This means that when the passwords change for one user, they change for all users.
SNMPv3 Accounts
The following default accounts are available for the SNMP Agent:
enc_mdsadmin—Read/write account using Authentication and Encryp-tion.
auth_mdsadmin—Read/write account using Authentication.
enc_mdsviewer—Read only account using Authentication and Encryp-tion.
auth_mdsviewer—Read only account using Authentication.
def_mdsviewer—Read only account with no Authentication or Encryp-tion.
196 WiYZ Technical Manual MDS 05-4954A01, Rev. C
Context Names
The following Context Names are used (refer to RFC2574 for full details):
Admin accounts: context_a/Viewer accounts: context_v.
All accounts share the same default passwords:
Authentication default password: MDSAuthPwd/Privacy default pass-word: MDSPrivPwd.
Passwords can be changed either locally (via the console) or from an SNMP Manager, depending on how the Agent is configured. If pass-words are configured and managed locally, they are non-volatile and will survive a power-cycle. If passwords are configured from an SNMP manager, they will be reset to whatever has been stored for local man-agement on power-cycle.
This behavior was chosen based on RFC specifications. The SNMP Manager and Agent do not exchange passwords, but actually exchange keys based on passwords. If the Manager changes the Agent’s password, the Agent does not know the new password. The Agent only knows the new key. In this case, only the Manager knows the new password. This could cause problems if the Manager loses the password. If that hap-pens, the Agent becomes unmanageable. Resetting the Agent’s pass-words (and therefore keys) to what is stored in flash memory upon power-cycle prevents the serious problem of losing the Agent’s pass-words.
If passwords are managed locally, they can be changed on the Agent (via the console). Any attempts to change the passwords for the Agent via an SNMP Manager will fail when the Agent is in this mode. Locally defined passwords will survive a power-cycle.
In either case, the SNMP Manager needs to know the initial passwords being used in order to talk to the Agent. If the Agent’s passwords are configured via the Manager, they can be changed from the Manager. If the passwords are managed locally, then the Manager must be re-con-figured with any password changes in order to continue talking to the Agent.
Password-Mode Management Changes
When the password management mode is changed, the active passwords used by the Agent may also change. Some common scenarios are dis-cussed below:
Common Scenarios • Passwords are currently being handled by the Manager. The assigned passwords are Microwave (Auth), and Rochester (Priv). Configuration is changed to manage the passwords locally. The passwords stored on the WiYZ Gateway were Fairport (Auth),
MDS 05-4954A01, Rev. C WiYZ Technical Manual 197
and Churchville (Priv) (if local passwords have never been used, then MDSAuthPwd and MDSPrivPwd are used). These passwords will now be used by the Agent to re-generate keys. The Manager must know these passwords to talk to the Agent.
• Passwords are currently managed locally. The local passwords are Fairport (Auth) and Churchville (Priv). Configuration is changed to handle the passwords from the Manager. The same passwords will continue to be used, but now the Manager can change them.
• Passwords are currently managed locally. The local passwords are Fairport (Auth) and Churchville (Priv). Passwords are changed to Brighton (Auth) and Perinton (Priv). The Agent will immedi-ately generate new keys based on these passwords and start using them. The Manager will have to be re-configured to use these new passwords.
• Passwords are currently managed locally. The local passwords are Fairport (Auth) and Churchville (Priv). Configuration is changed to handle the passwords from the Manager. The Man-ager changes the passwords to Brighton (Auth) and Perinton (Priv). The WiYZ Gateway is then rebooted. After a power-cycle, the Gateway will use the passwords stored in flash memory, which are Fairport (Auth) and Churchville (Priv). The Manager must be re-configured to use these new passwords.
Table 46. SNMP Traps (Sorted by Code)
SNMP Trap Severity Description
bootup(34) CRITICAL System Bootup
reboot(35) MAJOR User Selected Reboot
reprogStarted(36) INFORM Reprogramming Started
reprogCompleted(37) INFORM Reprogramming Completed
reprogFailed(38) MAJOR Reprogramming Failed
telnetLogin(39) MAJOR Telnet/SSH User login/logout
httpLogin(40) MAJOR HTTP User login/logout
logClear(41) INFORM Event Log Cleared
dhcpServer(42) INFORM DHCP server enabled/disabled
dhcpClient(43) INFORM DHCP client enabled/disabled
dhcpAddr(44) MINOR Obtained DHCP address
timeNotSet(45) INFORM Date/time not set
timeByUser(46) INFORM Date/time changed by user
timeFromServer(47) INFORM Date/time from server
consoleLogin(48) MAJOR Console user login/logout
httpLockdown(49) MAJOR HTTP Access locked down
parmChanged(50) INFORM Parameter changed
cfgscript(51) INFORM Configuration script generated/received
authKey(52) MAJOR Authorization key entered - valid/invalid
198 WiYZ Technical Manual MDS 05-4954A01, Rev. C
authDemo(53) MAJOR Demo authorization enabled/expired
maxDemos(54) CRITICAL Max demos reset/reached
modemRestart(55) MAJOR Modem restarted
internalError(56) MAJOR Internal error
gpsRestarted(57) MAJOR GPS Restarted
remoteConnection(58) INFORM Remote associated/disassociated
imageCopyStarted(59) INFORM Firmware image copy started
imageCopyComplete(60) INFORM Firmware image copy complete
imageCopyFailed(61) MAJOR Firmware image copy failed
connectionStatus(64) INFORM Connection status change
connAbort(65) MAJOR Connection cancelled
authenticating(66) INFORM Authenticating to Access Point
association(67) MAJOR Associated to Access Point established/lost
redundLackRem(72) MAJOR Lack of associated Remotes exceeded threshold for P21 AP
redundRecvErr(73) MAJOR Packet receive errors exceeded threshold for P21 AP
redundForced(74) MAJOR P21 AP forced switchover
redundancySwitch(75) MAJOR P21 AP auto switchover
radioError(76) CRITICAL Radio error
procopen(77) MAJOR Proc filesystem access failed
procformat(78) MAJOR Unexpected proc filesystem format
csropen(79) MAJOR Failed to open CSR device
csrstatus(80) MAJOR CSR read failed
csrctrlsignal(81) MAJOR CSR write failed
bandwidthMismatch(83) INFORM Bandwidth of AP in Locations file does not match this unit
gpsSync(84) INFORM GPS synchronized/lost sync
gpsTddSync(85) INFORM TDD synchronized/lost sync
tftpClientConn(86) INFORM TFTP Connection to Client Opened/Closed
tftpClientError(87) MAJOR Error in TFTP Transfer to Client
autoUpgrade(88) MAJOR Auto Firmware Upgrade Retry Scheduled/Starting
autoReboot(89) MAJOR Auto Firmware Boot Failed/Starting
certVerify(90) CRITICAL X.509 certificates loaded/failed
certChainVerify(91) CRITICAL Certificate chain verified/invalid
paTemp(92) MAJOR PowerAmp temperature Normal/Too hot
Table 46. SNMP Traps (Sorted by Code)(Continued)
SNMP Trap Severity Description
MDS 05-4954A01, Rev. C WiYZ Technical Manual 199
9.0 GLOSSARY OF TERMS & ABBREVIATIONS
If you are new to digital radio systems, some of the terms used in this guide may be unfamiliar. The following glossary explains many of these terms and will prove helpful in understanding the operation of the trans-ceiver.
Antenna System Gain—A figure, normally expressed in dB, repre-senting the power increase resulting from the use of a gain-type antenna. System losses (from the feedline and coaxial connectors, for example) are subtracted from this figure to calculate the total antenna system gain.
Bit—The smallest unit of digital data, often represented by a one or a zero. Eight bits (plus start, stop, and parity bits) usually comprise a byte.
Bits-per-second—See BPS.
BPS—Bits-per-second. A measure of the information transfer rate of digital data across a communication channel.
Bridging—(see Ethernet Bridging)
Byte—A string of digital data usually made up of eight data bits and start, stop and parity bits.
CTS—Clear to Send
Decibel (dB)—A measure computed from the ratio between two signal levels. Frequently used to express the gain (or loss) of a system.
Data Circuit-terminating Equipment—See DCE.
Data Communications Equipment—See DCE.
Data Terminal Equipment—See DTE.
dBi—Decibels referenced to an “ideal” isotropic radiator in free space. Frequently used to express antenna gain.
dBm—Decibels referenced to one milliwatt. An absolute unit used to measure signal power, as in transmitter power output, or received signal strength.
DCE—Data Circuit-terminating Equipment (or Data Communications Equipment). In data communications terminology, this is the “modem” side of a computer-to-modem connection. The transceiver described in this manual is hardwired as a DCE device.
Digital Signal Processing—See DSP.
200 WiYZ Technical Manual MDS 05-4954A01, Rev. C
DSP—Digital Signal Processing. The transceiver’s DSP is the core operating unit of the transceiver through which nearly all functions depend.
DTE—Data Terminal Equipment. A device that provides data in the form of digital signals at its output. Connects to the DCE device.
ETH—Ethernet
Fade Margin—The greatest tolerable reduction in average received signal strength that will be anticipated under most conditions. Provides an allowance for reduced signal strength due to multipath, slight antenna movement or changing atmospheric losses. A fade margin of 20 to 30 dB is usually sufficient in most systems.
FPGA—Field Programmable Gate Array
Frame—A segment of data that adheres to a specific data protocol and contains definite start and end points. It provides a method of synchro-nizing transmissions.
Hardware Flow Control—A transceiver feature used to prevent data buffer overruns when handling high-speed data from the RTU or PLC. When the buffer approaches overflow, the WiYZ Gateway drops the clear-to-send (CTS) line, which instructs the RTU or PLC to delay fur-ther transmission until CTS again returns to the high state.
Host Computer—The computer installed at the master unit, which con-trols the collection of data from one or more remote sites.
I/O—Input/Output
IP—Internet Protocol
LAN—Local Area Network
LED—Light Emitting Diode
mA—Milliamperes
MAC—Media Access Control
OTA—Over-the-Air
PA—Power Amplifier
Payload data—This is the application’s user communication data which is sent over the radio network.
Poll—A request for data issued from the host computer (or master PLC) to a Remote radio.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 201
PLC—Programmable Logic Controller. A dedicated microprocessor configured for a specific application with discrete inputs and outputs. It can serve as a host or as an RTU.
PPM—Parts per Million
Programmable Logic Controller—See PLC.
Remote Terminal Unit—See RTU.
RTS—Request-to-send
RTU—Remote Terminal Unit. A data collection device installed at a Remote radio site.
RX—Abbreviation for “Receive.”
Signal-to-Noise Ratio—See SNR.
SCADA—Supervisory Control And Data Acquisition. An overall term for the functions commonly provided through an MAS radio system.
SNR—Signal-to-Noise ratio. A measure of how well the signal is being received at a radio relative to noise on the channel.
SSH—Secure Shell protocol for a network that allows users to open a window on a local PC and connect to a remote PC as if they were present at the remote.
SSID—Service Set Identifier. A name that identifies a particular 802.11 wireless LAN.
Supervisory Control And Data Acquisition—See SCADA.
Telnet—A terminal emulation protocol that enables an Internet user to communicate with a Remote device for management activities as if it were locally connected to a PC.
TX—Abbreviation for “Transmit.”
WAN—Wide Area Network
202 WiYZ Technical Manual MDS 05-4954A01, Rev. C
10.0 APPENDIX A—WIYZ RELEASE NOTES
10.1 WiYZ System Firmware - Version 2.2.3
This document describes a production release of the WiYZ System fea-tures.
Products: WiYZ Gateway, WiYZ Outdoor Remote
Versions:
· Gateway –2.2.3
· Remote – 2.2.2
· ISA100 Mesh Stack – 04.03.14
Release Date: February 24, 2012
The latest revision of product manuals is available for download at the
GE MDS website: www.gemds.com
Introduction
The MDS WiYZ (pronounced “wise”) products combine technology and
function to provide a comprehensive range of solutions for data acquisition
and networking requirements. Whether your application requires the
collection of data from remote, unpowered sensors or deployment in areas
with obstructed communication paths or a bridge for data using the cellular
infrastructure to your enterprise network, the WiYZ products provide simple,
reliable and cost-effective solutions.
• Self-powered remotes connect off-the-shelf sensors, instruments and
switches
• Reduced deployment costs with standard based mesh networking
• Eliminate added cabling, power and infrastructure costs at remote
locations
• Seamless connection to multiple public and private wireless networks
• Ethernet and serial data collection with Modbus and Modbus TCP
• Automatic mesh network creation insures wireless reliability and
performance
• Automatic re-routing of communication in the event of a device
failure or path obstruction
• Global unlicensed use in 2.4 GHz band and public GSM /CDMA
cellular technology
MDS 05-4954A01, Rev. C WiYZ Technical Manual 203
Features
The WiYZ Gateway is the device that connects the WiYZ system to a
network. The Gateway is an outdoor (NEMA 4X/IP65) product that contains
various wired and wireless interfaces. For the wireless mesh remotes, the
Gateway functions as an ISA100 gateway, system manager, security manager,
and backbone router. It collects I/O data from remotes, stores, and presents
the data via Modbus, file transfer, or directly through its user interface. For
network connectivity, the gateway can function as one or more of the
following network devices: cellular bridge, Wi-Fi client, Wi-Fi Access Point,
Ethernet end-device, or MDS entraNET remote. The gateway implements a
full TCP/IP stack and can be configured and managed over a network. It
contains many advanced security features to ensure data integrity and allows
only authorized access for device configuration.
Changes since last release
· VPN capabilities updated to include IPSEC Support.
· Modbus support overhauled to support configurable register
assignment
· Modbus supports “Enhanced” mode operations allowing configurable
register values for unassigned or unavailable registers.
· Added support for 250ms, & 500ms publishing periods.
· Added full support for asynchronous event publication to Gateway in
the I/O database.
· WiYZ remote supports 2-wire and 4-wire RS-485 connections – with
some limitations as discussed below.
Issues resolved since last release
WiYZ Gateway
· Use of COM2 Data Port on the WiYZ Remote supported in both
battery and line power. See operational notes.
· Sensor scaling fixed and presents values greater than 4095.
WiYZ Remote
· Correct COM 2 data format settings limitations.
Unsupported Features
WiYZ Gateway
· “Use Star Topology” selection in the “Mesh Network – Provisioning”
page will have no effect.
· COM 2 Data port settings at 7-bits and 1 stop bit does not
differentiate between 1 or 2 stop bits.
· Wi-Fi using WEP Shared-Key is not supported.
· COM 2 Data port does not support 2-wire RS-485.
· Spanning Tree Protocol
204 WiYZ Technical Manual MDS 05-4954A01, Rev. C
WiYZ Remote
· COM 2 Data port does not support 7-bit modes.
Operational Notes
The following are operational that exist in this release of the software.
1. Configuration and management of WiYZ from the Cellular or
entraNET network interfaces can be very slow on initial load.
2. Downgrading to a previous version of firmware is not recommended
if you have not exported a copy of the current configuration files.
Please contact Technical Service is help is required.
3. Loss of configuration data could occur when using the “Import”
button on the Maintenance & Status page which has no confirmation
window popup.
4. WiYZ Gateway reprogramming may fail, if this occurs restarting the
process will correct the problem.
5. Importing Profiles using a Configuration, the units for Temperature
will revert to Degrees C.
6. Command-line interface is not recommended for WiYZ Gateway
configuration and management.
7. WiYZ Gateway does not support 2-wire RS-485 connections.
8. For Terminal Server operations to the WiYZ remote COM2 port the
committed and excess burst should be kept at default values of 15 and
0.25 respectively, other values may be problematic.
9. Reprogramming via entraNET or Cellular interfaces is not
recommended.
10. Modbus Read/Write operations require communications to the WiYZ
remote may take up to 20-30 seconds of response time.
11. Asynchronous events from WiYZ Remote to WiYZ Remote may
require up to 30 seconds of regeneration time.
12. With Radius User authorization enabled it may require >3 minutes
after boot up before being able to login IF the primary Radius server
is not available.
13. Use of WEP in any Wi-Fi mode is highly discouraged.
14. Committing a device profile to a remote will cause MODBUS polling
errors to occur until the commit has finished.
15. If a user saves a profile by overwriting the existing active profile to
the GW database, MODBUS polling immediately starts to fail and
will only recover when the saved profile has been successfully
committed to the remote.
16. WiYZ Gateway networking usage notes:
a. Reprogramming via HTTP may not work on all systems
properly.
b. When the Firewall is disabled the Firewall Rules Table's
Status for each Rule is “Rule ignored. Firewall is disabled”.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 205
c. Management via SNMP is supported but does not offer 100%
coverage.(Including Config File operations)
d. WiYZ Gateway does not support shutting down ports in the
event of a traffic storm (Spanning Tree).
e. High bandwidth Ethernet traffic > 20Mb/s may significantly
affect the WiYZ Gateway Mesh network.
f. Adding/removing a network interface (LAN, Wi-Fi,
entraNET) from the bridge that is currently in use will cause
loss of connection as the IP address will change.
g. Network setup for passing traffic from WAN via port
forwarding requires external devices to support configuration
of the default gateway IP address.
h. Spanning Tree Protocol settings do not take effect until after
a GW reboot.
i. In the event the Cellular interface stops sending data. A
Gateway reboot is required to address.
j. Reboot recommended after WAN/Firewall change.
k. During a reboot or modification of the Firewall settings, there
is a brief time that the Firewall is not enabled. This is a
function of the Firewall reinitializing. During this time ICMP
messages will get responses and even after the Firewall is
initialized, Pings will continue until the messages are
stopped.
20. WiYZ Gateway Cellular (WAN) connection notes:
a. When using cellular connection be sure Firewall is ON and
NAT is set to ON. Otherwise data traffic may be routed to the
Cell interface, which results in the service provider disabling
the cell connection causing the Cell to continuously go down.
21. WiYZ Mesh Network Usage Notes:
a. If Mesh is enabled, pressing “Commit” may cause the Mesh
network to restart.
b. Line Powered remotes may require up to 10 min to join
Gateway.
c. Sleeping Remotes may require at least 6hrs or more to join
the Gateway. (If the sleeping remote misses the beacon it will
retry every 6hrs.)
d. Changing the time of day or format (NTP, manual
configuration) will cause the Mesh to restart.
e. WiYZ Remotes may have ~2% packet error rate at -91dBm.
f. RSSI reporting at weak signals (< -
g. 90dBm) may not reporting within +/- 3dBm.
h. Timestamp resolution of the I/O database is 1 second, when
using 250ms or 500ms publishing rates may result in up to 4
records with the same timestamp.
22. WiYZ Remote COM2 serial data usage notes:
206 WiYZ Technical Manual MDS 05-4954A01, Rev. C
a. In Low Power mode the WiYZ Remote loses the first byte
received as part of the “wake-up” sequence.
b. Line power is required to a WiYZ Remote in order to
communicate to devices connected to COM2 of the WiYZ
Remote.
i. If a Remote is sleeping a wake-up byte must be sent
from the connected slave device in order for
communication to be established.
c. WiYZ Remote Terminal Server packet size should be limited
to 69 bytes. Larger payloads may be sent but streams of data
would be delivered fragmented. Additionally attempting to
transfer significant data streams will significantly impact
Remote performance or cause malfunctions.
d. COM2 RS232 supports flow control as follows: when the
WiYZ Remote COM2 recieve buffer approaches 80% of its
capacity, the Remote drops the clear-to-send (CTS) line, that
instructs the connected device to delay further transmission.
Once COM2 recieve used capacity goes below 20% of the
buffer capacity, CTS goes back to high state. This approach
brings a “hysteresis” on the toggling of CTS.
e. In a RS-485-multidrop configuration (i.e. a WiYZ Remote
and 2 or more devices connected to the RS-485 bus) any
traffic exchanged between devices connected to the bus
would be transmitted to the Gateway because the Remote acts
as a transparent repeater of the bus traffic.
f. 2-wire RS-485 operation in Low Power mode is NOT
supported.
g. RS-485 does not support hardware flow control.
23. When “waking” from Low Power mode, Analog Outputs pulse high
for 8-10ms
24. Outputs (Analog and Digital) on WiYZ Remotes are placed into the
Failsafe Value whenever a profile is committed to the remote.
25. Event mode propagation/latency is typically 5 seconds but can be up
to 30 seconds.
26. Failsafe times in the Remote are measured from the receipt of the last
valid packet – this may appear to the user to cause a pre-mature
failsafe response.
27. “Stale Data” may show up on a Remote’s COM2 after its anticipated
arrival. This may occur during continuous polling.
Known Errata
The following are known issues that exist in this release of the software.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 207
WiYZ Gateway
· Disabling NAT may shut down the PPP connection to the cell
modem.
· Security Certificates - load via HTTPS only.
· The parameter, Modbus Timeout, configured in the COM2 serial
wizard is not working. (instead use the TCP Modbus parameter)
· eNET (entraNET) configuration changes may not apply on the first
commit. In this case disable and re-enable the eNET.
· Wi-Fi – When in Ad-Hoc or AP Mode the LED does not indicate
correct status.
· Hardware Flow Control not supported.
WiYZ Remote
· Use of the COM2 serial port in Low Power mode does not properly
support 1200/2400 baud rate.
· WiYZ Remote power LED may not come on after the Status Button
is depressed.
· Vext on Voltage Low Remotes may shut off at 40 mA.
· Voltage Low (0 – 100 mV) Remotes support single ended Analog
Inputs.
· Event mode Digital Inputs mapped to Digital Outputs in a local loop
configuration may generate occasional short pulses of 9-11ms.
· When mapping a Remote Input to a Remote Output, and a Remote
has been rebooted and the sequence counter = 0, and the Event arrives
(all of this must occur simultaneously) the first pulse may be
duplicated.
· Unexpected event behavior in sleep mode. – When event pulses are
less than 3 sec apart only one pulse may be generated at the output.
· In the event that a Remote is in the state “Joined-Reading-Config” for
an extended period of time then Remote will require a manual reboot.
During initial setup of Local Loop Regeneration, contracts may initialize incorrectly. A reboot will address.
10.2 WiYZ System Firmware - Version 1.5.5
This document describes a production release of the WiYZ System fea-tures.
Products: WiYZ Gateway, WiYZ Outdoor Remote
Versions:
· Gateway –1.5.5
· Remote – 1.5.5
· ISA100 Mesh Stack – 04.03.14
Release Date: September 16, 2011
The latest revision of product manuals is available for download at the
208 WiYZ Technical Manual MDS 05-4954A01, Rev. C
GE MDS website: www.gemds.com
Introduction
The MDS WiYZ (pronounced “wise”) products combine technology and
function to provide a comprehensive range of solutions for data acquisition
and networking requirements. Whether your application requires the
collection of data from remote, unpowered sensors or deployment in areas
with obstructed communication paths or a bridge for data using the cellular
infrastructure to your enterprise network, the WiYZ products provide simple,
reliable and cost-effective solutions.
• Self-powered remotes connect off-the-shelf sensors, instruments and
switches
• Reduced deployment costs with standard based mesh networking
• Eliminate added cabling, power and infrastructure costs at remote
locations
• Seamless connection to multiple public and private wireless networks
• Ethernet and serial data collection with Modbus and Modbus TCP
• Automatic mesh network creation insures wireless reliability and
performance
• Automatic re-routing of communication in the event of a device
failure or path obstruction
• Global unlicensed use in 2.4 GHz band and public GSM and CDMA
cellular technology
Features
The WiYZ Gateway is the device that connects the WiYZ system to a
network. The Gateway is an outdoor (NEMA 4X/IP65) product that contains
various wired and wireless interfaces. For the wireless mesh remotes, the
Gateway functions as an ISA100 gateway, system manager, security manager,
and backbone router. It collects I/O data from remotes, stores, and presents
the data via Modbus, file transfer, or directly through its user interface. For
network connectivity, the gateway can function as one or more of the
following network devices: cellular bridge, Wi-Fi client, Wi-Fi Access Point,
Ethernet end-device, or MDS entraNET remote. The gateway implements a
full TCP/IP stack and can be configured and managed over a network. It
contains many advanced security features to ensure data integrity and allows
only authorized access for device configuration.
Changes since last release
· Wi-Fi – operational – supporting Station, Ad-hoc, and Access-point
modes of operation.
· ISA100 Terminal Server – ability to pass data to/from the COM2
Serial port of WiYZ Remotes to a terminal server set up on the WiYZ
gateway
· New graphical Network Map capability
MDS 05-4954A01, Rev. C WiYZ Technical Manual 209
· New graphing capability of data in the I/O data base.
· NAT support is now available
· SNMP V3 is now functional.
· Enable or disable TCP/UDP ports in the Routing and Firewall
Configuration
· Significantly improved reliability for over-the-air reprogramming
· Battery life without a connection to the WiYZ Gateway is now
significantly extended beyond the 5 years limited only by the “shelf
life” of the battery.
· WiYZ Remote provides password change support
· eNET LED in direct operates as follows.:
§ entraNET Direct-Mode Node Operation:
§ Off—Disabled.
§ Solid green—One or more Remotes connected to a
direct mode Root.
§ Solid red—No Remotes connected to a direct mode
Root.
§ entraNET Direct-Mode Root Operation:
§ Off—Disabled.
§ Solid green—Available for connected Remotes
· When the Radius User Authentication is in use with the Fallback
mode feature is supported.
· Loss of connection to WiYZ Gateway will cause WiYZ Remote
Outputs into the specified failsafe state.
Issues Resolved last release
WiYZ Gateway
· Packet loss numbers should not exceed 100%.
WiYZ Remote
· Analog outputs should operate properly after a remote power cycle,
profile commit or when a Remote rejoins to its Gateway.
· A Gateway reboot should cause no issues to Remote operation.
Unsupported Features
WiYZ Gateway
· “Use Star Topology” selection for advanced Mesh configuration is
not supported.
· COM 2 Data port settings at 7-bits and 1 stop bit does not
differentiate between 1 or 2 stop bits.
· Port forwarding capability is not available.
· Wi-Fi using WEP Shared-Key is not supported.
· COM 2 Data port does not support 2-wire RS-485.
· Password reset via an auth code on the console doesn’t work.
· The unit does not allow the user to enable or disable TCP/UDP ports
in the Routing and Firewall Configuration.
210 WiYZ Technical Manual MDS 05-4954A01, Rev. C
WiYZ Remote
· COM 2 Data port does not support 2-wire RS-485.
· COM 2 Data port does not support flow control
· COM 2 Data port does not support odd/even parity settings. Use of
8N1 highly recommended.
Operational Notes
The following are operational that exist in this release of the software.
· Downgrading to a previous version of firmware is not recommended.
Request technical support prior to downgrading or upgrading from a
downgraded unit.
· Pressing “Commit” for Mesh enable will cause the Mesh network to
restart
· On initial startup it may require up to 10 minutes for the Mesh
network to form. Data collection and publication during mesh
formation is not supported.
· Outputs (Analog and Digital) on WiYZ Remotes are placed into
failsafe value whenever a profile is committed to the remote.
· Use of COM2 Data Port on the WiYZ Remote requires line power.
(no low power modes)
· Event mode propagation/latency is typically 5 seconds but can be up
to 30 seconds.
· Failsafe times in the Remote are measured from the receipt of the last
valid packet – this may appear to the user to cause a pre-mature
failsafe response.
· Changing the time of day (NTP, or manual configuration) will cause
the Mesh to restart.
· If WiYZ Remote over-the-air firmware upgrades fail for any reason,
the upgrade may be restarted. Note: if the inactive version is shown at
the correct version the upgrade succeeded and the remote may be
rebooted to the new version.
· Management via SNMP is supported but does not offer 100%
coverage.
Known Errata
The following are known issues that exist in this release of the software.
WiYZ Gateway
· Switching the COM2 data port from RS-232 (default) to RS-485
mode requires the Gateway to be rebooted.
· Disabling NAT may shut down the PPP connection to the cell
modem.
· Reprogramming using the entraNET interface is not recommended
and may not complete successfully
· Modbus interface may be impacted by network instability causing an
outage of up to 6 minutes. The entraNET interface has shown more
susceptibility to this than other interfaces
MDS 05-4954A01, Rev. C WiYZ Technical Manual 211
· Changes to the Modbus Unit ID may not be implemented after a
commit.
· Changes to the entraNET configuration parameters may not get
implemented.
· SNMP may become non-functional using V1&V2 – requires a
Gateway reboot.
· The inactivity timer on the Terminal Server is reset only when data is
received from TCP client and not reset when data is received from the
remote. Therefore, terminal server feature should be used only for
polling applications where TCP client application is polling the
device connected to the remote’s COM2 port, sending requests and
receiving responses. The inactivity timer should be set to at least
twice the value of poll timer.
· The committed and excess burst should be kept at default values of 15
and .25 respectively. Other values are not supported in this release.
· The TCP client application should send maximum payload size of 69
bytes. Sending payload greater than this size can cause terminal
server malfunction.
WiYZ Remote
· WiYZ Remote power LED may not come on after the status button
press
· Vext on Voltage Low Remotes may shut off at 40 mA.
· Vext voltage is be affected by temperature. For example at +25C
drawing 40 mA, the voltage was 22.595V. At +70C drawing 40 mA,
the voltage was 22.134V.
· Voltage low (0 – 100 mV) Remotes support single ended analog
inputs.
· Event mode digital inputs mapped to digital outputs in a local loop
configuration may generate occasional short pulses of 9-11ms.
· At weak signals below < -90 dBm RSSI is not reported accurately.
· Sensor scaling may allow values greater than 4095.
· When “waking” from low power mode analog outputs “glitch” high
for 8-10ms.
· Changing baud rates on COM2 requires a reboot of the device.
· COM2 baud rate default is currently 8N2.
212 WiYZ Technical Manual MDS 05-4954A01, Rev. C
11.0 APPENDIX B—GNU GENERAL PUBLIC LICENSE NOTICE
Version 2, June 1991
Copyright © 1989, 1991 Free Software Foundation, Inc.51 Franklin Street, Fifth FloorBoston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software—to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation’s software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser Gen-eral Public License instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this ser-vice if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free pro-grams; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, dis-tribute and/or modify the software.
Also, for each author’s protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors’ reputations.
MDS 05-4954A01, Rev. C WiYZ Technical Manual 213
Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program propri-etary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and modifi-cation follow.
GNU General Public License
Terms and Conditions for Copying, Distribution, and Modification
1. This License applies to any program or other work which contains a
notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The “Program”, below, refers to any such program or work, and a “work based on
the Program” means either the Program or any derivative work
under copyright law: that is to say, a work containing the Program or
a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is
included without limitation in the term “modification”.) Each
licensee is addressed as “you”.
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the
Program is covered only if its contents constitute a work based on
the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
2. You may copy and distribute verbatim copies of the Program’s
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appro-
priate copyright notice and disclaimer of warranty; keep intact all
the notices that refer to this License and to the absence of any war-ranty; and give any other recipients of the Program a copy of this
License along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
3. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and dis-
tribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a. You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
214 WiYZ Technical Manual MDS 05-4954A01, Rev. C
b. You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
c. If the modified program normally reads commands interactively when run, you must cause it, when started running for such inter-active use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Pro-gram, and can be reasonably considered independent and sepa-rate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permis-sions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or col-lective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Pro-gram) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
4. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the fol-lowing:
a. Accompany it with the complete corresponding machine-read-able source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for soft-ware interchange; or,
b. Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete
MDS 05-4954A01, Rev. C WiYZ Technical Manual 215
machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
c. Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include any-thing that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that compo-nent itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distri-bution of the source code, even though third parties are not com-pelled to copy the source along with the object code.
5. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt other-wise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
6. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are pro-hibited by law if you do not accept this License. Therefore, by mod-ifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
7. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restric-
216 WiYZ Technical Manual MDS 05-4954A01, Rev. C
tions on the recipients’ exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
8. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other cir-cumstances.
It is not the purpose of this section to induce you to infringe any pat-ents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contribu-tions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
9. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among coun-tries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
10.The Free Software Foundation may publish revised and/or new ver-sions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Pro-gram specifies a version number of this License which applies to it
MDS 05-4954A01, Rev. C WiYZ Technical Manual 217
and “any later version”, you have the option of following the terms and conditions either of that version or of any later version pub-lished by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any ver-sion ever published by the Free Software Foundation.
11.If you wish to incorporate parts of the Program into other free pro-grams whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Founda-tion; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all deriva-tives of our free software and of promoting the sharing and reuse of software generally.
No Warranty 12.BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PRO-GRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANT-ABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NEC-ESSARY SERVICING, REPAIR OR CORRECTION.
13.IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUEN-TIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
218 WiYZ Technical Manual MDS 05-4954A01, Rev. C
IN CASE OF DIFFICULTY...
GE MDS products are designed for long life and trouble-free operation. However, this equipment, as with all electronic equipment, may have an occasional component failure. The following information will assist you in the event that servicing becomes necessary.
TECHNICAL ASSISTANCE
Technical assistance for GE MDS products is available from our Technical Support Department during business hours (8:30 A.M.–6:00 P.M. Eastern Time). When calling, please give the complete model number of the device, along with a description of the trouble/symptom(s) that you are experiencing. In many cases, problems can be resolved over the telephone, without the need for returning the unit to the factory. Please use one of the following means for product assistance:
Phone: 585 241-5510 E-Mail: [email protected]
FAX: 585 242-8369 Web: www.gemds.com
FACTORY SERVICE
Component level repair of this equipment is not recommended in the field. Many components are installed using surface mount technology, which requires specialized training and equipment for proper servicing. For this reason, the equipment should be returned to the factory for any PC board repairs. The factory is best equipped to diagnose, repair and align your device to its proper operating specifications.
If return of the equipment is necessary, you must obtain a Service Request Order (SRO) number. This number helps expedite the repair so that the equipment can be repaired and returned to you as quickly as possible. Please be sure to include the SRO number on the outside of the shipping box, and on any corre-spondence relating to the repair. No equipment will be accepted for repair without an SRO number.
SRO numbers are issued online at www.gemds.com/support/product/sro/. Your number will be issued immediately after the required information is entered. Please be sure to have the model number(s), serial number(s), detailed reason for return, “ship to” address, “bill to” address, and contact name, phone number, and fax number available when requesting an SRO number. A purchase order number or pre-payment will be required for any units that are out of warranty, or for product conversion.
If you prefer, you may contact our Product Services department to obtain an SRO number:
Phone Number: 585-241-5540Fax Number: 585-242-8400E-mail Address: [email protected]
The device must be properly packed for return to the factory. The original shipping container and pack-aging materials should be used whenever possible. All factory returns should be addressed to:
GE MDS, LLCProduct Services Department(SRO No. XXXX)175 Science ParkwayRochester, NY 14620 USA
When repairs have been completed, the equipment will be returned to you by the same shipping method used to send it to the factory. Please specify if you wish to make different shipping arrangements. To inquire about an in-process repair, you may contact our Product Services Group using the telephone, Fax, or E-mail information given above.
GE MDS, LLC
Rochester, NY 14620Telephone: +1 585 242-9600
FAX: +1 585 242-9620www.gemds.com
175 Science Parkway