zib_guest

zib_guest

Guest a guest room management integration for Home Assistant

Room State

The State device to tracks the current room state — whether or not there is an active reservation — and provides configuration options to control automatic state switching and default reseveration data

Reservations

The devices Current and Next track reservation data with the following entities:

• Guest name
• Door code
• Arrival
  • datetime %Y-%m-%d %H-%M-%S
  • datetime_abbr %Y-%m-%d @ %-I %p
  • date %Y-%m-%d
  • date_weekday %a, %b %-d
  • datetime_weekday %a, %b %-d @ %-I %p
  • time %H:%M:%S
  • time_abbr %H:%M
  • hour %-I %p
  • weekday %A
  • weekday_abbr %a
  • month %B
  • month_abbr %b
• Departure
  • [Same attributes as Arrival]
• Check in
  • [Used in Arrival time components]
• Check out
  • [Used in Departure time components]
• WiFi SSID
• WiFi key
  • qr 'WIFI:S:' + <wifi_ssid> + ';T:WPA;P:' + <wifi_key> + ';;'

I use this data to feed both guest-facing displays, where Aguests can see WiFi and other information about their own reservation, and for backend systems that tell me about upcoming reservations or control automations in relation to the reservation state

All entites are settable via a service call. I use an external program connected via the WS API to update these sensors based on my rental calendar and other external data. There are many ways this data could come into HA, but I wanted to use the WS API specifically for a number of reasons: it has an active connection so I'll know right away when HA disconnects, it uses simple tokens for auth, clients for several programming environments already exist, I can publish from anywhere that can reach the frontend HTTP instance

This project also covers at least the minimal parts required for any HA integration to publish async push sensors, add extra attributes, use the config_flow UI, and receive service calls. Feel free to use it as an example if you are working on your own integration. The HA team also publishes examples of many parts of the integration framework. If you want all the modern features start with the detailed_hello_world_push example