neilphan98/hearth-voice-assistant repository overview

⁠HEARTH Voice Assistant

Voice-assistant / smart-speaker tenant that publishes events over MQTT.

Real-device analogue: A smart speaker / voice assistant (an Alexa/Google-Home-class device).

Protocol / ports: MQTT client to the broker (TCP 1883); consumer cloud-style chatter.

⁠What it does / how it works

A smart-speaker tenant: publishes voice/assistant events to the MQTT broker and produces the periodic consumer chatter such a device emits.

⁠Functions

• MQTT event publishing
• Reception/front-desk voice endpoint

⁠How to use

Set MQQ1_MQTT_BROKER to your broker IP (default 192.168.6.10). Watch with mosquitto_sub -h <broker> -t '#' -v.

⁠Use in GNS3

• Import the matching .gns3a (File > Import appliance), or docker pull neilphan98/hearth-voice-assistant: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.5.12
MQQ1_PREFIX=24
MQQ1_GW=192.168.5.1
MQQ1_IP6=fd11:1111:1111:5::c
MQQ1_IP6_PREFIX=64
MQQ1_GW6=fd11:1111:1111:5::1
MQQ1_MQTT_BROKER=192.168.6.10

Current release: 1.1 (docker pull neilphan98/hearth-voice-assistant: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.