jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-16 22:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Fabian Affolter 2017-09-30 13:30:14 +02:00
commit c8ec8391f4
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
190 changed files with 787 additions and 379 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.markdown
View File

@ -16,5 +16,19 @@ Setting up to contribute to documentation and the process for submitting pull re
In order to make the preview available on [http://127.0.0.1:4000](http://127.0.0.1:4000), use the command as follows:
```bash
$ rake preview
bundle exec rake preview
```
## Speeding up site generation
Every release we post long changelogs to the website. This slows down generation of the website significantly! We include some tools to temporarily exclude the blog posts that you're not working on out of the way.
```bash
bundle exec rake isolate[filename-of-blogpost]
```
When you're done working on the site, run the following command to move the posts back again:
```bash
bundle exec rake integrate
```

80
source/_addons/configurator.markdown Normal file
View File

@ -0,0 +1,80 @@
---
layout: page
title: "HASS Configurator"
description: "Browser-based configuration file editor for Home Assistant."
date: 2017-09-25 14:00
sidebar: true
comments: false
sharing: true
footer: true
featured: true
og_image: /images/hassio/screenshots/addon-hass-configurator.png
---
As long as a fully featured configuration GUI for Home Assistant is still under development, you can use this add-on to add a browser based file-editor to your Hass.IO installation. By default it will listen on port `3218` of the host Hass.IO is running on.
More information and a standalone version for regular Home Assistant installations can be found in the [GitHub repository][code].
[code]: https://github.com/danielperna84/hass-configurator
<p class='img'>
<img src='/images/hassio/screenshots/addon-hass-configurator.png'>
Screenshot of the HASS Configurator.
</p>
### {% linkable_title Feature list %}
- Web-Based editor to modify your files with syntax highlighting.
- Upload and download files.
- Stage and commit changes in Git repositories, create and switch between branches, push to remotes.
- Lists of available triggers, events, entities, conditions and services. Selected element gets inserted into the editor at the last cursor position.
- Restart Home Assitant directly with the click of a button. Reloading groups, automations etc. can be done as well. An API-password is required.
- SSL support.
- Optional authentication and IP filtering for added security.
- Direct links to Home Assistant documentation and icons.
- Execute shell commands within the add-on container.
- Editor settings are saved in your browser.
### {% linkable_title Add-on Configuration %}
```json
{
"homeassistant_api": "http://homeassistant:8123/api",
"homeassistant_password": "",
"username": "admin",
"password": "secret",
"certfile": "fullchain.pem",
"keyfile": "privkey.pem",
"ssl": false,
"allowed_networks": ["192.168.0.0/16"],
"banned_ips": ["8.8.8.8"],
"ignore_pattern": ["__pycache__"]
}
```
- **homeassistant_api** (*Optional*): The configurator fetches some data from your running Home Assistant instance. If the API is not available through the default URL, modify this variable to fix this.
- **homeassistant_password** (*Optional*): If you plan on using API functions, you have to set your API password. Calling services of Home Assistant is prohibited without authentication.
- **username** (*Optional*): Set a username to access your configuration is protected.
- **password** (*Required*): Set a password for access.
- **ssl** (*Optional*): Enable or Disable SSL for the editor.
- **allowed_networks** (*Optional*): Limit access to the configurator by adding allowed IP addresses / networks to the list.
- **banned_ips** (*Optional*): List of statically banned IP addresses.
- **ignore_pattern** (*Optional*): Files and folders to ignore in the UI.
### {% linkable_title Embedding into Home-Assistant %}
Using the Home Assistant component [panel_iframe](https://home-assistant.io/components/panel_iframe/) it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration within the Home Assistant frontend.
An example configuration would look like this:
```yaml
panel_iframe:
configurator:
title: Configurator
icon: mdi:wrench
url: http://hassio.local:3218
```
<p class='note warning'>
Be careful when setting up port forwarding to the configurator while embedding into Home Assistant. If you don't restrict access by requiring authentication and / or blocking based on client IP addresses, your configuration will be exposed to the internet!
</p>

20
source/_addons/duckdns.markdown
View File

@ -10,12 +10,15 @@ footer: true
featured: true
---
[Duck DNS](https://duckdns.org/) is a free dynamic DNS service. Using this service you can have a custom domainname under duckdns.org point at your home computer.
[Duck DNS](https://duckdns.org/) is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. This add-on includes support for Let's Encrypt and will automatically create and renew your certificates.
```json
{
"lets_encrypt": {
"accept_terms": true
},
"token": "sdfj-2131023-dslfjsd-12321",
"domains": ["my-first-account.duckdns.org", "my-second-account.duckdns.org"]
"domains": ["my-domain.duckdns.org"]
}
```
@ -24,3 +27,16 @@ Configuration variables:
- **token** (*Required*): Your Duck DNS API key.
- **domains** (*Required*): A list of domains to update DNS.
- **seconds** (*Optional*): Seconds between updates to Duck DNS.
- **lets_encrypt.accept_terms** (*Optional*): If you accept the [Let's Encrypt Subscriber Agreement][le], it will generate & update Let's Enrypt certificates for your DuckDNS domain.
[le]: https://letsencrypt.org/repository/
## {% linkable_title Home Assistant configuration %}
Use the following configuration in Home Assistant to use the generated certificate:
```yaml
http:
ssl_certificate: /ssl/fullchain.pem
ssl_key: /ssl/privkey.pem
```

28
source/_addons/git_pull.markdown Normal file
View File

@ -0,0 +1,28 @@
---
layout: page
title: "GIT pull"
description: "Load and update configuration files for Home Assistant from a GIT repository."
date: 2017-09-25 14:00
sidebar: true
comments: false
sharing: true
footer: true
---
Load and update configuration files for Home Assistant from a GIT repository.
```json
{
"repository": null,
"auto_restart": false,
"repeat": {
"active": false,
"interval": 300
}
}
```
- **repository** (*Required*): GIT url to your repository.
- **auto_restart** (*Optional*): Make a restart of Home-Assistant if the config have change and is valid.
- **repeat/active** (*Optional*): Pull periodic for GIT updates.
- **repeat/interval** (*Optional*): Pull all x seconds and look for changes.

2
source/_addons/google_assistant.markdown
View File

@ -56,7 +56,7 @@ Configuration example that uses the USB microphone and use the built-in headset
{
"mic": "1,0",
"speaker": "0,0",
"client_secrets": "google_assistant.json",
"client_secrets": "google_assistant.json"
}
```

2
source/_addons/mosquitto.markdown
View File

@ -22,7 +22,7 @@ Set up [Mosquitto](https://mosquitto.org/) as MQTT broker.
],
"customize": {
"active": false,
"folder": "mosquitto",
"folder": "mosquitto"
}
}
```

4
source/_components/alarm_control_panel.egardia.markdown
View File

@ -14,7 +14,7 @@ ha_category: Alarm
The `egardia` platform enables the ability to control an [Egardia](http://egardia.com/)/Woonveilig control panel. These alarm panels are known under different brand names across the world, including Woonveilig in the Netherlands. This was tested on a Gate01 version of the Egardia/Woonveilig platform.
You will need to know the IP of your alarm panel on your local network. Test if you can login to the panel by browsing to the IP address and log in in using your Egardia/Woonveilig account.
You will need to know the IP of your alarm panel on your local network. Test if you can login to the panel by browsing to the IP address and log in using your Egardia/Woonveilig account.
To enable this, add the following lines to your `configuration.yaml`:
@ -41,7 +41,7 @@ Configuration variables:
Note that this basic configuration will only enable you to read the armed/armed away/disarmed status of your alarm and will **not** update the status if the alarm is triggered. This is because of how Egardia built their system. The alarm triggers normally go through their servers.
You can change this, however, using the following procedure. This is a more advanced configuration.
1. Log in into your alarm system's control panel. You will need to access http://[ip of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password.
1. Log in into your alarm system's control panel. You will need to access http://[IP of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password.
2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. Also, update the port number 85 or to anything you like. The provided software that you will set up in the next steps runs on port 85 by default. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'.
3. On your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. You will need the codes to include in your configuration.yaml. Make sure to change the status of your alarm to all states (disarm, arm, armhome) as well as trigger the alarm in all ways possible to get 100% coverage. **Before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).**
4. Once you have the codes, update your `configuration.yaml`:

4
source/_components/alert.markdown
View File

@ -75,7 +75,7 @@ freshwater_temp_alert:
### {% linkable_title Complex Alert Criteria %}
By design, the `alert` component only handles very simple criteria for firing. That is, it 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.
By design, the `alert` component only handles very simple criteria for firing. That is, it only checks if a single entity's state is equal to a value. At some point, it may be desirable 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.
```yaml
binary_sensor:
@ -99,7 +99,7 @@ This example will begin firing as soon as the entity `sensor.motion`'s `battery`
### {% linkable_title Dynamic Notification Delay Times %}
It may be desireable to have the delays between alert notifications dynamically change as the alert continues to fire. This can be done by setting the `repeat` configuration key to a list of numbers rather than a single number. Altering the first example would look like the following.
It may be desirable to have the delays between alert notifications dynamically change as the alert continues to fire. This can be done by setting the `repeat` configuration key to a list of numbers rather than a single number. Altering the first example would look like the following.
```yaml
# Example configuration.yaml entry

6
source/_components/alexa.markdown
View File

@ -33,13 +33,13 @@ The built-in Alexa component allows you to integrate Home Assistant into Alexa/A
### {% linkable_title Requirements %}
Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are ok because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) the and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230).
Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are OK because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) the and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230).
Additionally, note that at the time of this writing, your Alexa skill endpoint *must* accept requests over port 443 (Home Assistant default to 8123). There are two ways you can handle this:
1. In your router, forward external 443 to your Home Assistant serving port (defaults to 8123)
OR
2. Change your Home Assistant serving port to 443 this is done in the [`http`](/components/http/) section with the the `server_port` entry in your `configuration.yaml` file
2. Change your Home Assistant serving port to 443 this is done in the [`http`](/components/http/) section with the `server_port` entry in your `configuration.yaml` file
[blog-lets-encrypt]: https://home-assistant.io/blog/2015/12/13/setup-encryption-using-lets-encrypt/
@ -295,7 +295,7 @@ alexa:
{% endif %}{% endraw %}
```
You can add multiple items for a feed if you want. The Amazon required uid and timestamp will be randomly generated at startup and change at every restart of Home Assistant.
You can add multiple items for a feed if you want. The Amazon required UID and timestamp will be randomly generated at startup and change at every restart of Home Assistant.
Please refer to the [Amazon documentation][flash-briefing-api-docs] for more information about allowed configuration parameters and formats.

2
source/_components/asterisk_mbox.markdown
View File

@ -18,7 +18,7 @@ To enable the component, a configuration is required in both Home Assistant as w
First follow the [Asterisk PBX configuration guide](/docs/asterisk_mbox) to setup the necessary server on the Asterisk PBX server (this is needed even if Asterisk and Home Assistant are running on the same server)
Once that is complete, add the the following entry `configuration.yaml` file:
Once that is complete, add the following entry `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

14
source/_components/axis.markdown
View File

@ -20,7 +20,7 @@ Home Assistant will automatically discover their presence on your network.
## {% linkable_title Dependencies %}
```bash
$ sudo apt-get install python3-gi gir1.2-gstreamer-1.0
$ sudo apt-get install python3-gst-1.0 gir1.2-gstreamer-1.0 gir1.2-gst-plugins-base-1.0 gstreamer1.0-plugins-good gstreamer1.0-plugins-ugly gstreamer1.0-tools python3-gi
```
Depending on how you run Home Assistant, you may need to symlink the `gi` module into your environment.
@ -37,6 +37,16 @@ Raspberry Pi All-In-One Installer:
$ ln -s /usr/lib/python3/dist-packages/gi /srv/homeassistant/homeassistant_venv/lib/python3.4/site-packages
```
[Virtualenv](https://home-assistant.io/docs/installation/virtualenv/) installation:
```bash
$ ln -s /usr/lib/python3/dist-packages/gi /srv/homeassistant/lib/python3.5/site-packages
```
<p class='note'>
Adjust "python3.5" in command above to match your version as stored in "/srv/homeassistant/lib/pythonX.X"
</p>
You can also manually configure your devices by adding the following lines to your `configuration.yaml` file:
```yaml
@ -57,7 +67,7 @@ Configuration variables:
- **username** (*Optional*): The username to your Axis device. Default 'root'.
- **password** (*Optional*): The password to your Axis device. Default 'pass'.
- **trigger_time** (*Optional*): Minimum time (in seconds) a sensor should keep its positive value. Default 0.
- **http_port** (*Optional*): Configure port web server of device is accessible from. Default 80.
- **port** (*Optional*): Configure port web server of device is accessible from. Default 80.
- **location** (*Optional*): Physical location of your Axis device. Default not set.
- **include** (*Required*): This cannot be empty else there would be no use adding the device at all.
- **camera**: Stream MJPEG video to Home Assistant.

2
source/_components/binary_sensor.arest.markdown
View File

@ -30,7 +30,7 @@ Configuration variables:
- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, e.g. http://192.168.1.10.
- **pin** (*Required*): Number of the pin to monitor.
- **name** (*Optional*): Let you overwrite the the name of the device. By default *name* from the device is used.
- **name** (*Optional*): Let you overwrite the name of the device. By default *name* from the device is used.
Accessing the URL http://IP_ADDRESS/digital/PIN_NUMBER should give you the state of the pin inside a JSON response as `return_value`.

2
source/_components/binary_sensor.bayesian.markdown
View File

@ -41,7 +41,7 @@ Configuration variables:
- **prob_given_true** (*Required*): The probability of the observation occurring, given the event is `true`.
- **prob_given_false** (*Optional*): The probability of the observation occurring, given the event is `false` can be set as well. If `prob_given_false` is not set, it will default to `1 - prob_given_true`.
- **platform** (*Required*): The only supported observation platforms are `state` and `numeric_state`, which are modeled after their corresponding triggers for automations.
- **to_state** (*Required*): THe target start.
- **to_state** (*Required*): The target start.
- **probability_threshold** (*Optional*): The probability at which the sensor should trigger to `on`.
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Bayesian Binary`.

2
source/_components/binary_sensor.command_line.markdown
View File

@ -28,7 +28,7 @@ binary_sensor:
Configuration variables:
- **command** (*Required*): The action to take to get the value.
- **name** (*Optional*): Let you overwrite the the name of the device. By default *name* from the device is used.
- **name** (*Optional*): Let you overwrite the name of the device. By default *name* from the device is used.
- **device_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
- **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON".
- **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF".

2
source/_components/binary_sensor.enocean.markdown
View File

@ -30,7 +30,7 @@ Configuration variables:
- **name** (*Optional*): An identifier for the switch in the frontend.
- **device_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
EnOcean binary sensors only generate 'button_pressed' events. The event data has follwing four fields:
EnOcean binary sensors only generate 'button_pressed' events. The event data has following four fields:
- **id**: The ID of the device (see configuration).
- **pushed**: `1` for a button press, `0` for a button release.

2
source/_components/binary_sensor.flic.markdown
View File

@ -62,7 +62,7 @@ automation:
Event data:
- **button_name**: The name of the button, that triggered the event.
- **button_address**: The bluetooth address of the button, that triggered the event.
- **button_address**: The Bluetooth address of the button, that triggered the event.
- **click_type**: The type of click. Possible values are `single`, `double` and `hold`.
- **queued_time**: The amount of time this event was queued on the button, in seconds.

2
source/_components/binary_sensor.hikvision.markdown
View File

@ -24,7 +24,7 @@ binary_sensor.front_porch_motion
binary_sensor.front_port_line_crossing
```
When used with a NVR device the sensors will be appeneded with the channel number they represent. For example, if you configure an NVR with the name "Home" that supports 2 cameras with motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:
When used with a NVR device the sensors will be appended with the channel number they represent. For example, if you configure an NVR with the name "Home" that supports 2 cameras with motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:
```
binary_sensor.home_motion_1

2
source/_components/binary_sensor.mystrom.markdown
View File

@ -40,7 +40,7 @@ binary_sensor:
You need to configure every button to make it work with Home Assistant. First connect the Wifi Buttons to your wireless network. Keep in mind that they only support WPS (Wi-FI Protected Setup). Once a button is connected you have three minutes to set the actions for the push patterns. The fastest way is to use `curl`. Check the [documentation](https://mystrom.ch/wp-content/uploads/REST_API_WBP.txt) of the WiFi Button for further details about the implementation (`http://` is replaced by `get://` or `post://`). `action` is the name of the corresponding push pattern (see above).
The endpoint that is recieving the data is `[IP address Home Assistant]:8123/api/mystrom`.
The endpoint that is receiving the data is `[IP address Home Assistant]:8123/api/mystrom`.
```bash
$ curl -d "[action]=get://[IP address Home Assistant]:8123/api/mystrom?[action]%3D[ID of the button]" http://[IP address of the button]/api/v1/device/[MAC address of the button]

2
source/_components/binary_sensor.pilight.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.44
ha_iot_class: "Local Polling"
---
The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happend (for example lots of cheap PIR motion detector).
The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector).
To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file:

4
source/_components/binary_sensor.rfxtrx.markdown
View File

@ -25,7 +25,7 @@ binary_sensor:
automatic_add: True
```
Open your local home-assistant web UI and go to the "states" page. Then make sure to trigger your sensor. You should see a new entity appear in the *Current entites* list, starting with "binary_sensor." and some hexadecimal digits. Those hexadecimal digits are your device id.
Open your local home-assistant web UI and go to the "states" page. Then make sure to trigger your sensor. You should see a new entity appear in the *Current entities* list, starting with "binary_sensor." and some hexadecimal digits. Those hexadecimal digits are your device id.
For example: "binary_sensor.0913000022670e013b70". Here your device id is `0913000022670e013b70`. Then you should update your configuration to:
@ -70,7 +70,7 @@ binary_sensor:
## Options for PT-2262 devices under the Lighting4 protocol
When a data packet is transmitted by a PT-2262 device using the Lighting4 protocol, there is no way to automatically extract the device identifier and the command from the packet. Each device has its own id/command length combination and the fields lengths are not included in the data. One device that sends 2 different commands will be seen as 2 devices on Home Assistant. For sur cases, the following options are available in order to circumvent the problem:
When a data packet is transmitted by a PT-2262 device using the Lighting4 protocol, there is no way to automatically extract the device identifier and the command from the packet. Each device has its own id/command length combination and the fields lengths are not included in the data. One device that sends 2 different commands will be seen as 2 devices on Home Assistant. For such cases, the following options are available in order to circumvent the problem:
- **data_bits** (*Optional*): Defines how many bits are used for commands inside the data packets sent by the device.
- **command_on** (*Optional*): Defines the data bits value that is sent by the device upon an 'On' command.

2
source/_components/binary_sensor.ring.markdown
View File

@ -29,6 +29,6 @@ Configuration variables:
- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored.
- **ding**: Return a boolean value when the doorbell button was pressed.
- **motion**: Return a boolean value when a moviment was detected by the Ring doorbell.
- **motion**: Return a boolean value when a movement was detected by the Ring doorbell.
Currently only doorbells are supported by this sensor.

17
source/_components/binary_sensor.template.markdown
View File

@ -56,11 +56,11 @@ binary_sensor:
description: Defines a template to set the state of the sensor.
required: true
type: template
on_delay:
delay_on:
description: The amount of time the template state must be ***met*** before this sensor will switch to `on`.
required: false
type: time
off_delay:
delay_off:
description: The amount of time the template state must be ***not met*** before this sensor will switch to `off`.
required: false
type: time
@ -164,7 +164,7 @@ binary_sensor:
sensors:
washing_machine:
friendly_name: "Washing Machine"
off_delay:
delay_off:
minutes: 5
value_template: >-
{{ states('sensor.washing_machine_power')|float > 0 }}
@ -173,12 +173,11 @@ binary_sensor:
### {% linkable_title Is Anyone Home? %}
This example is determining if anyone is home based on the combination
of device tracking and motion sensors. It's extremely useful if you
have kids/baby sitter/grand parents who might still be in your
house that aren't represented by a trackable device in home
assistant. This is providing a composite of WiFi based device tracking
and Z-Wave multisensor presence sensors.
This example is determining if anyone is home based on the combination of device
tracking and motion sensors. It's extremely useful if you have kids/baby sitter/
grand parents who might still be in your house that aren't represented by a
trackable device in Home Assistant. This is providing a composite of WiFi based
device tracking and Z-Wave multisensor presence sensors.
{% raw %}
```yaml

2
source/_components/binary_sensor.velbus.markdown
View File

@ -37,6 +37,6 @@ Configuration variables:
- **name** (*Required*): Name of the binary sensor.
- **module** (*Required*): The hexadecimal module address
- **channel** (*Required*): The channel number in the module.
- **is_pushbutton** (*Optional*): Booelan to indicate if a wall switch is a push button or not (default: false)
- **is_pushbutton** (*Optional*): Boolean to indicate if a wall switch is a push button or not (default: false)
For hub configuration, see [the Velbus component](/components/velbus/).

2
source/_components/binary_sensor.wink.markdown
View File

@ -34,6 +34,6 @@ The requirement is that you have setup [Wink](/components/wink/).
- Dropcam sensors
<p class='note'>
The above devices are confimed to work, but others may work as well.
The above devices are confirmed to work, but others may work as well.
</p>

2
source/_components/binary_sensor.workday.markdown
View File

@ -18,7 +18,7 @@ The `workday` binary sensor indicates, whether the current day is a workday or n
To enable the `workday` sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuation.yaml entry
# Example configuration.yaml entry
binary_sensor:
- platform: workday
country: DE

2
source/_components/camera.generic.markdown
View File

@ -34,7 +34,7 @@ Configuration variables:
- **username** (*Optional*): The username for accessing your camera.
- **password** (*Optional*): The password for accessing your camera.
- **authentication** (*Optional*): Type for authenticating the requests `basic` (default) or `digest`.
- **limit_refetch_to_url_change** (*Optional*): True/false value (default: false). Limits refetching of the remote image to when the URL changes. Only relevant if using a template to fetch the remote image.
- **limit_refetch_to_url_change** (*Optional*): True/false value (default: false). Limits re-fetching of the remote image to when the URL changes. Only relevant if using a template to fetch the remote image.
- **content_type** (*Optional*): Set the content type for the IP camera if it is not a jpg file (default: `image/jpeg`). Use `image/svg+xml` to add a dynamic svg file.
<p class='img'>

2
source/_components/camera.mjpeg.markdown
View File

@ -28,7 +28,7 @@ camera:
Configuration variables:
- **mjpeg_url** (*Required*): The URL your camera serves the video on, eg. http://192.168.1.21:2112/
- **still_image_url** (*Optional*): The URL for thumbmail picture if camera support that.
- **still_image_url** (*Optional*): The URL for thumbnail picture if camera support that.
- **name** (*Optional*): This parameter allows you to override the name of your camera.
- **username** (*Optional*): The username for accessing your camera.
- **password** (*Optional*): The password for accessing your camera.

2
source/_components/camera.synology.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Synology Camera"
description: "Instructions how to integrate Synolog Surveillance Station cameras within Home Assistant."
description: "Instructions how to integrate Synology Surveillance Station cameras within Home Assistant."
date: 2016-10-13 08:01
sidebar: true
comments: false

6
source/_components/climate.ecobee.markdown
View File

@ -87,7 +87,7 @@ Returns the current temperature measured by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Currenly measured temperature
| Integer | Currently measured temperature
### {% linkable_title Attribute `target_temperature` %}
@ -171,7 +171,7 @@ is returned as the user-visible name (rather than the internally used name).
### {% linkable_title Attribute `fan_min_on_time` %}
Returns the current fan mimimum on time.
Returns the current fan minimum on time.
| Attribute type | Description |
| ---------------| ----------- |
@ -234,7 +234,7 @@ Turns the away mode on or off for the thermostat.
### {% linkable_title Service `set_hold_mode` %}
Puts the thermostat into the given hold mode. For 'home', 'away', 'sleep',
and ony other hold based on a reference climate, the
and any other hold based on a reference climate, the
target temperature is taken from the reference climate.
For 'temp', the current temperature is taken as the target temperature.
When None is provided as parameter, the hold_mode is turned off.

2
source/_components/climate.eq3btsmart.markdown
View File

@ -19,7 +19,7 @@ As the device doesn't contain a temperature sensor ([read more](https://forum.fh
we report target temperature also as current one.
### Testing the connectivity ###
Before configuring Home Assistant you should check that connectivity with the thermostat is working, which can can be done with the eq3cli tool:
Before configuring Home Assistant you should check that connectivity with the thermostat is working, which can be done with the eq3cli tool:
```bash
eq3cli --mac 00:11:22:33:44:55

4
source/_components/climate.knx.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "KNX Climate"
description: "Instructions on how to integrate KXN thermostats with Home Assistant."
description: "Instructions on how to integrate KNX thermostats with Home Assistant."
date: 2016-06-24 12:00
sidebar: true
comments: false
@ -56,7 +56,7 @@ climate:
* **controller_status_state_address** (*Optional*) Explicit KNX address for reading HVAC controller status
* **operation_mode_frost_protection_address** (*Optional*) KNX address for switching on/off frost/heat protection mode.
* **operation_mode_night_address** (*Optional*) KNX address for switching on/off night nmode.
* **operation_mode_night_address** (*Optional*) KNX address for switching on/off night mode.
* **operation_mode_comfort_address** (*Optional*) KNX address for switching on/off comfort mode.
`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` was specified.

2
source/_components/climate.proliphix.markdown
View File

@ -36,6 +36,6 @@ Configuration variables:
- **username** (*Required*): Username for the thermostat.
- **password** (*Required*): Password for the thermostat.
The Proliphix NT Thermostat series are ethernet connected thermostats. They have a local HTTP interface that is based on get/set
The Proliphix NT Thermostat series are Ethernet connected thermostats. They have a local HTTP interface that is based on get/set
of OID values. A complete collection of the API is available in this [API documentation](https://github.com/sdague/thermostat.rb/blob/master/docs/PDP_API_R1_11.pdf).

2
source/_components/climate.sensibo.markdown
View File

@ -27,7 +27,7 @@ climate:
Configuration variables:
- **api_key** (*Required*): Your API key.
- **id** (*Optional*): A unit ID or a list of IDs. If none specified then all units acessible by the `api_key` will be used.
- **id** (*Optional*): A unit ID or a list of IDs. If none specified then all units accessible by the `api_key` will be used.
To get your API key visit <https://home.sensibo.com/me/api>

2
source/_components/climate.wink.markdown
View File

@ -31,6 +31,6 @@ The requirement is that you have setup [Wink](/components/wink/).
- Rheem Econet water heaters (No Wink hub required)
<p class='note'>
The above devices are confimed to work, but others may work as well.
The above devices are confirmed to work, but others may work as well.
</p>

2
source/_components/cover.knx.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "KNX Cover"
description: "Instructions on how to integrate KXN covers with Home Assistant."
description: "Instructions on how to integrate KNX covers with Home Assistant."
date: 2017-06-18 12:00
sidebar: true
comments: false

2
source/_components/cover.mqtt.markdown
View File

@ -60,7 +60,7 @@ Configuration variables:
- **tilt_max** (*Optional*): The maximum tilt value. Default is `100`
- **tilt_closed_value** (*Optional*): The value that will be sent on a `close_cover_tilt` command. Default is `0`
- **tilt_opened_value** (*Optional*): The value that will be sent on an `open_cover_tilt` command. Default is `100`
- **tilt_status_optimistic** (*Optional*): Flag that determines if tilt works in optimistic mode. Default is `true` if `tilt_status_topic` is not deinfed, else `false`
- **tilt_status_optimistic** (*Optional*): Flag that determines if tilt works in optimistic mode. Default is `true` if `tilt_status_topic` is not defined, else `false`
- **tilt_invert_state** (*Optional*): Flag that determines if open/close are flipped; higher values toward closed and lower values toward open. Default is `False`
## {% linkable_title Examples %}

2
source/_components/cover.wink.markdown
View File

@ -31,6 +31,6 @@ The requirement is that you have setup [Wink](/components/wink/).
- Chamberlain (Limited functionality) (No Wink hub required)
<p class='note'>
The above devices are confimed to work, but others may work as well.
The above devices are confirmed to work, but others may work as well.
</p>

6
source/_components/device_tracker.bluetooth_le_tracker.markdown
View File

@ -17,7 +17,7 @@ ha_release: 0.27
We have received <a href='https://github.com/home-assistant/home-assistant/issues/4442'>numerous reports</a> that this integration will have a big impact on the performance of the server.
</p>
This tracker discovers new devices on boot and in regular intervals and tracks bluetooth low-energy devices periodically based on interval_seconds value. It is not required to pair the devices with each other.
This tracker discovers new devices on boot and in regular intervals and tracks Bluetooth low-energy devices periodically based on interval_seconds value. It is not required to pair the devices with each other.
Devices discovered are stored with 'BLE_' as the prefix for device mac addresses in `known_devices.yaml`.
@ -42,12 +42,12 @@ device_tracker:
Configuration variables:
- **device_id** (*Optional*): The device ID for the bluetooth device to be used for tracking. Defaults to `hci0`.
- **device_id** (*Optional*): The device ID for the Bluetooth device to be used for tracking. Defaults to `hci0`.
As some BT LE devices change their MAC address regularly, a new device is only discovered when it has been seen 5 times.
Some BTLE devices (e.g. fitness trackers) are only visible to the devices that they are paired with. In this case, the BTLE tracker won't see this device.
For running Home Assistant as non root user we can give python3 the missing capabilities to access the bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information).
For running Home Assistant as non root user we can give python3 the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information).
```bash
$ sudo apt-get install libcap2-bin

4
source/_components/device_tracker.bluetooth_tracker.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Bluetooth Tracker"
description: "Instructions for integrating bluetooth tracking within Home Assistant."
description: "Instructions for integrating Bluetooth tracking within Home Assistant."
date: 2016-04-10 17:24
sidebar: true
comments: false
@ -16,7 +16,7 @@ ha_release: 0.18
This tracker discovers new devices on boot and tracks Bluetooth devices periodically based on `interval_seconds` value. It is not required to pair the devices with each other! Devices discovered are stored with 'bt_' as the prefix for device MAC addresses in `known_devices.yaml`.
<p class='note'>
[Hass.io](/hassio/) only supports bluetooth on Raspberry Pi 3 via the Bluetooth BCM43xx (/addons/bluetooth_bcm43xx/) addon. [Hass.io](/hassio/) doesn't support external Bluetooth dongles.
[Hass.io](/hassio/) only supports Bluetooth on Raspberry Pi 3 via the Bluetooth BCM43xx (/addons/bluetooth_bcm43xx/) addon. [Hass.io](/hassio/) doesn't support external Bluetooth dongles.
</p>
To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:

2
source/_components/device_tracker.mysensors.markdown
View File

@ -47,7 +47,7 @@ For more information, visit the [serial api] of MySensors.
#define SN "GPS Sensor"
#define SV "1.0"
// GPS position send interval (in millisectonds)
// GPS position send interval (in milliseconds)
#define GPS_SEND_INTERVAL 30000
// The child id used for the gps sensor
#define CHILD_ID_GPS 1

2
source/_components/device_tracker.nmap_tracker.markdown
View File

@ -18,7 +18,7 @@ As an alternative to the router-based device tracking, it is possible to directl
If you're on Debian or Ubuntu, you might have to install the packages for `arp` and `nmap`. Do so by running `$ sudo apt-get install net-tools nmap`. On a Fedora host run `$ sudo dnf -y install nmap`.
<p class='note'>
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fullfilled.
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
</p>
Host detection is done via Nmap's "fast scan" (`-F`) of the most frequently used 100 ports, with a host timeout of 5 seconds.

6
source/_components/device_tracker.owntracks.markdown
View File

@ -31,7 +31,7 @@ Configuration variables:
- **max_gps_accuracy** (*Optional*): Sometimes Owntracks can report GPS location with a very low accuracy (few kilometers). That can trigger false zoning in your Home Assistant installation. With the parameter, you can filter these GPS reports. The number has to be in meter. For example, if you put 200 only GPS report with an accuracy under 200 will be take in account.
- **waypoints** (*Optional*): Owntracks users can define [waypoints](http://owntracks.org/booklet/features/waypoints/) (a.k.a regions) which are similar in spirit to Home Assistant zones. If this configuration variable is `True`, the Owntracks users who are in `waypoint_whitelist` can export waypoints from the device and Home Assistant will import them as zone definitions. Defaults to `True`.
- **waypoint_whitelist** (*Optional*): A list of user names (as defined for [Owntracks](/components/device_tracker.owntracks/)) who can export their waypoints from Owntracks to Home Assistant. Defaults to all users who are connected to Home Assistant via Owntracks.
- **secret** (*Optional*): [Payload encryption key](http://owntracks.org/booklet/features/encrypt/). This is usable when communicating with a third-party untrusted server or a public server (where anybody can subscribe to any topic). By default the payload is assumed to be unecrypted (although the comunication between Home Assistant and the server might still be encrypted). This feature requires the `libsodium` library to be present.
- **secret** (*Optional*): [Payload encryption key](http://owntracks.org/booklet/features/encrypt/). This is usable when communicating with a third-party untrusted server or a public server (where anybody can subscribe to any topic). By default the payload is assumed to be unencrypted (although the communication between Home Assistant and the server might still be encrypted). This feature requires the `libsodium` library to be present.
A full sample configuration for the `owntracks` platform is shown below:
@ -71,13 +71,13 @@ When you exit a zone, Home Assistant will start using location updates to track
### {% linkable_title Using Owntracks regions - forcing Owntracks to update using %}iBeacons
When run in the usual *significant changes mode* (which is kind to your phone battery), Owntracks sometimes doesn't update your location as quickly as you'd like when you arrive at a zone. This can be annoying if you want to trigger an automation when you get home. You can improve the situation using iBeacons.
iBeacons are simple bluetooth devices that send out an "I'm here" message. They are supported by IOS and some Android devices. Owntracks explain more [here](http://owntracks.org/booklet/guide/beacons/).
iBeacons are simple Bluetooth devices that send out an "I'm here" message. They are supported by IOS and some Android devices. Owntracks explain more [here](http://owntracks.org/booklet/guide/beacons/).
When you enter an iBeacon region, Owntracks will send a `region enter` message to HA as described above. So if you want to have an event triggered when you arrive home, you can put an iBeacon outside your front door. If you set up an OwnTracks iBeacon region called `home` then getting close to the beacon will trigger an update to HA that will set your zone to be `home`.
When you exit an iBeacon region HA will switch back to using GPS to determine your location. Depending on the size of your zone, and the accuracy of your GPS location this may change your HA zone.
Sometimes Owntracks will lose connection with an iBeacon for a few seconds. If you name your beacon starting with `-` Owntracks will wait longer before deciding it has exited the beacon zone. HA will ignore the `-` when it matches the Owntracks region with Zones. So if you call your Owntracks region `-home` then HA will recognise it as `home`, but you will have a more stable iBeacon connection.
Sometimes Owntracks will lose connection with an iBeacon for a few seconds. If you name your beacon starting with `-` Owntracks will wait longer before deciding it has exited the beacon zone. HA will ignore the `-` when it matches the Owntracks region with Zones. So if you call your Owntracks region `-home` then HA will recognize it as `home`, but you will have a more stable iBeacon connection.
### {% linkable_title Using Owntracks iBeacons to track devices %}
iBeacons don't need to be stationary. You could put one on your key ring, or in your car.

4
source/_components/device_tracker.snmp.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.7.5
---
A lot WiFi access points and WiFi routers support the Simple Network Management Protocol (SNMP). This is a standardized method for monitoring/manageing network connected devices. SNMP uses a tree-like hierarchy where each node is an object. Many of these objects contain (live) lists of insances and metrics, like network interfaces, disks, and wifi registrations.
A lot WiFi access points and WiFi routers support the Simple Network Management Protocol (SNMP). This is a standardized method for monitoring/manageing network connected devices. SNMP uses a tree-like hierarchy where each node is an object. Many of these objects contain (live) lists of instances and metrics, like network interfaces, disks, and WiFi registrations.
<p class='note warning'>
This device tracker needs SNMP to be enabled on the router. It could be that you need to install the SNMP support manually.
@ -61,7 +61,7 @@ device_tracker:
Configuration variables:
- **host** (*Required*): The IP address of the router, eg. 192.168.1.1.
- **community** (*Required*): The SNMP community which is set for the device. Most devices have a default community set to to `public` with read-only permission (which is sufficient).
- **community** (*Required*): The SNMP community which is set for the device. Most devices have a default community set to `public` with read-only permission (which is sufficient).
- **baseoid** (*Required*): The OID prefix where wireless client registrations can be found, usually vendor specific. It's advised to use the numerical notation. To find this base OID, check vendor documentation or check the MIB file for your device.
- **authkey** (*Inclusive*): Authentication key for SNMPv3. Variable privkey must also be set.
- **privkey** (*Inclusive*): Privacy key SNMPv3. Variable authkey must also be set.

2
source/_components/device_tracker.trackr.markdown
View File

@ -16,7 +16,7 @@ ha_iot_class: "Cloud Polling"
The `trackr` platform allows you to detect presence using [TrackR](https://www.thetrackr.com/) devices.
The offical TrackR mobile app handles the tracking of the TrackR devices using your phones bluetooth and GPS.
The official TrackR mobile app handles the tracking of the TrackR devices using your phones Bluetooth and GPS.
To integrate TrackR in Home Assistant, add the following section to your `configuration.yaml` file:

2
source/_components/downloader.markdown
View File

@ -28,7 +28,7 @@ Configuration variables:
### {% linkable_title Use the service %}
Go the the "Developer Tools", then to "Call Service", and choose `downloader/download_file` from the list of available services. Fill the "Service Data" field as shown in the example below and hit "CALL SERVICE".
Go to the "Developer Tools", then to "Call Service", and choose `downloader/download_file` from the list of available services. Fill the "Service Data" field as shown in the example below and hit "CALL SERVICE".
```json
{"url":"http://domain.tld/path/to/file"}

