Saturn South SS9002 Manuale utente
D101.2 18 Apr 2017
SS9002 ESBox LT
User Manual –Version 3
2
Table of Contents
1 Safety Notices .................................................................................................................................3
2 LED Quick Reference.......................................................................................................................4
3 Button Quick Reference..................................................................................................................5
4 Product Overview ...........................................................................................................................6
5 Technical Specifications ..................................................................................................................7
6 Web Interface Overview .................................................................................................................8
6.1 Overview Page ........................................................................................................................8
6.2 Wedit –Inbuilt AJAX text editor............................................................................................10
6.3 Devices Page .........................................................................................................................11
6.4 Network Options...................................................................................................................14
7 ESBox-ESCo Protocol.....................................................................................................................14
8 Installation ....................................................................................................................................15
9 Errors and Troubleshooting ..........................................................................................................16
10 Document Revision History.......................................................................................................16
3
1Safety Notices
This manual does not comprehensively cover all safety measures for installation and operation of
the device, since local code requirements and special operating conditions may necessitate further
measures.
Qualified Personnel
This device should be installed by technically qualified personnel. Failure to install in compliance
with national and local electrical codes and according to Saturn South recommendations may result
in electrical shock or fire hazard, unsatisfactory performance, or equipment failure.
This product is not intended for use by persons (including children) with reduced physical, sensory or
mental capabilities, or lack of experience or knowledge, unless they have been given supervision or
instruction concerning use of the product by a person responsible for their safety.
Children should be supervised to ensure that they do not play with the product.
Maintenance
Servicing of this device in the field is not possible and should not be attempted. If servicing is
required, please return this device to Saturn South or an authorised distributor. Opening the product
enclosure, for any reason, will render the Product Warranty void.
4
2LED Quick Reference
LED Status indications are shown in the same order as in the above diagram, for
example:
The above status would indicate that the ESBox was operating normally, that an
Ethernet connection is detected, that it has recently communicated with the ESCo
successfully, and that the ZigBee network is functioning correctly.
If a the current status of an individual LED does not affect the meaning of the
remainder of the LED pattern, it will appear as a . Blinking LEDs are shown as an
outline in the colour of the blink, such as , which indicates blinking green. For
example:
Means that the ‘ESBox Status’ LED will be solid blue, the ‘ZigBee Status’ LED will be
blinking green, and that the ‘Ethernet Status’ and ‘ESCo Connection’ LEDs are not
relevant to the meaning of the status.
LED Status
Comments
ESBox is functioning correctly.
ESBox is in ‘Permit Joining’ mode.
ZigBee network is starting up or restarting. This
state should not persist for more than a few
seconds.
ZigBee network failure.
No connection to ESCo.
Succesfully connected to ESCo, but failed
authentication.
No Ethernet connection detected.
Ethernet connection detected, but ESBox has
not been issued an address via DHCP.
ESBox application is starting up. This state
should not persist for more than a few seconds.
ESBox application error. Report the colour of the
next three LEDs to Saturn South for debug
purposes.
ESBox is in ‘Update’ mode.
ESBox is downloading files from the update
server.
ESBox application update in progress.
ESBox coorinator update in progress.
ESBox LT LED Indications in normal operation
SS9002 ESBox LT
5
3Button Quick Reference
Button press sequences are composed of only two types of button press:
•Short press (“S”) – less than one second
•Long press (“L”) – greater than 2 seconds (the ESBox LEDs will turn green when the button has been held for long enough to register a ‘Long’ press)
Button press sequences are expressed as combinations of these two types, for example: LSSS = A long press, followed by three short presses.
Button press sequences are acknowledged immediately when they are entered. If a mistake is made when entering a button press sequence, the user should wait
for at least 5 seconds for the sequence monitor to reset, and then try again. The device LED will blink amber for a few seconds to indicate a reset of the button
sequence monitor. Note that much of the functionality described here can also be accessed through the ‘Devices’ page on the ESBox web interface.
Feature Name
Button
Sequence
Intention of Sequence
Notes
Factory Reset
LLLSS
Performs factory reset.
The ESBox will lose all knowledge of any currently paired
devices, and will clear any existing OTA update registrations.
Permit Join Mode
LSSS
Places device into ‘Permit Joining’ mode to allow
the device to connect to ESBox’s network.
Reset Static
LSSLS
When entered, the ESBox will use a default static
IP the next time it starts.
ESBox can be reached at 10.55.55.1 in this mode.
Reset DHCP
LSSLSS
When entered, the ESBox will use DHCP the next
time it starts, irrespective of the current network
settings.
Reboot
LSLS
Reboot device
De-register Updates
LLSSS
De-register and ZigBee updates that have been
registered on the ESBox.
This will cancel any active OTA process. The ESBox’s device
list will be unaffected.
Reset Network
LLSLS
Clear the ESBox’s device list and restart the ZigBee
network.
Registered OTA updates will be preserved.
Reset UI Password
LSLLS
Reset the ESBox Web UI login to username ‘esbox’
and password ‘esbox’
Force Re-Enable Web UI
LSLSS
Enable the Web UI even if it has been explicitly
disabled in the .usrconf settings file
WAPP_en=0 will be ignored until the next restart.
SS9002 ESBox LT
Release
6
4Product Overview
The SS9002 ESBox LT ZigBee-Ethernet gateway provides a bidirectional link between installed ZigBee
devices –such as Saturn South load control products –and a remote server. Up to 20 ZigBee devices
can be managed simultaneously by the ESBox LT, with support for a growing number of third-party
ZigBee Home Automation compatible devices.
The SS9002 ESBox LT is capable of storing up to 28 days of measurement data for 8 load control
devices in internal memory. Logged data can be retrieved on demand by a remote server or sent
automatically at a configurable interval.
A flexible update system enables remote firmware upgrades for the ESBox LT and Over The Air (OTA)
updating of devices connected to the ZigBee network. Standards-based network security ensures the
privacy of consumer information at all times.
A straightforward deployment and commissioning process helps to minimise the cost of large scale
roll-outs, and powerful Zigbee network diagnostics tools are available to troubleshoot Home Area
Network (HAN) setup in difficult sites.
The ESBox LT connects via wired Ethernet to any network with internet access, and logged data is
retrieved from the ESBox LT using a freely available protocol. Communications can be dynamically
throttled to limit the use of the consumer's Internet bandwidth as required.
The ESBox LT is suitable for a wide range of applications, from basic data logging and energy
consumption reporting, to high-speed Demand Management and Network Support applications in
isolated power networks.
7
5Technical Specifications
Type: ESBox LT ZigBee-Ethernet Gateway
Model: SS9002.1
Power Supply: 5VDC 0.6A
Operating Temperature Range: -20°C to +65°C
Storage Temperature Range: -25°C to +80°C
Relative Humidity: 10-95% non-condensing
Average Power Consumption: <4W
Mass: 0.080kg
Dimensions: 80 x 56 x 23.5 mm
Standards and Approvals:
•AS/NZS 61000.6.3
•AS/NZS 4268
•Radiocommunications Class Licence (2000)
•RCM
8
6Web Interface Overview
The ESBox LT includes a web interface for configuring the device’s network options, ESCo/backhaul
connection settings, and for managing the ZigBee network.
6.1 Overview Page
The ESBox Overview page is the default page, and can be accessed from other pages using the
‘Overview’ button on the navigation panel on the left hand side.
This page presents a summary of the status of the ESBox, including version information for each
component of the device firmware, the local machine time, and the device’s unique ZigBee IEEE
address.
The Overview page also features a live terminal that can be used to manually send commands to the
ESBox, edit device setting files, inspect core software modules, and access debugging information.
9
The AJAX update period for the terminal and other display options are available in the terminal
settings menu, which can be accessed by clicking on the cog icon above the terminal.
This document does not provide a comprehensive set of documentation for the functionality
exposed through the ESBox’s terminal. A significant amount of terminal functionality is self-
documented, and an overview of the most common commands can be retrieved by typing ‘help’ into
the terminal, and detailed help for each command can be retrieved using the ‘<command> --help’
command.
The green text to the left of the command line entry box at the bottom of the terminal describes the
application that is currently in focus. The default application is ‘shell’, which provides a set of Unix-
style commands for navigating and modifying the file system, such as ‘cd’, ‘rm’, ‘mv’, etc. Other
applications can be brought to the foreground using the ‘show’ command.
10
6.2 Wedit –Inbuilt AJAX text editor
One of the key features built in to the ESBox web application is the in-browser AJAX based text wed
editor (wedit). Wedit can be used to modify ESBox configuration files manually, or to manually save
new update hex images to the ESBox’s non-volatile flash.
To edit a text file using wedit, enter the name of an existing or new file after the wedit command.
For example, the ESBox options file can be edited manually by typing ‘wedit .options’ while the
‘shell’ application is in focus.
When a file is opened using the wedit tool, an ‘edit’ hyperlink will be printed in the terminal that can
be used to access the wedit text editor interface.
Please the ESBox-ESCo Protocol Specification document for a complete description of the ESBox
Options listed in the .options file.
Formatting and syntax highlighting for the open file can be customised using the wedit settings
menu accessed by clicking the cog icon on the right hand side of the wedit page.
Indice
