From 75acd0f3851fad16fd96d648add4a3fb47a96469 Mon Sep 17 00:00:00 2001 From: Joe Stump Date: Sat, 11 May 2024 15:25:23 -0400 Subject: [PATCH] Docs: Add FAQ This is a re-implementation of PR #187 to pass tests. Signed-off-by: Andrew Grimberg --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d1ff927..f009393 100644 --- a/README.md +++ b/README.md @@ -134,7 +134,7 @@ The integration is set up using the GUI. - Go to Configuration -> Integrations and click on the "+"-button. - Search for "Rental Control" -- Enter a name for the calendar, and the URL +- Enter a name for the calendar, and the calendar's `ics` URL (see FAQ) - By default it will set up 5 sensors for the 5 nex upcoming events (sensor.rental_control\_\\_event_0 ~ 4). You can adjust this to add more or fewer sensors @@ -192,3 +192,17 @@ While the integration supports reconfiguration a few things may not fully update after a reconfiguration. If you are having issues with reconfigured options not being picked up properly try reloading the particular integration installation or restart Home Assistant. + +## Frequently Asked Questions + +### Why does my calendar events say `Reserved` instead of the guest's name? + +AirBnB does not include guest or booking details in the invite. What is included in the `ics` data varies by provider. Calendar `ics` URLs from some 3rd party tools (e.g. Host Tools) do include guest information and will show that rather than `Reserved` in calendar events. + +### Where can I find my rental calendar's `ics` URL? + +Each provider has slightly different instructions: + +- [AirBnB](https://www.airbnb.com/help/article/99) +- [VRBO](https://help.vrbo.com/articles/Export-your-reservation-calendar) +- [Host Tools](https://help.hosttools.com/en/articles/5128627-how-do-i-export-an-ical-link-from-host-tools)