eGauge Meter Configuration

Topics related to configuring the eGauge meter. This is essential for proper meter operation!

Initial Configuration

Configuration steps that must be performed after installation!

Initial Configuration

Installation Overview Tips (START HERE!)

Process and Tips for a successful installation

  1. Read Owner's Manual.

  2. Physical Installation (Diagrams for common setups can be found at egauge.net/help/config section 2, starting on page 13, as of time of article publishing).
    Voltages: First available breaker may not be on the system L1. Ensure the eGauge's L1 breaker is on the same phase as the system L1. Use a volt-meter to check voltage between the eGauge L1 and system L1, zero volts is the correct phase. More information on panel phasing hereAlways connect the N terminal appropriately or damage may occur. Never connect a ground to the N terminal.
    CTs: Point the sticker towards what is being measured. For example, Utility, Solar Inverter, or Load. Some CTs require two clicks to close fully. Use a volt-meter to check between conductor CT is around and the eGauge L1, L2, or L3 to ensure correct phase.
    NetworkVisit this KB article for how to confirm network connections are up and device interface can be accessed.

  3. Connect to eGauge interface for configuration via this KB article. Note if you are not on the local network of the eGauge, you will need to register the device and enable remote administration and possibly reset the password. Visit this KB article for more information.
    NOTE: You may need to click "LAN Access" before configuring if accessing via the proxy server.

  4. In the eGauge interface, navigate to Settings -> Installation and configure the unit. Visit this KB article for more information on how to configure.

    For meters purchased on or after Jan 2021, the default credentials are printed on the side of the meter. 

    For meters purchased prior to Jan 2021, the default username is "owner" and password "default".

    eGauge support cannot provide the password currently set on a meter or the default password on meters shipped on or after Jan 2021. 


    NOTE: If an error stating you are unauthorized to change settings, enable remote administration or click LAN Access in the top right corner of the page and try again.

  5. After configuration, commission the system by verifying readings in the channel checker.  This article has information on identifying and correcting installation or configuration issues.
    • Verify amperage readings are accurate with a multimeter (Use fresh batteries! Sometimes the eGauge is more accurate!)
    • Verify voltages are accurate with a multimeter
    • Ensure power polarities are correct (applies to system with a neutral)
      • Grid is positive when there is no production back-feeding
      • Generation is positive when producing (negative when in standby)
      • Individual loads can be negative
    • Ensure power factors look good (applies to systems with a neutral)

  6. Make sure Date and Time is correct in Settings -> Date & Time.

  7. Optional: update firmware in Tools -> Firmware Update.


Linked Articles

Accessing the eGauge interface

Register device, remote access and reset password

Initial Configuration Steps

Commissioning readings with the Channel Checker

Initial Configuration

Initial Configuration Steps

The eGauge must be configured for the system monitored or data will be invalid.

To configure the eGauge, log on to it (see this KB article) and navigate to Settings -> Installation.


The full configuration guide can be accessed at egauge.net/help/config. Line diagrams with example configurations can be found in Section 2 Configuration Examples, starting on page 13 (as of time of writing this article).
Potential Transformers


If step-down transformers are used, like on a 480V delta, select the appropriate transformer ratio or type here. E.g., 480:120 for a generic 480V to 120V transformer, or FDT-480-120 for the Functional Devices transformer provided by eGauge Systems.

If eGauge is connected directly to the systems voltage, leave this as "direct (no PT)"

Sensors/CTs

Note: in firmware v4.0 and greater, "CT" has been changed to "S" for Sensor. For example, CT5 = S5, and CT12 = S12.

The current transformers in each slot are selected here. See this KB article for how to understand the drop-down menu options

Remote Devices

This can be left alone if no remote devices are used.

Registers


Note: in firmware v4.0 and greater, "CT" has been changed to "S" for Sensor. For example, CT5 = S5, and CT12 = S12.

Registers can be deleted by clicking the [x] to the right of the register name. For each measurement, add a register. Click "Add Component" to add a CTxLine combination.

This example shows three-phase Grid being monitored by CT1, CT2, and CT3.

Solar 1 is monitored by CT4 and CT5, and is feeding on L1 and L2.
Solar 2 is monitored by CT6 and CT7, feeding on L3 and L1.

It is vital for CTxLine combinations to be correct. Visit this KB article on information on phase checking with a volt-meter.

Total and Virtual Registers

