|
|
@@ -0,0 +1,27 @@
|
|
|
+# zib_guest
|
|
|
+
|
|
|
+## Guest reservation integration for Home Assistant
|
|
|
+
|
|
|
+#### Provides any number of devices with entities for:
|
|
|
+
|
|
|
+- Guest name
|
|
|
+- Door code
|
|
|
+- Arrival date
|
|
|
+- Departure date
|
|
|
+- WiFi name
|
|
|
+- WiFi key
|
|
|
+- WiFi QR code
|
|
|
+
|
|
|
+All entites are settable with service calls (or derived automatically from from settable fields) for easy use from other parts of HA, or from the
|
|
|
+WebSocket/REST API. I use the data to feed both guest-facing displays, like a ePaper display for the WiFi information and for labeling the guest's door.
|
|
|
+I also feed my own displays so I know when the next guest is arriving and how long they will be staying
|
|
|
+
|
|
|
+I use an external program connected via the WS API to update these sensors based on my rental calendar and other external database. Other intergrations
|
|
|
+could do this; for example the mobile_app integration allows publishing sensors. The REST API can construct (ephemeral) states out of thin air. But I
|
|
|
+wanted something I could feed via the WS API for easy, secure access from external data source
|
|
|
+
|
|
|
+This project also covers at least the miminal parts required to build fully async sensors and service calls for any HA integration. The HA team
|
|
|
+[publishes examples](https://github.com/home-assistant/example-custom-config/tree/master) of many parts of this process. If you just want a basic
|
|
|
+integration for a simple sensor it's not a lot of work. If you want to support all the modern features like config_flow and async push update you'll
|
|
|
+want to start with the [detailed_hello_world_push
|
|
|
+example](https://github.com/home-assistant/example-custom-config/tree/master/custom_components/detailed_hello_world_push), or with a repo like this one
|
