Sign in

v1

latestOpenAPI 3.0.02026-07-14643983.3 KB
VirtualBillingMeterActive

Beta: Virtual Meter API: Activates a Meter and add the Consumption to a Virtual Meter assosiated with the User.

Beta: Virtual Meter API: Activates a Meter and add the Consumption to a Virtual Meter assosiated with the User.

post/api/VirtualBillingMeterActive

Request body

SerialNumberstring

The Serialnumber of the Meter to activate.

Response

OK

ActivePowernumber double

The Actvie Power or current flow rate

ActivePowerL1number double

The Actvie Power Phase L1

ActivePowerL2number double

The Actvie Power Phase L2

ActivePowerL3number double

The Actvie Power Phase L3

ActivePowerUnitstring

The Unit of the Active Power Value

ActiveTariffinteger

The Number of the Active Tariff

AdditionalMeterSerialNumberstring

An additional Meter serial number. e.g. the number of a meter a smart-me device is connected to.

AnalogOutput1integer

The analog output number 1 (PWM signal) (0 - 32183)

AnalogOutput2integer

The analog output number 2 (PWM signal) (0 - 32183)

ChargingStationState'Booting' | 'ReadyNoCarConnected' | 'ReadyCarConnected' | 'StartedWaitForCar' | 'Charging' | 'Installation' | 'Authorize' | 'Offline'

The state of a pico charging station. (Only available for pico charging stations)

CounterReadingnumber double

The Meter Counter Reading (Total Energy used)

CounterReadingExportnumber double

The Meter Counter Reading only export

CounterReadingImportnumber double

The Meter Counter Reading only import

CounterReadingT1number double

The Meter Counter Reading Tariff 1

CounterReadingT2number double

The Meter Counter Reading Tariff 2

CounterReadingT3number double

The Meter Counter Reading Tariff 3

CounterReadingT4number double

The Meter Counter Reading Tariff 4

CounterReadingUnitstring

The Unit of the Counter Reading

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

DigitalInput2boolean

The digital input number 2

DigitalOutput1boolean

The digital output number 1

DigitalOutput2boolean

The digital output number 2

FamilyType'MeterFamilyTypeUnknown' | 'MeterFamilyTypeSmartMeConnectV1' | 'MeterFamiliyTypeSmartMeMeter' | 'MeterFamiliyTypeSmartMeMeterWithSwitch' | 'MeterFamilyTypeMBusGatewayV1' | 'MeterFamilyTypeRS485GatewayV1' | 'MeterFamilyTypeKamstrupModule' | 'MeterFamilyTypeSmartMe3PhaseMeter80A' | 'MeterFamilyTypeSmartMe3PhaseMeter32A' | 'MeterFamilyTypeSmartMe3PhaseTelstarTransformer' | 'MeterFamilyTypeLandisGyrModule' | 'MeterFamilyTypeFnnOpticalModule' | 'MeterFamilyTypeSmartMe3PhaseTelstar80AWiFi' | 'MeterFamilyTypeSmartMe3PhaseTelstar80AMobile' | 'MeterFamilyTypeSmartMe1PhaseMeter80AV2WiFi' | 'MeterFamilyTypeSmartMe1PhaseMeter32AV2WiFi' | 'MeterFamilyTypeSmartMe1PhaseMeter80AGprs' | 'MeterFamilyTypeSmartMe1PhaseMeter32AGprs' | 'MeterFamilyTypeWMBusGatewayV1' | 'MeterFamilyTypeSmartMe3PhaseTelstarTransformerMobile' | 'MeterFamilyTypeMithralHallV1' | 'MeterFamilyTypeRestApiMeter' | 'MeterFamilyTypeVirtualBillingMeter'

The Family Type of the device.

FlowRatenumber double

The current flow rate (e.g. m3/h)

Idstring

The ID of the device

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

The sub meter type (e.g. warmwater or coldwater)

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

SwitchOnboolean

Flag if the Switch is on on this device.

SwitchPhaseL1Onboolean

Flag if the Phase L1 is on on this device.

SwitchPhaseL2Onboolean

Flag if the Phase L2 is on on this device.

SwitchPhaseL3Onboolean

Flag if the Phase L3 is on on this device.

Temperaturenumber double

The Temperature (in degree celsius)

ValueDatestring date-time

Time of last successful connection the the smart-me Cloud.

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)