Merge branch 'current' into next
This commit is contained in:
Robbie Trencheny
commit
080cf64170
41 changed files with 363 additions and 117 deletions
|
|
@ -46,6 +46,29 @@ Configuration variables:
|
|||
|
||||
In this example, the garage door status (`input_boolean.garage_door`) is watched and this alert will be triggered when its status is equal to `on`. This indicates that the door has been opened. Because the `skip_first` option was set to `True`, the first notification will not be delivered immediately. However, every 30 minutes, a notification will be delivered until either `input_boolean.garage_door` no longer has a state of `on` or until the alert is acknowledged using the Home Assistant frontend.
|
||||
|
||||
For notifiers that require other parameters (such as `twilio_sms` which requires you specify a `target` parameter when sending the notification), you can use the `group` notification to wrap them for an alert. Simply create a `group` notification type with a single notification member (such as `twilio_sms`) specifying the required parameters other than `message` provided by the `alert` component:
|
||||
|
||||
```yaml
|
||||
- platform: group
|
||||
name: john_phone_sms
|
||||
services:
|
||||
- service: twilio_sms
|
||||
data:
|
||||
target: !secret john_phone
|
||||
```
|
||||
|
||||
```yaml
|
||||
freshwater_temp_alert:
|
||||
name: "Warning: I have detected a problem with the freshwater tank temperature"
|
||||
entity_id: binary_sensor.freshwater_temperature_status
|
||||
state: 'on'
|
||||
repeat: 5
|
||||
can_acknowledge: true
|
||||
skip_first: false
|
||||
notifiers:
|
||||
- john_phone_sms
|
||||
```
|
||||
|
||||
### {% linkable_title Complex Alert Criteria %}
|
||||
|
||||
By design, the `alert` component only handles very simple criteria for firing. That is, is only checks if a single entity's state is equal to a value. At some point, it may be desireable to have an alert with a more complex criteria. Possibly, when a battery percentage falls below a threshold. Maybe you want to disable the alert on certain days. Maybe the alert firing should depend on more than one input. For all of these situations, it is best to use the alert in conjunction with a `Template Binary Sensor`. The following example does that.
|
||||
|
|
|
|||
|
|
@ -357,7 +357,7 @@ Please refer to the [Amazon documentation][flash-briefing-api-docs] for more inf
|
|||
- Hit "Next"
|
||||
- Test
|
||||
- Having passed all validations to reach this screen you can now click on "< Back to All Skills" as your flash briefing is now available as in "Development" service.
|
||||
- To invoke your flash briefing, open the Alexa app on your phone or go to the [Alexa Setings Site][alexa-settings-site], open the "Skills" configuration section, select "Your Skills", scroll to the bottom, tap on the Flash Briefing Skill you just created, enable it, then manage Flash Briefing and adjust ordering as necessary. Finally ask your Echo for your "news","flash briefing", or "briefing".
|
||||
- To invoke your flash briefing, open the Alexa app on your phone or go to the [Alexa Settings Site][alexa-settings-site], open the "Skills" configuration section, select "Your Skills", scroll to the bottom, tap on the Flash Briefing Skill you just created, enable it, then manage Flash Briefing and adjust ordering as necessary. Finally ask your Echo for your "news","flash briefing", or "briefing".
|
||||
|
||||
[amazon-dev-console]: https://developer.amazon.com
|
||||
[flash-briefing-api]: https://developer.amazon.com/alexa-skills-kit/flash-briefing
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ The `flic` platform allows you to connect with multiple [flic](https://flic.io)
|
|||
|
||||
The platform does not directly interact with the buttons, but communicates with the flic service that manages the buttons. The service can run on the same instance as home assistant or any other reachable machine. For setup instructions visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [OS X](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows).
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
To use your flic buttons in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
|
@ -27,15 +27,15 @@ binary_sensor:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Optional*): The IP or hostname of the flic service server. (default: `localhost`)
|
||||
- **port** (*Optional*): The port of the flic service. (default: `5551`)
|
||||
- **discovery** (*Optional*): If `true`, the component is configured to constantly scan for new buttons. (default: `true`)
|
||||
- **host** (*Optional*): The IP or hostname of the flic service server. Defaults to `localhost`.
|
||||
- **port** (*Optional*): The port of the flic service. Defaults to `5551`.
|
||||
- **discovery** (*Optional*): If `true` then the component is configured to constantly scan for new buttons. Defaults to `true`.
|
||||
- **ignored_click_types**: List of click types whose occurrence should not trigger and `flic_click` event.
|
||||
- **timeout** (*Optional*): Maximum time in seconds an event can be queued locally on a button before discarding the event. (default: `3`)
|
||||
- **timeout** (*Optional*): Maximum time in seconds an event can be queued locally on a button before discarding the event. Defaults to 3.
|
||||
|
||||
#### {% linkable_title Discovery %}
|
||||
|
||||
If discovery is enabled, you can add a new button by pressing it for at least 7s. The button will be paired with the flic service and added to Home Assistant. Otherwise, you have to manually pair it with the flic service. The Home Assistant platform will not scan for new buttons and will only connect to buttons already paired.
|
||||
If discovery is enabled, you can add a new button by pressing it for at least 7 seconds. The button will be paired with the flic service and added to Home Assistant. Otherwise, you have to manually pair it with the flic service. The Home Assistant platform will not scan for new buttons and will only connect to buttons already paired.
|
||||
|
||||
#### {% linkable_title Timeout %}
|
||||
+When the flic button is triggered while disconnected from flic service, it will queue all events and try to connect and transmit them as soon as possible. The timeout variable can be used to stop events from triggering if too much time passed between the action and the notification in Home Assistant.
|
||||
|
|
|
|||
|
|
@ -22,18 +22,21 @@ To enable the `workday` sensor in your installation, add the following to your `
|
|||
binary_sensor:
|
||||
- platform: workday
|
||||
country: DE
|
||||
province: BW
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **country** (*Required*): Country code according to [holidays](https://pypi.python.org/pypi/holidays/0.8.1) notation.
|
||||
- **province** (*Optional*): Province code according to [holidays](https://pypi.python.org/pypi/holidays/0.8.1) notation (defaults to None).
|
||||
- **workdays** (*Optional*): List of workdays (defaults to mon, tue, wed, thu, fri).
|
||||
- **excludes** (*Optional*): List of workday excludes (defaults to sat, sun, holiday).
|
||||
- **province** (*Optional*): Province code according to [holidays](https://pypi.python.org/pypi/holidays/0.8.1) notation. Defaults to None.
|
||||
- **workdays** (*Optional*): List of workdays. Defaults to `mon`, `tue`, `wed`, `thu`, `fri`.
|
||||
- **excludes** (*Optional*): List of workday excludes. Defaults to `sat`, `sun`, `holiday`.
|
||||
|
||||
Days are specified as follows: `mon`, `tue`, `wed`, `thu`, `fri`, `sat`, `sun`. The keyword `holiday` is used for public holidays identified by the holidays module.
|
||||
|
||||
<p class='note warning'>
|
||||
If you use the sensor for Canada (`CA`) with Ontario (`ON`) as `province:` then you need to wrap `ON` in quotes. Otherwise the value is evaluated as `True` (check the YAML documentation for further details) and the sensor will not work.
|
||||
</p>
|
||||
|
||||
Example usage for automation:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -49,5 +49,5 @@ camera:
|
|||
```
|
||||
|
||||
<p class='note'>
|
||||
Most users will need to set `valid_ssl` to false unless they have installed a valid SSL certificate in place of the built in self-signed certificate.
|
||||
Most users will need to set `verify_ssl` to false unless they have installed a valid SSL certificate in place of the built in self-signed certificate.
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -22,6 +22,7 @@ By default, every group appears in the HOME tab. If you create a group `default_
|
|||
group:
|
||||
default_view:
|
||||
view: yes
|
||||
icon: mdi:home
|
||||
entities:
|
||||
- group.kitchen
|
||||
- group.awesome_people
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ ha_release: 0.12
|
|||
|
||||
The `lifx` platform allows you to integrate your [LIFX](http://www.lifx.com) into Home Assistant.
|
||||
|
||||
_Please note, LIFX is currently not supported on Windows._
|
||||
_Please note, the `lifx` platform does not support Windows. The `lifx_legacy` platform (supporting basic functionality) can be used instead._
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ Turns one light on or multiple lights on using [groups]({{site_root}}/components
|
|||
| `xy_color` | yes | A list containing two floats representing the xy color you want the light to be. Two comma separated floats that represent the color in XY.
|
||||
| `rgb_color` | yes | A list containing three integers representing the rgb color you want the light to be. Three comma separated integers that represent the color in RGB. You can find a great chart here: [Hue Color Chart](http://www.developers.meethue.com/documentation/hue-xy-values)
|
||||
| `color_temp` | yes | An INT in mireds representing the color temperature you want the light to be.
|
||||
| `color_name` | yes | A human readable string of a color name, such as `blue` or `goldenrod` or [`chucknorris`](http://stackoverflow.com/questions/8318911/why-does-html-think-chucknorris-is-a-color). If your browser can display it, so can Home Assistant.
|
||||
| `color_name` | yes | A human readable string of a color name, such as `blue` or `goldenrod`. All [CSS3 color names](https://www.w3.org/TR/2010/PR-css3-color-20101028/#svg-color) are supported.
|
||||
| `brightness` | yes | Integer between 0 and 255 for how bright the color should be.
|
||||
| `flash` | yes | Tell light to flash, can be either value `short` or `long`. *not supported by Wink
|
||||
| `effect`| yes | Applies an effect such as `colorloop` or `random`.
|
||||
|
|
|
|||
|
|
@ -36,7 +36,6 @@ mysensors:
|
|||
persistence_file: 'path/mysensors4.json'
|
||||
topic_in_prefix: 'mygateway1-out'
|
||||
topic_out_prefix: 'mygateway1-in'
|
||||
debug: true
|
||||
optimistic: false
|
||||
persistence: true
|
||||
retain: true
|
||||
|
|
@ -50,7 +49,7 @@ Configuration variables:
|
|||
- **tcp_port** (*Optional*): Specifies the port of the connected tcp ethernet gateway. Default is 5003.
|
||||
- **topic_in_prefix** (*Optional*): Set the prefix of the MQTT topic for messages coming from the MySensors gateway in to Home Assistant. Default is an empty string.
|
||||
- **topic_out_prefix** (*Optional*): Set the prefix of the MQTT topic for messages going from Home Assistant out to the MySensors gateway. Default is an empty string.
|
||||
- **debug** (*Optional*): Enable or disable verbose debug logging. Default is false.
|
||||
- **debug** (*DEPRECATED*): This option has been deprecated. Please remove this from your config is you have it included. Use the logger component to filter log messages on log level.
|
||||
- **persistence** (*Optional*): Enable or disable local persistence of sensor information. If this is disabled, then each sensor will need to send presentation messages after Home Assistant starts. Default is true.
|
||||
- **persistence_file** (*Optional*): The path to a file to save sensor information. The file extension determines the file type. Currently supported file types are 'pickle' and 'json'.
|
||||
- **version** (*Optional*): Specifies the MySensors protocol version to use. Supports 1.4, 1.5 and 2.0. Default is 1.4.
|
||||
|
|
|
|||
|
|
@ -8,46 +8,33 @@ comments: false
|
|||
sharing: true
|
||||
footer: true
|
||||
ha_category: Sensor
|
||||
featured: false
|
||||
logo: crimereports.png
|
||||
ha_release: 0.42
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `crimereports` sensor allows one to track reported incidents occurring in a Home Assistant zone. Incidents include anything reported to [Crime Reports](http://crimereports.com). Your regional emergency services may or may not report data. The sensor only counts incidents from the current day.
|
||||
The `crimereports` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Crime Reports](http://crimereports.com). Your regional emergency services may or may not report data. The sensor only counts incidents from the current day.
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml`. Your `zone` should be of sufficient size to capture incidents in your area. Your `home` zone is probably too small.
|
||||
To enable this sensor, add the following lines to your `configuration.yaml`. Your `radius` should be of sufficient size to capture incidents in your area.
|
||||
|
||||
```yaml
|
||||
zone:
|
||||
- name: neighborhood
|
||||
latitude: <your latitude>
|
||||
longitude: <your longitude>
|
||||
radius: <your neighborhood radius>
|
||||
|
||||
sensor:
|
||||
- platform: crimereports
|
||||
zone: neighborhood
|
||||
name: <any name>
|
||||
radius: <your radius>
|
||||
```
|
||||
|
||||
Configuration options for the Crime Reports Sensor:
|
||||
|
||||
- **zone** (*Required*): The zone to monitor.
|
||||
- **name** (*Required*): Name the sensor whatever you want.
|
||||
- **radius** (*Required*): Radius in meters.
|
||||
- **latitude** (*Optional*): Defaults to your home zone latitude.
|
||||
- **longitude** (*Optional*): Defaults to your home zone longitude.
|
||||
- **include** (*Optional*): List of incident types to include.
|
||||
- **exclude** (*Optional*): List of incident types to exclude.
|
||||
- **update_inverval** (*Optional*): Minimum time interval between updates. Default is 30 minutes. Supported formats:
|
||||
- `update_interval: 'HH:MM:SS'`
|
||||
- `update_interval: 'HH:MM'`
|
||||
- Time period dictionary, e.g.:
|
||||
<pre>update_interval:
|
||||
# At least one of these must be specified:
|
||||
days: 0
|
||||
hours: 0
|
||||
minutes: 3
|
||||
seconds: 30
|
||||
milliseconds: 0
|
||||
</pre>
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
|
|
|
|||
51
source/_components/sensor.metoffice.markdown
Normal file
51
source/_components/sensor.metoffice.markdown
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Met Office Sensor"
|
||||
description: "Instructions on how to integrate Met Office weather conditions into Home Assistant."
|
||||
date: 2017-03-23 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: metoffice.jpg
|
||||
ha_category: Weather
|
||||
ha_release: 0.42
|
||||
---
|
||||
|
||||
The `metoffice` sensor platform uses the Met Office's [DataPoint API][datapoint] for weather data.
|
||||
|
||||
- Each sensor will be given the `device_id` of "Met Office [condition]"
|
||||
- The sensor checks for new data every minute, starting 30 minutes after the timestamp of the most recent data as the data is updated every half-hour.
|
||||
|
||||
To add the Met Office weather to your installation you'll need to register for a free api key at the link above and then add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: metoffice
|
||||
api_key: "my-api-key"
|
||||
monitored_conditions:
|
||||
- weather
|
||||
- temperature
|
||||
- feels_like_temperature
|
||||
- wind_speed
|
||||
- wind_direction
|
||||
- wind_gust
|
||||
- visibility
|
||||
- uv
|
||||
- precipitation
|
||||
- humidity
|
||||
```
|
||||
|
||||
Your location will be detected from your home `latitude` and `longitude` settings.
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **api_key** (*Required*): Your personal API key from the [Datapoint website][datapoint].
|
||||
|
||||
<p class='note'>
|
||||
This sensor is an alternative to the [`metoffice`](/components/weather.metoffice/) weather platform.
|
||||
The weather platform is easier to configure but less customisable.
|
||||
</p>
|
||||
|
||||
[datapoint]: http://www.metoffice.gov.uk/datapoint
|
||||
|
|
@ -52,7 +52,7 @@ Configuration variables:
|
|||
- **sum_rain_1**: Rainfall in the last hour in mm.
|
||||
- **sum_rain_24**: Rainfall in mm from 00:00am - 23:59pm.
|
||||
- **WindAngle**: Wind angle
|
||||
- **WingStrength**: Wind strength
|
||||
- **WindStrength**: Wind strength
|
||||
- **GustAngle**: Wind gust angle
|
||||
- **GustStrength**: Wind gust strength
|
||||
- **min_temp**: Min temperature for today
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ ha_release: 0.31
|
|||
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.
|
||||
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:
|
||||
|
|
|
|||
34
source/_components/weather.metoffice.markdown
Normal file
34
source/_components/weather.metoffice.markdown
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Met Office"
|
||||
description: "Instructions on how to integrate Met Office weather conditions into Home Assistant."
|
||||
date: 2017-03-23 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: metoffice.jpg
|
||||
ha_category: Weather
|
||||
ha_release: 0.42
|
||||
---
|
||||
|
||||
The `metoffice` weather platform uses the Met Office's [DataPoint API][datapoint] for weather data.
|
||||
|
||||
To add the Met Office weather platform to your installation you'll need to register for a free api key at the link above and then add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
weather:
|
||||
- platform: metoffice
|
||||
api_key: "my-api-key"
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **api_key** (*Required*): Your personal API key from the [Datapoint website][datapoint].
|
||||
|
||||
<p class='note'>
|
||||
This platform is an alternative to the [`metoffice`](/components/sensor.metoffice/) sensor.
|
||||
The weather platform is easier to configure but less customisable.
|
||||
</p>
|
||||
|
||||
[datapoint]: http://www.metoffice.gov.uk/datapoint
|
||||
Loading…
Add table
Add a link
Reference in a new issue