The Usage and Generation totaling registers determine the red and green areas on the main graph, as well as summary information for Usage and Generation.

For Usage in a back-fed system, positive values of Solar (e.g., Solar 1+ ) are added to Grid. In a line-side feed, the  negative values would be added to Usage (e.g., Solar 1- ).

Generation consists of all Generating loads.

Initial Configuration

eGauge Configuration Guide

The eGauge is a powerful, highly accurate piece of monitoring hardware. However, it is essential to configure the eGauge properly, or the readings obtained will not be correct. Even on identical installations the exact settings may vary, depending on how the eGauge and CTs are installed. The document below covers the various aspects of basic eGauge configuration (assuming monitoring is done exclusively with CTs and voltage taps - remote devices are only briefly covered in this document).

Technical support is available to assist with configuration, but there is no guarantee the device configuration will be set correctly. Ensuring a device is correctly configured falls on the owner or installer of that device.

To determine your firmware version, visit View -> Status in the device interface.

Configuration Guide for firmware v4.x

Configuration Guide for firmware v3.x

Initial Configuration

Accessing eGauge Interface

If the credentials need to be reset or remote configuration enabled, visit this KB article.

There are two methods to access the eGauge graphical interface.

Remote Access via Proxy-server

First, if the device has internet access and is able to connect to the proxy-server, it can be accessed at:

http://DEVNAME.d.egauge.net or http://DEVNAME.egaug.es 

Where DEVNAME is the eGauge device name, found on the sticker with the unit or the LCD screen.

A "Not Found" response means the eGauge is not connected to the proxy server. The eGauge requires outbound connections to port TCP 8082 and 8084 of d.egauge.net for the remote connections to work. See this article for more information about network connections.

Configuration Note:

If you are on the same local network where the eGauge is installed and are configuring for the first time, you may need to click "LAN Access" in the top right of the page to redirect to the local IP address of the eGauge. This is required if you wish to use the factory credentials.

For meters purchased on or after Jan 2021, the factory credentials are printed on the side of the meter.

For meters purchased prior to Jan 2021, the factory credentials are user: owner pass: default.

Note that these credentials may have been changed.

eGauge support cannot provide the password currently set on a meter or the default password on meters shipped on or after Jan 2021.

If you are not on the same local network and need to make changes, or reset the password visit this KB article.

Local access via hostname or IP

If the eGauge does not have internet access, or is not allowed to access the proxy server, it can be accessed from the local IP address or device name. The device name and IP address can be found on the EG4xxx LCD screen by depressing the toggle switch to get to the main menu, toggle to "Info" and depress the switch, and toggle left or right to see "Name" and "IP address":

In this example, the device can be accessed at http://10.1.90.133

On some networks, the device can also be accessed at http://eGauge99999/ or http://eGauge99999.local/

Initial Configuration

Register a device, remote access, and password resets

To only access a device interface, visit this KB article.

To register a device and get access, log in or create an eGauge.net account at https://egauge.net/login.

After being logged in, hover over eGuard, and click "Register a Device":


Enter the registration date, device name, and MAC address. The MAC address should start with F8-2F-5B. Enter the MAC without colons, dashes or spaces:

If you administrate an existing group, you will have the option to add the device to the group you admin. If the device being registered belongs to another group, after pressing Register Device it will tell you it cannot be moved but has been registered.


Next, visit eGauge.net/eGuard or hover your mouse over eGuard and click on Portfolio:


Locate the newly registered device in the portfolio and click the notepad icon to the left of the device name:

Note: the "Name" to the right of the notepad icon is a link to the eGauge proxy-server URL


In the device details page, locate Remote Administration Control and press the Enable button:

The first username in the eGauge Access Control Settings now has remote administration enabled. Assuming the meter configuration hasn't been modified:

For meters purchased on or after Jan 2021, the factory credentials are printed on the side of the meter.

For meters purchased prior to Jan 2021, the factory credentials are user: owner pass: default.

Note that these credentials may have been changed.

eGauge support cannot provide the password currently set on a meter or the default password on meters shipped on or after Jan 2021.

 Make sure to change the password to something secure in Settings -> Access Control.

If you administrate a group and the device was moved to it during registration, there is also an option to reset a password for a user on the device:

Initial Configuration

Configuring CTid-enabled sensors

What is CTid?

