Skip to content
Manuals and Docs

EcoPhi Portal

3 Manual

3.1 Quick Guide – Set up an EcoPhi Box

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

3.2.1 Change Account Settings

In your Account Settings, you can change your avatar (profile picture), name, email address, localization, and theme.
When you have made changes on 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, then confirm with “Change password”.

3.2.3 Delete Account

Note: Deleting your account will also delete all Entities where you are the only Owner, together with all their data. This action is not reversible.

  1. On the bottom of the Account Settings page, click “Yes, Delete”.
  2. You will be required to confirm the deletion.

3.3 Site Management

3.3.1 Add a New Site

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

  1. Go to the “Sites Overview” tab on the left navigation bar and click the + button on the top right.
  2. Enter the name and an optional description.
  3. Add labels to better filter and search your Sites. Labels are Entity-wide.
  4. Add a location by searching for the address. Ensure the correct location is selected, as it affects analysis and performance checks.
  5. 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, first add a Data Source, then add Components to the Data Source.

3.3.2.1 Add a Data Source/Add an EcoPhi Box
  1. Go to “Site Settings” -> Data Sources section and click +.
  2. Select “EcoPhi Device” as the source type.
  3. Enter a name that identifies the Data Source clearly.
  4. Optionally, add labels for searching and filtering.
  5. Enter the EcoPhi Box serial number (starting with a lowercase m).
  6. Click “Add Data Source”.
3.3.2.2 Connection Settings (Connection Order and Wi-Fi Settings)
  1. Configure the Wi-Fi connection settings by clicking on the connection icon.
  2. Change the connection order (e.g., SIM, LAN, Wi-Fi).
  3. For Wi-Fi, enter the Wi-Fi name and SSID password.
3.3.2.3 Add Optional Calculations

Define ecological and economical calculation factors (e.g., CO2 per kWh, Trees saved per kWh, Grid selling price).

Note: These settings apply to new data sent after configuration, not historical data.

3.3.2.4 Add Components/Connect Equipment to the EcoPhi Box
  1. On the “Site Settings” tab, click +.
  2. Select the correct Data Source.
  3. Enter a name that identifies the Component clearly.
  4. Optionally, add labels for searching and filtering.
  5. Select the Component type (e.g., Serial, Analog, or Digital).

3.3.3 Deleting and Updating Data Sources

  1. Go to “Site Settings” -> Data Sources.
  2. Click the Edit or Delete icon next to the Data Source.

Note: You must delete Components associated with a Data Source before deleting the Data Source.

3.3.4 Deleting and Updating Components

  1. Go to “Site Settings” -> Components.
  2. Click the Edit or Delete icon next to the Component.

3.3.5 Share a Site with a Sub-Entity

Both the Site and the Sub-Entity must exist before sharing.

Method 1:

  1. Go to “Entity Settings” -> Sub-Entities.
  2. Click the three dots next to the Sub-Entity and select “Add Sites”.
  3. Choose the Sites and confirm.

Method 2:

  1. Go to “Site Overview”.
  2. Expand the Site and click the “Share Site” icon.
  3. Select the Sub-Entities and confirm.

3.3.6 Set and Change Action Conditions Parameters

  1. Go to “Site Details” -> “Action Conditions” tab.
  2. Define or adjust action conditions (e.g., controls, logic parameters).

Important: Saved changes are immediately applied to the device.

3.3.7 Edit an Existing Site

  1. Go to the “Site Overview” tab.
  2. Expand the Site by clicking the arrow on the left.
  3. On the bottom navigation bar, click the “Edit” icon.
  4. Change the Site information and click “Update Site”.

3.3.8 Delete an Existing Site

Important: Deleting a Site will delete all Components in this Site, together with all their data. This action cannot be undone.

  1. Go to the “Site Overview” tab.
  2. Expand the Site by clicking the arrow on the left.
  3. On the bottom navigation bar, click the “Delete this Site” icon.
  4. Confirm the deletion.

3.3.9 Create and Use Labels

Labels can be used for Sites, Data Sources, and Components. They help to categorize and filter.

  1. Define labels as Key-Value Pairs when creating or updating a Site, Data Source, or Component.
  2. To add a new label, type a label name, click ”+ New category …”, and enter the value.
  3. To use an existing label, select it from the dropdown and save.

3.4 Entity and Sub-Entity Management

3.4.1 Switching to Different Entities/Sub-Entities

Use the Entity picker on the top right to switch between Entities and Sub-Entities you are a member of.

3.4.2 Create a Sub-Entity

  1. Go to “Entity Settings” -> Sub-Entities.
  2. Click + to add a new Sub-Entity.
  3. Enter a name and assign at least one Owner. You can also invite other Owners via email.
  4. Select the required permissions:
    • Edit Sites: Allows Sub-Entities to edit Sites but not create new ones.
    • Use Sub-Entities: Allows Sub-Entities to create their own Sub-Entities.
    • Use API Keys: Allows creation of API keys at the Sub-Entity level.
  5. Click “Create Sub-Entity”.

3.4.3 Add an API Key

  1. Go to “Entity Settings” -> Manage API Keys.
  2. Click “Create API Key”.
  3. Enter a name and optional description or expiry date.
  4. Select permissions and click “Create Key”.
  5. Copy the API key. Note: You won’t be able to view it again after closing the window.

3.4.4 Create Alerts

  1. Go to “Alerts” on the left navigation bar.
  2. Click “Add Alert”.
  3. Fill out the form and click “Add Alert”.

Note: Alerts are Entity-wide and not automatically inherited by Sub-Entities.

3.5 User Management

3.5.1 Add New Users to an Entity or Sub-Entity

  1. Go to “Entity Settings” -> Members.
  2. Click + to invite a user.
  3. Enter the email address, select the Role, and click “Send Invite”.
  4. The user will receive an invitation email to accept.

3.5.2 Accept Invites to a (Sub-)Entity

  1. Hover over the Entity picker on the top right and click “Entity Memberships”.
  2. View open invitations and accept or reject them.

3.5.3 Change User Permissions

  1. Go to “Entity Settings” -> Members.
  2. Click “Edit Role” next to the member.
  3. Select the new Role and click “Update”.

3.5.4 Remove a User from an Entity

  1. Go to “Entity Settings” -> Members.
  2. Click “Remove Membership” next to the user and confirm.

3.5.5 Create a New Account

  1. Go to the Sign-Up page and click “Don’t have an account? Sign-up here”.
  2. Fill in your name and password, then click “Sign Up”.
  3. Verify your email address using the confirmation email.

3.6 Monitoring Dashboards

3.6.1 Changing the Time Range

  1. Use the time picker on the top right to select a predefined or custom range.
  2. Adjust the time range directly within a graph:
    • Hover over the graph.
    • Press and hold the left mouse button, drag to highlight the desired range, and release.

3.6.2 Update the Data

Dashboards update when opened. To refresh manually, click the refresh button on the top right.

3.6.3 Show and Hide Data in a Graph

  1. Click on a value’s name in the legend to show/hide it.
  2. To select multiple values, hold Ctrl (Cmd on Mac) and click the names.

3.7 Download Data as CSV or Excel

  1. Select the required time range on the dashboard.
  2. Click the three dots on the top right of the panel.
  3. Go to “Inspect” -> “Data”.
  4. Select data options (e.g., formatted or raw data, headers for Excel).
  5. Click “Download CSV”.

EcoPhi Renewables Engineering GmbH

Alter Schlachthof 33
76131 Karlsruhe
www.ecophi.io