How To: Read data from a Remote eGauge

How to read data from one eGauge meter to another via UDP/TCP

Overview

These protocols are used to have a master eGauge meter read from a secondary eGauge meter. There are two options available - UDP or TCP. This can be used at installations where multiple eGauge meters are present to allow the end user to see a single consolidated view instead of navigating to multiple meters. This protocol is only supported by eGauge meters, and cannot be used with third party devices.

Prerequisites

  • For best results, meters should be connected to the LAN via Ethernet. Other communication types such as WiFi can introduce network latency which can affect communication between meters.
  • UDP is generally the more stable and reliable option, but only works over local networks where UDP access is available. 
  • TCP uses a connection over TCP port 80 instead of UDP.  The Device Address can be a device name, IP, or FQDN (do not specify "http://" or use any slashes in the address). A TCP connection can be established over the eGauge proxy server, meaning it's possible to pull data from meters at multiple sites into a single master eGauge. However, this connection may be unstable.

 

  • Remote devices with site-wide password protection will not allow for remote eGauge via TCP to be used.
 

 

Instructions

Step 1: Click the menu(≡) in the upper left, then select Setup → Other Settings

 

Step 2: Click on Installation on the left side

 

Step 3: Under the Remote Devices section of the Installation Settings page, click Add Device to configure a new remote device. Give the remote device a descriptive name. In this example, it is named ‘Remote eGauge’

Step 4: Choose the communication protocol from the dropdown list and complete the device address. Below, examples for UDP and TCP are shown.

remote eGauge via UDP: The Device Address string is simply the device name of the remote eGauge. An IP address can also be used, but the meter should either be set to use a static IP address or assigned a DHCP lease reservation.

remote eGauge via TCP: The Device Address can be a device name, IP, or FQDN (do not specify "http://" or use any slashes in the address). A TCP connection can be established over the eGauge proxy server, meaning it's possible to pull data from meters at multiple sites into a single master eGauge. However, this connection may be unstable.

Step 5: Click on the gray  ?  at the end of the Device address field to resolve the remote device. If the remote device is reachable it will resolve to a green check mark.  A red X indicates that the remote device cannot be resolved. 

This remote eGauge meter is available locally over UDP but times out over TCP due to network settings

Clicking on the blue ‘info’ button after the check mark or X will display more information about the communication results and/or the registers that were detected.

Step 6:  Once the green check mark appears, registers can be added to the eGauge configuration to store data fetched from the remote device. Click the Add Register button in the Registers section of the Installation settings page.

Name your register and use the first dropdown menu to change the register type to the remote device you set up in steps 2 through 4. The next dropdown will list available registers from that meter.

Register LDC is pulling remote register ‘LDC Volts’ from the remote eGauge named ‘remote eGauge UDP’

 

Troubleshooting and Tips

  • Issue: My remote device does not resolve
    • Solution: Check that the correct device name and protocol is being used. You may need to follow up with the local network administrator for more information.
       
  • Issue: My remote device resolves but there are no registers in the dropdown.
    • Solution: Check that the green check mark is showing in the remote device definition.  If it is, click it again to populate the available register dropdown list.
       
  • Issue: I added a new register to my remote device but it's not showing up in the available registers list.
    • Solution: Click the check mark or question mark again to resolve the remote device. This will pull in any changes made since the last time the device was resolved.