CTid is a technology created by eGauge which allows the eGauge meter to obtain information about a connected CT or Sensor. This information can include model, manufacturer, serial number, amperage rating (if CT), and other information about the sensor. The information is stored on a chip embedded in the CT or Sensor, and can only be read by EG4xxx model units (eGauge Core and eGauge Pro). When inputs are scanned for CTid sensors, they are automatically configured instead of the user's traditional drop-down selection box.

CTid enabled sensors also contain a locator LED that can be blinked from the eGauge configuration interface. This can be used to identify which sensor is connected to which port, in the event the leads were switched or untraceable.

Prerequisites

If you are not familiar with programming the eGauge, please refer to the overview help page and ensure access and permissions to configure the eGauge before continuing.

Ensure the sensors and Sensor Hub are installed correctly before continuing.

Configuring CTid Sensors

To configure a CTid-enabled sensor, navigate to the Installation Settings page (Settings -> Installation). Locate the blue "CTid" above the sensor drop-down menus:



Next, select the sensor ports that have CTid-enabled sensors connected, and press "Scan Checked Sensors":

image-1610997682982.png


A green check-mark will show for each successfully detected sensor. The model and serial number is displayed for each sensor. Press the plus or minus sign (1) to expand or collapse additional information for the sensor. Every CTid sensor has an LED, which can be blinked by clicking the "Blink LED" button (2). To delete a configured sensor, press the "x" button (3). When finished, press "Back to Settings" to the left of the "Scan" button:

image-1610997428809.png


In the above image, an ambient temperature sensor (ETLW) is connected to Sensor port 1. Port 2 contains a temperature probe sensor (ETN100), port 3 contains a pulse sensor (EPS), port 4 contains a low voltage or dry contact sensor (ELV2), and port 5 contains a Rope CT (ERA-1206-2775).


Back in the Installation Settings page, the inputs will show the sensor detected in blue to indicate it was programmed via CTid:

image-1610995276614.png


Finally, configure registers to record the data from these sensors:

image-1610995407675.pngChoosing "S" (Sensor) for the type will record the value of the sensor. Temperature sensors record °C, pulse counts are unit-less, dry contact (low voltage sensor) records voltage and CTs record amperage.

To record power, use "P" (Power) and choose the CT input (S5 in this example) and the voltage line it is on.

Instantaneous values may be found in the channel checker:

image-1610997332639.png

Initial Configuration

Commissioning readings with the Channel Checker

After configuring the eGauge, it is necessary to commission the readings to ensure accuracy using the channel checker. The channel checker can be accessed via Tools -> Channel Checker.

The Channel Checker tool provides instantaneous readings of all the inputs of the eGauge including voltage, amperage, watts, frequency and power factor.

Example: Good 3-phase solar

The left-side shows the channel inputs: the Line-Line voltages are ~500V, Line-Neutral are ~288V. Currents on CT1, CT2, and CT3 are between 640A and 660A. Only channels that are configured in a register will appear here.

The right-side shows the registers and calculated power. Each leg of the solar inverter is outputting ~183kW, and have a good power factor of ~.98 (as expected by a solar inverter).

Example: Negated value on main usage

If a system with a neutral does not have any solar or other power back-feeding through the CTs, all power polarities should be the same. In this example, CT7*L3 shows a negative value (-2259.8W), while CT8*L2 and CT9*L1 show positive power values. When these are added together in the register, CT7*L3 reduces the overall power and will give inaccurate power values.

Cause Fix
The CT is physically reversed (MOST COMMON) Physically reverse the CT, or negate it in the Installation Settings register component (e.g., CT7*L3 to -CT7*L3)
Phase mix-up (MOST COMMON USUALLY W/ BAD POWER FACTOR) Locate the correct phase and move the CT to it, or change the association in the Installation Settings register component (e.g., CT7*L3 to CT*L2). Visit this KB article for more information on phasing.
The CT black/white leads have been swapped Swap the leads, or negate it in the Installation Settings register component. This is more common with CT extensions.
Multiple conductors in CT of different phases, or different directions If multiple conductors are run through the CT with different phases, or different directions, it can cause polarity to randomly shift or stay at an unexpected polarity. Ensure only conductors of the same phase are in the CT.
Bad CT splices If CTs have been extended or modified, sometimes they are mistakenly wired different on each end which can lead to combined signals that cause bad data. Ensure twisted pair wire is used.
CT not connected or insufficient amperage If the CT is not connected the signal will bounce and can switch polarity. If there is no or insufficient amperage, noise can cause bad readings.
Wrong CT selected Configuring with the wrong CT can cause the power to be negated or wrong.

 

