EpiSensor ZGW-10 User manual

User Guide
Industrial IoT Gateway
Applies to: ZGW-10
EPI-233-03
© EpiSensor

Table of Contents
Safety Information 4
Installation 4
NCC Warnings 5
Intended Use 5
Related Documents 5
What’s Included? 6
Getting Started 6
Connecting to the Gateway 6
Changing the Default Password 11
Home 11
General 12
Sensor Network 13
Data Export 13
Network 14
Settings ￫Add Nodes 14
Nodes 15
Nodes ￫Node Settings 19
Information 20
Status 21
Properties 21
Sensors 22
Nodes ￫Node Settings ￫Sensor Settings 24
Sensor Information 24
Sensor Properties 25
Data ￫Graph View 27
Data ￫Data File Archive 29
Settings ￫Data Export 29
Quality of Service 30
Status 30
Settings 30
EpiSensor JSON 31
Edge JSON 32
CSV via FTP 33
RKDAP 35
Layout 36
Settings ￫Ethernet 37
Settings ￫Cellular 39
Page 2of 54

Settings ￫Time & Date 41
Settings ￫System 42
Settings ￫Password 44
Settings ￫Sensor Network 45
Logs ￫Log View 46
Logs ￫Log Settings 47
Logs ￫Log File Archive 49
About ￫Overview 49
Ordering Information 51
Region Specific Features 53
Troubleshooting & Support 53
Warranty 54
Glossary 54
Page 3of 54

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.
Symbol
Description
The addition of either symbol to a “Danger” or “Warning” safety label indicates that an
electrical hazard exists which will result in personal injury if the instructions are not
followed.
This is the safety alert symbol. It is used to alert you to potential personal injury hazards.
Obey all safety messages that follow this symbol to avoid possible injury or death.
Installation
Electrical equipment should be installed, operated, serviced and maintained only by qualified personnel. No
responsibility is assumed by EpiSensor for any consequences arising out of the use of this material.
A qualified person is one who has skills and knowledge related to the construction, installation, and operation of
electrical equipment and has received safety training to recognize and avoid the hazards involved.
Installation, wiring, testing and service must be performed in accordance with all local and national electrical
codes.
Installation & Safety Notes
➔EpiSensor equipment should be installed, operated, serviced and maintained only by qualified
personnel. EpiSensor does not assume any responsibility for any consequences arising out of the use
of this equipment.
➔Clearly label the device’s disconnect circuit mechanism and install it within easy reach of the operator.
➔The fuses / circuit breakers must be rated for the installation voltage and sized for the available fault
current.
Page 4of 54

NCC Warnings
This is a class A product. In a domestic environment this product may cause radio interference in which case the
user may be required to take adequate measures.
警告使用者：此為甲類資訊技術設備，於居住環境中使用時，可能會造成射頻擾動，在此種情況
下， 使用者會被要求採取某些適當的對策
Appropriate use is advised to minimise the impact of electromagnetic waves.
減少電磁波影響，請妥適使用
Radio wave power density MPE standard value: 1 mW/cm2, measured value of the sent product: 0.142 mW/cm2,
it is recommended that the device antenna be at least 20 cm away from the human body when in use.
電波功率密度 MPE 標準值:1 mW/cm2,送測產品實測值:0.142 mW/cm2,建議使用時設備天線至少距離人體
20 公分
Intended Use
Do not use this device for critical control or protection applications where human or equipment safety relies on
the operation of the control circuit. Failure to follow these instructions can result in death, serious injury, or
equipment damage.
Related Documents
Related installation and configuration documents are listed in the following table:
Document
Reference No.
EpiSensor ZGW-10 Datasheet
EPI-213-01
EpiSensor ZGW-10 Install Sheet
EPI-215-01
Gateway API User Guide
ESE-009-08
Bootloading on a live Gateway
EPI-064-00
Use of Node Profiles on the EpiSensor Gateway
EPI-208-00
Page 5of 54