2
source/_components/ecobee.markdown
View File

@ -42,7 +42,7 @@ The PIN can be found from the Home Assistant portal on the Ecobee card or from t
- 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.
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 pop-up 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:

4
source/_components/emulated_hue.markdown
View File

@ -17,6 +17,10 @@ The `emulated_hue` component provides a virtual Philips Hue bridge, written enti
entities. The driving use case behind this functionality is to allow Home Assistant to work with an Amazon Echo or Google Home with no set up cost outside of configuration changes.
The virtual bridge has the ability to turn entities on or off, or change the brightness of dimmable lights. The volume level of media players can be controlled as brightness.
<p class='note'>
A physical Hue Bridge is required for the lights to function - this virtual bridge will not replace a physical bridge.
</p>
<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 addresses, 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>

4
source/_components/foursquare.markdown
View File

@ -46,7 +46,7 @@ After that, you will get redirected to your `REDIRECT_URL` with the `access_toke
The component accepts pushes from Foursquare at `/api/foursquare`. The route does not require authentication.
Foursquare checkin events can be used out of the box to trigger automation actions, e.g.:
Foursquare check-in events can be used out of the box to trigger automation actions, e.g.:
```yaml
automation:
@ -69,7 +69,7 @@ Parameters:
- **eventId** (*Optional*): The event the user is checking in to.
- **shout** (*Optional*): A message about your check-in. The maximum length of this field is 140 characters.
- **mentions** (*Optional*): Mentions in your check-in. This parameter is a semicolon-delimited list of mentions. A single mention is of the form "start,end,userid", where start is the index of the first character in the shout representing the mention, end is the index of the first character in the shout after the mention, and userid is the userid of the user being mentioned. If userid is prefixed with "fbu-", this indicates a Facebook userid that is being mention. Character indices in shouts are 0-based.
- **broadcast** (*Optional*): "Who to broadcast this check-in to. Accepts a comma-delimited list of values: private (off the grid) or public (share with friends), facebook share on facebook, twitter share on twitter, followers share with followers (celebrity mode users only), If no valid value is found, the default is public."
- **broadcast** (*Optional*): "Who to broadcast this check-in to. Accepts a comma-delimited list of values: private (off the grid) or public (share with friends), Facebook share on Facebook, twitter share on twitter, followers share with followers (celebrity mode users only), If no valid value is found, the default is public."
- **ll** (*Optional*): Latitude and longitude of the user's location. Only specify this field if you have a GPS or other device reported location for the user at the time of check-in.
- **llAcc** (*Optional*): Accuracy of the user's latitude and longitude, in meters.
- **alt** (*Optional*): Altitude of the user's location, in meters.