False Positives Reason
There is bidirectional power or back-feeding active Power flowing through a CT in one direction gives a positive polarity, and if power reverses direction (like in back-feeding) the polarity negates. Make sure there is no back-feeding when troubleshooting polarity.

Example: Poor power factors

In a system with a neutral, power factors are between 0 and 1. Higher power factors usually indicate better performance, resistive loads (like a heater, hot water heater, solar inverter, etc) generally have high power factors, while capacitive or inductive loads (like motors, pumps, switching power supplies, CFL lighting, etc) will have lower power factors.

Generally, standard equipment tends to have a .6 power factor or higher, but it's not always the case.

Cause Fix
Phase mix-up (MOST COMMON, USUALLY W/ NEGATED VALUES) Locate the correct phase and move the CT to it, or change the association in the Installation Settings register component (e.g., CT7*L3 to CT*L2). Visit this KB article for more information on phasing.
CT not clamped fully, or other damage Ensure CT is fully clamped and undamaged. Some CTs take two clicks to fully close.
CT not configured correctly If the type of CT is wrong (Rope, DC CT, AC CT), it can cause poor power factors and incorrect amperages.

 

False Positives Reason
Active production from inverter on back-fed system (does not have to be actively back-feeding) Solar and other inverters put out
all real power, so as production increases on a back-fed system less real power is demanded from the utility and more reactive power, bringing the grid power factors down. This is normal. Run tests without any active production.
Insufficient amperage When there is insufficient amperage on a CT (especially rope CTs), noise can cause higher than real amperage readings, and that noise is cancelled out when power is calculated resulting in a lower than real power factor. This is normal.
Equipment uses a lot of reactive power Some equipment like HVAC systems can have a power factor of ~.5.

 

 

Advanced Configuration

Advanced meter configuration (above and beyond monitoring real power).

Advanced Configuration

Voltage registers

Voltage registers are configured in much the same way as power registers (the default register type on the eGauge). To add a voltage register:

Firmware 4.0 and newer

Navigate to Settings -> Installation

Under Registers, click the "Add Registers" button

Name the register as appropriate

Using the dropdown menu, change the register type from "P" to "L"

In the next dropdown menu, select the appropriate voltage reference

In the final dropdown menu, select the measurement type (if in doubt, "normal value" is generally correct)

Click "Save" at the bottom of the page when finished (valid credentials required)

As with all physical registers, data will only start recording from the time the register is created.

 

It is also possible to set up a formula register to evaluate the difference between two voltage registers. This can be used to trigger an alert, or just to obtain a historical reference.  It is typically not required for the average installation.  To create this register:

Navigate to Settings -> Installation

Under Registers, click the "Add Registers" button

Name the register as appropriate

Using the dropdown menu, change the register type to "="

A second dropdown menu will appear.  Set the unit type to "voltage [V]"

In the formula field, enter the following: abs($"volt_reg_1"-$"volt_reg_2") where volt_reg_1 and volt_reg_2 are the names of voltage registers.  The order does not matter.

Click "Save" at the bottom of the page when finished (valid credentials required)

 

Legacy (pre firmware 4.0)

Navigate to Settings -> Installation

Under Registers, click the "Add Registers" button

Name the register as appropriate

Using the dropdown menu, change the register type from "P" to "V"

A second dropdown menu will appear.  Select the appropriate voltage reference

Click "Save" at the bottom of the page when finished (valid credentials required)


 

 

 

Advanced Configuration

Amperage Registers

The eGauge can be set to record individual CT amperages as separate registers. Unlike power registers, amperage registers are absolute values (they do not change polarity to reflect the directional flow of current).

Firmware 4.0 and newer

To add amperage registers:

Navigate to Settings -> Installation

Under Registers, click the "Add Registers" button

Name the register as appropriate

Using the dropdown menu, change the register type from "P" to "S"

In the next dropdown menu, select the appropriate sensor number

In the final dropdown menu, select the measurement type (if in doubt, "normal value" is generally correct)

Click "Save" at the bottom of the page when finished (valid credentials required)

As with all physical registers, data will only start recording from the time the register is created.

 

Legacy (pre firmware 4.0)

To add amperage registers:

Navigate to Settings -> Installation

Under Registers, click the "Add Registers" button

Name the register as appropriate

Using the dropdown menu, change the register type from "P" to "I"

