Skip to main content

Topics Reference

Node Topics

Firmware

ExplanationMQTT TopicPayload
Firmware infonode/{id}/info{"firmware": "motion-detector", "version": "v1.3.0"}

Battery

ExplanationMQTT TopicPayload
Battery Module Voltagenode/{id}/battery/standard/voltage6.21
Mini Battery Module Voltagenode/{id}/battery/mini/voltage3.12

Sensors

ExplanationMQTT Topic
Illuminancenode/{id}/lux-meter/0:0/illuminance
Relative Humiditynode/{id}/hygrometer/0:2/relative-humidity
Pressurenode/{id}/barometer/0:0/pressure
Altitudenode/{id}/barometer/0:0/altitude
Temperature (Core Module)node/{id}/thermometer/0:1/temperature
Temperature (Climate Module, Tag)node/{id}/thermometer/0:0/temperature
CO2 Meternode/{id}/co2-meter/-/concentration
info

Values like 0:0 or 0:2 in the topics above describe which I2C bus the sensor is using and which revision the sensor is. The first value before : describes I2C0 (default) or I2C1 bus.

The second number after : describes the revision of the sensor. These numbers are fixed and never change. This corresponds with firmware SDK values.

Relays

info

Only allowed values for payload are true/false.

ExplanationMQTT TopicResponse
Power Module Relay Setnode/{id}/relay/-/state/setnode/{id}/relay/-/state
Power Module Relay Getnode/{id}/relay/-/state/getnode/{id}/relay/-/state
Relay Module Relay Setnode/{id}/relay/0:0/state/setnode/{id}/relay/0:0/state
Relay Module Relay Getnode/{id}/relay/0:0/state/getnode/{id}/relay/0:0/state
Relay Module Pulsenode/{id}/relay/0:0/pulse/set{"duration":200, "direction":true}

LED

ExplanationMQTT Topic
LED on the Core Modulenode/{id}/led/-/state/set

Button

ExplanationMQTT Topic
Button Pressnode/{id}/push-button/-/event-count
Button Holdnode/{id}/push-button/-/hold-count
Button Hold Durationnode/{id}/push-button/-/hold-duration

PIR Motion Detector

ExplanationMQTT Topic
Object Movement Detectionnode/{id}/pir/-/event-count

LED Strip

ExplanationMQTT Topic / explanationExample
Set brightness 0-100%node/{id}/led-strip/-/brightness/set
Set color #250000 or RGBW #250000(80)node/{id}/led-strip/-/color/set
Set compound(part of LED Strip)node/{id}/led-strip/-/compound/set[20, "#ff0000", 20, "#00ff00"]
Set effectnode/{id}/led-strip/-/effect/set
  • {"type":"test"}
  • {"type":"rainbow", "wait":50}
  • {"type":"rainbow-cycle", "wait":50}
  • {"type":"theater-chase-rainbow", "wait":50}
  • {"type":"color-wipe", "wait":50, "color":"#800000"}
  • {"type":"theater-chase", "wait":50, "color":"#008000"}
  • {"type":"stroboscope", "wait":50, "color":"#0000ff"}
  • {"type":"icicle", "wait":50, "color":"#ff0000"}
  • {"type":"pulse-color", "wait":200, "color":"#ff0000"}
Thermometer effectnode/{id}/led-strip/-/thermometer/set
  • {"temperature": 22.5, "min":-20, "max": 50}
  • {"temperature": 22.5, "min":-20, "max": 50, "white-dots": 10}
  • {"temperature": 22.5, "min":-20, "max": 50, "set-point": 30, "color":"#ff0000"}
  • {"temperature": 22.5, "min":-20, "max": 50, "white-dots": 10, "set-point": 30, "color":"#ff0000"}
  • {"temperature": -20, "min":-20, "max": 50, "set-point": 30, "color":"#00ff00"}

LCD Module

ExplanationMQTT TopicExample
Left Buttonnode/{id}/push-button/lcd:left/event-count
Right Buttonnode/{id}/push-button/lcd:left/event-count
Clear Screennode/{id}/push-button/lcd:left/event-count
Write Textnode/{id}/push-button/lcd:left/event-count{"x": 5, "y": 10, "text": "HARDWARIO"}

Gateway Topics

tip

All these commands are build into the HARDWARIO Playground and you can do all this in the Devices Tab.

Pairing

ExplanationMQTT TopicResponse
Startgateway/{id}/pairing-mode/startgateway/{id}/pairing-mode "start"
Stopgateway/{id}/pairing-mode/stopgateway/{id}/pairing-mode "stop"

Paired Nodes

ExplanationMQTT TopicResponse
Listgateway/{id}/nodes/getgateway/{id}/nodes [{"id": "a7c8b05762dd", "alias": "generic-node:0"}, {"id": "836d1983718a", "alias": "lcd-thermostat:0"}]
Purge All Nodesgateway/{id}/nodes/purgegateway/{id}/nodes []

Manual Add/Remove

ExplanationMQTT TopicResponse
Addgateway/{id}/nodes/add "{id-node}"gateway/{id}/attach "{id-node}"
Removegateway/{id}/nodes/remove "{id-node}"gateway/{id}/detach "{id-node}"

Aliases

ExplanationMQTT Topic
Setgateway/{id}/alias/set {"id": "id-node", "alias": "new-name"}
Removegateway/{id}/alias/remove "{id-node}"
Remove Aliasgateway/{id}/alias/set {"id": "id-node", "alias": null}

Scan Wireless

ExplanationMQTT TopicResponse
Startgateway/{id}/scan/startgateway/{id}/scan "start"
Stopgateway/{id}/scan/stopgateway/{id}/scan "stop"