MQTT Topics

Generic Node Topics

A detailed list of topics is in README in GitHub repository bcf-generic-node.

Firmware

Explanation	MQTT Topic	Payload
Firmware info	node/{id}/info	{"firmware": "motion-detector", "version": "v1.3.0"}

Battery

Explanation	MQTT Topic	Payload
Battery Module voltage	node/{id}/battery/standard/voltage	3.12
Mini Battery Module voltage	node/{id}/battery/mini/voltage	6.21

Sensors

Explanation	MQTT Topic
Illuminance	node/{id}/lux-meter/0:0/illuminance
Relative humidity	node/{id}/hygrometer/0:2/relative-humidity
Pressure	node/{id}/barometer/0:0/pressure
Altitude	node/{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 meter	node/{id}/co2-meter/-/concentration

Note

Values like 0:0 or 0:2 in topics above describe on which I2C bus the sensor is and which revision the sensor is. First value before : descibes I2C0 (default) or I2C1 bus. The second number after : describes the revision of the sensor. These numbers are fixed and never changes. This corresponds with firmware SDK values.

Relays

Important

Only allowed values for payload are true/false

Explanation	MQTT Topic	Response
Power Module relay set	node/{id}/relay/-/state/set	node/{id}/relay/-/state
Power Module relay get	node/{id}/relay/-/state/get	node/{id}/relay/-/state
Relay Module	node/{id}/relay/0:0/state/set	node/{id}/relay/0:0/state
Relay Module get	node/{id}/relay/0:0/state/get	node/{id}/relay/0:0/state
Relay Module pulse	node/{id}/relay/0:0/pulse/set	{"duration":200, "direction":true}

Note

You can use 2 relay modules, if you do that you will just change the 0:0 to 0:1

LED

Explanation	MQTT Topic
LED on the Core Module	node/{id}/led/-/state/set

Button

Explanation	MQTT Topic
Button press	node/{id}/push-button/-/event-count

PIR

Explanation	MQTT Topic
Object movement detection	node/{id}/pir/-/event-count

LED Strip

Explanation	MQTT Topic / explanation	Example
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	node/{id}/led-strip/-/compound/set	[20, "#ff0000", 20, "#00ff00"]
Set effect	node/{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 effect	node/{id}/led-strip/-/thermometer/set turn on “backlight” (0-255) display a set point pixel with a selected color display only set-point	{"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

Explanation	MQTT Topic	Response
Left button	node/{id}/push-button/lcd:left/event-count
Right button	node/{id}/push-button/lcd:right/event-count
Clear screen	node/{id}/lcd/-/screen/clear
Write text	node/{id}/lcd/-/text/set	{"x": 5, "y": 10, "text": "HARDWARIO"} {"x": 5, "y": 40, "text": "HARDWARIO", "font": 28}

Gateway Topics

A detailed list of topics is in README in GitHub repository bch-gateway

Note

Replace {id} with id or name of gateway, use “all” for request to all. Also to see the MQTT responses open the Node-RED debug tab or run this console command mosquitto_sub -t gateway/#.

Pairing

Explanation	MQTT Topic	Response
Start	gateway/{id}/pairing-mode/start	gateway/{id}/pairing-mode "start"
Stop	gateway/{id}/pairing-mode/stop	gateway/{id}/pairing-mode "stop"

Paired nodes

Explanation	MQTT Topic	Response
List	gateway/{id}/nodes/get	gateway/{id}/nodes [{"id": "a7c8b05762dd", "alias": "generic-node:0"},  {"id": "836d1983718a", "alias": "lcd-thermostat:0"}]
Purge all nodes	gateway/{id}/nodes/purge	gateway/{id}/nodes []

Manual add/remove

Explanation	MQTT Topic	Response
Add	gateway/{id}/nodes/add "{id-node}"	gateway/{id}/attach "{id-node}"
Remove	gateway/{id}/nodes/remove "{id-node}"	gateway/{id}/detach "{id-node}"

Aliases

Explanation	MQTT Topic
set	gateway/{id}/alias/set {"id": "id-node", "alias": "new-name"}
remove	gateway/{id}/alias/remove "{id-node}"
remove alias	gateway/{id}/alias/set {"id": "id-node", "alias": null}

Scan wireless

Explanation	MQTT Topic	Response
Start	gateway/{id}/scan/start	gateway/{id}/scan "start"
Stop	gateway/{id}/scan/stop	gateway/{id}/scan "stop"

Hint

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

Mosquitto command examples

Send to all connected gateways:

mosquitto_pub -t gateway/all/pairing-mode/start -n

mosquitto_pub -t gateway/all/pairing-mode/stop -n

mosquitto_pub -t gateway/all/nodes/get -n

mosquitto_pub -t gateway/all/nodes/purge -n

Gateway named “usb-dongle”:

mosquitto_pub -t gateway/usb-dongle/pairing-mode/start -n

mosquitto_pub -t gateway/usb-dongle/pairing-mode/stop -n

Gateway named “core-module”:

mosquitto_pub -t gateway/core-module/pairing-mode/start -n

mosquitto_pub -t gateway/core-module/pairing-mode/stop -n