mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-13 20:36:52 +00:00
Merge branch 'current' into next
This commit is contained in:
Franck Nijhof
commit
00bd926f08
@ -69,7 +69,7 @@ GEM
|
||||
rb-fsevent (~> 0.10, >= 0.10.3)
|
||||
rb-inotify (~> 0.9, >= 0.9.10)
|
||||
mercenary (0.4.0)
|
||||
mini_portile2 (2.8.0)
|
||||
mini_portile2 (2.8.1)
|
||||
multi_json (1.15.0)
|
||||
mustermann (3.0.0)
|
||||
ruby2_keywords (~> 0.0.1)
|
||||
@ -81,8 +81,8 @@ GEM
|
||||
pathutil (0.16.2)
|
||||
forwardable-extended (~> 2.6)
|
||||
public_suffix (5.0.1)
|
||||
racc (1.6.1)
|
||||
rack (2.2.4)
|
||||
racc (1.6.2)
|
||||
rack (2.2.5)
|
||||
rack-protection (3.0.5)
|
||||
rack
|
||||
rake (13.0.6)
|
||||
|
||||
@ -42,6 +42,7 @@ The `august` integration allows you to integrate your [August](https://august.co
|
||||
| Yale Assure Lock | yes |
|
||||
| Yale Assure Lock 2 | yes |
|
||||
| Yale Conexis L1 | yes |
|
||||
| Yale Conexis L2 | yes |
|
||||
| Yale Linus | yes |
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
@ -10,23 +10,50 @@ ha_codeowners:
|
||||
ha_integration_type: entity
|
||||
---
|
||||
|
||||
The calendar integration allows you to integrate your calendars into Home Assistant. Calendars are shown on the calendar dashboard, and can be used with automations.
|
||||
The calendar integration provides calendar entities, allowing other integrations
|
||||
to integrate calendars into Home Assistant. Calendars are shown on the calendar
|
||||
dashboard and can be used with automations.
|
||||
|
||||
A calendar entity has state and attributes represent the next upcoming event (only). A calendar trigger is much more flexible, has fewer limitations, and is recommended for automations, instead of using the entity state.
|
||||
A calendar entity has a state and attributes representing the next event (only).
|
||||
A calendar trigger is much more flexible, has fewer limitations, and is
|
||||
recommended for automations instead of using the entity state.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Calendar entities are here to be consumed and provided by other integrations.
|
||||
|
||||
This page, therefore, does not provide instructions on how to create calendar
|
||||
entities. Please see the ["Calendar" category](/integrations/#calendar) on the
|
||||
integrations page to find integration offering calendar entities.
|
||||
|
||||
</div>
|
||||
|
||||
## Viewing and managing calendars
|
||||
|
||||
Each calendar is represented as its own entity 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 clicking
|
||||
the “Add event” button in the lower right corner of the calendar dashboard.
|
||||
|
||||
## Automation
|
||||
|
||||
Calendar [Triggers](/docs/automation/trigger) enable automation based on an event start or end. Review the [Automating Home Assistant](/getting-started/automation/) getting started guide on automations or the [Automation](/docs/automation/) documentation for full details.
|
||||
Calendar [Triggers](/docs/automation/trigger) enable automation based on an
|
||||
event's start or end. Review the [Automating Home Assistant](/getting-started/automation/)
|
||||
getting started guide on automations or the [Automation](/docs/automation/)
|
||||
documentation for full details.
|
||||
|
||||
{% my automations badge %}
|
||||
|
||||
|
||||
|
||||
An example of a calendar trigger in yaml:
|
||||
An example of a calendar trigger in YAML:
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
trigger:
|
||||
- trigger:
|
||||
- platform: calendar
|
||||
# Possible values: start, end
|
||||
event: start
|
||||
@ -36,10 +63,14 @@ automation:
|
||||
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 might not fire.
|
||||
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 might not fire.
|
||||
|
||||
See [Automation Trigger Variables: Calendar](/docs/automation/templating/#calendar) for additional trigger data available for conditions or actions.
|
||||
See [Automation Trigger Variables: Calendar](/docs/automation/templating/#calendar)
|
||||
for additional trigger data available for conditions or actions.
|
||||
|
||||
### Automation Recipes
|
||||
|
||||
@ -48,26 +79,26 @@ Below are a few example ways you can use Calendar triggers.
|
||||
{% details "Example: Calendar Event Notification " %}
|
||||
|
||||
This example automation consists of:
|
||||
- For the calendar entity `calendar.personal`
|
||||
- At the start of any calendar event
|
||||
- Send a notification with the title and start time of the event
|
||||
- Allowing multiple events starting at the same time
|
||||
|
||||
- For the calendar entity `calendar.personal`.
|
||||
- At the start of any calendar event.
|
||||
- Send a notification with the title and start time of the event.
|
||||
- Allowing multiple events starting at the same time.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
automation:
|
||||
alias: Calendar notification
|
||||
trigger:
|
||||
- platform: calendar
|
||||
event: start
|
||||
entity_id: calendar.personal
|
||||
action:
|
||||
- service: persistent_notification.create
|
||||
data:
|
||||
message: >-
|
||||
Event {{ trigger.calendar_event.summary }} @
|
||||
{{ trigger.calendar_event.start }}
|
||||
mode: queued
|
||||
- alias: Calendar notification
|
||||
trigger:
|
||||
- platform: calendar
|
||||
event: start
|
||||
entity_id: calendar.personal
|
||||
action:
|
||||
- service: persistent_notification.create
|
||||
data:
|
||||
message: >-
|
||||
Event {{ trigger.calendar_event.summary }} @
|
||||
{{ trigger.calendar_event.start }}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
@ -76,34 +107,34 @@ automation:
|
||||
{% details "Example: Calendar Event Light Schedule " %}
|
||||
|
||||
This example consists of:
|
||||
- For the calendar entity ` calendar.device_automation`
|
||||
- When event summary contains `Front Lights`
|
||||
- Turn on and off light named `light.front` when the event starts and ends
|
||||
|
||||
- For the calendar entity ` calendar.device_automation`.
|
||||
- When event summary contains `Front Lights`.
|
||||
- Turn on and off light named `light.front` when the event starts and ends.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
automation:
|
||||
alias: Front Light Schedule
|
||||
trigger:
|
||||
- platform: calendar
|
||||
event: start
|
||||
entity_id: calendar.device_automation
|
||||
- platform: calendar
|
||||
event: end
|
||||
entity_id: calendar.device_automation
|
||||
condition:
|
||||
- condition: template
|
||||
value_template: "{{ 'Front Lights' in trigger.calendar_event.summary }}"
|
||||
action:
|
||||
- if:
|
||||
- "{{ trigger.event == 'start' }}"
|
||||
then:
|
||||
- service: light.turn_on
|
||||
entity_id: light.front
|
||||
else:
|
||||
- service: light.turn_off
|
||||
entity_id: light.front
|
||||
mode: queued
|
||||
- alias: Front Light Schedule
|
||||
trigger:
|
||||
- platform: calendar
|
||||
event: start
|
||||
entity_id: calendar.device_automation
|
||||
- platform: calendar
|
||||
event: end
|
||||
entity_id: calendar.device_automation
|
||||
condition:
|
||||
- condition: template
|
||||
value_template: "{{ 'Front Lights' in trigger.calendar_event.summary }}"
|
||||
action:
|
||||
- if:
|
||||
- "{{ trigger.event == 'start' }}"
|
||||
then:
|
||||
- service: light.turn_on
|
||||
entity_id: light.front
|
||||
else:
|
||||
- service: light.turn_off
|
||||
entity_id: light.front
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
|
||||
@ -37,15 +37,15 @@ It is not possible to use Python imports with this integration. If you want to d
|
||||
This is a simplified example that does no real work.
|
||||
It is created as a first step, to help with:
|
||||
|
||||
- Demonstrate how to setup the script
|
||||
- Demonstrating how to setup the script
|
||||
- How to process the input data
|
||||
- How to log the script activity
|
||||
- How to troubleshoot / manually call the script.
|
||||
|
||||
Start by enabling the Python script and create the first script.
|
||||
Start by enabling the Python Scripts integration and create the first script.
|
||||
|
||||
- Add to `configuration.yaml`: `python_script:`
|
||||
- Create folder `<config>/python_scripts`
|
||||
- Create the folder `<config>/python_scripts`
|
||||
- Create a file `<config>/python_scripts/hello_world.py` in the folder and give it this content:
|
||||
|
||||
```python
|
||||
@ -82,7 +82,7 @@ logger:
|
||||
The following example shows how to trigger a custom event over the `hass.bus`.
|
||||
|
||||
This example uses the `hello_world.py` from the previous example.
|
||||
Edit the file and the code listed below to the end of the file.
|
||||
Edit the file adding the code listed below to the end of the file.
|
||||
There is no need to reload the configuration or restart Home Assistant.
|
||||
|
||||
```python
|
||||
|
||||
@ -44,7 +44,7 @@ Devices must have a Yale Access module installed to function with this integrati
|
||||
|
||||
These devices do not send updates, but can be locked and unlocked.
|
||||
|
||||
- MD-04I (Yale Conexis L1)
|
||||
- MD-04I (Yale Conexis L1, Yale Conexis L2)
|
||||
- YRCB-490 (Yale Smart Cabinet Lock)
|
||||
|
||||
## Push updates
|
||||
|
||||
@ -41,7 +41,7 @@ The integration is tested and verified for the following devices from YoLink:
|
||||
|
||||
* YS6602/4 YS6704 (outlet | plug)
|
||||
* YS7103/4/5 (siren)
|
||||
* YS7704 (door sensor)
|
||||
* YS7704/7705/7706 (door sensor)
|
||||
* YS7707 (Contact Sensor)
|
||||
* YS7804/5 (motion sensor)
|
||||
* YS7903/4 (leak sensor)
|
||||
@ -52,6 +52,6 @@ The integration is tested and verified for the following devices from YoLink:
|
||||
* YS5705/6 (switch)
|
||||
* YS7A01/2 (CO & Smoke Sensor)
|
||||
* YS4002/3 (Thermostat)
|
||||
* YS4906/8 YS7706 (Garage Door Sensor/ Garage Door Controller)
|
||||
* YS4906/8 (Garage Door Sensor/ Garage Door Controller)
|
||||
* YS5707 (Dimmer)
|
||||
* YS6801/2 (MultiOutlet)
|
||||
|
||||
@ -83,6 +83,7 @@ Some other Zigbee coordinator hardware may not support a firmware that is capabl
|
||||
- [RaspBee II (a.k.a. RaspBee 2) Raspberry Pi Shield from dresden elektronik](https://phoscon.de/raspbee2)
|
||||
- [RaspBee Raspberry Pi Shield from dresden elektronik](https://phoscon.de/raspbee)
|
||||
- Silicon Labs EmberZNet based radios using the EZSP protocol (via the [bellows](https://github.com/zigpy/bellows) library for zigpy)
|
||||
- [Home Assistant SkyConnect](/skyconnect/)
|
||||
- [ITead SONOFF Zigbee 3.0 USB Dongle Plus Model "ZBDongle-E" (EFR32MG21 variant)](https://itead.cc/product/zigbee-3-0-usb-dongle/)
|
||||
- [ITead Sonoff ZBBridge](https://itead.cc/product/sonoff-zbbridge/) (Note! [WiFi-based bridges are not recommended for ZHA with EZSP radios](https://github.com/home-assistant/home-assistant.io/issues/17170). Also, this first have to be flashed with [Tasmota firmware and Silabs EmberZNet NCP EZSP UART Host firmware to use as Serial-to-IP adapter](https://www.digiblur.com/2020/07/how-to-use-sonoff-zigbee-bridge-with.html))
|
||||
- [Nortek GoControl QuickStick Combo Model HUSBZB-1 (Z-Wave & Zigbee Ember 3581 USB Adapter)](https://www.nortekcontrol.com/products/2gig/husbzb-1-gocontrol-quickstick-combo/) (Note! Not a must but recommend [upgrade the EmberZNet NCP application firmware](https://github.com/walthowd/husbzb-firmware))
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user