Merge branch 'current' into next
This commit is contained in:
Robbie Trencheny
commit
bb8eb97edd
63 changed files with 612 additions and 206 deletions
|
|
@ -22,12 +22,11 @@ Amazon has released [Echosim], a website that simulates the Alexa service in you
|
|||
|
||||
## {% linkable_title I just want to turn devices on and off using Echo %}
|
||||
|
||||
If you just want to be able to turn anything with a switch (like lights, switches, media players, etc) on and off, check out Michael Auchter's [Haaska][haaska-github-link] which integrates the [Alexa Lighting API][alexa-lighting-api] into Home Assistant.
|
||||
If you just want to be able to turn anything with a switch (like lights, switches, media players, etc) on and off, you should enable the [Emulated Hue][emulated-hue-component] component. It makes your Home Assistant appear as if it were a Phillips Hue bridge, which Echo works with natively.
|
||||
|
||||
[haaska-github-link]: https://github.com/auchter/haaska
|
||||
[alexa-lighting-api]: https://developer.amazon.com/public/binaries/content/assets/html/alexa-lighting-api.html
|
||||
[emulated-hue-component]: https://home-assistant.io/components/emulated_hue/
|
||||
|
||||
Implementing Haaska means you can turn things on and off by simply saying
|
||||
Enabling the Emulated Hue component means you can turn things on and off by simply saying
|
||||
|
||||
> Alexa, turn the living room lights on.
|
||||
|
||||
|
|
@ -43,9 +42,9 @@ or
|
|||
|
||||
> Alexa, tell Home Assistant to set the living room lights to twenty percent.
|
||||
|
||||
In addition, you would need to build custom intents for each device and on/off combination using the below method, whereas everything just works without any extra work by using Haaska.
|
||||
In addition, you would need to build custom intents for each device and on/off combination using the below method, whereas everything just works without any extra work by using Emulated Hue.
|
||||
|
||||
Please note that you can use Haaska and the built-in Alexa component side-by-side without issue if you wish.
|
||||
Please note that you can use Emulated Hue and the built-in Alexa component side-by-side without issue if you wish.
|
||||
|
||||
## {% linkable_title I want to build custom commands to use with Echo %}
|
||||
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ footer: true
|
|||
logo: bloomsky.png
|
||||
ha_category: Binary Sensor
|
||||
ha_release: 0.14
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `bloomsky` binary sensor platform allows you to get data from your BloomSky device.
|
||||
|
|
@ -22,5 +23,13 @@ To use your BloomSky binary sensor in your installation, add the following to yo
|
|||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: bloomsky
|
||||
monitored_conditions:
|
||||
- Night
|
||||
- Rain
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **monitored_conditions** array (*Required*): The sensors that you wish to monitor on all of your devices. Select from these options:
|
||||
- Night
|
||||
- Rain
|
||||
|
|
|
|||
|
|
@ -10,10 +10,11 @@ footer: true
|
|||
logo: command_line.png
|
||||
ha_category: Binary Sensor
|
||||
ha_release: 0.12
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `command` binary sensor platform issues specific commands to get data.
|
||||
The `command_line` binary sensor platform issues specific commands to get data.
|
||||
|
||||
To use your Command binary sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -14,10 +14,10 @@ ha_iot_class: "Local Polling"
|
|||
---
|
||||
|
||||
|
||||
The `ffmpeg` platform allows you to use every video or audio feed with [FFmpeg](http://www.ffmpeg.org/) for various sensors in Home Assistant. Available are: **noise**, **motion**. If the `ffmpeg` process is brocken, the sensor going to unavailable. It exists a service to restart a instance with *binary_sensor.ffmpeg_restart*.
|
||||
The `ffmpeg` platform allows you to use every video or audio feed with [FFmpeg](http://www.ffmpeg.org/) for various sensors in Home Assistant. Available are: **noise**, **motion**. If the `ffmpeg` process is broken, the sensor will be unavailable. To restart the instance, use the service *binary_sensor.ffmpeg_restart*.
|
||||
|
||||
<p class='note'>
|
||||
You need a `ffmpeg` binary in your system path. On Debain 8 you can install it from backports. If you want Hardware support on a Raspberry Pi you need to build it from sourceby ourself. Windows binary are avilable on [FFmpeg](http://www.ffmpeg.org/) homepage.
|
||||
You need the `ffmpeg` binary in your system path. On Debain 8 you can install it from backports. If you want Hardware support on a Raspberry Pi you need to build it from source. Windows binary are avilable on [FFmpeg](http://www.ffmpeg.org/) homepage.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Noise %}
|
||||
|
|
@ -47,7 +47,7 @@ Configuration variables:
|
|||
- **duration** (*Optional*): Default 1 seconds. How long need the noise over the peak to trigger the state.
|
||||
- **reset** (*Optional*): Defaults to 20 seconds. The time to reset the state after none new noise is over the peak.
|
||||
- **extra_arguments** (*Optional*): Extra option they will pass to `ffmpeg`, like audio frequence filtering.
|
||||
- **output** (*Optional*): Allow you to send the audio output of this sensor to a icecast server or other ffmpeg supported output, eg. to stream with sonos after state is trigger.
|
||||
- **output** (*Optional*): Allow you to send the audio output of this sensor to an icecast server or other ffmpeg supported output, eg. to stream with sonos after state is triggered.
|
||||
|
||||
For playing with values:
|
||||
|
||||
|
|
@ -57,7 +57,7 @@ $ ffmpeg -i YOUR_INPUT -vn -filter:a silencedetect=n=-30dB:d=1 -f null -
|
|||
|
||||
### {% linkable_title Motion %}
|
||||
|
||||
FFmpeg don't have a motion detection filter so it use a scene filter to detect a new scene/motion. In fact you can set how big a object or size of image they need change to detect a motion. The option 'changes' is the percent value of change between frames. You can add a denoise filter to video if you want a realy small value for 'changes'.
|
||||
FFmpeg doesn't have a motion detection filter, so it uses a scene filter to detect a new scene/motion. In fact, you can set how big of an object or the size of an image that needs to change in order to detect motion. The option 'changes' is the percent value of change between frames. You can add a denoise filter to the video if you want a really small value for 'changes'.
|
||||
|
||||
To enable your FFmpeg with motion detection in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -79,14 +79,14 @@ camera:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **input** (*Required*): A ffmpeg compatible input file, stream or feed.
|
||||
- **input** (*Required*): A ffmpeg compatible input file, stream, or feed.
|
||||
- **tool** (*Required*): Is fix set to `motion`.
|
||||
- **name** (*Optional*): This parameter allows you to override the name of your camera.
|
||||
- **ffmpeg_bin** (*Optional*): Default `ffmpeg`.
|
||||
- **changes** (*Optional*): Default 10 percent. A lower value is more sensitive. I use 4 / 3.5 on my cameras. It describe how much of two frames need to change to detect it as motion. See on descripton.
|
||||
- **reset** (*Optional*): Default 20 seconds. The time to reset the state after none new motion is detect.
|
||||
- **repeat** (*Optional*): Default 0 repeats (deactivate). How many motion need to detect in *repeat_time* to trigger a motion.
|
||||
- **repeat_time** (*Optional*): Default 0 seconds (deactivate). The time to repeats before it trigger a motion.
|
||||
- **changes** (*Optional*): Default 10 percent. A lower value is more sensitive. I use 4 / 3.5 on my cameras. It describes how much needs to change between two frames to detect it as motion. See on descripton.
|
||||
- **reset** (*Optional*): Default 20 seconds. The time to reset the state after no new motion is detected.
|
||||
- **repeat** (*Optional*): Default 0 repeats (deactivate). How many events need to be detected in *repeat_time* in order to trigger a motion.
|
||||
- **repeat_time** (*Optional*): Default 0 seconds (deactivate). The span of time *repeat* events need to occur in before triggering a motion.
|
||||
- **extra_arguments** (*Optional*): Extra option they will pass to ffmpeg. i.e. video denoise filtering.
|
||||
|
||||
For playing with values (changes/100 is the scene value on ffmpeg):
|
||||
|
|
@ -94,3 +94,5 @@ For playing with values (changes/100 is the scene value on ffmpeg):
|
|||
```bash
|
||||
$ ffmpeg -i YOUR_INPUT -an -filter:v select=gt(scene\,0.1) -f framemd5 -
|
||||
```
|
||||
|
||||
If you are running into trouble with this sensor, please refer to this [Troubleshooting section](/components/camera.ffmpeg/#troubleshooting).
|
||||
|
|
|
|||
|
|
@ -14,11 +14,16 @@ ha_category: Binary Sensor
|
|||
|
||||
The `nest` binary sensor platform let you monitor various states of a thermostat from [Nest](https://nest.com).
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use this sensors.
|
||||
</p>
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
binary_sensor:
|
||||
platform: nest
|
||||
scan_interval: 60
|
||||
monitored_conditions:
|
||||
- 'fan'
|
||||
- 'hvac_ac_state'
|
||||
|
|
@ -34,6 +39,7 @@ binary_sensor:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **scan_interval** (*Optional*): Interval in seconds to scan.
|
||||
- **monitored_conditions** array (*Required*): States to monitor.
|
||||
- 'fan'
|
||||
- 'hvac_ac_state'
|
||||
|
|
@ -45,4 +51,3 @@ Configuration variables:
|
|||
- 'hvac_emer_heat_state'
|
||||
- 'online'
|
||||
|
||||
<p class='note'>You must have the [Nest component](/components/nest/) configured to use this sensor.</p>
|
||||
|
|
|
|||
|
|
@ -66,3 +66,29 @@ binary_sensor:
|
|||
value_template: {% raw %}"{{ states.switch.door.state == 'on' }}"{% endraw %}
|
||||
sensor_class: opening
|
||||
```
|
||||
|
||||
|
||||
### {% linkable_title Combining multiple sensors, and using entity_id: %}
|
||||
|
||||
This example combines multiple CO sensors into a single overall status. It also shows how to use `entity_id`
|
||||
|
||||
```yaml
|
||||
binary_sensor:
|
||||
- platform: template
|
||||
sensors:
|
||||
co:
|
||||
friendly_name: 'CO'
|
||||
sensor_class: 'gas'
|
||||
value_template: {% raw %}>-
|
||||
{%- if is_state("sensor.bedroom_co_status", "Ok")
|
||||
and is_state("sensor.kitchen_co_status", "Ok")
|
||||
and is_state("sensor.wardrobe_co_status", "Ok") -%}
|
||||
Off
|
||||
{%- else -%}
|
||||
On
|
||||
{%- endif %}{% endraw %}
|
||||
entity_id:
|
||||
- sensor.bedroom_co_status
|
||||
- sensor.kitchen_co_status
|
||||
- sensor.wardrobe_co_status
|
||||
```
|
||||
|
|
|
|||
|
|
@ -9,10 +9,14 @@ sharing: true
|
|||
footer: true
|
||||
logo: bloomsky.png
|
||||
ha_category: Hub
|
||||
ha_release: 0.14
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `bloomsky` component allows you to access your [BloomSky](http://www.insteon.com/) weather station's [sensors](/components/sensor.bloomsky) and [camera](/components/camera.bloomsky) from Home Assistant.
|
||||
The `bloomsky` component allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's [sensors](/components/sensor.bloomsky), [binary sensors](/components/binary_sensor.bloomsky), and [camera](/components/camera.bloomsky) from Home Assistant.
|
||||
|
||||
Obtain your PI key from your [BloomSky dashboard](https://dashboard.bloomsky.com). Click `developers` in the bottom left of the screen.
|
||||
|
||||
To integrate your BloomSky hub with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -24,4 +28,4 @@ bloomsky:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **api_key** *Required*: Your BloomSky API key, obtained from your [BloomSky dashboard](https://dashboard.bloomsky.com) (click `developers` in the bottom left of the screen)
|
||||
- **api_key** (*Required*): Your BloomSky API key.
|
||||
|
|
|
|||
|
|
@ -13,10 +13,10 @@ ha_release: 0.26
|
|||
---
|
||||
|
||||
|
||||
The `ffmpeg` platform allows you to use every video feed with [FFmpeg](http://www.ffmpeg.org/) as camera in Home Assistant.
|
||||
The `ffmpeg` platform allows you to use every video feed with [FFmpeg](http://www.ffmpeg.org/) as camera in Home Assistant. The input for ffmpeg need to support that could have multiple connection to source (input) in same time. For every user in UI and all 10 seconds (snapshot image) it make a new connection/reading to source. Normally that should never be a trouble only in strange selfmade constructs can be make mistakes.
|
||||
|
||||
<p class='note'>
|
||||
You need a ffmpeg binary in your system path. On debain 8 you can install it from backports. If you want HW support on raspberry you need self build from source. Windows binary are avilable on ffmpeg homepage.
|
||||
You need a `ffmpeg` binary in your system path. On Debain 8 you can install it from backports. If you want Hardware support on a Raspberry Pi you need tobuild from source by yourself. Windows binary are avilable on the [FFmpeg](http://www.ffmpeg.org/) website.
|
||||
</p>
|
||||
|
||||
To enable your FFmpeg feed in your installation, add the following to your `configuration.yaml` file:
|
||||
|
|
@ -36,9 +36,24 @@ Configuration variables:
|
|||
- **input** (*Required*): A ffmpeg compatible input file, stream or feed.
|
||||
- **name** (*Optional*): This parameter allows you to override the name of your camera.
|
||||
- **ffmpeg_bin** (*Optional*): Default 'ffmpeg'.
|
||||
- **extra_arguments** (*Optional*): Extra option they will pass to ffmpeg. i.e. image quality or video filter options.
|
||||
- **extra_arguments** (*Optional*): Extra option they will pass to `ffmpeg`. i.e. image quality or video filter options.
|
||||
|
||||
### {% linkable_title Image quality %}
|
||||
|
||||
You can control the `image quality` with [`extra_arguments`](https://www.ffmpeg.org/ffmpeg-codecs.html#jpeg2000) `-q:v 2-32` or with lossless option `-pred 1`.
|
||||
|
||||
### {% linkable_title Troubleshooting %}
|
||||
|
||||
In most of case, `ffmpeg` autodetect all needed options to read a video/audio stream or file. But it is possible in rare cases that's needed to set a option to help `ffmpeg`. Per default `ffmpeg` use 5 seconds to detect all options or abort.
|
||||
|
||||
First check, if your stream playable by `ffmpeg` with (use option `-an` or `-vn` to disable video or audio stream):
|
||||
|
||||
```
|
||||
$ ffmpeg -i INPUT -an -f null -
|
||||
```
|
||||
|
||||
Now you can see what going wrong. Following list could be help to solve your trouble:
|
||||
|
||||
- `[rtsp @ ...] UDP timeout, retrying with TCP`: You need to set RTSP transport in the configuration with: `input: -rtsp_transport tcp -i INPUT`
|
||||
- `[rtsp @ ...] Could not find codec parameters for stream 0 (Video: ..., none): unspecified size`: FFmpeg need more data or time for autodetect. You can set the `analyzeduration` and/or `probesize` option, play with this value. If you know the needed value you can set it with: `input: -analyzeduration xy -probesize xy tcp -i INPUT`. More information about that can be found on [FFmpeg](https://www.ffmpeg.org/ffmpeg-formats.html#Description).
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ The `generic_thermostat` climate platform is a thermostat implemented in Home As
|
|||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
climate:
|
||||
platform: heat_control
|
||||
platform: generic_thermostat
|
||||
name: Study
|
||||
heater: switch.study_heater
|
||||
target_sensor: sensor.study_temperature
|
||||
|
|
|
|||
|
|
@ -25,9 +25,9 @@ climate:
|
|||
ipaddress: YOUR_IPADDRESS
|
||||
port: YOUR_PORT
|
||||
tstats:
|
||||
1:
|
||||
id: THERMOSTAT_ID
|
||||
name: THERMOSTAT_NAME
|
||||
- 1:
|
||||
id: THERMOSTAT_ID
|
||||
name: THERMOSTAT_NAME
|
||||
```
|
||||
|
||||
A single interface can handle up to 32 connected devices.
|
||||
|
|
|
|||
|
|
@ -14,6 +14,10 @@ ha_category: Climate
|
|||
|
||||
The `nest` climate platform let you control a thermostat from [Nest](https://nest.com).
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use those thermostats.
|
||||
</p>
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
@ -25,6 +29,3 @@ climate:
|
|||
<img src='{{site_root}}/images/screenshots/nest-thermostat-card.png' />
|
||||
</p>
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](https://home-assistant.io/components/nest/) configured to use this sensor.
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ footer: true
|
|||
logo: command_line.png
|
||||
ha_category: Cover
|
||||
ha_release: 0.14
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
A `command_line`cover platform that issues specific commands when it is moved up, down and stopped. It allows anyone to integrate any type of cover into Home Assistant that can be controlled from the command line.
|
||||
|
|
@ -22,10 +23,10 @@ cover:
|
|||
- platform: command_line
|
||||
covers:
|
||||
Garage door:
|
||||
open_cmd: move_command up kitchen
|
||||
close_cmd: move_command down kitchen
|
||||
stop_cmd: move_command stop kitchen
|
||||
state_cmd: state_command kitchen
|
||||
opencmd: move_command up kitchen
|
||||
closecmd: move_command down kitchen
|
||||
stopcmd: move_command stop kitchen
|
||||
statecmd: state_command kitchen
|
||||
value_template: {% raw %}>
|
||||
{% if value == 'open' %}
|
||||
100
|
||||
|
|
@ -39,8 +40,8 @@ Configuration variables:
|
|||
|
||||
- **covers** (*Required*): The array that contains all command line covers.
|
||||
- **entry** (*Required*): Name of the command line cover. Multiple entries are possible.
|
||||
- **open_cmd** (*Required*): The command to open the cover.
|
||||
- **close_cmd** (*Required*): The action to close the cover.
|
||||
- **stop_cmd** (*Required*): The action to stop the cover.
|
||||
- **state_cmd** (*Optional*): If given, this will act as a sensor that runs in the background and updates the state of the cover. If the command returns a `0` the indicates the cover is fully closed, whereas a 100 indicates the cover is fully open.
|
||||
- **value_template** (*optional - default: '{% raw %}{{ value }}{% endraw%}'*): if specified, `state_cmd` will ignore the result code of the command but the template evaluating will indicate the position of the cover. For example, if your `state_cmd` returns a string "open", using `value_template` as in the example config above will allow you to translate that into the valid state `100`.
|
||||
- **opencmd** (*Required*): The command to open the cover.
|
||||
- **closecmd** (*Required*): The action to close the cover.
|
||||
- **stopcmd** (*Required*): The action to stop the cover.
|
||||
- **statecmd** (*Optional*): If given, this will act as a sensor that runs in the background and updates the state of the cover. If the command returns a `0` the indicates the cover is fully closed, whereas a 100 indicates the cover is fully open.
|
||||
- **value_template** (*optional - default: '{% raw %}{{ value }}{% endraw%}'*): if specified, `statecmd` will ignore the result code of the command but the template evaluating will indicate the position of the cover. For example, if your `statecmd` returns a string "open", using `value_template` as in the example config above will allow you to translate that into the valid state `100`.
|
||||
|
|
|
|||
|
|
@ -30,27 +30,31 @@ cover:
|
|||
state_topic: "home-assistant/cover"
|
||||
command_topic: "home-assistant/cover/set"
|
||||
name: "MQTT Sensor"
|
||||
optimistic: false
|
||||
qos: 0
|
||||
retain: true
|
||||
payload_open: "PAYLOAD_OPEN"
|
||||
payload_close: "PAYLOD__CLOSE"
|
||||
payload_stop: "PAYLOAD_STOP"
|
||||
state_open: "STATE_OPEN"
|
||||
state_closed: "STATE_CLOSED"
|
||||
service_open: "SERVICE_OPEN"
|
||||
service_close: "SERVICE_CLOSE"
|
||||
optimistic: false
|
||||
retain: false
|
||||
value_template: '{% raw %}{{ value.x }}{% endraw %}'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **state_topic** (*Required*): The MQTT topic subscribed to receive sensor values.
|
||||
- **command_topic** (*Required*): The MQTT topic to publish commands to control the rollershutter.
|
||||
- **name** (*Optional*): The name of the sensor. Default is "MQTT Sensor".
|
||||
- **state_open** (*Optional*): The payload that represents open state. Default is"STATE_OPEN"
|
||||
- **state_closed** (*Optional*): The payload that represents closed state. Default is "STATE_CLOSED"
|
||||
- **service_open** (*Optional*): The payload that represents open state in service mode. Default is"SERVICE_OPEN"
|
||||
- **service_close** (*Optional*): The payload that represents closed state in service mode. Default is "SERVICE_CLOSE"
|
||||
- **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is `true` if no state topic defined, else `false`.
|
||||
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
|
||||
- **retain** (*Optional*): If the published message should have the retain flag on or not.
|
||||
- **payload_open** (*Optional*): The payload that opens the cover. Default is "UP"
|
||||
- **payload_close** (*Optional*): The payload that closes the cover. Default is "DOWN"
|
||||
- **payload_stop** (*Optional*): The payload that stops the rollershutter. default is "STOP"
|
||||
- **state_open** (*Optional*): The payload that represents open state. Default is"STATE_OPEN"
|
||||
- **state_closed** (*Optional*): The payload that represents closed state. Default is "STATE_CLOSED"
|
||||
- **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is `true` if no state topic defined, else `false`.
|
||||
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
|
||||
|
||||
For a quick check you can use the commandline tools shipped with `mosquitto` to send MQTT messages. Set the state of your sensor manually:
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ ha_category: Cover
|
|||
ha_release: 0.13
|
||||
---
|
||||
|
||||
Wink cover/garage door functionality is currently limited to view only. Wink garage doors will still show the current state of the door, but control has been disabled for third parties. If you have a Chamberlain garage door, and would like to control it via Home Assistant, please contact Chamberlain and request that they re-enabled third-party control.
|
||||
Wink cover/garage door functionality depends on the product you're using. With GoControl/Linear Home Assistant can open, close, and view state. Chamberlain is currently limited to view only. Meaning Home Assistant will only show the current state of the door and control has been disabled (by Chamberlain). If you have a Chamberlain garage door, and would like to control it via Home Assistant, please contact Chamberlain and request that they re-enabled third-party control.
|
||||
|
||||
The following quote is from Wink.
|
||||
|
||||
|
|
|
|||
|
|
@ -19,14 +19,14 @@ Available demo platforms:
|
|||
- [Alarm control panel](/components/alarm_control_panel/) (`alarm_control_panel`)
|
||||
- [Binary sensor](/components/binary_sensor/) (`binary_sensor`)
|
||||
- [Camera](/components/camera/) (`camera`)
|
||||
- [Climate](/components/climate/) (`climate`)
|
||||
- [Cover](/components/cover/) (`cover`)
|
||||
- [Fan](/components/fan/) (`fan`)
|
||||
- [Light](/components/light/) (`light`)
|
||||
- [Lock](/components/lock/) (`lock`)
|
||||
- [Notification](/components/notify/) (`notify`)
|
||||
- [Cover](/components/cover/) (`cover`)
|
||||
- [Sensor](/components/sensor/) (`sensor`)
|
||||
- [Switch](/components/switch/) (`switch`)
|
||||
- [Climate](/components/climate/) (`climate`)
|
||||
- [Fan](/components/fan/) (`fan`)
|
||||
|
||||
To integrate a demo platform in Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Bluetooth Tracker"
|
||||
title: "Bluetooth LE Tracker"
|
||||
description: "Instructions for integrating bluetooth low-energy tracking within Home Assistant."
|
||||
date: 2016-08-24 00:00
|
||||
sidebar: true
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ Install on your smartphone:
|
|||
- [Android](https://play.google.com/store/apps/details?id=io.locative.app)
|
||||
- [iOS](https://itunes.apple.com/us/app/geofancy/id725198453)
|
||||
|
||||
To configure Locative, you must set up the app to send a `GET` request to your Home Assistant server at `http://<ha_server>/api/locative`. Make sure to include the API password if you have configured a password in Home Assistant (add `?api_password=<password>` to the end of the URL). When you enter or exit a geofence, Locative will send a `GET` request to that URL, updating Home Assistant.
|
||||
To configure Locative, you must set up the app to send a `GET` request to your Home Assistant server at `http://<ha_server>/api/locative`. Make sure to include the API password if you have configured a password in Home Assistant (add `?api_password=<password>` to the end of the URL). When you enter or exit a geofence, Locative will send a `GET` request to that URL, updating Home Assistant. You are not able to specify a device name in Locative. Instead, you will need to look in your known_devices.yaml file for a new device that Locative will have created on it's first `GET`. If you had been or are using Owntracks as well, you will need to update the device name used in the Owntracks setup with the name that Locative generated.
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/locative.png'/>
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ ha_category: Downloading
|
|||
ha_release: pre 0.7
|
||||
---
|
||||
|
||||
The `downloader` component provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist.
|
||||
The `downloader` component provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user that is running Home Assistant.
|
||||
|
||||
To enable it, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -13,11 +13,11 @@ featured: true
|
|||
---
|
||||
|
||||
|
||||
The Ecobee platform lets you control a thermostats and view sensor data from the [Ecobee](https://ecobee.com) thermostat.
|
||||
The `ecobee` component lets you control a thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats.
|
||||
|
||||
You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this component. To get the key, first you need to register your thermostat. Once you have done that, click on the 'Become a developer' link on the developer site. Login with your ecobee credentials, accept the SDK agreement, fill in the fields, and click save. Now login to the regular consumer portal, and in the hamburger menu there will br a new option 'Developer'. Select that, then select 'Create New'. Give your app a name (it appears to need to be unique across all users, as I tried 'home-assistant' and it said it was already in use) and a summary (neither of these are important as they are not used anywhere). For Authorization method select 'ecobee PIN'. You don't need an Application Icon or Detailed Description. Click Save. Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the 'X' to close the Developer section.
|
||||
You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this component. To get the key, first you need to register your thermostat. Once you have done that, click on the **Become a developer** link on the developer site. Login with your Ecobee credentials, accept the SDK agreement, fill in the fields, and click **save**. Now login to the regular consumer portal, and in the hamburger menu there will be a new option **Developer**. Select that, then select **Create New**. Give your app a name (it appears to need to be unique across all users, as I tried 'home-assistant' and it said it was already in use) and a summary (neither of these are important as they are not used anywhere). For Authorization method select **ecobee PIN**. You don't need an Application Icon or Detailed Description. Click **Save**. Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the **X** to close the Developer section.
|
||||
|
||||
The first time you run Home-Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking 'Add Application' in the 'My Apps' section in the sidebar. Enter the PIN code from the Home Assistant screeen. To get the PIN code select the item in the Ecobee card. If you do not have an Ecobee card, you may be using groups with default_view that don't show the card. To get around this you can temporarily comment out the default_view section or add the configurator.ecobee component to your default_view and restart Home Assistant. Once you enter the PIN on the Ecobee site, wait approximately 5 minutes and then click on the 'I have authorized the app' link at the bottom of the Ecobee popup window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full Ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your default_view (if you had to disable it) and add the Ecobee sensors to a group and/or view.
|
||||
The first time you run Home Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar. Enter the PIN code from the Home Assistant screeen. To get the PIN code select the item in the ecobee card. If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` component to your `default_view` and restart Home Assistant. Once you enter the PIN on the ecobee site, wait approximately 5 minutes and then click on the **I have authorized the app** link at the bottom of the ecobee popup window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your `default_view` (if you had to disable it) and add the ecobee sensors to a group and/or view.
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -29,8 +29,8 @@ ecobee:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **api_key** (*Required*): Your Ecobee api key.
|
||||
- **hold_temp** (*Optional*): True/False whether or not to hold changes indefinitely (True) or until the next scheduled event (False, default).
|
||||
- **api_key** (*Required*): Your ecobee API key.
|
||||
- **hold_temp** (*Optional*): True/False whether or not to hold changes indefinitely (True) or until the next scheduled event. Defaults to `False`.
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/ecobee-sensor-badges.png' />
|
||||
|
|
|
|||
|
|
@ -15,6 +15,10 @@ ha_iot_class: "Local Push"
|
|||
The `emulated_hue` component provides a virtual Philips Hue bridge, written entirely in software, that allows services that work with the Hue API to interact with Home Assistant
|
||||
entities. The driving use case behind this functionality is to allow Home Assistant to work with an Amazon Echo with no set up cost outside of configuration changes.
|
||||
|
||||
<p class='note'>
|
||||
It is recommended to assign a static IP address to the computer running Home Assistant. This is because the Amazon Echo discovers devices by IP addresss, and if the IP changes, the Echo won't be able to control it. This is easiest done from your router, see your router's manual for details.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
|
||||
To enable the emulated Hue bridge, add the following to your `configuration.yaml` file:
|
||||
|
|
|
|||
|
|
@ -2,14 +2,14 @@
|
|||
layout: page
|
||||
title: "Insteon Hub Fan"
|
||||
description: "Instructions how to setup the Insteon Hub Fans within Home Assistant."
|
||||
date: 2016-08-26 08:00
|
||||
date: 2017-08-26 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Fan
|
||||
ha_release: 0.27
|
||||
ha_release: 0.30
|
||||
---
|
||||
|
||||
The `insteon_hub` fan component lets you control your fans connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant.
|
||||
|
|
|
|||
|
|
@ -20,8 +20,8 @@ To use RSS feeds in your installation, add the following to your `configuration.
|
|||
# Example configuration.yaml entry
|
||||
feedreader:
|
||||
urls:
|
||||
- https://home-assistant.io/atom.xml
|
||||
- https://github.com/blog.atom
|
||||
- https://home-assistant.io/atom.xml
|
||||
- https://github.com/blog.atom
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
|
|
|||
|
|
@ -55,6 +55,18 @@ When your screen looks like this, click the 'call service' button.
|
|||
You need to setup a unique trigger for each event you sent to IFTTT.
|
||||
</p>
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml Automation entry
|
||||
automation:
|
||||
- alias: Startup Notification
|
||||
trigger:
|
||||
platform: event
|
||||
event_type: homeassistant_start
|
||||
action:
|
||||
service: ifttt.trigger
|
||||
data: {"event":"TestHA_Trigger", "value1":"Hello World!"}
|
||||
```
|
||||
|
||||
### {% linkable_title Sending events from IFTTT to Home Assistant %}
|
||||
|
||||
To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web. This can be achieved by forwarding port 8123 from your router to the device running Home Assistant. If your ISP is giving you a new IP address from time to time, consider using [DuckDNS][duck-dns].
|
||||
|
|
|
|||
|
|
@ -14,32 +14,32 @@ Interacts with media players on your network. Please check the sidebar for a ful
|
|||
## {% linkable_title Services %}
|
||||
|
||||
### {% linkable_title Media control services %}
|
||||
Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `media_play_pause`, `media_play`, `media_pause`, `media_next_track`, `media_previous_track`, `clear_playlist`
|
||||
Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `media_play_pause`, `media_play`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track`, `clear_playlist`
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Target a specific media player. Defaults to all.
|
||||
|
||||
#### {% linkable_title Service `media_player/mute_volume` %}
|
||||
#### {% linkable_title Service `media_player/volume_mute` %}
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Target a specific media player. Defaults to all.
|
||||
| `mute` | no | True/false for mute/unmute
|
||||
| Service data attribute | Optional | Description |
|
||||
|------------------------|----------|--------------------------------------------------|
|
||||
| `entity_id` | yes | Target a specific media player. Defaults to all. |
|
||||
| `is_volume_muted` | no | True/false for mute/unmute |
|
||||
|
||||
#### {% linkable_title Service `media_player/set_volume_level` %}
|
||||
#### {% linkable_title Service `media_player/volume_set` %}
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Target a specific media player. Defaults to all.
|
||||
| `volume` | no | Integer for volume level
|
||||
| Service data attribute | Optional | Description |
|
||||
|------------------------|----------|--------------------------------------------------|
|
||||
| `entity_id` | yes | Target a specific media player. Defaults to all. |
|
||||
| `volume_level` | no | Integer for volume level |
|
||||
|
||||
#### {% linkable_title Service `media_player/media_seek` %}
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Target a specific media player. Defaults to all.
|
||||
| `position` | no | Position to seek to. The format is platform dependent.
|
||||
| Service data attribute | Optional | Description |
|
||||
|------------------------|----------|--------------------------------------------------------|
|
||||
| `entity_id` | yes | Target a specific media player. Defaults to all. |
|
||||
| `seek_position` | no | Position to seek to. The format is platform dependent. |
|
||||
|
||||
#### {% linkable_title Service `media_player/play_media` %}
|
||||
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ Configuration variables:
|
|||
- **event** (*Required*): The event
|
||||
- **tracker** (*Required*): The name of tracker inside Instapush.
|
||||
|
||||
To retrieve those values for existing settings, log into your account at [https://instapush.im](https://instapush.im) and go to your **Dashboard**. Then click **APPS** tab, choose an app, and check the **Basic Info** section. The *Application ID* is the ``api_key`` and ``app_secret`` is the *Application Secret*.
|
||||
To retrieve the needed values for existing settings, log into your account at [https://instapush.im](https://instapush.im) and go to your **Dashboard**. Then click the **APPS** tab, choose an app, and check the **Basic Info** section. The *Application ID* is the `api_key` and `app_secret` is the *Application Secret*.
|
||||
|
||||
Assuming that your setup looks look in the image below...
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Notify My Android"
|
||||
description: "Instructions how to add user notifications to Home Assistant."
|
||||
description: "Instructions how to add NMA notifications to Home Assistant."
|
||||
date: 2015-05-01 18:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
|
|
@ -13,7 +13,9 @@ ha_release: pre 0.7
|
|||
---
|
||||
|
||||
|
||||
The nma platform uses [Notify My Android (NMA)](http://www.notifymyandroid.com/) to delivery notifications from Home Assistant to your Android device.
|
||||
The `nma` platform uses [Notify My Android (NMA)](http://www.notifymyandroid.com/) to delivery notifications from Home Assistant to your Android device.
|
||||
|
||||
Go to the [NMA website](https://www.notifymyandroid.com) and create a new API key. If you are using the trial offer then keep in mind that your limit is five (5) message per day.
|
||||
|
||||
To add NMA to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -28,8 +30,8 @@ notify:
|
|||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
- **api_key** (*Required*): Enter the API key for NMA. Go to https://www.notifymyandroid.com and create a new API key.
|
||||
- **api_key** (*Required*): Enter the API key for NMA.
|
||||
|
||||
Details for the API : https://www.notifymyandroid.com/api.jsp
|
||||
Details for the (API)[https://www.notifymyandroid.com/api.jsp].
|
||||
|
||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||
|
|
|
|||
|
|
@ -9,10 +9,13 @@ sharing: true
|
|||
footer: true
|
||||
logo: pushetta.png
|
||||
ha_category: Notifications
|
||||
ha_release: pre 0.7
|
||||
---
|
||||
|
||||
|
||||
The pushetta platform uses [Pushetta](http://www.pushetta.com) to delivery notifications from Home Assistant to your devices.
|
||||
The `pushetta` notify platform uses [Pushetta](http://www.pushetta.com) to delivery notifications from Home Assistant to your devices.
|
||||
|
||||
To retrieve the API token, log into your account at (http://www.pushetta.com)[http://www.pushetta.com] and go to your **Dashboard**. Create a new channel by clicking on **Channels** and then **Add a Channel**.
|
||||
|
||||
To enable Pushetta notifications in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -31,8 +34,6 @@ Configuration variables:
|
|||
- **api_key** (*Required*): Your API key for Pushetta.
|
||||
- **channel_name** (*Required*): The name of your channel.
|
||||
|
||||
To retrieve the API token, log into your account at http://www.pushetta.com and go to your **Dashboard**. Create a new channel by clicking on **Channels** and then **Add a Channel**.
|
||||
|
||||
It's easy to test your Pushetta setup outside of Home Assistant. Assuming you have a channel *home-assistant*, just fire a request and check the channel page in the dashboard for a new message.
|
||||
|
||||
```bash
|
||||
|
|
|
|||
|
|
@ -15,6 +15,8 @@ ha_release: pre 0.7
|
|||
|
||||
The [Pushover service](https://pushover.net/) is a platform for the notify component. This allows components to send messages to the user using Pushover.
|
||||
|
||||
In order to get an API key you need to go to the [Pushover website](https://pushover.net) and register a new application. From the website you can also retrieve your user key.
|
||||
|
||||
To use Pushover notifications, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
@ -29,8 +31,8 @@ notify:
|
|||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
- **api_key** (*Required*): This parameter is optional but should be configured, in order to get an API key you should go to https://pushover.net and register a new application.
|
||||
- **user_key** (*Required*): To retrieve this value log into your account at https://pushover.net
|
||||
- **api_key** (*Required*): Your API key.
|
||||
- **user_key** (*Required*): Your user key for Pushover.
|
||||
|
||||
This is a quote from the Pushover website regarding free/open source apps:
|
||||
|
||||
|
|
@ -39,3 +41,5 @@ This is a quote from the Pushover website regarding free/open source apps:
|
|||
</blockquote>
|
||||
|
||||
When setting up the application you can use this [icon](https://home-assistant.io/images/favicon-192x192.png).
|
||||
|
||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||
|
|
|
|||
|
|
@ -25,17 +25,8 @@ The quickest way to retrieve your `chat_id` is visiting [https://api.telegram.or
|
|||
The result set will include your chat ID as `id` in the `from` section:
|
||||
|
||||
```json
|
||||
{
|
||||
"ok":true,
|
||||
"result":[
|
||||
{
|
||||
"update_id":254199982,
|
||||
"message":{
|
||||
"message_id":201,
|
||||
"from":{
|
||||
"id":123456789,
|
||||
"first_name":"Your first name",
|
||||
...
|
||||
{"ok":true,"result":[{"update_id":254199982,
|
||||
"message":{"message_id":27,"from":{"id":123456789,"first_name":"YOUR_FIRST_NAME YOUR_NICK_NAME","last_name":"YOUR_LAST_NAME","username":"YOUR_NICK_NAME"},"chat":{"id":123456789,"first_name":"YOUR_FIRST_NAME YOUR_NICK_NAME","last_name":"YOUR_LAST_NAME","username":"YOUR_NICK_NAME","type":"private"},"date":1678292650,"text":"test"}}]}
|
||||
```
|
||||
|
||||
Another way to get your chat ID directly is described below:
|
||||
|
|
@ -92,6 +83,27 @@ action:
|
|||
- **username** (*Optional*): Username for an URL which require HTTP basic authentication.
|
||||
- **password** (*Optional*): Username for an URL which require HTTP basic authentication.
|
||||
|
||||
### {% linkable_title Document support %}
|
||||
|
||||
```yaml
|
||||
...
|
||||
action:
|
||||
service: notify.NOTIFIER_NAME
|
||||
data:
|
||||
title: Send a document
|
||||
message: That's a example that sends a document.
|
||||
data:
|
||||
document:
|
||||
file: /tmp/whatever.odf
|
||||
caption: Picture Title xy
|
||||
|
||||
```
|
||||
|
||||
- **url** or **file** (*Required*): For local or remote path to an image.
|
||||
- **caption** (*Optional*): The title of the image.
|
||||
- **username** (*Optional*): Username for an URL which require HTTP basic authentication.
|
||||
- **password** (*Optional*): Username for an URL which require HTTP basic authentication.
|
||||
|
||||
### {% linkable_title Location support %}
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -11,9 +11,9 @@ logo: apcupsd.png
|
|||
ha_category: Sensor
|
||||
---
|
||||
|
||||
The `apcupsd` sensor platform to allow you to monitor a UPS (battery backup) by using data from the [apcaccess](http://linux.die.net/man/8/apcaccess) command.
|
||||
The `apcupsd` sensor platform allows you to monitor a UPS (battery backup) by using data from the [apcaccess](http://linux.die.net/man/8/apcaccess) command.
|
||||
|
||||
To add this platform to your installation, add the following to your `configuration.yaml` file:
|
||||
To use this sensor platform, you first have to set up [apcupsd](https://home-assistant.io/components/apcupsd/) and add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
|
|
|||
|
|
@ -9,6 +9,8 @@ sharing: true
|
|||
footer: true
|
||||
logo: bloomsky.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.14
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
|
|
@ -33,7 +35,7 @@ sensor:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **monitored_conditions** array *Required*: The sensors that you wish to monitor on all of your devices. Select from these options:
|
||||
- **monitored_conditions** array (*Required*): The sensors that you wish to monitor on all of your devices. Select from these options:
|
||||
- Humidity
|
||||
- Luminance
|
||||
- Night
|
||||
|
|
|
|||
|
|
@ -10,10 +10,11 @@ footer: true
|
|||
logo: command_line.png
|
||||
ha_category: Sensor
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
A sensor platform that issues specific commands to get data. This might become our most powerful platform as it allows anyone to integrate any type of sensor into Home Assistant that can get data from the command line.
|
||||
The `command_line` sensor platform that issues specific commands to get data. This might become our most powerful platform as it allows anyone to integrate any type of sensor into Home Assistant that can get data from the command line.
|
||||
|
||||
To enable it, add the following lines to your `configuration.yaml`:
|
||||
|
||||
|
|
|
|||
|
|
@ -9,13 +9,15 @@ sharing: true
|
|||
footer: true
|
||||
logo: avm.png
|
||||
ha_category: System Monitor
|
||||
ha_release: "0.27"
|
||||
ha_release: 0.27
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers
|
||||
on TCP port 1012. It will assume the values 'idle', 'ringing', 'dialing', or 'talking',
|
||||
with the phone numbers involved contained in the state attributes.
|
||||
on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing`, or `talking` with the phone numbers involved contained in the state attributes.
|
||||
|
||||
To activate the call monitor on your Fritz!Box, dial #96*5* from any phone connected to it.
|
||||
|
||||
To use the Fritz!Box call monitor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -53,6 +53,7 @@ sensor:
|
|||
gas_secret: 'GAS_SECRET'
|
||||
gas_type: imperial
|
||||
gas_calorific: 38.2
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,11 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
ha_category: sensor
|
||||
ha_category: Sensor
|
||||
ha_release: 0.27
|
||||
---
|
||||
|
||||
The MH-Z19 is a small nondispersive infrared sensor that can measure CO2 sensors. High CO2 levels can lead to drowsiness, poor concentration, loss of attention or increased heart rate. Outside CO2 levels are usually between 250 and 350ppm, but inside levels can reach between 1000 and 5000 ppm. High CO2 levels indicate that you should increase ventilation.
|
||||
The MH-Z19 is a small nondispersive infrared sensor that can measure CO2 sensors. High CO2 levels can lead to drowsiness, poor concentration, loss of attention or increased heart rate. The CO2 level outside is around 400ppm, but inside levels can reach between 1000 and 5000 ppm. High CO2 levels indicate that you should increase ventilation.
|
||||
|
||||
Check out the [Open Home Automation web site](https://www.open-homeautomation.com/2016/08/24/monitor-co2-levels-in-your-house/) for a quick guide how to connect the sensor to your PC or Raspberry Pi.
|
||||
|
||||
|
|
|
|||
|
|
@ -15,6 +15,10 @@ ha_release: pre 0.7
|
|||
|
||||
The `nest` sensor platform let you monitor sensors connected to your [Nest](https://nest.com) thermostat and/or your Nest Protect Smoke Alarm.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use those sensors.
|
||||
</p>
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
@ -57,6 +61,3 @@ Configuration variables:
|
|||
- 'co_status' # Nest Protect only
|
||||
- 'smoke_status' # Nest Protect only
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use this sensor.
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -15,6 +15,10 @@ ha_iot_class: "Cloud Poll"
|
|||
|
||||
The `nest` weather sensor platform let you monitor current weather conditions based on the location of your [Nest](https://nest.com) thermostat.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use those sensors.
|
||||
</p>
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
@ -37,4 +41,3 @@ Configuration variables:
|
|||
- 'wind_speed'
|
||||
- 'wind_direction'
|
||||
|
||||
<p class='note'>You must have the [Nest component](/components/nest/) configured to use this sensor.</p>
|
||||
|
|
|
|||
|
|
@ -37,8 +37,8 @@ sensor:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): This is the base URL of your SABnzbd instance including the port number if not running on 80, eg. http://192.168.1.32:8124/
|
||||
- **port** (*Optional*): The port to use whith SABnzbd instance. Defaults to 8080.
|
||||
- **host** (*Required*): The host where your SABnzbd instance is running, eg. 192.168.1.32
|
||||
- **port** (*Optional*): The port to use whith SABnzbd instance. Defaults to `8080`.
|
||||
- **api_key** (*Required*): Name that will be used in the frontend for the pin.
|
||||
- **name** (*Optional*): The name to use when displaying this SABnzbd instance.
|
||||
- **monitored_variables** array (*Required*): List of the monitored variables.
|
||||
|
|
@ -48,3 +48,16 @@ Configuration variables:
|
|||
- **queue_remaining**: Remaining elements in the queue
|
||||
- **disk_size**: Disk size of the storage location
|
||||
- **disk_free**: Free disk space at the sotrage location
|
||||
|
||||
Note that this will create sensors under the name 'sab' and NOT 'sabnzbd' as follows:
|
||||
|
||||
```
|
||||
- sensor.sab_status
|
||||
- sensor.sab_speed
|
||||
- sensor.sab_queue
|
||||
- sensor.sab_left
|
||||
- sensor.sab_disk
|
||||
- sensor.sab_disk_free
|
||||
```
|
||||
|
||||
As always, you can determine the names of sensors by looking at the dev-state page `< >` in the web interface.
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ ha_category: System Monitor
|
|||
ha_release: "0.20"
|
||||
---
|
||||
|
||||
The `supervisord` platform allows you to track the states of [Supervisor](http://supervisord.org/).
|
||||
The `supervisord` platform allows you to track the states of [Supervisord](http://supervisord.org/).
|
||||
|
||||
To use this sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -10,10 +10,11 @@ footer: true
|
|||
logo: command_line.png
|
||||
ha_category: Switch
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
A switch platform that issues specific commands when it is turned on and off. This might very well become our most powerful platform as it allows anyone to integrate any type of switch into Home Assistant that can be controlled from the command line, including calling other scripts!
|
||||
The `command_line` switch platform issues specific commands when it is turned on and off. This might very well become our most powerful platform as it allows anyone to integrate any type of switch into Home Assistant that can be controlled from the command line, including calling other scripts!
|
||||
|
||||
To enable it, add the following lines to your `configuration.yaml`:
|
||||
|
||||
|
|
|
|||
112
source/_components/switch.netio.markdown
Normal file
112
source/_components/switch.netio.markdown
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Netio Switch"
|
||||
description: "Instructions how to integrate Netio switches into Home Assistant."
|
||||
date: 2016-09-02 19:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: netio.png
|
||||
ha_category: Switch
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: 0.24
|
||||
---
|
||||
|
||||
|
||||
The `netio` switch platform allows you to control your [Netio](http://www.netio-products.com/en/overview/) Netio4, Netio4 All, and Netio 230B. These are smart outlets controllable through ethernet and/or WiFi that reports consumptions (Netio4all).
|
||||
|
||||
To use Netio devices in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
- platform: netio
|
||||
host: 192.168.1.43
|
||||
port: 1234
|
||||
username: user
|
||||
password: pwd
|
||||
outlets:
|
||||
1: Free
|
||||
2: TV
|
||||
4: Lamp
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): The IP address of your Netio plug, eg. http://192.168.1.32
|
||||
- **port** (*Optional*): The port to communicate with the switch. Defaults to `1234`.
|
||||
- **username** (*Required*): The username for your plug.
|
||||
- **password** (*Required*): The password for your plug.
|
||||
- **outlets** (*Required*) array: List of all outlets.
|
||||
- **[No.]: [Name]** (*Required*): Identification of an outlet.
|
||||
|
||||
|
||||
|
||||
To get pushed updates from the Netio devices, one can add this Lua code in the device interface as an action triggered on "Netio" "System variables updated"
|
||||
with an 'Always' schedule:
|
||||
|
||||
|
||||
```lua
|
||||
-- this will send socket and consumption status updates via CGI
|
||||
-- to given address. Associate with 'System variables update' event
|
||||
-- to get consumption updates when they show up
|
||||
|
||||
local address='ha:8123'
|
||||
local path = '/api/netio/<host>'
|
||||
|
||||
|
||||
local output = {}
|
||||
for i = 1, 4 do for _, what in pairs({'state', 'consumption',
|
||||
'cumulatedConsumption', 'consumptionStart'}) do
|
||||
local varname = string.format('output%d_%s', i, what)
|
||||
table.insert(output,
|
||||
varname..'='..tostring(devices.system[varname]):gsub(" ","|"))
|
||||
end end
|
||||
|
||||
local qs = table.concat(output, '&')
|
||||
local url = string.format('http://%s%s?%s', address, path, qs)
|
||||
devices.system.CustomCGI{url=url}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
The `dlink` switch platform allows you to control the state of your [D-Link Wi-Fi Smart Plugs](http://us.dlink.com/product-category/home-solutions/connected-home/smart-plugs/).
|
||||
|
||||
Supported devices (tested):
|
||||
|
||||
- DSP-W215
|
||||
- DSP-W110
|
||||
|
||||
To use your D-Link smart plugs in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
platform: dlink
|
||||
host: IP_ADRRESS
|
||||
name: D-Link plug
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
|
@ -84,7 +84,7 @@ switch:
|
|||
switches:
|
||||
blind:
|
||||
friendly_name: 'Blind'
|
||||
value_template: {% raw %}'{{ state }}'{% endraw %}
|
||||
value_template: {% raw %}'{{ is_state_attr("switch.blind_toggle", "sensor_state", "on") }}'{% endraw %}
|
||||
turn_on:
|
||||
service: switch.toggle
|
||||
entity_id: switch.blind_toggle
|
||||
|
|
|
|||
|
|
@ -28,9 +28,9 @@ thermostat:
|
|||
ipaddress: YOUR_IPADDRESS
|
||||
port: YOUR_PORT
|
||||
tstats:
|
||||
1:
|
||||
id: THERMOSTAT_ID
|
||||
name: THERMOSTAT_NAME
|
||||
- 1:
|
||||
id: THERMOSTAT_ID
|
||||
name: THERMOSTAT_NAME
|
||||
```
|
||||
|
||||
A single interface can handle up to 32 connected devices.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue