# eGuard Overview

<p class="callout success">There's a lot in eGuard! Additional documentation can be found in the <span style="text-decoration: underline;">**[eGuard Fundamentals](https://kb.egauge.net/books/eguard-portfolio-manager/chapter/eguard-fundamentals)**</span> chapter.</p>

## eGuard Overview

eGuard is an administrative management system for eGauge devices that allows an individual to monitor and manage multiple eGauge meters from a single web interface.

<table border="0" id="bkmrk-eguard-portfolio" style="width: 100%; border-collapse: collapse; border-style: hidden;"><tbody><tr><td style="width: 100%;">[![eguard-sunnyvale-portfolio.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/eguard-sunnyvale-portfolio.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/eguard-sunnyvale-portfolio.png)</td></tr><tr><td class="align-center" style="width: 100%;">*eGuard Portfolio for group "Sunnyvale"* </td></tr></tbody></table>

The eGuard interface allows you to view the current status and statistics for all devices you have rights to. With proper authorization, you can also use eGuard to enable remote administration, create device notes, assign and manage groups, monitor device uptime, and check production and/or usage statistics.

eGuard can also generate alerts to inform users of device connectivity issues, low production, high usage, and incorrect time settings.

Devices can be added to groups or sites. Groups can be used to allow other eGuard users to monitor and administer specific devices, while sites allow devices to be organized based on installation location.

To access eGuard, you will need to create an account at eGauge.net. Log in using the green login button at the top of the page. After logging in, the login button will change to a drop down menu. All eGuard functions (as well as other functions outside of the scope of this document) can be found here.

### Who is eGuard For?

eGuard is a complementary tool for those who need to manage five or more eGauge devices. eGuard provides quick and direct access to device status information. eGauge highly recommends that any new customer ordering more than five eGauges contact the eGauge support department at support@egauge.net to set up an eGuard account. Newly purchased devices are added to eGuard automatically, before they are shipped.

Use eGuard as a Customer Relationship Management (CRM) tool or in conjunction with other CRM software to identify and address issues quickly and efficiently. Note that eGuard is a tool intended for installers and site administrators and is not intended for use by the average end user. No additional information is provided through eGuard that cannot also be obtained through the eGauge interface directly.

### Signing up for eGuard

Please see [this article](https://kb.egauge.net/books/eguard-porfolio-manager/page/signing-up-for-an-eguard-account-and-requesting-access) for information on signing up for eGuard and obtaining access to a group of devices.

### eGuard Functionality

#### Portfolio (main view)

The eGuard Table page is the main summary area for eGuard. This page presents a table of devices associated with your username. The data on the page is updated hourly.

##### Top Menu Bar

The top menu bar (below the Portfolio/Permissions/Groups/Alerts/Sites tab bar) has several functions:

<table border="1" id="bkmrk-register-a-new-egaug" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 28.0247%;">[![image-1593460380689.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/image-1593460380689.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/image-1593460380689.png)

</td><td style="width: 71.9753%;">[Register a new eGauge](https://kb.egauge.net/link/168#bkmrk-adding-devices-to-gr) meter and bring into account.</td></tr><tr><td style="width: 28.0247%;">[![image-1593460425527.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/image-1593460425527.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/image-1593460425527.png)

</td><td style="width: 71.9753%;">Choose to display only one of your owned groups, or sub-groups.</td></tr><tr><td style="width: 28.0247%;">[![image-1593460458668.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/image-1593460458668.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/image-1593460458668.png)

</td><td style="width: 71.9753%;">Display average wattage in the summary table.</td></tr><tr><td style="width: 28.0247%;">[![image-1593460479820.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/image-1593460479820.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/image-1593460479820.png)

</td><td style="width: 71.9753%;">Display total kWh values in the summary table.</td></tr><tr><td style="width: 28.0247%;">[![image-1593460509092.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/image-1593460509092.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/image-1593460509092.png)

</td><td style="width: 71.9753%;">Hide or show columns/fields.</td></tr><tr><td style="width: 28.0247%;">[![image-1593460528979.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/image-1593460528979.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/image-1593460528979.png)

</td><td style="width: 71.9753%;">Enable group-by device view which shows group separator row and groups by Group/Subgroup, Job name, or Owner (registrant).</td></tr><tr><td style="width: 28.0247%;">[![image-1593460638822.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/image-1593460638822.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/image-1593460638822.png)

</td><td style="width: 71.9753%;">Perform a [mass CSV export](https://kb.egauge.net/books/eguard-porfolio-manager/page/mass-csv-export "Mass CSV export") of devices in portfolio.</td></tr></tbody></table>

##### Device filter (search)

On the right-hand side of the page there is a device filter (search) function. Any devices listed in the table can be filtered for text found in the name, job, and other fields.

<table border="1" id="bkmrk-enter-your-search-te" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 29.0123%;">[![image-1593461106165.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/image-1593461106165.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/image-1593461106165.png)

</td><td style="width: 70.9877%;">Enter your search text here.</td></tr><tr><td style="width: 29.0123%;">[![image-1593461121942.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/image-1593461121942.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/image-1593461121942.png)

</td><td style="width: 70.9877%;">Advanced search: also enter specific Group, Job, Owner and other field filters.</td></tr><tr><td style="width: 29.0123%;">[![image-1593461181558.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/image-1593461181558.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/image-1593461181558.png)

</td><td style="width: 70.9877%;">Hide/show the "Showing *N* to *X* of *Y* records" and "*N* records per page" option.</td></tr><tr><td style="width: 29.0123%;">[![image-1593461258479.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/image-1593461258479.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/image-1593461258479.png)

</td><td style="width: 70.9877%;">Multi-level sorting function.</td></tr></tbody></table>

##### Main Table Data

<table border="0" id="bkmrk-eguard-portfolio-for" style="width: 100%; border-collapse: collapse; border-style: hidden; height: 274px;"><tbody><tr style="height: 246px;"><td style="width: 100%; height: 246px;">[![eguard-sunnyvale-portfolio.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/eguard-sunnyvale-portfolio.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/eguard-sunnyvale-portfolio.png)</td></tr><tr style="height: 28px;"><td class="align-center" style="width: 100%; height: 28px;">*eGuard Portfolio for group "Sunnyvale"*</td></tr></tbody></table>

**The following columns are available to display data for the devices.**

<table border="1" id="bkmrk-group-each-device-be" style="border-collapse: collapse; width: 100%; height: 834px;"><tbody><tr style="height: 147px;"><td style="width: 16.0494%; height: 147px;">Group</td><td style="width: 83.9506%; height: 147px;">Each device belongs to a group. A single user can administer multiple groups, and each group can contain multiple subgroups (which can then be shared with other users). Permission required: Administrator or Manager.

To the left of the group name is a Group Editor button. Clicking this button will allow the user to make or change group assignment if they have appropriate permissions (Administrator or Manager).

</td></tr><tr style="height: 46px;"><td style="width: 16.0494%; height: 46px;">Job</td><td style="width: 83.9506%; height: 46px;">This value is set on the Device Details Page and allows the user to identify the specific job of an meter, if desired. This value does not need to be unique for each eGauge.</td></tr><tr style="height: 63px;"><td style="width: 16.0494%; height: 63px;">Owner</td><td style="width: 83.9506%; height: 63px;">User who registered this device. This may or may not be the same as the eGuard administrator. For example, a device might be administered by “Installer” but owned by “Homeowner”. This value will be blank if the device is not registered</td></tr><tr style="height: 169px;"><td style="width: 16.0494%; height: 169px;">Name</td><td style="width: 83.9506%; height: 169px;">The name of the eGauge meter. This can only be changed by contacting eGauge directly, and is guaranteed to be unique. The name itself is also a link to that eGauges user interface (provided the device is online).

A notepad icon appears to the left of the Name. When clicked, it will open the Device Details Page for the eGauge adjacent to the button. Job name and notes can be edited here, as well as certain actions like password resets.

</td></tr><tr style="height: 46px;"><td style="width: 16.0494%; height: 46px;">Map</td><td style="width: 83.9506%; height: 46px;">If a meter has latitude and longitude set in Settings -&gt; General Settings, this column will display a globe icon. When clicked, a map centered on the location of the device will load in a new window.</td></tr><tr style="height: 126px;"><td style="width: 16.0494%; height: 126px;">Status</td><td style="width: 83.9506%; height: 126px;">Shows whether the eGauge was on the proxy during the most recent check by eGuard.

<p class="callout info">This value updates once an hour, so it is not guaranteed to show if a meter is currently available or not.</p>

</td></tr><tr style="height: 63px;"><td style="width: 16.0494%; height: 63px;">Availability</td><td style="width: 83.9506%; height: 63px;">Describes the device uptime over the past five days as a percentage. Hovering the mouse cursor over the percentage will cause a popup to display with an hourly uptime chart, as well as the last seen date and time.</td></tr><tr style="height: 46px;"><td style="width: 16.0494%; height: 46px;">Temp</td><td style="width: 83.9506%; height: 46px;">Device internal operating temperature. This should not be confused with ambient temp, and will almost always be warmer.</td></tr><tr style="height: 46px;"><td style="width: 16.0494%; height: 46px;">Link Quality</td><td style="width: 83.9506%; height: 46px;">Connection quality reported by eGauge. Will show 100% for Ethernet. HomePlug and WiFi/cell may show various values.</td></tr><tr style="height: 53px;"><td style="width: 16.0494%; height: 53px;">Firmware</td><td style="width: 83.9506%; height: 53px;">Shows current firmware version for a given device. Versions listed in red should be up-graded as major bug fixes and patches have been implemented in newer firmware, please [update firmware](https://kb.egauge.net/books/egauge-meter-ui/page/checking-and-upgrading-firmware) in this case.</td></tr><tr style="height: 29px;"><td style="width: 16.0494%; height: 29px;">Model</td><td style="width: 83.9506%; height: 29px;">The model of the eGauge unit. May be blank on older model eGauge2 units.</td></tr><tr><td style="width: 16.0494%;">Power/Energy Values</td><td style="width: 83.9506%;">The right-hand side of the table displays either average wattage (kW) or total energy (kWh) depending on what is selected in the [top menu bar](https://kb.egauge.net/link/203#bkmrk-top-menu-bar). These values reflect the Usage and Generation virtual registers configured on the meter.</td></tr></tbody></table>

##### Device Details Page

The *Device Details Page* is a summary and control area for a specific eGauge meter. Each meter will have its own device page, regardless of whether it is in a group or site with other meters. Use caution when changing settings on the device page, as it is possible to overwrite settings and user credentials.

The device details page can be accessed by clicking the notepad icon to the left of the device name in the eGuard Portfolio table, shown in the red circle:

[![image-1644272797714.png](https://kb.egauge.net/uploads/images/gallery/2022-02/scaled-1680-/image-1644272797714.png)](https://kb.egauge.net/uploads/images/gallery/2022-02/image-1644272797714.png)

<table border="0" id="bkmrk-device-details-page-" style="width: 100%; border-collapse: collapse; border-style: hidden;"><tbody><tr><td style="width: 100%;">[![image-1593467514436.png](https://kb.egauge.net/uploads/images/gallery/2020-06/scaled-1680-/image-1593467514436.png)](https://kb.egauge.net/uploads/images/gallery/2020-06/image-1593467514436.png)

</td></tr><tr><td class="align-center" style="width: 100%;">*Device Details Page for eGauge9995*</td></tr></tbody></table>

**The following information and functions are available on the Device Details page (some information may not be available on lower privileges than admin)**

<table border="1" id="bkmrk-%22you-are-an-admin-fo" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 50%;">"You are an admin for this device"</td><td style="width: 50%;">Shows your user level for the device, and some additional information about it.

**Data For Device**: Opens eGuard portfolio view with only that device.

**Reset Password**: A random password can be generated for the selected user account.

</td></tr><tr><td style="width: 50%;">Privileged Device Info</td><td style="width: 50%;">Shows privileged device information such as MAC(s) and serial numbers for device.</td></tr><tr><td style="width: 50%;">Remote Administration Control</td><td style="width: 50%;">Enables or Disables remote administration for the first [user configured](https://kb.egauge.net/books/egauge-meter-ui/page/creating-or-changing-usernames-and-passwords) on the eGauge.</td></tr><tr><td style="width: 50%;">Firmware</td><td style="width: 50%;">Download [firmware](https://kb.egauge.net/books/egauge-meter-ui/page/checking-and-upgrading-firmware) files for EG3xxx and EG4xxx for manual upgrades via interface or USB.</td></tr><tr><td style="width: 50%;">Remote Configuration Control</td><td style="width: 50%;">Allows a different device's configuration to be copied to this device, assuming the other device is in the user's group and both are online, same model and sufficient registers.</td></tr><tr><td style="width: 50%;">Job Name</td><td style="width: 50%;">This is the Job name that shows up in the eGuard portfolio view.</td></tr><tr><td style="width: 50%;">Installer Notes</td><td style="width: 50%;">Custom notes may be added and associated with the device.</td></tr><tr><td style="width: 50%;">Create Site Info</td><td style="width: 50%;">Create a new [site](https://kb.egauge.net/books/eguard-porfolio-manager/page/eguard-sites) and link device to it.</td></tr><tr><td style="width: 50%;">Link eGauge9995 to an Existing Site</td><td style="width: 50%;">If a [site](https://kb.egauge.net/books/eguard-porfolio-manager/page/eguard-sites) already exists, link device to it.</td></tr></tbody></table>

#### Groups

See the [eGuard Groups article](https://kb.egauge.net/books/eguard-porfolio-manager/page/eguard-groups).

#### Permissions

See the [eGuard Permissions article](https://kb.egauge.net/books/eguard-porfolio-manager/page/eguard-permissions).

#### Alerts

See the [eGuard Alerts article](https://kb.egauge.net/books/eguard-porfolio-manager/page/eguard-alerts).

#### Sites

See the [eGuard Sites article](https://kb.egauge.net/books/eguard-porfolio-manager/page/eguard-sites).