BESS — Metadata

Subscribe to BMS-published metadata for BESS points.

Direction: Subscribe (receive)

Channel

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

BMS-published metadata for BESS points.

MQTT wildcard examples

• All BESS metadata: BMS/v1/PUB/Metadata/BESS/#

Parameters

Message: BESS Status Metadata

Content Type: application/json

Payload

Optional fields common to all generic equipment metadata, regardless of identifier mode.

Object Mode

• objectName and objectId are required.
• servesId is optional in Named-object mode.
• associateId must not be present.

Incompatible with EquipmentAssociateMode — validators enforce this via the parent oneOf.

Associate Mode

• associateId is required.
• objectName, objectId, and servesId must not be present.

Incompatible with EquipmentNamedObjectMode — validators enforce this via the parent oneOf.

1
{
2
  "objectName": "string",
3
  "objectId": "string",
4
  "servesId": [
5
    "string"
6
  ]
7
}

Message: BESS Available Metadata

Content Type: application/json

Payload

Optional fields common to all generic equipment metadata, regardless of identifier mode.

Object Mode

• objectName and objectId are required.
• servesId is optional in Named-object mode.
• associateId must not be present.

Incompatible with EquipmentAssociateMode — validators enforce this via the parent oneOf.

Associate Mode

• associateId is required.
• objectName, objectId, and servesId must not be present.

Incompatible with EquipmentNamedObjectMode — validators enforce this via the parent oneOf.

1
{
2
  "objectName": "string",
3
  "objectId": "string",
4
  "servesId": [
5
    "string"
6
  ]
7
}

Message: GenericEquipment 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.

Object Mode

• objectName and objectId are required.
• servesId is optional in Named-object mode.
• associateId must not be present.

Incompatible with EquipmentAssociateMode — validators enforce this via the parent oneOf.

Associate Mode

• associateId is required.
• objectName, objectId, and servesId must not be present.

Incompatible with EquipmentNamedObjectMode — validators enforce this via the parent oneOf.

1
{
2
  "objectName": "string",
3
  "objectId": "string",
4
  "servesId": [
5
    "string"
6
  ]
7
}