4
source/_components/hdmi_cec.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.23
ha_iot_class: "Local Push"
---
The `hdmi_cec` component provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entites for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as Soundbars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers.
The `hdmi_cec` component provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers.
## {% linkable_title CEC Setup %}
@ -26,7 +26,7 @@ The computer running Home Assistant must support CEC, and of course be connected
[libcec](https://github.com/Pulse-Eight/libcec) must be installed for this component to work. Follow the installation instructions for your environment, provided at the link. `libcec` installs Python 3 bindings by default as a system Python module. If you are running Home Assistant in a [Python virtual environment](/getting-started/installation-virtualenv/), make sure it can access the system module, by either symlinking it or using the `--system-site-packages` flag.
<p class='note'>
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fullfilled.
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
</p>
#### {% linkable_title Symlinking into virtual environment %}

4
source/_components/homematic.markdown
View File

@ -35,7 +35,7 @@ homematic:
Configuration variables (global):
- **hosts** (*Required*): Configuration for each host to integrate into Home Assistant.
- **local_ip** (*Optional*): IP of device running Home Assistant. Override autodetected value for exotic network setups.
- **local_ip** (*Optional*): IP of device running Home Assistant. Override auto-detected value for exotic network setups.
- **local_port** (*Optional*): Port for connection with Home Assistant. By default it is randomly assigned.
Configuration variables (host):
@ -87,7 +87,7 @@ Resolving names can take some time. So when you start Home Assistant you won't s
In order to allow communication with multiple hosts or different protocols in parallel (wireless, wired and ip), multiple connections will be established, each to the configured destination. The name you choose for the host has to be unique and limited to ASCII letters.
Using multiple hosts has the drawback, that the services (explained below) may not work as expected. Only one connection can be used for services, which limits the devices/variables a service can use to the scope/protocol of the host.
This does *not* affect the entites in Home Assistant. They all use their own connection and work as expected.
This does *not* affect the entities in Home Assistant. They all use their own connection and work as expected.
### {% linkable_title Reading attributes of entities %}

4
source/_components/http.markdown
View File

@ -26,7 +26,7 @@ http:
Configuration variables:
- **api_password** (*Optional*): Protect Home Assistant with a password.
- **server_host** (*Optional*): Only listen to incoming requests on specific ip/host (default: accept all)
- **server_host** (*Optional*): Only listen to incoming requests on specific IP/host (default: accept all)
- **server_port** (*Optional*): Let you set a port to use. Defaults to 8123.
- **base_url** (*Optional*): The URL that Home Assistant is available on the internet. For example: `hass-example.duckdns.org:8123`. Defaults to local IP address. The IOS app finds local installations, if you have an outside URL use this so that you can auto fill when discovered in the app.
- **development** (*Optional*): Disable caching and load unvulcanized assets. Useful for Frontend development.
@ -36,7 +36,7 @@ Configuration variables:
- **use_x_forwarded_for** (*Optional*): Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You should only enable this in a trustworthy network environment, as clients passing that header could easily spoof their source IP address. Defaults to False.
- **trusted_networks** (*Optional*): List of trusted networks, consisting of IP addresses or networks, that are allowed to bypass password protection when accessing Home Assistant. It should be noted that if you use a reverse proxy, all requests to home assistant, regardless of source, will arrive from the reverse proxy IP address. Therefore in a reverse proxy scenario this option should be used with extreme care.
- **ip_ban_enabled** (*Optional*): Flag indicating whether additional IP filtering is enabled. Defaults to False.
- **login_attempts_threshold** (*Optional*): Number of failed login attemt from single IP after which it will be automatically banned if `ip_ban_enabled` is True. Defaults to -1, meaning that no new automatic bans will be added.
- **login_attempts_threshold** (*Optional*): Number of failed login attempt from single IP after which it will be automatically banned if `ip_ban_enabled` is True. Defaults to -1, meaning that no new automatic bans will be added.
The sample below shows a configuration entry with possible values:

2
source/_components/ifttt.manything.markdown
View File

@ -11,7 +11,7 @@ logo: manything.png
ha_category: Camera
---
[Manything](https://manything.com) is a smart app that turns your Android device, iPhone, iPod, or iPad into a wifi camera for monitoring your home, your pets, anything! Comes with live streaming, motion activated alerts, cloud video recording, and more.
[Manything](https://manything.com) is a smart app that turns your Android device, iPhone, iPod, or iPad into a WiFi camera for monitoring your home, your pets, anything! Comes with live streaming, motion activated alerts, cloud video recording, and more.
To get manything support, HA will use IFTTT's [Maker Channel](https://ifttt.com/maker) and the [ManyThing Channel](https://ifttt.com/manything). Use the [IFTTT Setup instructions](/components/ifttt/) to activate the IFTTT Platform.

2
source/_components/image_processing.openalpr_local.markdown
View File

@ -22,7 +22,7 @@ For using inside automation look on [component](/components/image_processing) pa
If you want process all data locally, you need version 2.3.1 or higher of the `alpr` commandline tool.
If you don't find binaries for your distribution you can compile from source. Documention of how to build OpenALPR is found [here](https://github.com/openalpr/openalpr/wiki).
If you don't find binaries for your distribution you can compile from source. Documentation of how to build OpenALPR is found [here](https://github.com/openalpr/openalpr/wiki).
On a Debian system you can use this `cmake` command to build only the command line tool:

8
source/_components/image_processing.seven_segments.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Seven segments display"
description: "Instructions how to use OCR for seven segemnts displays into Home Assistant."
description: "Instructions how to use OCR for seven segments displays into Home Assistant."
date: 2017-05-18 08:00
sidebar: true
comments: false
@ -18,7 +18,7 @@ ha_iot_class: "Local Polling"
The `seven_segments` image processing platform allows you to read physical seven segments displays through Home Assistant. [`ssocr`](https://www.unix-ag.uni-kl.de/~auerswal/ssocr/) is used to extract the value shown on the display which is observed by a [camera](/components/camera/).
<p class='note'>
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fullfilled.
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
</p>
`ssocr` needs to be available on your system. Check the installation instruction below:
@ -34,7 +34,7 @@ $ sudo make PREFIX=/usr install # On most systems
$ make deb # (Optional) This allows you to make a deb so that you apt is aware of ssocr
```
To enable the OCR of a seven segement display in your installation, add the following to your `configuration.yaml` file:
To enable the OCR of a seven segment display in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -98,7 +98,7 @@ sensor:
- platform: template
sensors:
power_meter:
value_template: '{{ states.image_processing.sevensegement_ocr_seven_segments.state }}'
value_template: '{{ states.image_processing.sevensegment_ocr_seven_segments.state }}'
friendly_name: 'Ampere'
unit_of_measurement: 'A'
```

2
source/_components/influxdb.markdown
View File

@ -109,7 +109,7 @@ optional arguments:
If you want to import all the recorded data from your recorder database you can use the data import script.
It will read all your state_change events from the database and add them as data-points to the InfluxDB.
You can specify the source database either by pointing the `--config` option to the config directory which includes the default sqlite database or by giving a sqlalchemy connection URI with `--uri`.
You can specify the source database either by pointing the `--config` option to the config directory which includes the default SQLite database or by giving a sqlalchemy connection URI with `--uri`.
The writing to InfluxDB is done in batches that can be changed with `--step`.
You can control, which data is imported by using the command line options `--exclude_entities` and `--exclude_domains`.

2
source/_components/insteon_plm.markdown
View File

@ -63,7 +63,7 @@ unambiguous, but sometimes the component will not be able to guess the actual
usage of the device. For example, there might be a table lamp plugged into an
INSTEON appliance relay module. By default, this will show as a 'switch'
device in Home Assistant, but it really should be a 'light' device. For
exceptions like this, the component supports a device plaform override. You
exceptions like this, the component supports a device platform override. You
can set any device (by address) to explicitly use a specific platform if the
default is not correct.

2
source/_components/joaoapps_join.markdown
View File

@ -13,7 +13,7 @@ ha_release: "0.24"
---
The Join platform exposes services from [Join](http://joaoapps.com/join). In Home Assistant, the Join features are divided up in two locations, the Join component, and the Join notify platform. The notify platform allows us to send messages to Join devices, the the component allows us to access the other special features that Join offers.
The Join platform exposes services from [Join](http://joaoapps.com/join). In Home Assistant, the Join features are divided up in two locations, the Join component, and the Join notify platform. The notify platform allows us to send messages to Join devices, the component allows us to access the other special features that Join offers.
In the `configuration.yaml` file you need to provide the api key and device id or name of the target device. You can find your device id and api key [here](https://joinjoaomgcd.appspot.com/).

2
source/_components/keyboard_remote.markdown
View File

@ -69,7 +69,7 @@ automation:
```
## {% linkable_title Disconnections %}
This component manages disconnections and re-connections of the keyboard, for example in the case of a bluetooth device that turns off automatically to preserve battery.
This component manages disconnections and re-connections of the keyboard, for example in the case of a Bluetooth device that turns off automatically to preserve battery.
If the keyboard disconnects, the component will fire an event `keyboard_remote_disconnected`.
When the keyboard reconnects, an event `keyboard_remote_connected` will be fired.

2
source/_components/knx.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "KNX"
description: "Instructions on how to integrate KXN components with Home Assistant."
description: "Instructions on how to integrate KNX components with Home Assistant."
date: 2016-06-08 12:00
sidebar: true
comments: false

2
source/_components/light.avion.markdown
View File

@ -29,7 +29,7 @@ Configuration variables:
- **username** (*Optional*): The username used in the Avion app. If username and password are both provided, any associated switches will automatically be added to your configuration.
- **password** (*Optional*): The password used in the Avion app.
- **devices** (*Optional*): An optional list of devices with their bluetooth address, a custom name to use in the frontend and the API key. The API key can be obtained by executing the following command:
- **devices** (*Optional*): An optional list of devices with their Bluetooth address, a custom name to use in the frontend and the API key. The API key can be obtained by executing the following command:
```
curl -X POST -H "Content-Type: application/json" -d '{"email": "fakename@example.com", "password": "password"}' https://admin.avi-on.com/api/sessions | jq
```

6
source/_components/light.hue.markdown
View File

@ -58,9 +58,9 @@ light:
### {% linkable_title Using Hue Groups in Home Assistant %}
The Hue API allows you to group lights. Home Assistant also supports grouping of entities natively, but sometimes it can be usefull to use Hue Groups to group light bulbs. By doing so, Home Assistant only needs to send one API call to change the state of all the bulbs in those groups instead of one call for every light in the group. This causes all the bulbs to change state simultaniously.
The Hue API allows you to group lights. Home Assistant also supports grouping of entities natively, but sometimes it can be useful to use Hue Groups to group light bulbs. By doing so, Home Assistant only needs to send one API call to change the state of all the bulbs in those groups instead of one call for every light in the group. This causes all the bulbs to change state simultaneously.
These Hue Groups can be a `Luminaire`, `Lightsource`, `LightGroup` or `Room`. The `Luminaire` and `Lightsource` can't be created manually since the Hue bridge manages these automatically based on the discovered bulbs. The `Room` and `LightGroup` can be created manually through the API, or the mobile app. A bulb can only exist in one `Room`, but can exist in multiple `LightGroup`. The `LightGroup` can be usefull to link certain bulbs together since.
These Hue Groups can be a `Luminaire`, `Lightsource`, `LightGroup` or `Room`. The `Luminaire` and `Lightsource` can't be created manually since the Hue bridge manages these automatically based on the discovered bulbs. The `Room` and `LightGroup` can be created manually through the API, or the mobile app. A bulb can only exist in one `Room`, but can exist in multiple `LightGroup`. The `LightGroup` can be useful to link certain bulbs together since.
The 2nd generation Hue app only allows to create a `Room`. You need to use the first generation app or the API to create a `LightGroup`.
@ -129,4 +129,4 @@ The Hue API doesn't activate scenes directly, only on a Hue Group (typically roo
Neither group names or scene names are guaranteed unique in Hue. If you are getting non deterministic behavior, adjust your Hue scenes via the App to be more identifying.
The Hue hub has limitted spaces for scenes, and will delete scenes if new ones get created that would overflow that space. The API docs say this is based on "Least Recently Used".
The Hue hub has limited spaces for scenes, and will delete scenes if new ones get created that would overflow that space. The API docs say this is based on "Least Recently Used".

4
source/_components/light.knx.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "KNX Light"
description: "Instructions on how to integrate KXN lights with Home Assistant."
description: "Instructions on how to integrate KNX lights with Home Assistant."
date: 2016-06-24 12:00
sidebar: true
comments: false
@ -39,5 +39,5 @@ light:
* **state_address**: (*Optional*) separate KNX group address for retrieving the switch state of the light.
* **brightness_state_address**: (*Optional*) separate KNX group address for retrieving the dimmed state of the light.
Some KNX devices can change their state internally without any messages on the KXN bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object.
Some KNX devices can change their state internally without any messages on the KNX bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object.
For switching/light actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address.

4
source/_components/light.limitlessled.markdown
View File

@ -18,7 +18,7 @@ ha_release: pre 0.7
### {% linkable_title Setup %}
Before configuring Home Assistant, make sure you can control your bulbs or LEDs with the MiLight mobile application. Discover your bridge(s) IP address. You can do this via your router or a mobile application like Fing ([android](https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en) or [itunes](https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8)). Keep in mind that LimitlessLED bulbs are controlled via groups. You can not control an individual bulb via the bridge, unless it is in a group by itself. Note that you can assign an `rgbw`, `rgbww` and `white` group to the same group number, effectively allowing 12 groups (4 `rgbww`, 4 `rgbw` and 4 `white`) per bridge.
Before configuring Home Assistant, make sure you can control your bulbs or LEDs with the MiLight mobile application. Discover your bridge(s) IP address. You can do this via your router or a mobile application like Fing ([android](https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en) or [iTunes](https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8)). Keep in mind that LimitlessLED bulbs are controlled via groups. You can not control an individual bulb via the bridge, unless it is in a group by itself. Note that you can assign an `rgbw`, `rgbww` and `white` group to the same group number, effectively allowing 12 groups (4 `rgbww`, 4 `rgbw` and 4 `white`) per bridge.
To add `limitlessled` to your installation, add the following to your `configuration.yaml` file:
@ -71,7 +71,7 @@ Refer to the [light]({{site_root}}/components/light/) documentation for general
- *Color*: There are 256 color possibilities along the LimitlessLED color spectrum. Color properties like saturation and lightness can not be used - only Hue can. The only exception is white (which may be warm or cold depending on the type of RGBW bulb). If you select a color with saturation or lightness, Home Assistant will calculate the nearest valid LimitlessLED color.
- *Brightness*: Wifi bridge v6 supports 101 brightness steps; older versions only 25.
- **White**
- When using a legacy wifi bridge (before v6), you can observe on the MiLight mobile application, you can not select a specific brightness or temperature - you can only step each property up or down. There is no indication of which step you are on. This restriction, combined with the unreliable nature of LimitlessLED transmissions, means that setting white bulb properties is done on a best-effort basis. The only very reliable settings are the minimum and maximum of each property.
- When using a legacy WiFi bridge (before v6), you can observe on the MiLight mobile application, you can not select a specific brightness or temperature - you can only step each property up or down. There is no indication of which step you are on. This restriction, combined with the unreliable nature of LimitlessLED transmissions, means that setting white bulb properties is done on a best-effort basis. The only very reliable settings are the minimum and maximum of each property.
- *Temperature*: Wifi bridge v6 supports 101 temperature steps; older versions only 10.
- *Brightness*: Wifi bridge v6 supports 101 brightness steps; older versions only 10.
- **Transitions**

2
source/_components/light.rflink.markdown
View File

@ -80,7 +80,7 @@ light:
name: Bedroom Lamp
```
Any on/off command from any allias ID updates the current state of the light. However when sending a command through the frontend only the primary ID is used.
Any on/off command from any alias ID updates the current state of the light. However when sending a command through the frontend only the primary ID is used.
### {% linkable_title Light types %}

2
source/_components/light.wink.markdown
View File

@ -28,7 +28,7 @@ The requirement is that you have setup [Wink](/components/wink/).
- Wink light groups (User created groups of lights)
<p class='note'>
The above devices are confimed to work, but others may work as well.
The above devices are confirmed to work, but others may work as well.
</p>

2
source/_components/light.x10.markdown
View File

@ -31,5 +31,5 @@ light:
Configuration variables:
- **id** (*Required*): Device identifier. Composed of house code und unit id.
- **id** (*Required*): Device identifier. Composed of house code and unit id.
- **name** (*Optional*): A friendly name for the device. By default *id* from the device is used.

2
source/_components/light.xiaomi_miio.markdown
View File

@ -17,7 +17,7 @@ The `xiaomi_miio` platform allows you to control the state of your Xiaomi Philip
Currently, the supported features are `on`, `off`, `set_cct` (colortemp) , `set_bright` (brightness).
Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file.
Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file.
To add a Xiaomi Philips Light to your installation, add the following to your configuration.yaml file:

2
source/_components/light.yeelight.markdown
View File

@ -48,7 +48,7 @@ Per default the bulb limits the amount of requests per minute to 60, a limitatio
<p class='note'>
Before trying to control your light through Home Assistant, you have to setup your bulb using Yeelight app. ( [Android](https://play.google.com/store/apps/details?id=com.yeelight.cherry&hl=fr), [IOS](https://itunes.apple.com/us/app/yeelight/id977125608?mt=8) ).
In the bulb property, you have to enable "Developer Mode" Developer mode may only be available with the latest firmware installed on your bulb. Firmware can be updated in the application after connecting the bulb.
Determine your bulb ip (using router, software, ping ...)
Determine your bulb IP (using router, software, ping ...)
</p>
<p class='note warning'>

2
source/_components/lock.markdown
View File

@ -16,7 +16,7 @@ Keeps track which locks are in your environment, their state and allows you to c
### {% linkable_title Use the services %}
Go the the **Developer Tools**, then to **Call Service** in the frontend, and choose `lock/lock` or `lock/unlock` from the list of available services (**Available services:** on the left). Enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**.
Go to the **Developer Tools**, then to **Call Service** in the frontend, and choose `lock/lock` or `lock/unlock` from the list of available services (**Available services:** on the left). Enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**.
```json
{"entity_id":"lock.front_door"}

2
source/_components/media_player.anthemav.markdown
View File

@ -13,7 +13,7 @@ ha_iot_class: "Local Push"
ha_release: 0.37
---
Both [Anthem]'s current and last generation of A/V Receivers and and Processors support IP-based, network control. This Home Assistant platform adds proper "local push" support for any of these receivers on your network.
Both [Anthem]'s current and last generation of A/V Receivers and Processors support IP-based, network control. This Home Assistant platform adds proper "local push" support for any of these receivers on your network.
## {% linkable_title Supported Models %}

11
source/_components/media_player.clementine.markdown
View File

@ -16,8 +16,7 @@ ha_iot_class: "Local Polling"
The `clementine` platform allows you to control a [Clementine Music Player](https://www.clementine-player.org).
To add a Clementine Player to your Home Assistant installation, add the following to
your `configuration.yaml` file:
To add a Clementine Player to your Home Assistant installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -33,10 +32,8 @@ Configuration variables:
- **access_token** (*Optional*): The authorization code needed to connect.
- **name** (*Optional*): The name you would like to give to the Clementine player. The default is "Clementine Remote".
Remember that Clementine must be configured to accept connections through its
network remote control protocol.
Remember that Clementine must be configured to accept connections through its network remote control protocol.
You can configure this through Clementine `Tools > Preferences > Network remote control`
configuration menu. Enable `Use network remote control` and configure the other options
for your use case.
You can configure this through Clementine `Tools > Preferences > Network remote control` configuration menu. Enable `Use network remote control` and configure the other options for your use case.
This component does not implement the `play_media` service so you cannot add tracks to the playlist.

2
source/_components/media_player.directv.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.25
ha_iot_class: "Local Polling"
---
Master [DirecTV](http://www.directv.com/) receivers (ie: those that have tuners) will be automatically discovered if you enable the [discovery component](/components/discovery/) and the the receiver is powered-on. Slave/RVU client/Genie boxes will also be discovered, but only if they are also online at the time of discovery.
Master [DirecTV](http://www.directv.com/) receivers (ie: those that have tuners) will be automatically discovered if you enable the [discovery component](/components/discovery/) and the receiver is powered-on. Slave/RVU client/Genie boxes will also be discovered, but only if they are also online at the time of discovery.
To ensure that your DirecTV boxes are always found and configured, they should be added into your `configuration.yaml`.

2
source/_components/media_player.firetv.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "FireTV"
description: "Instructions how to integrate FIre-TV into Home Assistant."
description: "Instructions how to integrate Fire-TV into Home Assistant."
date: 2015-10-23 18:00
sidebar: true
comments: false

4
source/_components/media_player.kodi.markdown
View File

@ -164,7 +164,7 @@ media_player:
method: System.Shutdown
```
#### Turn on and off the TV with the Kodi JSON-CEC Addon
#### Turn on and off the TV with the Kodi JSON-CEC Add-on
For Kodi devices running 24/7 attached to a CEC capable TV (OSMC / OpenElec and systems alike running in Rasperry Pi's, for example), this configuration enables the optimal way to turn on/off the attached TV from Home Assistant while Kodi is always active and ready:
@ -246,4 +246,4 @@ script:
method: VideoLibrary.Scan
```
For a more complex usage of the `kodi_call_method` service, with event triggering of Kodi API results, you can have a look at this [example](/cookbook/kodi_dynamic_input_select/)
For a more complex usage of the `kodi_call_method` service, with event triggering of Kodi API results, you can have a look at this [example](/cookbook/automation_kodi_dynamic_input_select/)

2
source/_components/media_player.spotify.markdown
View File

@ -68,7 +68,7 @@ Configuration variables:
After the prerequisites and configuration are complete, restart Home Assistant. A **Spotify** configurator element will be available. Follow the instructions to authorize Home Assistant to access your Spotify account. A Spotify media player will then appear. If Spotify prompts you to download a file after completing authorization, discard the download. It is not needed.
## {% linkable_title Sources %}
The sources are based on if you have streamed to these devices before in Spotify. If you don't have any sources, then simply stream from your phone to another device in your house, bluetooth, echo, etc. Once you do the sources will show up in the developer console as a device to cast/stream to. Also know that the devices won't show up in the dev-console as sources unless they are powered on as well.
The sources are based on if you have streamed to these devices before in Spotify. If you don't have any sources, then simply stream from your phone to another device in your house, Bluetooth, echo, etc. Once you do the sources will show up in the developer console as a device to cast/stream to. Also know that the devices won't show up in the dev-console as sources unless they are powered on as well.
## {% linkable_title URI Links For Playlists/Etc %}
You can send playlists to spotify via the "media_content_type": "playlist" and "media_content_id": "spotify:user:spotify:playlist:37i9dQZF1DWSkkUxEhrBdF" which are a part of the media_player.play_media service, you can test this from the services control panel in the Home Assistant frontend.

2
source/_components/media_player.universal.markdown
View File

@ -60,7 +60,7 @@ It is recommended that the command *turn_on*, the command *turn_off*, and the at
It is also recommended that the command *volume_up*, the command *volume_down*, the command *volume_mute*, and the attribute *is_volume_muted* all be provided together. The attribute *is_volume_muted* should return either True or the on state when the volume is muted. The *volume_mute* service should toggle the mute setting.
When providing *select_source* as a command, it is recomended to also provide the attributes *source*, and *source_list*. The *source* attribute is the currently select source, while the *source_list* attribute is a list of all available sources.
When providing *select_source* as a command, it is recommended to also provide the attributes *source*, and *source_list*. The *source* attribute is the currently select source, while the *source_list* attribute is a list of all available sources.
Below is an example configuration.

2
source/_components/media_player.yamaha.markdown
View File

@ -41,7 +41,7 @@ A few notes:
- Not specifying the host variable will result in automatically searching your network for Yamaha Receivers. It will add a media player device for each one.
- For receivers that support more than one zone, Home Assistant will add one media player per zone supported by the player, named "$name Zone 2" and "$name Zone 3".
- In some cases, autodiscovery fails due to a known bug in the receiver's firmware. It is possible to manually specify the receiver's IP address or via it's hostname (if it is discoverably by your DNS) then.
- In some cases, auto-discovery fails due to a known bug in the receiver's firmware. It is possible to manually specify the receiver's IP address or via it's hostname (if it is discoverable by your DNS) then.
- Please note: If adding the IP address or hostname manually, you **must** enable network standby on your receiver, or else startup of Home Assistant will hang if you have your receiver switched off.
- Currently, this component supports powering on/off, mute, volume control and source selection. Playback controls, for instance play and stop are available for sources that supports it.

6
source/_components/mysensors.markdown
View File

@ -49,9 +49,9 @@ mysensors:
Configuration variables:
- **device** (*Required*): The path to the serial gateway where it is connected to your Home Assistant host, or the address of the tcp ethernet gateway, or `mqtt` to setup the MQTT gateway. Resolving DNS addresses is theoretically supported but not tested.
- **device** (*Required*): The path to the serial gateway where it is connected to your Home Assistant host, or the address of the TCP Ethernet gateway, or `mqtt` to setup the MQTT gateway. Resolving DNS addresses is theoretically supported but not tested.
- **baud_rate** (*Optional*): Specifies the baud rate of the connected serial gateway. Default is 115200.
- **tcp_port** (*Optional*): Specifies the port of the connected tcp ethernet gateway. Default is 5003.
- **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** (*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.
@ -88,7 +88,7 @@ The MQTT gateway requires MySensors version 2.0 and only the MQTT client gateway
Present a MySensors sensor or actuator, by following these steps:
1. Connect the serial gateway to your computer or the ethernet or MQTT gateway to your network.
1. Connect the serial gateway to your computer or the Ethernet or MQTT gateway to your network.
2. Configure the MySensors component in `configuration.yaml`.
3. Start hass.
4. Write and upload your MySensors sketch to the sensor. Make sure you:

2
source/_components/nest.markdown
View File

@ -25,7 +25,7 @@ The Nest component is the main component to integrate all [Nest](https://nest.co
5. Click "[Create New Product](https://developers.nest.com/products/new)"
6. Fill in details:
- Product name must be unique. We recommend [email] - Home Assistant.
- The description, users, urls can all be anything you want.
- The description, users, URLs can all be anything you want.
- Leave the "Redirect URI" Field blank
7. For permissions check every box and if it's an option select the read/write option.
- The description requires a specific format to be accepted.

2
source/_components/notify.ciscospark.markdown
View File

@ -16,7 +16,7 @@ The `ciscospark` notification platform allows you to deliver notifications from
To use this notification platform you need to get a developer token. To obtain a token visit [Spark for Developers](https://developer.ciscospark.com/index.html)
At this time you also need to specify the `Cisco Spark` `roomid`. The `roomid` can also be found at [Spark for Developers](https://developer.ciscospark.com/index.html). Just look in the Doumentation under Rooms.
At this time you also need to specify the `Cisco Spark` `roomid`. The `roomid` can also be found at [Spark for Developers](https://developer.ciscospark.com/index.html). Just look in the Documentation under Rooms.
To enable the Cisco Spark notification in your installation, add the following to your `configuration.yaml` file:

2
source/_components/notify.knx.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: knx.png
ha_category: Notify
ha_category: Notifications
ha_release: 0.53
ha_iot_class: "Local Push"
---

2
source/_components/notify.slack.markdown
View File

@ -38,7 +38,7 @@ Configuration variables:
- **api_key** (*Required*): The Slack API token to use for sending Slack messages.
- **default_channel** (*Required*): The default channel to post to if no channel is explicitly specified when sending the notification message.
- **username** (*Optional*): Setting username will allow Home Assistant to post to Slack using the username specified. By default not setting this will post to Slack using the user account or botname that you generated the api_key as.
- **icon** (*Optional*): Use one of the Slack emoji's as an Icon for the supplied username. Slack uses the standard emoji sets used [here](http://www.webpagefx.com/tools/emoji-cheat-sheet/).
- **icon** (*Optional*): Use one of the Slack emojis as an Icon for the supplied username. Slack uses the standard emoji sets used [here](http://www.webpagefx.com/tools/emoji-cheat-sheet/).
### {% linkable_title Slack service data %}

2
source/_components/pilight.markdown
View File

@ -35,7 +35,7 @@ Configuration variables:
- **send_delay** (*Optional*): You can define a send delay as a fraction of seconds if you experience transmission problems when you try to switch multiple switches at once. This can happen when you use a [pilight USB Nano](https://github.com/pilight/pilight-usb-nano) as hardware and switches a whole group of multiple switches on or off. Tested values are between 0.3 and 0.8 seconds depending on the hardware.
- **whitelist** (*Optional*): You can define a whitelist to prevent that too many unwanted RF codes (e.g. the neighbours weather station) are put on your HA event bus. All defined subsections have to be matched. A subsection is matched if one of the items are true.
In this example only received RF codes using a daycom or intertechno protocol are put on the event bus and only when the device id is 42. For more possible settings please look at the receiver section of the pilight [API](https://www.pilight.org/development/api/).
In this example only received RF codes using a daycom or Intertechno protocol are put on the event bus and only when the device id is 42. For more possible settings please look at the receiver section of the pilight [API](https://www.pilight.org/development/api/).
A full configuration sample could look like the sample below:

14
source/_components/plant.markdown
View File

@ -33,11 +33,11 @@ Configuration variables:
- **entity_id** (*Required*): Set by you and is used by the component as the `entity_id`.
- **sensors** (*Required*):
- **moisture** (*Optional*): Moisture of the plant. Meassured in %. Can have a min and max value set optionally.
- **battery** (*Optional*): Battery level of the plant sensor. Meassured in %. Can only have a min level set optionally.
- **temperature:** (*Optional*): Temperaure of the plant. Meassured in degrees Celcius. Can have a min and max value set optionally.
- **conductivity:** (*Optional*): Conductivity of the plant. Meassured in µS/cm. Can have a min and max value set optionally.
- **brightness:** (*Optional*): Light exposure of the plant. Meassured in Lux. Can have a min and max value set optionally.
- **moisture** (*Optional*): Moisture of the plant. Measured in %. Can have a min and max value set optionally.
- **battery** (*Optional*): Battery level of the plant sensor. Measured in %. Can only have a min level set optionally.
- **temperature:** (*Optional*): Temperature of the plant. Measured in degrees Celsius. Can have a min and max value set optionally.
- **conductivity:** (*Optional*): Conductivity of the plant. Measured in µS/cm. Can have a min and max value set optionally.
- **brightness:** (*Optional*): Light exposure of the plant. Measured in Lux. Can have a min and max value set optionally.
- **min_moisture** (*Optional*): Minimum moisture level before triggering a problem. Typical value: 20
- **max_moisture** (*Optional*): Maximum moisture level before triggering a problem. Typical value: 60
- **min_battery** (*Optional*): Minimum battery level before triggering a problem. Typical value: 20
@ -50,11 +50,11 @@ Configuration variables:
## {% linkable_title Examples %}
### Using plain MQTT sensor to get the data
This is a practial example that uses a multiple of `MQTT sensors` to supply the readings used by the `plant` sensor.
This is a practical example that uses a multiple of `MQTT sensors` to supply the readings used by the `plant` sensor.
Another good source of this data would be the [Mi Flora](https://home-assistant.io/components/sensor.miflora/) component.
If the sensor data within the the min/max values the status will be `ok`, if not the status will be `problem`. You can use this to trigger a notification, if there is a problem with your plant. Of course you can only monitor attributes of your plant, where the sensor is configured and is providing the data.
If the sensor data is within the min/max values the status will be `ok`, if not the status will be `problem`. You can use this to trigger a notification, if there is a problem with your plant. Of course you can only monitor attributes of your plant, where the sensor is configured and is providing the data.
## Data Source

2
source/_components/remote.harmony.markdown
View File

@ -146,7 +146,7 @@ automation:
action:
service: remote.send_command
data_template:
# using a data template to have if brances for relavant device
# using a data template to have if brances for relevant device
# Always the same entity_id - the harmony hub
entity_id: remote.bedroom
# Always the same command - the Pause key

2
source/_components/remote.itach.markdown
View File

@ -14,7 +14,7 @@ ha_release: 0.39
---
The `itach` remote platform allows you to control IR devices with a [Global Caché iTach Device](https://www.globalcache.com/products/itach/ip2irspecs) and GC-100 devices. The Global Cache IR API are similar accross their product line. See API documentation links at the end of this page.
The `itach` remote platform allows you to control IR devices with a [Global Caché iTach Device](https://www.globalcache.com/products/itach/ip2irspecs) and GC-100 devices. The Global Cache IR API are similar across their product line. See API documentation links at the end of this page.
To use your iTach remote in your installation, you will need to know the IR commands for your devices in Pronto hex format and add the following to your `configuration.yaml` file:

2
source/_components/remote.markdown
View File

@ -17,7 +17,7 @@ Keeps track which remotes are in your environment, their state and allows you to
### {% linkable_title Use the services %}
Go the the **Developer Tools**, then to **Call Service** in the frontend, and choose `remote/turn_on`, `remote/turn_off`, or `remote/toggle` from the list of available services (**Available services:** on the left). Enter something like the sample below into the **Service Data** field and hit **Call Service**.
Go to the **Developer Tools**, then to **Call Service** in the frontend, and choose `remote/turn_on`, `remote/turn_off`, or `remote/toggle` from the list of available services (**Available services:** on the left). Enter something like the sample below into the **Service Data** field and hit **Call Service**.
```json
{"entity_id":"remote.family_room"}

14
source/_components/rflink.markdown
View File

@ -14,9 +14,9 @@ ha_release: 0.38
The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
The 433 Mhz spectrum is used by many manufacturers mostly using their own protocol/standard and includes devices like: light switches, blinds, weather stations, alarms and various other sensors.
The 433 MHz spectrum is used by many manufacturers mostly using their own protocol/standard and includes devices like: light switches, blinds, weather stations, alarms and various other sensors.
RFLink Gateway supports a number of RF frequencies, using a wide range of low-cost hardware. Their website provides details for various RF transmitter, receiver and transceiver modules for 433Mhz, 868Mhz and 2.4 Ghz [here.](http://www.nemcon.nl/blog2/wiring)
RFLink Gateway supports a number of RF frequencies, using a wide range of low-cost hardware. Their website provides details for various RF transmitter, receiver and transceiver modules for 433MHz, 868MHz and 2.4 GHz [here.](http://www.nemcon.nl/blog2/wiring)
<p class='note'>
Note: Versions later than R44 adds support for Ikea Ansluta, Philips Living Colors Gen1, MySensors devices.
@ -40,7 +40,7 @@ Configuration variables:
- **port** (*Required*): The path to RFLink USB/serial device or TCP port in TCP mode.
- **host** (*Optional*): Switches to TCP mode, connects to host instead of to USB/serial.
- **wait_for_ack** (*Optional*): Wait for RFLink to ackowledge commands sent before sending new command (slower but more reliable). Defaults to `True`
- **wait_for_ack** (*Optional*): Wait for RFLink to acknowledge commands sent before sending new command (slower but more reliable). Defaults to `True`
- **ignore_devices** (*Optional*): List of devices id's to ignore. Supports wildcards (*) at the end.
- **reconnect_interval** (*Optional*): Time in seconds between reconnect attempts.
@ -104,7 +104,7 @@ sensor:
### {% linkable_title Ignoring devices %}
RFLink platform can be configured to completely ignore a device on a platform level. This is useful when you have neighbors which also use 433 Mhz technology.
RFLink platform can be configured to completely ignore a device on a platform level. This is useful when you have neighbors which also use 433 MHz technology.
For example:
@ -129,14 +129,14 @@ Even though a lot of devices are supported by RFLink, not all have been tested/i
### {% linkable_title Device Incorrectly Identified %}
If you find a device is recognized differently, with different protocols or the ON OFF is swapped or detected as two ON commands, it can be overcome with the RFlink 'RF Signal Learning' mechanism from RFLink Rev 46 (11 March 2017). [Link to further detail.](http://www.nemcon.nl/blog2/faq#RFFind)
If you find a device is recognized differently, with different protocols or the ON OFF is swapped or detected as two ON commands, it can be overcome with the RFLink 'RF Signal Learning' mechanism from RFLink Rev 46 (11 March 2017). [Link to further detail.](http://www.nemcon.nl/blog2/faq#RFFind)
### {% linkable_title Technical overview %}
- The`rflink` Python module a asyncio transport/protocol is setup that fires an callback for every (valid/supported) packet received by the RFLink gateway.
- This component uses this callback to distribute 'rflink packet events' over Home Assistant's bus which can be subscribed to by entities/platform implementations.
- The platform implementions take care of creating new devices (if enabled) for unsees incoming packet id's.
- Device entities take care of matching to the packet ID, interpreting and performing actions based on the packet contents. Common entitiy logic is maintained in this main component.
- The platform implementation takes care of creating new devices (if enabled) for unseen incoming packet id's.
- Device entities take care of matching to the packet ID, interpreting and performing actions based on the packet contents. Common entity logic is maintained in this main component.
### {% linkable_title Debug logging %}

2
source/_components/satel_integra.markdown
View File

@ -56,7 +56,7 @@ Configuration variables:
- **port** (*Optional*): The port on which the ETHM module listens for clients using integration protocol. Default: `7094`
- **partition** (*Optional*): The partition to operate on. Integra can support multiple partitions, this platform only supports one. Default: `1`
- **arm_home_mode** (*Optional*): The mode in which arm Satel Integra when 'arm home' is used. Possible options are `1`,`2` or `3`, default being `1`. For more information on what are the differences between them, please refer to Satel Integra manual.
- **zones** (*Optional*): This module does not discover currently which zones are actually in use, so it will only monitor the ones defined in the config. For each zone, a proper ID mus be given as well as it's name (does not need to match the one specified in Satel Integra alarm). For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*
- **zones** (*Optional*): This module does not discover currently which zones are actually in use, so it will only monitor the ones defined in the config. For each zone, a proper ID must be given as well as it's name (does not need to match the one specified in Satel Integra alarm). For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*
List of all zone IDs can be taken from DloadX program.

2
source/_components/scsgate.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.13
ha_iot_class: "Local Polling"
---
The SCSGate component support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a homebrew device allows to interact with the MyHome system from BTicino/Legrande.
The SCSGate component support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a home-brew device allows to interact with the MyHome system from BTicino/Legrande.
To enable SCSGate in your installation, add the following to your `configuration.yaml` file:

4
source/_components/sensor.arest.markdown
View File

@ -14,7 +14,7 @@ ha_release: pre 0.7
---
The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
To use your aREST enabled device in your installation, add the following to your `configuration.yaml` file:
@ -34,7 +34,7 @@ sensor:
Configuration variables:
- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, e.g. http://192.168.1.10.
- **name** (*Optional*): Let you overwrite the the name of the device. By default *name* from the device is used.
- **name** (*Optional*): Let you overwrite the name of the device. By default *name* from the device is used.
- **monitored_variables** array (*Optional*): List of exposed variables.
- **[variable]** (*Required*): Name of the variable to monitor.
- **name** (*Optional*): The name to use for the frontend.

2
source/_components/sensor.bh1750.markdown
View File

@ -14,7 +14,7 @@ ha_iot_class: "Local Push"
---
The `bh1750` sensor platform allows you to read the ambient light level in lux from a [BH1750FVI sensor](http://cpre.kmutnb.ac.th/esl/learning/bh1750-light-sensor/bh1750fvi-e_datasheet.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet.
The `bh1750` sensor platform allows you to read the ambient light level in Lux from a [BH1750FVI sensor](http://cpre.kmutnb.ac.th/esl/learning/bh1750-light-sensor/bh1750fvi-e_datasheet.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet.
Tested devices:

2
source/_components/sensor.broadlink.markdown
View File

@ -78,7 +78,7 @@ sensor:
The pycrypto library needs to be available on your platform. On a typical windows sysytem `pip install pycrypto` will fail, as a compiler needs to be installed first.
</p>
The quickest way around this is to use a pre-built binary, e.g. from https://github.com/sfbahr/PyCrypto-Wheels
The quickest way around this is to use a pre-built binary, e.g. from [https://github.com/sfbahr/PyCrypto-Wheels](https://github.com/sfbahr/PyCrypto-Wheels)
Be sure to get the correct 64 or 32-bit binary for your system, the full command line will look something like the sample below for a 64-bit system:

6
source/_components/sensor.buienradar.markdown
View File

@ -62,8 +62,8 @@ Configuration variables:
- **visibility**: Visibility in meters ([m](https://en.wikipedia.org/wiki/Metre)).
- **windgust**: The wind speed of wind gusts ([m/s](https://en.wikipedia.org/wiki/M/s)).
- **precipitation**: The amount of precipitation/rain in mm/h.
- **precipitation_forecast_average**: The average expected precipitation/rain in mm/h within the given timeframe.
- **precipitation_forecast_total**: The total expected precipitation/rain in mm within the given timeframe. The total expected rain in the configured timeframe will be equal to _precipitation_forecast_total_/_timeframe_ mm/min. So, with timeframe configured to 30 minutes and a value of 5, the expected rain is 5 mm in 30 minutes, which is the same as 10 mm/h. If timeframe is set to 90 minutes and a value of 5, the expected rain is 5 mm in 90 minutes, which is equal to 3.3 mm/h.
- **precipitation_forecast_average**: The average expected precipitation/rain in mm/h within the given time-frame.
- **precipitation_forecast_total**: The total expected precipitation/rain in mm within the given time-frame. The total expected rain in the configured time-frame will be equal to _precipitation_forecast_total_/_timeframe_ mm/min. So, with time-frame configured to 30 minutes and a value of 5, the expected rain is 5 mm in 30 minutes, which is the same as 10 mm/h. If time-frame is set to 90 minutes and a value of 5, the expected rain is 5 mm in 90 minutes, which is equal to 3.3 mm/h.
- **irradiance**: Sun intensity in Watt per square meter ([W/m2](https://en.wikipedia.org/wiki/W/m2)).
- **temperature_1d** [<sup>[1d]</sup>](#1d): The forecasted temperature (in [C](https://en.wikipedia.org/wiki/Celsius)).
- **mintemp_1d** [<sup>[1d]</sup>](#1d): The forecasted minimum temperature (in [C](https://en.wikipedia.org/wiki/Celsius)).
@ -162,4 +162,4 @@ sensor:
```
[Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata)
> Buienradar makes free weatherdata available for use by individuals and businesses (website/intranet). The use of the weatherdata is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your usage or to request permission.
> Buienradar makes free weather-data available for use by individuals and businesses (website/intranet). The use of the weather-data is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your usage or to request permission.

4
source/_components/sensor.citybikes.markdown
View File

@ -28,8 +28,8 @@ Configuration options:
- **name** (*Optional*): The base name of this group of monitored stations. The entity ID of every monitored station in this group will be prefixed with this base name, in addition to the network ID.
- **network** (*Optional*): The name of the bike sharing system to poll. Defaults to the system that operates in the monitored location.
- **latitude** (*Optional*): Latitude of the location, around which bike stations are monitored. Defaults to the latitude in your your `configuration.yaml` file.
- **longitude** (*Optional*): Longitude of the location, around which bike stations are monitored. Defaults to the longitude in your your `configuration.yaml` file.
- **latitude** (*Optional*): Latitude of the location, around which bike stations are monitored. Defaults to the latitude in your `configuration.yaml` file.
- **longitude** (*Optional*): Longitude of the location, around which bike stations are monitored. Defaults to the longitude in your `configuration.yaml` file.
- **radius** (*Optional*): The radius (in meters or feet, depending on the Home Assistant configuration) around the monitored location. Only stations closer than this distance will be monitored.
- **stations** array (*Optional*): A list of specific stations to monitor. The list should contain station `ID`s or `UID`s, which can be obtained from the CityBikes API.

2
source/_components/sensor.currencylayer.markdown
View File

@ -14,7 +14,7 @@ ha_release: 0.32
---
The `currencylayer` sensor will show you the current exchange rate from [Currencylayer](https://currencylayer.com/) that provides realtime exchange rates for [170 currencies](https://currencylayer.com/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour.
The `currencylayer` sensor will show you the current exchange rate from [Currencylayer](https://currencylayer.com/) that provides real-time exchange rates for [170 currencies](https://currencylayer.com/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour.
Obtain your API key [here](https://currencylayer.com/product)

2
source/_components/sensor.darksky.markdown
View File

@ -41,7 +41,7 @@ Configuration variables:
- **api_key** (*Required*): Your API key.
- **name** (*Optional*): Additional name for the sensors. Default to platform name.
- **forecast** array (*Optional*): List of days in the 7 day forecast you would like to receive data on, starting with tomorrow as day 1. Any `monitored_condition` with a daily forecast by DarkSky will generate a sensor tagged with `_<day>`.
- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specificed), defaults to coordinates defined in your `configuration.yaml`
- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml`
- **longitude** (*Optional*): Longitude coordinate to monitor weather of (required if **latitude** is specified), defaults to coordinates defined in your `configuration.yaml`
- **monitored_conditions** array (*Required*): Conditions to display in the frontend.
- **summary**: A human-readable text summary of the current conditions.

45
source/_components/sensor.dsmr.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "DSMR/Slimme meter"
title: "DSMR or Slimme meter"
description: "Instructions how to integrate DSMR Smartmeter within Home Assistant."
date: 2016-11-12 12:00
sidebar: true
@ -15,11 +15,9 @@ ha_iot_class: "Local Push"
A sensor platform for Dutch Smart Meters which comply to DSMR (Dutch Smart Meter Requirements), also known as 'Slimme meter' or 'P1 poort'.
Currently support DSMR V2.2 and V4 through the [dsmr_parser](https://github.com/ndokter/dsmr_parser) module by Nigel Dokter.
For official information about DSMR refer to: [DSMR Document](http://www.netbeheernederland.nl/themas/hotspot/hotspot-documenten/?dossierid=11010056&title=Slimme%20meter&onderdeel=Documenten)
For unofficial hardware connection examples refer to: [Domoticx](http://domoticx.com/p1-poort-slimme-meter-hardware/)
- Currently support DSMR V2.2 and V4 through the [dsmr_parser](https://github.com/ndokter/dsmr_parser) module by Nigel Dokter.
- For official information about DSMR refer to: [DSMR Document](http://www.netbeheernederland.nl/themas/hotspot/hotspot-documenten/?dossierid=11010056&title=Slimme%20meter&onderdeel=Documenten)
- For unofficial hardware connection examples refer to: [Domoticx](http://domoticx.com/p1-poort-slimme-meter-hardware/)
<p class='img'>
<img src='/images/screenshots/dsmr.png' />
@ -33,13 +31,13 @@ This component is known to work for:
- Kaifa E0026
- Kamstrup 382JxC (DSMR 2.2)
,USB serial converters:
USB serial converters:
- Cheap (Banggood/ebay) Generic PL2303
- https://sites.google.com/site/nta8130p1smartmeter/webshop
- https://www.sossolutions.nl/slimme-meter-kabel
And Serial to network proxies:
Serial to network proxies:
- ser2net - http://ser2net.sourceforge.net/
@ -49,11 +47,20 @@ sensor:
- platform: dsmr
```
Configuration variables:
- **port** string (*Optional*): Serial port to which Smartmeter is connected (default: /dev/ttyUSB0 (connected to USB port)). For remote (i.e. ser2net) connections, use TCP port number to connect to (i.e. 2001).
- **host** string (*Optional*): Host to which Smartmeter is connected (default: '' (connected via serial or USB, see **port**)). For remote connections, use IP address of host to connect to (i.e. 192.168.1.13).
- **dsmr_version** string (*Optional*): Version of DSMR used by meter, choices: 2.2, 4 (default: 2.2).
{% configuration %}
port:
description: "Serial port to which Smartmeter is connected (default: /dev/ttyUSB0 (connected to USB port)). For remote (i.e. ser2net) connections, use TCP port number to connect to (i.e. 2001)."
required: false
type: string
host:
description: "Host to which Smartmeter is connected (default: '' (connected via serial or USB, see **port**)). For remote connections, use IP address of host to connect to (i.e. 192.168.1.13)."
required: false
type: string
name:
description: "Version of DSMR used by meter, choices: 2.2, 4. Defaults to 2.2."
required: false
type: string
{% endconfiguration %}
Full configuration examples can be found below:
@ -95,6 +102,7 @@ group:
```
Optional configuration example for ser2net:
```sh
# Example /etc/ser2net.conf for proxying USB/serial connections to DSMRv4 smart meters
2001:raw:600:/dev/ttyUSB0:115200 NONE 1STOPBIT 8DATABITS XONXOFF LOCAL -RTSCTS
@ -111,3 +119,14 @@ and after that you need to reboot!
```
$ sudo reboot
```
### {% linkable_title Technical overview %}
DSMR is a standard to which Dutch smartmeters must comply. It specifies that the smartmeter must send out a 'telegram' every 10 seconds over a serial port.
The contents of this telegram differ between version but they generally consist of lines with 'obis' (Object Identification System, a numerical ID for a value) followed with the value and unit.
This module sets up a asynchronous reading loop using the `dsmr_parser` module which waits for a complete telegram, parser it and puts it on an async queue as a dictionary of `obis`/object mapping. The numeric value and unit of each value can be read from the objects attributes. Because the `obis` are know for each DSMR version the Entities for this component are create during bootstrap.
Another loop (DSMR class) is setup which reads the telegram queue, stores/caches the latest telegram and notifies the Entities that the telegram has been updated.

2
source/_components/sensor.dwd_weather_warnings.markdown
View File

@ -31,7 +31,7 @@ To get the region name:
- Find your region here: `https://www.dwd.de/DE/wetter/warnungen_landkreise/warnWetter_node.html?ort=Hamburg`
- Verify if you find any warning for your region here: `https://www.dwd.de/DWD/warnungen/warnapp_landkreise/json/warnings.json?jsonp=loadWarnings`
The warning level is between 0 (no danger) and 4 (extrem weather conditions):
The warning level is between 0 (no danger) and 4 (extreme weather conditions):
- Warnungen vor extremem Unwetter (Stufe 4)
- Unwetterwarnungen (Stufe 3)
- Warnungen vor markantem Wetter (Stufe 2)

6
source/_components/sensor.dweet.markdown
View File

@ -29,12 +29,12 @@ Configuration variables:
- **device** (*Required*): Identification of the device (also known as `thing`).
- **value_template** (*Required*): The variable to extract a value from the content.
- **name** (*Optional*): Let you overwrite the the name of the device in the frontend.
- **name** (*Optional*): Let you overwrite the name of the device in the frontend.
- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any.
### {% linkable_title Full configuration sample %}
A ful configuration entry could look like the sample below.
A full configuration entry could look like the sample below.
```yaml
# Example configuration.yaml entry
@ -48,7 +48,7 @@ sensor:
### {% linkable_title Interacting with Dweet.io %}
You can easily send dweets from the commandline to test your sensor with `curl`.
You can easily send dweets from the command-line to test your sensor with `curl`.
```bash
$ curl -H 'Content-Type: application/json' -d '{"temperature": 40, "humidity": 65}' https://dweet.io/dweet/for/ha-sensor

Some files were not shown because too many files have changed in this diff Show More