My Smart Home - Zigbee2MQTT

Garage project for private purposes. Allows usage of any Zigbee device in my home.

🐳 Make sure you have installed Docker.

See how to put this repo in action at IanStorm/my-smart-home-ras-pi.

How to use in "production"? 👨‍💼 👩‍💼

1. Follow "How to get a pre-built Docker image?".
2. Ensure to have a running MQTT broker available via mqtt-broker:1883.
3. Start a Docker instance:

$	docker run \
		--rm \
		-d \
		-t \
		--device=/dev/ttyACM0 \
		-v /var/opt/my-smart-home-zigbee2mqtt/data/state.json:/app/data/state.json \
		ianstorm/my-smart-home-zigbee2mqtt

• • --device=/dev/ttyACM0: Makes the host's CC2531 available to the Docker container (see app/data/configuration.yaml)
  • -v [...]/state.json[...]: Ensure state.json is initially set as {}

How to develop? 👨‍💻 👩‍💻

Make sure you have installed Visual Studio Code.

1. Clone this repository.
2. cd inside the cloned folder.
3. In ./app/data/configuration.yaml:
   1. Set permit_join: true (instead of false)
   2. Set availability: true (instead of false)
   3. Add frontend: {}
4. Ensure to have the latest firmware running on the USB Zigbee sniffer (here: CC2531), see how to flash the CC2531.
5. Start the Docker instances:

docker-compose up

Appendix

How to get a pre-built Docker image? ☁️

Get the latest Docker image from Docker Hub:

$	docker pull ianstorm/my-smart-home-zigbee2mqtt:latest

Sources

• Official Zigbee2MQTT documentation: Docker
• Official Zigbee2MQTT documentation: Configuration
• Official Zigbee2MQTT documentation: How to secure network
• Official Zigbee2MQTT documentation: How to hide secrets