MQTT Publish Topics

Object Topics

Publish to an object topic using the format commands/object/SUBTOPIC and write to the data JSON key.

For example, to change the brightness of the O3's LED light ring from 50% to 100%, publish {"data": 100} to commands/object/lightringBrightness. The corresponding subscribe topic events/object/lightringBrightness will then show {"Present_Value": 100}.

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. 

To publish to the O3's internal MQTT broker, you will need to enter a user name and password. If you are publishing to the O3's internal MQTT broker for the first time, use the following login credentials: username = user, password = admin.

Object Publish Topics

Topic	Description
commands/object/lightringPattern	Plays pre-defined light ring pattern (1‑13). Default value is 1 (Off).
commands/object/lightringRepeat	Sets number of times light ring pattern repeats. Default value is 1.
commands/object/lightringRed	Sets red component of light ring RGB value. Range: 0 to 100. Default value is 0 (Off).
commands/object/lightringGreen	Sets green component of light ring RGB value. Range: 0 to 100. Default value is 0 (Off).
commands/object/lightringBlue	Sets blue component of light ring RGB value. Range: 0 to 100. Default value is 0 (Off).
commands/object/lightringColorOverride	Activates custom light ring color defined by lightringRed, lightringBlue, and lightringGreen subtopics. Set to 1 (On) or 0 (Off). When set to 1 (On), it overrides commands/object/lightringPattern.
commands/object/lightringBrightness	Sets overall brightness of light ring. Range: 0 to 100. Default value is 50.
commands/object/indicateStatus	Displays power-on self-test (POST) status. Set to 1 (On) or 0 (Off). POST status is indicated by the following colors: green = OK, red = sensor problem, blue = Bluetooth problem, and yellow = Ethernet problem. Default value is 0 (Off).
commands/object/irPattern	Not currently supported. Sends IR code (1‑13) for remote control of A/V equipment. Default value is 1 (Off).
commands/object/irRepeats	Not currently supported. Sets number of times IR code is sent per transmission. Default value is 1.
commands/object/irCode1 to commands/object/irCode12	Not currently supported. Sets IR code. Obtain the remote control codes specific to your appliance brand and model in Pronto hex format (4-digit hexadecimal values separated by spaces). Remote control codes are available online on websites such as remotecentral.com.
commands/object/soundfile	Plays a sound by sound file name. For example, {"data": "(1) Power On.wav"}. See commands/object/soundinfo.
commands/object/volume	Sets the speaker volume. Range: 0 to 100. Default value is 75%.
commands/object/soundRepeat	Sets the number of times a sound is played. Default value is 1.
commands/object/soundinfo	Lists the names and index numbers of all the sound files and their total size (in bytes). No JSON content needs to be entered. Simply enter 0 and then publish.
commands/object/ioChannel1	Sets the xP1 universal point value, if applicable.
commands/object/ioChannel2	Sets the xP2 universal point value, if applicable.

Metric Topics

See Accessing metric data through MQTT

Firmware and Reboot Topics

Topic	Description
commands/fw/updateFw	Initiates a firmware upgrade. Indicate the firmware version using the format {"data": {"version": "FIRMWARE_VERSION"}}.
commands/reboot	Reboots the O3 using the following message: {"data": {"source": "enteliWeb", "message": "command coldstart"}}.