Calendar

The Calendar integration集成将 Home Assistant 与您的设备、服务等连接和集成。 [Learn more] provides calendar entities实体表示 Home Assistant 中的传感器、执行器或功能。实体用于监控物理属性或控制其他实体。实体通常是设备或服务的一部分。 [Learn more], allowing other integrations to integrate calendars into Home Assistant. Calendars are shown on the calendar dashboard and can be used with automations.

This page does not provide instructions on how to create calendar entities. Please see the “Calendar” category on the integrations page to find integrations offering calendar entities. For example, Local Calendar is a fully local integration to create calendars and events within your Home Assistant instance or other integrations work with other services providing calendar data.

Viewing and managing calendars

Each calendar is represented as its own entity实体表示 Home Assistant 中的传感器、执行器或功能。实体用于监控物理属性或控制其他实体。实体通常是设备或服务的一部分。 [Learn more] in Home Assistant and can be viewed and managed on a calendar dashboard. You can find the calendar dashboard in the main sidebar of your Home Assistant instance.

Some calendar integrations allow Home Assistant to manage your calendars directly from Home Assistant. In this case, you can add new events by selecting the Add event button in the lower right corner of the calendar dashboard.

Also see Actions below.

The state of a calendar entity

The state shows whether or not there is an active event:

• On: The calendar has an active event.
• Off: The calendar does not have an active event.

In addition, the entity can have the following states:

• Unavailable: The entity is currently unavailable.
• Unknown: The state is not yet known.

Automation

Calendar Triggers enable automationHome Assistant 中的自动化允许您自动响应在家中和周围发生的事情。 [Learn more] based on an event’s start or end. Review the Automating Home Assistant getting started guide on automations or the Automation documentation for full details.

Calendar triggers触发器是定义的一组平台值或条件，用于触发自动化运行。 [Learn more] are the best way to automate based on calendar events. A calendar entity实体表示 Home Assistant 中的传感器、执行器或功能。实体用于监控物理属性或控制其他实体。实体通常是设备或服务的一部分。 [Learn more] can also be used to automate based on its state, but these are limited and attributes only represent the next event.

An example of a calendar trigger触发器是定义的一组平台值或条件，用于触发自动化运行。 [Learn more] in YAML:

automation:
  - triggers:
    - trigger: calendar
      # Possible values: start, end
      event: start
      # The calendar entity_id
      entity_id: calendar.personal
      # Optional time offset to fire a set time before or after event start/end
      offset: -00:15:00

Calendar triggers should not generally use automation mode single to ensure the trigger can fire when multiple events start at the same time (e.g., use queued or parallel instead). Note that calendars are read once every 15 minutes. When testing, make sure you do not plan events less than 15 minutes away from the current time, or your trigger触发器是定义的一组平台值或条件，用于触发自动化运行。 [Learn more] might not fire.

See Automation Trigger Variables: Calendar for additional trigger data available for conditions or actions.

Automation recipes

Below are a few example ways you can use Calendar triggers.

automation:
  - alias: "Calendar notification"
    triggers:
      - trigger: calendar
        event: start
        entity_id: calendar.personal
    actions:
      - action: persistent_notification.create
        data:
          message: >-
            Event {{ trigger.calendar_event.summary }} @
            {{ trigger.calendar_event.start }}

automation:
  - alias: "Front Light Schedule"
    triggers:
      - trigger: calendar
        event: start
        entity_id: calendar.device_automation
      - trigger: calendar
        event: end
        entity_id: calendar.device_automation
    conditions:
      - condition: template
        value_template: "{{ 'Front Lights' in trigger.calendar_event.summary }}"
    actions:
      - if:
          - "{{ trigger.event == 'start' }}"
        then:
          - action: light.turn_on
            target:
              entity_id: light.front
        else:
          - action: light.turn_off
            target:
              entity_id: light.front

Actions

Some calendar integrations集成将 Home Assistant 与您的设备、服务等连接和集成。 [Learn more] allow Home Assistant to manage your calendars directly using actions动作在 Home Assistant 的多个地方使用。作为脚本或自动化的一部分，动作定义了触发器被激活后将发生的事情。在脚本中，动作被称为序列。 [Learn more]. The actions provided by some calendar entity实体表示 Home Assistant 中的传感器、执行器或功能。实体用于监控物理属性或控制其他实体。实体通常是设备或服务的一部分。 [Learn more] are described below or you can read more about actions.

Action calendar.create_event

Add a new calendar event. A calendar target is selected with a Target Selector and the data payload supports the following fields:

This is a full example of an action动作在 Home Assistant 的多个地方使用。作为脚本或自动化的一部分，动作定义了触发器被激活后将发生的事情。在脚本中，动作被称为序列。 [Learn more] in YAML:

action: calendar.create_event
target:
  entity_id: calendar.device_automation_schedules
data:
  summary: "Example"
  start_date: "2022-10-01"
  end_date: "2022-10-02"

Home Assistant Calendars do not allow zero duration Calendar events. The following would create a one minute long event starting “now”. This could be used to record an external event in a Calendar.

action: calendar.create_event
target:
  entity_id: calendar.device_automation_schedules
data:
  summary: "Example"
  start_date_time: "{{ now() }}"
  end_date_time: "{{ now() + timedelta(minutes=1) }}"

Action calendar.get_events

This action populates Response Data with calendar events within a date range. It can return events from multiple calendars.

action: calendar.get_events
target:
  entity_id:
    - calendar.school
    - calendar.work
data:
  duration:
    hours: 24
response_variable: agenda

The response data contains a field for every calendar entity (e.g. calendar.school and calendar.work in this case). Every calendar entity has a field events containing a list of events with these fields:

This example uses a template with response data in another action:

action: notify.nina
data:
  title: Daily agenda for {{ now().date() }}
  message: >-
    Your school calendar for today:
    {% for event in agenda["calendar.school_calendar"]["events"] %}
    {{ event.start}}: {{ event.summary }}<br>
    {% endfor %}
    Your work calendar for today:
    {% for event in agenda["calendar.work_calendar"]["events"] %}
    {{ event.start}}: {{ event.summary }}<br>
    {% endfor %}