mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 01:06:52 +00:00
Merge branch 'current' into next
This commit is contained in:
Fabian Affolter
commit
ebf955b274
@ -1,18 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Lupusec Alarm Control Panel"
|
||||
description: "Instructions on how to setup the Lupusec Alarm control panel within Home Assistant."
|
||||
date: 2018-10-03 16:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: lupusec.png
|
||||
ha_category: Alarm
|
||||
ha_release: 0.83
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `lupusec` security control panel platform allows you to control your [Lupusec](https://www.lupus-electronics.de) devices.
|
||||
|
||||
The requirement is that you have setup your [Lupusec component](/components/lupusec/). The alarm control panel is automatically added to the Home Assistant frontend.
|
||||
@ -8,39 +8,38 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: amcrest.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Hub
|
||||
- Camera
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: 0.49
|
||||
redirect_from:
|
||||
- /components/camera.amcrest/
|
||||
- /components/sensor.amcrest/
|
||||
- /components/switch.amcrest/
|
||||
---
|
||||
|
||||
The `amcrest` camera platform allows you to integrate your
|
||||
[Amcrest](https://amcrest.com/) IP camera in Home Assistant.
|
||||
The `amcrest` camera platform allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Camera](#camera)
|
||||
- [Sensor](#sensor)
|
||||
- [Switch](#switch)
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable your camera in your installation,
|
||||
add the following to your `configuration.yaml` file:
|
||||
To enable your camera in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
amcrest:
|
||||
- host: IP_ADDRESS_CAMERA_1
|
||||
- host: IP_ADDRESS_CAMERA
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
sensors:
|
||||
- motion_detector
|
||||
- sdcard
|
||||
switches:
|
||||
- motion_detection
|
||||
- motion_recording
|
||||
|
||||
- host: IP_ADDRESS_CAMERA_2
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
resolution: low
|
||||
stream_source: snapshot
|
||||
sensors:
|
||||
- ptz_preset
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
@ -147,10 +146,65 @@ Newer Amcrest firmware may not work, then **rtsp** is recommended instead.
|
||||
make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/)
|
||||
documentation to install the `ffmpeg`.
|
||||
|
||||
Finish its configuration by visiting the
|
||||
[Amcrest sensor page](/components/sensor.amcrest/) or
|
||||
[Amcrest camera page](/components/camera.amcrest/).
|
||||
|
||||
To check if your Amcrest camera is supported/tested, visit the
|
||||
[supportability matrix](https://github.com/tchellomello/python-amcrest#supportability-matrix)
|
||||
link from the `python-amcrest` project.
|
||||
|
||||
## {% linkable_title Advanced Configuration %}
|
||||
|
||||
You can also use this more advanced configuration example:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
amcrest:
|
||||
- host: IP_ADDRESS_CAMERA_1
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
sensors:
|
||||
- motion_detector
|
||||
- sdcard
|
||||
switches:
|
||||
- motion_detection
|
||||
- motion_recording
|
||||
|
||||
# Add second camera
|
||||
- host: IP_ADDRESS_CAMERA_2
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
resolution: low
|
||||
stream_source: snapshot
|
||||
sensors:
|
||||
- ptz_preset
|
||||
```
|
||||
|
||||
## {% linkable_title Camera %}
|
||||
|
||||
Once you have enabled the [Amcrest component](/components/amcrest), you can add cameras to your Home Assistant configuration. add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
camera:
|
||||
- platform: amcrest
|
||||
```
|
||||
|
||||
To check if your Amcrest camera is supported/tested, visit the [supportability matrix](https://github.com/tchellomello/python-amcrest#supportability-matrix) link from the `python-amcrest` project.
|
||||
|
||||
## {% linkable_title Sensor %}
|
||||
|
||||
Once you have enabled the [Amcrest component](/components/amcrest), you can add sensors to your Home Assistant configuration. Add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: amcrest
|
||||
```
|
||||
|
||||
## {% linkable_title Switch %}
|
||||
|
||||
The `amcrest` switch platform lets you control settings of [Amcrest IP Camera](#camera) through Home Assistant.
|
||||
|
||||
Switches will be configured automatically. Please refer to the [component](/components/amcrest/) configuration on how to setup.
|
||||
|
||||
<p class='note warning'>
|
||||
In previous versions, switch devices in setups with multiple cameras, would not have specific entity ID causing them to change randomly after each Home Assistant restart. The current version adds the name of the camera at the end of the switch entity ID, making it more specific and consistent and causes the name option to be required in a multi-camera system. This behavior matches the sensor behavior of the Amcrest component. Because of this, older automations may require updates to the entity ID.
|
||||
</p>
|
||||
@ -8,13 +8,24 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: apple.png
|
||||
ha_category: Multimedia
|
||||
ha_category:
|
||||
- Multimedia
|
||||
- Media Player
|
||||
- Remote
|
||||
ha_iot_class: "Local Push"
|
||||
ha_release: 0.49
|
||||
redirect_from:
|
||||
- /components/media_player.apple_tv/
|
||||
- /components/remote.apple_tv/
|
||||
---
|
||||
|
||||
The `apple_tv` platform allows you to control an Apple TV (3rd and 4th generation). See the [remote platform](/components/remote.apple_tv/) if you want to send remote control buttons, e.g., arrow keys.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Media Player
|
||||
- [Remote](#remote)
|
||||
|
||||
<p class='note'>
|
||||
Currently, you must have Home Sharing enabled for this to work. Support for pairing Home Assistant with your device will be supported in a later release.
|
||||
</p>
|
||||
@ -160,3 +171,30 @@ To play media on an Apple TV with device authentication enabled (e.g., ATV4 with
|
||||
### {% linkable_title Service `apple_tv_scan` %}
|
||||
|
||||
Scans the local network for Apple TVs. All found devices are presented as a persistent notification.
|
||||
|
||||
## {% linkable_title Remote %}
|
||||
|
||||
The `apple_tv` remote platform allows you to send remote control buttons to an Apple TV. It is automatically setup when an Apple TV is configured.
|
||||
|
||||
At the moment, the following buttons are supported:
|
||||
|
||||
- up
|
||||
- down
|
||||
- left
|
||||
- right
|
||||
- menu
|
||||
- top_menu
|
||||
- select
|
||||
|
||||
A typical service call for press several buttons looks like this.
|
||||
|
||||
```yaml
|
||||
service: remote.send_command
|
||||
data:
|
||||
entity_id: remote.apple_tv
|
||||
command:
|
||||
- left
|
||||
- left
|
||||
- menu
|
||||
- select
|
||||
```
|
||||
@ -8,13 +8,24 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: asus.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Hub
|
||||
- Presence Detection
|
||||
- Sensor
|
||||
ha_release: 0.83
|
||||
ha_iot_class: "Local Polling"
|
||||
redirect_from:
|
||||
- /components/device_tracker.asuswrt/
|
||||
- /components/sensor.asuswrt/
|
||||
---
|
||||
|
||||
The `asuswrt` component is the main component to connect to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- **Presence Detection** - The asuswrt platform offers presence detection by looking at connected devices to a ASUSWRT based router.
|
||||
- **Sensor** - The asuswrt sensor platform allows you to get upload and download data from your ASUSWRT within Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use an ASUSWRT router in your installation, add the following to your `configuration.yaml` file:
|
||||
@ -101,7 +112,41 @@ asuswrt:
|
||||
|
||||
The example above, creates the following sensors:
|
||||
|
||||
* sensor.asuswrt_download (unit_of_measurement: Gigabyte - *Daily accumulation*)
|
||||
* sensor.asuswrt_download_speed (unit_of_measurement: Mbit/s)
|
||||
* sensor.asuswrt_upload (unit_of_measurement: Gigabyte - *Daily accumulation*)
|
||||
* sensor.asuswrt_upload_speed (unit_of_measurement: Mbit/s)
|
||||
- sensor.asuswrt_download (unit_of_measurement: Gigabyte - *Daily accumulation*)
|
||||
- sensor.asuswrt_download_speed (unit_of_measurement: Mbit/s)
|
||||
- sensor.asuswrt_upload (unit_of_measurement: Gigabyte - *Daily accumulation*)
|
||||
- sensor.asuswrt_upload_speed (unit_of_measurement: Mbit/s)
|
||||
|
||||
|
||||
## {% linkable_title Padavan custom firmware (The rt-n56u project) %}
|
||||
|
||||
The [rt-n56u project](https://bitbucket.org/padavan/rt-n56u) does not store `dnsmasq.leases` which is used to track devices at `/var/lib/misc/` as `asuswrt` do. However this component can still be used for the rt-n56u project by linking `dnsmasq.leases` during the boot process of the router.
|
||||
|
||||
Follow these steps to setup the link.
|
||||
|
||||
1. SSH or Telnet into the router. (default ssh admin@my.router)
|
||||
2. Run the following command to find the file:
|
||||
|
||||
```bash
|
||||
$ find / -name "dnsmasq.leases"
|
||||
```
|
||||
3. Copy or remember the full path of, example: `/tmp/dnsmasq.leases`
|
||||
4. Create the folder if it does not exist:
|
||||
|
||||
```bash
|
||||
$ mkdir -p /var/lib/misc
|
||||
```
|
||||
5. Add the linking process to the routers started script (one line):
|
||||
|
||||
```bash
|
||||
$ echo "/bin/ln -s /tmp/dnsmasq.leases /var/lib/misc/dnsmasq.leases" >> /etc/storage/started_script.sh
|
||||
```
|
||||
|
||||
6. Reboot the router or link the file:
|
||||
|
||||
```bash
|
||||
$ /bin/ln -s /tmp/dnsmasq.leases /var/lib/misc/dnsmasq.leases
|
||||
```
|
||||
|
||||
The started script is also accessible and editable in the Router's web interface. `Advanced Settings -> Customization -> Scripts -> Custom User Script -> Run After Router Started`
|
||||
|
||||
|
||||
@ -1,20 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Lupusec Binary Sensor"
|
||||
description: "Instructions on how to integrate Lupusec binary sensors into Home Assistant."
|
||||
date: 2018-10-03 16:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: lupusec.png
|
||||
ha_category: Binary Sensor
|
||||
ha_release: 0.83
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `lupusec` security control panel platform allows you to control your [Lupusec](https://www.lupus-electronics.de) devices.
|
||||
|
||||
This platform will add `door contacts` and `window contacts` to your Home Assistant setup.
|
||||
|
||||
For the sensors to work you have to setup your [`lupusec` component](/components/lupusec/).
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "OpenTherm Gateway Binary Sensor"
|
||||
description: "Expose internal data from the OpenTherm Gateway."
|
||||
date: 2018-10-19 18:23
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: opentherm.png
|
||||
ha_category: Binary Sensor
|
||||
ha_release: 0.81
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `opentherm_gw` binary sensor platform is used to expose internal data from the [OpenTherm Gateway](http://otgw.tclcode.com/) in Home Assistant.
|
||||
|
||||
# {% linkable_title Configuration %}
|
||||
|
||||
Configuration of this platform is achieved through the [OpenTherm Gateway Hub](/components/opentherm_gw/) configuration.
|
||||
|
||||
<p class='note'>
|
||||
The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.
|
||||
</p>
|
||||
@ -1,40 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Ring Binary Sensor"
|
||||
description: "Instructions on how to integrate your Ring.com devices within Home Assistant."
|
||||
date: 2017-04-01 10:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: ring.png
|
||||
ha_category: Doorbell
|
||||
ha_release: 0.42
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
To get your [Ring.com](https://ring.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: ring
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
monitored_conditions:
|
||||
description: Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions below will be enabled.
|
||||
required: false
|
||||
type: list
|
||||
keys:
|
||||
ding:
|
||||
description: Return a boolean value when the doorbell button was pressed.
|
||||
motion:
|
||||
description: Return a boolean value when a movement was detected by the Ring doorbell.
|
||||
{% endconfiguration %}
|
||||
|
||||
Currently it supports doorbell, external chimes and stickup cameras.
|
||||
@ -1,22 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "ZoneMinder Binary Sensor"
|
||||
description: "Provides the connectivity from Home Assistant to ZoneMinder."
|
||||
date: 2019-01-18 02:30
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: zoneminder.png
|
||||
ha_category: Binary Sensor
|
||||
ha_release: 0.87
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `zoneminder` binary sensor platform lets you monitor the availability of your [ZoneMinder](https://www.zoneminder.com) install.
|
||||
|
||||
<p class='note'>
|
||||
This platform is automatically loaded by the [ZoneMinder component](/components/zoneminder/) during it's setup.
|
||||
</p>
|
||||
|
||||
Each binary_sensor created will be named after the hostname used when configuring the [ZoneMinder component](/components/zoneminder/).
|
||||
@ -24,6 +24,8 @@ redirect_from:
|
||||
|
||||
The `bmw_connected_drive` component lets you retrieve data of your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work.
|
||||
|
||||
The `bmw_connected_drive` component also works with (recent) Mini vehicles. You need to have a working Mini Connected account, and a Mini Connected enabled vehicle for this to work.
|
||||
|
||||
For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/m1n3rva/bimmer_connected) on github.
|
||||
|
||||
This component provides the following platforms:
|
||||
|
||||
@ -1,28 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Amcrest IP Camera"
|
||||
description: "Instructions on how to integrate Amcrest IP cameras within Home Assistant."
|
||||
date: 2016-11-24 10:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: amcrest.png
|
||||
ha_category: Camera
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: 0.34
|
||||
---
|
||||
|
||||
To get your [Amcrest](https://amcrest.com/) cameras working within Home Assistant, please follow the instructions for the general [Amcrest component](/components/amcrest).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Once you have enabled the [Amcrest component](/components/amcrest), add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
camera:
|
||||
- platform: amcrest
|
||||
```
|
||||
|
||||
To check if your Amcrest camera is supported/tested, visit the [supportability matrix](https://github.com/tchellomello/python-amcrest#supportability-matrix) link from the `python-amcrest` project.
|
||||
@ -1,85 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Ring Camera"
|
||||
description: "Instructions on how to integrate your Ring.com devices within Home Assistant."
|
||||
date: 2017-10-20 10:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: ring.png
|
||||
ha_category: Camera
|
||||
ha_release: 0.57
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
To get your [Ring.com](https://ring.com/) cameras working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring). Please note that downloading and playing Ring video will require a Ring Protect plan.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
camera:
|
||||
- platform: ring
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
ffmpeg_arguments:
|
||||
description: Extra options to pass to ffmpeg, e.g., image quality or video filter options.
|
||||
required: false
|
||||
type: string
|
||||
scan_interval:
|
||||
description: How frequently to query for new video in seconds.
|
||||
required: false
|
||||
type: integer
|
||||
default: 90
|
||||
{% endconfiguration %}
|
||||
|
||||
**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation.
|
||||
|
||||
Currently it supports doorbell and stickup cameras.
|
||||
|
||||
## {% linkable_title Saving the videos captured by your Ring Door Bell %}
|
||||
|
||||
You can save locally the latest video captured by your Ring Door Bell using the [downloader](/components/downloader) along with either an [automation](/components/automation) or [python_script](/components/python_script). First, enable the [downloader](/components/downloader) component in your configuration by adding the following to your `configuration.yaml`.
|
||||
|
||||
```yaml
|
||||
downloader:
|
||||
download_dir: downloads
|
||||
```
|
||||
Then you can use the following `action` in your automation (this will save the video file under `<config>/downloads/ring_<camera_name>/`):
|
||||
|
||||
```yaml
|
||||
action:
|
||||
- service: downloader.download_file
|
||||
data_template:
|
||||
url: "{{ states.camera.front_door.attributes.video_url }}"
|
||||
subdir: "{{states.camera.front_door.attributes.friendly_name}}"
|
||||
filename: "{{states.camera.front_door.attributes.friendly_name}}"
|
||||
```
|
||||
|
||||
If you want to use `python_script`, enable it your `configuration.yaml` file first:
|
||||
```yaml
|
||||
python_script:
|
||||
```
|
||||
You can then use the following `python_script` to save the video file:
|
||||
|
||||
```python
|
||||
# obtain ring doorbell camera object
|
||||
# replace the camera.front_door by your camera entity
|
||||
ring_cam = hass.states.get('camera.front_door')
|
||||
|
||||
subdir_name = 'ring_{}'.format(ring_cam.attributes.get('friendly_name'))
|
||||
|
||||
# get video URL
|
||||
data = {
|
||||
'url': ring_cam.attributes.get('video_url'),
|
||||
'subdir': subdir_name,
|
||||
'filename': ring_cam.attributes.get('friendly_name')
|
||||
}
|
||||
|
||||
# call downloader component to save the video
|
||||
hass.services.call('downloader', 'download_file', data)
|
||||
```
|
||||
@ -1,30 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "ZoneMinder Camera"
|
||||
description: "View ZoneMinder camera streams within Home Assistant."
|
||||
date: 2017-02-19 18:11
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: zoneminder.png
|
||||
ha_category: Camera
|
||||
ha_release: 0.39
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `zoneminder` camera platform lets you monitor the current stream of your [ZoneMinder](https://www.zoneminder.com) cameras.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [ZoneMinder component](/components/zoneminder/) configured to view the camera stream.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
camera:
|
||||
- platform: zoneminder
|
||||
```
|
||||
@ -1,25 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "OpenTherm Gateway Climate"
|
||||
description: "Control your OpenTherm Gateway from Home Assistant."
|
||||
date: 2018-08-29 16:23
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: opentherm.png
|
||||
ha_category: Climate
|
||||
ha_release: 0.78
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
|
||||
The `opentherm_gw` climate platform is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant.
|
||||
|
||||
# {% linkable_title Configuration %}
|
||||
|
||||
Configuration of this platform is achieved through the [OpenTherm Gateway Hub](/components/opentherm_gw/) configuration.
|
||||
|
||||
<p class='note'>
|
||||
The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.
|
||||
</p>
|
||||
@ -1,22 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Asuswrt Device Tracker"
|
||||
description: "Instructions on how to integrate Asuswrt device tracker into Home Assistant."
|
||||
date: 2015-08-06 19:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: asus.png
|
||||
ha_category: Presence Detection
|
||||
ha_release: pre 0.7
|
||||
---
|
||||
|
||||
|
||||
The `asuswrt` platform offers presence detection by looking at connected devices to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router.
|
||||
|
||||
The platform will be automatically configured if Asuswrt component is configured.
|
||||
|
||||
For more configuration information see the [Asuswrt component](/components/asuswrt/) documentation.
|
||||
|
||||
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
|
||||
@ -13,7 +13,7 @@ ha_release: 0.36
|
||||
---
|
||||
|
||||
|
||||
The `upc_connect` platform offers presence detection by looking at connected devices to a [Connect Box](https://www.upc.ch/de/internet/connectbox/) from [Liberty Global](http://www.libertyglobal.com/) (also known as UPC Cablecom in Switzerland) which is a Internet provider in Switzerland and Austria.
|
||||
The `upc_connect` platform offers presence detection by looking at connected devices to a [Connect Box](https://www.upc.ch/en/internet/learn-about-internet/) from [Liberty Global](https://www.libertyglobal.com) (also known as UPC Cablecom in Switzerland) which is an Internet provider in Switzerland, Austria and the Netherlands (under Ziggo).
|
||||
|
||||
To use a Connect Box in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -35,5 +35,6 @@ See the [device tracker component page](/components/device_tracker/) for instruc
|
||||
|
||||
Also known to be working with the following devices:
|
||||
- Irish Virgin Media Super Hub 3.0
|
||||
- Ziggo Connectbox NL
|
||||
- Unitymedia Connect Box (DE)
|
||||
- Ziggo Connectbox (NL)
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@ redirect_from:
|
||||
- /components/switch.esphome/
|
||||
---
|
||||
|
||||
This component allows you to connect your [ESPHome](https://esphomelib.com/esphomeyaml/index.html) devices directly into Home Assistant with the [native ESPHome API](https://esphomelib.com/esphomeyaml/components/api.html).
|
||||
This component allows you to connect your [ESPHome](https://esphome.io) devices directly into Home Assistant with the [native ESPHome API](https://esphome.io/components/api.html).
|
||||
|
||||
## {% linkable_title Setup the component via the integrations screen %}
|
||||
|
||||
|
||||
@ -11,6 +11,7 @@ logo: avm.png
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Climate
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_release: 0.68
|
||||
ha_iot_class: "Local Polling"
|
||||
@ -18,10 +19,18 @@ redirect_from:
|
||||
- /components/binary_sensor.fritzbox/
|
||||
- /components/switch.fritzbox/
|
||||
- /components/climate.fritzbox/
|
||||
- /components/sensor.fritzbox/
|
||||
---
|
||||
|
||||
The [AVM](https://en.avm.de) Fritzbox component for Home Assistant allows you to integrate the switch and climate devices.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Binary Sensor
|
||||
- Climate
|
||||
- [Sensor](#sensor)
|
||||
- Switch
|
||||
|
||||
#### {% linkable_title Tested Devices %}
|
||||
|
||||
- [FRITZ!Box 6490 Cable](https://en.avm.de/products/fritzbox/fritzbox-6490-cable/)
|
||||
@ -80,4 +89,19 @@ The are several attributes that can be useful for automations and templates.
|
||||
| `temperature_unit` | The unit of the temperature sensor (only available if the device support temperature sensor).
|
||||
| `temperature` | The current temperature sensor reading (only available if the device supports temperature sensor).
|
||||
| `total_consumption` | The total power consumption since the beginning of operation (only available if the device supports power meter function).
|
||||
| `total_consumption_unit` | The unit of the total_consumption (only available if the device supports power meter function).
|
||||
| `total_consumption_unit` | The unit of the total_consumption (only available if the device supports power meter function).
|
||||
|
||||
## {% linkable_title Sensor %}
|
||||
|
||||
To get AVM Fritzbox temperature sensor (e.g. FRITZ!DECT Repeater 100) follow the instructions for the [Fritzbox component](#setup).
|
||||
|
||||
### {% linkable_title Attributes %}
|
||||
|
||||
The are several attributes that can be useful for automations and templates.
|
||||
|
||||
| Attribute | Description |
|
||||
| --------- | ----------- |
|
||||
| `device_locked` | The state of the key lock at the device.
|
||||
| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface.
|
||||
| `temperature_unit` | The unit of the temperature sensor.
|
||||
| `temperature` | The current temperature sensor reading.
|
||||
@ -17,12 +17,9 @@ This component sets up integration with [Geofency](http://www.geofency.com/). Ge
|
||||
|
||||
Enabling this component will automatically enable the [Geofency Device Tracker](/components/device_tracker.geofency/).
|
||||
|
||||
To integrate Geofency in Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
To configure Geofency, you must set it up via the integrations panel in the configuration screen. You must then configure the iOS app (via the Webhook feature) to send a POST request to your Home Assistant server at the webhook URL provided by the integration during setup. Use the default POST format. Make sure to enable the 'Update Geo-Position' functionality for mobile beacons.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
geofency:
|
||||
```
|
||||
When using mobile beacons (optional) an entry in `configuration.yaml` is still needed as this can't be added via the integrations panel.
|
||||
|
||||
{% configuration %}
|
||||
mobile_beacons:
|
||||
@ -31,7 +28,7 @@ mobile_beacons:
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
A full sample configuration for the `geofency` component is shown below:
|
||||
A sample configuration for the `geofency` component when using mobile beacons is shown below:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -40,5 +37,3 @@ geofency:
|
||||
- car
|
||||
- keys
|
||||
```
|
||||
|
||||
To configure Geofency, you must set it up via the integrations panel in the configuration screen. You must then configure the iOS app (via the Webhook feature) to send a POST request to your Home Assistant server at the webhook URL provided by the integration during setup. Use the default POST format. Make sure to enable the 'Update Geo-Position' functionality for mobile beacons.
|
||||
|
||||
@ -410,7 +410,7 @@ When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant wi
|
||||
|
||||
1. Create a string variable **V_Last_Reboot** on the CCU
|
||||
|
||||
2. Creata a new programm on the CCU **without any conditions**, which executes the following *HM-Script* with a delay of 30 seconds:
|
||||
2. Creata a new programm on the CCU **without any conditions**, which executes the following *HM-Script* with a delay of 30 seconds. The Script needs to be implemented within the section `Activity: Then`.
|
||||
|
||||
```javascript
|
||||
var obj = dom.GetObject("V_Last_Reboot");
|
||||
|
||||
@ -8,16 +8,24 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: philips_hue.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Hub
|
||||
- Light
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_qa_scale: platinum
|
||||
featured: true
|
||||
ha_release: "0.60"
|
||||
ha_qa_scale: platinum
|
||||
redirect_from:
|
||||
- /components/light.hue/
|
||||
---
|
||||
|
||||
Philips Hue support is integrated into Home Assistant as a Hub that can drive the light platform. The preferred way to setup the Philips Hue platform is by enabling the [discovery component](/components/discovery/).
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Light
|
||||
|
||||
Once discovered, if you have a custom default view, locate `configurator.philips_hue` in the entities list ( < > ) and add it to a group in `configuration.yaml`. Restart Home Assistant so that the configurator is visible in the Home Assistant dashboard. Once Home Assistant is restarted, locate and click on `configurator.philips_hue` to bring up the initiation dialog. This will prompt you to press the Hue button to register the Hue hub in Home Assistant. Once complete, the configurator entity isn't needed anymore and can be removed from any visible group in `configuration.yaml`.
|
||||
|
||||
When you configure the Hue bridge from Home Assistant, it writes a token to a file in your Home Assistant [configuration directory](/docs/configuration/). That token authenticates the communication with the Hue bridge. This token uses the Address of the Hue Bridge. If the IP address for the Hue Bridge changes, you will need to register the Hue Bridge with Home Assistant again. To avoid this you may set up DHCP registration for your Hue Bridge, so that it always has the same IP address.
|
||||
@ -124,7 +132,6 @@ Home Assistant will automatically detect your new `LightGroup` and add it to the
|
||||
|
||||
More information can be found on the [Philips Hue API documentation](https://www.developers.meethue.com/documentation/groups-api#22_create_group) website.
|
||||
|
||||
|
||||
### {% linkable_title Using Hue Scenes in Home Assistant %}
|
||||
|
||||
The Hue platform has its own concept of scenes for setting the colors of a group of lights at once. Hue Scenes are very cheap, get created by all kinds of apps (as it is the only way to have 2 or more lights change at the same time), and are rarely deleted. A typical Hue hub might have hundreds of scenes stored in them, many that you've never used, almost all very poorly named.
|
||||
|
||||
@ -1,20 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Philips Hue Light"
|
||||
description: "Instructions on how to integrate Philips Hue lights into Home Assistant."
|
||||
date: 2015-03-23 20:09
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: philips_hue.png
|
||||
ha_category: Light
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: pre 0.7
|
||||
---
|
||||
|
||||
The Philips Hue light platform allows you to control your Philips Hue lights.
|
||||
|
||||
This component will automatically add `Lights` configured on your Hue bridges.
|
||||
|
||||
The requirement is that you have setup your [Philips Hue bridge](/components/hue/).
|
||||
@ -639,7 +639,7 @@ light:
|
||||
|
||||
- [MQTT JSON Light](https://github.com/mertenats/Open-Home-Automation/tree/master/ha_mqtt_rgbw_light_with_discovery) is another implementation for ESP8266 including [MQTT discovery](/docs/mqtt/discovery/).
|
||||
|
||||
- [esphomelib](https://github.com/OttoWinter/esphomelib) is a library for ESP8266 and ESP32 boards that has many of Home Assistant's MQTT features (like [discovery](/docs/mqtt/discovery/)) pre-implemented and provides high-level abstractions for components such as lights or sensors.
|
||||
- [ESPHome](https://esphome.io) implements the JSON schema for MQTT based installs and supports [MQTT discovery](/docs/mqtt/discovery/).
|
||||
|
||||
- [AiLight](https://github.com/stelgenhof/AiLight) is a custom firmware for the Ai-Thinker (and equivalent) RGBW WiFi light bulbs that has an ESP8266 onboard and controlled by the MY9291 LED driver. It implements the [MQTT JSON light](/components/light.mqtt_json/) platform and supports ON/OFF, RGBW colours, brightness, colour temperature, flashing and transitions. Also it includes [MQTT Auto Discovery](/docs/mqtt/discovery/)) and the MQTT Last Will and Testament is enabled as well.
|
||||
|
||||
|
||||
@ -8,9 +8,17 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: lupusec.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Hub
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
- Switch
|
||||
ha_release: 0.83
|
||||
ha_iot_class: "Local Polling"
|
||||
redirect_from:
|
||||
- /components/alarm_control_panel.lupusec/
|
||||
- /components/binary_sensor.lupusec/
|
||||
- /components/switch.lupusec/
|
||||
---
|
||||
|
||||
The `lupusec` component allows the user to integrate their Lupusec alarm control panel and ultimately all connected sensors and other devices. For more information about the LUPUS-Electronics security system please visit their [website](https://www.lupus-electronics.de).
|
||||
@ -21,9 +29,9 @@ Supported units:
|
||||
|
||||
The following devices are supported by the underlying `lupupy` Python library and integrated into Home Assistant.
|
||||
|
||||
- [Alarm Control Panel](/components/alarm_control_panel.lupusec/): Displays the alarm status and controls arming, disarming and home modus.
|
||||
- [Binary Sensor](/components/binary_sensor.lupusec/): Displays the status of binary sensors. Currently only Door and window sensors are supported.
|
||||
- [Switch](/components/switch.lupusec/): Turn off and on your Lupus power switches.
|
||||
- **Alarm Control Panel**: Displays the alarm status and controls arming, disarming and home modus.
|
||||
- **Binary Sensor**: Displays the status of binary sensors. Currently only Door and window sensors are supported.
|
||||
- **Switch**: Turn off and on your Lupus power switches.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
|
||||
@ -1,16 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Apple TV Media Player"
|
||||
description: "Instructions on how to integrate Apple TV devices into Home Assistant."
|
||||
date: 2017-02-08 07:11
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: apple.png
|
||||
ha_category: Media Player
|
||||
ha_iot_class: "Local Push"
|
||||
ha_release: 0.38
|
||||
---
|
||||
|
||||
To setup the `apple_tv` media player platform, please follow the instructions on the [Apple TV Component page](/components/apple_tv/).
|
||||
@ -99,9 +99,11 @@ Assuming you have already added the platform to your configuration:
|
||||
1. Open Home Assistant in Chrome or Firefox.
|
||||
2. Load profile page by clicking on the badge next to the Home Assistant title in the sidebar. Assuming you have met all the [requirements](#requirements) above then you should see a new slider for Push Notifications. If the slider is greyed out, ensure you are viewing Home Assistant via its external HTTPS address. If the slider is not visible, ensure you are not in the user configuration (Sidebar, Configuration, Users, View User).
|
||||
3. Slide it to the on position.
|
||||
4. Within a few seconds you should be prompted to allow notifications from Home Assistant.
|
||||
5. Assuming you accept, that's all there is to it!
|
||||
6. (Optional, but highly recommended!) Open the `html5_push_registrations.conf` file in your configuration directory. You will see a new entry for the browser you just added. Rename it from `unnamed device` to a name of your choice, which will make it easier to identify later. _Do not change anything else in this file!_ You need to restart Home Assistant after making any changes to the file.
|
||||
4. Name the device you're using in the alert that appears.
|
||||
5. Within a few seconds you should be prompted to allow notifications from Home Assistant.
|
||||
6. Assuming you accept, that's all there is to it!
|
||||
|
||||
**Note:** If you aren't prompted for a device name when enabling notifications, open the `html5_push_registrations.conf` file in your configuration directory. You will see a new entry for the browser you just added. Rename it from `unnamed device` to a name of your choice, which will make it easier to identify later. _Do not change anything else in this file!_ You need to restart Home Assistant after making any changes to the file.
|
||||
|
||||
### {% linkable_title Testing %}
|
||||
|
||||
|
||||
@ -8,14 +8,33 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: opentherm.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Hub
|
||||
- Binary Sensor
|
||||
- Climate
|
||||
- Sensor
|
||||
ha_release: 0.81
|
||||
ha_iot_class: "Local Push"
|
||||
redirect_from:
|
||||
- /components/binary_sensor.opentherm_gw/
|
||||
- /components/climate.opentherm_gw/
|
||||
- /components/sensor.opentherm_gw/
|
||||
---
|
||||
|
||||
The `opentherm_gw` component is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Binary Sensor
|
||||
- Climate
|
||||
- Sensor
|
||||
|
||||
When enabled, this component will automatically add its [`climate` entity](/components/climate.opentherm_gw) to Home Assistant.
|
||||
|
||||
<p class='note'>
|
||||
The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.
|
||||
</p>
|
||||
|
||||
# {% linkable_title Configuration %}
|
||||
|
||||
```yaml
|
||||
@ -253,6 +272,7 @@ monitored_variables:
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Supported Variables %}
|
||||
|
||||
The list above contains all supported variables. Note that not all boilers and thermostats properly support all variables, so the fact that a variable is listed here and published by your system does not necessarily mean that you will get useful data out of it. To see which variables are published in your situation, enable debug logging for the `opentherm_gw` component and look for the status updates.
|
||||
|
||||
# {% linkable_title Services %}
|
||||
@ -346,12 +366,13 @@ The value you provide here will be used with the GPIO `home` (5) and `away` (6)
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `temperature` | no | The setback temperature. Accepted values are `0.0` through `30.0`.
|
||||
|
||||
|
||||
## {% linkable_title GPIO modes %}
|
||||
|
||||
Possible modes and their meaning for the GPIO pins are listed here:
|
||||
{% comment %}
|
||||
Bulletpoints and numbers to match the LED mode layout below.
|
||||
{% endcomment %}
|
||||
|
||||
* 1\. No function, default for both ports on a freshly flashed chip.
|
||||
* 2\. Ground - A permanently low output (0V). Could be used for a power LED.
|
||||
* 3\. Vcc - A permanently high output (5V). Can be used as a short-proof power supply for some external circuitry used by the other GPIO port.
|
||||
@ -361,9 +382,10 @@ Possible modes and their meaning for the GPIO pins are listed here:
|
||||
* 7\. Away - Set thermostat to setback temperature when pulled high.
|
||||
* 8\. DS1820 (GPIO port B only) - Data line for a DS18S20 or DS18B20 temperature sensor used to measure the outside temperature. A 4k7 resistor should be connected between GPIO port B and Vcc.
|
||||
|
||||
|
||||
## {% linkable_title LED modes %}
|
||||
|
||||
Possible LED modes and their meaning are listed here:
|
||||
|
||||
* R. Receiving an Opentherm message from the thermostat or boiler.
|
||||
* X. Transmitting an Opentherm message to the thermostat or boiler.
|
||||
* T. Transmitting or receiving a message on the thermostat interface.
|
||||
|
||||
@ -35,6 +35,23 @@ component does not automatically query the API for new data after it initially
|
||||
loads. To request new data, the `update_data` service may be used.
|
||||
</p>
|
||||
|
||||
<p class='note warning'>
|
||||
Each use of the `update_data` service will consume 1 or 2 API calls, depending
|
||||
on which monitored conditions are configured.
|
||||
|
||||
If the OpenUV component is configured through the Home Assistant UI (via the
|
||||
`Configuration >> Integrations` panel), each service call will consume 2 API
|
||||
calls from the daily quota.
|
||||
|
||||
If the OpenUV component is configured via `configuration.yaml`, service calls
|
||||
will consume 2 API calls if `monitored_conditions` contains both
|
||||
`uv_protection_window` and any other condition; any other scenarios will only
|
||||
consume 1 API call.
|
||||
|
||||
Ensure that you understand these specifications when calling the `update_data`
|
||||
service.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To retrieve data from OpenUV, add the following to your `configuration.yaml`
|
||||
|
||||
@ -1,40 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Apple TV Remote"
|
||||
description: "Instructions on how to integrate Apple TV remote into Home Assistant."
|
||||
date: 2017-06-26 20:50
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: apple.png
|
||||
ha_category: Remote
|
||||
ha_iot_class: "Local Push"
|
||||
ha_release: 0.49
|
||||
---
|
||||
|
||||
|
||||
The `apple_tv` remote platform allows you to send remote control buttons to an Apple TV. It is automatically setup when an Apple TV is configured, please see [Apple TV Component](/components/apple_tv/) for configuration details.
|
||||
|
||||
At the moment, the following buttons are supported:
|
||||
|
||||
- up
|
||||
- down
|
||||
- left
|
||||
- right
|
||||
- menu
|
||||
- top_menu
|
||||
- select
|
||||
|
||||
A typical service call for press several buttons looks like this.
|
||||
|
||||
```yaml
|
||||
service: remote.send_command
|
||||
data:
|
||||
entity_id: remote.apple_tv
|
||||
command:
|
||||
- left
|
||||
- left
|
||||
- menu
|
||||
- select
|
||||
```
|
||||
@ -8,12 +8,27 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: ring.png
|
||||
ha_category: Doorbell
|
||||
ha_category:
|
||||
- Doorbell
|
||||
- Binary Sensor
|
||||
- Camera
|
||||
- Sensor
|
||||
ha_release: 0.42
|
||||
ha_iot_class: "Cloud Polling"
|
||||
redirect_from:
|
||||
- /components/binary_sensor.ring/
|
||||
- /components/camera.ring/
|
||||
- /components/sensor.ring/
|
||||
---
|
||||
|
||||
The `ring` implementation allows you to integrate your [Ring.com](https://ring.com/) devices in Home Assistant.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](#binary-sensor)
|
||||
- [Camera](#camera) - downloading and playing Ring video will require a Ring Protect plan.
|
||||
- [Sensor](#sensor)
|
||||
|
||||
Currently only doorbells are supported by this sensor.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
@ -38,4 +53,136 @@ password:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
Finish its configuration by visiting the [Ring binary sensor](/components/binary_sensor.ring/) or [Ring sensor](/components/sensor.ring/) documentation.
|
||||
## {% linkable_title Binary Sensor %}
|
||||
|
||||
Once you have enabled the [Ring component](/components/ring), you can start using a binary sensor. Add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: ring
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
monitored_conditions:
|
||||
description: Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions below will be enabled.
|
||||
required: false
|
||||
type: list
|
||||
keys:
|
||||
ding:
|
||||
description: Return a boolean value when the doorbell button was pressed.
|
||||
motion:
|
||||
description: Return a boolean value when a movement was detected by the Ring doorbell.
|
||||
{% endconfiguration %}
|
||||
|
||||
Currently it supports doorbell, external chimes and stickup cameras.
|
||||
|
||||
## {% linkable_title Camera %}
|
||||
|
||||
<p class='note'>
|
||||
Please note that downloading and playing Ring video will require a Ring Protect plan.
|
||||
<p>
|
||||
|
||||
Once you have enabled the [Ring component](/components/ring), you can start using the camera platform. Add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
camera:
|
||||
- platform: ring
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
ffmpeg_arguments:
|
||||
description: Extra options to pass to ffmpeg, e.g., image quality or video filter options.
|
||||
required: false
|
||||
type: string
|
||||
scan_interval:
|
||||
description: How frequently to query for new video in seconds.
|
||||
required: false
|
||||
type: integer
|
||||
default: 90
|
||||
{% endconfiguration %}
|
||||
|
||||
**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation.
|
||||
|
||||
Currently it supports doorbell and stickup cameras.
|
||||
|
||||
## {% linkable_title Saving the videos captured by your Ring Door Bell %}
|
||||
|
||||
You can save locally the latest video captured by your Ring Door Bell using the [downloader](/components/downloader) along with either an [automation](/components/automation) or [python_script](/components/python_script). First, enable the [downloader](/components/downloader) component in your configuration by adding the following to your `configuration.yaml`.
|
||||
|
||||
```yaml
|
||||
downloader:
|
||||
download_dir: downloads
|
||||
```
|
||||
|
||||
Then you can use the following `action` in your automation (this will save the video file under `<config>/downloads/ring_<camera_name>/`):
|
||||
|
||||
```yaml
|
||||
action:
|
||||
- service: downloader.download_file
|
||||
data_template:
|
||||
url: "{{ states.camera.front_door.attributes.video_url }}"
|
||||
subdir: "{{states.camera.front_door.attributes.friendly_name}}"
|
||||
filename: "{{states.camera.front_door.attributes.friendly_name}}"
|
||||
```
|
||||
|
||||
If you want to use `python_script`, enable it your `configuration.yaml` file first:
|
||||
|
||||
```yaml
|
||||
python_script:
|
||||
```
|
||||
|
||||
You can then use the following `python_script` to save the video file:
|
||||
|
||||
```python
|
||||
# obtain ring doorbell camera object
|
||||
# replace the camera.front_door by your camera entity
|
||||
ring_cam = hass.states.get('camera.front_door')
|
||||
|
||||
subdir_name = 'ring_{}'.format(ring_cam.attributes.get('friendly_name'))
|
||||
|
||||
# get video URL
|
||||
data = {
|
||||
'url': ring_cam.attributes.get('video_url'),
|
||||
'subdir': subdir_name,
|
||||
'filename': ring_cam.attributes.get('friendly_name')
|
||||
}
|
||||
|
||||
# call downloader component to save the video
|
||||
hass.services.call('downloader', 'download_file', data)
|
||||
```
|
||||
|
||||
## {% linkable_title Sensor %}
|
||||
|
||||
Once you have enabled the [Ring component](/components/ring), you can start using the sensor platform. Add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: ring
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
monitored_conditions:
|
||||
type: list
|
||||
required: false
|
||||
description: Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions below will be enabled.
|
||||
keys:
|
||||
battery:
|
||||
description: Return the battery level from device.
|
||||
last_activity:
|
||||
description: Return the timestamp from the last event captured (ding/motion/on demand) by the Ring doorbell camera.
|
||||
last_ding:
|
||||
description: Return the timestamp from the last time the Ring doorbell button was pressed.
|
||||
last_motion:
|
||||
description: Return the timestamp from the last motion event captured by the Ring doorbell camera.
|
||||
volume:
|
||||
description: Return the volume level from the device.
|
||||
wifi_signal_category:
|
||||
description: Return the WiFi signal level from the device.
|
||||
wifi_signal_strength:
|
||||
description: Return the WiFi signal strength (dBm) from the device.
|
||||
{% endconfiguration %}
|
||||
|
||||
Currently it supports doorbell, external chimes and stickup cameras.
|
||||
@ -1,25 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Amcrest IP Camera"
|
||||
description: "Instructions on how to integrate Amcrest IP cameras sensors within Home Assistant."
|
||||
date: 2017-01-13 10:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: amcrest.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.37
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
To get your [Amcrest](https://amcrest.com/) cameras working within Home Assistant, please follow the instructions for the general [Amcrest component](/components/amcrest).
|
||||
|
||||
Once you have enabled the [Amcrest component](/components/amcrest), add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: amcrest
|
||||
```
|
||||
To check if your Amcrest camera is supported/tested, visit the [supportability matrix](https://github.com/tchellomello/python-amcrest#supportability-matrix) link from the `python-amcrest` project.
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Asuswrt Sensor"
|
||||
description: "Instructions on how to integrate Asuswrt sensors into Home Assistant."
|
||||
date: 2017-08-30 12:21
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: asus.png
|
||||
ha_category: System Monitor
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: 0.83
|
||||
---
|
||||
|
||||
The `asuswrt` sensor platform allows you to get upload and download data from your [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) within Home Assistant.
|
||||
|
||||
For more configuration information see the [Asuswrt component](/components/asuswrt/) documentation.
|
||||
@ -1,27 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Fritzbox temperature sensor"
|
||||
description: "Instructions on how to integrate the AVM Fritzbox temperature sensor."
|
||||
date: 2019-01-22 20:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: avm.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.87
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
To get AVM Fritzbox temperature sensor (e.g. FRITZ!DECT Repeater 100) follow the instructions for the [Fritzbox component](/components/fritzbox/).
|
||||
|
||||
## {% linkable_title Attributes %}
|
||||
|
||||
The are several attributes that can be useful for automations and templates.
|
||||
|
||||
| Attribute | Description |
|
||||
| --------- | ----------- |
|
||||
| `device_locked` | The state of the key lock at the device.
|
||||
| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface.
|
||||
| `temperature_unit` | The unit of the temperature sensor.
|
||||
| `temperature` | The current temperature sensor reading.
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "OpenTherm Gateway Sensor"
|
||||
description: "Expose internal data from the OpenTherm Gateway."
|
||||
date: 2018-10-10 12:23
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: opentherm.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.81
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `opentherm_gw` sensor platform is used to expose internal data from the [OpenTherm Gateway](http://otgw.tclcode.com/) in Home Assistant.
|
||||
|
||||
# {% linkable_title Configuration %}
|
||||
|
||||
Configuration of this platform is achieved through the [OpenTherm Gateway Hub](/components/opentherm_gw/) configuration.
|
||||
|
||||
<p class='note'>
|
||||
The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.
|
||||
</p>
|
||||
@ -1,50 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Ring Sensor"
|
||||
description: "Instructions on how to integrate your Ring.com devices within Home Assistant."
|
||||
date: 2017-04-01 10:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: ring.png
|
||||
ha_category: Doorbell
|
||||
ha_release: "0.40"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
To get your [Ring.com](https://ring.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: ring
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
monitored_conditions:
|
||||
type: list
|
||||
required: false
|
||||
description: Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions below will be enabled.
|
||||
keys:
|
||||
battery:
|
||||
description: Return the battery level from device.
|
||||
last_activity:
|
||||
description: Return the timestamp from the last event captured (ding/motion/on demand) by the Ring doorbell camera.
|
||||
last_ding:
|
||||
description: Return the timestamp from the last time the Ring doorbell button was pressed.
|
||||
last_motion:
|
||||
description: Return the timestamp from the last motion event captured by the Ring doorbell camera.
|
||||
volume:
|
||||
description: Return the volume level from the device.
|
||||
wifi_signal_category:
|
||||
description: Return the WiFi signal level from the device.
|
||||
wifi_signal_strength:
|
||||
description: Return the WiFi signal strength (dBm) from the device.
|
||||
{% endconfiguration %}
|
||||
|
||||
Currently it supports doorbell, external chimes and stickup cameras.
|
||||
@ -1,52 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "ZoneMinder Sensor"
|
||||
description: "How to view ZoneMinder monitor functions and events within Home Assistant."
|
||||
date: 2016-10-13 22:57
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: zoneminder.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.31
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `zoneminder` sensor platform lets you monitor the current state of your [ZoneMinder](https://www.zoneminder.com) install including the number of events, the current state of the cameras and ZoneMinder's current run state.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [ZoneMinder component](/components/zoneminder/) configured to use this sensor.
|
||||
</p>
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: zoneminder
|
||||
include_archived: false
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
include_archived:
|
||||
description: Whether to include archived ZoneMinder events in event counts.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
monitored_conditions:
|
||||
description: Event count sensors to display in the frontend.
|
||||
required: false
|
||||
type: list
|
||||
keys:
|
||||
all:
|
||||
description: All events.
|
||||
month:
|
||||
description: Events in the last month.
|
||||
week:
|
||||
description: Events in the last week.
|
||||
day:
|
||||
description: Events in the last day.
|
||||
hour:
|
||||
description: Events in the last hour.
|
||||
{% endconfiguration %}
|
||||
@ -1,22 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Amcrest IP Camera Settings"
|
||||
description: "Instructions on how to integrate settings for Amcrest IP Camera as switches within Home Assistant."
|
||||
date: 2018-03-08 00:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: amcrest.png
|
||||
ha_category: Switch
|
||||
ha_release: 0.67
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `amcrest` switch platform lets you control settings of [Amcrest IP Camera](https://home-assistant.io/components/camera.amcrest/) through Home Assistant.
|
||||
|
||||
Switches will be configured automatically. Please refer to the [component](/components/amcrest/) configuration on how to setup.
|
||||
|
||||
<p class='note warning'>
|
||||
In previous versions, switch devices in setups with multiple cameras, would not have specific entity ID causing them to change randomly after each Home Assistant restart. The current version adds the name of the camera at the end of the switch entity ID, making it more specific and consistent and causes the name option to be required in a multi-camera system. This behavior matches the sensor behavior of the Amcrest component. Because of this, older automations may require updates to the entity ID.
|
||||
</p>
|
||||
@ -1,20 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Lupusec Switch"
|
||||
description: "Instructions on how to integrate Lupusec switches into Home Assistant."
|
||||
date: 2018-10-03 16:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: lupusec.png
|
||||
ha_category: Switch
|
||||
ha_release: 0.83
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `lupusec` security control panel platform allows you to control your [Lupusec](https://www.lupus-electronics.de) devices.
|
||||
|
||||
This component will automatically add `Power Switches` configured in your Lupusec control panel.
|
||||
|
||||
For the switches to work you have to setup your [`lupusec` component](/components/lupusec/).
|
||||
@ -1,45 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "ZoneMinder Switch"
|
||||
description: "How to toggle the function of ZoneMinder monitors in Home Assistant."
|
||||
date: 2016-10-13 22:57
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: zoneminder.png
|
||||
ha_category: Switch
|
||||
ha_release: 0.31
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `zoneminder` switch platform allows you to toggle the current function of all cameras attached to your [ZoneMinder](https://www.zoneminder.com) instance.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [ZoneMinder component](/components/zoneminder/) configured to use this and if ZoneMinder authentication is enabled the account specified in the component configuration must have "Edit" permission for "System".
|
||||
</p>
|
||||
|
||||
To enable this switch, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
- platform: zoneminder
|
||||
command_on: Modect
|
||||
command_off: Monitor
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
command_on:
|
||||
description: The function you want the camera to run when turned on.
|
||||
required: true
|
||||
type: string
|
||||
command_off:
|
||||
description: The function you want the camera to run when turned off.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note'>
|
||||
The default functions installed by ZoneMinder are: None, Monitor, Modect, Record, Mocord, Nodect.
|
||||
</p>
|
||||
@ -55,11 +55,17 @@ Errors and warnings are posted as the event `system_log_event`, so it is possibl
|
||||
| `message` | Descriptive message of the error, e.g., "Error handling request". |
|
||||
| `timestamp` | Unix timestamp with as a double, e.g., 1517241010.237416. |
|
||||
|
||||
Live examples of these events can be found in the Home Assistant log file or by just looking in the system log. An example could, for instance, look like this:
|
||||
Live examples of these events can be found in the Home Assistant log file (`home-assistant.log`) or by just looking in the system log. An example could, for instance, look like this:
|
||||
|
||||
<img src='/images/components/system_log/system_log_entry.png' />
|
||||
```text
|
||||
2019-02-14 16:20:35 ERROR (MainThread) [homeassistant.loader] Unable to find component system_healt
|
||||
2019-02-14 16:20:36 ERROR (MainThread) [homeassistant.components.device_tracker] Error setting up platform google_maps
|
||||
Traceback (most recent call last):
|
||||
File "/home/fab/Documents/repos/ha/home-assistant/homeassistant/components/device_tracker/__init__.py", line 184, in
|
||||
[...]
|
||||
```
|
||||
|
||||
The message ("Unable to find service..."), source (`core.py`) and level (`WARNING`) can easily be extracted from the image. The exact timestamp and stack trace is shown in the selected entry.
|
||||
The message ("Unable to find component system_healt"), source (`homeassistant.loader`) and level (`ERROR`) can easily be extracted from the log. The exact timestamp and if there is a stack trace that's shown as well. Here is another error caused by the `google_map` integration with additional output present.
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
@ -91,6 +97,7 @@ automation:
|
||||
|
||||
This automation will create a persistent notification whenever an error or warning is logged that has the word "service" in the message:
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
automation:
|
||||
- alias: Create notifications for "service" errors
|
||||
@ -99,10 +106,11 @@ automation:
|
||||
event_type: system_log_event
|
||||
condition:
|
||||
condition: template
|
||||
value_template: {% raw %}'{{ "service" in trigger.event.data.message }}'{% endraw %}
|
||||
value_template: '{{ "service" in trigger.event.data.message }}'
|
||||
action:
|
||||
service: persistent_notification.create
|
||||
data_template:
|
||||
title: Something bad happened
|
||||
message: {% raw %}'{{ trigger.event.data.message }}'{% endraw %}
|
||||
message: '{{ trigger.event.data.message }}'
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
@ -8,13 +8,30 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: zoneminder.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Hub
|
||||
- Binary Sensor
|
||||
- Camera
|
||||
- Sensor
|
||||
- Switch
|
||||
featured: false
|
||||
ha_release: 0.31
|
||||
ha_iot_class: "Local Polling"
|
||||
redirect_from:
|
||||
- /components/binary_sensor.zoneminder/
|
||||
- /components/camera.zoneminder/
|
||||
- /components/sensor.zoneminder/
|
||||
- /components/switch.zoneminder/
|
||||
---
|
||||
|
||||
The ZoneMinder component sets up the integration with your [ZoneMinder](https://www.zoneminder.com) instance so that [cameras](/components/camera.zoneminder/), [sensors](/components/sensor.zoneminder/), and [switches](/components/switch.zoneminder) can use it. Configuring this component will automatically load the [binary_sensor](/components/binary_sensor.zoneminder) which tracks ZoneMinder availability.
|
||||
The ZoneMinder component sets up the integration with your [ZoneMinder](https://www.zoneminder.com) instance.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](#binary-sensor)
|
||||
- [Camera](#camera)
|
||||
- [Sensor](#sensor)
|
||||
- [Switch](#switch)
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
@ -91,3 +108,92 @@ action:
|
||||
id: ZM_HOST
|
||||
name: Home
|
||||
```
|
||||
|
||||
## {% linkable_title Binary Sensor %}
|
||||
|
||||
The `zoneminder` binary sensor platform lets you monitor the availability of your [ZoneMinder](https://www.zoneminder.com) install.
|
||||
|
||||
Each binary_sensor created will be named after the hostname used when configuring the [ZoneMinder component](/components/zoneminder/).
|
||||
|
||||
## {% linkable_title Camera %}
|
||||
|
||||
The `zoneminder` camera platform lets you monitor the current stream of your [ZoneMinder](https://www.zoneminder.com) cameras.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
camera:
|
||||
- platform: zoneminder
|
||||
```
|
||||
|
||||
## {% linkable_title Sensor %}
|
||||
|
||||
The `zoneminder` sensor platform lets you monitor the current state of your [ZoneMinder](https://www.zoneminder.com) install including the number of events, the current state of the cameras and ZoneMinder's current run state.
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: zoneminder
|
||||
include_archived: false
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
include_archived:
|
||||
description: Whether to include archived ZoneMinder events in event counts.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
monitored_conditions:
|
||||
description: Event count sensors to display in the frontend.
|
||||
required: false
|
||||
type: list
|
||||
keys:
|
||||
all:
|
||||
description: All events.
|
||||
month:
|
||||
description: Events in the last month.
|
||||
week:
|
||||
description: Events in the last week.
|
||||
day:
|
||||
description: Events in the last day.
|
||||
hour:
|
||||
description: Events in the last hour.
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Switch %}
|
||||
|
||||
The `zoneminder` switch platform allows you to toggle the current function of all cameras attached to your [ZoneMinder](https://www.zoneminder.com) instance.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [ZoneMinder component](/components/zoneminder/) configured to use this and if ZoneMinder authentication is enabled the account specified in the component configuration must have "Edit" permission for "System".
|
||||
</p>
|
||||
|
||||
To enable this switch, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
- platform: zoneminder
|
||||
command_on: Modect
|
||||
command_off: Monitor
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
command_on:
|
||||
description: The function you want the camera to run when turned on.
|
||||
required: true
|
||||
type: string
|
||||
command_off:
|
||||
description: The function you want the camera to run when turned off.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note'>
|
||||
The default functions installed by ZoneMinder are: None, Monitor, Modect, Record, Mocord, Nodect.
|
||||
</p>
|
||||
@ -1139,7 +1139,7 @@ Call service is the basic way of calling a service within AppDaemon. It can call
|
||||
#### {% linkable_title Synopsis %}
|
||||
|
||||
```python
|
||||
self.call_service(self, service, **kwargs)
|
||||
self.call_service(service, **kwargs)
|
||||
```
|
||||
|
||||
#### {% linkable_title Returns %}
|
||||
@ -1150,7 +1150,7 @@ None
|
||||
|
||||
##### {% linkable_title service %}
|
||||
|
||||
The service name, e.g., `light.turn_on`.
|
||||
The service name, e.g., `light/turn_on`.
|
||||
|
||||
##### {% linkable_title \*\*kwargs %}
|
||||
|
||||
|
||||
@ -31,23 +31,24 @@ Notes:
|
||||
* You must use the full filename in the payload (including extension).
|
||||
|
||||
## {% linkable_title Custom push notification sounds %}
|
||||
The app allows you to use your own custom sounds in push notifications. The sounds must be formatted following [Apple's requirements][sound-requirements]. You set the filename of the sound in the notification payload. To add sounds:
|
||||
|
||||
The app allows you to use your own custom sounds in push notifications. The sounds must be formatted as 32bit float 48000Hz wav files. You set the filename of the sound in the notification payload. To add sounds:
|
||||
|
||||
1. Connect the device to a PC or Mac running the latest version of iTunes.
|
||||
2. Go to the device in iTunes.
|
||||
3. Select "Apps" on the left sidebar.
|
||||
4. Scroll down until you see the section labeled "File Sharing".
|
||||
5. Select Home Assistant.
|
||||
6. Drag and drop properly formatted sounds.
|
||||
7. Click Sync in the lower right.
|
||||
8. Once sync is complete, disconnect the device from the computer.
|
||||
9. On your iOS device, open the Home Assistant app.
|
||||
10. Go to Settings -> Notification Settings.
|
||||
11. Select "Import sounds from iTunes".
|
||||
3. Select "File Sharing" in the left-hand menu.
|
||||
4. Select Home Assistant.
|
||||
5. Drag and drop properly formatted sounds (32bit float 48000Hz wav files).
|
||||
6. Click Sync in the lower right.
|
||||
7. Once the sync is complete, disconnect the device from the computer.
|
||||
8. On your iOS device, open the Home Assistant app.
|
||||
9. Go to Settings -> Notification Settings.
|
||||
10. Select "Import sounds from iTunes".
|
||||
|
||||
Assuming that you correctly formatted the sounds they are now available to use in push notifications.
|
||||
|
||||
Notes:
|
||||
|
||||
* **Please note that due to a bug in iOS 10 you may need to restart your entire device before notification sounds can be played. This should hopefully be fixed by Apple soon.**
|
||||
* Uploading a file with the same name as an existing one will overwrite the original.
|
||||
* You can view what sounds are installed on each device by inspecting the `ios.conf` file in your configuration directory. They are listed in the `pushSounds` array.
|
||||
|
||||
@ -77,7 +77,30 @@ The steps would be:
|
||||
* Click on "Next" and then "Apply"
|
||||
* Your Home Assistant within Docker should now run and will serve the web interface from port 8123 on your Docker host (this will be your Synology NAS IP address - for example `http://192.168.1.10:8123`)
|
||||
|
||||
To use a Z-Wave USB stick for Z-Wave control, the HA Docker container needs extra configuration to access to the USB stick. While there are multiple ways to do this, the least privileged way of granting access can only be performed via the Terminal, at the time of writing. See this page for configuring Terminal acces to your Synology NAS:
|
||||
|
||||
<https://www.synology.com/en-global/knowledgebase/DSM/help/DSM/AdminCenter/system_terminal>
|
||||
|
||||
See this page for accessing the Terminal via SSH:
|
||||
|
||||
<https://www.synology.com/en-global/knowledgebase/DSM/tutorial/General_Setup/How_to_login_to_DSM_with_root_permission_via_SSH_Telnet>
|
||||
|
||||
Adjust the following Terminal command as follows :
|
||||
|
||||
- Replace `/PATH_TO_YOUR_CONFIG` points at the folder where you want to store your configuration
|
||||
- Replace `/PATH_TO_YOUR_USB_STICK` matches the path for your USB stick (e.g., `/dev/ttyACM0` for most Synology users)
|
||||
- Replace "Australia/Melbourne" with [your timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
|
||||
|
||||
Run it in Terminal.
|
||||
|
||||
```bash
|
||||
sudo docker run --restart always -d --name="homeassistant" -v /PATH_TO_YOUR_CONFIG:/config --device=/PATH_TO_YOUR_USB_STICK -e TZ=Australia/Melbourne --net=host homeassistant/home-assistant
|
||||
```
|
||||
|
||||
Complete the remainder of the Z-Wave configuration by [following the instructions here.](/docs/z-wave/installation)
|
||||
|
||||
Remark: to update your Home Assistant on your Docker within Synology NAS, you just have to do the following:
|
||||
|
||||
* Go to the Docker-app and move to "Registry"-section
|
||||
* Find "homeassistant/home-assistant" within registry and click on "Download". Choose the "latest" tag, this will overwrite your current image to the latest version.
|
||||
* Wait until the system-message/-notification comes up, that the download is finished (there is no progress bar)
|
||||
|
||||
@ -201,7 +201,7 @@ Supported abbreviations:
|
||||
The following software has built-in support for MQTT discovery:
|
||||
|
||||
- [Sonoff-Tasmota](https://github.com/arendst/Sonoff-Tasmota) (starting with 5.11.1e)
|
||||
- [esphomeyaml](https://esphomelib.com/esphomeyaml/index.html)
|
||||
- [ESPHome](https://esphome.io)
|
||||
- [ESPurna](https://github.com/xoseperez/espurna)
|
||||
- [Arilux AL-LC0X LED controllers](https://github.com/mertenats/Arilux_AL-LC0X)
|
||||
- [room-assistant](https://github.com/mKeRix/room-assistant) (starting with 1.1.0)
|
||||
|
||||
@ -18,4 +18,10 @@ If you are able to successfully run `python3 --version` but not `pip3`, install
|
||||
$ python3 -m pip install homeassistant
|
||||
```
|
||||
|
||||
On a Debian system, you can also install python3 by `sudo apt-get install python3`d and pip3 by `sudo apt-get install python3-pip`.
|
||||
On a Debian system, you can also install python3 by `sudo apt-get install python3` and pip3 by `sudo apt-get install python3-pip`.
|
||||
|
||||
If you run into errors during installation, check that you've installed all the necessary prerequisite packages, which include `python3-dev`, `libffi-dev`, and `libssl-dev`. On a Debian-based system, you can install these via `apt-get`:
|
||||
|
||||
```bash
|
||||
$ sudo apt-get install python3-dev libffi-dev libssl-dev
|
||||
```
|
||||
|
||||
@ -17,7 +17,6 @@ There are various ways to get in touch with the Home Assistant community. It doe
|
||||
- [Discord Chat Server][discord] for general Home Assistant discussions and questions.
|
||||
- Follow us on [Twitter][twitter], use [@home_assistant][twitter]
|
||||
- Join the [Facebook community][facebook]
|
||||
- Join the [Google+ community][google-plus]
|
||||
- Join the Reddit in [/r/homeassistant][reddit]
|
||||
|
||||
### {% linkable_title Bugs, Feature requests, and alike %}
|
||||
|
||||
13
source/ios/beta-auth.markdown
Normal file
13
source/ios/beta-auth.markdown
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Home Assistant iOS beta authentication"
|
||||
description: "Landing page for Home Assistant iOS beta app."
|
||||
release_date: 2016-10-24 15:00:00 -0700
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
<link rel='redirect_uri' href='homeassistant-beta://auth-callback'>
|
||||
<script>document.location.href = '/docs/ecosystem/ios';</script>
|
||||
13
source/ios/dev-auth.markdown
Normal file
13
source/ios/dev-auth.markdown
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Home Assistant iOS dev authentication"
|
||||
description: "Landing page for Home Assistant iOS dev app."
|
||||
release_date: 2016-10-24 15:00:00 -0700
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
<link rel='redirect_uri' href='homeassistant-dev://auth-callback'>
|
||||
<script>document.location.href = '/docs/ecosystem/ios';</script>
|
||||
Loading…
x
Reference in New Issue
Block a user