Power Meter — Metadata

Subscribe to BMS-published metadata for all PowerMeter points.

Direction: Subscribe (receive)

Channel

BMS/v1/PUB/Metadata/PowerMeter/{pointType}/{tagPath}

BMS-published metadata for all PowerMeter points.

MQTT wildcard examples

All power meter metadata: BMS/v1/PUB/Metadata/PowerMeter/#

Parameters

Parameter	Description
`pointType`	PowerMeter point type. Values: `Voltage`, `PowerFactor`, `Frequency`, `ApparentPower`, `ActivePower`, `Current` … (9 total)
`tagPath`	Vendor-defined hierarchical tag path.

Message: PowerMeter Voltage Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `PowerMeter`
`pointType`	string	Yes	Values: `Voltage`
`objectName`	string	Yes	Human-readable name of the electrical device.
`objectId`	string	Yes	Stable unique identifier for the electrical device.
`servesId`	array<string>	Yes	List of objectIds of entities served by this power meter.
`engUnit`	string	Yes

Example payload

{
  "objectType": "PowerMeter",
  "pointType": "Voltage",
  "objectName": "string",
  "objectId": "string",
  "servesId": [
    "string"
  ],
  "engUnit": "string"
}

Message: PowerMeter PowerFactor Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `PowerMeter`
`pointType`	string	Yes	Values: `PowerFactor`
`objectName`	string	Yes	Human-readable name of the electrical device.
`objectId`	string	Yes	Stable unique identifier for the electrical device.
`servesId`	array<string>	Yes	List of objectIds of entities served by this power meter.

Example payload

{
  "objectType": "PowerMeter",
  "pointType": "PowerFactor",
  "objectName": "string",
  "objectId": "string",
  "servesId": [
    "string"
  ]
}

Message: PowerMeter Frequency Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `PowerMeter`
`pointType`	string	Yes	Values: `Frequency`
`objectName`	string	Yes	Human-readable name of the electrical device.
`objectId`	string	Yes	Stable unique identifier for the electrical device.
`servesId`	array<string>	Yes	List of objectIds of entities served by this power meter.
`engUnit`	string	Yes

Example payload

{
  "objectType": "PowerMeter",
  "pointType": "Frequency",
  "objectName": "string",
  "objectId": "string",
  "servesId": [
    "string"
  ],
  "engUnit": "string"
}

Message: PowerMeter ApparentPower Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `PowerMeter`
`pointType`	string	Yes	Values: `ApparentPower`
`objectName`	string	Yes	Human-readable name of the electrical device.
`objectId`	string	Yes	Stable unique identifier for the electrical device.
`servesId`	array<string>	Yes	List of objectIds of entities served by this power meter.
`engUnit`	string	Yes

Example payload

{
  "objectType": "PowerMeter",
  "pointType": "ApparentPower",
  "objectName": "string",
  "objectId": "string",
  "servesId": [
    "string"
  ],
  "engUnit": "string"
}

Message: PowerMeter ActivePower Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `PowerMeter`
`pointType`	string	Yes	Values: `ActivePower`
`objectName`	string	Yes	Human-readable name of the electrical device.
`objectId`	string	Yes	Stable unique identifier for the electrical device.
`servesId`	array<string>	Yes	List of objectIds of entities served by this power meter.
`engUnit`	string	Yes

Example payload

{
  "objectType": "PowerMeter",
  "pointType": "ActivePower",
  "objectName": "string",
  "objectId": "string",
  "servesId": [
    "string"
  ],
  "engUnit": "string"
}

Message: PowerMeter Current Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `PowerMeter`
`pointType`	string	Yes	Values: `Current`
`objectName`	string	Yes	Human-readable name of the electrical device.
`objectId`	string	Yes	Stable unique identifier for the electrical device.
`servesId`	array<string>	Yes	List of objectIds of entities served by this power meter.
`engUnit`	string	Yes

Example payload

{
  "objectType": "PowerMeter",
  "pointType": "Current",
  "objectName": "string",
  "objectId": "string",
  "servesId": [
    "string"
  ],
  "engUnit": "string"
}

Message: PowerMeter CurrentLimit Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `PowerMeter`
`pointType`	string	Yes	Values: `CurrentLimit`
`objectName`	string	Yes	Human-readable name of the electrical device.
`objectId`	string	Yes	Stable unique identifier for the electrical device.
`servesId`	array<string>	Yes	List of objectIds of entities served by this power meter.
`engUnit`	string	Yes

Example payload

{
  "objectType": "PowerMeter",
  "pointType": "CurrentLimit",
  "objectName": "string",
  "objectId": "string",
  "servesId": [
    "string"
  ],
  "engUnit": "string"
}

Message: PowerMeter PhaseCurrent Metadata

Content Type: application/json

Payload

Name	Type	Required	Description
`objectType`	string	Yes	Values: `PowerMeter`
`pointType`	string	Yes	Values: `PhaseCurrent`
`objectName`	string	Yes	Human-readable name of the electrical device.
`objectId`	string	Yes	Stable unique identifier for the electrical device.
`servesId`	array<string>	Yes	List of objectIds of entities served by this power meter.
`engUnit`	string	Yes
`phase`	string	Yes	Electrical phase identifier. Letter form (A/B/C) and numeric form (1/2/3) are both accepted to align with publisher conventions. Values: `A`, `B`, `C`, `1`, `2`, `3`

Example payload

{
  "objectType": "PowerMeter",
  "pointType": "PhaseCurrent",
  "objectName": "string",
  "objectId": "string",
  "servesId": [
    "string"
  ],
  "engUnit": "string",
  "phase": "A"
}

Message: PowerMeter GenericPoint Metadata

Content Type: application/json

Payload

Field fragment for a vendor-specific or unmapped GenericPoint. processArea is required.

engUnit and stateText are both optional but mutually exclusive — include at most one. See the two variants below.

Continuous measurement with a known engineering unit. When `engUnit` is prese…

Name	Type	Required	Description
`engUnit`	string	No	Engineering unit for the measurement.

Binary or enumerated state point. When `stateText` is present, `engUnit` must…

Name	Type	Required	Description
`stateText`	array<map<string, any>>	No	State label mapping. Each entry maps a numeric state value to its human-readable label (e.g., `[{value: 0, text: "Off"}, {value: 1, text: "On"}]`).

Example payload

{
  "objectType": "string",
  "pointType": "GenericPoint",
  "objectName": "string",
  "objectId": "string",
  "servesId": [
    "string"
  ],
  "processArea": [
    "string"
  ],
  "phase": "A",
  "integration": "string",
  "isSetpoint": false
}