P1 MQTT API 1.0 documentation

Operations

SUB p1ams/{p1Id}/readouts

Real-time readouts from electricity meter

Operation IDreadoutOperation

Accepts the following message:

Readout messagereadoutMessage

application/json

Message IDreadoutMessage

object

uid: readoutSchema

cosen_name

string

Cosem name, empty if not available

voltage_l1

number | null

Voltage on phase L1. Null if not available.

voltage_l2

number | null

Voltage on phase L2. Null if not available.

voltage_l3

number | null

Voltage on phase L3. Null if not available.

current_l1

number | null

Current on phase L1. Null if not available.

current_l2

number | null

Current on phase L2. Null if not available.

current_l3

number | null

Current on phase L3. Null if not available.

import_power_active_l1

number | null

Active power imported on phase L1. Null if not available.

import_power_active_l2

number | null

Active power imported on phase L2. Null if not available.

import_power_active_l3

number | null

Active power imported on phase L3. Null if not available.

import_power_active

number | null

Total active power imported. Null if not available.

import_power_reactive_l1

number | null

Reactive power imported on phase L1. Null if not available.

import_power_reactive_l2

number | null

Reactive power imported on phase L2. Null if not available.

import_power_reactive_l3

number | null

Reactive power imported on phase L3. Null if not available.

import_power_reactive

number | null

Total reactive power imported. Null if not available.

export_power_reactive_l1

number | null

Reactive power exported on phase L1. Null if not available.

export_power_reactive_l2

number | null

Reactive power exported on phase L2. Null if not available.

export_power_reactive_l3

number | null

Reactive power exported on phase L3. Null if not available.

export_power_reactive

number | null

Total reactive power exported. Null if not available.

export_power_active_l1

number | null

Active power exported on phase L1. Null if not available.

export_power_active_l2

number | null

Active power exported on phase L2. Null if not available.

export_power_active_l3

number | null

Active power exported on phase L3. Null if not available.

export_power_active

number | null

Total active power exported. Null if not available.

import_energy_active

number | null

Total active energy imported. Null if not available.

import_energy_reactive

number | null

Total reactive energy imported. Null if not available.

export_energy_active

number | null

Total active energy exported. Null if not available.

export_energy_reactive

number | null

Total reactive energy exported. Null if not available.

import_power_active_1

number | null

Active power imported (tumbling 1-minute average).

export_power_active_1

number | null

Active power exported (tumbling 1-minute average).

import_power_active_15

number | null

Active power imported (tumbling 15-minute average).

export_power_active_15

number | null

Active power exported (tumbling 15-minute average).

frequency

number | null

Grid frequency in Hz. Null if not available.

off_grid

integer | null

Indicator for off-grid status.

error_communication

integer

Communication error code (0 = no error)

timestamp

integer

Unix epoch timestamp of the reading

Additional properties are allowed.

Examples

{
  "cosen_name": "",
  "voltage_l1": 234.4,
  "voltage_l2": 0,
  "voltage_l3": 0,
  "current_l1": 0,
  "current_l2": 0,
  "current_l3": 0,
  "import_power_active_l1": 0,
  "import_power_active_l2": 0,
  "import_power_active_l3": 0,
  "import_power_active": 0,
  "import_power_reactive_l1": 0,
  "import_power_reactive_l2": 0,
  "import_power_reactive_l3": 0,
  "import_power_reactive": 0,
  "export_power_reactive_l1": 0,
  "export_power_reactive_l2": 0,
  "export_power_reactive_l3": 0,
  "export_power_reactive": 0,
  "export_power_active_l1": 0,
  "export_power_active_l2": 0,
  "export_power_active_l3": 0,
  "export_power_active": 0,
  "import_energy_active": 0,
  "import_energy_reactive": 0,
  "export_energy_active": 0,
  "export_energy_reactive": 0,
  "import_power_active_1": 0,
  "export_power_active_1": 0,
  "import_power_active_15": 0,
  "export_power_active_15": 0,
  "frequency": null,
  "off_grid": null,
  "error_communication": 0,
  "timestamp": 1750458188
}

This example has been generated automatically.

Messages

#1Readout messagereadoutMessage

application/json

Message IDreadoutMessage

object

uid: readoutSchema

cosen_name

string

Cosem name, empty if not available

voltage_l1

number | null

Voltage on phase L1. Null if not available.

voltage_l2

number | null

Voltage on phase L2. Null if not available.

voltage_l3

number | null

Voltage on phase L3. Null if not available.

current_l1

number | null

Current on phase L1. Null if not available.

current_l2

number | null

Current on phase L2. Null if not available.

current_l3

number | null

Current on phase L3. Null if not available.

import_power_active_l1

number | null

Active power imported on phase L1. Null if not available.

