SchemaBMS Event BusOperationsPump

Pump — Metadata

View as Markdown

Subscribe to BMS-published metadata for Pump points.

Direction: Subscribe (receive)

Channel

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

BMS-published metadata for Pump points.

MQTT wildcard examples

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

Parameters

ParameterDescription
pointTypePump point type. Values: PumpSpeed, Available, GenericPoint
tagPathVendor-defined hierarchical tag path.

Message: Pump PumpSpeed Metadata

Content Type: application/json

Payload

Measurement fields for PumpSpeed. Typical engUnit: RPM. The identifier (named-object XOR associate) and measurement (engUnit XOR stateText) constraints are independent and enforced by EquipmentMeasurementModeBase.

Requires a non-empty engUnit string (mutually exclusive with stateText).

NameTypeRequiredDescription
engUnitstringYesEngineering unit for the measurement.

Required for state/status/alarm points that carry no engineering unit.

NameTypeRequiredDescription
stateTextarray<map<string, any>>YesState label mapping. Each entry maps a numeric state value to its human-readable label (e.g., [{value: 0, text: "Off"}, {value: 1, text: "On"}]).
1{
2  "engUnit": "string"
3}

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

NameTypeRequiredDescription
objectNamestringYesHuman-readable equipment name.
objectIdstringYesStable unique identifier for the equipment.
servesIdarray<string>NoOptional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode.

Associate Mode

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

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

NameTypeRequiredDescription
associateIdstringYesIdentifier of the associated entity.
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.

NameTypeRequiredDescription
objectNamestringYesHuman-readable equipment name.
objectIdstringYesStable unique identifier for the equipment.
servesIdarray<string>NoOptional list of objectIds of entities this equipment serves. Only valid in Named-object mode. Only valid in Named-object mode — must not appear in Associate mode.

Associate Mode

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

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

NameTypeRequiredDescription
associateIdstringYesIdentifier of the associated entity.
1{
2  "objectName": "string",
3  "objectId": "string",
4  "servesId": [
5    "string"
6  ]
7}