Table of Contents
Advertisement
Quick Links
Advertisement
Table of Contents
Related Manuals for EpiSensor ZGW-10
Summary of Contents for EpiSensor ZGW-10
- Page 1 User Guide Industrial IoT Gateway Applies to: ZGW-10 EPI-233-03 © EpiSensor...
-
Page 2: Table Of Contents
Sensor Information Sensor Properties Data ￫ Graph View Data ￫ Data File Archive Settings ￫ Data Export Quality of Service Status Settings EpiSensor JSON Edge JSON CSV via FTP RKDAP Layout Settings ￫ Ethernet Settings ￫ Cellular Page 2 of 54... - Page 3 Settings ￫ Time & Date Settings ￫ System Settings ￫ Password Settings ￫ Sensor Network Logs ￫ Log View Logs ￫ Log Settings Logs ￫ Log File Archive About ￫ Overview Ordering Information Region Specific Features Troubleshooting & Support Warranty Glossary Page 3 of 54...
-
Page 4: Safety Information
Safety Information Please read these instructions carefully before trying to install, operate, service or maintain the ZGW-10. The following special notes may appear throughout the user guide (or on the equipment labels) to warn of potential hazards or to call attention to information that clarifies or simplifies a procedure for users. -
Page 5: Ncc Warnings
Related installation and configuration documents are listed in the following table: Document Reference No. EPI-213-01 EpiSensor ZGW-10 Datasheet EPI-215-01 EpiSensor ZGW-10 Install Sheet ESE-009-08 Gateway API User Guide EPI-064-00 Bootloading on a live Gateway EPI-208-00 Use of Node Profiles on the EpiSensor Gateway Page 5 of 54... -
Page 6: What's Included
Getting Started EpiSensor’s IoT platform is easy to deploy, configure and scale and includes a range of sensor products that can monitor a variety of environmental and energy usage parameters in commercial and industrial environments. - Page 7 2. Connect an Ethernet cable between your computer and the Ethernet Port on the ZGW-10 Gateway If your version of the ZGW-10 has a cellular modem, Wi-Fi / Bluetooth or GPS, connect the antennas as shown on page 2 of the ZGW-10 install sheet (document ref. EPI-215-01).
- Page 8 There are four LEDs on the ZGW-10. The M.2 PWR and M.2 NET LEDs indicate the cellular modem status and are described later in this document in the section on enabling the cellular modem. The PWR and ACT LEDs indicate...
- Page 9 During the boot sequence both LEDs may be ON for a duration of a few seconds. However if both LEDs remain ON the boot sequence has failed. The Gateway supports all recent versions of Chrome, Firefox, Safari and Edge web browsers. On older browsers, some features may not display correctly.
- Page 10 After five minutes has elapsed you can try again, up to another five attempts are allowed, and so on. In the event of the password being irretrievable, please contact support@episensor.com After logging in, you will see a navigation bar at the top of the page. The sections in this document match the links in this top navigation.
-
Page 11: Changing The Default Password
Figure 2 - Navigation Changing the Default Password It is strongly recommended to change the default account password after login by navigating to Settings ￫ Password. Please note that passwords are case sensitive. The screenshot below shows the password change interface. -
Page 12: General
Status: The status of the Gateway system. This indicates whether or not the gateway software is up and running. It does not indicate the status of the wireless sensor network. If this parameter is not showing “OK” please contact EpiSensor support. Time & Date: The current time and date in terms of Coordinated Universal Time (UTC). -
Page 13: Sensor Network
(See Settings ￫ Add Nodes for more information). Sensor Usage: This represents the number of sensors in the wireless sensor network that are reporting data. This value is shown on a progress bar. The maximum number of reporting sensors in the ZGW-10 Gateway network is 1000. -
Page 14: Network
Network This section provides an overview of how the Gateway is connected to a LAN or the Internet. Connection: Shows the active network interface – this could be Ethernet or Cellular modem. Internal IP: The IP that the Gateway has been configured with or assigned by a DHCP server. External IP: If the Gateway has Internet access, this is the Gateway’s IP address on the internet. -
Page 15: Nodes
For adding nodes to a network when the ZAP (Zigbee Access Point) firmware version is lower than 1.60, please contact support@episensor.com. The firmware version of the ZAP can be checked on the Settings ￫ Sensor Network page. - Page 16 Figure 6 - Nodes List View Note the hierarchy of settings for Nodes and Sensors. The nodes list (above) lists each node connected to the Gateway, with status information and links to take action or view node settings. The node settings page provides status and communications information specific to that node, allowing users to change node level settings and list the sensors associated with that node.
- Page 17 Name: The node name, by default is the node serial number but may be assigned on the Nodes ￫ Settings page (use the ‘action’ drop-down menu to access this page). Product Code: The EpiSensor specific product code. Details on product codes can be found in the products section of this user guide or at https://episensor.com/products Serial: The unique serial number of the node (also referred to as the “long address”...
- Page 18 Figure 7 - Nodes List Action Drop-Down Each of the actions above is described in more detail as follows: Ping: Send a “Ping” over-the-air command to the node. The purpose of sending a Ping command to a node is to check if it is alive.
-
Page 19: Nodes ￫ Node Settings
Delete: Remove this node from the Gateway. This does not remove the node from the wireless sensor network; it merely removes the node from the Gateway's records. This typically would be used to remove unresponsive nodes from the list. If a responsive node is removed from the list, it will automatically be added the next time it sends a heartbeat or a data point to the Gateway. -
Page 20: Information
Figure 9 - Node Settings Information Serial Number: The unique serial number of this node. Short Address: The short address of this node. Name: The name of this node. This value defaults to the node serial number, however a non-default name may also be assigned. -
Page 21: Status
record an asset tag or to note when maintenance is due. Note Assigned node descriptions may contain alphanumeric characters (A-Z, a-z, 0-9) as well as full stop ( . ), underscore ( _ ), dash ( - ) and a space. Status Status: If no communications have been received (data or heartbeats) from a node in the last 30 minutes, the status column will show the following icon:... -
Page 22: Sensors
Product Code: The EpiSensor specific product code. Details on product codes can be found in the products section of this user guide. Firmware Version: This field lists the version of firmware that each node is running. For optimal performance the node firmware version should be 2.60 or higher. - Page 23 Export: This icon indicates whether data export has been enabled or disabled for this sensor. The Export ID for a sensor can be configured on the Nodes ￫ Settings ￫ Sensor Setting page. If export is disabled for a sensor, the following icon will be shown: Reporting: Indicates whether data reporting is enabled for this particular sensor.
-
Page 24: Nodes ￫ Node Settings ￫ Sensor Settings
Nodes ￫ Node Settings ￫ Sensor Settings This page provides more details on a specific sensor. Changes to the sensor settings may be submitted by clicking the “Save Changes” button at the bottom of the page. Figure 13 - Sensor Settings Page Sensor Information Node Name: The name of the node that this sensor belongs to (as assigned by the user on the Nodes ￫... -
Page 25: Sensor Properties
Units: The units of data the sensor reports data in. In Sync: This flag indicates if there are over-the-air commands pending for this sensor. Over-the-air commands are issued as a result of an “Action” command being sent using the drop down list on the Nodes ￫ Settings page, or from this page, or by changing a setting. - Page 26 capture events by reporting data as frequently as possible. To deal with these conflicting requirements, various ‘Delta Reporting Modes’ are available on all sensors. “Delta only” mode reports a data point when a change is detected that exceeds the value defined in “Reporting Delta”.
-
Page 27: Data ￫ Graph View
amount of time a particular node can log data for, first calculate how many data points will be produced per day for that node, and then divide the 10,000 point buffer by that number to get the number of days the node can log data for. - Page 28 Figure 15 - Graph View Screen From here the parameters of the data graph may be selected and the graph will be displayed by clicking the “Build Graph” button. Auto Refresh: Whether or not the graph should be automatically refreshed while the graph page is loaded. If selected, the page will reload every minute.
-
Page 29: Data ￫ Data File Archive
The files are listed in date order with the most recent at the top of the page. The ZGW-10 Gateway has a minimum of 8GB of on-board flash storage available, approximately 6GB of which is available for data storage. -
Page 30: Quality Of Service
Quality of Service Data in the EpiSensor platform is ‘pushed’ from each node to the Gateway via a ZigBee wireless mesh network. Nodes take a cautious approach to delivering data - if an acknowledgement is not received by the node in time, a data message will be retried. -
Page 31: Episensor Json
Data can be pushed to a HTTP(S) web service or stored locally. Data will be exported in an efficient JSON format, similar to EpiSensor JSON, with an array of data points. A unique identifier (which defaults to the Gateway’s serial Edge JSON number) can be configured. -
Page 32: Edge Json
Gateway ID: This field is a unique identifier for the Gateway, which defaults to the serial number of the Gateway, but is configurable. Note that the Gateway ID field must also be completed in the case where EpiSensor JSON is stored locally. -
Page 33: Csv Via Ftp
Edge JSON Format: "method":"epi_edge_data", "ver":"1.0", "gateway":"000D6F00010B768E", "nodes":[ "serial_number":"000D6F000FF14359", "data":[ "id":"24", "export_id":"000D6F000FF14359_24", "timestamp":"1549018805", "value":12 "id":"25", "export_id":"000D6F000FF14359_25", "timestamp":"1549018805", "value":1.142 In this example the Gateway ID is “000D6F00010B768E”. Data is originating from one node with serial “000D6F000FF14359” and there are two data points from that node in the payload. The first data point has a Unix / Epoch timestamp of "1549018805"... - Page 34 Remote Directory: The remote directory to store files in. This is an optional field. Leading and trailing backslashes ( \ ) are also optional and will be ignored. FTP Timeout: The timeout to use for all FTP transactions. Default value is 300000 milliseconds. Note The FTP server must be configured to accept PASSIVE mode connections to avoid problems with Firewalls on the client side.
-
Page 35: Rkdap
ID (see the ‘Sensor Settings’ section for more information). Export ID’s should be noted when configuring data feeds in any other software system. For more information regarding the export protocol definitions contact: support@episensor.com Note The file name of the CSV file will be DAT_XXXXXX_YYYYYY.csv where XXXXXX is the Gateway’s unique serial number and YYYYYY is a date/time stamp. -
Page 36: Layout
If a data export via FTP or HTTP(S) fails, the export file will be stored on the local file system. The number of files queued for export in this way will be reflected in the “Status” section of this page. Export of these files will be retried periodically, based on the data export interval. -
Page 37: Settings ￫ Ethernet
Figure 19 – Layout View Screenshot Settings ￫ Ethernet The Settings ￫ Ethernet page shows the status of the Ethernet interface on the Gateway and also allows users to configure the way the Gateway is assigned an IP address. Page 37 of 54... - Page 38 Figure 20 - Gateway Ethernet Settings The following information is provided as part of the status of the Ethernet interface: Name: The name of the Ethernet interface, typically eth0, or in the case of the Cellular modem being enabled, br0, because in this mode the Gateway can act as a network bridge. MAC Address: The hardware address of the Gateway’s Ethernet interface.
-
Page 39: Settings ￫ Cellular
The configuration section of this page will be disabled if there is no Ethernet interface found or if the 3G modem is enabled. It is not possible to configure the Ethernet interface in these scenarios. The following fields are used to configure the Ethernet interface: Enable DHCP: If this checkbox is ticked, dynamic IP addressing will be enabled for the Ethernet interface. - Page 40 Network: The network type supported by this modem. Figure 22 - Cellular Network Settings The following information is used to configure the 3G cellular network connection: Enable Cellular Modem: Whether or not to enable the cellular modem. This does not indicate whether or not the Gateway has successfully connected to the cellular network using the modem.
-
Page 41: Settings ￫ Time & Date
Poll Interval: The rate at which the Gateway will attempt to open a TCP connection to the host configured above. There are two LEDs on the ZGW-10 which indicate the modem status. The M.2 PWR LED will indicate when the modem is powered. -
Page 42: Settings ￫ System
Figure 24 - Time and Date Settings Page After selecting the time zone, date and time, click ‘Save Changes’ for the changes to take effect. Changing the system time will result in the Uptime field on the Dashboard page being reset. Changing the system time will also invalidate the “Time Since Last Data Export”... - Page 43 After forming a new network, “Allow Join” mode should be enabled to allow nodes to join the new network. Forming a new network should only be done after consultation with EpiSensor support. Note Nodes must leave their current network before they will attempt to join a new network.
-
Page 44: Settings ￫ Password
Restart Gateway Application: Restarts the Gateway software. Shutdown Gateway Application: Shuts down the Gateway software. Restart Gateway Hardware: Restarts the Gateway hardware (the Gateway software will be restarted as a result). Shutdown Gateway Hardware: Shut down the Gateway hardware (the Gateway software will be shut down as a result). -
Page 45: Settings ￫ Sensor Network
Extended Pan ID: Zigbee Personal Area Network Extended identifier. Channel: The channel number (11 - 26) within the 2.4GHz radio band in use by this Zigbee network. Profile: A unique identifier assigned to EpiSensor by the Zigbee Alliance. It defines the EpiSensor Zigbee network Profile. -
Page 46: Logs ￫ Log View
Boost Enabled: Whether or not signal power boost is enabled. If this is enabled, the Zigbee radio signal power will be boosted by 2dB. ZAP Long Address: The unique serial number of the ZAP. This is also defines the serial number of the gateway (see About ￫... -
Page 47: Logs ￫ Log Settings
Each log message will include the following information: ● Time that the log message was generated at. ● Execution thread that generated the message. ● The logging level of this message (e.g. INFO). ● The method that generated the message. ●... - Page 48 Logging Level: This parameter controls the severity of log messages that will be recorded. There are 7 log severity levels as follows, with Level 1 being the lowest level which records most data, Level 7 being the highest level which records least data: Log Level Description This is the lowest level and is used for debugging of the software.
-
Page 49: Logs ￫ Log File Archive
Host: The Syslog server host name or IP address. Port: The Syslog server port number. The default is port 514. Logs ￫ Log File Archive The currently active log file (gateway.log) and all archived log files are listed on this page. The files can be downloaded from this page. - Page 50 Figure 32 - About Page Gateway Serial: This is the serial number of the Gateway. It is derived from the serial number of the ZAP that is connected to the Gateway. The Gateway serial number is used as a unique identifier in each data export file name.
-
Page 51: Ordering Information
Login page. Ordering Information EpiSensor products are available to order directly or via EpiSensor’s distribution partners. The following table lists the available ZGW-10 options. Product Code Example: ZGW -... - Page 52 Compliance Label There is a compliance label on the front of the ZGW-10 with important compliance and regulatory information. The label material is white PVC with permanent adhesive and matte overlaminate. The following table lists the certification and safety symbols that appear on the certification labels of the EpiSensor ZGW-10. Please refer to it for a definition of each symbol.
-
Page 53: Region Specific Features
Region Specific Features Some features of the ZGW-10 are not available in all regions worldwide. The following tables list features that are not available / disabled in each region: Taiwan ●... -
Page 54: Warranty
All EpiSensor products and provided with a 365 day limited warranty effective from the shipping/invoice date of an order. During the warranty period, under the conditions of normal use, EpiSensor will repair or replace any product that has a manufacturing defect.
Need help?
Do you have a question about the ZGW-10 and is the answer not in the manual?
Questions and answers