import_power_active_l2

number | null

Active power imported on phase L2. Null if not available.

import_power_active_l3

number | null

Active power imported on phase L3. Null if not available.

import_power_active

number | null

Total active power imported. Null if not available.

import_power_reactive_l1

number | null

Reactive power imported on phase L1. Null if not available.

import_power_reactive_l2

number | null

Reactive power imported on phase L2. Null if not available.

import_power_reactive_l3

number | null

Reactive power imported on phase L3. Null if not available.

import_power_reactive

number | null

Total reactive power imported. Null if not available.

export_power_reactive_l1

number | null

Reactive power exported on phase L1. Null if not available.

export_power_reactive_l2

number | null

Reactive power exported on phase L2. Null if not available.

export_power_reactive_l3

number | null

Reactive power exported on phase L3. Null if not available.

export_power_reactive

number | null

Total reactive power exported. Null if not available.

export_power_active_l1

number | null

Active power exported on phase L1. Null if not available.

export_power_active_l2

number | null

Active power exported on phase L2. Null if not available.

export_power_active_l3

number | null

Active power exported on phase L3. Null if not available.

export_power_active

number | null

Total active power exported. Null if not available.

import_energy_active

number | null

Total active energy imported. Null if not available.

import_energy_reactive

number | null

Total reactive energy imported. Null if not available.

export_energy_active

number | null

Total active energy exported. Null if not available.

export_energy_reactive

number | null

Total reactive energy exported. Null if not available.

import_power_active_1

number | null

Active power imported (tumbling 1-minute average).

export_power_active_1

number | null

Active power exported (tumbling 1-minute average).

import_power_active_15

number | null

Active power imported (tumbling 15-minute average).

export_power_active_15

number | null

Active power exported (tumbling 15-minute average).

frequency

number | null

Grid frequency in Hz. Null if not available.

off_grid

integer | null

Indicator for off-grid status.

error_communication

integer

Communication error code (0 = no error)

timestamp

integer

Unix epoch timestamp of the reading

Additional properties are allowed.

Schemas

object

uid: readoutSchema

cosen_name

string

Cosem name, empty if not available

voltage_l1

number | null

Voltage on phase L1. Null if not available.

voltage_l2

number | null

Voltage on phase L2. Null if not available.

voltage_l3

number | null

Voltage on phase L3. Null if not available.

current_l1

number | null

Current on phase L1. Null if not available.

current_l2

number | null

Current on phase L2. Null if not available.

current_l3

number | null

Current on phase L3. Null if not available.

import_power_active_l1

number | null

Active power imported on phase L1. Null if not available.

import_power_active_l2

number | null

Active power imported on phase L2. Null if not available.

import_power_active_l3

number | null

Active power imported on phase L3. Null if not available.

import_power_active

number | null

Total active power imported. Null if not available.

import_power_reactive_l1

number | null

Reactive power imported on phase L1. Null if not available.

import_power_reactive_l2

number | null

Reactive power imported on phase L2. Null if not available.

import_power_reactive_l3

number | null

Reactive power imported on phase L3. Null if not available.

import_power_reactive

number | null

Total reactive power imported. Null if not available.

export_power_reactive_l1

number | null

Reactive power exported on phase L1. Null if not available.

export_power_reactive_l2

number | null

Reactive power exported on phase L2. Null if not available.

export_power_reactive_l3

number | null

Reactive power exported on phase L3. Null if not available.

export_power_reactive

number | null

Total reactive power exported. Null if not available.

export_power_active_l1

number | null

Active power exported on phase L1. Null if not available.

export_power_active_l2

number | null

Active power exported on phase L2. Null if not available.

export_power_active_l3

number | null

Active power exported on phase L3. Null if not available.

export_power_active

number | null

Total active power exported. Null if not available.

import_energy_active

number | null

Total active energy imported. Null if not available.

import_energy_reactive

number | null

Total reactive energy imported. Null if not available.

export_energy_active

number | null

Total active energy exported. Null if not available.

export_energy_reactive

number | null

Total reactive energy exported. Null if not available.

import_power_active_1

number | null

Active power imported (tumbling 1-minute average).

export_power_active_1

number | null

Active power exported (tumbling 1-minute average).

import_power_active_15

number | null

Active power imported (tumbling 15-minute average).

export_power_active_15

number | null

Active power exported (tumbling 15-minute average).

frequency

number | null

Grid frequency in Hz. Null if not available.

off_grid

integer | null

Indicator for off-grid status.

error_communication

integer

Communication error code (0 = no error)

timestamp

integer

Unix epoch timestamp of the reading

Additional properties are allowed.

P1 MQTT API 1.0

Servers

Security:

Operations

This example has been generated automatically.

Messages

Schemas