neilphan98/hearth-mqtt-client repository overview

⁠HEARTH MQTT Sensor

MQTT telemetry sensor/logger (paho): publishes or subscribes building data.

Real-device analogue: An MQTT IoT sensor (temperature/occupancy) or a data logger.

Protocol / ports: MQTT (TCP 1883) via paho.

⁠What it does / how it works

A paho-based tenant. MQTT_MODE=publisher emits periodic telemetry on MQTT_TOPIC; subscriber logs a topic. Used for temp/motion sensors and the BMS logger.

⁠Functions

• Periodic telemetry publish (MQTT_PERIOD)
• Topic subscribe/log
• Role via MQTT_DEVICE / MQTT_TOPIC

⁠How to use

Set MQTT_BROKER to your broker IP and MQTT_TOPIC; start. Confirm on the broker with mosquitto_sub -h <broker> -t <topic> -v.

⁠Use in GNS3

• Import the matching .gns3a (File > Import appliance), or docker pull neilphan98/hearth-mqtt-client:1.1.
• Drag onto your topology, wire to a switch/hub, start. Console: telnet.
• Adapters: 1. Category: guest.

IPv4 device: leave MQQ1_IP empty to auto-assign a unique IP (zero-config), or set a fixed address. Zone via HEARTH_OCTET (5 corp / 6 ot / 8 security).

⁠Default environment (per node)

MQQ1_IP=192.168.6.11
MQQ1_PREFIX=24
MQQ1_GW=192.168.6.1
MQQ1_IP6=fd11:1111:1111:6::b
MQQ1_IP6_PREFIX=64
MQQ1_GW6=fd11:1111:1111:6::1
MQTT_MODE=publisher
MQTT_BROKER=192.168.6.10
MQTT_PERIOD=5
RD_MODE=mqtt-pub
MQQ1_BROKER=192.168.6.10
MQQ1_PERIOD=5
MQTT_DEVICE=thermostat
HEARTH_NETSVC=192.168.6.50
MQTT_BACKGROUND=1
MQTT_TOPIC=building/floor2-office/temperature
MQQ1_TOPIC=building/floor2-office/temperature
HEARTH_ROOM=office

Current release: 1.1 (docker pull neilphan98/hearth-mqtt-client:1.1)

Part of the HEARTH Tower commercial-building IoT/OT security testbed. Image tags are immutable per release (1.0, 1.1, ...), so updating the device list never changes nodes you already placed. See the HEARTH bundle for all devices + guides.