EcoPhi Portal

3.1 Quick Guide – Set up an EcoPhi Box

Note

This is a quick guide and implies that you already have experience with the portal as well as the installation of an EcoPhi Box. If this is your first setup, make sure to read the rest of the manual carefully.

1. Create a new Site for the project
   Go to Sites Overview, click “Add Site” and fill out the form.

2. Create a Data Source for the EcoPhi Box
   Go to the Site Details to the Site Settings Tab. Click “Add Data Source”. Make sure to enter the correct EcoPhi serial number, which is printed on the Box.

3. Add Components
   On the Site Settings Tab, click “Add Component”, select the Data Source, and fill out the form. Repeat this step for all Components.

3.2 Account Settings

You can find the account setting on the top navigation bar when you click on your user profile icon.

3.2.1 Change Account Settings

In your Account Settings, you can change your profile picture (avatar), name, email address, localization and theme.

Note

When you have made changes in the account settings page, don’t forget to click “Save” on the bottom of the page.

3.2.2 Change Password

On the bottom of the Account Settings page, enter your current password and new password and confirm with “Change password”.

3.2.3 Delete Account

Caution

Deleting your account will also delete all Entities of which you are the only Owner, together with all their data. This action is not reversible. If you don’t want the Entities to be deleted, make sure that there is at least one more Owner.

On the bottom of the Account Settings page, click “Yes, Delete”.

You will be required to confirm the deletion.

3.3 Site Management

3.3.1 Add a new Site

Watch this video to see how you can create new Sites:

Play

Note

Only Main Entities can create new Sites. If you are in a Sub-Entity, it is not possible to create a new Site.

Go to the „Sites Overview“ Tab on the left navigation bar and click the “Add Site” button on the top right.

Enter the name and an optional description. You can add labels to better filter and search your Sites.

Labels are Entity-wide, so once you have created a new label, it will be available for other Sites too. Either select an existing label or type in a new label. Enter the value and click the Check Button. To enter more labels, click ”+”. To delete a label, click on ”-” and delete the label(s).

To add a location, search for the address. The correct location will be matched with the system. You can change the display title, which will be shown in the Site Overview, to fit your required format.

Note

For proper analysis of the Site, make sure to select the correct address. The coordinates will be saved based on the location. These may be used for forecasting or performance checks.

Click “Add Site”.

Note

Creating a new Site may take a few seconds, as multiple steps are carried out in the background.

You will see the new Site in the Site Overview once it’s created.

3.3.2 Set Up and Configure a Site/Connect an EcoPhi Box

To set up your Site, you first need to add a Data Source and then add Components to the Data Source.

Go to the „Site Overview“ Tab and click on the Site go open the Site Detail View.

3.3.2.1 Add a Data Source/Add an EcoPhi Box

Watch this video to see how you can add Data Sources to a Site:

Play

In the Detail View of the Site, go to “Site Settings” -> Data Sources section and click “Add Data Source”.

• Source Type: Select “EcoPhi Device”.
• Name: Enter a name that clearly identifies the Data Source. You can optionally add labels for better searching and filtering.
• Serial number: Enter the EcoPhi Box serial number (starting with a lower-case m…). You can find the serial number written on one of the sides of the EcoPhi Box.

Click “Add Data Source”. You will now see the new Data Source.

3.3.2.2 Connection Settings (Connection Order and Wi-Fi Settings)

When the Data Source is created, you can configure the Wifi connection settings by clicking on the connection icon.

You can change the connection order (SIM, LAN and Wifi). The connection order defines how the box will try to establish a connection. In case if can’t establish a connection with the first priority, it will switch to the next one.

In case you are using a Wifi connection, you can enter the Wifi name and SSID password.

3.3.2.3 Add Optional Calculations

When you set up a Data Source, you can optionally define ecological and economical calculation factors, which are CO2 per kWh, Trees saved per kWh, Grid selling price and Grid buying price.

Note

The settings don’t have an effect on historical data. They are being used for calculations for all data that is being sent after the settings have been made.

3.3.2.4 Add Components/Connect Equipment to the EcoPhi Box

Watch this video to see how you can add Components to a Data Source:

Play

On the “Site Settings” tab, click “Add Component”.

Select the correct Data Source.

Enter a name that clearly identifies the Component.

You can optionally add labels for better searching and filtering.

Select the correct Component type from the list. Depending on the Component type, different settings need to be made.

Serial Components

Select the correct Equipment from the list, enter a read-out interval, enter the Modbus ID and an optional IP address and port.

The Role defines which system parameters are being monitored by the component and if it needs to be controlled as part of an automated Energy Management.

Example: An energy meter can be defined to measure the Grid, Load, Solar or Battery power. These measurements will then be reflected in the total system value.

Analog

