commit
abfd390dc8
104 changed files with 1650 additions and 166 deletions
20
source/_components/alarm_control_panel.spc.markdown
Normal file
20
source/_components/alarm_control_panel.spc.markdown
Normal file
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Vanderbilt SPC Alarm"
|
||||
description: "Instructions how to setup the Vanderbilt SPC Alarm control panel within Home Assistant."
|
||||
date: 2017-05-18 22:01
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: vanderbilt_spc.png
|
||||
ha_category: Alarm
|
||||
ha_release: 0.47
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
|
||||
The `spc` alarm control panel platform allows you to control your [Vanderbilt SPC](http://www.spc-intruder-detection.com/ssp-spc/) alarms.
|
||||
|
||||
The requirement is that you have setup your [SPC hub](/components/spc/).
|
||||
|
20
source/_components/binary_sensor.spc.markdown
Normal file
20
source/_components/binary_sensor.spc.markdown
Normal file
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
layout: page
|
||||
title: "SPC Binary Sensor"
|
||||
description: "Instructions how to integrate Vanderbilt SPC binary sensors into Home Assistant."
|
||||
date: 2017-05-18 22:05
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: vanderbilt_spc.png
|
||||
ha_release: 0.47
|
||||
ha_category: Binary Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `spc` platform allows you to get data from your [Vanderbilt SPC](http://www.spc-intruder-detection.com/ssp-spc/) binary sensors from within Home Assistant.
|
||||
|
||||
Check the [type/class](/components/binary_sensor/) list for a possible visualization of your zone. Currently motion, smoke and door sensors are supported.
|
||||
|
||||
The requirement is that you have setup your [SPC hub](/components/spc/).
|
32
source/_components/binary_sensor.tapsaff.markdown
Normal file
32
source/_components/binary_sensor.tapsaff.markdown
Normal file
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Taps Aff"
|
||||
description: "Instructions how to use the Taps Aff binary sensor in Home Assistant."
|
||||
date: 2017-05-28 18:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: tapsaff.png
|
||||
ha_category: Weather
|
||||
featured: false
|
||||
ha_release: 0.47
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `tapsaff` binary sensor provides the 'Taps Aff' status for a given location within the UK using [Taps Aff](http://www.taps-aff.co.uk).
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: tapsaff
|
||||
location: glasgow
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **location** (*Required*): The location for the Taps Aff. It must be configured with a UK postcode or city to work.
|
||||
- **name** (*Optional*): The name to use when displaying this sensor.
|
36
source/_components/camera.onvif.markdown
Normal file
36
source/_components/camera.onvif.markdown
Normal file
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
layout: page
|
||||
title: "ONVIF Camera"
|
||||
description: "Instructions on how to integrate a ONVIF camera within Home Assistant."
|
||||
date: 2017-06-09 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: onvif.png
|
||||
ha_category: Camera
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
|
||||
The `ONVIF` platform allows you to use an ONVIF camera in Home Assistant. This requires FFmpeg component to be already configured.
|
||||
|
||||
To enable your ONVIF in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
camera:
|
||||
- platform: onvif
|
||||
host: 192.168.1.111
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): An IP or hostname of the camera.
|
||||
- **name** (*Optional*): Override the name of your camera.
|
||||
- **username** (*Optional*): The username for the camera.
|
||||
- **password** (*Optional*): The password for the camera.
|
||||
- **port** (*Optional*): The port for the camera. This defaults to 5000
|
||||
|
||||
|
||||
If you are running into trouble with this sensor, please refer to the [Troubleshooting section](/components/ffmpeg/#troubleshooting).
|
58
source/_components/climate.flexit.markdown
Normal file
58
source/_components/climate.flexit.markdown
Normal file
|
@ -0,0 +1,58 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Flexit A/C controller"
|
||||
description: "Instructions how to integrate Flexit A/C unit into Home Assistant."
|
||||
date: 2017-06-02 16:30 +0200
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: flexit.png
|
||||
ha_category: Climate
|
||||
ha_release: 0.47
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
Integrates [Flexit](https://www.flexit.no/en/) Air Conditioning unit into Home Assistant.
|
||||
|
||||
Requires an CI66 Modbus Adapter [CI66](https://www.flexit.no/en/products/air_handling_unit/accessories_ahu/modul/modbusadapter_ci66/modbus_adapter_ci66_k2-c2-uni/)
|
||||
|
||||
To enable this platform, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
climate:
|
||||
- platform: flexit
|
||||
slave: 21
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **slave** (*Required*): The slave ID of the modbus adapter, set using DIP-switches.
|
||||
- **name** (*Optional*): Displayed name of the A/C unit
|
||||
|
||||
<p class='note'>
|
||||
This component requires the [Modbus](/components/modbus/) component to be set up to work
|
||||
</p>
|
||||
|
||||
Full configuration example including modbus setup shown below:
|
||||
|
||||
DIP-switch settings on the CI66:
|
||||
1=ON, 2=ON, 3=OFF, 4=ON, 5=OFF, 6=ON, 7=ON, 8=ON
|
||||
|
||||
```yaml
|
||||
# Full example configuration.yaml entry
|
||||
modbus:
|
||||
type: serial
|
||||
method: rtu
|
||||
port: /dev/ttyUSB0
|
||||
baudrate: 56000
|
||||
stopbits: 1
|
||||
bytesize: 8
|
||||
parity: E
|
||||
|
||||
climate:
|
||||
- platform: flexit
|
||||
name: Main A/C
|
||||
slave: 21
|
||||
```
|
|
@ -7,7 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: garadget_logo.jpg
|
||||
logo: garadget.png
|
||||
ha_category: Cover
|
||||
ha_release: 0.32
|
||||
ha_iot_class: "Cloud Polling"
|
||||
|
|
|
@ -47,6 +47,8 @@ Configuration variables:
|
|||
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is `0`. Will also be used when publishing messages.
|
||||
- **retain** (*Optional*): If the published message should have the retain flag on or not. Default is `false`.
|
||||
- **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
|
||||
- **set_position_topic** (*Optional*): The MQTT topic to publish position commands to.
|
||||
- **set_position_template** (*Optional*): Defines a [template](/topics/templating/) to define the position to be sent to the `set_position_topic` topic. Incoming position value is available for use in the template `{{position}}`. If no template is defined, the numeric position (0-100) will be written directly to the topic.
|
||||
- **tilt_command_topic** (*Optional*): The MQTT topic to publish commands to control the cover tilt.
|
||||
- **tilt_status_topic** (*Optional*): The MQTT topic subscribed to receive tilt status update values.
|
||||
- **tilt_min** (*Optional*): The minimum tilt value. Default is `0`
|
||||
|
|
60
source/_components/dyson.markdown
Normal file
60
source/_components/dyson.markdown
Normal file
|
@ -0,0 +1,60 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Dyson"
|
||||
description: "Instructions how to integrate Dyson into Home Assistant."
|
||||
date: 2017-05-27 10:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: dyson.png
|
||||
ha_category: Hub
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
The `dyson` component is the main component to integrate all [Dyson](https://dyson.com) related platforms.
|
||||
|
||||
Currently limited to Cool Link Purifier.
|
||||
|
||||
To enable this component, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
dyson:
|
||||
username: <dyson_account_user_email>
|
||||
password: <dyson_acount_password>
|
||||
language: <dyson_account_language>
|
||||
devices:
|
||||
- device_id: <device_id_1>
|
||||
device_ip: <device_ip_1>
|
||||
- device_id: <device_id_2>
|
||||
device_ip: <device_ip_2>
|
||||
...
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): Dyson account username (email address)
|
||||
- **password** (*Required*): Dyson account password
|
||||
- **language** (*Required*): Dyson account language country code. Known working codes: `FR`, `NL`, `UK`, `AU`. But others codes should work.
|
||||
- **devices** (*Optional*): List of devices
|
||||
- **device_id** (*Required*): Device ID. Available in the mobiles applications (*Settings* page)
|
||||
- **device_ip** (*Required*): Device IP address
|
||||
|
||||
`devices` list is optional but you'll have to provide them if discovery is not working (warnings in the logs and the devices are not available in Home Assistant web interface).
|
||||
To find devices IP address, you can use your router or `nmap`:
|
||||
|
||||
```bash
|
||||
$ nmap -p 1883 XXX.XXX.XXX.XXX/YY -- open
|
||||
```
|
||||
|
||||
Where:
|
||||
|
||||
- **XXX.XXX.XXX.XXX** is your network address
|
||||
- **YY** is your network mask
|
||||
|
||||
For example:
|
||||
|
||||
```bash
|
||||
$ nmap -p 1883 192.168.0.0/24 -- open
|
||||
```
|
24
source/_components/fan.dyson.markdown
Normal file
24
source/_components/fan.dyson.markdown
Normal file
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Dyson Purifier Fan"
|
||||
description: "Instructions how to setup the Dyson Purifier fans within Home Assistant."
|
||||
date: 2017-05-27 10:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: dyson.png
|
||||
ha_category: Fan
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
|
||||
The `dyson` fan platform allows you to control your Dyson Purifier fans.
|
||||
|
||||
You have first to setup the [Dyson component](/components/dyson/)
|
||||
|
||||
### {% linkable_title Supported fan devices %}
|
||||
|
||||
- Pure Cool link (desk and tower)
|
||||
- Pure Hot+cool link (but heating is not yet supported)
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Home Assistant 0.46"
|
||||
title: "Home Assistant 0.47"
|
||||
description: ""
|
||||
date: 2016-12-16 17:00
|
||||
sidebar: true
|
||||
|
@ -9,7 +9,7 @@ sharing: true
|
|||
footer: true
|
||||
logo: home-assistant.png
|
||||
ha_category: Other
|
||||
ha_release: 0.46
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
Details about the latest release can always be found at:
|
||||
|
|
|
@ -10,9 +10,44 @@ footer: true
|
|||
logo: opencv.png
|
||||
ha_category: Image Processing
|
||||
featured: false
|
||||
ha_release: 0.44
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
The `opencv` image processing platform allows you to create a standalone image processor without the linked camera entity as mentioned in the [OpenCV page](https://home-assistant.io/components/opencv).
|
||||
[OpenCV](http://www.opencv.org) is an open source computer vision image and video processing library.
|
||||
|
||||
Please refer to the [component](/components/opencv/) configuration on how to setup the image processor.
|
||||
Some pre-defined classifiers can be found here: https://github.com/opencv/opencv/tree/master/data
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
|
||||
To setup OpenCV with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
image_processing:
|
||||
- platform: opencv
|
||||
name: Front Door Faces
|
||||
source:
|
||||
- entity_id: camera.front_door
|
||||
classifier:
|
||||
mom: /path/to/classifier.xml
|
||||
```
|
||||
|
||||
- **name** (*Required*): The name of the OpenCV image processor.
|
||||
- **source** array (*Required*): List of image sources.
|
||||
- **entity_id** (*Required*): A camera entity id to get picture from.
|
||||
- **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity.
|
||||
- **classifier** (*Optional*): Dictionary of name to path to the classifier xml file. If this field is not provided, a face classifier will be downloaded from OpenCV's github repo.
|
||||
|
||||
**classifier** may also be defined as a dictionary of names to classifier configurations:
|
||||
|
||||
```yaml
|
||||
mom:
|
||||
file: /path/to/classifier/xml
|
||||
neighbors: 4
|
||||
min_size: (40, 40)
|
||||
scale: 1.1f
|
||||
```
|
||||
|
||||
- **file** (*Required*): The path to the classifier xml file.
|
||||
- **scale** (*Optional*): The scale to perform when processing, this is a `float` value that must be greater than or equal to `1.0`, default is `1.1`.
|
||||
- **neighbors** (*Optional*): The minimum number of neighbors required for a match, default is `4`. The higher this number, the more picky the matching will be; lower the number, the more false positives you may experience.
|
||||
|
|
|
@ -42,8 +42,10 @@ Configuration variables:
|
|||
- **y_position** (*Optional*): Y coordinate of the upper left corner of the area to crop. Defaults to `0`.
|
||||
- **height** (*Optional*): Height of the area to crop. Defaults to `0`.
|
||||
- **width** (*Optional*): Width of the area to crop. Defaults to `0`.
|
||||
- **rotate** (*Optional*): Rotation of the image. Defaults to `0`.
|
||||
- **threshold** (*Optional*): Threshold for the difference between the digits and the background. Defaults to `0`.
|
||||
- **digits** (*Optional*): Number of digits in the display. Defaults to `-1`.
|
||||
- **extra_arguments** (*Optional*): Other arguments to use. Like `-D`, `dilation`, `erosion`, `greyscale`, `make_mono`, etc.
|
||||
- **source** array (*Required*): List of image sources.
|
||||
- **entity_id** (*Required*): A camera entity id to get picture from.
|
||||
- **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity.
|
||||
|
@ -54,7 +56,7 @@ Configuration variables:
|
|||
It's suggested that the first attempt to determine the needed parameters is using `ssocr` directly. This may require a couple of iterations to get the result
|
||||
|
||||
```bash
|
||||
$ ssocr -D erosion crop 390 250 490 280 -t 20 -d 4 ss-test.jpg
|
||||
$ ssocr -D erosion crop 390 250 490 280 -t 20 -d 4 seven-seg.png
|
||||
```
|
||||
|
||||
This would lead to the following entry for the `configuration.yaml` file:
|
||||
|
@ -62,7 +64,7 @@ This would lead to the following entry for the `configuration.yaml` file:
|
|||
```yaml
|
||||
camera:
|
||||
- platform: local_file
|
||||
file_path: /home/fab/.homeassistant/seven-seg.png
|
||||
file_path: /home/homeassistant/.homeassistant/seven-seg.png
|
||||
name: seven_segments
|
||||
image_processing:
|
||||
- platform: seven_segments
|
||||
|
|
|
@ -23,13 +23,13 @@ The default InfluxDB configuration doesn't enforce authentication. If you have i
|
|||
influxdb:
|
||||
```
|
||||
|
||||
You will still need to create a database named `home_assistant` via InfluxDB's web interface or command line. For instructions how to create a database check the [InfluxDB documentation](https://docs.influxdata.com/influxdb/v1.0/introduction/getting_started/#creating-a-database) relevant to the version you have installed.
|
||||
You will still need to create a database named `home_assistant` via InfluxDB's web interface or command line. For instructions how to create a database check the [InfluxDB documentation](https://docs.influxdata.com/influxdb/latest/introduction/getting_started/#creating-a-database) relevant to the version you have installed.
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Optional*): IP address of your database host, e.g. 192.168.1.10. Defaults to `localhost`.
|
||||
- **port** (*Optional*): Port to use. Defaults to 8086.
|
||||
- **username** (*Optional*): The username of the database user.
|
||||
- **username** (*Optional*): The username of the database user. The user needs read/write privileges on the database.
|
||||
- **password** (*Optional*): The password for the database user account.
|
||||
- **database** (*Optional*): Name of the database to use. Defaults to `home_assistant`. The database must already exist.
|
||||
- **ssl** (*Optional*): Use https instead of http to connect. Defaults to false.
|
||||
|
|
28
source/_components/juicenet.markdown
Normal file
28
source/_components/juicenet.markdown
Normal file
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Juicenet"
|
||||
description: "Instructions how to setup WiFi-equipped Juicenet charging stations with Home Assistant."
|
||||
date: 2017-05-20 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: juicenet.png
|
||||
ha_category: Hub
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
|
||||
The `juicenet` sensor platform pulls data from a [JuiceNet](https://emotorwerks.com/products/juicenet/) charging station equipped with a wifi connection. It will access and make available all of the devices attached to your account.
|
||||
|
||||
To enable the platform in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yml entry
|
||||
juicenet:
|
||||
access_token: ACCESS_TOKEN
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **access_token** (*Required*): Your eMotorWerks API Token can be found in the [dashboard](https://dashboard.emotorwerks.com/Manage).
|
|
@ -41,6 +41,7 @@ Change the light to a new state.
|
|||
| ---------------------- | ----------- |
|
||||
| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all.
|
||||
| `transition` | Duration (in seconds) for the light to fade to the new state.
|
||||
| `infrared` | Automatic infrared level (0..255) when light brightness is low (for compatible bulbs).
|
||||
| `power` | Turn the light on (`True`) or off (`False`). Leave out to keep the power as it is.
|
||||
| `...` | Use `color_name`, `brightness` etc. from [`light.turn_on`]({{site_root}}/components/light/#service-lightturn_on) to specify the new state.
|
||||
|
||||
|
@ -56,7 +57,7 @@ automation:
|
|||
- service: light.turn_on
|
||||
data:
|
||||
entity_id: light.office, light.kitchen
|
||||
effect: lifx_effect_breathe
|
||||
effect: lifx_effect_pulse
|
||||
```
|
||||
|
||||
However, if you want to fully control a light effect, you have to use its dedicated service call, like this:
|
||||
|
@ -76,23 +77,9 @@ script:
|
|||
|
||||
The available light effects and their options are listed below.
|
||||
|
||||
### {% linkable_title Service `light.lifx_effect_breathe` %}
|
||||
|
||||
Run a breathe effect by fading to a color and back.
|
||||
|
||||
| Service data attribute | Description |
|
||||
| ---------------------- | ----------- |
|
||||
| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all.
|
||||
| `color_name` | A color name such as `red` or `green`.
|
||||
| `rgb_color` | A list containing three integers representing the RGB color you want the light to be.
|
||||
| `brightness` | Integer between 0 and 255 for how bright the color should be.
|
||||
| `period` | The duration of a single breathe.
|
||||
| `cycles` | The total number of breathes.
|
||||
| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True).
|
||||
|
||||
### {% linkable_title Service `light.lifx_effect_pulse` %}
|
||||
|
||||
Run a flash effect by quickly changing to a color and then back.
|
||||
Run a flash effect by changing to a color and then back.
|
||||
|
||||
| Service data attribute | Description |
|
||||
| ---------------------- | ----------- |
|
||||
|
@ -100,8 +87,9 @@ Run a flash effect by quickly changing to a color and then back.
|
|||
| `color_name` | A color name such as `red` or `green`.
|
||||
| `rgb_color` | A list containing three integers representing the RGB color you want the light to be.
|
||||
| `brightness` | Integer between 0 and 255 for how bright the color should be.
|
||||
| `period` | The duration of a single pulse.
|
||||
| `period` | The duration of a single pulse (in seconds).
|
||||
| `cycles` | The total number of pulses.
|
||||
| `mode` | The way to change between colors. Valid modes: `blink` (default), `breathe`, `ping`, `strobe`, `solid`.
|
||||
| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True).
|
||||
|
||||
### {% linkable_title Service `light.lifx_effect_colorloop` %}
|
||||
|
|
32
source/_components/lock.sesame.markdown
Normal file
32
source/_components/lock.sesame.markdown
Normal file
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Sesame Smart Lock"
|
||||
description: "Instructions on how to integrate Sesame by CANDY HOUSE into Home Assistant."
|
||||
date: 2017-05-02 12:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: sesame.png
|
||||
ha_category: Lock
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_release: "0.47"
|
||||
---
|
||||
|
||||
The `sesame` platform allows you to control your [Sesame](https://candyhouse.co/) smart locks made by CANDY HOUSE, Inc.
|
||||
|
||||
Your Sesame needs to be paired with a mobile device running the app in *virtual station* mode, or a standalone [Wi-Fi Access Point](https://candyhouse.co/collections/frontpage/products/wi-fi-access-point).
|
||||
|
||||
Once you have remote access enabled, add the following to your `configuration.yaml` file:
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
lock:
|
||||
- platform: sesame
|
||||
email: abc@i-lovecandyhouse.co
|
||||
password: super-strong-password
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **email** (*Required*): The email address for your Sesame account.
|
||||
- **password** (*Required*): The password for your Sesame account.
|
|
@ -20,22 +20,22 @@ Presently, there's only support for communicating with the [RadioRA 2](http://ww
|
|||
|
||||
When configured, the `lutron` component will automatically discover the rooms and their associated switches/dimmers as configured by the RadioRA 2 software from Lutron. Each room will be treated as a separate group.
|
||||
|
||||
To use Lutron RadioRA 2 devices in your installation, add the following to your `configuration.yaml` file using the IP of your RadioRA 2 Main Repeater:
|
||||
To use Lutron RadioRA 2 devices in your installation, add the following to your `configuration.yaml` file using the IP address of your RadioRA 2 main repeater:
|
||||
|
||||
``` yaml
|
||||
# Example configuration.yaml entry
|
||||
lutron:
|
||||
lutron_host:IP_ADDRESS
|
||||
lutron_user: lutron
|
||||
lutron_password: integration
|
||||
host: IP_ADDRESS
|
||||
username: lutron
|
||||
password: integration
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **lutron_ip** (*Required*): The IP address of the Main Repeater.
|
||||
- **lutron_user** (*Required*): The login name of the user. The user `lutron` always exists, but other users can be added via RadioRA 2 software.
|
||||
- **lutron_password** (*Required*): The password for the user specified above. `integration` is the password for the always-present `lutron` user.
|
||||
- **host** (*Required*): The IP address of the Main Repeater.
|
||||
- **username** (*Required*): The login name of the user. The user `lutron` always exists, but other users can be added via RadioRA 2 software.
|
||||
- **password** (*Required*): The password for the user specified above. `integration` is the password for the always-present `lutron` user.
|
||||
|
||||
<p class='note'>
|
||||
It is recommended to assign a static IP address to your Main Repeater. This ensures that it won't change IP addresses, so you won't have to change the `lutron_ip` if it reboots and comes up with a different IP address.
|
||||
It is recommended to assign a static IP address to your main repeater. This ensures that it won't change IP addresses, so you won't have to change the `host` if it reboots and comes up with a different IP address.
|
||||
</p>
|
||||
|
|
35
source/_components/mailgun.markdown
Normal file
35
source/_components/mailgun.markdown
Normal file
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Mailgun"
|
||||
description: "Instructions how to add Mailgun mail notifications to Home Assistant."
|
||||
date: 2017-02-06 16:52
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: mailgun.png
|
||||
ha_category: Notifications
|
||||
ha_release: 0.38
|
||||
---
|
||||
|
||||
The component supports push messages and generates events based on inbound data. To use, add a Route set to Store and Notify with a URL of the following form: `https://<domain>/api/mailgun?api_password=<password>`
|
||||
|
||||
To send messages, use the [Mailgun notify platform][notify].
|
||||
|
||||
[notify]: /components/notify.mailgun/
|
||||
|
||||
## {% linkable_title Sample configuration %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
mailgun:
|
||||
domain: mg.example.com
|
||||
api_key: token-XXXXXXXXX
|
||||
sandbox: False
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **domain** (*Optional*): This is the domain name to be used when sending out mail. Defaults to the first custom domain you have set up.
|
||||
- **sandbox** (*Optional*): Whether to use the sandboxed domain for outgoing mail. The `domain` item takes precedence over this. Defaults to `False`.
|
||||
- **api_key** (*Required*): This is the API token that has been generated in your Mailgun account.
|
|
@ -7,7 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: sharp_aquos.jpg
|
||||
logo: sharp_aquos.png
|
||||
ha_category: Media Player
|
||||
featured: false
|
||||
ha_release: 0.35
|
||||
|
|
|
@ -22,9 +22,17 @@ Supported devices:
|
|||
- Denon RCD-N8 (untested)
|
||||
- Denon RCD-N9 (partial support)
|
||||
- Denon AVR receivers with integrated Network support (partial support)
|
||||
- Denon AVR-X2000 (via denonavr platform)
|
||||
- Denon AVR-X2100W (via denonavr platform)
|
||||
- Denon AVR-X4100W (via denonavr platform)
|
||||
- Denon AVR receivers (via denonavr platform (untested))
|
||||
- Denon AVR-1912 (via denonavr platform)
|
||||
- Denon AVR-2312CI (via denonavr platform)
|
||||
- Denon AVR-3311CI (via denonavr platform)
|
||||
- Marantz M-CR603 (via denonavr platform)
|
||||
- Marantz M-RC610 (via denonavr platform)
|
||||
- Marantz SR5008 (via denonavr platform)
|
||||
- Marantz NR1604 (via denonavr platform)
|
||||
- Other Denon AVR receivers (via denonavr platform (untested))
|
||||
- Marantz receivers (experimental via denonavr platform)
|
||||
|
||||
<pre class='note'>
|
||||
|
@ -60,12 +68,21 @@ A few notes for platform: denon
|
|||
media_player:
|
||||
- platform: denonavr
|
||||
host: IP_ADDRESS
|
||||
name: NAME
|
||||
show_all_sources: True / False
|
||||
zones:
|
||||
- zone: Zone2 / Zone3
|
||||
name: NAME
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Optional*): IP address of the device. Example: 192.168.1.32. If not set, auto discovery is used.
|
||||
- **name** (*Optional*): Name of the device. If not set, friendlyName of receiver is used.
|
||||
- **show_all_sources** (*Optional*): If True all sources are displayed in sources list even if they are marked as deleted in the receiver. If False deleted sources are not displayed (default). Some receivers have a bug that marks all sources as deleted in the interface. In this case this option could help.
|
||||
- **zones** (*Optional*): List of additional zones to be activated. They are displayed as additional media players with the same functionality Main Zone of the device supports
|
||||
- **zone**: Zone which should be activated. Valid options are Zone2 and Zone3
|
||||
- **name** (*Optional*): Name of the zone. If not set the name of the main device + zone as suffix is taken.
|
||||
|
||||
A few notes for platform: denonavr
|
||||
- Additional option the control Denon AVR receivers with a builtin web server is using the HTTP interface with denonavr platform.
|
||||
|
|
38
source/_components/media_player.nadtcp.markdown
Normal file
38
source/_components/media_player.nadtcp.markdown
Normal file
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
layout: page
|
||||
title: "NAD tcp"
|
||||
description: "Instructions how to integrate the NAD D 7050 or C338 digital amplifiers into Home Assistant."
|
||||
date: 2017-06-07 20:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: nad.png
|
||||
ha_category: Media Player
|
||||
ha_release: 0.47
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `nadtcp` platform allows you to control the D7050 and C338 from Home Assistant via WiFi. Note that it has only been tested with the D 7050.
|
||||
|
||||
To add a NAD amplifier to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
media_player:
|
||||
platform: nadtcp
|
||||
host: 192.168.0.112
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): The IP address of your amplifier.
|
||||
- **name** (*Optional*): Name of the device. Default is NAD amplifier.
|
||||
- **min_volume** (*optional*): Minimum volume in dB to use with the slider. Default is `-60`
|
||||
- **max_volume** (*optional*): Maximum volume in dB to use with the slider. Default is `-10`
|
||||
- **volume_step** (*Optional*): The amount in dB you want to increase the volume with when pressing volume up/down. Default is 4 dB.
|
||||
|
||||
The maximum volume level of the D 7050 amplifier is +10 db, minimum is -90.
|
||||
|
||||
|
|
@ -7,7 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: soundtouch.jpg
|
||||
logo: soundtouch.png
|
||||
ha_category: Media Player
|
||||
ha_release: 0.34.0
|
||||
ha_iot_class: "Local Polling"
|
||||
|
|
|
@ -18,10 +18,15 @@ The `spotify` media player platform allows you to control [Spotify](https://www.
|
|||
|
||||
## {% linkable_title Prerequisites %}
|
||||
|
||||
- Spotify Premium account.
|
||||
- Spotify Application, properly configured.
|
||||
- Spotify account.
|
||||
- Spotify Application, properly configured
|
||||
|
||||
<p class='note'>
|
||||
Controlling the Spotify component (pause, play, next, etc) requires a Premium account. If you do not have a Premium account, the component in the frontend will not show the controls.
|
||||
</p>
|
||||
|
||||
To create the required Spotify Application:
|
||||
|
||||
- Login to [Spotify Developer](https://developer.spotify.com)
|
||||
- Visit the [My Applications](https://developer.spotify.com/my-applications/#!/applications) page
|
||||
- Select **Create An App**. Enter any name and description. Once your application is created, view it and copy your **Client ID** and **Client Secret**, which are used in the Home Assistant configuration file.
|
||||
|
@ -46,6 +51,9 @@ media_player:
|
|||
- platform: spotify
|
||||
client_id: <your client id>
|
||||
client_secret: <your client secret>
|
||||
aliases:
|
||||
abc123def456: 'Living Room'
|
||||
9183abas000: 'Bed Room'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
@ -53,6 +61,7 @@ Configuration variables:
|
|||
- **client_id** (*Required*): Client ID from your Spotify Application.
|
||||
- **client_secret** (*Required*): Client Secret from your Spotify Application.
|
||||
- **cache_path** (*Optional*): Path to cache authentication token (defaults to configuration directory).
|
||||
- **aliases** (*Optional*): Dictionary of device ids to be aliased, handy for devices that Spotify cannot properly determine the device name of. New devices will be logged to the `info` channel for ease of aliasing.
|
||||
|
||||
## {% linkable_title Setup %}
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Mailgun"
|
||||
title: "Mailgun Notify"
|
||||
description: "Instructions how to add Mailgun mail notifications to Home Assistant."
|
||||
date: 2017-02-06 16:52
|
||||
sidebar: true
|
||||
|
@ -12,18 +12,23 @@ ha_category: Notifications
|
|||
ha_release: 0.38
|
||||
---
|
||||
|
||||
The Mailgun notification service allows you to send emails via Mailgun's REST API.
|
||||
The Mailgun notification service allows you to send emails via Mailgun's REST API. It requires the [Mailgun component] to be set up.
|
||||
|
||||
[Mailgun component]: /components/mailgun/
|
||||
|
||||
## {% linkable_title Sample configuration %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
mailgun:
|
||||
domain: mg.example.com
|
||||
api_key: token-XXXXXXXXX
|
||||
sandbox: False
|
||||
|
||||
notify:
|
||||
- name: NOTIFIER_NAME
|
||||
- name: mailgun
|
||||
platform: mailgun
|
||||
domain: YOUR_MAILGUN_DOMAIN
|
||||
token: TOKEN
|
||||
recipient: RECIPIENT_EMAIL
|
||||
recipient: me@example.com
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
@ -34,21 +39,6 @@ Configuration variables:
|
|||
- **recipient** (*Required*): The email address of the recipient.
|
||||
- **sender** (*Optional*): The sender's email address. Defaults to `hass@DOMAIN`, where `DOMAIN` is outgoint mail domain, as defined by the `domain` and `sanbox` configuration entries.
|
||||
|
||||
## {% linkable_title Full configuration %}
|
||||
|
||||
A full configuration example for the Mailgun notifier system can look like this:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
notify:
|
||||
- name: mailgun
|
||||
platform: mailgun
|
||||
domain: mg.example.com
|
||||
sanbox: False
|
||||
token: 'token-XXXXXXXXX'
|
||||
recipient: me@example.com
|
||||
```
|
||||
|
||||
## {% linkable_title Example automation %}
|
||||
|
||||
The following automation reacts to an event by sending out an email with two attachments.
|
||||
|
|
|
@ -23,7 +23,7 @@ The requirements are:
|
|||
|
||||
To retrieve your `chat_id`, contact any of the Telegram bots created for this purpose (@myidbot, @get_id_bot)
|
||||
|
||||
The quickest way to retrieve your `chat_id` is visiting [https://api.telegram.org/botYOUR_API_TOKEN/getUpdates](https://api.telegram.org/botYOUR_API_TOKEN/getUpdates) or to use `$ curl -X GET https:/api.telegram.org/botYOUR_API_TOKEN/getUpdates`. Replace `YOUR_API_TOKEN` with your actual token.
|
||||
The quickest way to retrieve your `chat_id` is visiting [https://api.telegram.org/botYOUR_API_TOKEN/getUpdates](https://api.telegram.org/botYOUR_API_TOKEN/getUpdates) or to use `$ curl -X GET https://api.telegram.org/botYOUR_API_TOKEN/getUpdates`. Replace `YOUR_API_TOKEN` with your actual token.
|
||||
|
||||
The result set will include your chat ID as `id` in the `from` section:
|
||||
|
||||
|
|
|
@ -1,75 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "OpenCV"
|
||||
description: "Instructions how to setup OpenCV within Home Assistant."
|
||||
date: 2017-04-01 22:36
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: opencv.png
|
||||
ha_category: Hub
|
||||
ha_release: 0.44
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
[OpenCV](http://www.opencv.org) is an open source computer vision image and video processing library.
|
||||
|
||||
Some pre-defined classifiers can be found here: https://github.com/opencv/opencv/tree/master/data
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
|
||||
To setup OpenCV with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
opencv:
|
||||
classifier_group:
|
||||
- name: Family
|
||||
add_camera: True
|
||||
entity_id:
|
||||
- camera.front_door
|
||||
- camera.living_room
|
||||
classifier:
|
||||
- file_path: /path/to/classifier/face.xml
|
||||
name: Bob
|
||||
- file_path: /path/to/classifier/face_profile.xml
|
||||
name: Jill
|
||||
min_size: (20, 20)
|
||||
color: (255, 0, 0)
|
||||
scale: 1.6
|
||||
neighbors: 5
|
||||
- file_path: /path/to/classifier/kid_face.xml
|
||||
name: Little Jimmy
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Required*): The name of the OpenCV image processor.
|
||||
- **entity_id** (*Required*): The camera entity or list of camera entities that this classification group will be applied to.
|
||||
- **classifier** (*Required*): The classification configuration for to be applied:
|
||||
- **file_path** (*Required*): The path to the HAARS or LBP classification file (xml).
|
||||
- **name** (*Optional*): The classification name, the default is `Face`.
|
||||
- **min_size** (*Optional*): The minimum size for detection as a tuple `(width, height)`, the default is `(30, 30)`.
|
||||
- **color** (*Optional*): The color, as a tuple `(Blue, Green, Red)` to draw the rectangle when linked to a dispatcher camera, the default is `(255, 255, 0)`.
|
||||
- **scale** (*Optional*): The scale to perform when processing, this is a `float` value that must be greater than or equal to `1.0`, default is `1.1`.
|
||||
- **neighbors** (*Optional*): The minimum number of neighbors required for a match, default is `4`. The higher this number, the more picky the matching will be; lower the number, the more false positives you may experience.
|
||||
|
||||
Once OpenCV is configured, it will create an `image_processing` entity for each classification group/camera entity combination as well as a camera so you can see what Home Assistant sees.
|
||||
|
||||
The attributes on the `image_processing` entity will be:
|
||||
|
||||
```json
|
||||
'matches': {
|
||||
'Bob': [
|
||||
(x, y, w, h)
|
||||
],
|
||||
'Jill': [
|
||||
(x, y, w, h)
|
||||
],
|
||||
'Little Jimmy': [
|
||||
(x, y, w, h)
|
||||
]
|
||||
}
|
||||
```
|
||||
|
45
source/_components/python_script.markdown
Normal file
45
source/_components/python_script.markdown
Normal file
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Python Scripts"
|
||||
description: "Instructions how to setup Python scripts within Home Assistant."
|
||||
date: 2017-06-15 19:59
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: home-assistant.png
|
||||
ha_category: Automation
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
This component allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the `<config>/python_scripts/` folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment. The following variables are available in the sandbox:
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| `hass` | The Home Assistant object. Access is only allowed to call services, set/remove states and fire events. [API reference][hass-api]
|
||||
| `data` | The data passed to the Python Script service call.
|
||||
| `logger` | A logger to allow you to log messages: `logger.info()`, `logger.warning()`, `logger.error()`. [API reference][logger-api]
|
||||
|
||||
[hass-api]: https://home-assistant.io/developers/development_hass_object/
|
||||
[logger-api]: https://docs.python.org/3.4/library/logging.html#logger-objects
|
||||
|
||||
## {% linkable_title Writing your first script %}
|
||||
|
||||
- Add to `configuration.yaml`: `python_script:`
|
||||
- Create folder `<config>/python_scripts`
|
||||
- Create a file `hello_world.py` in the folder and give it this content:
|
||||
|
||||
```python
|
||||
name = data.get('name', 'world')
|
||||
logger.info("Hello {}".format(name))
|
||||
hass.bus.fire(name, { "wow": "from a Python script!" })
|
||||
```
|
||||
|
||||
- Start Home Assistant
|
||||
- Call service `python_script/hello_world` with parameters
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "you"
|
||||
}
|
||||
```
|
|
@ -31,7 +31,7 @@ Configuration variables:
|
|||
|
||||
- **[service_name]** (*Required*): The name used to expose the service. E.g. in the above example would it be ` rest_command.example_request`.
|
||||
- **url** (*Required*): The URL (support template) for sending request.
|
||||
- **method** (*Optional*): HTTP method (get, post, put, delete). Default is get.
|
||||
- **method** (*Optional*): HTTP method to use (`get`, `post`, `put`, or `delete`). Defaults to `get`.
|
||||
- **payload** (*Optional*): A string/template to send with request.
|
||||
- **username** (*Optional*): The username for HTTP authentication.
|
||||
- **password** (*Optional*): The password for HTTP authentication.
|
||||
|
|
33
source/_components/sensor.blockchain.markdown
Normal file
33
source/_components/sensor.blockchain.markdown
Normal file
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Blockchain.info"
|
||||
description: "Instructions how to integrate Blockchain.info data within Home Assistant."
|
||||
date: 2017-06-01 16:20
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: blockchain.png
|
||||
ha_category: Finance
|
||||
ha_release: 0.47
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `Blockchain` sensor platform displays Bitcoin wallet balances from [blockchain.info](https://blockchain.info).
|
||||
|
||||
To add the Blockchain sensor to your installation, specify a list of bitcoin addresses to watch in the `configuration.yaml` file. The sensor state will be the sum of the balances of all addresses listed.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: blockchain
|
||||
addresses:
|
||||
- '1BMsHFczb2vY1BMDvFGWgGU8mkWVm5fupp'
|
||||
- '183J5pXWqYYsxZ7inTVw9tEpejDXyMFroe'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **addresses** (*Required*): List of bitcoin wallet addresses to watch.
|
||||
|
78
source/_components/sensor.buienradar.markdown
Normal file
78
source/_components/sensor.buienradar.markdown
Normal file
|
@ -0,0 +1,78 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Buienradar"
|
||||
description: "Instructions how to integrate buienradar.nl sensor within Home Assistant."
|
||||
date: 2017-05-15 14:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo:
|
||||
ha_category: Weather
|
||||
ha_release: 0.44
|
||||
---
|
||||
|
||||
|
||||
The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The
|
||||
weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands.
|
||||
The relevant weatherstation used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component).
|
||||
|
||||
To integrate `buienradar` with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: buienradar
|
||||
monitored_conditions:
|
||||
- symbol
|
||||
- humidity
|
||||
- temperature
|
||||
- windspeed
|
||||
- pressure
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **platform** (*Required*): buienradar.
|
||||
- **latitude** (*Optional*): latitude to use for selection of data source location. Longitude & latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.
|
||||
- **longitude** (*Optional*): longitude to use for selection of data source location. Longitude & latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.
|
||||
- **monitored_conditions** array (*Required*): one or more conditions to display in the frontend.
|
||||
- **stationname**: the name of the selected meteo-station.
|
||||
- **symbol**: A symbol for the current weather.
|
||||
- **humidity**: The relative humidity (%).
|
||||
- **temperature**: The current temperature (in C).
|
||||
- **groundtemperature**: The current ground temperature (in C).
|
||||
- **windspeed**: The wind speed in m/s.
|
||||
- **windforce**: The wind speed/force in Bft.
|
||||
- **winddirection**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise.
|
||||
- **windazimuth**: Where the wind is coming from: N (North),Z (south), NO (Noth-East), etc..
|
||||
- **pressure**: The sea-level air pressure in hPa.
|
||||
- **visibility**: Visibility in meters (m).
|
||||
- **windgust**: The windspeed of wind gusts (m/s).
|
||||
- **precipitation**: the amount of precipitation/rain in mm/h.
|
||||
- **irradiance**: Sun intensity in Watt per square meter (W/m2).
|
||||
|
||||
Full configuration example where location is manually specified:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
- platform: buienradar
|
||||
latitude: 51.65
|
||||
longitude: 5.70
|
||||
monitored_conditions:
|
||||
- stationname
|
||||
- symbol
|
||||
- humidity
|
||||
- temperature
|
||||
- groundtemperature
|
||||
- windspeed
|
||||
- windforce
|
||||
- winddirection
|
||||
- windazimuth
|
||||
- pressure
|
||||
- visibility
|
||||
- windgust
|
||||
- precipitation
|
||||
- irradiance
|
||||
```
|
||||
|
|
@ -7,7 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: comed.jpg
|
||||
logo: comed.png
|
||||
ha_category: Energy
|
||||
ha_release: "0.40"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
|
|
24
source/_components/sensor.dyson.markdown
Normal file
24
source/_components/sensor.dyson.markdown
Normal file
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Dyson Purifier Sensor"
|
||||
description: "Instructions how to setup the Dyson Purifier fans within Home Assistant."
|
||||
date: 2017-05-27 10:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: dyson.png
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
|
||||
The `dyson` sensor platform allows you to control your Dyson Purifier's filter life time.
|
||||
|
||||
You have first to setup the [Dyson component](/components/dyson/)
|
||||
|
||||
### {% linkable_title Supported fan devices %}
|
||||
|
||||
- Pure Cool link (desk and tower)
|
||||
- Pure Hot+cool link (but heating is not yet supported)
|
|
@ -7,7 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: ebox.jpg
|
||||
logo: ebox.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.39
|
||||
ha_iot_class: "Cloud Polling"
|
||||
|
|
16
source/_components/sensor.ecobee.markdown
Normal file
16
source/_components/sensor.ecobee.markdown
Normal file
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Ecobee Sensor"
|
||||
description: "Instructions how to setup the Ecobee sensors within Home Assistant."
|
||||
date: 2015-11-30 18:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: ecobee.png
|
||||
ha_category: Binary Sensor
|
||||
ha_release: 0.9
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
To get your Ecobee sensors working with Home Assistant, follow the instructions for the general [Ecobee component](/components/ecobee/).
|
31
source/_components/sensor.etherscan.markdown
Normal file
31
source/_components/sensor.etherscan.markdown
Normal file
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Etherscan"
|
||||
description: "Instructions how to integrate Etherscan.io data within Home Assistant."
|
||||
date: 2017-06-01 16:20
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: etherscan.png
|
||||
ha_category: Finance
|
||||
ha_release: 0.47
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `Etherscan` sensor platform displays Ethereum wallet balances from [Etherscan.io](https://etherscan.io).
|
||||
|
||||
To add the Etherscan sensor to your installation, specify an ethereum address to watch in the `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: etherscan
|
||||
address: '0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **address** (*Required*): Ethereum wallet address to watch.
|
||||
- **name** (*Optional*): The name of the sensor used in the frontend.
|
31
source/_components/sensor.gitter.markdown
Normal file
31
source/_components/sensor.gitter.markdown
Normal file
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Gitter Sensor"
|
||||
description: "Instructions how to integrate a Gitter room sensor with Home Assistant"
|
||||
date: 2017-06-11 09:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: gitter.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
|
||||
This `gitter` sensor allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages.
|
||||
|
||||
To use a Gitter sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: gitter
|
||||
api_key: YOUR_API_TOKEN
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **api_key** (*Required*): Your Gitter.im API token.
|
||||
- **room** (*Optional*): Gitter room to monitor. Defaults to `home-assistant/home-assistant`
|
||||
|
|
@ -147,6 +147,5 @@ Here, last Monday is _today_ as a timestamp, minus 86400 times the current weekd
|
|||
```
|
||||
|
||||
<p class='note'>
|
||||
The `/dev-template` page of your home-assistant UI can help you check if the values for `start`, `end` or `duration` are correct.
|
||||
If you want to check if your period is right, just click on your component, the `from` and `to` attributes will show the start and end of the period, nicely formatted.
|
||||
The `/dev-template` page of your home-assistant UI can help you check if the values for `start`, `end` or `duration` are correct. If you want to check if your period is right, just click on your component, the `from` and `to` attributes will show the start and end of the period, nicely formatted.
|
||||
</p>
|
||||
|
|
30
source/_components/sensor.juicenet.markdown
Normal file
30
source/_components/sensor.juicenet.markdown
Normal file
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Juicenet Sensor"
|
||||
description: "Instructions how to setup WiFi-equipped Juicenet charging stations with Home Assistant."
|
||||
date: 2015-01-20 22:36
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: juicenet.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
|
||||
The `juicenet` sensor platform allows you to get data from your [JuiceNet](https://emotorwerks.com/products/juicenet/) sensors.
|
||||
|
||||
The requirement is that you have setup [Juicenet](/components/juicenet/).
|
||||
|
||||
### {% linkable_title Added sensors %}
|
||||
|
||||
These sensors will be added for each juicenet device in your account:
|
||||
|
||||
- Status
|
||||
- Temperature (inside the device)
|
||||
- Voltage
|
||||
- Amps
|
||||
- Watts
|
||||
- Charge time of session
|
||||
- Energy added this session
|
123
source/_components/sensor.radarr.markdown
Normal file
123
source/_components/sensor.radarr.markdown
Normal file
|
@ -0,0 +1,123 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Radarr Sensor"
|
||||
description: "Instructions how to integrate Radarr sensors with Home Assistant"
|
||||
date: 2017-05-04 00:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: radarr.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
|
||||
This `radarr` sensor platform pulls data from a given Radarr instance.
|
||||
|
||||
To use your [Radarr](https://radarr.tv/) sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: radarr
|
||||
api_key: YOUR_API_KEY
|
||||
host: IP_ADDRESS
|
||||
port: PORT
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **api_key** (*Required*): Your Radarr API key, found in Settings > General in the Radarr Web UI.
|
||||
- **monitored_conditions** array (*Required*): Conditions to display on the frontend.
|
||||
- **movies**: The number of movies in Radarr.
|
||||
- **upcoming**: The number of upcoming movie releases (physical and in cinemas).
|
||||
- **commands**: The number of commands being run.
|
||||
- **diskspace**: Available disk space.
|
||||
- **status**: System status information
|
||||
- **host** (*Optional*): The host Radarr is running on (Default: localhost).
|
||||
- **port** (*Optional*): The port Radarr is running on (Default: 7878).
|
||||
- **urlbase** (*Optional*): The base URL Radarr is running under (Default: /).
|
||||
- **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only (Default: 1).
|
||||
- **include_paths** (*Optional*): Array of filepaths to include when calculating diskspace. Leave blank to include all.
|
||||
- **unit**: (*Optional*): The unit to display disk space in (Default: GB).
|
||||
- **ssl**: boolean (*Optional*): Whether or not to use SSL for Radarr.
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
In this section you find some real life examples of how to use this sensor.
|
||||
|
||||
### {% linkable_title Get Episodes airing in next 2 days %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: radarr
|
||||
api_key: YOUR_API_KEY
|
||||
host: 192.168.1.8
|
||||
monitored_conditions:
|
||||
- upcoming
|
||||
days: 2
|
||||
```
|
||||
|
||||
### {% linkable_title Enable SSL %}
|
||||
|
||||
SSL may run on a different port than the default (7878). The SSL port can be bound to any port in Radarr, so it should be set in the config here (unless it is changed to 7878).
|
||||
|
||||
```yaml
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: radarr
|
||||
api_key: YOUR_API_KEY
|
||||
host: 192.168.1.8
|
||||
port: 9898
|
||||
monitored_conditions:
|
||||
- upcoming
|
||||
days: 2
|
||||
ssl: true
|
||||
```
|
||||
|
||||
### {% linkable_title Get disk space for all storage locations %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: radarr
|
||||
api_key: YOUR_API_KEY
|
||||
host: 192.168.1.8
|
||||
monitored_conditions:
|
||||
- diskspace
|
||||
```
|
||||
|
||||
### {% linkable_title Get disk space for listed storage locations %}
|
||||
|
||||
The storage locations Radarr returns are in the system page and in some cases this can list duplicates if sub paths are mounted separately. By listing paths to include, you can choose what data is reported by the sensor.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: radarr
|
||||
api_key: YOUR_API_KEY
|
||||
host: 192.168.1.8
|
||||
monitored_conditions:
|
||||
- diskspace
|
||||
include_paths:
|
||||
- /tank/plex
|
||||
```
|
||||
|
||||
### {% linkable_title Get disk space in different unit %}
|
||||
|
||||
The Radarr API returns available space in bytes, but this sensor will default to reporting it in GB to make the number more manageable. This can be overridden if your storage needs require a different unit. All units from bytes (B) to yottabytes (YB) are supported.
|
||||
|
||||
*This calculation is done using base 2 math, and may differ from systems calculating using base 10 math.*
|
||||
|
||||
```yaml
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: radarr
|
||||
api_key: YOUR_API_KEY
|
||||
host: 192.168.1.8
|
||||
monitored_conditions:
|
||||
- diskspace
|
||||
unit: TB
|
||||
```
|
31
source/_components/sensor.ripple.markdown
Normal file
31
source/_components/sensor.ripple.markdown
Normal file
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Ripple"
|
||||
description: "Instructions how to integrate ripple.com data within Home Assistant."
|
||||
date: 2017-06-06 16:20
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: ripple.png
|
||||
ha_category: Finance
|
||||
ha_release: 0.47
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `ripple` sensor platform displays Ripple wallet balances from [Ripple.com](https://ripple.com).
|
||||
|
||||
To add the Ripple sensor to your installation, specify a ripple address to watch in the `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: ripple
|
||||
address: 'r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **address** (*Required*): Ripple wallet address to watch
|
||||
- **name** (*Optional*): Name for the sensor to use in the frontend.
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Yahoo Weather"
|
||||
title: "Yahoo Weather Sensor"
|
||||
description: "Instructions how to integrate Yahoo Weather within Home Assistant."
|
||||
date: 2016-07-06 9:06
|
||||
sidebar: true
|
||||
|
@ -17,10 +17,10 @@ ha_iot_class: "Cloud Polling"
|
|||
The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/) as an source for current meteorological data. The `forecast` will show you the condition for 5 days, 0 is the current day. You can use only `weather`, `temp_min`, and `temp_max` with forecast. It's important to note that a yweather sensor will only show ONE days forecast at a time so to show multiple days forecasts, you will need to use the 'name:' option and give each sensor a unique name.
|
||||
|
||||
<p class='note warning'>
|
||||
Use of the Yahoo Weather API should not exceed reasonable request volume. Access is limited to 2,000 signed calls per day.
|
||||
Use of the Yahoo Weather API should not exceed reasonable request volume. Access is limited to 2000 signed calls per day.
|
||||
</p>
|
||||
|
||||
The `woeid` (Where On Earth ID) for your location, as shown in the example below. You can find your woeid by copying the numeric digits at the end of the URL for your location at [Yahoo Weather](https://www.yahoo.com/news/weather/). If you don't add a woeid it generate it from Home Assistant's latitude and longitude.
|
||||
The `woeid` (Where On Earth ID) for your location, as shown in the example below. You can find your WOEID by copying the numeric digits at the end of the URL for your location at [Yahoo Weather](https://www.yahoo.com/news/weather/). If you don't add a WOEID it generate it from Home Assistant's latitude and longitude.
|
||||
|
||||
To add Yahoo Weather to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
@ -68,7 +68,6 @@ sensor:
|
|||
- weather
|
||||
- temp_min
|
||||
- temp_max
|
||||
|
||||
- platform: yweather
|
||||
forecast: 2
|
||||
name: yw_day2
|
||||
|
@ -76,7 +75,6 @@ sensor:
|
|||
- weather
|
||||
- temp_min
|
||||
- temp_max
|
||||
|
||||
- platform: yweather
|
||||
forecast: 3
|
||||
name: yw_day3
|
||||
|
@ -84,9 +82,7 @@ sensor:
|
|||
- weather
|
||||
- temp_min
|
||||
- temp_max
|
||||
|
||||
```
|
||||
|
||||
|
||||
Details about the API are available in the [Yahoo! Developer Network](https://developer.yahoo.com/weather/).
|
||||
|
||||
|
|
34
source/_components/spc.markdown
Normal file
34
source/_components/spc.markdown
Normal file
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
layout: page
|
||||
title: "SPC"
|
||||
description: "Instructions how to setup Vanderbilt SPC devices within Home Assistant."
|
||||
date: 2017-05-18 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
ha_category: Hub
|
||||
ha_release: 0.47
|
||||
logo: vanderbilt_spc.png
|
||||
---
|
||||
|
||||
Home Assistant has support to integrate your [Vanderbilt SPC](http://www.spc-intruder-detection.com/ssp-spc/) alarm panel and any connected motion, door and smoke sensors.
|
||||
|
||||
Integration with SPC is done through a third-party API gateway called [SPC Web Gateway](http://www.lundix.se/smarta-losningar/) which must be installed and configured somewhere on your network.
|
||||
|
||||
Home Assistant needs to know where to find the SPC Web Gateway API endpoints, to configure this add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
spc:
|
||||
api_url: API_URL
|
||||
ws_url: WS_URL
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **api_url** (*Required*): URL of the SPC Web Gateway command REST API, e.g. `http://<ip>:8088`.
|
||||
- **ws_url** (*Required*): URL of the SPC Web Gateway websocket, e.g. `ws://<ip>:8088`.
|
||||
|
||||
Supported sensors will be automatically discovered and added, however they will be hidden by default.
|
||||
|
|
@ -12,7 +12,7 @@ ha_category: "History"
|
|||
ha_release: 0.13
|
||||
---
|
||||
|
||||
The `splunk` component makes it possible to log all state changes to an external [Splunk](http://splunk.com/) database using Splunk's HTTP Event Collector feature. You can either use this alone, or with the Home Assistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). Since the HEC feature is new to Splunk, you will need to use at least version 6.3.
|
||||
The `splunk` component makes it possible to log all state changes to an external [Splunk](http://splunk.com/) database using Splunk's HTTP Event Collector (HEC) feature. You can either use this alone, or with the Home Assistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). Since the HEC feature is new to Splunk, you will need to use at least version 6.3.
|
||||
|
||||
To use the `splunk` component in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
@ -28,3 +28,4 @@ Configuration variables:
|
|||
- **host** (*Optional*): IP address or host name of your Splunk host, eg. 192.168.1.10. Will default to `localhost` if not supplied.
|
||||
- **port** (*Optional*): Port to use. Defaults to 8088.
|
||||
- **ssl** (*Optional*): Use https instead of http to connect. Defaults to False.
|
||||
- **name** (*Optional*): This parameter allows you to specify a friendly to send to Splunk as the host, instead of using the name of the HEC. Defaults to HASS
|
||||
|
|
|
@ -29,6 +29,7 @@ Configuration variables:
|
|||
|
||||
- **resource** (*Required*): The resource or endpoint that contains the value.
|
||||
- **name** (*Optional*): Name of the REST switch.
|
||||
- **method** (*Optional*): HTTP method to use (`post` or `put`). Defaults to `post`.
|
||||
- **body_on** (*Optional*): The body of the POST request that commands the switch to become enabled. Default is "ON". This value can be a [template](/topics/templating/).
|
||||
- **body_off** (*Optional*): The body of the POST request that commands the switch to become disabled. Default is "OFF". This value can also be a [template](/topics/templating/).
|
||||
- **is_on_template** (*Optional*): A [template](/docs/configuration/templating/#processing-incoming-data) that determines the state of the switch from the value returned by the GET request on the resource URL. This template should compute to a boolean (True or False). If the value is valid JSON, it will be available in the template as the variable `value_json`. Default is equivalent to `'{% raw %}{{ value_json == body_on }}{% endraw %}'`. This means that by default, the state of the switch is on if and only if the response to the GET request matches .
|
||||
|
|
|
@ -115,13 +115,17 @@ switch:
|
|||
This example shows how to change the icon based on the day/night cycle.
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
switch:
|
||||
- platform: template
|
||||
sensors:
|
||||
day_night:
|
||||
friendly_name: 'Day/Night'
|
||||
value_template: {% raw %}'{% if is_state("sun.sun", "above_horizon") %}Day{% else %}Night{% endif %}'{% endraw %}
|
||||
icon_template: {% raw %}'{% if is_state("sun.sun", "above_horizon") %}mdi:weather-sunny{% else %}mdi:weather-night{% endif %}'{% endraw %}
|
||||
|
||||
switches:
|
||||
garage:
|
||||
value_template: {% raw %}"{{ is_state(cover.garage_door', 'on') }}"{% endraw %}
|
||||
turn_on:
|
||||
service: cover.open_cover
|
||||
entity_id: cover.garage_door
|
||||
turn_off:
|
||||
service: cover.close_cover
|
||||
entity_id: cover.garage_door
|
||||
icon_template: {% raw %}"{% if is_state('cover.garage_door', 'open') %}mdi:garage-open{% else %}mdi:garage{% endif %}"{% endraw %}
|
||||
```
|
||||
|
||||
|
|
|
@ -23,6 +23,23 @@ updater:
|
|||
|
||||
If you choose not to share any information when checking for updates, you can add `reporting: False`.
|
||||
|
||||
It is possible to report the components that you are using to the Home Assistant developers. This will help them focus on improving the popular ones. To enable this option, you have to add `include_used_components: True`.
|
||||
|
||||
```json
|
||||
"components": [
|
||||
"apcupsd",
|
||||
"api",
|
||||
"automation",
|
||||
"binary_sensor",
|
||||
"binary_sensor.zwave",
|
||||
"camera",
|
||||
"camera.uvc",
|
||||
"config",
|
||||
"config.core",
|
||||
...
|
||||
]
|
||||
```
|
||||
|
||||
### {% linkable_title Notification %}
|
||||
|
||||
For an added bonus, an automation component can be created to send a message with a notifier when that state of this component's entity changes.
|
||||
|
|
|
@ -25,6 +25,23 @@ volvooncall:
|
|||
password: password
|
||||
```
|
||||
|
||||
Users registered with Volvo in North America or China will need to specify a service url:
|
||||
|
||||
```yaml
|
||||
# North America
|
||||
volvooncall:
|
||||
username: username
|
||||
password: password
|
||||
service_url: 'https://vocapi-na.wirelesscar.net/customerapi/rest/v3.0/'
|
||||
```
|
||||
```yaml
|
||||
# China
|
||||
volvooncall:
|
||||
username: username
|
||||
password: password
|
||||
service_url: 'https://vocapi-cn.wirelesscar.net/customerapi/rest/v3.0/'
|
||||
```
|
||||
|
||||
A more advanced example for setting the vehicle name and selecting what resources to display:
|
||||
|
||||
```yaml
|
||||
|
@ -44,6 +61,7 @@ Configuration variables:
|
|||
|
||||
- **username** (*Required*): The username associated with your Volvo On Call account.
|
||||
- **password** (*Required*): The password for your given Volvo On Call account.
|
||||
- **service_url** (*Optional*): The service URL to use for Volvo On Call (defaults to https://vocapi.wirelesscar.net/customerapi/rest/v3.0/).
|
||||
- **name** (*Optional*): Make it possible to provide a name for the vehicles.
|
||||
- **resources** (*Optional*): A list of resources to display (defaults to all available).
|
||||
|
||||
|
|
48
source/_components/weather.buienradar.markdown
Normal file
48
source/_components/weather.buienradar.markdown
Normal file
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Buienradar Weather"
|
||||
description: "Instructions how to integrate buienradar.nl weather within Home Assistant."
|
||||
date: 2017-05-15 14:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo:
|
||||
ha_category: Weather
|
||||
ha_release: 0.44
|
||||
---
|
||||
|
||||
The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The
|
||||
weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands.
|
||||
The relevant weatherstation used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component).
|
||||
|
||||
To add the buienradar weather to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
weather:
|
||||
- platform: buienradar
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
- **platform** (*Required*): buienradar
|
||||
- **latitude** (*Optional*): latitude to use for selection of data source location. Longitude & latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.
|
||||
- **longitude** (*Optional*): longitude to use for selection of data source location. Longitude & latitude will be taken from Home Assistant configuration, but can be overridden/changed in this component to select a different location for buienradar.
|
||||
- **forecast** (*Optional*): 'True' to add a temperature forecast, 'False' to suppress it
|
||||
|
||||
|
||||
A full configuration example:
|
||||
|
||||
```yaml
|
||||
weather:
|
||||
- platform: buienradar
|
||||
name: buienradar
|
||||
latitude: 51.65
|
||||
longitude: 5.70
|
||||
forecast: True
|
||||
```
|
||||
|
||||
<p class='note'>
|
||||
This platform is an alternative to the [`buienradar`](/components/sensor.buienradar/) sensor.
|
||||
The weather platform is easier to configure but less customisable.
|
||||
</p>
|
44
source/_components/weather.yweather.markdown
Normal file
44
source/_components/weather.yweather.markdown
Normal file
|
@ -0,0 +1,44 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Yahoo Weather"
|
||||
description: "Instructions how to integrate Yahoo Weather within Home Assistant."
|
||||
date: 2016-07-06 9:06
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: yahooweather.png
|
||||
ha_category: Weather
|
||||
ha_release: 0.47
|
||||
---
|
||||
|
||||
|
||||
The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/) as an source for current meteorological data. The `forecast` will show you the condition for 5 days, 0 is the current day.
|
||||
|
||||
<p class='note warning'>
|
||||
Use of the Yahoo Weather API should not exceed reasonable request volume. Access is limited to 2000 signed calls per day.
|
||||
</p>
|
||||
|
||||
The `woeid` (Where On Earth ID) for your location, as shown in the example below. You can find your WOEID by copying the numeric digits at the end of the URL for your location at [Yahoo Weather](https://www.yahoo.com/news/weather/). If you don't add a WOEID it generate it from Home Assistant's latitude and longitude.
|
||||
|
||||
To add Yahoo Weather to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
weather:
|
||||
- platform: yweather
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **woeid** (*Optional*): See above.
|
||||
- **forecast** (*Optional*): Day of forecast. The default is the current day to display conditions.
|
||||
- **name** (*Optional*): The name of the sensor. To easily recognize each sensor when adding more than one Yahoo weather sensor, it is recommended to use the name option. Defaults to `Yweather`.
|
||||
|
||||
|
||||
<p class='note'>
|
||||
This platform is an alternative to the [`yweather`](/components/sensor.yweather/) sensor.
|
||||
</p>
|
||||
|
||||
Details about the API are available in the [Yahoo! Developer Network](https://developer.yahoo.com/weather/).
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue