mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-25 10:17:23 +00:00
Merge branch 'current' into next
This commit is contained in:
Franck Nijhof
commit
8446840c1b
@ -101,8 +101,8 @@ social:
|
||||
# Home Assistant release details
|
||||
current_major_version: 0
|
||||
current_minor_version: 108
|
||||
current_patch_version: 0
|
||||
date_released: 2020-04-08
|
||||
current_patch_version: 3
|
||||
date_released: 2020-04-10
|
||||
|
||||
# Either # or the anchor link to latest release notes in the blog post.
|
||||
# Must be prefixed with a # and have double quotes around it.
|
||||
|
||||
6
source/_cookbook/configuration_yaml_by_DrJohnT.markdown
Normal file
6
source/_cookbook/configuration_yaml_by_DrJohnT.markdown
Normal file
@ -0,0 +1,6 @@
|
||||
---
|
||||
title: "Configuration.yaml by DrJohnT"
|
||||
description: "Velux windows, Drayton Wiser heating, Audio / Visual, lighting and humidity controlled fans"
|
||||
ha_category: Example configuration.yaml
|
||||
ha_external_link: https://github.com/DrJohnT/HomeAssistantPublicConfig
|
||||
---
|
||||
@ -76,7 +76,15 @@ Knowing how to access the [state object](/docs/configuration/state_object/) of a
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Be aware that if you reference a trigger state object in an automation action, attempting to test that automation by calling the `automation.trigger` service or by clicking EXECUTE in the More Info box for the automation will not work. This is because the trigger state object doesn't exist in those contexts. One way to test automations like these is to manually change the state of the trigger entity at Developer Tools > States.
|
||||
Be aware that if you reference a `trigger` state object in templates of automation `action`, attempting to test that automation by calling the `automation.trigger` service or by clicking EXECUTE in the More Info box for the automation will not work. This is because the trigger state object doesn't exist in those contexts. One way to test automations like these is to manually check that the templates work as expected by pasting them in Developer Tools > Template together with your trigger's definition like:
|
||||
|
||||
{%raw%}
|
||||
```yaml
|
||||
{% set trigger={'to_state':{'state': 'heat'}} %}
|
||||
{% set option = trigger.to_state.state %}
|
||||
{{ 'on' if option == 'heat' else 'off' }}
|
||||
```
|
||||
{%endraw%}
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -352,6 +352,8 @@ automation:
|
||||
|
||||
You could run the above automation by sending a POST HTTP request to `http://your-home-assistant:8123/api/webhook/some_hook_id`. An example with no data sent to a SSL/TLS secured installation and using the command-line curl program is `curl -d "" https://your-home-assistant:8123/api/webhook/some_hook_id`.
|
||||
|
||||
Note that each webhook can only be used in one automation at a time.
|
||||
|
||||
### Zone trigger
|
||||
|
||||
Zone trigger fires when an entity is entering or leaving the zone. For zone automation to work, you need to have setup a device tracker platform that supports reporting GPS coordinates. This includes [GPS Logger](/integrations/gpslogger/), the [OwnTracks platform](/integrations/owntracks/) and the [iCloud platform](/integrations/icloud/).
|
||||
|
||||
@ -8,7 +8,7 @@ AppDaemon is a loosely coupled, multithreaded, sandboxed Python execution enviro
|
||||
|
||||
# Another Take on Automation
|
||||
|
||||
AppDaemon is not meant to replace Home Assistant Automations and Scripts, rather complement them. For a lot of things, automations work well and can be very succinct. However, there is a class of more complex automations for which they become harder to use, and appdeamon then comes into its own. It brings quite a few things to the table:
|
||||
AppDaemon is not meant to replace Home Assistant Automations and Scripts, rather complement them. For a lot of things, automations work well and can be very succinct. However, there is a class of more complex automations for which they become harder to use, and AppDaemon then comes into its own. It brings quite a few things to the table:
|
||||
|
||||
- New paradigm - Some problems require a procedural and/or iterative approach, and `AppDaemon` Apps are a much more natural fit for this. Recent enhancements to Home Assistant scripts and templates have made huge strides, but for the most complex scenarios, Apps can do things that automations can't.
|
||||
- Ease of use - AppDaemon's API is full of helper functions that make programming as easy and natural as possible. The functions and their operation are as "Pythonic" as possible; experienced Python programmers should feel right at home.
|
||||
|
||||
@ -175,7 +175,10 @@ If you want to use a USB Bluetooth adapter or Z-Wave USB stick with Home Assista
|
||||
The above command should show you any USB devices plugged into your NAS. If you have more than one, you may get multiple items returned. Like : `ttyACM0`
|
||||
|
||||
- Run Docker command:
|
||||
`docker run --init --name home-assistant --net=host --privileged -itd -v /share/CACHEDEV1_DATA/Public/homeassistant/config:/config -e variable=TZ -e value=Europe/London --device /dev/ttyACM0 homeassistant/home-assistant:stable`
|
||||
|
||||
```bash
|
||||
docker run --init --name home-assistant --net=host --privileged -itd -v /share/CACHEDEV1_DATA/Public/homeassistant/config:/config -e TZ=Europe/London --device /dev/ttyACM0 homeassistant/home-assistant:stable
|
||||
```
|
||||
|
||||
`-v` is your configuration path
|
||||
`-e` is set timezone
|
||||
@ -193,7 +196,10 @@ That will tell Home Assistant where to look for our Z-Wave radio.
|
||||
|
||||
- Connect to your NAS over SSH
|
||||
- Run Docker command:
|
||||
`docker run --init --name home-assistant --net=host --privileged -itd -v /share/CACHEDEV1_DATA/Public/homeassistant/config:/config -e variable=TZ -e value=Europe/London -v /dev/bus/usb:/dev/bus/usb -v /var/run/dbus:/var/run/dbus homeassistant/home-assistant:stable`
|
||||
|
||||
```bash
|
||||
docker run --init --name home-assistant --net=host --privileged -itd -v /share/CACHEDEV1_DATA/Public/homeassistant/config:/config -e TZ=Europe/London -v /dev/bus/usb:/dev/bus/usb -v /var/run/dbus:/var/run/dbus homeassistant/home-assistant:stable
|
||||
```
|
||||
|
||||
First `-v` is your configuration path
|
||||
`-e` is set timezone
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Actiontec
|
||||
description: Instructions on how to integrate Actiontec routers into Home Assistant.
|
||||
logo: actiontec.png
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_release: 0.7
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Aladdin Connect
|
||||
description: Instructions how to integrate Genie Aladdin Connect garage door covers into Home Assistant.
|
||||
logo: aladdin_connect.png
|
||||
ha_category:
|
||||
- Cover
|
||||
ha_release: 0.75
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: AlarmDecoder
|
||||
description: Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an AlarmDecoder device.
|
||||
logo: alarmdecoder.png
|
||||
ha_category:
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Alpha Vantage
|
||||
description: Instructions on how to setup Alpha Vantage within Home Assistant.
|
||||
logo: alpha_vantage.png
|
||||
ha_category:
|
||||
- Finance
|
||||
ha_iot_class: Cloud Polling
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Ambiclimate
|
||||
description: Instructions on how to integrate Ambiclimate A/C controller into Home Assistant.
|
||||
logo: ambiclimate.png
|
||||
ha_category: Climate
|
||||
ha_release: 0.93
|
||||
ha_iot_class: Cloud Polling
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Amcrest
|
||||
description: Instructions on how to integrate Amcrest (or Dahua) IP cameras within Home Assistant.
|
||||
logo: amcrest.png
|
||||
ha_category:
|
||||
- Hub
|
||||
- Binary Sensor
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Ampio Smart Smog System
|
||||
description: Instructions on how to setup Ampio Smog sensors in Home Assistant.
|
||||
logo: ampio_smog.png
|
||||
ha_category:
|
||||
- Health
|
||||
- Sensor
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Anel NET-PwrCtrl
|
||||
description: Instructions on how to integrate ANEL PwrCtrl switches within Home Assistant.
|
||||
logo: anel.png
|
||||
ha_category:
|
||||
- Switch
|
||||
ha_iot_class: Local Polling
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Sharp Aquos TV
|
||||
description: Instructions on how to integrate a Sharp Aquos TV into Home Assistant.
|
||||
logo: sharp_aquos.png
|
||||
ha_category:
|
||||
- Media Player
|
||||
ha_release: 0.35
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Arlo
|
||||
description: Instructions on how to integrate your Netgear Arlo cameras within Home Assistant.
|
||||
logo: arlo.png
|
||||
ha_category:
|
||||
- Hub
|
||||
- Alarm
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Aruba
|
||||
description: Instructions on how to integrate Aruba routers into Home Assistant.
|
||||
logo: aruba.png
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_release: 0.7
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Asterisk Call Detail Records
|
||||
description: Instructions on how to integrate an Asterisk CDR within Home Assistant.
|
||||
logo: asterisk.png
|
||||
ha_category:
|
||||
- Mailbox
|
||||
ha_release: 0.79
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Asterisk Voicemail
|
||||
description: Instructions on how to integrate your existing Asterisk voicemail within Home Assistant.
|
||||
logo: asterisk.png
|
||||
ha_category:
|
||||
- Mailbox
|
||||
ha_iot_class: Local Push
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Avri
|
||||
description: Instructions on how to set up Avri Waste sensor within Home Assistant.
|
||||
logo: avri.jpeg
|
||||
ha_category:
|
||||
- Sensor
|
||||
ha_iot_class: Cloud Polling
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Axis
|
||||
description: Integration between network devices from Axis Communications with Home Assistant.
|
||||
logo: axis.png
|
||||
ha_category:
|
||||
- Camera
|
||||
- Binary Sensor
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Baidu
|
||||
description: Instructions on how to setup Baidu TTS with Home Assistant.
|
||||
logo: baiducloud.png
|
||||
ha_category:
|
||||
- Text-to-speech
|
||||
ha_release: 0.59
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Bitcoin
|
||||
description: Instructions on how to integrate Bitcoin data within Home Assistant.
|
||||
logo: bitcoin.png
|
||||
ha_category:
|
||||
- Finance
|
||||
ha_release: pre 0.7
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Blockchain.com
|
||||
description: Instructions on how to integrate Blockchain.com data within Home Assistant.
|
||||
logo: blockchain.png
|
||||
ha_category:
|
||||
- Finance
|
||||
ha_release: 0.47
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: BloomSky
|
||||
description: Instructions on how to integrate the BloomSky within Home Assistant.
|
||||
logo: bloomsky.png
|
||||
ha_category:
|
||||
- Environment
|
||||
- Binary Sensor
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Bluetooth LE Tracker
|
||||
description: Instructions for integrating bluetooth low-energy tracking within Home Assistant.
|
||||
logo: bluetooth.png
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_iot_class: Local Polling
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Bluetooth Tracker
|
||||
description: Instructions for integrating Bluetooth tracking within Home Assistant.
|
||||
logo: bluetooth.png
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_iot_class: Local Polling
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Australian Bureau of Meteorology (BOM)
|
||||
description: Instructions on how to integrate Bureau of Meteorology Australia weather conditions into Home Assistant.
|
||||
logo: bom.png
|
||||
ha_category:
|
||||
- Weather
|
||||
- Sensor
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Sony Bravia TV
|
||||
description: Instructions on how to integrate a Sony Bravia TV into Home Assistant.
|
||||
logo: bravia.png
|
||||
ha_category:
|
||||
- Media Player
|
||||
ha_release: 0.23
|
||||
|
||||
@ -106,7 +106,7 @@ custom_calendars:
|
||||
|
||||
### Sensor attributes
|
||||
|
||||
- **offset_reached**: If set in the event title and parsed out will be on/off once the offset in the title in minutes is reached. So the title Very important meeting !!-10 would trigger this attribute to be on 10 minutes before the event starts.
|
||||
- **offset_reached**: If set in the event title and parsed out will be on/off once the offset in the title in minutes is reached. So the title Very important meeting !!-10 would trigger this attribute to be on 10 minutes before the event starts. This should be in the format of `HH:MM` or `MM`.
|
||||
- **all_day**: `True/False` if this is an all day event. Will be `False` if there is no event found.
|
||||
- **message**: The event title with the `search` values extracted. So in the above example for `offset_reached` the message would be set to Very important meeting
|
||||
- **description**: The event description.
|
||||
|
||||
@ -85,7 +85,7 @@ For example, the following action in an automation would take a recording from "
|
||||
```yaml
|
||||
action:
|
||||
service: camera.record
|
||||
data:
|
||||
data_template:
|
||||
entity_id: camera.yourcamera
|
||||
filename: '/tmp/{{ entity_id }}_{{ now().strftime("%Y%m%d-%H%M%S") }}.mp4'
|
||||
```
|
||||
|
||||
@ -27,7 +27,8 @@ Note that Home Assistant Cast requires your Home Assistant installation to be ac
|
||||
|
||||
## Advanced use
|
||||
|
||||
Cast devices can only be discovered if they are on the same subnet as Home Assistant. If this is not the case, you need to configure the IP address of the Cast device directly:
|
||||
### Manual configuration
|
||||
By default, any discovered Cast device is added to Home Assistant. This can be restricted by supplying a white list of wanted chrome casts.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -43,7 +44,7 @@ media_player:
|
||||
type: list
|
||||
keys:
|
||||
host:
|
||||
description: Use only if you don't want to scan for devices.
|
||||
description: IP-address of a Cast device to add to Home Assistant. Use only if you don't want to add all available devices. The device won't be added until discovered through mDNS.
|
||||
required: false
|
||||
type: string
|
||||
ignore_cec:
|
||||
@ -53,3 +54,12 @@ media_player:
|
||||
required: false
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
### Cast devices and Home Assistant on different subnets
|
||||
|
||||
Cast devices can only be discovered and connected to if they are on the same subnet as Home Assistant. If this is not the case, it's necessary to:
|
||||
|
||||
- Enable mDNS forwarding between the subnets.
|
||||
- Enable source NAT to make requests from Home Assistant to the Chromecast appear to come from the same subnet as the Chromecast.
|
||||
|
||||
Setups with cast devices on a different subnet than Home Assistant are not recommended and not supported.
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Cisco IOS
|
||||
description: Instructions on how to integrate Cisco IOS routers into Home Assistant.
|
||||
logo: cisco.png
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_release: 0.33
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Cisco Mobility Express
|
||||
description: Instructions on how to integrate Cisco Mobility Express wireless controllers into Home Assistant.
|
||||
logo: cisco.png
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_release: '0.90'
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Coinbase
|
||||
description: Instructions for how to add Coinbase sensors to Home Assistant.
|
||||
logo: coinbase.png
|
||||
ha_category:
|
||||
- Finance
|
||||
- Sensor
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Zehnder ComfoAir Q
|
||||
description: Instructions on how to integrate Zehnder ComfoAir Q350/450/600 ventilation systems into Home Assistant.
|
||||
logo: zehnder.png
|
||||
ha_category:
|
||||
- Fan
|
||||
- Sensor
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Aruba ClearPass
|
||||
description: Instructions on how to integrate Aruba ClearPass into Home Assistant.
|
||||
logo: aruba.png
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_release: '0.90'
|
||||
|
||||
@ -33,8 +33,9 @@ Known supported devices:
|
||||
- Marantz M-RC610
|
||||
- Marantz SR5008
|
||||
- Marantz SR6007 - SR6010
|
||||
- Marantz NR1506
|
||||
- Marantz NR1504
|
||||
- Marantz NR1604
|
||||
- Marantz NR1506
|
||||
- Other Denon AVR receivers (untested)
|
||||
- Marantz receivers (experimental)
|
||||
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Dialogflow
|
||||
description: Instructions on how integrate Dialogflow with Home Assistant.
|
||||
logo: dialogflow.png
|
||||
ha_category:
|
||||
- Voice
|
||||
ha_release: 0.56
|
||||
|
||||
@ -8,16 +8,15 @@ ha_release: '0.100'
|
||||
ha_domain: doods
|
||||
---
|
||||
|
||||
The `doods` image processing platform allows you to detect and recognize objects in a camera image using [DOODS](https://github.com/snowzach/doods/). The state of the entity is the number of objects detected, and recognized objects are listed in the `summary` attribute along with quantity. The `matches` attribute provides the confidence `score` for recognition and the bounding `box` of the object for each detection category.
|
||||
The `doods` image processing integration allows you to detect and recognize objects in a camera image using [DOODS](https://github.com/snowzach/doods/). The state of the entity is the number of objects detected and recognized objects are listed in the `summary` attribute along with quantity. The `matches` attribute provides the confidence `score` for recognition and the bounding `box` of the object for each detection category.
|
||||
|
||||
## Setup
|
||||
|
||||
You need to have DOODS running somewhere. It's easiest to run as a Docker container and deployment is described on Docker Hub
|
||||
[DOODS - Docker](https://hub.docker.com/r/snowzach/doods)
|
||||
You need to have DOODS running somewhere. It's easiest to run as a [Docker](https://hub.docker.com/r/snowzach/doods) container.
|
||||
|
||||
## Configuration
|
||||
|
||||
The configuration loosely follows the TensorFlow configuration. To enable this platform in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable this integration in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -44,20 +43,20 @@ source:
|
||||
required: false
|
||||
type: string
|
||||
url:
|
||||
description: The URL of the DOODS server
|
||||
description: The URL of the DOODS server.
|
||||
required: true
|
||||
type: string
|
||||
timeout:
|
||||
description: Timeout for requests (in seconds)
|
||||
description: Timeout for requests (in seconds).
|
||||
required: false
|
||||
type: integer
|
||||
default: 90
|
||||
detector:
|
||||
description: The DOODS detector to use
|
||||
description: The DOODS detector to use.
|
||||
required: true
|
||||
type: string
|
||||
confidence:
|
||||
description: The default confidence for any detected objects where not explicitly set
|
||||
description: The default confidence for any detected objects where not explicitly set.
|
||||
required: false
|
||||
type: float
|
||||
area:
|
||||
@ -104,7 +103,7 @@ labels:
|
||||
required: true
|
||||
type: string
|
||||
confidence:
|
||||
description: The minimum confidence for the selected label
|
||||
description: The minimum confidence for the selected label.
|
||||
required: false
|
||||
type: float
|
||||
area:
|
||||
@ -140,9 +139,12 @@ labels:
|
||||
|
||||
{% endconfiguration %}
|
||||
|
||||
## Sample configuration
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example advanced configuration.yaml entry
|
||||
# Example configuration.yaml entry
|
||||
image_processing:
|
||||
- platform: doods
|
||||
scan_interval: 1000
|
||||
@ -152,8 +154,8 @@ image_processing:
|
||||
source:
|
||||
- entity_id: camera.front_yard
|
||||
file_out:
|
||||
- "/tmp/{% raw %}{{ camera_entity.split('.')[1] }}{% endraw %}_latest.jpg"
|
||||
- "/tmp/{% raw %}{{ camera_entity.split('.')[1] }}_{{ now().strftime('%Y%m%d_%H%M%S') }}{% endraw %}.jpg"
|
||||
- "/tmp/{{ camera_entity.split('.')[1] }}_latest.jpg"
|
||||
- "/tmp/{{ camera_entity.split('.')[1] }}_{{ now().strftime('%Y%m%d_%H%M%S') }}.jpg"
|
||||
confidence: 50
|
||||
# This global detection area is required for all labels
|
||||
area:
|
||||
@ -177,9 +179,11 @@ image_processing:
|
||||
- truck
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
## Optimizing resources
|
||||
|
||||
[Image processing components](/components/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing.
|
||||
The [Image processing integration](/components/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds) and then call the `image_processing.scan` service when you actually want to perform processing.
|
||||
|
||||
```yaml
|
||||
# Example advanced configuration.yaml entry
|
||||
|
||||
@ -32,7 +32,7 @@ It is recommended to set up a new account on your Doorbird App for use with Home
|
||||
|
||||
## Configuration
|
||||
|
||||
To add `DoorBird` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **DoorBird**.
|
||||
To add `DoorBird` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **DoorBird**. After filling out UI prompts, click the gear icon to edit device settings. Enter device event names here to associate with a schedule in DoorBird app. See [Schedules](#schedules)
|
||||
|
||||
Alternatively, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -129,7 +129,8 @@ Simply open a new browser window and navigate to `{Home Assistant URL}/api/doorb
|
||||
localhost:8123`. Replace `{DEVICE_TOKEN}` with the token specified in your configuration for the device you would like to clear.
|
||||
<br><br>
|
||||
Please note that clearing device events will require configuration steps above to be taken again. It could also affect other third-party applications you may use with your DoorBird device. It will not break the official mobile app in any way, so mobile push notifications will still work.
|
||||
|
||||
<br><br>
|
||||
If DoorBird was setup using UI prompts, a token can be discovered through DoorBird App by clicking settings (cog icon) -> Administration-> LOGIN (using your App Administration details). Under the "FAVORITES" section, choose "HTTP(S) Calls". This displays all events and the associated HTTP URL. In that URL field, you will be able to see the token that was auto-generated by Home Assistant.
|
||||
|
||||
#### Event Data
|
||||
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Efergy
|
||||
description: Instructions on how to integrate Efergy devices within Home Assistant.
|
||||
logo: efergy.png
|
||||
ha_category:
|
||||
- Energy
|
||||
ha_release: pre 0.7
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Envisalink
|
||||
description: Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an envisalink evl3/evl4 board.
|
||||
logo: eyezon.png
|
||||
ha_category:
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Epson
|
||||
description: Instructions on how to integrate Epson projector into Home Assistant.
|
||||
logo: epson.png
|
||||
ha_category:
|
||||
- Media Player
|
||||
ha_release: 0.72
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Epson Workforce
|
||||
description: Instructions on how to integrate Epson Workforce Printer into Home Assistant.
|
||||
logo: epson.png
|
||||
ha_category:
|
||||
- Sensor
|
||||
ha_release: 0.92
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Fido
|
||||
description: Instructions on how to integrate Fido data usage within Home Assistant.
|
||||
logo: fido.png
|
||||
ha_category:
|
||||
- Network
|
||||
ha_release: 0.39
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Gearbest
|
||||
description: Instructions on how to integrate a Gearbest sensor into Home Assistant.
|
||||
logo: gearbest.png
|
||||
ha_category:
|
||||
- Sensor
|
||||
ha_iot_class: Cloud Polling
|
||||
|
||||
@ -94,10 +94,9 @@ arrival:
|
||||
required: false
|
||||
type: time
|
||||
departure:
|
||||
description: "Time when travel is expected to end. A 24 hour time string like `08:00:00`. On a sensor update it will be combined with the current date to get travel time for that moment. Cannot be used in combination with `arrival`. The default is now (the current date and time)"
|
||||
description: "Time when travel is expected to end. A 24 hour time string like `08:00:00`. On a sensor update it will be combined with the current date to get travel time for that moment. Cannot be used in combination with `arrival`. If departure is not provided each update of the sensor uses the current date and time."
|
||||
required: false
|
||||
type: time
|
||||
default: "now"
|
||||
unit_system:
|
||||
description: "You can choose between `metric` or `imperial`."
|
||||
required: false
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Hikvision
|
||||
description: Instructions on how to integrate Hikvision camera switches into Home Assistant.
|
||||
logo: hikvision.png
|
||||
ha_category:
|
||||
- Switch
|
||||
ha_release: pre 0.7
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Hisense AEH-W4A1
|
||||
description: Instructions to setup the Hisense AEH W4A1 WiFi module for ACs.
|
||||
logo: hisense.png
|
||||
ha_release: 0.103
|
||||
ha_category:
|
||||
- Climate
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Hunter Douglas PowerView
|
||||
description: Instructions on how to setup Hunter Douglas PowerView scenes within Home Assistant.
|
||||
logo: hunter-douglas-powerview.png
|
||||
ha_category:
|
||||
- Scene
|
||||
ha_release: 0.15
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Hunter Hydrawise
|
||||
description: Instructions on how to integrate your Hunter Hydrawise Wi-Fi irrigation control system within Home Assistant.
|
||||
logo: hydrawise_logo.png
|
||||
ha_category:
|
||||
- Irrigation
|
||||
- Binary Sensor
|
||||
|
||||
@ -19,7 +19,6 @@ To enable input booleans in your installation, add the following lines to your `
|
||||
input_boolean:
|
||||
notify_home:
|
||||
name: Notify when someone arrives home
|
||||
initial: off
|
||||
icon: mdi:car
|
||||
```
|
||||
|
||||
|
||||
@ -10,21 +10,25 @@ ha_release: 0.45
|
||||
ha_domain: kira
|
||||
---
|
||||
|
||||
The `kira` integration is the main integration to integrate Keene Electronics IR over IP [Kira](https://www.keene.co.uk/keene-ir-anywhere-single-worldwide.html) modules with Home Assistant.
|
||||
The `kira` integration is the main integration to integrate Keene Electronics IR over IP [Kira](https://k2audio.co.uk/collections/ip-and-internet-control) modules with Home Assistant.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Remote
|
||||
- Sensor
|
||||
- Remote (emit an IR code when instructed by Home Assistant)
|
||||
- Sensor (trigger Home Assistant to do something when a particular IR signal is received)
|
||||
|
||||
### Example Configuration
|
||||
Some models (original Kira and Kira128) can be configured to act as either a sensor or as a remote. They are also able act as both when set to Standalone mode. The wireless models are hardware specific so the receiver can only be integrated as a sensor and the transmitter can only be integrated as a remote.
|
||||
|
||||
If you are using two or more Kira devices for point to point IR transfer across your network they can continue to perform this function whilst also acting as a sensor or remote for Home Assistant.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
kira:
|
||||
```
|
||||
|
||||
Kira modules have no built-in mechanism for auto-discovery, so will need to be configured to send packets to Home Assistant. Documentation for this can be found on the manufacturer's website [Here](https://www.keene.co.uk/pages/iranywhere/index.html).
|
||||
Kira modules have no built-in mechanism for auto-discovery, so will need to be configured to send packets to Home Assistant. The process varies according to the module type. The documentation for each can be found on the [manufacturer's website](https://www.info.keene-electronics.co.uk).
|
||||
|
||||
### Configuration Options
|
||||
|
||||
@ -83,7 +87,15 @@ remotes:
|
||||
|
||||
If no sensors or remotes are specified, a sensor with default values will be added.
|
||||
|
||||
### Code Configuration
|
||||
### Entities
|
||||
|
||||
Restart Home Assistant and you should now have an entity called `kira_remote` (or whatever you called it). To check go to Developer Tools > States and start to type “kira” within the entity list.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/integrations/kira/kira_states.png' />
|
||||
</p>
|
||||
|
||||
### IR Codes
|
||||
|
||||
The first time the Kira integration is loaded, `kira_codes.yaml` will be created in the Home Assistant configuration directory.
|
||||
|
||||
@ -129,11 +141,102 @@ repeat:
|
||||
|
||||
Some manufacturers (e.g., Samsung) require an IR code to be sent a number of times in a row in rapid succession (usually 3). This doesn't apply to the vast majority of devices, but it can be helpful if needed.
|
||||
|
||||
You now need to edit `kira_codes.yaml` to make sure it contains the codes you want the Kira to blast out as a remote or respond to as a sensor. Note that each time you edit and save the `kira_codes.yaml` file you need to restart Home Assistant for the changes to take effect, reloading the automations alone is not sufficient.
|
||||
|
||||
### Example remote
|
||||
|
||||
Using the number 1 button from a Panasonic DVD player:
|
||||
|
||||
```yaml
|
||||
# Example kira_codes.yaml entry
|
||||
- name: PanaOne
|
||||
code: "K 2432 0D31 06EB 0196 01F3 0194 0538 01B4 01D3 01B4 01D1 01B4 01D3 01B4 01D3 01B3 01D3 01B3 01D3 01B4 01D3 01B3 01D3 01B3 01D3 01B4 01D3 01B3 01D3 01B4 0518 01B4 01D3 01B3 01D3 01B4 01D1 01B7 01D1 01B7 01D1 01B4 01D3 01B4 0518 01B4 01D3 01B4 01D1 01B7 0518 01B4 01D3 01B3 01D3 01B4 01D1 01B7 01D1 01B4 01D3 01B4 01D1 01B7 01D1 01B7 01D1 01B4 01D3 01B4 01D1 01B7 01D1 01B4 01D3 01B4 0518 01B4 01D3 01B4 01D1 01B7 01D1 01B7 01D1 01B4 01D3 01B4 01D1 01B7 01D1 01B4 01D3 01B4 01D1 01B7 01D1 01B4 0518 01B7 2000"
|
||||
device: DVD
|
||||
type: kira
|
||||
```
|
||||
|
||||
Go to "Configuration" and select "Scripts" and click to add a new script. This is an example using the Panasonic code above.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/integrations/kira/kira_remote_script.png' />
|
||||
</p>
|
||||
|
||||
When you have filled in the data to match your YAML entry save the script and test it by clicking the play button next to the name you assigned. If all has gone well your Kira module should now blast this IR code and operate your equipment.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/integrations/kira/kira_test_script.png' />
|
||||
</p>
|
||||
|
||||
Once you know the code is working and procedure is correct you can use the facility in any number of ways, perhaps triggering the output based on sensor readings or by adding a number of buttons as a virtual remote in the Home Assistant front end.
|
||||
|
||||
### Example sensor
|
||||
|
||||
Using the number 1 and 2 buttons from a Panasonic DVD player:
|
||||
|
||||
```yaml
|
||||
# Example kira_codes.yaml entry
|
||||
- name: PanaOne
|
||||
code: "K 2432 0D31 06EB 0196 01F3 0194 0538 01B4 01D3 01B4 01D1 01B4 01D3 01B4 01D3 01B3 01D3 01B3 01D3 01B4 01D3 01B3 01D3 01B3 01D3 01B4 01D3 01B3 01D3 01B4 0518 01B4 01D3 01B3 01D3 01B4 01D1 01B7 01D1 01B7 01D1 01B4 01D3 01B4 0518 01B4 01D3 01B4 01D1 01B7 0518 01B4 01D3 01B3 01D3 01B4 01D1 01B7 01D1 01B4 01D3 01B4 01D1 01B7 01D1 01B7 01D1 01B4 01D3 01B4 01D1 01B7 01D1 01B4 01D3 01B4 0518 01B4 01D3 01B4 01D1 01B7 01D1 01B7 01D1 01B4 01D3 01B4 01D1 01B7 01D1 01B4 01D3 01B4 01D1 01B7 01D1 01B4 0518 01B7 2000"
|
||||
device: DVD
|
||||
type: kira
|
||||
|
||||
- name: PanaTwo
|
||||
code: "K 2432 0D30 06EE 0192 01F6 0192 053A 0192 01F3 0194 01F3 0194 01F3 0192 01F6 0192 01F3 0194 01F3 0192 01F6 0192 01F3 0194 01F3 0192 01F6 0192 01F3 0194 053A 0192 01F3 0194 01F3 0194 01F3 0194 01F3 0192 01F3 0194 01F3 0194 053A 0192 01F6 0192 01F3 0194 053A 0192 01F3 0194 01F3 0194 01F3 0194 01F3 0192 01F6 0192 01F3 0194 01F3 0192 01F3 0194 053A 0194 01F3 0194 01F3 0192 01F6 0192 053A 0192 01F3 0194 01F3 0194 01F3 0194 053A 0192 01F3 0194 01F3 0194 01F3 0194 01F3 0192 01F6 0192 01F3 0194 053A 0192 2000"
|
||||
device: DVD
|
||||
type: kira
|
||||
```
|
||||
|
||||
Visit the Kira module configuration page and be sure to make the following changes according to your module use:
|
||||
|
||||
If this is to be the only use of the Kira module then set the TARGET IP address to be that of your Home Assistant installation. Uncheck the “auto find” option box if present. Click on save and reboot the module.
|
||||
|
||||
If the Kira module is to used in conjunction with another module be for IR over IP then leave (or set) the TARGET IP address to that of the other Kira module and in this instance set the COMPUTER IP address to the IP address of your Home Assistant installation. Check the option box to "send to alternative device" if present. Click on save and reboot to make the changes effective.
|
||||
|
||||
Note that once you changed the COMPUTER IP you will longer be able to use the Kira utiltiy on your PC to capture IR codes.
|
||||
|
||||
Next within Home Assistant go to Developer tools -> States and scroll down the list until you see `sensor.kira_(whatever you called it)`. Aim your remote at the Kira device and press the buttons you stored the code for. If all is well you should see the state change to match the name you gave to the code.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/integrations/kira/kira_sensor_states.png' />
|
||||
</p>
|
||||
|
||||
Example automation using these IR codes to toggle a Sonoff plug.
|
||||
|
||||
```yaml
|
||||
# Example kira_sensor
|
||||
- id: '1583339338363'
|
||||
alias: Panasonic On
|
||||
description: Turn on sonoff s20 relay
|
||||
trigger:
|
||||
- entity_id: sensor.kira_wireless
|
||||
platform: state
|
||||
to: PanaOne
|
||||
condition: []
|
||||
action:
|
||||
- device_id: 3628b4f34df943b3b721ead954cf3ca7
|
||||
domain: switch
|
||||
entity_id: switch.plug2_relay
|
||||
type: turn_on
|
||||
- id: '1584035716024'
|
||||
alias: 'Panaxonic Off '
|
||||
description: Turn off sonoff s20 relay
|
||||
trigger:
|
||||
- entity_id: sensor.kira_wireless
|
||||
platform: state
|
||||
to: PanaTwo
|
||||
condition: []
|
||||
action:
|
||||
- device_id: 3628b4f34df943b3b721ead954cf3ca7
|
||||
domain: switch
|
||||
entity_id: switch.plug2_relay
|
||||
type: turn_off
|
||||
```
|
||||
|
||||
### Code Types
|
||||
|
||||
When creating an entry in `kira_codes.yaml`, a few different kinds of codes can be used.
|
||||
|
||||
- **kira**: This is the native wire protocol used by Kira modules. These can be captured using netcat.
|
||||
- **kira**: This is the native wire protocol used by Kira modules. These can be captured using the free Kira utility available from the manufacturers website.
|
||||
- **pronto**: Pronto codes are supported.
|
||||
- **nec**: If the device uses NEC IR codes and the manufacturer has published them, they can be used here.
|
||||
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: LG Netcast
|
||||
description: Instructions on how to integrate a LG TV (Netcast 3.0 & 4.0) within Home Assistant.
|
||||
logo: lg.png
|
||||
ha_category:
|
||||
- Media Player
|
||||
ha_iot_class: Local Polling
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: LG Soundbars
|
||||
description: Instructions on how to integrate LG Soundbars into Home Assistant.
|
||||
logo: lg.png
|
||||
ha_category:
|
||||
- Media Player
|
||||
ha_iot_class: Local Polling
|
||||
|
||||
@ -165,6 +165,8 @@ lock:
|
||||
command_topic: "home-assistant/frontdoor/set"
|
||||
payload_lock: "LOCK"
|
||||
payload_unlock: "UNLOCK"
|
||||
state_locked: "LOCK"
|
||||
state_unlocked: "UNLOCK"
|
||||
optimistic: false
|
||||
qos: 1
|
||||
retain: true
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: OpenWRT (luci)
|
||||
description: Instructions on how to integrate OpenWRT routers into Home Assistant.
|
||||
logo: openwrt.png
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_release: pre 0.7
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Lupus Electronics LUPUSEC
|
||||
description: Instructions on integrating Lupusec home security with Home Assistant.
|
||||
logo: lupusec.png
|
||||
ha_category:
|
||||
- Hub
|
||||
- Alarm
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Mailgun
|
||||
description: Instructions on how to add Mailgun mail notifications to Home Assistant.
|
||||
logo: mailgun.png
|
||||
ha_category:
|
||||
- Notifications
|
||||
ha_release: 0.38
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Matrix
|
||||
description: Matrix chatbot support
|
||||
logo: matrix.png
|
||||
ha_category:
|
||||
- Hub
|
||||
- Notifications
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Meraki
|
||||
description: Instructions on how to integrate Meraki-based presence detection into Home Assistant.
|
||||
logo: meraki.png
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_release: '0.60'
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Ubiquiti mFi mPort
|
||||
description: Instructions on how to integrate mFi within Home Assistant.
|
||||
logo: ubiquiti.png
|
||||
ha_category:
|
||||
- Network
|
||||
- Sensor
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Mi Flora
|
||||
description: Instructions on how to integrate MiFlora BLE plant sensor with Home Assistant.
|
||||
logo: miflora.png
|
||||
ha_category:
|
||||
- Environment
|
||||
ha_release: 0.29
|
||||
|
||||
@ -16,7 +16,9 @@ MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things
|
||||
|
||||
Your first step to get MQTT and Home Assistant working is to choose a [broker](/docs/mqtt/broker).
|
||||
|
||||
To integrate MQTT into Home Assistant, add the following section to your `configuration.yaml` file.
|
||||
The preferred way to setup MQTT for your installation is via **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **MQTT**.
|
||||
|
||||
Alternatively, if you want to manually configure MQTT, you will need to add the following to your `configuration.yaml` file.
|
||||
|
||||
To connect to your [own MQTT broker](/docs/mqtt/broker#run-your-own):
|
||||
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: MQTT Eventstream
|
||||
description: Instructions on how to setup MQTT eventstream within Home Assistant.
|
||||
logo: mqtt.png
|
||||
ha_category:
|
||||
- Other
|
||||
ha_release: 0.11
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: MQTT JSON
|
||||
description: Instructions on how to use JSON MQTT to track devices in Home Assistant.
|
||||
logo: mqtt.png
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_iot_class: Configurable
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: MQTT Room Presence
|
||||
description: Instructions on how to track room presence within Home Assistant.
|
||||
logo: mqtt.png
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_release: 0.27
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: MQTT Statestream
|
||||
description: Instructions on how to setup MQTT Statestream within Home Assistant.
|
||||
logo: mqtt.png
|
||||
ha_category:
|
||||
- Other
|
||||
ha_release: 0.54
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Mycroft
|
||||
description: Instructions on how to setup Mycroft AI within Home Assistant.
|
||||
logo: mycroft.png
|
||||
ha_category:
|
||||
- Voice
|
||||
- Notifications
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Nanoleaf
|
||||
description: Instructions how to integrate Nanoleaf Light Panels into Home Assistant.
|
||||
logo: nanoleaf_light.png
|
||||
ha_category:
|
||||
- Light
|
||||
ha_iot_class: Local Polling
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: NETGEAR
|
||||
description: Instructions on how to integrate NETGEAR routers into Home Assistant.
|
||||
logo: netgear.png
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_iot_class: Local Polling
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: NETGEAR LTE
|
||||
description: Instructions on how to integrate your NETGEAR LTE modem within Home Assistant.
|
||||
logo: netgear.png
|
||||
ha_release: 0.72
|
||||
ha_category:
|
||||
- Network
|
||||
|
||||
@ -77,6 +77,12 @@ The following binary sensors are added for each thermostat zone:
|
||||
|
||||
The `nexia` climate platform lets you control a thermostat.
|
||||
|
||||
The following thermostats are supported: `XL1050`, `XL850`, `XL824`
|
||||
|
||||
The following thermostats are not supported: `XL624`
|
||||
|
||||
Other thermostats may work, but they have not been tested.
|
||||
|
||||
### Scene
|
||||
|
||||
The `nexia` scene platform lets you activate a nexia automation.
|
||||
|
||||
@ -12,7 +12,7 @@ ha_codeowners:
|
||||
|
||||
The `nextcloud` integration pulls summary [Nextcloud](https://nextcloud.com/) information into Home Assistant.
|
||||
|
||||
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Niko Home Control
|
||||
description: Instructions on how to integrate Niko Home Control lights into Home Assistant.
|
||||
logo: niko.png
|
||||
ha_category:
|
||||
- Light
|
||||
ha_iot_class: Local Polling
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Notion
|
||||
description: How to integrate Notion kits within Home Assistant.
|
||||
logo: notion.png
|
||||
ha_category:
|
||||
- Hub
|
||||
- Binary Sensor
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: ONVIF
|
||||
description: Instructions on how to integrate a ONVIF camera within Home Assistant.
|
||||
logo: onvif.png
|
||||
ha_category:
|
||||
- Camera
|
||||
ha_release: 0.47
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: OpenSky Network
|
||||
description: Instructions on how to integrate OpenSky Network into Home Assistant.
|
||||
logo: opensky.png
|
||||
ha_category:
|
||||
- Transport
|
||||
ha_release: 0.43
|
||||
|
||||
@ -93,7 +93,7 @@ forecast:
|
||||
description: Enables the forecast. The default is to display the current conditions.
|
||||
required: false
|
||||
default: false
|
||||
type: string
|
||||
type: boolean
|
||||
language:
|
||||
description: The language in which you want text results to be returned. It's a two-characters string, e.g., `en`, `es`, `ru`, `it`, etc.
|
||||
required: false
|
||||
|
||||
@ -23,7 +23,7 @@ to your configuration.yaml:
|
||||
|
||||
```yaml
|
||||
opnsense:
|
||||
url: http://router/api
|
||||
url: https://router/api
|
||||
api_secret: API_SECRET
|
||||
api_key: API_KEY
|
||||
```
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Orangepi GPIO
|
||||
title: Orange Pi GPIO
|
||||
description: Instructions on how to integrate the GPIO capability of a Orange Pi into Home Assistant.
|
||||
ha_category:
|
||||
- DIY
|
||||
@ -13,11 +13,11 @@ ha_domain: orangepi_gpio
|
||||
|
||||
The `orangepi_gpio` integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding pages.
|
||||
|
||||
## Binary Sensor
|
||||
This integration provides the following platforms:
|
||||
|
||||
The `orangepi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your Orange Pi or NanoPi.
|
||||
- Binary sensor: The `orangepi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your Orange Pi or NanoPi.
|
||||
|
||||
## Configuration
|
||||
### Configuration
|
||||
|
||||
To use your Orange Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -79,6 +79,7 @@ As this platform supports different types of GPIO pinouts for difference Orange
|
||||
| `neocore2` | Supports the NanoPi Neocore 2 |
|
||||
|
||||
## Additional steps
|
||||
|
||||
This integration uses the `SYSFS` filesystem to get control of the GPIOs. Therefore an operating system with `CONFIG_GPIO_SYSFS` is required. As far as I know, most out-of-the-box distributions still enable this by default.
|
||||
|
||||
As of Linux 4.8 sysfs-gpio is marked as obsolete. However as of today, the alternative GPIO character device is not widely used. Therefore we will use this until the new character device is more widely supported.
|
||||
@ -92,3 +93,31 @@ SUBSYSTEM=="gpio*", PROGRAM="/bin/sh -c 'find -L /sys/class/gpio/ -maxdepth 2 -e
|
||||
```
|
||||
|
||||
Home Assistant will now be able to control your GPIO pins.
|
||||
|
||||
## Limitations
|
||||
|
||||
This integration uses interrupts to catch changes on your pins. However, it depends on the Allwinner chipset which pin banks support external interrupts. There is also a great difference between Orange Pi models which pins are routed to the GPIO connector. Therefore it greatly differs between devices which pins you can use for your sensors.
|
||||
|
||||
You can find the pinouts of all the supported Orange Pi devices [here](https://pascalroeleven.nl/2020/04/13/orange-pi-gpio-pinouts/). The pinouts for the [NanoPi Duo](http://wiki.friendlyarm.com/wiki/index.php/NanoPi_Duo) and [NanoPi NEO Core2](http://wiki.friendlyarm.com/wiki/index.php/NanoPi_NEO_Core2) can be found on the [FriendlyARM wiki](http://wiki.friendlyarm.com/). For example: If a pin is named PA01, the pin bank is PA. If this pin bank is in the following table after your chipset, this particular pin is supported.
|
||||
|
||||
| Chipset | Pin banks which support external interrupts |
|
||||
| ------- | ------------------------------------------- |
|
||||
| H2+ | PA, PG, PL |
|
||||
| H3 | PA, PG, PL |
|
||||
| H5 | PA, PF, PG, PL |
|
||||
| H6 | PF, PG, PH, PL, PM |
|
||||
| A64 | PB, PG, PH, PL |
|
||||
|
||||
In the table below you can see the number of usable pins for sensors per device.
|
||||
|
||||
| Device | Usable pins |
|
||||
| ----- | ----------- |
|
||||
| H2+ (R1, Zero) | 17/17 |
|
||||
| H3 (Lite, One, PC, PC Plus, Plus 2E) | 21/28 |
|
||||
| H5 (Zero Plus) | 17/17 |
|
||||
| H5 (Zero Plus 2) | 15/17 |
|
||||
| H5 (PC 2) | 22/28 |
|
||||
| H5 (Prime) | 17/28 |
|
||||
| H6 (Lite 2, One Plus) | 3/17 |
|
||||
| H6 (PI 3) | 8/17 |
|
||||
| A64 (Win Plus) | 18/28 |
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Orvibo
|
||||
description: Instructions on how to integrate Orvibo sockets within Home Assistant.
|
||||
logo: orvibo.png
|
||||
ha_category:
|
||||
- Switch
|
||||
ha_release: 0.8
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Panasonic Blu-Ray Player
|
||||
description: Instructions on how to integrate a Panasonic Blu-Ray player into Home Assistant.
|
||||
logo: panasonic.png
|
||||
ha_category:
|
||||
- Media Player
|
||||
ha_iot_class: Local Polling
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Panasonic Viera TV
|
||||
description: Instructions on how to integrate a Panasonic Viera TV into Home Assistant.
|
||||
logo: panasonic.png
|
||||
ha_category:
|
||||
- Media Player
|
||||
ha_release: 0.17
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Pandora
|
||||
description: Instructions on how to integrate Pandora radio into Home Assistant.
|
||||
logo: pandora.png
|
||||
ha_category:
|
||||
- Media Player
|
||||
ha_release: 0.22
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Philips TV
|
||||
description: Instructions on how to add Philips TVs to Home Assistant.
|
||||
logo: philips.png
|
||||
ha_category:
|
||||
- Media Player
|
||||
ha_iot_class: Local Polling
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Pilight
|
||||
description: Instructions on how to setup Pilight within Home Assistant.
|
||||
logo: pilight.png
|
||||
ha_category:
|
||||
- DIY
|
||||
- Binary Sensor
|
||||
|
||||
@ -138,7 +138,7 @@ To apply the user and role just created, we need to give it permissions
|
||||
* Click `Datacenter`
|
||||
* Click `Permissions`
|
||||
* Open `Add` and click `User Permission`
|
||||
* Select "\" for the path
|
||||
* Select "/" for the path
|
||||
* Select your Home Assistant user (`hass`)
|
||||
* Select the Home Assistant role (`home-assistant`)
|
||||
* Make sure `Propigate` is checked
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: PulseAudio Loopback
|
||||
description: Instructions on how to use Pulseaudio loopback modules to build a flexible whole-home audio system.
|
||||
logo: pulseaudio.png
|
||||
ha_category:
|
||||
- Switch
|
||||
ha_release: 0.16
|
||||
|
||||
@ -58,9 +58,25 @@ Component specific values in the nested `data` section are optional.
|
||||
|
||||
Image attachments can be added using the `attachment` parameter, which can either be a valid URL for an image (ex: `http://example.com/image.png`) or a local file reference (ex: `/tmp/image.png`).
|
||||
|
||||
To use a specific Pushover device, set it using `target`. If one of the entered devices doesn't exist or is disabled in your Pushover account it will send a message to all you devices. To send to all devices, just skip the target attribute.
|
||||
|
||||
```yaml
|
||||
- service: notify.entity_id
|
||||
data:
|
||||
message: "This is the message"
|
||||
title: "Title of message"
|
||||
target:
|
||||
- pixel3
|
||||
- pixel4a
|
||||
data:
|
||||
sound: pianobar
|
||||
priority: 0
|
||||
```
|
||||
|
||||
|
||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||
|
||||
When sending a notification, optional parameters can also be set as per the pushover [API documentation](https://pushover.net/api).
|
||||
When sending a notification, optional parameters can also be set as per the Pushover [API documentation](https://pushover.net/api).
|
||||
|
||||
Example notification triggered from the Alexa integration for an intents is shown below which also uses [Automation Templating](/getting-started/automation-templating/) for the message:
|
||||
|
||||
@ -77,9 +93,9 @@ alexa:
|
||||
message: "The location of {{ User }} has been queried via Alexa."
|
||||
data:
|
||||
title: "Home Assistant"
|
||||
target: pixel
|
||||
data:
|
||||
sound: falling
|
||||
device: pixel
|
||||
url: "https://www.home-assistant.io/"
|
||||
attachment: "/tmp/image.png"
|
||||
```
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Rain Bird
|
||||
description: Instructions on how to integrate your Rain Bird LNK WiFi Module within Home Assistant.
|
||||
logo: rainbird.png
|
||||
ha_category:
|
||||
- Irrigation
|
||||
- Sensor
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Raspihats
|
||||
description: Instructions on how to integrate Raspihats add-on boards for Raspberry Pi into Home Assistant.
|
||||
logo: raspihats.png
|
||||
ha_category:
|
||||
- DIY
|
||||
- Binary Sensor
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Rejseplanen
|
||||
description: Instructions on how to integrate timetable data for Danish Rejseplanen within Home Assistant.
|
||||
logo: rejseplanen.png
|
||||
ha_category:
|
||||
- Transport
|
||||
ha_iot_class: Cloud Polling
|
||||
|
||||
@ -1,14 +1,13 @@
|
||||
---
|
||||
title: Remember The Milk
|
||||
description: Instructions on how to use Remember The Milk with Home Assistant.
|
||||
logo: rememberthemilk.png
|
||||
ha_category:
|
||||
- Calendar
|
||||
ha_release: 0.57
|
||||
ha_domain: remember_the_milk
|
||||
---
|
||||
|
||||
The `Remember The Milk` (RTM) integration allows you to create tasks in [remember_the_milk](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., water the plants. The integration allows you to have several RTM accounts in parallel.
|
||||
The `remember_the_milk` integration allows you to create tasks in [Remember The Milk (RTM)](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., water the plants. The integration allows you to have several RTM accounts in parallel.
|
||||
|
||||
## Setup
|
||||
|
||||
@ -16,7 +15,7 @@ The setup consists of two steps: getting an API key and registering your account
|
||||
|
||||
### Step 1: API key
|
||||
|
||||
To be able to use this component, you need a Remember The Milk account and you need to apply for your own [API key](https://www.rememberthemilk.com/services/api/keys.rtm). With the API key you will also receive your personal `shared secret`. Both of them need to be stored in your Home Assistant configuration:
|
||||
To be able to use this integration, you need a Remember The Milk account and you need to apply for your own [API key](https://www.rememberthemilk.com/services/api/keys.rtm). With the API key you will also receive your personal shared secret. Both of them need to be stored in your Home Assistant configuration:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -43,7 +42,7 @@ remember_the_milk:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### Step 2: registering your account
|
||||
### Step 2: Registering your account
|
||||
|
||||
After saving the configuration, you need to (re-)start Home Assistant. On the first start you will notice a new "Configuration" panel appearing on the Home Assistant page. After opening the configuration page, follow the link "Remember The Milk login". This will take you to a login page where you have to log in with your normal Remember The Milk credentials. This will authorize Home Assistant to access your Remember The Milk account.
|
||||
|
||||
@ -53,13 +52,13 @@ If the registration was successful, the Configuration panel will disappear from
|
||||
|
||||
In the background Home Assistant downloaded a "token" from the Remember The Milk server which is stored in the `remember_the_milk.conf` file locally. So you only need to register once. After that the token is used to authenticate with the server.
|
||||
|
||||
## Creating/updating tasks with service ```create_task```
|
||||
## Creating/updating tasks with service `create_task`
|
||||
|
||||
This integration offers a new service domain ```remember_the_milk``` with the services ```<account>_create_task```. You can call this service with the argument ```name``` and the optional parameter ```id``` to create a new task in your Remember The Milk account. You can call this service from your usual automations.
|
||||
This integration offers a new service domain `remember_the_milk` with the services `<account>_create_task`. You can call this service with the argument `name` and the optional parameter `id` to create a new task in your Remember The Milk account. You can call this service from your usual automations.
|
||||
|
||||
If you set an ```id``` and a task with that id exists already, the existing task is updated, rather than creating a new task. This way you can change the name of the task. If you do not set an ```id```, a new task is created with every call. If you're using this from an automation, you could use the name of your automation as id or the entity that triggered the task to be created. This way you can later on update or complete this task.
|
||||
If you set an `id` and a task with that id exists already, the existing task is updated, rather than creating a new task. This way you can change the name of the task. If you do not set an `id`, a new task is created with every call. If you're using this from an automation, you could use the name of your automation as id or the entity that triggered the task to be created. This way you can later on update or complete this task.
|
||||
|
||||
The task creation supports the "smart syntax", so to create a task with the tag "from_hass" which is due today you can create a task with the name ```test task created in Home Assistant ^today #from_hass```. More info about the smart syntax is available on the [Remember The Milk documentation](https://www.rememberthemilk.com/help/answer/basics-smartadd-howdoiuse).
|
||||
The task creation supports the "smart syntax", so to create a task with the tag "from_hass" which is due today you can create a task with the name `test task created in Home Assistant ^today #from_hass`. More info about the smart syntax is available on the [Remember The Milk documentation](https://www.rememberthemilk.com/help/answer/basics-smartadd-howdoiuse).
|
||||
|
||||
**Note:**
|
||||
At the moment, smart syntax is *not* supported when updating tasks. All smart syntax commands are ignored during the update and will end up as normal text in the name of the task.
|
||||
@ -69,11 +68,11 @@ At the moment, smart syntax is *not* supported when updating tasks. All smart sy
|
||||
| name | no | Name of the new task, you can use the smart syntax here. | "do this ^today #from_hass" |
|
||||
| id | yes | Identifier for the task you're creating, can be used to update or complete the task later on | "myid" |
|
||||
|
||||
## Completing tasks with service ```complete_task```
|
||||
## Completing tasks with service `complete_task`
|
||||
|
||||
Complete a tasks that was privously created from Home Assistant. You can not complete tasks that were created outside of Home Assistant.
|
||||
|
||||
If you have created your task with an ```id```, calling ```<account>_complete_task``` with the parameter ```id``` will then complete your task.
|
||||
If you have created your task with an `id`, calling `<account>_complete_task` with the parameter `id` will then complete your task.
|
||||
|
||||
|Service data attribute | Optional | Description | Example |
|
||||
|-----------------------|----------|-------------|---------|
|
||||
@ -81,7 +80,9 @@ If you have created your task with an ```id```, calling ```<account>_complete_ta
|
||||
|
||||
## Automation example
|
||||
|
||||
Here's an example for an automation that creates a new task whenever ```sensor.mysensor``` is ```on``` and completes it when the sensor reports ```off```. This way it reminds you to switch it off. By using the ```entity_id``` as id for the task, you can use the same rule also for multiple sensors.
|
||||
Here's an example for an automation that creates a new task whenever `sensor.mysensor` is `on` and completes it when the sensor reports `off`. This way it reminds you to switch it off. By using the `entity_id` as ID for the task, you can use the same rule also for multiple sensors.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
- id: mysensor_on
|
||||
@ -105,7 +106,8 @@ Here's an example for an automation that creates a new task whenever ```sensor.m
|
||||
id: "{{trigger.entity_id}}"
|
||||
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
## Disclaimer
|
||||
|
||||
This product uses the Remember The Milk API but is not endorsed or certified by Remember The Milk.
|
||||
This integration uses the Remember The Milk API but is not endorsed or certified by Remember The Milk.
|
||||
|
||||
@ -3,7 +3,6 @@ title: SAJ Solar Inverter
|
||||
description: Instructions on how to connect your SAJ Solar Inverter to Home Assistant.
|
||||
ha_category:
|
||||
- Energy
|
||||
logo: saj.png
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: '0.100'
|
||||
ha_codeowners:
|
||||
|
||||
@ -111,6 +111,7 @@ For example: for model `UN55NU7100`, the `UN55` would mean it's an LED, North Am
|
||||
- KU6290
|
||||
- KU6400U
|
||||
- KU6470
|
||||
- KU6500 (on working with WOL)
|
||||
- KU7000
|
||||
- M5620
|
||||
- MU6170UXZG
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Satel Integra
|
||||
description: Instructions on how to integrate a Satel Integra alarm panel with Home Assistant using an ETHM network extension from Satel.
|
||||
logo: satel.jpg
|
||||
ha_category:
|
||||
- Hub
|
||||
- Alarm
|
||||
|
||||
@ -95,7 +95,7 @@ Example for using the block framework:
|
||||
message: Message that will be added as a comment to the file.
|
||||
title: Title of the file.
|
||||
data:
|
||||
attachments:
|
||||
blocks:
|
||||
- type: section
|
||||
text:
|
||||
type: mrkdwn
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: SleepIQ
|
||||
description: Instructions for how to integrate SleepIQ beds within Home Assistant.
|
||||
logo: sleepiq.png
|
||||
ha_category:
|
||||
- Health
|
||||
- Sensor
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user