Template: calendar.list_events -> calendar.get_events

[e0909]

Hey guys,

I use several templates to count calendar events for the actual day (as well adding the event titles to the attribute).

template.yaml

- trigger:
    platform: time_pattern
    minutes: /30
  action:
  - service: calendar.list_events
    target:
      entity_id: calendar.privat
    data:
      start_date_time: "{{ now().strftime('%Y-%m-%d 00:00:00') }}"
      end_date_time: "{{ (now() + timedelta(days=1)).strftime('%Y-%m-%d 00:00:00') }}"
    response_variable: scheduled_events_privat
  sensor:
  - name: Scheduled Events PRIVAT 24h
    unique_id: scheduled_events_privat_24h
    state: "{{ scheduled_events_privat.events | count() }}"
    attributes:
      scheduled_events_privat: "{{ scheduled_events_privat.events }}"
    icon: mdi:calendar

As announced the service ‘calendar.list_events’ is deprecated and will stop working in Home Assistant 2024.6. So I need to use ‘calendar.get_events’.

The output seems to be changed.

calender.list_events

events:
  - start: "2023-12-19T09:10:00+01:00"
    end: "2023-12-19T10:10:00+01:00"
    summary: Zahnarzt

calender.get_events

calendar.privat:
  events:
    - start: "2023-12-19T09:10:00+01:00"
      end: "2023-12-19T10:10:00+01:00"
      summary: Zahnarzt

I did not get it working with the calender.get_events service.
Can some one help me out here what I need to change in my template to get it working with the new service?

Thanks

[petro]

- trigger:
    platform: time_pattern
    minutes: /30
  action:
  - service: calendar.get_events
    target:
      entity_id: calendar.privat
    data:
      start_date_time: "{{ now().strftime('%Y-%m-%d 00:00:00') }}"
      end_date_time: "{{ (now() + timedelta(days=1)).strftime('%Y-%m-%d 00:00:00') }}"
    response_variable: scheduled_events_privat
  sensor:
  - name: Scheduled Events PRIVAT 24h
    unique_id: scheduled_events_privat_24h
    state: "{{ scheduled_events_privat['calendar.privat'].events | count() }}"
    attributes:
      scheduled_events_privat: "{{ scheduled_events_privat['calendar.privat'].events }}"
    icon: mdi:calendar

[e0909]

oh wow, that was fast
works!
thank you very much @petro

[e0909]

oh, im not sure why but now i get an error and the sensor is not available anymore.

Logger: homeassistant.helpers.template
Source: helpers/template.py:2260
First occurred: 20:59:00 (5 occurrences)
Last logged: 21:00:00

Template variable error: ‘dict object’ has no attribute ‘calendar.privat’ when rendering ‘{{ scheduled_events_privat[‘calendar.privat’].events | count() }}’

Logger: homeassistant.helpers.sensor
Source: helpers/trigger_template_entity.py:208
First occurred: 20:59:00 (5 occurrences)
Last logged: 21:00:00

Error rendering state template for sensor.scheduled_events_privat_24h: UndefinedError: ‘dict object’ has no attribute ‘calendar.privat’

[petro]

Sorry, didn’t change the service call from calendar.list_events to calendar.get_events. Make that change and it’ll work.

[123 (Taras)]

For future reference:

Problem with new service call "calendar.get_events"

For future reference, the Calendar integration’s documentation includes an example showing how to use calendar.get_events. The main difference from the previous version is that calendar.get_events can report events for multiple calendars. Therefore you have to specify which calendar you want from the response_variable (even if you asked for events from just one calendar). That’s why templeton_nash’s example, and the one in the documentation, reference the desired calendar’s events like this: a…

[e0909]

works now as promised
Thanks again

[remmob]

Thank you, this was very helpful.
I want to format it a bit more

start - end summary | example: 10:00-11:00 Work
and put in place of the entity name, which would give me a list of all the events.
Is that possible?

[petro]

That would have to be done in your notification.

[Michael_Dahl]

perhaps you might find something here you can use: How to list multiple calendar event in a template - #128 by Didgeridrew

[Garyw (Gary Wilkinson)]

Hi Petro, I think you helped me a year or so ago to get my automation going, however now its changed to get.events I can’t seem to get it right. I have an automation that gets the cal data for the last 24hrs and places it in a sensor that is in the templates directory, every morning piper gives me the cal events for the day I seem to be missing something? Not sure if there is a simpler way of doing it now with all the development, but this is what I have today. Any help would be appreciated.
Automation:

Sensor in templates directory