Entities

Customer

A customer is the entity that has operational access to one or more installations. When using the APIs or MQTT, access to a customer is granted through a service account.

Installation

An installation is the physical location where meters are installed. This is called a site in the administrative portal.

Meter

A meter is a logical metering point provided by either a physical metering device or a virtual calculation in the platform. A single physical device may provide measurements for multiple metering points. A metering point is usually the main energy supply for a building, a zone, or a specific appliance. Meters are organized in a hierarchy, and each meter keeps a reference to its parent.

Register

A register is a reference to a specific time series available for a meter. Each register has a type defining its content and behavior.

Time Series

A time series is a sequence holding meter readings data for a specific period of time. One time series includes the data of several meter readings for a specific register.

Label

A label is key-value metadata assigned to an entity by you, the user. This can be used to categorize and filter data based on your needs. Currently, this is supported for installations and meters. Labels can be managed through these endpoints:

/Installation/{id}/labels/{keys}
/Meters/{id}/labels/{keys}

Entity-Relationship Diagram

erDiagram
    CUSTOMER ||--o{ SERVICE_ACCOUNT : "related to"
    CUSTOMER ||--o{ INSTALLATION : ""
    CUSTOMER ||--o{ PORTAL_USER : "related to"

    INSTALLATION ||--o{ METER : ""
    METER ||--o{ REGISTER : ""
    REGISTER ||--o{ TIME_SERIES : ""