SchemaBMS Event BusOperationsFan

Fan Integration — Value

View as Markdown

Publish integration values for Fan control points.

Direction: Publish (send)

Channel

BMS/v1/{integration}/Value/Fan/{pointType}/{tagPath}

Values published by integrations for Fan control points. Subscribe to BMS/v1/PUB/Metadata/Fan/# and publish only when that metadata payload includes an integration field whose value matches the publishing integration identifier. That matching metadata payload indicates the integration can publish values to this topic.

MQTT wildcard examples

  • All integration Fan values: BMS/v1/+/Value/Fan/#

Parameters

ParameterDescription
integrationIntegration identifier.
pointTypeIntegration-published Fan point type. Values: GenericPoint
tagPathMust match the tagPath from the corresponding BMS metadata exactly.

Message: Point Value

Content Type: application/json

Live value message. Payload envelope is identical for all point types. The semantic meaning of value is determined by the corresponding metadata message.

Payload

NameTypeRequiredDescription
valuenumber or nullYesLive reading for the point (float). May be null when the BMS has no valid reading available.
timestampintegerYesUnix timestamp in epoch milliseconds (source event time).
qualityintegerYes1 = good quality. Any other integer indicates value is not trustworthy
1{
2  "value": 22.96215,
3  "timestamp": 1743620423000,
4  "quality": 1
5}