Browse Source

readme: added sample config for home assistant

Fabian Peter Hammerle 3 years ago
parent
commit
5b6ab807a5
1 changed files with 17 additions and 0 deletions
  1. 17 0
      README.md

+ 17 - 0
README.md

@@ -40,6 +40,23 @@ $ mosquitto_pub -h MQTT_BROKER -t intertechno-cc1101/12345678/0/set -m ON
 
 ⚠️ Support for TLS is not implemented yet. Do not connect to brokers via unprotected networks (e.g., internet, wifi network).
 
+## Home Assistant 🏡
+
+```yaml
+# https://www.home-assistant.io/docs/mqtt/broker/#configuration-variables
+mqtt:
+  broker: BROKER_HOSTNAME_OR_IP_ADDRESS
+  # credentials, additional options…
+
+# https://www.home-assistant.io/integrations/switch.mqtt/#configuration-variables
+switch:
+- platform: mqtt
+  name: intertechno_smart_outlet
+  command_topic: intertechno-cc1101/12345678/0/set
+  # http://materialdesignicons.com/
+  icon: mdi:light-switch
+```
+
 ## Docker 🐳
 
 ```sh