What’s Included?
The items included with each EpiSensor Gateway are as follows:
ZGW-10
Qty
Item
1
ZGW-10 IoT Gateway
1
Primary Cellular Antenna
1
Secondary Cellular Antenna
The ZGW-10 Gateway requires an external 12/24V power supply that is not included as standard. For information
on the accessories available for each model, please contact [e-mail]
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.
This user guide contains technical information on configuring and maintaining the central component in the
platform - the Gateway. For a minimum system, you will need a Gateway, a computer to access the web interface
of the Gateway, an Ethernet cable (included) and at least one wireless node.
Connecting to the Gateway
Please confirm that all items listed above are present before proceeding. Also note the following guide relates to
release V4 of the Gateway software.
Page 6of 54

Quick Setup for ZGW-10
1. Connect the ZigBee dongle to USB port 3 as shown above
2. Connect an Ethernet cable between your computer and the Ethernet Port on the ZGW-10 Gateway
3. 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 7of 54

4. Connect a 12V / 24V power supply to Gateway’s DC input jack (marked “PWR” on the label), to the
USB-C port, or to the green DC input terminals. Note: only connect one power source at a time.
5. Configure your computer’s Ethernet settings with a static IP address of 172.31.255.123 and a subnet
mask of 255.255.255.0
6. Connect to http://172.31.255.1:8081/ with a modern browser
7. Login with Username: admin, Password: A1
8. Go to Settings ￫System. Select ‘Form New Network’ and Submit. Wait for 20 seconds.
9. Go to Settings ￫Add Nodes and enable ‘allow join’ mode for 1 hour.
10. Power on any mains-powered nodes. Press and hold ‘mode button’ until the Status LED flashes on
battery-powered nodes.
11. If the nodes are in factory default condition, they will connect to the Gateway and appear in the nodes
list.
Important Note
The factory default IP address for all Gateways is 172.31.255.1
It can take up to 5 minutes for the Gateway to initialise. After this time, go to http://172.31.255.1:8081/ in a
modern browser and you should see the Gateway login interface below.
Important Note
You will need access to port 8081 to access the web interface of the Gateway and the API.
Other ports used depending on what features are enabled and what data export type is
selected.
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
the general state of the ZGW-10 as follows:
PWR LED STATUS
ACT LED STATUS
Meaning
OFF
*
Gateway is not powered.
ON
FLASHING
Gateway is powered and operating normal. Note that the ACT LED
duty cycle is low when the gateway is operating normally. It will have
a longer duty cycle during the boot sequence of the gateway.
Page 8of 54

ON
ON
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.
If the login page fails to load, try pinging the Gateway’s IP address from the command line on your computer:
If the ping request is timing out, verify that the physical network connection is OK, and check that the network
settings have been applied correctly.
Page 9of 54

Figure 1 - Login Screen
Important Note
The default Gateway user account is Administrator; the default login details for this account
are as follows:
Username: Administrator
Password: A1
On recent Gateway software releases, “admin” will also be accepted as the username for this account. If the
incorrect password is entered, four more attempts are permitted before the user is locked out for five minutes.
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 [e-mail]
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 10 of 54

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. Passwords can consist of letters [A-Z] and [a-z], numbers [0-9] and the following characters [. ! * ^ _ -]
Figure 3 - Password Change Screen
After successful login, there is a session timeout on the web interface. After one hour of inactivity on the
web-interface users will have to re-login to the web interface.
Home
The Home page is the first page encountered after log-in. The aim of the Home page is to provide an overview of
the status of the Gateway.
Page 11 of 54

Figure 4 - Dashboard View
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).
Uptime: How long the Gateway application has been running for in days, hours, minutes and seconds.
Logging Level: The currently configured Log Level (See Logs ￫Log Settings for more information).
Page 12 of 54

