v1

latestOpenAPI 3.0.02026-07-14643983.3 KB
Devices

Creates or updates a Device or updates it's values.

Creates or updates a Device or updates it's values. For a new device leave the ID empty. To create a device you have to set the DeviceEnergyType. To update values, add the ID of the device and the values you like to set. (See the Data Type Model for more Information)

post/api/Devices

Request body

ActivePowernumber double

The Active Power or current flow rate. In kW or m3/h

CounterReadingnumber double

The Meter Counter Reading (Total Energy used) in kWh or m3.

CounterReadingExportnumber double

The Meter Counter Reading only export

CounterReadingExportT1number double

The Meter Counter Reading only export (Tariff 1)

CounterReadingExportT2number double

The Meter Counter Reading only export (Tariff 2)

CounterReadingT1number double

The Meter Counter Reading Tariff 1 in kWh or m3.

CounterReadingT2number double

The Meter Counter Reading Tariff 2 in kWh or m3.

Currentnumber double

The Current (in A)

CurrentL1number double

The Current Phase L1 (in A)

CurrentL2number double

The Current Phase L2 (in A)

CurrentL3number double

The Current Phase L3 (in A)

DeviceEnergyType'MeterTypeUnknown' | 'MeterTypeElectricity' | 'MeterTypeWater' | 'MeterTypeGas' | 'MeterTypeHeat' | 'MeterTypeHCA' | 'MeterTypeAllMeters' | 'MeterTypeTemperature' | 'MeterTypeMBusGateway' | 'MeterTypeRS485Gateway' | 'MeterTypeCustomDevice' | 'MeterTypeCompressedAir' | 'MeterTypeSolarLog' | 'MeterTypeVirtualMeter' | 'MeterTypeWMBusGateway'

The Energy Type of this device

DigitalInput1boolean

The digital input number 1

Idstring

The ID of the device

MeterSubType'MeterSubTypeUnknown' | 'MeterSubTypeCold' | 'MeterSubTypeHeat' | 'MeterSubTypeChargingStation' | 'MeterSubTypeElectricity' | 'MeterSubTypeWater' | 'MeterSubTypeGas' | 'MeterSubTypeElectricityHeat' | 'MeterSubTypeTemperature' | 'MeterSubTypeVirtualBattery'

The Sub Type of this Meter.

Namestring

The Name of the Device

PowerFactornumber double

The Power Factor (cos phi). Range: 0 - 1

PowerFactorL1number double

The Power Factor (cos phi) Phase L1. Range: 0 - 1

PowerFactorL2number double

The Power Factor (cos phi) Phase L2. Range: 0 - 1

PowerFactorL3number double

The Power Factor (cos phi) Phase L3. Range: 0 - 1

Serialinteger

The Serial number

Temperaturenumber double

The Temperature (in degree celsius)

ValueDatestring date-time

The Date of the Value (in UTC). If this is null the Server Time is used.

Voltagenumber double

The Voltage (in V)

VoltageL1number double

The Voltage Phase L1 (in V)

VoltageL2number double

The Voltage Phase L2 (in V)

VoltageL3number double

The Voltage Phase L3 (in V)

Response

OK

ActivePowernumber double

The Active Power or current flow rate. In kW or m3/h

CounterReadingnumber double

The Meter Counter Reading (Total Energy used) in kWh or m3.

CounterReadingExportnumber double

The Meter Counter Reading only export

CounterReadingExportT1number double

The Meter Counter Reading only export (Tariff 1)

CounterReadingExportT2number double

The Meter Counter Reading only export (Tariff 2)

CounterReadingT1number double

The Meter Counter Reading Tariff 1 in kWh or m3.

CounterReadingT2number double

The Meter Counter Reading Tariff 2 in kWh or m3.

Currentnumber double

The Current (in A)

CurrentL1number double

The Current Phase L1 (in A)

CurrentL2number double

The Current Phase L2 (in A)

CurrentL3number double

The Current Phase L3 (in A)

DeviceEnergyType'MeterTypeUnknown' | 'MeterTypeElectricity' | 'MeterTypeWater' | 'MeterTypeGas' | 'MeterTypeHeat' | 'MeterTypeHCA' | 'MeterTypeAllMeters' | 'MeterTypeTemperature' | 'MeterTypeMBusGateway' | 'MeterTypeRS485Gateway' | 'MeterTypeCustomDevice' | 'MeterTypeCompressedAir' | 'MeterTypeSolarLog' | 'MeterTypeVirtualMeter' | 'MeterTypeWMBusGateway'

The Energy Type of this device

DigitalInput1boolean

The digital input number 1

Idstring

The ID of the device

MeterSubType'MeterSubTypeUnknown' | 'MeterSubTypeCold' | 'MeterSubTypeHeat' | 'MeterSubTypeChargingStation' | 'MeterSubTypeElectricity' | 'MeterSubTypeWater' | 'MeterSubTypeGas' | 'MeterSubTypeElectricityHeat' | 'MeterSubTypeTemperature' | 'MeterSubTypeVirtualBattery'

The Sub Type of this Meter.

Namestring

The Name of the Device

PowerFactornumber double

The Power Factor (cos phi). Range: 0 - 1

PowerFactorL1number double

The Power Factor (cos phi) Phase L1. Range: 0 - 1

PowerFactorL2number double

The Power Factor (cos phi) Phase L2. Range: 0 - 1

PowerFactorL3number double

The Power Factor (cos phi) Phase L3. Range: 0 - 1

Serialinteger

The Serial number

Temperaturenumber double

The Temperature (in degree celsius)

ValueDatestring date-time

The Date of the Value (in UTC). If this is null the Server Time is used.

Voltagenumber double

The Voltage (in V)

VoltageL1number double

The Voltage Phase L1 (in V)

VoltageL2number double

The Voltage Phase L2 (in V)

VoltageL3number double

The Voltage Phase L3 (in V)