Checking and upgrading firmware

Table of Contents

Overview
Checking Current Firmware Version
Updating Firmware
Video Tutorial
Updating Firmware Without an Internet Connection

Overview

eGauge releases periodic firmware updates to address bugs, add functionality, and address security issues. Depending on the nature of the issue, a firmware update may be the first step recommended by technical support. In addition, many CT definitions only exist in newer firmware versions. Applying a firmware update requires a valid username and password for the eGauge meter in question.

Full firmware release notes are available at https://egauge.net/revs

Checking Current Firmware Version

The current firmware version of a device can be seen by clicking View > Device Status from the menu, or visiting http://DEVNAME.egaug.es/status.html (replace DEVNAME with the device name of your eGauge). The current firmware version will be listed next to Firmware:

 

Sample Status Page

Updating Firmware

To update the firmware on an eGauge meter:

1. Navigate to Tools -> Firmware Upgrade
2. Click the "Upgrade Firmware" button (shown below)

image-1598461848451.png

3. The eGauge may prompt for user credentials
4. The firmware update process will begin. This typically takes about five minutes on a reasonable connection.

image-1598461918716.png

5. After the firmware is updated, the meter will automatically reboot. If the update is run but the meter firmware matches the latest firmware, the meter will display an error message instead - this is normal.

If the meter does not automatically reboot after a firmware update, you can reboot the meter manually under Tools -> Reboot. This is required, as failing to reboot after a firmware update can cause issues with the UI or other elements of the meter.

Updating from an extremely old firmware to the current firmware (generally anything prior to firmware version 2.15) can cause display issues. It may be necessary to clear your browser cache after updating from an older firmware version to the latest version.

 

Video Tutorial

A video tutorial is also available:

 

Updating Firmware Without an Internet Connection

 

Offline Firmware Updates

From firmware 2.02 onward, the EG30xx and EG4xxx model lines support offline firmware updates. Normally, when a firmware update is started the eGauge will reach out to egauge.net, download the latest firmware, apply the update, and reboot. However, in cases where egauge.net is not accessible (for example, meters installed on tightly secured networks or at sites without an internet connection) it is possible to perform an offline firmware update.

Meters on firmware older than version 4.0.4 may have issues with offline firmware updates and will require an internet connection to update. Once updated past version 4.0.4, offline updates will work as normal.

 

Obtaining the firmware update file

In order to utilize offline firmware updates, an egauge.net account is required. The device to be updated must be in the user's eGuard portfolio. For more details on using eGuard, refer to this article.

Navigate to the device page for the meter to be updated. To access the device page, click the square icon to the left of the device name shown in the eGuard portfolio listing.

image-1596466978112.png

Note that firmware files are linked to specific meters - it will be necessary to download a firmware update file for each meter. A firmware update file for a specific meter is not guaranteed to be compatible with any other meters.

Once on the device page, click the "Download Firmware" button to download the latest firmware file for that device.

image-1596467021231.png

Make a note of where the file is downloaded - this will be needed later. 

 

Applying the firmware update file

Connect to the eGauge interface. Assuming the meter is offline (not connected to the proxy server), this can be done via a direct connection or by connecting to the eGauge via IP address or hostname from a computer on the same network as the meter.

Navigate to Tools -> Firmware Upgrade (shown below).

image-1596467457087.png

Select "Choose File". A separate window will open. Navigate to the location of the downloaded firmware file and select the file. The page will update to show the name of the firmware update file to the right of the "Choose File" button.

image-1596467585859.png

The firmware upload will start (this may take a few minutes, even on a direct connection). Once the file has been uploaded, the eGauge will automatically update the firmware and reboot. Note that the meter may take up to five minutes to reconnect after a reboot.

If the meter does not automatically reboot after a firmware update, you can reboot the meter manually under Tools -> Reboot. This is required, as failing to reboot after a firmware update can cause issues with the UI or other elements of the meter.