Select the correct Equipment from the list. The range indicates the measurement range. Make sure to select the correct measurement range which matches your sensor specifications. The measurement range and sensor type is usually printed on the sensor.

Enter the read-out interval.

Enter the correct socket number. You can define the Component as an analog input or analog output.

Note

The socket number is the number printed on the EcoPhi distribution board of the EcoPhi Box (see also Device Manual).

Caution

The sensor must be connected to this exact socket on the distribution board of the EcoPhi Box.

Digital

Select the correct Equipment from the list. In case of a digital pulse sensor, make sure you select the equipment with the right pulse ratio.

Example: There a digital pulse water meters, which count 10, 100 or 1000 liters per pulse. Selecting the wrong pulse ratio will thus lead to wrong measurements.

Enter the read-out interval.

Enter the correct socket number. You can define the Component as a digital input or digital output.

Note

The socket number is the number printed on the EcoPhi distribution board of the EcoPhi Box (see also Device Manual).

Caution

The sensor must be connected to this exact socket on the distribution board of the EcoPhi Box.

3.3.3 Deleting and Updating Data Sources

Go to “Site Settings” -> Data Sources.

Click the Edit Data Source or Delete Data Source icon.

Note

If Components are added to a Data Source, you first need to delete the Components to be able to delete the Data Source.

3.3.4 Deleting and Updating Components

To delete or update Components, go to “Site Settings” -> Components. On the right side of the Component, click on the Edit Component or Delete Component icon.

3.3.5 Share a Site with a Sub-Entity

Note

Both the Site and the Sub-Entity need to exist before you can share a Site with a Sub-Entity.

Watch this video to see how you can share Sites with Sub-Entities:

Play

There are two methods to share a Site with a Sub-Entity.

Method 1 - Select Sites for Entity

Go to “Entity Settings” -> Sub-Entities. Click on the three dots of to the Sub-Entity that you want to share the Site with and click “Add Sites”.

Select the Site(s) that you want to share and click “Add Sites”.

Method 2 - Select Entities for Site

Go to the “Site Overview” and expand the Site by clicking the arrow on the left. In the bottom right navigation bar, click on the “Share Site” icon.

Select the Sub-Entity(ies) that you want to share the Site with and click “Share Site”.

3.3.6 Set and change action conditions parameters

Under the “Site Details” of a Site, go to the “Action Conditions” tab, where you can define action conditions such as controls and logic parameters. The availability depends on your specific project and if action conditions have been initially set up for your Site.

Example:

Once you have done the changed, click “Save”.

To undo the changes, click “Reset”.

Caution

Important: Once saved, the new parameters will directly be sent to the device, so make sure you have the correct settings before you save.

3.3.7 Edit an existing Site

Go to the „Site Overview“ Tab. Expand the Site by clicking on the arrow on the left.

On the right side of the bottom navigation bar of the Site, click the “Edit” icon.

Change the Site information and click “Update Site”.

3.3.8 Delete an existing Site

Caution

Deleting the Site will also delete all Components in this Site together with all their data.

Caution

This cannot be un-done, so make sure you really want to delete the Site.

Caution

All measurements and data will be deleted with the Site

Go to the „Site Overview“ Tab. Expand the Site by clicking on the arrow on the left.

On the right side of bottom navigation bar of the Site, click the “Delete this Site” icon.

You are required to confirm the deletion.

3.3.9 Create and use labels

Note

Labels can be used for Sites, Data Sources and Components. They allow you to add individual information and help to categorize and filter.

Note

Labels need to be defined before they can be used. Once they have been defined, they are available in the Entity and all Sub-Entities.

Labels are defined as Key-Value Pairs.

When you create or update a Site, Data Source or Component, you will see a section to add Labels.

To add a new Label, type in an individual Label name and click ”+ New category … ”. Enter the value and save the Label.

To select an existing Label, select the Label in the drop-down list, enter the value and save the Label.

3.4 Entity and Sub-Entity Management

3.4.1 Create a Sub-Entity

Watch this video to see how you can create Sub-Entities:

Play

Go to “Entity Settings” on the left navigation bar and open the Sub-Entities section.

You will see a list of all Sub-Entities. Click “Add Sub-Entity”.

A name is required.

You can add yourself as an Owner, if you want to manage the Sub-Entity. You can also invite other Owners via Email.

Note

At least one of the option has to be used, because a Sub-Entity always needs to have at least one Owner. A Sub-Entity can also have multiple Owners.

Select the required permissions:

• Edit Sites: If enabled, Sub-Entities can edit Sites, e.g. change Site name and information or add Data Sources and Components. Creating new Sites is not possible, as this can only be done by the Main Entity.
• Use Sub-Entities: If enabled, Sub-Entities can create own Sub-Entities and share Sites with their Sub-Entities.
• Use API Keys: Defines, if API keys can be created on the Sub-Entity level.