A second dropdown menu will appear.  Select the appropriate CT number

Click "Save" at the bottom of the page when finished (valid credentials required)

 

 

Advanced Configuration

Power Register Subtypes

By default, the eGauge will record Power registers as the "Net" (=) subtype. This means the register will record power flow in both directions. Positive readings will be graphed as a green line, and negative readings as a red line.

However, it is possible to record other subtypes as well. Some of these are needed for basic calculations (such as positive-only subtypes) while others can be used in advanced calculations (the apparent power subtype). The full list is below:

Power Register Subtypes

To select a power register subtype, click the small box containing the "=" sign that appears to the right of the "P" indicating a power register. Select the appropriate subtypes and click the OK button. Subtypes are named based on the original (net) power register's name and their subtype sign. For example, a power register named "Grid" recording net, apparent, and positive-only power would exist as "Grid", "Grid*", and "Grid+". Each subtype selection uses an additional register in the eGauge database.

Grid Register with Multiple Subtypes

As with all physical registers, additional registers recording power register subtypes will only start recording from the time they are created.

 

Advanced Configuration

Power Factor

Although the eGauge uses power factor to calculate real power, the power factor values are not stored in the database by default. However, it is possible to create a register to track the power factor of either a single CT/phase pairing or aggregate registers containing multiple CT/phase pairings. This requires both a Real Power and Apparent Power register already be configured (see Power Register Subtypes). 

Power registers can contain a single CT/phase pairing or multiple CT/phase pairs. Any set of real power and apparent power registers can be used to calculate power factor. If unsure how to create an apparent power register, please see Power Register Subtypes.

In the example below, there are eight registers. Four real power (Grid, S1xL1, S2xL2, S3xL3) and four apparent power registers (Grid*, S1xL1*, S2xL2*, S3xL3*).

To record power factor for a given real power and apparent power register set:

Navigate to Settings -> Installation

Under Registers, click the "Add Registers" button

Name the register as appropriate

Using the dropdown menu, change the register type from "P" to "="

A second dropdown menu will appear.  Select the unit type "number"

In the formula field, enter the following: 1000*($"REGNAME"/$"REGNAME*") where REGNAME is the name of the power register (type P).  Note the * present after the second instance of REGNAME.

Click "Save" at the bottom of the page when finished (valid credentials required)

Sample Power Factor Register (using the registers "Grid" and "Grid*")

Advanced Configuration

THD Registers

The eGauge can calculate Total Harmonic Distortion (THD) on a given CT or voltage reference. Each THD measurement will use one physical register. To do so:

Navigate to Settings -> Installation

Under Registers, click the "Add Registers" button

Name the register as appropriate

Using the dropdown menu, change the register type from "P" to "="

A second dropdown menu will appear.  Select the unit type to "total harm. dist"

In the formula field, enter the following:  THD(HZ, chan("XX")) where HZ is the system frequency in Hz and XX represents either a CT (CT1, CT2, CT3, etc) or a voltage reference (L1, L2, L3).

Click "Save" at the bottom of the page when finished (valid credentials required)


Sample THD Register for CT1 on a 60Hz system

Firmware 4.0 and later:

CTx channel names have been replaced with Sx channel names. Thus, instead of using chan("CT1"), use chan("S1"). Configuration is otherwise identical:

 

Advanced Configuration

Connection Quality