Sensor Network
This subsection provides information about the wireless sensor network that this Gateway is controlling. The
term “Node” refers to all EpiSensor wireless monitoring products. A node may have zero or more “Sensors”.
Example
An EpiSensor TES-11 temperature sensor node has two sensors: a temperature sensor and a
battery level sensor.
ZAP Connection: This indicates how the NGR is configured to connect to the ZAP. The connection will be either
via RS232 or via Socket.
Node Usage: This represents the number of nodes currently joined to the wireless sensor network. There is a
progress bar which shows the current usage level and the maximum allowed. The maximum number of nodes
that may be joined to the ZGW-10 Gateway network is 100.
Node Status: The node status in terms of inactive and active nodes. Active nodes are nodes that are operating as
expected, inactive nodes are nodes that have not reported data as expected.
Allow Join: The allow join status indicates whether or not the Gateway has opened the network for new nodes
to join. (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.
Export Enabled Sensors: The number of sensors that have been enabled for ‘data export’ on this Gateway. This
parameter is useful when licensing 3rd party software products.
Data Export
This subsection displays information relating to the data export features on the Gateway.
Last Export: Displays the amount of time that has passed since the Gateway last exported data.
Export Type: The active data export ‘driver’.
Export Interval: How often the Gateway is configured to export data.
Page 13 of 54

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. This is
determined by polling an external server on the Internet.
Settings ￫Add Nodes
To add a node to the Gateway first navigate to the Settings ￫Add Nodes page of the Gateway web interface.
By default the wireless sensor network is ‘closed’ and does not allow new nodes to join. From this page, the
network may be ‘opened’, thus allowing new nodes to join. Similarly from this page, an ‘open’ network may be
‘closed’ which re-enables the wireless sensor network and prevents new nodes from joining.
If a network is currently ‘closed’, it may be opened by selecting the Allow Join ‘Enable’ radio button and selecting
the time period for which Allow Join should be enabled for, then clicking ‘Submit’.
Figure 5 - Allow Join
If a network is currently ‘open’, it may be closed by selecting the Allow Join ‘Disable’ radio button, and
submitting the form.
Page 14 of 54

Example
If a network is currently ‘open’ and allow join mode is enabled for X amount of time, this will
override the previously selected time period.
For adding nodes to a network when the ZAP (Zigbee Access Point) firmware version is lower than 1.60, please
contact [e-mail]. The firmware version of the ZAP can be checked on the Settings ￫Sensor
Network page.
When “allow join” mode has been enabled on the Gateway, mains powered nodes that are in a factory default
state should detect the open network and join the Gateway. They will appear in the Nodes ￫List View page. To
add battery powered nodes to the Gateway, press and hold the button until the LED flickers and then turns on
constantly, and then release the button. This will wake the battery powered node up from a low power state and
force it to scan for open networks, (assuming the node is in a factory default state). For the location of the
button and LED see the relevant section of the user guide relating to that product.
To join nodes that have already been associated with another Gateway, a ‘factory reset’ will be required. For
instructions on resetting a node to the factory default state, see the “Button and LED Interface” section of this
document.
Nodes
This Nodes page shows the list of nodes that have been added to the Gateway. This list may be empty if there is
no ZAP connected or if the ZAP is connected but no nodes have been added to the Gateway.
Page 15 of 54

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. Navigate to the node settings page
using the drop-down ‘action’ menu. The user can then go a level deeper into a settings page for each sensor.
Note
Some “batch commands” are available from the nodes list page that can save time when
configuring data export. A batch command is a command that changes settings for all of the
sensors on a node.
For each node in the network the following information is shown:
Page 16 of 54

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” of the node).
Last Data: The amount of time since the last data point was received from any sensor of this node. This will show
“None” if no data has been received.
Note
This value is approximated to the nearest second, minute, hour or day. For example “5
hours” could be 5 hours plus any number of minutes and seconds past the hour. The exact
time of the last data point can be found on the Node Settings page.
Export: If at least one sensor of this node is enabled for data export then a tick will be shown . Otherwise it is
set to the following icon:
In Sync: A warning icon will be shown if there are over-the-air commands pending for this node: Over-the-air
commands are issued as a result of the selection of an “Action” from the drop down list for each node. If the
node is ‘in-sync’ with the information on the Gateway, the following icon will be shown:
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: Otherwise the column will show the following icon: The
purpose of this field is to highlight nodes that are no longer connected to the wireless network. “Heartbeats” are
messages received regularly from all nodes on the network that inform the Gateway that they are active on the
network.
Firmware: 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.
‘Legacy mode’ will automatically be enabled for nodes with a firmware version of 2.6 or lower. There are no
additional settings to be configured for this mode. Data from these nodes will be interpolated to a 15 minute
reporting interval. Cumulative sensors such as kWh or pulse sensors will report in kWh/15min period. The Export
ID and other parameters for these sensors can be configured in the normal way. For more information on Legacy
Mode please contact [e-mail]
For each node in the network the actions shown below are available from the drop down list:
Page 17 of 54

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.
Sync: A “node property” can be a read-only or configurable parameter relating to a node or sensor. Selecting this
action will issue a command to request that all node properties be refreshed. This action will result in numerous
over-the-air commands being issued. It can be used if the settings pages for a node or sensor have not been fully
populated (i.e. that some fields are displaying a dash “-“ symbol). This could be caused by the Gateway being
powered down while a new node is being added.
Export All: Enable data export from all sensors of this node. Export can be enabled or disabled for individual
sensors from the Nodes ￫Settings (via “Action” drop-down list) ￫Sensor Settings (via “Action” drop-down list).
Export None: Disable data export for all sensors of this node. Export can be enabled or disabled for individual
sensors of this node from the Nodes ￫Settings (via “Action” drop-down list) ￫Sensor Settings (via “Action”
drop-down list).
Reset Node: Send an over-the-air command to reset the node. This is equivalent to power cycling the node (i.e.
switching the nodes off and then on). No settings on the node will be lost.
Factory Reset Node: Send an over-the-air “factory reset” command to the node. In this case all node settings will
be lost; the node will disconnect from the Gateway and will be returned to a factory default state.
Settings: Navigate to the Settings page for this node.
Page 18 of 54

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. To permanently delete a live node from the Gateway, first
issue a “Factory Reset Node” command to the node, then delete the node from the Gateway.
After an action has been selected, a response message will be
displayed at the top of the page. In the case of actions which
result in over-the-air commands being issued, the response
message can only confirm that the command was sent. The log
file (accessed through Logs ￫Log View) will provide information
regarding the response received from the node, assuming the
Log Level is set to a high enough level (see ‘Log Settings’ section
for more information). When the command has completed
(successfully or not) the In-Sync flag will show the tick symbol.
However, to confirm that the command has been implemented
users must either check the log file, or the relevant settings
page.
The Gateway’s web interface is designed to work on a variety of
mobile phone and tablet web browsers. If the Gateway is
accessed from these devices, the screen size will adapt. For
mobile phone browsers in portrait mode, the top navigation bar
will be replaced with a drop down list. In addition, on pages that
include a table of data, some columns will be hidden to improve
the user experience:
Figure 8 – Gateway web Interface on Mobile Web Browser
Nodes ￫Node Settings
The node settings page provides more detail on a specific node, and allows users to change node level settings.
Changes to the node settings may be submitted by clicking the 'Save Changes' button and the bottom of the
page.
Page 19 of 54

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. This name will be used then in the Nodes ￫List View and Data pages.
Note
Assigned node names may contain alphanumeric characters (A-Z, a-z, 0-9) as well as full stop
( . ), underscore ( _ ), dash ( - ) and a space.
Description: A description of this node. This field is optional and could be used to describe a node location,
Page 20 of 54