Click “Create Sub-Entity”.

3.4.2 Add an API Key

Watch this video to see how you can create and manage API keys:

Play

Go to “Entity Settings” on the left navigation bar and click on Manage API Keys.

You will see a list with already created API keys.

Click on “Create API Key”.

Define a name to identify the key. A description and an expiry date can be defined optionally.

Make sure you select the right permissions and click “Create Key”.

Note

In most cases, the API is used to retrieve measurement data from the EcoPhi portal. These permissions are already pre-selected. If you only want to use the API for data retrieval, you don’t need additional permissions.

A window will open with the API key. Copy the key to be able to use it.

Caution

Important: Once you close the window, you will not be able to see the key again, so make sure to copy and save it securely.

Note

You can find more information on the API and test the API endpoints with your key here: https://api.portal.ecophi.io/d/docs#/

Note

You can delete keys by clicking on the “Remove” icon on the API key list.

3.4.3 Create Alerts

Go to “Alerts” on the left navigation bar.

You will see a list of all the existing alerts for all Sites of the Entity.

Click on “Add Alert”. Fill out the form and click “Add Alert”.

Note

Alerts are defined per Entity and are not automatically inherited to Sub-Entities when a Site is shared.

3.5 User Management

Watch this video to see how you can invite members to your Entities:

Play

To add or manage a User for a specific Entity or Sub-Entity, you must switch to the respective Entity via the Entity Picker on the top right of the navigation bar.

3.5.1 Add new Users to an Entity or Sub-Entity

To change Entity settings and add users, you need to be logged in at the Entity.

Go to “Entity-Settings” -> Members and click “Invite member”.

Enter the Email address and select the Role. Click “Send invite”.

The user will receive an email to accept the invite. Once the user has accepted the invite, they are added as a member of the (Sub-)Entity.

3.5.2 Accept invites to a (Sub-)Entity

Users that have been invited to a (Sub-)Entity must accept the invite.

Hover over the Entity picker on the top right of the navigation bar and click on “Entity Memberships”.

You can also see open invitations on the welcoming page. Click on the logo on the top left to go to the welcoming page.

You will see the invites and existing memberships.

Accept or reject the invite.

3.5.3 Change the user permissions

Go to “Entity Settings” -> Members. On the right of the member entry, click “Edit Role”.

Select the Role and click “Update Access”.

3.5.4 Remove a user from an Entity

Go to “Entity Settings” -> Member section.

On the right of the member entry, click “Remove Membership”. You will be required to confirm the removal.

3.5.5 Create a new account

To create an account, go to the Sign-up page and click on “Don’t have an account? Sign-up here”.

Fill-in the name and password and click “Sign up”.

You will receive an email to verify your email address. Check your Spam, if you don’t receive a mail.

::note

If you haven’t received a mail, go to the Sign-Up page, click on “Verify E-mail”. :::

Enter your email address and click “Resend”.

3.6 Monitoring Dashboards

Go to “Site Overview” and click on the Site to open the Site Detail View.

In the Site Details, you can find several Tabs for monitoring and analyzing your data.

Overview: Here you can see the overview dashboard of your Site. The Overview dashboards aggregate the data of all Data Sources that belong to the Site.

Data Sources: Shows the dashboards of the Data Sources (e.g. the connected EcoPhi Boxes). Here you can see the detailed measurement data of all connected and configured Components.

Data Analyzer: Allows you to show and compare all raw measurement data that exists in the Site. You can select each Data Source and Component and select single or multiple measurement values.

Watch this video to see how to use the Data Analyzer:

Play

3.6.1 Changing the time range

Click on the time picker on the top right.

You can select a pre-defined time range or specify an individual time range. Depending on your location, you can also change the time settings.

You can also adjust the time range directly within a graph:

1. Hover over the graph.
2. Press and hold the left mouse button.
3. Drag the mouse to highlight the desired time range.
4. Release the mouse button to set the new time range.

3.6.2 Update the data

The dashboards update the data when they are being opened. Once open, the dashboards don’t automatically update by default.

To retrieve the latest data, click on the refresh button on the top right.

3.6.3 Show and hide data in a graph

You can select individual values within a graph by clicking on its name in the legend. To display all values again, click on its name once more.

To select multiple values simultaneously, hold down the Ctrl key (Cmd key on Mac) and then select the desired values by clicking on its names in the legend.

3.7 Data export as csv or Excel

You can download data for each panel in the dashboard. To download data as a csv or Excel file, first select the required time range on the dashboard. Go to the dashboard panel of which you want to download the data. Click on the three dots on the top right of the panel.

Go to “Inspect” -> “Data”.

Open the “Data options” section to select between formatted or raw data and to select headers for Excel. When you’re ready, click “Download CSV”.