Skip to content

Data Model

The Voltimax IoT Platform uses a schema-driven data model defined in schemas/metrics/. All metric types, units, asset types, and profiles are generated from these JSON definitions - see Metrics Schema for the generation workflow.

This page documents the data model concepts that apply across the platform.

Metric Keys

Metric keys uniquely identify measurements using a hierarchical structure.

Format: domain.identifier or domain.identifier#scope

  • Domain - category of the metric (energy, battery, pcs, cooling, io)
  • Identifier - specific measurement name (voltage_ln, soc, active_power)
  • Scope - optional qualifier for three-phase systems or aggregates, separated by #

Examples:

text
energy.voltage_ln#l1      # Phase L1 line-to-neutral voltage
battery.soc               # Battery state of charge (no scope)
energy.active_power#sum   # Total active power across all phases

Scopes

Scopes expand a single metric definition into multiple variants for multi-phase electrical systems. Common values: sum (aggregated), l1/l2/l3 (per-phase), n (neutral), l1_l2/l2_l3/l3_l1 (line-to-line), t1/t2 (tariff periods). See Metrics Schema for the full explanation.

Units

The Unit enum provides standardized units of measurement (Watt, WattHour, Volt, Ampere, Hertz, Celsius, Percent, Ohm, Var, Va, Count). Units are defined in schemas/metrics/metrics.json and generated as the Unit enum in Voltimax.Iot.Contracts.

Asset Types

The platform supports these energy asset types: Grid, Building, Solar, Charger, Battery, Inverter, and Load. Asset types are defined in the contracts and determine which metric domains apply to a device.

Metric Domains

Metrics are organized into domains, each covering a specific aspect of energy asset telemetry:

  • Energy - three-phase electrical measurements: voltage, current, power (active/reactive/apparent), energy counters, power quality, frequency. See Energy Metrics Reference.
  • Battery - BMS telemetry: pack voltage/current/power, SoC, SoH, capacity, cycle count, cell statistics, environmental conditions. See Battery Metrics Reference.
  • PCS - inverter telemetry: running/grid state, DC and AC measurements, energy counters, device temperature. See PCS Metrics Reference.
  • Cooling - thermal management: chiller status, water temperature, pressure. See Cooling Metrics Reference.
  • I/O - digital I/O: safety switches, environmental sensors, fire suppression, equipment status. See I/O Metrics Reference.
  • Battery Alarms - alarm conditions with severity levels (0–4): cell voltage/temperature, over-current, isolation/communication faults. See Battery Alarm Metrics Reference.

Metric Profiles

Profiles group metrics by monitoring depth. Each metric is assigned a profile level in its registry definition:

  • Basic - essential operational metrics (e.g., SoC, total power, frequency, system status)
  • Standard - normal monitoring (e.g., per-phase values, temperatures, capacity tracking)
  • Advanced - detailed diagnostics (e.g., reactive/apparent power per phase, THD, cell-level data, insulation resistance)

Profiles are defined in schemas/metrics/metrics.json as the MetricProfile enum. The Metrics Reference pages list the profile assignment for each metric.