Explorar el Código

readme: document requirements

Fabian Peter Hammerle hace 3 años
padre
commit
959009ca72
Se han modificado 1 ficheros con 16 adiciones y 0 borrados
  1. 16 0
      README.md

+ 16 - 0
README.md

@@ -0,0 +1,16 @@
+# intertechno-cc1101-mqtt
+
+MQTT client controlling [Intertechno Outlets](https://www.intertechno.at/)
+via a [CC1101 Transceiver](https://www.ti.com/product/CC1101)
+
+Compatible with [Home Assistant](https://www.home-assistant.io/)'s
+[MQTT Switch](https://www.home-assistant.io/integrations/switch.mqtt/) platform.
+
+## Requirements
+
+* MQTT broker
+* [Intertechno](https://www.intertechno.at/) smart outlet
+* [CC1101 transceiver](https://www.ti.com/product/CC1101)
+* Linux machine with CC1101 connected to SPI port
+  ([wiring instructions](https://github.com/fphammerle/python-cc1101#wiring-raspberry-pi)
+  for raspberry pi)