For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • DSX Exchange
    • Architecture
    • Pre-Deployment
    • Deployment
    • Integrator Quickstart
    • Operations
    • Authentication
    • BMS Integration
    • Validated Capabilities
  • Schema
      • Overview
          • Metadata
          • Value
      • Messages
      • Schemas
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogo
On this page
  • Channel
  • Parameters
  • Message: HX LiquidTemperature Metadata
  • Payload
  • Object Mode
  • Associate Mode
  • Message: HX LiquidDifferentialPressure Metadata
  • Payload
  • Requires a non-empty engUnit string (mutually exclusive with stateText).
  • Required for state/status/alarm points that carry no engineering unit.
  • Message: HX LiquidFlow Metadata
  • Payload
  • Requires a non-empty engUnit string (mutually exclusive with stateText).
  • Required for state/status/alarm points that carry no engineering unit.
  • Message: HX LiquidPressure Metadata
  • Payload
  • Requires a non-empty engUnit string (mutually exclusive with stateText).
  • Required for state/status/alarm points that carry no engineering unit.
  • Message: HX Status Metadata
  • Payload
  • Object Mode
  • Associate Mode
  • Message: HX Available Metadata
  • Payload
  • Object Mode
  • Associate Mode
  • Message: HX ValvePosition Metadata
  • Payload
  • Requires a non-empty engUnit string (mutually exclusive with stateText).
  • Required for state/status/alarm points that carry no engineering unit.
  • Message: HX PumpSpeed Metadata
  • Payload
  • Requires a non-empty engUnit string (mutually exclusive with stateText).
  • Required for state/status/alarm points that carry no engineering unit.
  • Message: HX FanSpeed Metadata
  • Payload
  • Requires a non-empty engUnit string (mutually exclusive with stateText).
  • Required for state/status/alarm points that carry no engineering unit.
  • Message: HX DamperPosition Metadata
  • Payload
  • Requires a non-empty engUnit string (mutually exclusive with stateText).
  • Required for state/status/alarm points that carry no engineering unit.
  • Message: HX AirTemperature Metadata
  • Payload
  • Object Mode
  • Associate Mode
  • Message: HX AirDifferentialPressure Metadata
  • Payload
  • Requires a non-empty engUnit string (mutually exclusive with stateText).
  • Required for state/status/alarm points that carry no engineering unit.
  • Message: HX AirRelativeHumidity Metadata
  • Payload
  • Requires a non-empty engUnit string (mutually exclusive with stateText).
  • Required for state/status/alarm points that carry no engineering unit.
  • Message: HX AirFlow Metadata
  • Payload
  • Requires a non-empty engUnit string (mutually exclusive with stateText).
  • Required for state/status/alarm points that carry no engineering unit.
  • Message: HX AirPressure Metadata
  • Payload
  • Requires a non-empty engUnit string (mutually exclusive with stateText).
  • Required for state/status/alarm points that carry no engineering unit.
  • Message: HX LeakDetect Metadata
  • Payload
  • Object Mode
  • Associate Mode
  • Message: GenericEquipment GenericPoint Metadata
  • Payload
  • Object Mode
  • Associate Mode
SchemaBMS Event BusOperationsHX

HX — Metadata

||View as Markdown|
Previous

Value

Next

Value

Subscribe to BMS-published metadata for HX points.

Direction: Subscribe (receive)

Channel

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

BMS-published metadata for HX points.

MQTT wildcard examples

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

Parameters

ParameterDescription
pointTypeHX point type. Values: LiquidTemperature, LiquidDifferentialPressure, LiquidFlow, LiquidPressure, Status, Available … (17 total)
tagPathVendor-defined hierarchical tag path.

Message: HX LiquidTemperature 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.
Example payload
1{
2  "objectName": "string",
3  "objectId": "string",
4  "servesId": [
5    "string"
6  ]
7}

Message: HX LiquidDifferentialPressure Metadata

Content Type: application/json

Payload

Measurement fields for LiquidDifferentialPressure. Typical engUnit: kPa. 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"}]).
Example payload
1{
2  "engUnit": "string"
3}

Message: HX LiquidFlow Metadata

Content Type: application/json

Payload

Measurement fields for LiquidFlow. Typical engUnit: LPM. 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"}]).
Example payload
1{
2  "engUnit": "string"
3}

Message: HX LiquidPressure Metadata

Content Type: application/json

Payload

Measurement fields for LiquidPressure. Typical engUnit: kPa. 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"}]).
Example payload
1{
2  "engUnit": "string"
3}

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

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.
Example payload
1{
2  "objectName": "string",
3  "objectId": "string",
4  "servesId": [
5    "string"
6  ]
7}

Message: HX 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.
Example payload
1{
2  "objectName": "string",
3  "objectId": "string",
4  "servesId": [
5    "string"
6  ]
7}

Message: HX ValvePosition Metadata

Content Type: application/json

Payload

Measurement fields for ValvePosition. Typical engUnit: %. 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"}]).
Example payload
1{
2  "engUnit": "string"
3}

Message: HX 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"}]).
Example payload
1{
2  "engUnit": "string"
3}

Message: HX FanSpeed Metadata

Content Type: application/json

Payload

Measurement fields for FanSpeed. 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"}]).
Example payload
1{
2  "engUnit": "string"
3}

Message: HX DamperPosition Metadata

Content Type: application/json

Payload

Measurement fields for DamperPosition. Typical engUnit: %. 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"}]).
Example payload
1{
2  "engUnit": "string"
3}

Message: HX AirTemperature 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.
Example payload
1{
2  "objectName": "string",
3  "objectId": "string",
4  "servesId": [
5    "string"
6  ]
7}

Message: HX AirDifferentialPressure Metadata

Content Type: application/json

Payload

Measurement fields for AirDifferentialPressure. Typical engUnit: Pa. 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"}]).
Example payload
1{
2  "engUnit": "string"
3}

Message: HX AirRelativeHumidity Metadata

Content Type: application/json

Payload

Measurement fields for AirRelativeHumidity. Typical engUnit: %RH. 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"}]).
Example payload
1{
2  "engUnit": "string"
3}

Message: HX AirFlow Metadata

Content Type: application/json

Payload

Measurement fields for AirFlow. Typical engUnit: CFM. 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"}]).
Example payload
1{
2  "engUnit": "string"
3}

Message: HX AirPressure Metadata

Content Type: application/json

Payload

Measurement fields for AirPressure. Typical engUnit: Pa. 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"}]).
Example payload
1{
2  "engUnit": "string"
3}

Message: HX LeakDetect Metadata

Content Type: application/json

Payload

0 = No Leak, 1 = Leak. No engUnit.

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.
Example payload
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.
Example payload
1{
2  "objectName": "string",
3  "objectId": "string",
4  "servesId": [
5    "string"
6  ]
7}