MQTT Subscribe Topics

Object Topics

You can subscribe to read-only object topics that contain sensor data and device configurations. Subscribe using the format events/object/SUBTOPIC and read the Present_Value JSON key. To subscribe to all object topics, use events/object/#.

MQTT topics are case sensitive. Make sure you write the topic exactly as is written in the table below to ensure your settings are properly applied. 

Sensor Data Object Subscribe Topics

Topic	Description
events/object/occupantTemperature	Temperature at 1 m (3 ft) above the floor. This is a composite value derived from the O3's internal temperature sensors and the IR temperature sensor. Range: 0°C to 59°C (32°F to 138°F).
events/object/irTemperature	Average temperature of surfaces in the O3's field of view. Range: 0°C to 59°C (32°F to 138°F).
events/object/internalTemperature	Temperature at ceiling height. Range: 0°C to 59°C (32°F to 138°F).
events/object/rawTemperature	Uncalibrated occupant temperature. Range: 0°C to 59°C (32°F to 138°F).
events/object/occupantHumidity	Humidity at 1 m (3 ft) above floor. This is calculated from the occupant temperature and internal humidity using psychrometrics. Range: 0% to 100%.
events/object/internalHumidity	Humidity at ceiling height. Range: 0% to 100%.
events/object/combinedOccupancy	Combined (motion + sound) occupancy signal. Active state when motion and sound is detected. Range: 0 (not occupied), 1 (occupied).
events/object/motion	Motion occupancy signal. Active state when motion is detected. Range: 0 (not occupied), 1 (occupied).
events/object/acousticActivityLevel	Audio level after certain frequencies are filtered out. Range: 0 to 65535.
events/object/acousticOccupancy	Acoustic occupancy signal. Active state when audio level is above acoustic occupancy threshold. Range: 0 (not occupied), 1 (occupied).
events/object/motionSensitivity	Controls the sensitivity of the PIR sensor to changes in movement levels within the detection area. Range: 0% to 100%. 100% = maximum sensitivity.
events/object/acousticSensitivity	Controls the sensitivity of the acoustic occupancy sensor to changes in audio levels within the detection area. Range: 0% to 100%. 100% = maximum sensitivity.
events/object/acousticRetriggerSeconds	The amount of time that activity sounds can cause the O3 to remain in the occupied state after motion is detected. Default value is 1200 seconds (20 minutes). Measured from most recent motion detection event.
events/object/occupancyInactivitySeconds	The amount of time it takes the O3 to return to the unoccupied state when no motion and no audio activity is detected. Default value is 30 seconds (5 minutes).
events/object/acousticBGUpdateSeconds	Update period for the baseline microphone levels to adjust to environmental changes when no occupants are present. Default value is 30 seconds.
events/object/lightLevel	Brightness of ambient light (lux or foot-candle). Range: 0 to 65535 (lux) or 0 to 6088 (foot-candle).
events/object/colorTemperature	Color temperature of ambient light (K). Range: 0 to 65535.
events/object/colorRed	Red component of ambient light. Range: 0 to 65535.
events/object/colorGreen	Green component of ambient light. Range: 0 to 65535.
events/object/colorBlue	Blue component of ambient light. Range: 0 to 65535.
events/object/soundLevel	Level of ambient noise (dB SPL). Unfiltered audio level across the entire spectrum. Range: 0 to 120 dB.
events/object/irRepeat	Number of times IR code is sent per transmission.
events/object/irCode1 to events/object/irCode12	IR code.
events/object/irPattern	Index of the IR code.
events/object/occupantEstimation	The estimated number of occupants in a space.

Device Configuration Object Subscribe Topics

Topic	Description
events/object/temperatureSetPoint	User-entered temperature. Measured by user at occupant height. Offset is calculated by the O3.
events/object/lightlevelSetPoint	User-entered light level. Records the light level read by the O3 (AI12) when the lighting in the space is set to the desired brightness. This setpoint can be retrieved later by the control system to set the feedback loop, etc.
events/object/lightringPattern	Pre-defined light ring pattern (1‑13). Default value is 1 (Off).
events/object/lightringRepeat	Number of times light ring pattern repeats. Default value is 1.
events/object/lightringRed	Red component of light ring RGB value. Range: 0% to 100%. Default value is 0% (Off).
events/object/lightringGreen	Green component of light ring RGB value. Range: 0% to 100%. Default value is 0% (Off).
events/object/lightringBlue	Blue component of light ring RGB value. Range: 0% to 100%. Default value is 0% (Off).
events/object/lightringColorOverride	Custom light ring color defined by lightringRed, lightringBlue, and lightringGreen subtopics. Range: 0 (Off), 1 (On). When set to 1 (On), it overrides lightringPattern.
events/object/lightringBrightness	Overall brightness of light ring. Range: 0% to 100%. Default value is 50%.
events/object/soundinfo	Lists the names and index numbers of all the sound files and their total size. There are 25 default sounds and you can create up to 25 custom sounds. For more details about creating custom sounds, see the BACnet Application Guide on support.o3hub.com. This topic is updated automatically whenever a custom sound file is added, changed, or removed.
events/object/volume	Speaker volume. Range: 0% to 100%. Default value is 75%.
events/object/soundRepeat	Number of times a sound is played. Default value is 1.
events/object/startupSoundEnable	Startup sound. Range: 0 (Off), 1 (On). Default value is 0 (Off).
events/object/bleMac	Displays the MAC address of Bluetooth LE beacon.
events/object/ioChannel1	Displays the xP1 universal point value.
events/object/ioChannel2	Displays the xP2 universal point value.

Metric Topics

See Accessing metric data through MQTT