Leviton EMB Hub Installation Manual

Page 1
EMB HubTM Data Acquisition System
WEB VERSION
Cat. No. A8810
Installation and Operation Manual
DI-005-A8810-00B
Page 2
WEB VERSION
Page 3
WEB VERSION
1 Product Application Limitation ......................................................................................................1
2 Features and Specifications ..........................................................................................................2
3 Installation Checklist .......................................................................................................................3
4 Installation ........................................................................................................................................4
5 Configuration ...................................................................................................................................7
6 EMB Hub Administration Overview ............................................................................................. 11
7 Security ..........................................................................................................................................13
8 Modbus ...........................................................................................................................................14
9 Wireless ..........................................................................................................................................22
10 Networking ...................................................................................................................................23
11 System Options ...........................................................................................................................25
12 Diagnostics ..................................................................................................................................28
13 LCD Console ................................................................................................................................29
14 Log File Data ................................................................................................................................31
15 Retrieving Data From The EMB Hub ..........................................................................................36
16 Mechanical Drawings ..................................................................................................................39
17 Warranty and Contact Infromation .............................................................................................40
Page 4
1 PRODUCT APPLICATION LIMITATION
WEB VERSION
• Leviton products are not intended for use in critical applications such as nuclear facilities, human implantable devices or life support. Leviton is not liable, in whole or in part, for any claims or damages arising from such uses.
• Leviton strongly believes in continuous improvement, therefore we must reserve the right to change specifications and product offerings without notice. Where possible, we will substitute products with equivalent functionality when necessary.
NOTICE
This product is not intended for life safety applications.
Do not install this product in hazardous or classified locations.
The installer is responsible for conformance to all applicable codes.
1
Page 5
2 FEATURES AND SPECIFICATIONS
WEB VERSION
The EMB Hub data acquisition system is designed to allow owners and managers of commercial and industrial facilities with a cost-effective means of gathering crucial information in a timely manner. To meet these requirements, the EMB Hub system provides the installer with all the tools necessary to install and configure the hardware and software with a minimum of time and investment.
Processor Arm9 embedded CPU Operating System Linux 2.6 Memory 32 MB ram, 16 MB flash LED Ethernet, ModbusTM TX/RX, power, alarm Console 2 x 16 character LCD, two pushbuttons LAN RJ45 10/100 Ethernet, full half duplex, auto polarity Protocols Modbus/RTU, Modbus/TCP, TCP/IP, PPP, HTTP/HTML, FTP, NTP,
XML, SNMP-Trap
Power Supply 24VDC, 500mA, Required (not included) The unit is to be sourced by a Class 2
power supply with the following output: 24VDC, 500 mA minimum but not to
exceed 8A. Note: only 350mA is required if the USB port is not used. Interval Recording User selectable 1-60 minutes. Default 15 minute interval. Serial Port1 RS 485 Modbus, supports up to 32 external devices (expandable) Isolation2 The RJ45 Ethernet is isolated to 1500VDC from the main board. RS485 port is isolated to 1500VDC from the main board. Power input and USB port are non isolated. Environmental Pollution Degree 2, Altitude up to 2000M. For indoor and outdoor use when used in an appropriate enclosure. The A8810 must be mounted inside a NEMA rated electrical enclosure for safety
and isolation requirements. North America: Indoor, temperature -30°-+70°C, 0-95% humidity, non condensing. EMC FCC CFR 47 Part 15, Class A EN 61000, EN 61326 Size 4.99 in x 4.25 in x 2 in (102 mm x 108 mm x 51 mm) Mass 0.42 lbs (0.19 kg)
4
1
Inputs are intended for low voltage
class 2 outputs
2
If the product is used in a manner
not specified by the manufacture, the protection provided by the equipment may be impaired.
A8810 EMB Hub
2
Page 6
3 INSTALLATION CHECKLIST
WEB VERSION
An EMB Hub system installation requires the following components: Required hardware:
• EMB Hub A8810 data acquisition server (required)
• Ethernet connection
• Ethernet Cat 5 cable (required for LAN or direct laptop to EMB Hub connection)
• Power Supply: 24VDC Optional hardware:
• Additional Modbus RTU devices power meters (e.g., Veris Enercept, PML Ion, Emon ProMon, etc)
• 2 wire, twisted pair with shield for Modbus/RS485 connection. (BeldenTM 1120A or equivalent)
• Termination resistor (120 ohm) for long RS485 runs over 200 ft. LAN information:
• Ethernet 10/100Mbit connection point (hub or switch)
• IP address and Netmask (check with system administrator)
• Gateway address (check with system administrator)
• DNS server address (check with system administrator)
• HTTP Proxy address (optional), may be required if the EMB Hub is behind a firewall
(check with system administrator)
3
3
Insulation connected to meters inside high voltage panels should have an insulation rating in excess of the
service voltage. Consult a licensed electrician and local building codes for further requirements that may apply.
3
Page 7
4 INSTALLATION
WEB VERSION
4.1 Hardware Installation
4.1.1
Unpack materials: Remove all materials from shipping box and verify all required components
are available.
4.1.2 Mount the EMB Hub on the wall, panel or other appropriate location.
4.1.3 (optional) Connect the Modbus network loop as shown in the wiring diagram. Follow the
manufacturer’s instructions for installing and powering the Modbus devices. Verify that the Modbus address settings are unique for each device (i.e., no two devices with the same address) and power up the device. Connect each device in the chain by “daisy chaining” the devices together. Observe + and - polarity on the Modbus devices. For more information about Modbus loops, please read our Modbus FAQ available at www.leviton.com.
Low voltage analog, pulse, and RS485 wiring that enters electrical panels must have a minimum insulation rating that exceeds the voltage inside the panel. In addition, other regulations may apply; consult the building codes in your area prior to installation.
The RS485 port on the A8810 does not have a built in terminator. A 120 ohm termination resistor should be placed at the ends of the RS485 loop, between the + and - wires. For more information about RS485 termination, read the Modbus FAQ at www.leviton.com
Some Modbus devices do not use the same label notation as the EMB Hub . Rather than +, -, S, Emon uses Low, High, and Gnd. To attach an Emon meter, use + to high, - to low, and shield to Gnd.
WARNING:
TO AVOID DEATH OR INJURY, after wiring the A8810, remove all scraps of wire or foil shield from the electrical panel. This could be dangerous if wire scraps come into contact with high voltage wires.
4.2 Electrical Connections
A8810
EMB Hub
4
Page 8
4 INSTALLATION
WEB VERSION
4.3 Power up and diagnostics: A power supply is not provided with the EMB Hub, therefore it is up to the
installer to provide the required 24VDC. After the power is applied, the green “Alive” light in the upper right of the Modbus should come on and the LCD display will display a series of diagnostic screens ending with the following message on the LCD display (this boot sequence may require up to 20 seconds to complete):
120
This indicates that the EMB Hub has loaded properly and is ready for configuration and connection to the network and sensors. If the “Alive” light does not come on or the LCD display does not cycle to the above screen, verify that the power cord is plugged in. If after cycling the power the unit still does not power up (or if an error message appears in the LCD display) contact technical support. After the A8810 has been powered up for a minute, the green Alive LED should blink slowly once per second during normal operation.
Alive: blinks once per second while the system is operating correctly.
Alarm: blinks to indicate a problem.
Ethernet Link/Act: On when connected to a hub or switch, off when not connected. Blinks when LAN
traffic is being sent or received.
RS485 RX/TX. The 485TX led should blink slowly once per second during normal operation. The RX led
will blink when external Modbus devices communicate with the EMB Hub.
4.4 Verify connected devices: To verify that the Modbus devices are installed and reporting correctly, use
the Modbus status utility on the EMB Hub server. To do this test, follow these steps:
4.4.1 Press and release the menu (top) button on the EMB Hub. The following will appear on
the LCD display:
4.4.2 Press the menu (top) button several more times until the LCD display shows the
following message:
4.4.3 Press the select (bottom) button on the server and the unit will begin the diagnosis of the
Modbus loop. After the check is completed, the unit will display the following message:
5
Page 9
4 INSTALLATION
WEB VERSION
4.4.4 Verify that the number of devices located by the server (the total of OK, fail and new) matches
the number of devices actually installed and connected. For a first time installation, all devices should appear as “new”. (Note: A “device” is the Modbus connected device, not necessarily
the sensor. For example, an A8332 I/O module with 8 sensors connected is only one modbus device, not eight.) For further information on the LCD console, please review the console
section of this manual.
4.4.5 The EMB Hub completes a background scan for new Modbus devices every 2-5 minutes.
Increasing the RS485 Modbus timeout may increase the time required to detect new devices. If the Modbus devices are connected after the server is booted up, the devices may not appear on the screen for several minutes. In the worst case, allow up to 5 minutes for the EMB Hub to locate all the connected devices.
4.4.6 If all devices are reporting properly, it is now time to connect the server to the network or
phone line for remote reporting and configuration.
6
Page 10
5 CONFIGURATION
WEB VERSION
5.1 Basic Network Configuration
5.1.1 Determine the IP addressing needs: The IP address of the EMB Hub server can be
implemented using one of three methods. Check with the network administrator to determine which method applies. For phone installations, use “direct connection to laptop” to allow initial configuration.
Static IP address this is a fixed IP address which is assigned by a network administrator and
configured into the EMB Hub; or
Dynamic Host Configuration Protocol (DHCP) address this process assigns an IP address
dynamically to the EMB Hub when it is connected to the network from a host DHCP server; or
Direct connection between the EMB Hub and a single temporary computer such as a laptop. (primary
connection will be dialin or dialout by modem) You will need the following information from your network administrator: The addresses will be in the form of “###.###.###.###”), where “#” refers to the numbers 0 to 9.
5.1.2 Configure the IP address as selected from the table above. For direct connection to laptop,
the address settings above are set as the factory default, and you may be able to skip to the “Laptop/Computer Setup” section if the factory default settings are present.
To begin config uration, make sure that the server displays the start screen:
If this screen does not appear on the LCD display, press and hold the menu (top) button on the
server for several seconds and the message should appear. To change the IP address to the static address assigned by the network administrator, do the following:
5.1.2.1 Press the menu (top) button once to get the TCP/IP configuration menu.
5.1.2.2 Press the select (bottom) button twice to get the IP config menu:
5.1.2.3 Press the select button again to see the IP address menu:
7
Page 11
5 CONFIGURATION
WEB VERSION
5.1.2.4 At this point, the cursor on the display will be blinking on the first number in the IP
address on the second line.
5.1.2.5 To change the number, press the menu (top) button and the display will cycle through the
digits 0 -as well as “.”. Once the correct digit is displayed, press the select (lower) button to advance to the next digit and repeat the process until all the digits are correct.
5.1.2.6 Once the IP address on the EMB Hub matches the assigned IP address, press the select
(bottom) button once more to return to the main TCP/IP menu.
5.1.3 Set the netmask, gateway, and DNS server(s) addresses as noted in the chart “Network
Address Worksheet” using the same technique as shown above. The only change is that after Step B, press the menu (top) button multiple times to see the netmask, gateway, and dns setup menu, then push the select button to set the option.
Note: If DHCP configuration is selected, the IP, netmask, gateway, and dns server addresses
will be obtained automatically. Simply select the “Enable DHCP” from the first TCP/IP configuration menu.
5.1.4 After the address information has been set, you must reboot the EMB Hub.
Select the “(Previous Menu)” option after step 5.1.2.2. The menu will then state that the EMB Hub must be rebooted to take effect. Press ‘select’ to allow the EMB Hub to reboot.
Once the EMB Hub has rebooted, the new IP address will be displayed on the console. If
DHCP addressing was specified, the server assigned address will be displayed.
Note: if DHCP is unable to obtain an IP address, the EMB Hub will use the fallback
address of 192.168.0.100
8
Page 12
5 CONFIGURATION
WEB VERSION
5.2 Laptop/Computer Setup
5.2.1 You must have a computer to access and configure the EMB Hub . This computer must have
an ethernet connection (on the LAN or by direct connection) and must have a web browser installed.
Note: If your building already has an existing LAN that the EMB Hub is attached to, you can
use an existing computer on that LAN. Check with your network administrator for details. If this option is available, use a LAN connected computer and skip to the “ EMB Hub administration overview” section below.
LAN
ethernet
Laptop
LAN Connected EMB Hub
The remainder of this section will assume the installer has brought a laptop to the site, and
will connect the laptop to the building LAN, or directly to the EMB Hub. Attach the laptop to the EMB Hub or LAN as shown.
ethernet
EMB Hub
Laptop
Ethernet Connected EMB Hub
ethernet
EMB Hub
5.2.2 Attach the laptop to the EMB Hub or to the LAN. The A8810 will automatically detect whether
a direct or crossover cable is required, and will reverse polarity accordingly. This feature will allow you to use either a straight ethernet cable or a crossover ethernet cable interchangeably.
If the laptop is to be attached to an existing LAN, obtain a static IP address (or use DHCP
addressing) from the network administrator.
9
Page 13
5 CONFIGURATION
WEB VERSION
5.3 Laptop/Computer IP Address Configuration
Configure the laptop IP address using the following steps. Note: Only Windows is detailed below, however you can use any OS/Browser you wish such as MacOS or Linux. Details on network setup for non-windows operating systems is beyond the scope of this document however.
5.3.1 From the Windows start menu, select the “Settings”, “Network Connections” option. Double
click the ‘Local Area’ network connection icon in the network folder, then click the “Properties” button.
5.3.2 In the network setup dialog, there should be a list of items including adapters, clients and
protocols. Locate the item labeled “Internet Protocol (TCP/IP)”.
Note: If you have multiple ethernet cards, you may have multiple lines labeled
“TCP/IP ----> ethernet card”. Locate the ethernet card that corresponds to the physical connection to the EMB Hub and then select the TCP/IP option that is linked with that ethernet card.
5.3.3 Double click the TCP/IP option you selected in
step 5.3.2 above. The Internet Protocol properties dialog will be shown. This page allows you to select DHCP (obtain an IP address automatically) or configure an address manually.
5.3.4 Select the option for “Use the following IP address”
as shown in the picture to the right. Set the IP and Netmask from the Laptop Address Worksheet above. It would be helpful to make note of your previous settings in this dialog so you may set them back after you are done with the EMB Hub configuration.
5.3.5 Close the TCP/IP settings dialog, and Network dialog.
10
Page 14
6 EMB HUB ADMINISTRATION OVERVIEW
WEB VERSION
The EMB Hub should now be available on the local area network for you to access using a web browser.
6.1 Use your web browser to connect to the EMB Hub by entering:
http://192.168.40.50/setup/
Where 192.168.40.50 is the IP address displayed on the on the EMB Hub LCD display.
6.2 At startup, the initial login will require the user to create a password to be used for subsequent login.
6.2.1 From the web browser interface, click on “Click here to enter”.
6.2.2 Enter the username and password.
6.3 Your web browser should now display the EMB Hub configuration menu. To the left, a list of
configuration options are available. On the right, a specific configuration page will be shown. The first page is a welcome message with some system status information. Proceed with the configuration of the EMB Hub using your web browser.
6.4 Expand the Networking option, and select setup. Verify the addresses are consistent with those in the
“Network Address Worksheet.”
6.5 Expand the Modbus option, and select “Device List.” You should see a list of each Modbus device
attached to the EMB Hub. Before the EMB Hub can begin logging data, each Modbus device must be assigned a unique name.
6.5.1 Click the device number to the left of the unconfigured Modbus device.
6.5.2 A page with the current device status and readings will be displayed. Click on the “configure”
button at the bottom of the page.
6.5.3 Enter a name for the device in the supplied field.
6.5.4 Change any low and high range alarm settings you may need. (optional)
6.5.5 Click the “Save” button at the bottom of the page to save your changes.
6.5.6 Repeat these steps for each Modbus device.
Some devices may require additional information. For example, the Veris H8238 multi circuit power meter allows the CT size to be specified. The Leviton A8332 I/O Modules have additional configuration options on each data point line to specify the details of the analog, pulse, or resistive input. These include the 4-20mA device scale, multipliers and engineering units. Each 4-20mA or 0-10Vsensor should be supplied with technical information including the low and high range values that can be used to configure the EMB Hub. Also, the EMB Hub has many common sensor types pre programmed that can be selected from a drop down list. Review the Modbus Advanced Configuration Options section of this manual for further configuration details.
11
Page 15
6 EMB HUB ADMINISTRATION OVERVIEW
WEB VERSION
6.6
Select the Modbus/Setup menu option. Specify the Modbus Loop Name. This will become the name
of the EMB Hub. This is the name that will appear on the BMO website service (if subscribed). Specify the data logging period. The default is 15 minutes.
6.7 Decide upon a method of data transfer. (see section later in this document). If you select the HTTP/
Post method to send data to the BMO website, you can configure this by selecting the “LogFileData, Setup/Upload” page.
6.7.1 Make note of the EMB Hub serial number.
6.7.2 Select upload options as needed for time of day to upload the data and retry control.
6.7.3 Check the checkbox to allow remote configuration. This will allow you to reconfigure the EMB
Hub from the BMO web site without having to connect directly to the EMB Hub
6.7.4 Specify the “Target address to upload data.” This is the website address where the EMB Hub
will send the collected data. If you have an in house data collection service, you should enter the address of your data server in this field. Leviton also provides a service called Building Manager Online that can collect and report data for you. If you are using the BMO service, the target address to upload data should be set to http://www.buildingmanageronline.com/upload.php
6.7.5 When configuring the EMB Hub to send data to the BMO site or your own data collection
server, the EMB Hub will authenticate itself with the server by using the serial number and a password. This password must be supplied here, and can be obtained when you sub scribe for the BMO service, or by your database administrator.
6.7.6 Click “Apply” to save your changes.
If you select a manual transfer method, remove (blank out) the target address in the Modbus/Upload Data page.
12
Page 16
7 SECURITY
WEB VERSION
The EMB Hub has three levels of security. These are “operator”, “user” and “admin”. When using a browser to access the EMB Hub , basic http authentication is used to prompt your browser for a username and password. The admin account uses “admin” as the default password. To change the password, select the Accounts menu from the left side tree display. Next, select the account name. Click the “Change Password” button to set a new password for the selected account.
admin: This account has full access to modify any of the system settings. The default password is “admin”.
operator: This account may view settings, however may only change Modbus alarm ranges and device.
user: This account can view some system settings including the Modbus device status pages and
can change.
When using FTP to access the EMB Hub , you may use the admin account username/password for read only access. Log information is stored in /var/log/modbus. For read write delete access, use the login name “root” and the admin password.
The three usernames specified are not able to be changed or renamed, nor can arbitrary usernames be added to the EMB Hub. Access is only controlled by setting the password for the three existing usernames noted.
The “operator” and “user” accounts are disabled by default. These accounts are activated when you first set a password for each.
13
Page 17
8 MODBUS
WEB VERSION
8.1 Modbus Device List
The EMB Hub automatically searches for Modbus devices on the RS485 serial loop. The Modbus Device List page will show a listing of all the currently detected or configured devices the EMB Hub has found. The device list will show the Modbus address number, status (OK, Error, Alarm, Unconfigured), the device name (user specified) and the device identification string.
Click on the Modbus address number for any of the devices for specific device details
Note: not all Modbus devices have built in driver support in the EMB Hub. If a device appears in the list with “Unknown” in the status column, you may need to upgrade the firmware on the EMB Hub to access the device. At the bottom of the device list page under the Type column, a link is shown that will show all the Modbus devices with built in driver support provided in the firmware. Use the System/Firmware update page to check for newer versions of the firmware. The leviton.com website FAQ also has a list of supported Modbus devices. Modbus devices that are not supported by built in drivers may be configured using the Modbus Framework feature in the EMB Hub.
At the bottom of the device list, there is an option to allow you to rename all the devices listed. This is useful for initial deployments. There is also a troubleshooting link that will look for common configuration problems and alert you to the appropriate solution.
14
Page 18
8 MODBUS
WEB VERSION
8.2 Device List Options
At the top of the Modbus device list page, there are several display options that control the sorting of the device list.
Tree display: click this icon to organize the list by showing each ModHopper®, and the devices
attached to each one.
List display: (default) show the list of Modbus devices sorted by the Modbus address number.
At the bottom of the Modbus device list, there are several options that may be selected to view or configure all the Modbus devices at the same time. These options are as follows:
Add: Manually add a Modbus device to the device list. This option can be used to configure a Modbus device that is not presently connected to the system, add a framework configured device, or add a Modbus/ TCP connected device. See the section on manually adding a device below.
Troubleshoot:
Rename all devices: This option allows you to edit all the device names in one configuration page.
This is useful when initially configuring a large number of new devices. A name must be assigned to a device before the EMB Hub will log data for it.
List all supported devices: This option will show a list of all Modbus devices with built in drivers in the installed firmware.
Show [setup]: Display links for Device configuration and Advanced configuration for each device.
Show [devinfo]: Display the communications options including baud rate, serial number and firmware
version (when available) for all devices in the Modbus device list.
Show [stats]: show packet counters for all devices in the device list. These include
Sent: Total number of packets sent to this Modbus
Received: Total number of valid packets received from this Modbus address.
Error: Total number of packets received that fail CRC for this device. (does not include non
response queries)
RTT: The average round trip time for the last 7-10 packets that received a valid response. This value
is useful in configuring the Modbus timeout in the ModbusSetup/RS485 page. Note: if the timeout is
set too short, you will not see an accurate value because packets dropped for timeout are not counted
for RTT.
The EMB Hub will review the devices connected and offer suggestions about any problems found.
XML: Display the device list data in XML
Notes on RTT and Timeout configuration:
To best measure the true RTT, set the ModbusSetup/RS485 timeout to the maximum period and allow the EMB Hub to run for 5 or 10 minutes. Next, review the RTT values seen in the device list page and make note of the longest RTT time shown for any device. Last, configure the ModbusSet up/RS485 timeout to the option that is the next largest than the longest time seen for any device. For example if the worst RTT is 600ms, set the timeout to 1 second.
Typical RTT values for direct connected devices should range between 40ms and 200ms. Systems that have wireless links such as ModHoppers should expect an additional delay of 500ms per hop. A complex system with multiple ModHoppers may have RTT values upwards of 3 seconds.
15
Page 19
8 MODBUS
WEB VERSION
8.3 Device Details
The device detail page will show a list of all the meter data points, alarm settings and console options. The data point names for most devices are automatically entered. Some devices such as the A8332-8F2D I/O module have generic inputs, and will be labeled as “Input #1”. At the top of the page, the status of the device is shown. This usually reports “ok” however it can include error information if the device is not responding properly. A list of device errors is available in the log file details section of this manual. At the bottom of the page, several buttons are present.
Done: Returns you to the device list.
Log File: This icon will display a table view of the most recent data in the current log file. Use the log file
export page for complete log data access.
XML: This icon will show the current data from the Modbus device in an XML format. The URL from this icon can be copied and used to gather xml data for client side Javascript or Java applications.
Configure: This button will allow you to change the device parameters such as the alarm and console settings.
16
Page 20
8 MODBUS
WEB VERSION
8.4 Device Configuration
When the “configure” button is clicked from the device details page, the screen will be refreshed, with the same information, however the device name, alarm settings and console checkbox will be available.
Device Name: This field allows you to specify a name for the device such as “main building power” or other useful name to indicate the location or function of the device. A name must be assigned to a device before the EMB Hub will log data for it.
Low Alarm, High Alarm: Specify a threshold for the alarm. If the data point is recorded below the Low Alarm, or above the High Alarm levels at the time a log entry is taken, the point will be considered in an alarm state.
Console: Checking this checkbox will cause the EMB Hub to display this data point on the LCD console. Multiple data points are rotated about every 10 seconds. The values on the LCD console are updated when the next log interval occurs.
Point Config: Some devices have configurable point features. The A8332 I/O module has 8 flexible (Analog, Pulse, and Resistive) inputs that require additional configuration as detailed in the next section. The H663/704 BCM product only requires the circuit breaker name in this menu. Most data points are automatically configured and this option may not be displayed.
Advanced: At the lower right corner of the page, an advanced configuration button may be present depending on the Modbus device features.
17
Page 21
8 MODBUS
WEB VERSION
8.5 Advanced Configuration Options
The advanced configuration page contains special options specific to the device you are configuring. For the A8332 I/O module, you may specify the pulse rate speed that the pulse inputs will work at, review the 4-20mA/0-10v input status, as well as selecting the proper curve scaling for a resistive output device. On power meters, the CT size and orientation options may be present. The device serial number and other specific parameters will be displayed if available.
Specific options available in the Advanced Configuration page vary depending on the features available in the Modbus Device, as well as the features implemented in the built-in EMB Hub driver.
8.6 Manual Device Add Options
Modbus devices may be added manually by clicking on the “add” link on the bottom of the modbus device list page. This option is intended for use when adding devices to the configuration profile prior to installing the physical hardware, or configuring Modbus/TCP devices that will automatically populate in the Modbus device list.
The manual setup page has several options that must be configured before the EMB Hub will recognize the Modbus device. The options are as follows:
Modbus Address: The Modbus device address must be supplied. Note: when configuring a device on a remote Modbus/TCP gateway, the Modbus address of the remote device must not be the same as any address on the local RS485 loop.
Modbus/TCP Gateway IP: This option allows the EMB Hub to log data from a remote Modbus device that is attached to the LAN via a Modbus TCP gateway device such as an EGX or Moxa gateway. For local Modbus devices attached to the EMB Hub RS485 port, use “127.0.0.1”
Modbus/TCP Gateway Port: If a remote Modbus/TCP gateway is used, the TCP port of the remote gateway must be specified. The default TCP port is 502 on most gateways. For local Modbus devices attached to the EMB Hub RS485 port, use 502.
Device Name: You must provide a name for the Modbus device to identify it in the device list. This should be something that will identify the meter location and purpose.
Device Type: This menu will allow the selection of any built in driver or any Modbus Framework template that is available on the EMB Hub. It is important to select the driver or template that matches the Modbus device.
18
Page 22
8 MODBUS
WEB VERSION
8.7 Troubleshooting Modbus Devices
If the device you have attached does not appear in the Modbus device list, check the following:
• Verify the + (red), - (black), and Shield connections are correct on all connections. Look for any
connection in the middle of the loop that may have the wires reversed, or shorted together. Check the Modbus FAQs on the leviton.com website for further details on wiring a Modbus serial connection.
• Verify the address settings of every Modbus device. No two devices may have the same address.
• If only one device is not working, try disconnecting all the other devices on the Modbus loop to isolate
the problem. If possible, bring the failed device adjacent to the EMB Hub and attach it with a short stub of wire to eliminate possible wiring problems. If the EMB Hub can find a device on the short stub, the problem is probably a wiring related issue on the RS485 loop.
• Check to verify the Modbus device is supported by the EMB Hub . Usually, the EMB Hub will locate the
device and print “Unknown” in the device status column if the device is not recognized by the EMB Hub firmware drivers. In the lower right corner of this screen, there is a link that will show a list of supported devices. Use this to verify the Modbus device in question is supported by the EMB Hub firmware version. If not, check for firmware upgrades online with the Firmware Update configuration page.
• Remember, the EMB Hub may take between 2 and 5 minutes to detect a new device that has been
attached to the Modbus RS485 loop. Rebooting the EMB Hub, refreshing the device list page, or using the console “Modbus status” menu will not speed up the recognition process.
• Click the “Troubleshooting” link at the bottom of the Modbus device list page for further diagnostics.
8.8 Modbus Setup
The Modbus setup page provides several options related to the Modbus RS485 serial port.
EMB Hub Name: This is the name of the EMB Hub. This name will be present on all log file descriptors when uploaded to a central database website such as BMO. It is helpful to name th e EMB Hub based on the physical location of the system, or building. Note: this feature was labeled “Loop Name” in older firmware versions.
Data logging period: This option sets the log interval for the EMB Hub. Options range from once per minute to once per hour. All of the selections are even divisions of one hour. The EMB Hub calculates the next log time by finding the next multiple of the log period past the start of the hour. For example, if the log period is 15 minutes, log readings will be taken at 0, 15, 30 and 45 minutes past the hour. The log period is not calculated based on “15 minutes after the last reading”.
When the EMB Hub is first started, it will take an initial reading of all the Modbus devices immediately. Following that, the next log reading will be calculated as a multiple of the log period after the hour. The initial reading is taken to allow the EMB Hub to gather information for meters that require demand calculations, as well as provide accurate information starting when the EMB Hub is booted.
Modbus/TCP access: The EMB Hub has a Modbus TCP gateway feature that allows other systems to send queries to all attached Modbus RS485 devices. This feature allows control of what systems have access to the Modbus TCP gateway feature. The settings include “no access”, “local subnet only” and “allow any”. This basic security feature only allows control based on the IP address of the system making the request. The Modbus TCP protocol does not have provisions for any authentication passw ord or other methods of security. By default, the gateway feature is disabled, and set to “No Access.”.
19
Page 23
8 MODBUS
WEB VERSION
The Modbus TCP gateway is a feature that allows the EMB Hub to share the attached Modbus RS485 devices with other systems such as PCs with software and building control systems. The gateway receives incoming TCP requests, verifies the length of the packet does not exceed 255 bytes, and forwards the packet to the Modbus RS485 loop. The gateway does not verify the contents of the packet, nor the target add ress specified in the request. If the Modbus RS485 device sends a valid response back, the gateway will return this information to the the system requesting it via TCP. If no response is received, a timeout failure will be sent to the requester. Because the gateway does not process the contents of the request or reply, it is possible to query devices on the Modbus RS485 loop that are not specifically supported by the EMB Hub. A Modbus/TCP technical guide may be available soon at www.leviton.com.
Modbus RS/485 baud rate: This feature allows the configuration of the RS485 serial port speed which the EMB Hub uses to communicate with Modbus devices. Options include 9600, 19200, 38400, 57600, and
115200. The default is 9600, most Modbus devices communicate at this speed as well. Multiple baud rates may be selected in this menu. If multiple rates are selected, the EMB Hub will automatically detect the baud rate of each Modbus device from the chosen options. Once the baud rate has been detected for a specific Modbus device address, and will continue to communicate with that specific device address at the detected speed. This feature will allow you to mix multiple devices on the same RS485 loop with different baud rates. Modbus devices default to a baud rate of 9600. Note: Modbus device manufacturers usually do not ‘officially’ support this configuration, however we have not seen any problems with this in any of the Modbus devices we provide drivers for. Most Modbus devices simply ignore packets received at the wrong baud rate. If you are experiencing Modbus communications problems, you should set the baud rate to a fixed 9600 before troubleshooting.
Modbus RS485 Parity: This feature allows alternate parity options to be set. Default is no parity.
Modbus RS485 Stopbit: This feature allows alternate stop bit options to be set. Default is one stop bit.
Modbus RS485 timeout: This feature sets the period of time the EMB Hub will wait for a response from
any device on the Modbus RS485 serial loop. The default of 200ms is long enough for most Modbus devices. Longer timeouts may be required if you have a very slow device, or if you have a Modbus repeater device in the serial loop. Devices such as the ModHopper, the Veris H8936 Local Display, or any RS485 wireless link repeaters add a substantial delay. Setting the delay longer than the default will increase the time required to auto detect new Modbus devices when attached to the EMB Hub. For ModHopper con nections, use a minimum setting of 1.5 seconds. The allowed range is 100ms to 5 seconds.
Tip: Set the timeout to the longest available setting, and use the “stats” option on the bottom right of the device list page to monitor the actual RTT (response time) for each device. Next, decrease the RS485 Timeout that is close to (but longer than) the slowest device in the device list.
Modbus RS485 Debug: This feature records Modbus RS485 transaction data in the system debug log file. You must click the “start log” button on the system/log files page to record this information. Debug options are as follows:
• None: No RS485 information is logged.
• Errors: Only Modbus errors are logged.
• Transaction: One line is logged describing every RS485 query, and the result of that query.
• Full Debug: Complete listing of all queries including hex dumps of all data sent/received.
20
Page 24
8 MODBUS
WEB VERSION
Search for Modbus RS485 Devices: This option allows the EMB Hub to search for Modbus devices attached on the RS/485 port. This feature may be disab led to reduce queries on the RS/485 port. Default is enabled.
Search for Sensor Network Devices: This option will allow the EMB Hub to search for sensor network enabled ModHoppers (R9120-3SN), and log data from attached devices. Note: this is for sensor network devices such as PointSix and Badger receivers, and not Modbus or Pulse devices. Default is disabled.
8.9 Alarm Setup
The Modbus Alarms section provides the ability to send messages when alarm levels are exceeded. Messages can be sent by email, SNMP or displayed on the LCD console. Alarms are processed at the end of the data logging period. For more frequent alarms, shorten the data log interval. Log readings and alarm processing can be set to as often as once per minute.
Display all alarms on LCD console: When checked, all alarm messages are shown on the LCD display of the EMB Hub.
SNMP Trap Send Enabled: When checked, SNMP Trap messages are sent after every log period for each data point that is in an alarm state. The trap includes information about the EMB Hub system data point, and alarm state. A full MIB is located on the EMB Hub , click the MIB link to the right of this option.
SNMP Trap Host 1 (2,3): When SNMP traps are enabled, a trap message is sent to each of the trap host addresses. Specify the trap host by IP address, not DNS name.
Direct email on alarm. When checked, the EMB Hub will send an email message when any data point changes its alarm state.
SMTP Mail Server Address: The ip address of the email server on the LAN that will process and forward the email message to the recipient.
Sender Address: The address that will be used in the “From:” line of the email. This is helpful in identifying the source of the alarm email message. If your SMTP mail server has junk filtering, you may be required to use a sender address that matches a mailbox address on the SMTP mail server; check with your mail server administrator for specific details on this issue.
Recipient address 1 (2,3): The EMB Hub can send a copy of the alarm notice to multiple email addresses. Specify one, two or three email addresses in the fields provided for the recipient addresses.
8.10 Modbus Framework
The Modbus Framework feature is a tool to allow the EMB Hub to read data from any Modbus device by creating a template in the Modbus Framework editor. The template describes the Modbus register read commands, and the conversion required for each data point that is to be read. The Framework feature is an advanced feature of the EMB Hub that requires the user to be familiar with the Modbus protocol and with the Modbus register point list for the specific Modbus device that will be used. For more information on the Modbus Framework feature, download the Modbus Framework documentation from www.leviton.com.
21
Page 25
9 WIRELESS
WEB VERSION
9.1 Sensor List
The sensor list feature works in conjunction with a number of non Modbus sensors. Sensor devices such as PointSix, BAPI, and Badger/Orion typically transmit data on a preset interval and are not polled by the EMB Hub. Data is received and uniquely identified by the sensor’s serial number. Each sensor may be given a name, and some have additional options to configure such as input value scaling.
9.2 ModHopper Map
The EMB Hub has additional diagnostic features th at assist with ModHopper deployments. The most useful is the ModHopper route map. Select the ModHoppers menu from the Wireless section in the EMB Hub menu tree as shown below.
The graph will draw a blue box for each ModHopper that is attached to the system. The blue number inside the box icon is the Modbus address of the ModHopper. To the side of each icon, three lines of information will be shown.
• The device list name will be shown to the side of each ModHopper icon.
• The link quality, hops and round trip time (rtt) will be printed under the ModHopper name.
• A list of attached Modbus device addresses will be shown on the third line. This is a list of addresses
that the ModHopper has automatically detected on the local RS485 port.
The graph will print strong links in thick green lines. Lines progress from green, to yellow, to red to indicate weak links.
22
Page 26
10 NETWORKING
WEB VERSION
10.1 Network Status
This page displays the current status of the EMB Hub network connections. Several interfaces may be shown if both Ethernet and ppp dialin/dialout are active at the same time. Each interface will report the IP address, number of packets sent and received, and other details specific to the interface. For the ethernet interface, the MAC address (HWaddr) will be shown as well as a network collision count.
Note: the “lo” or Loopback interface is the internal network and is always present, “eth0” is the Ethernet segment, and “ppp0” is the dialout or dialin connection. In addition, the current gateway and DNS server information will be shown. These items will provide information about DHCP assigned configuration information.
10.2 Ethernet setup
The ethernet setup page has the following options:
• IP Address: The IP address of the ethernet interface: Default 192.168.40.50
• Netmask: The netmask of the ethernet network. Default 255.255.255.0
• Gateway Address: The gateway is the routing device that moves traffic from the LAN to the internet.
The default is 192.168.40.1. If you do not have an internet connection for your LAN, or you are using a crossover ethernet cable, leave this field blank.
• DNS1, DNS2: These are the primary and secondary DNS servers. If you are using a dialout connection,
these must be set to the DNS server provided by your dialup isp. If you only use the EMB Hub on a crossover cable and /or dialin mode, you should leave these blank.
• DHCP (enable/disable) If you LAN has a DHCP server, you may enable this option and remove the
previous options for IP, netmask, gateway, and DNS. Check with your LAN administrator first.
• HTTP Proxy. If your LAN is connected to the internet using a sophisticated firewall, you may need to use
the HTTP proxy feature. Check with your LAN administrator first, however if you don’t have a proxy set on your computer then you most likely don’t need to configure the EMB Hub to use a proxy. If in doubt, leave this blank first, and try the connection test. If it fails, ask your LAN administrator about proxy servers, if any.
After changing any of the settings on this page, you will be required to reboot the EMB Hub Use the system/status web configuration page, or the LCD console to reboot the EMB Hub.
23
Page 27
10 NETWORKING
WEB VERSION
10.3 Troubleshooting Ethernet Problems
After reconfiguring the ethernet settings you experience problems accessing the EMB Hub with your web browser, check the following items.
• Verify that you rebooted the EMB Hub after making the changes to the network settings.
• Use the EMB Hub LCD console. Check the IP address and Netmask. Verify these are correct.
• Verify the ethernet link/act light next to the Ethernet port is on. It should blink with activity.
• Verify the network connection in your computer has the proper IP address, on the same subnet, to
access the EMB Hub. NOTE: one common mistake is configuring the Laptop IP to the same address as the IP address of the EMB Hub. In order for the laptop and EMB Hub to communicate, the IP addresses should not be identical. (See the basic network config for suggested IP addresses.)
• Use the LCD console to run the Network Status test. This will attempt a number of things including a
ping query to the gateway address. If the EMB Hub can ping an external machine such as a gateway, the ethernet port is most likely connected properly. If the EMB Hub does not use a gateway, try adding a gateway address, and make it the address of your computer.
24
Page 28
11 SYSTEM OPTIONS
WEB VERSION
11.1 Status
The system status page shows the current memory and flash disk utilization values, system up time, and load average. Also included on this page are two buttons for Reboot and Shutdown. It is important to use the shutdown option prior to removing power from the EMB Hub. The LCD console will report the reboot or shutdown status.
11.2 Processess
The system process table is shown in both tree and tabular formats. The process list is useful when contacting Leviton technical support.
11.3 Date and Time
The EMB Hub keeps time using UTC or Universal time. All log files are recorded in UTC time as well. Timestamps shown on the EMB Hub local configuration pages are converted to local time for the convenience of the installer. The date/time configuration page provides the following options:
Date/time in UTC and Local time.
Date/time dropdown menus to select the current (local) time manually.
Timezone: a drop down list of the supported zones.
Time sync protocol: Select NTP or Rdate. Most Linux/Unix systems provide rdate, however many provide
NTP as well. Windows domain servers can also provide NTP. If possible use NTP as it is a more robust protocol.
Time Server: Specify the DNS name or IP address of your time server. The default “time.leviton.com” can be used if the EMB Hub has a connection to the Internet. The EMB Hub will attempt to synchronize time with the time server every time an upload session. This will ensure that the clock is checked and adjusted at a minimum of once per day. Typically, the synchronization will align the clock to within +/-1 second of the internet time source or atomic clock. You may need to verify if your firewall will allow NTP or Rdate packets to pass through. Generally, it is better to use a local time server if possible. The time server time.leviton.com supports both NTP and Rdate time protocols. If you use a GSM connected system, you will probably need to use Rdate. NTP is blocked by many cellular service carriers.
11.4 Universal Time
Log data is stored in UTC time. This allows data collection services such as BMO to collect data from multiple sites in different time zones. If you are operating your own database system to store log data from the EMB Hub, it is best to store the data in UTC time in the database as well, and only convert it to local time when generating the final report or graph for the user.
25
Page 29
11 SYSTEM OPTIONS
WEB VERSION
If you store data in local time, you will have the following issues.
1. Local time is relative. Is Local the time where the EMB Hub exists, or local to where the data is stored?
If local to the EMB Hub , you must shift each EMB Hub data set depending on its location.
2. There are about 11 time zones in the US. Some observe DST, others do not. These include Alaska, the
Aleutians, Arizona, Central, Eastern, Hawaii, Indiana, Michigan, Mountain, Pacific, and Samoa.
3. When converting to local time, there will be one hour of overlapping data in the fall when the time is
adjusted for Daylight Savings time, ie, log entries run 12:45, 1:00, 1:15, 1:30, 1:45, 1:00, 1:15, 1:30, 1:45, 2:00am. This will prevent you from sorting your data by time in your database.
4. In the spring, you will have a gap in the data from 1:59 to 3:00am. This can cause problems if you are
calculating demand values based on consumption.
5. Converting local time to any other timezone usually involves converting it to UTC first.
Using UTC time solves these problems elegantly. The best practice is to store data in the database in UTC format and then convert the information when generating a report for the user. For example, if you wish to draw a graph of KW over Time, prompt the user for a date range, i.e., Jan 1 midnight to Jan 2 midnight. Take the user specified end points and convert these times from local time to UTC. Next, create an SQL query using the new UTC formatted data as your select statement. i.e.,:
SELECT * from TABLE where time > ‘2003-01-01 08:00:00’ and time < ‘2003-01-02 08:00:00’
Note the time is 8 hours ahead of local time. This example is for Pacific which is 8 hours off from UTC. This will return a list of data points between the two specified time ranges. Next, plot the data on a graph, using the UTC times for start and end points. Finally, when drawing the ‘time’ legend on the graph, convert the values back to Local time before displaying. i.e., 2003-01-01 00:00:00 to 2003-01-02 00:00:00. Any division lines on the time axis can be handled the same way. The advantage of using this technique is that it will properly draw a graph across DST change boundaries. The graph axis is based on UTC time with no DST, and will not show a gap or overlap a the time of the change. The axis labeling will be correct as well, matching the UTC times precisely.
Another way to handle the conversion is to query and convert all the returned timestamps to local time before drawing the graph. This is useful if you do not have detailed control over the graph legend drawing process. This technique will not properly graph across DST changes as the graph is based on local time including DST changes.
11.5 System logs
The EMB Hub can keep several log files that report the general operation of the system, not related to the normal data logs. These include the following:
Debug Messages: the EMB Hub can run a “syslog” process to record more detailed information about its operations, however this log consumes vast quantities of memory quickly, and is disabled by default. Click the “start log” button to enable the feature. Click the “end log” button to disable. Note: when the EMB Hub is rebooted, the debug log will be disabled on startup.
Kernel Boot log: startup messages about the Linux operating system startup. This log shows what hardware items were detected and initialized.
26
Page 30
11 SYSTEM OPTIONS
WEB VERSION
Ftp Connection log: This log shows a list of files transferred by FTP on the EMB Hub.
Last Data Upload log: This log file contains a report from the last data upload attempt to remote database/
webservers such as BMO. This log will show if any log files are being rejected by the dabase/webserver, or if the network is not allowing a connection.
Last Modem Connection log: This log file shows the details of the modem operation including modem connection quality parameters. This is updated ever time the modem makes a dial in or dial out connection.
Time Change Log: This log contains a list of time change events. When the EMB Hub system clock is changed either manually or by automated time sync, and the change is more than a few seconds, the event is recorded here.
System boot log: This log shows when the EMB Hub was started, and lists process events such as remote logins, or logger process restarts. This log is most useful for detecting when the EMB Hub was restarted, and whether there was a proper shutdown event prior to rebooting (if not, possibly a power outage).
Start/End logging: This button allows the user to start detailed logging or disable it if it is running.
Purge Log Files: This button will clear all the system log files listed on this page, but not the meter data log
files. (deletes kernel, boot, FTP, messages, upload log files) This does not clear the interval log data from attached meter devices.
11.6 Firmware Update
The EMB Hub can upgrade its own firmware using the firmware update page. The EMB Hub must have an Internet connection to communicate with the leviton.com website for firmware updates. If a LAN connection is present and configured, it will be used by default.
After clicking the “Check for updates” button, the EMB Hub will contact the webserver and attempt to down load a list of firmware files. The list is compared to the firmware versions installed, and a listing of the files will be displayed. If any firmware updates are available, a button to the right will be shown labled “Upgrade”. The firmware files are as follows:
asarm.cramfs
usrarm.cramfs
ramdisk.gz
zImage
When clicking on the Upgrade button, the EMB Hub will again contact the webserver and download the requested firmware image file. The EMB Hub will take a few seconds to verify the file checksum and prompt you with an “Install” button. Click the install button and the EMB Hub will install the firmware update and reboot itself to make the changes take effect.
The main EMB Hub firmware file including the modbus and data logging software.
High level system support files such as FTP, and timezone information.
Low level system files and system libraries.
The Linux operating system.
Do not power down the EMB Hub during any step of the EMB Hub firmware update process. Doing so may corrupt the system and render the EMB Hub unusable.
27
Page 31
12 DIAGNOSTICS
WEB VERSION
12.1 Host Lookup
The Host Lookup page provides the ability to do some basic network tests. These are as follows:
Ping: send an echo request to the specified
Traceroute: Send an echo request to the target address and attempt to locate every router in between the
EMB Hub and that address.
Nslookup: convert the DNS name to an IP address, useful for testing the functionality of the DNS server configured in the Network/Setup webpage.
To run a network test, enter the IP address or DNS name in the field provided, check the checkbox next to the test you wish to use, and click the OK button. Multiple tests can be specified.
12.2 Connection Test
The connection test page will attempt to establish an HTTP session with the specified upload server. Click the “begin test” to start this process. Information will be printed in black. Success responses will be printed in green, failure messages will be printed in red. A sample upload test follows:
Note: in the last section where SUCCESS is indicated. The failure is due to the password not being correct.
28
Page 32
13 LCD CONSOLE
WEB VERSION
The EMB Hub has an LCD console and two push buttons labeled “menu” and “select”. These can be used to configure some of the basic features of the EMB Hub. The intended purpose of the console is to configure the EMB Hub to a point where a computer can communicate with it for further detailed configuration.
When the EMB Hub is running, it will show “EMB Hub Ready” and the current time alternated with the ethernet IP address. If you choose to enable the console display of data points, the LCD will also show the selected point names and current reading values. The display will change to the next listed item about once every 10 seconds. If a data point name is longer than will fit on the 16 character wide display, it will be scrolled. Pressing the select button will cause the display to change to the next configured item. Pressing the select button quickly will skip through multiple display points.
Pressing the Menu button will cause the main menu to appear. Once [Main Menu] is shown on the console, the menu button will change the menu option, and the select button will take action on the currently displayed option. Some options provide sub menus, others allow you to edit the option value. The following is a tree display of the main menu and sub menus.
The TCP/IP sub menu will allow you to configure the ethernet settings for the EMB Hub. To edit the IP settings, use the menu button to change options, and press the select button to edit the option. Once selected, you will see the curent value displayed and a blinking square cursor on the first character. Press the menu button to change the character or digit. Press the select button to use the digit and move the cursor to the right one space. If you press the select button multiple times, the cursor will move right a similar number of spaces, allowing you to skip over characters that may be correct based on the previous settings. When you are finished entering the IP address, select a blank space with the menu button, and press select. Any characters still remaining to the right of the cursor will be eliminated. (i.e., if changing
128.193.100.200 to 10.0.0.1, the new IP address will be several digits shorter than the old one.
29
Page 33
13 LCD CONSOLE
WEB VERSION
Network Status: This option will test the ethernet connection by attempting to ping the following addresses: localhost, ethernet IP address, gateway, DNS1, DNS2. The localhost ping will verify the kernel IP stack is properly initialized. The ethernet ping will verify the ethernet card’s IP address is set and communicating with the kernel. The ethernet ping test does not send any packets over the ethernet cable however. The gateway ping test will verify that the gateway address responds to queries. This test is the first one that actually sends packets over the ethernet wire. The gateway test does not verify the IP address of the gateway is correct, or that the gateway is working correctly, it only tests that the address specifed as a gateway responds to a ping request. The DNS1 and DNS2 ping tests verify the IP addresses listed for DNS servers respond to ping requests. This test does not verify if the DNS servers can actually resolve DNS names to IP addresses.
For a more complete test, use the connection test web page in the EMB Hub diagnostics menu.
Modbus Status: This option will report the number of devices currently detected by the EMB Hub. The display will show a device count for “Devices OK”, “New”, and “Failed”. These are as follows:
Devices OK: The number of Modbus devices that are presently working, and have been configured.
New: Devices that the EMB Hub supports, and are working, but have not yet been given a name.
Failed: The number of modbus devices that either stopped responding, or are not supported by the
EMB Hub.
Note: selecting the modbus status option from the EMB Hub console does not cause the EMB Hub to search for new devices. The EMB Hub checks for new devices in the background all the time, taking about
2.5 minutes to complete each pass through all 255 possible addresses. The modbus test console option simply displays the number of devices the EMB Hub presently knows about.
Upload Data Now: If the EMB Hub is configured to upload data using HTTP/POST to a webserver/database such as BMO,this option will cause the EMB Hub to upload all stored data immediately.
Reboot: This option will reboot the EMB Hub.
Shutdown: This option will stop the data logging processes and secure the flash memory. When secured,
the console will state that the power may be disconnected. It is important to shut down the EMB Hub cleanly prior to disconnecting the power from the device.
The EMB Hub has an advanced menu that can be used to perform system checks and clear all configuration options to the default settings. To access the advanced menu, wait until the LCD shows “EMB Hub Ready” and press both the Menu and Select buttons at the same time. Hold both down together for about 10 seconds. When the advanced menu is displayed, you may release the two buttons. The following is a tree display of the advanced menu.
The Check Flash Disk option will force the EMB Hub to check the entire flash disk for file system integrity. This will require you to reboot the EMB Hub.
The Enable Console feature will provide a shell prompt on the serial port for remote diagnostics. This is intended to be used by Leviton technical support only.
The Reset Configuration option will remove all the user settings, data, and passwords that have been configured and will return the EMB Hub to the factory default settings. This is mainly useful when reconfiguring an EMB Hub that has been used previously on a different job or project.
30
Page 34
14 LOG FILE DATA
WEB VERSION
The EMB Hub stores data from the modbus devices in text (.csv) log files. One log file is created for each modbus device on the system. On a daily basis, the log files are “rotated”, that is, the current log file is renamed and compressed with gzip compression, and a new log file is started. This allows the EMB Hub to make efficient use of the flash memory. When the storage capacity is beyond 95% full, the oldest log file will be removed from the system.
14.1 Log File Status
The EMB Hub can display a list of log files in the “log file data/status” web configuration page. A bar graph will show the amount of storage capacity that is used by the existing log data. Below, a list of modbus device log file will be displayed along with the file size and timestamp when the file was last modified.
Each modbus device may have multiple log files. The log file name starts with “mb-xxx.” where xxx is the modbus device id number. One file, with the .log extension is the file where the most recent data is being stored. Other log files have a .gz extension. These are older log data files that have been compressed to save space.
The file name will be a link that will open up a browser window to view the contents of the single log file. Clicking on the single log file will only show the contents of that log file, and not all historical data for the device. Use the log export feature if all log data is required.
14.2 Log File Format
Once you have downloaded the data from the EMB Hub , you will need to process it. The file is an ASCII text file with comma delimited data. One line is recorded for each log cycle. The file will look something like the following example from a 4A4P-M I/O Module. ‘2019-01-31 18:30:00’,0,0,0,-0.00,89.29,39.05,49.11,0,0,0,0
‘2019-01-31 18:35:00’,0,0,0x02,-0.01,104.24,39.05,49.11,0,0,0,0 ‘2019-01-31 18:40:00’,0,0,0,,87.82,39.05,49.11,0,0,0,0 ‘2019 01-31 18:45:00’,139,,,,,,,,,,
In this example, the first line shows a regular log entry. The second line shows a high range alarm for data point 2. The third column shows point 1 as invalid, and the fourth line shows the Modbus device is not responding.
Notice the following columns are shown.
1. Date/Time in UTC (GMT) time. This field is quoted to handle the space in the middle.
The format is YYYY-MM-DD HH-MM-SS
2. Modbus error (if any). 0=no error, see table be low.
3. Low Range alarm bitmap (hex notation).
4. High Range alarm bitmap (hex notation)
5. Data point 1
6. Data point 2
7. - - -
8. Data point N
31
Page 35
14 LOG FILE DATA
WEB VERSION
Comments:
Date/Time: The date/time column reports the time at which data was logged from the Modbus device.
Note: this is not necessarily the time at the start of the log cycle. Users with large number of devices may notice some of the Modbus devices at higher address numbers report 1 or 2 seconds after the first Modbus devices. This is because the 9600 baud speed of the Modbus loop is not fast enough to log all Modbus devices in less than 1 second. If a device does not respond during a log cycle, the EMB Hub will attempt to query the device several more times. If a subsequent query is successful, the time of the successful query will be used in the log file but may be several seconds after the initial log cycle.
The log date/time is in Universal time. (UTC) This means that the data is logged with no shift for daylight savings time, and must be converted to local time for reporting purposes. When importing into a database, data should be kept in UTC time for ease of use. When reporting the final data, you should adjust the time to reflect the local timezone for which you are reporting. The data export option on the BMO website will pro mpt you for a time zone when you export the data, and will adjust the log date/time accordingly. Note: UTC is sometimes referred to as GMT. (Greenwich Mean Time).
Modbus Error: If the error value is not 0, the remainder of the columns for this line will be reported as NULL.
1 Operation not permitted
2 No such file or directory
3 No such process
4 Interrupted system call
5 Input/output error
6 No such device or address
9 Bad file descriptor
11 Resource temporarily unavailable
12 Cannot allocate memory
13 Permission denied
16 Device or resource busy
19 No such device
23 Too many open files in system
24 Too many open files
26 Text file busy
28 No space left on device
32 Broken pipe
52 Invalid Exchange
101 Network is unreachable
110 Connection timed out
111 Connection refused
113 No route to host
129 Illegal Function (function was not allowed by the slave device)
130 Illegal Data Address (the data address is not allowed by the slave device)
131 Illegal Data Value
132 Illegal Response Length
32
Page 36
14 LOG FILE DATA
WEB VERSION
138 Gateway Path Unavailable (the Modbus/TCP gateway may be misconfigured)
139 Device Failed to Respond (the Modbus device may be off or disconnected)
140 Received invalid Modbus data checksum
141 Received response from unexpected device
142 Received unsolicited query, assume another Modbus master device is present
143 Modbus device probe function received some good responses and some failures
160 Start log (Entry in log file after EMB Hub starts up)
161 Stop log (Entry in log file if EMB Hub is shut down properly)
162 System time changed, caused logger to restart logging for intervals
163 System auto-restart
164 Log entry corrupt
165 Modbus device restart detected
192 Modbus device does not match the device type in the configuration file
193 Modbus device’s serial number changed
(could be two devices with the same Modbus address)
Low/High Range Alarms: This number is a hex representation showing which data points are out of range. 0x01 shows data point 1 in alarm state. 0x04 shows data point 3 in alarm state.
Data Points: Data points are shown in the same order as the modbus device configuration display in the modbus/device list page. Data is displayed in floating point form. When a specific point is unavailable (4A4P-M broken wire alarm) or the point is not supported as part of the configuration (phase B current on a single phase H8163 meter hookup) the point will be logged as blank. This preserves the column structure of the file, and allows notation of invalid data. SQL databases often accept blank or NULL as a valid entry in a data table to represent invalid data.
For data exported from the BMO website, the columns that are invalid (NULL) are reported as blank fields. This makes it easier to import into MS Excel as blank cells. With the current firmware, the EMB Hub will report blank fileds rather than “NULL” to make direct import of data from the EMB Hub easier, as well as reduce the file size. Developers intending to use data files from the EMB Hub should handle both the word “NULL” as well as a blank column as indicatio ns of an invalid data point.
14.3 Log Storage Capacity
The EMB Hub uses approximately 8 MB of flash disk for log file storage. As data from the Modbus meters is collected, it is appended to log files on this flash chip. Once a day (at the first call out period for uploading data) the log files are “rotated”. This action renames each log file and compresses the old file using gzip. The net result is a smaller file for storage or modem/ethernet transfer.
Because the files are compressed, the actual size of the data on the flash chip will vary depending on the data itself. For example, if a device is reporting 25KWh, it will use fewer bytes than a log entry that has 9,999,999KWh.
We have measured a typical installation with 5 H8036 power meters and 5 A8923 I/O modules, and determined the system will run for well over a hundred days with a 15 minute log cycle. Changing the number of meters, the type of log data, or the log cycle period will affect your results accordingly. Please read Technote “TN-03” at leviton.com for more information about log file storage capacity.
33
Page 37
14 LOG FILE DATA
WEB VERSION
When the EMB Hub storage area on the flash starts to run out of space, the following action is taken:
• When the 8 MB log file storage area is 75% full, the EMB Hub will immediately compress the log files
and attempt to upload the data to the BMO website or user specified site. This action will not wait until the next scheduled upload time.
• When the storage area is 95% full, the EMB Hub will immediately attempt to upload the data, and if
unsuccessful, will purge the oldest (rotated) log data file.
Log files are deleted automatically if the EMB Hub has successfully uploaded the log file to a database server using the HTTP/Post protocol. If you do not configure the EMB Hub to automatically push the log files to your server, you must manually delete them. To delete log files, refer to the FTP method of downloading log files. One step detailed in the FTP section is how to delete a log file from the EMB Hub.
14.4 Uploading data to the BMO website
After the EMB Hub has been configured and has logged some data, you will want to collect the data for analysis. There are several ways of collecting the data from the EMB Hub including the Building Manager Online service. Other methods are noted in the data collection FAQ. This section details configuring the EMB Hub for use with the BMO service.
14.4.1 First, use your browser to connect to the EMB Hub . Select the Modbus/Setup section from
the menu on the left. In the field titled “Modbus Loop Name” enter a name for this EMB Hub to uniquely identify it on the BMO website. Because the BMO site can show multiple EMB Hub devices, it is important to have a descriptive name in this field.
14.4.2 Select the “Log File Data”, “Setup/Upload” menu option. The following features are available:
EMB Hub Serial Number: This is the serial number that uniquely identifies this EMB Hub.
This number can not be changed. When uploading data to the BMO website, this serial number is used to identify the EMB Hub to the BMO server.
Scheduled upload time: This option allows you to control when the EMB Hub will initiate
the upload process. You can select any hour of the day, and the EMB Hub will select some time at random within that hour to start the upload. The random feature allows multiple EMB Hub devices to share a single dial up account or phone line by not starting the dial out at the same time for all devices. If the EMB Hub is on a LAN connection (DSL, Cable Modem, T1, etc) an upload time of “hourly” may be selected.
Upload data on alarm: status change will cause the EMB Hub to initiate the upload process
if any point on any modbus device enters or leaves an alarm state. This allows the EMB Hub to send data when an alarm is detected, and will upload that information to the BMO website in a timely manner. The BMO website will then send email notifications if necessary. If this option is disabled, the BMO website may not be able to send notifications until the end of the day when the EMB Hub calls in at its specified upload time.
Upload data on low disk alarm: This feature will cause the EMB Hub to attempt a data
upload immediately if the log file storage area is more than 75% full.
34
Page 38
14 LOG FILE DATA
WEB VERSION
Allow remote Modbus device configuration: If enabled, users may remotely configure alarms
and other modbus device features on the BMO website. When the EMB Hub uploads data to the BMO website, it will also download any new configuration information as needed. Note: if configuration changes are made to the EMB Hub , those changes will be uploaded to the BMO site. If configuration changes are made at both the EMB Hub and the BMO website, the most recent changes will be used.
Target Address to upload data: This is the website URL to which you can upload data. This should
always be set to http://www.buildingmanageronline.com/u pload.php unless you are configuring the EMB Hub to send data to your own internal database server. (see the Data Collection FAQ at www.leviton.com
Password to upload data: This password is used by the BMO webserver to verify the EMB Hub
device authentication before accepting the uploaded data. You should select a password other than the default, and make note of it for future reference.
Number of times to retry: In the event of a failure (often due to dial up problems, busy signals, etc.)
this option specifies the number of retries to attempt the upload again. If all retries fail, the EMB Hub will wait until the next scheduled upload time before trying again.
Time to wait before retry: In the event of a failure, the EMB Hub can be configured to wait for a
specified period of time before attempting another connection. This option specifies how long to wait before retrying.
14.4.3 Contact the Leviton Technical Support department. Please have the EMB Hub serial number
and password to upload data handy. Your tech support representative will confirm your BMO account and will add the EMB Hub to one of your client databases.
14.4.4 Click the “Upload Data Now” button. Your data will be sent to the BMO web server.
14.4.5 For more detailed information about the transfer process, use the Connection Test page in the
Testing/Diags menu on the EMB Hub for a full report of the data upload progress.
35
Page 39
15 RETRIEVING DATA FROM THE EMB HUB
WEB VERSION
Overview of how the system was designed to work.
Now that you have installed your EMB Hub and configured it to collect data from your meters and sensors, you will want to collect the data from your EMB Hub . This document will provide an overview for collecting data from the EMB Hub. Processing the data for billing reports, summaries, and other data processing are beyond the scope of this document.
Three basic ways to collect data from the EMB Hub:
• HTTP download from the EMB Hub with a browser (pull)
• FTP download from the EMB Hub (pull)
• HTTP Post: The EMB Hub uploads data to a database/webserver. (push)
15.1 HTTP Direct from the EMB Hub
The EMB Hub has the ability to export log file data to a web browser directly from the setup web pages. To use this feature, access the EMB Hub setup menu with your web browser. Select the “Log File Export” page from the Log File Data menu on the left side of the page.
For each device, a separate log file will be saved. Select the device from the dropdown list provided. Specify Comma or Tab delimited data, and indicate if column headers are required. Click the download button to download the data.
The log file format is the same as is provided by FTP and by the BMO web site. Note: All timestamps are in UTC.
When importing log files into Microsoft Excel, be sure to specify the log data is comma separated, and use a single quote mark as the text delimiter.
15.2 FTP Direct from the EMB Hub
The EMB Hub will allow inbound connections for transfer of log data files using the FTP protocol. FTP to the EMB Hub and log in using the system admin password. Files are located in /var/log/modbus. For further information on FTP log file transfer, please review the technote and FAQ section of the Leviton website.
15.3 HTTP/Post Upload To Building Manager Online
• EMB Hub sends data to the BMO website.
• The BMO Website stores the data in a SQL database.
• Quick reporting from our website.
• Includes remote EMB Hub configuration service.
• Includes alarm notification by email.
• Data available for download in .CSV/Tab delimited format upon your request.
• For pricing and to sign up for service, contact sales@buildingmanageronline.com or
call +1-503-601-2099
36
Page 40
15 RETRIEVING DATA FROM THE EMB HUB
WEB VERSION
15.4 HTTP/Post Upload To Your Database Server
• EMB Hub uploads data directly to your webserver or database server.
• You must supply a script to process the incoming data. Sample script for ASP and PHP are available
upon request.
• Requires web server, CGI Scripting and, database (SQL) knowledge.
• Alarm processing available by processing data on your server when data is uploaded.
• Designed for integration with existing energy reporting systems.
• Contact Leviton technical support for further details and sample scripts.
15.5 Removing Data From the EMB Hub
When using an HTTP/Post method to allow the EMB Hub to push data to a database server, the EMB Hub will automatically remove log files from its flash memory once the EMB Hub has confirmed that the file was received by the database server.
If you are using the EMB Hub with a standalone mode, you can use FTP to delete log files from the flash memory.
For FTP, the process is essentially the same process as the manual FTP data download. For more information on FTP access to the EMB Hub, please view the FAQ and Technotes section at leviton.com.
Steps for Microsoft Windows command prompt FTP.
Use the following commands.
The “mdel” command will tell the FTP software to delete all files ending in .gz in the current directory. Some FTP clients will allow you to specify a command “prompt” prior to using “mdel” that will prevent the FTP client software from asking if you are sure you wish to delete each file.
15.6 Linking to EMB Hub Device Status Pages
It may be helpful to create a shortcut or a hyperlink on another web page that will direct the browser to bring up a specific device status page in your browser. To do this, right click on the page and select properties. The URL for the page will be shown on that dialog. Simply copy/paste this URL into your link.
The EMB Hub can provide Modbus device data in XML format. This feature, coupled with browser based AJAX (Javascript) can provide a very powerful tool to allow the creation of custom web pages. Further examples of XML and its uses are available on the Leviton website in the Documentation/Technotes section.
37
Page 41
16 MECHANICAL DRAWINGS
WEB VERSION
The EMB Hub uses a plastic enclosure that is approximately 4 in x 4.25 in x 2 in deep.
The EMB Hub has 4 mounting holes for use with a #6 screw. The drawing above shows the relative position of the mounting holes.
38
Page 42
17 WARRANTY AND CONTACT INFORMATION
WEB VERSION
FCC STATEMENT:
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 the user will be required to correct the interference at his own expense.
Any changes or modifications not expressly approved by Leviton Manufacturing Co., could void the user’s authority to operate the equipment.
FCC SUPPLIERS DECLARATION OF CONFORMITY (SDOC):
Model A8810 manufactured by Leviton Manufacturing Co., Inc., 201 North Service Road, Melville, NY 11747, www. leviton.com. This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) This device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation.
IC STATEMENT:
This device complies with Industry Canada license-exempt RSS standard(s). 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.
TRADEMARK DISCLAIMER:
Use herein of third party trademarks, service marks, trade names, brand names and/or product names are for informational purposes only, are/may be the trademarks of their respective owners; such use is not meant to imply
affiliation, sponsorship, or endorsement. Modbus is a U.S. registered trademark of Schneider Electric USA, Inc. Belden is a trademark of Belden, Inc. Enercept is a registered U.S. trademark of Veris Industries.
Leviton Manufacturing Co., Inc.
201 North Service Road, Melville, NY 11747
Visit Leviton’s website at http://www.leviton.com
© 2021 Leviton Manufacturing Co., Inc. All rights reserved.
Specifications and price subject to change at any time without notice.
FOR CANADA ONLY
For warranty information and/or product returns, residents of Canada should contact Leviton in writing at Leviton Manufacturing of Canada ULC to th e attention of the Quality Assurance Department, 165 Hymus Blvd, Pointe-Claire (Quebec), Canada H9R 1E9 or by telephone at 1 800 405-5320.
Leviton warrants to the original consumer purchaser and not for the benefit of anyone else that this product at the time of its sale by Leviton is free of defects in materials and workmanship under normal and proper use for five years from the purchase date. Leviton’s only obligation is to correct such defects by repair or replacement, at its option. For details visit www.leviton.com or call 1-800-824-
3005. This warranty excludes and there is disclaimed liability for labor for removal of this product or reinstallation. This warranty is void if this product is installed improperly or in an improper environment, overloaded, misused, opened, abused, or altered in any manner, or is not used under normal operating conditions or not in accordance with any labels or instructions. There are no other or implied warranties of any kind, including merchantability and fitness for a particular purpose, but if any implied warranty is required by the applicable jurisdiction, the duration of any such implied warranty, including merchantability and fitness for a particular purpose, is limited to five years. Leviton is not liable for incidental, indirect, special, or consequential damages, including without
limitation, damage to, or loss of use of, any equipment, lost sales or profits or delay or failure to perform this warranty obligation. The remedies provided herein are the exclusive remedies under this warranty, whether based on contract, tort or otherwise.
LIMITED 5 YEAR WARRANTY AND EXCLUSIONS
For Technical Assistance Call: 1-800-824-3005 (USA Only) or 1-800-405-5320 (Canada Only)
www.leviton.com
39
Page 43
WEB VERSION
Page 44
WEB VERSION
Loading...