diff --git a/ical_updater.json b/ical_updater.json index fa693d3..9702a75 100644 --- a/ical_updater.json +++ b/ical_updater.json @@ -1,7 +1,7 @@ { "sensor.ical": { - "updated_at": "2021-01-15", - "version": "1.0", + "updated_at": "2021-01-17", + "version": "1.2", "local_location": "/custom_components/ical/__init__.py", "remote_location": "https://raw.githubusercontent.com/tybritten/ical-sensor-homeassistant/master/__init__.py", "visit_repo": "https://github.com/tybritten/ical-sensor-homeassistant/", diff --git a/info.md b/info.md index b5ece18..e04a28f 100644 --- a/info.md +++ b/info.md @@ -1,18 +1,21 @@ # iCal Sensor Support for Home Assistant -in your configuration.yaml you'll need: +This integration will create sensors for the next few future calendar events, called: -```yaml -sensor: -- platform: ical - name: "My Calendar" - url: "http://url.to/ical" -``` +* sensor.ical_my_calendar_event_0 +* sensor.ical_my_calendar_event_1 +* sensor.ical_my_calendar_event_2 +(...) -It will create sensors for the next few future calendar events, called: +And it will create a calendar-entry that can be used in the calendar cards etc. -* sensor.my_calendar_event_0 -* sensor.my_calendar_event_1 -* sensor.my_calendar_event_2 +* calendar.ical_my_calendar +### Setup -etc \ No newline at end of file +The integration is set up using the GUI. + +* Go to Configuration -> Integrations and click on the "+"-button. +* Search for "ical" +* Enter a name for the calendar, and the URL +* By default it will set up 5 sensors for the 5 nex upcoming events (sensor.ical__event_1 ~ 5). You can adjust this to add more or fewer sensors +* The integration will only consider events with a start time 365 days into the future by default. This can also be adjusted when adding a new calendar