The eGauge can record network connection quality as a percentage value (0..100). This information is displayed on the Status page (http://DEVNAME.egaug.es/status.html, where DEVNAME is the device name of your eGauge meter) under "Connection Quality" by default, but historical values are not stored. Storing network connection quality as a register may be useful for certain types of troubleshooting (for example, to determine if the HomePlug signal is interrupted by a certain piece of equipment turning on/off). Note that this value updates once a minute (not necessarily at the top of the minute).

To record network connection quality:

Navigate to Settings -> Installation

Under Registers, click the "Add Registers" button

Name the register as appropriate

Using the dropdown menu, change the register type from "P" to "="

A second dropdown menu will appear.  Select the unit type to "number"

In the formula field, enter the following: conn_qual() (note that nothing should be entered between the parentheses)

Click "Save" at the bottom of the page when finished (valid credentials required)

 

Sample Connection Quality register using conn_qual()

 

Note that this function is available on the EG30xx and EG4xxx hardware. It is not available on the eGauge2. conn_qual() tracks the connection quality of whatever network interface is in use, and does not need to be modified or adjusted if the network interface is changed (for example, if switching from HomePlug to Ethernet communication). As with all physical registers, conn_qual() will only start recording data from the time it is created.

Advanced Configuration

Net import/export registers on line side tap system

On a backfed PV installation (that is, an installation where excess solar production is fed back through a breaker on the main distribution panel to the utility) it is relatively easy to see the net import and export of power. The CTs installed on the main utility feeds are in effect net CTs, as they see power imported from and exported to the utility. Any register created using those CTs will thus change polarity when production exceeds consumption, and change back when consumption exceeds production. For instructions on displaying the net import/export values for a backfed system, see this article.

However, a line side tap PV installation (where the solar is tapped between the main utility feed CTs and the utility meter itself) only tracks the consumption of the main distribution panel by default. A register using the main utility feed CTs will only see the consumption associated with that panel, regardless of how much production is being fed back to the utility. In this case, a comparison between the main utility CTs ("Grid" register) and the production CTs ("Solar" register) can show how much power is being imported or exported.

To track this information, two formula registers must be created as follows:

Sample Net Import/Export register setup

Net In = min($"Solar" - $"Grid",0)

Net Out = max($"Solar" - $"Grid",0)

Note that this assumes two registers, one named "Grid" which tracks only consumption on the main distribution panel, and one name "Solar" which tracks total solar production. If needed multiple registers can be combined.

Advanced Configuration

Net Usage/Generation Registers on a Backfed System

In some cases, it can be useful to graph the net flow of power to and from the utility, instead of the total power consumed and produced. This process adds a new view to display this information. The instructions below only apply to backfed PV systems - use these instructions for lineside tap installations.

Note that valid credentials are needed to apply these changes. These instructions also assume that these registers are being added to an existing installation. Steps 6-7 can be skipped on a fresh installation.

1. Navigate to Settings -> Installation and verify the "Usage" register at the bottom of the page contains "Solar+". This will not work with devices which are not using "Solar+" in the "Usage" register.

2. Set the "Grid" register to record both positive and net values. When done, it should look like this:

Figure 1: Grid register configuration

3. Add two new virtual registers: "Net.Usage" and "Net.Generation". Note the spelling and capitalization must match exactly.

4. Set "Net.Usage" to equal "Grid+" and "Net.Generation" to equal "Grid-". When done, they should look like this:

 

Figure 2: Virtual register configuration

5. Save and reboot.

6. Once the eGauge comes back online, navigate to Tools -> Split Registers.

7. Select "Grid" and click Start Splitting. This process can take 10-15 minutes - do not reboot the eGauge during this time.

Once the register split process has been completed, data can be viewed on the main graph page by selecting the "Net" view. The images below show a comparison between the default "total used/total generated" graph and the new "net used/net sold" graph.

Figure 3: Default view (note overlapping Usage and Generation lines)

Figure 4: Net view (note power is either moving to or from the utility)

Advanced Configuration

Reactive Power (kVAr)

Reactive power can be recorded using a formula register.

First, create a power register for the equipment monitored:

Next, click the power sub-type selector box to the right of the "P" box:

Choose "* Record apparent power" and press OK:

Finally, add a new register, change the "P" box to an equals sign for a formula register, choose "react. power [var]" as the unit, and enter a formula of:

VAr($"registername", $"registername*") 

where registername is the name of the power register. Note the asterisk (*) on the end of the second register name - this references the apparent power register.

Advanced Configuration

Potential Transformer Configuration

The eGauge AC voltage inputs can handle up to 277Vrms between any line input (L1, L2, L3) and neutral terminal. If voltages exceed this range, potential transformers must be used to step-down the voltage from the system to the eGauge voltage input terminals.

When using a potential transformer, the eGauge must be configured appropriately in Settings -> Installation -> Potential Transformers. Generic options such as 277:120 and 480:120 are available, as well as specific supported transformer models, such as FDT-480-120.

A set of negated transformer values are also available. Choosing this negates the polarity of the voltage. This has the effect of negating all power calculations using this transformer setting.

 

Custom potential transformer ratios

If a custom, unsupported step-down transformer ratio is used but not available in the drop-down menu, a custom scale factor will need to be used.

To calculate a custom potential transformer scale factor, use the following calculation:

secondary / primary * model_pt_value = SCALE_FACTOR

 

where:

secondary  is the secondary voltage
primary  is the primary voltage
model_pt_value  is a model-specific value (see below)
SCALE_FACTOR  is the custom scale factor you should use on the eGauge2 and EG30xx

The model_pt_value number will vary based on what model eGauge is in use, as described below (note values are negated):

EG4xxx (with LCD display) -74.0140
EG30xx (no LCD, w/ Ethernet) -4.003
eGauge2 (no Ethernet, no LCD) -4.003

 

For example:

EG4xxx with a 277:240 transformer would have a custom scale of -64.128:

240 / 277 * -74.0140 = -64.128

 

Similarly, an eGauge2 or EG30xx with a 277:240 transformer would have a custom scale of -3.4683:

240 / 277 * -4.003 = -3.4683

Remote Devices and Third Party Devices

Overview

The eGauge can record data from a variety of remote devices. This includes other eGauge meters (via UDP over a local network or via TCP through the proxy server) and third party devices via Modbus TCP or Modbus RTU (using a USB to RS485 converter). Third party devices include any piece of standalone hardware not manufactured by eGauge Systems (ie, anything that's not another eGauge meter).

Data read from remote devices can be displayed through the eGauge user interface, allowing multiple relevant data points to be aggregated in a single location. For example, an eGauge could monitor solar production locally using CTs, then pull additional performance data from the inverter and environmental data from an environmental sensor. Data stored in this way uses register slots on the "master" eGauge meter, meaning there is a limit to how much data can be imported into a single eGauge. For information on database capacity, see this article.

Breaks in communication will result in gaps in the historical data imported by the "master" eGauge meter. These gaps cannot be backfilled or adjusted.

Remote devices are configured under Settings -> Installation in the "Remote Devices" section. Best practice is to configure the remote device itself first (eg, ensure the remote device is reporting complete and valid values through that remote device's interface), then configure the "master" eGauge to read data from that remote device. 

 

Table of Contents

Example Remote Device Configuration

    Verifying a Remote Device

    Reading from a Remote Device

Supported Protocol Configuration

    Remote eGauge via UDP/TCP

    Serial

    Modbus TCP

    ControlByWeb    

 


 

Example Remote Device Configuration

The following image shows an eGauge configured to record building consumption using CTs, and recording a solar inverter via Modbus RTU (RS485):

image-1611268071430.png

There are 3 fields to configure for a remote device:

Device Name: This name describes the remote device. In the above example, the remote device is a solar inverter and has been named "Inverter". The name is completely arbitrary, but should make sense to the user.

Protocol: The protocol used by the remote device. In the above example, the remote device is using Modbus RTU via an RS485 (serial) connection, and therefore "Serial" is the protocol. A full list of supported protocols is available in the Supported Protocol Configuration section of this document.

Device Address: This describes the remote device and how to communicate with it. The formatting for the device address varies based on the protocol supported by that device, and is explained in detail in the appropriate section for that device:

Remote eGauge Device Address Format

Modbus RTU Device Address Format

Modbus TCP Device Address Format

ControlByWeb Device Address Format

image-1611351008974.png

In the example above, the device address specifies the remote device is using Modbus RTU (modbus://), the device map is CSI-50KTL-GS-B, with a unit ID of 1 (.1), is read via a serial to USB adapter on USB port 2 (@USB2), uses 9600 baud, 8 data bits, no parity, and 1 stop bit (:9600/8n1).

 

Verifying A Remote Device

After a remote device is configured, the remote device must be verified. To do this, click the grey "?" question mark to the right of the device address field. This will attempt to resolve and read data from the remote device. If this succeeds, the question mark will turn into a green check-mark, indicating the remote device is reachable and returning data.

The blue "i" button to the right of the question mark button will provide debug output after the remote device is resolved. If the remote device fails to resolve, this debug information can help determine why.

The remote device will need to be re-verified every time the Installation page is reloaded. 

 

Reading From A Remote Device

To actually record data from a remote device, it must first be verified using the process above. Assuming that is successful, create a new register in the "Registers" section by clicking the "Add Register" button. Select a name for the new register. Using the dropdown menu, change the default "P" to the remote device name. A second dropdown menu will appear - select the appropriate register from the list. Make sure to click "Save" at the bottom of the page to save these changes.

image-1611350804053.png

In the example above, the eGauge is set to record two registers from the remote device "Environment Sensor".

 


 

Supported Protocol Configuration

Some protocols are deprecated or unsupported and are not documented here.

Remote eGauge via UDP/TCP

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.

Remote eGauge Device Address Format

UDP is generally the more stable and reliable option, but only works over local networks where UDP access is available. 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.

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.

The example below shows a master meter configured to read from "eGauge52002" via both UDP and TCP.

image-1611351873016.png


 

Serial

This protocol is used for devices being read over a serial line. This includes Modbus RTU (both SunSpec and non-SunSpec) and SMA via serial. Serial data can be read over a local USB port on the EG4xxx using a USB to RS485 converter, or on the EG30xx and EG4xxx meters using RS485 to Ethernet converter over a local network (LAN).

Modbus RTU Device Address Format

The device address for serial devices is as follows:

protocol://DEVTYPE.SERIAL_ADDR@CONV_ADDR:PARAMETERS

where:

protocol:// is the protocol. Currently only modbus:// is supported, and is used with Modbus RTU over RS485.

DEVTYPE is the device type.  This can be the name of a Modbus map. See this article for information on how to find and create Modbus maps.

SERIAL_ADDR is the serial address (also referred to as the slave address, device ID, or unit ID) of the remote device.

CONV_ADDR is the address of the serial converter. For USB-serial converters, this can be USB1 or USB2 (case-sensitive). If using a serial-to-Ethernet converter, this can be the hostname, MAC address, or IP address of the converter.

:PARAMETERS are additional addressing parameters which may be specified.

If using a USB485 converter, the format is :BAUD/[DATA_BITS][PARITY][STOP_BITS].  BAUD is the baud, DATABITS is the number of data bits, PARITY is n for "none", e for "even" or o for "odd", and STOP_BITS are the number of stop bits. Examples include :9600/8n1 and :19200/8e1. It is most typical to have 8 data bits, no parity, and 1 stop bit. If the Modbus map defines default serial parameters, this may be excluded.

If using an Ethernet-serial converter, :PARAMETERS specifies a TCP port. If omitted, the eGauge defaults to use port 50,000 which is the default for the support BF-430 converter.

Examples

modbus://imt_si.1@USB1

modbus://cps403x.5@USB2:9600/8n1

modbus://ae75_100tx.1@192.168.1.241 Note this is using an IP address to specify a serial-Ethernet converter like the BF-430.


 

Modbus TCP

Modbus TCP is a protocol that operates over a local TCP/IP network. The remote device must be connected to the same local network as the eGauge. 

Using Modbus TCP over the internet (across networks) is unsafe and not supported.

Modbus TCP Device Address Format

The device address format for Modbus TCP is as follows:

DEVTYPE.UNIT_ID@ADDR:TCP_PORT

where:

DEVTYPE is the name of a Modbus map. See this article for information on how to find and create Modbus maps.

.UNIT_ID is the unit ID (also referred to as slave address or device ID) of the Modbus device. If omitted, this defaults to 255. Some Modbus TCP devices do not care what unit ID is specified.

ADDR is the address of the Modbus device. This may be an IP, hostname, or FQDN.

:TCP_PORT is optional to specify a non-default Modbus TCP port. If omitted, this defaults to the standard Modbus TCP port of 502.

Examples

cps403x@192.168.1.242


 

ControlByWeb

The eGauge can read from many ControlByWeb products that are network-enabled. This includes the X-320, X-410, X-420 and others. These ControlByWeb devices run a local webserver which the eGauge can read from over the local network. Communication is handled through HTTP requests, meaning only local communication (over the same network) is supported.

ControlByWeb Device address format

The format for the remote device is simply the IP address of the ControlByWeb device. The ControlByWeb hardware must have a static IP configured or DHCP reservation on the network so the IP address doesn't change unexpectedly.

image-1612543493002.png

The following data points are supported. Note that X indicates a there may be multiple data points of that type available (this depends on the model). For example, "countX" could be "count1", "count2", and so on.

frequency (frequency input)
vin (voltage powering the CBW device)
countX (pulse reading)
analogInputX (analog input value)
oneWireSensorX (one wire temperature sensors)
sensorXtemp (temperature sensors)
extvarX (external variable)
digitalIOX (binary digital IO value)

Although the eGauge can read from ControlByWeb devices, CBW hardware is not officially supported by eGauge Systems. For configuration questions on the CBW hardware itself, contact ControlByWeb directly

For questions regarding whether a specific ControlByWeb model is compatible with the eGauge, contact eGauge support directly