Glossary
This section defines key terms used throughout the API documentation to ensure a clear and consistent understanding.
| Term | Description |
|---|---|
| Cluster | A cluster apartment made up of multiple en suite bedrooms that share a communal living, kitchen, and dining area (LKD). Linked by a shared clusterId. |
| Cluster ID | The identifier used to group spaces (e.g. bedrooms and shared LKDs) that belong to the same cluster apartment. |
| Device ID | The internal identifier used in API requests to reference a specific device. This is returned in lookups and other endpoints. |
| Device Identifier | A unique identifier used for sending and receiving network commands. Distinct from the internal {device_id} used in API endpoints. |
| Estimated Electricity | An estimate of electricity consumption based on usage of the Utopi smart panel heater. Not equivalent to actual metered electricity consumption. |
| Interval | The time bucket used for grouping readings in a time series. Supported values include 1 hour and 15 minutes. |
| LKD | Abbreviation for Living, Kitchen, and Dining - the shared communal space in a cluster apartment. |
| Metric | A type of environmental or utility measurement (e.g. temperature, humidity, CO₂, estimated electricity, water). |
| Reading | A recorded value for a metric at a specific timestamp. Readings are retrieved in time series format. |
| Site | A building or collection of buildings managed as a single location (e.g. a PBSA development or BTR property). |
| Space | A single apartment, bedroom, or other defined area within a site. |
| Space Type | The classification of a space based on its use, such as studio apartment, penthouse, or communal area. |