jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Merge remote-tracking branch 'origin/current' into next

Browse source
This commit is contained in:
Paulus Schoutsen 2017-10-05 09:24:55 -07:00
commit f9e3f7e099
54 changed files with 398 additions and 296 deletions
Download patch file Download diff file Expand all files Collapse all files

15
source/_components/binary_sensor.android_ip_webcam.markdown
View file

@ -17,3 +17,18 @@ ha_iot_class: "Local Polling"
The `android_ip_webcam` binary sensor platform lets you observe the motion state of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant.
Devices will be configured automatically. Please refer to the [component](/components/android_ip_webcam/) configuration on how to setup.
## {% linkable_title Examples %}
You can also setup the binary motion sensor with the following script:
{% raw %}
```yaml
binary_sensor:
- platform: rest
name: Kitchen Motion
sensor_class: motion
resource: http://IP:8080/sensors.json?sense=motion_active
value_template: '{{ value_json.motion_active.data[0][1][0] | round(0) }}'
```
{% endraw %}

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

@ -15,7 +15,7 @@ ha_release: 0.35
The `flic` platform allows you to connect with multiple [flic](https://flic.io) smart buttons.
The platform does not directly interact with the buttons, but communicates with the flic service that manages the buttons. The service can run on the same instance as home assistant or any other reachable machine. For setup instructions visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [OS X](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows).
The platform does not directly interact with the buttons, but communicates with the flic service that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine. For setup instructions visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [OS X](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows).
To use your flic buttons in your installation, add the following to your `configuration.yaml` file:

12
source/_components/camera.mjpeg.markdown
View file

@ -37,3 +37,15 @@ Configuration variables:
<p class='note'>
There is a <a href="https://github.com/shazow/urllib3/issues/800" target="_blank">known issue in urllib3</a> that you will get error messages in your logs like <code>[StartBoundaryNotFoundDefect(), MultipartInvariantViolationDefect()], unparsed data: ''</code> but the component still works fine. You can ignore the messages.
</p>
## {% linkable_title Examples %}
Example of using a DCS-930L Wireless N Network Camera from D-Link:
```yaml
camera:
- platform: mjpeg
name: Livingroom Camera
still_image_url: http://IP/image.jpg
mjpeg_url: http://IP/video/mjpg.cgi
```

4
source/_components/climate.markdown
View file

@ -226,8 +226,8 @@ automation:
The step for the setpoint can be adjusted (default to 0,5 increments) by adding the following line into configuration
'''yaml
```yaml
customize:
- entity_id
target_temp_step: 1
'''
```

6
source/_components/counter.markdown
View file

@ -39,7 +39,7 @@ Pick an icon that you can find on [materialdesignicons.com](https://materialdesi
### {% linkable_title Media control services %}
Available services: `increment`, `decrement`, and `reset`.
#### {% linkable_title Service `counter/increment` %}
#### {% linkable_title Service `counter.increment` %}
Increments the counter with 1 or the given value for the steps.
@ -47,7 +47,7 @@ Increments the counter with 1 or the given value for the steps.
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. |
#### {% linkable_title Service `counter/decrement` %}
#### {% linkable_title Service `counter.decrement` %}
Decrements the counter with 1 or the given value for the steps.
@ -55,7 +55,7 @@ Decrements the counter with 1 or the given value for the steps.
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. |
#### {% linkable_title Service `counter/reset` %}
#### {% linkable_title Service `counter.reset` %}
With this service the counter is reset to its initial value.

52
source/_components/cover.template.markdown
View file

@ -170,27 +170,33 @@ This example allows you to control two or more covers at once.
```yaml
homeassistant:
customize:
all_covers:
cover_group:
assume_state: true
cover:
- platform: template
covers:
all_covers:
friendly_name: "All Covers"
cover_group:
friendly_name: "Cover Group"
open_cover:
service: script.cover_all_open
service: script.cover_group
data:
modus: 'open'
close_cover:
service: script.cover_all_close
service: script.cover_group
data:
modus: 'close'
stop_cover:
service: script.cover_all_stop
service: script.cover_group
data:
modus: 'stop'
set_cover_position:
service: script.cover_all_set_position
service: script.cover_group_position
data_template:
position: "{{ position }}"
value_template: "{{ is_state('sensor.all_covers', 'open') }}"
position: "{{position}}"
value_template: "{{is_state('sensor.cover_group', 'open')}}"
icon_template: >-
{% if is_state('sensor.all_covers', 'open') %}
{% if is_state('sensor.cover_group', 'open') %}
mdi:window-open
{% else %}
mdi:window-closed
@ -202,7 +208,7 @@ cover:
sensor:
- platform: template
sensors:
all_covers:
cover_group:
value_template: >-
{% if is_state('cover.bedroom', 'open') %}
open
@ -216,35 +222,21 @@ sensor:
- cover.livingroom
script:
cover_all_open:
cover_group:
sequence:
- service: cover.open_cover
- service_template: "cover.{{modus}}_cover"
data:
entity_id:
- cover.bedroom
- cover.livingroom
cover_all_stop:
sequence:
- service: cover.stop_cover
data:
entity_id:
- cover.bedroom
- cover.livingroom
cover_all_close:
sequence:
- service: cover.close_cover
data:
entity_id:
- cover.bedroom
- cover.livingroom
cover_all_set_position:
cover_group_position:
sequence:
- service: cover.set_cover_position
data_template:
entity_id:
- cover.bedroom
- cover.livingroom
position: "{{ position }}"
position: "{{position}}"
automation:
- alias: "Close covers at night"
@ -255,7 +247,7 @@ automation:
action:
- service: cover.set_cover_position
data:
entity_id: cover.all_covers
entity_id: cover.cover_group
position: 25
```
{% endraw %}

2
source/_components/envisalink.markdown
View file

@ -65,7 +65,7 @@ Configuration variables:
- **evl_version** (*Optional*): 3 for evl3, or 4 for evl4. Default: `3`
- **keepalive_interval** (*Optional*): This is a periodic heartbeat signal (measured in seconds) sent to your Envisalink board to keep it from restarting. This is required for DSC and Honeywell systems. Defaults to `60` seconds.
- **zonedump_interval** (*Optional*): This is an interval (measured in seconds) where the evl will dump out all zone statuses. This is required for Honeywell systems, which do not properly send zone closure events. DSC boards do not technically need this. Default: `30`
- **panic_type** (*Optional*): Both DSC and Honeywell boards support a "panic" alarm. This is used when the alarm_trigger service is called in home assistant. This determines which type of panic alarm to raise. Default = Police. Valid values are: Police, Fire, Ambulance
- **panic_type** (*Optional*): Both DSC and Honeywell boards support a "panic" alarm. This is used when the alarm_trigger service is called in Home Assistant. This determines which type of panic alarm to raise. Default = Police. Valid values are: Police, Fire, Ambulance
- **zones** (*Optional*): Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.envisalink/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*
- **partitions** (*Optional*): Again, Envisalink boards do not tell us what is in use and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor components are loaded.

14
source/_components/ffmpeg.markdown
View file

@ -1,7 +1,7 @@
---
layout: page
title: "FFmpeg"
description: "Instructions for how to integrate FFmpeg within Home Assistant."
description: "Instructions on how to integrate FFmpeg within Home Assistant."
date: 2016-09-14 00:00
sidebar: true
comments: false
@ -11,7 +11,7 @@ logo: ffmpeg.png
ha_category: Hub
---
The `ffmpeg` component allows other Home Assistant components to process video and audio streams. This component supports all FFmpeg versions since 3.0.0; if you have a older version, please update.
The `ffmpeg` component allows other Home Assistant components to process video and audio streams. This component supports all FFmpeg versions since 3.0.0; if you have an older version, please update.
<p class='note'>
You need the `ffmpeg` binary in your system path. On Debian 8 or Raspbian (Jessie) you can install it from [debian-backports](https://backports.debian.org/Instructions/). If you want [hardware acceleration](https://trac.ffmpeg.org/wiki/HWAccelIntro) support on a Raspberry Pi, you will need to build from source by yourself. Windows binaries are available on the [FFmpeg](http://www.ffmpeg.org/) website.
@ -52,7 +52,7 @@ ffmpeg:
In most cases, `ffmpeg` automatically detects all needed options to read a video or audio stream or file. But it is possible in rare cases that you will need to set options to help `ffmpeg` out.
First check that your stream is playable by `ffmpeg` outside of Home Assistant with (use option `-an` or `-vn` to disable video or audio stream):
First, check that your stream is playable by `ffmpeg` outside of Home Assistant with (use option `-an` or `-vn` to disable video or audio stream):
```
$ ffmpeg -i INPUT -an -f null -
@ -61,19 +61,19 @@ $ ffmpeg -i INPUT -an -f null -
Now you should be able to see what is going wrong. The following list contains some common problems and solutions:
- `[rtsp @ ...] UDP timeout, retrying with TCP`: You need to set an RTSP transport in the configuration with: `input: -rtsp_transport tcp -i INPUT`
- `[rtsp @ ...] Could not find codec parameters for stream 0 (Video: ..., none): unspecified size`: FFmpeg needs more data or time for autodetection (the default is 5 seconds). You can set the `analyzeduration` and/or `probesize` options to experiment with giving FFmpeg more leeway. If you find the needed value, you can set it with: `input: -analyzeduration xy -probesize xy -i INPUT`. More information about this can be found [here](https://www.ffmpeg.org/ffmpeg-formats.html#Description).
- `[rtsp @ ...] Could not find codec parameters for stream 0 (Video: ..., none): unspecified size`: FFmpeg needs more data or time for autodetection (the default is 5 seconds). You can set the `analyzeduration` and/or `probesize` options to experiment with giving FFmpeg more leeway. If you find the needed value, you can set it with: `input: -analyzeduration xy -probesize xy -i INPUT`. More information about this can be found [here](https://www.ffmpeg.org/ffmpeg-formats.html#Description).
#### {% linkable_title USB cameras %}
For `INPUT` a valid source is needed. USB camera are an easy way to test your video setup. To get all available USB cameras connected to the system, eg. use the v4l2 tools on a Linux machine.
For `INPUT` a valid source is needed. A USB camera is an easy way to test your video setup. To get all available USB cameras connected to the system, e.g., use the v4l2 tools on a Linux machine.
```bash
$ v4l2-ctl --list-devices
UVC Camera (046d:0825) (usb-0000:00:14.0-1):
/dev/video1
/dev/video1
Integrated Camera (usb-0000:00:14.0-10):
/dev/video0
/dev/video0
```
Record a test video with your USB device `/dev/video1`:

2
source/_components/group.markdown
View file

@ -58,7 +58,7 @@ Configuration variables:
- **view** (*Optional*): If yes then the entry will be shown as a view (tab) at the top.
- **name** (*Optional*): Name of the group.
- **icon** (*Optional*): If the group is a view, this icon will show at the top in the frontend instead of the name. If the group is a view and both name and icon have been specified, the icon will appear at the top of the fronted and the name will be displayed as the mouse-over text. If it's not a view, then the icon shows when this group is used in another group.
- **icon** (*Optional*): If the group is a view, this icon will show at the top in the frontend instead of the name. If the group is a view and both name and icon have been specified, the icon will appear at the top of the frontend and the name will be displayed as the mouse-over text. If it's not a view, then the icon shows when this group is used in another group.
- **control** (*Optional*): Set value to `hidden`. If hidden then the group switch will be hidden.
- **entities** (*Required*): array or comma delimited string, list of entities to group.

8
source/_components/http.markdown
View file

@ -14,7 +14,7 @@ ha_category: "Other"
The `http` component serves all files and data required for the Home Assistant frontend. You only need to add this to your configuration file if you want to change any of the default settings.
<p class='note warning'>
It's HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.
It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.
</p>
```yaml
@ -28,13 +28,13 @@ 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_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.
- **base_url** (*Optional*): The URL that Home Assistant is available on the internet. For example: `hass-example.duckdns.org:8123`. Defaults to the 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.
- **ssl_certificate** (*Optional*): Path to your TLS/SSL certificate to serve Home Assistant over a secure connection.
- **ssl_key** (*Optional*): Path to your TLS/SSL key to serve Home Assistant over a secure connection.
- **cors_allowed_origins** (*Optional*): A list of origin domain names to allow [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) requests from. Enabling this will set the `Access-Control-Allow-Origin` header to the Origin header if it is found in the list, and the `Access-Control-Allow-Headers` header to `Origin, Accept, X-Requested-With, Content-type, X-HA-access`. You must provide the exact Origin, i.e. `https://home-assistant.io` will allow requests from `https://home-assistant.io` but __not__ `http://home-assistant.io`.
- **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.
- **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 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.
@ -74,7 +74,7 @@ All [requests](/developers/rest_api/#post-apistatesltentity_id) need to be sent
If you want to use Home Assistant to host or serve static files then create a directory called `www` under the `.homeassistant` configuration path. The static files in `.homeassistant/www/` can be accessed by the following URL `http://your.domain:8123/local/`.
If you want to apply additional IP filtering, and automatically ban brute force attempts, set `ip_ban_enabled` to `True` and select number of attempts. After first ban file `ip_bans.yaml` will be created in the root configuration folder. It will have IP address and time in UTC when it was added:
If you want to apply additional IP filtering, and automatically ban brute force attempts, set `ip_ban_enabled` to `True` and the maximum number of attempts. After the first ban, an `ip_bans.yaml` file will be created in the root configuration folder. It will have the banned IP address and time in UTC when it was added:
```yaml
127.0.0.1:

2
source/_components/light.decora.markdown
View file

@ -52,5 +52,5 @@ Jun 20 19:41:18 androlapin hass[29588]: OSError: [Errno 8] Exec format error
1. Go to your `.homeassistant` folder
2. Then go to `deps/bluepy` subfolder.
3. Then run `make all`
4. Restart home assistant
4. Restart Home Assistant
</p>

4
source/_components/light.hue.markdown
View file

@ -16,11 +16,11 @@ ha_release: pre 0.7
Philips Hue support is integrated into Home Assistant as a light platform. The preferred way to setup the Philips Hue platform is by enabling the [discovery component](/components/discovery/).
Once discovered, if you have a custom default view, locate `configurator.philips_hue` in the entities list ( < > ) and add it to a group in `configuration.yaml`. Restart Home Assistant so that the configurator is visible in the Home Assistant dashboard. Once Home Assistant is restarted, locate and click on `configurator.philips_hue` to bring up the initiation dialog. This will prompt you to press the Hue button to register the Hue hub in home assistant. Once complete, the configurator entity isn't needed anymore and can be removed from any visible group in `configuration.yaml`.
Once discovered, if you have a custom default view, locate `configurator.philips_hue` in the entities list ( < > ) and add it to a group in `configuration.yaml`. Restart Home Assistant so that the configurator is visible in the Home Assistant dashboard. Once Home Assistant is restarted, locate and click on `configurator.philips_hue` to bring up the initiation dialog. This will prompt you to press the Hue button to register the Hue hub in Home Assistant. Once complete, the configurator entity isn't needed anymore and can be removed from any visible group in `configuration.yaml`.
When you configure the Hue bridge from Home Assistant, it writes a token to a file in your Home Assistant [configuration directory](/docs/configuration/). That token authenticates the communication with the Hue bridge. This token uses the IP Address of the Hue Bridge. If the IP address for the Hue Bridge changes, you will need to register the Hue Bridge with Home Assistant again. To avoid this you may set up DHCP registration for your Hue Bridge, so that it always has the same IP address.
Restarting Home Assistant once more should result in the Hue lights listed as "light" entities. Add these light entities to configuration.yaml and restart home assistant once more to complete the installation.
Restarting Home Assistant once more should result in the Hue lights listed as "light" entities. Add these light entities to configuration.yaml and restart Home Assistant once more to complete the installation.
If you want to enable the component without relying on the [discovery component](/components/discovery/), add the following lines to your `configuration.yaml` file:

6
source/_components/media_player.frontier_silicon.markdown
View file

@ -24,7 +24,7 @@ This component was developed and tested with a Hama [DIR3110] and a Medion [MD 8
## Configuration
Your Frontier Silicon based device should be automatically discovered by home assistant. The auto-discovery service assumes that the device uses the default PIN code: *1234*. If you have changed the PIN code, the auto-discovery will fail as home assistant will not be able to connect to the device. You can set the PIN code of your device (depending on manufacturer) under:
Your Frontier Silicon based device should be automatically discovered by Home Assistant. The auto-discovery service assumes that the device uses the default PIN code: *1234*. If you have changed the PIN code, the auto-discovery will fail as Home Assistant will not be able to connect to the device. You can set the PIN code of your device (depending on manufacturer) under:
*MENU button > Main Menu > System setting > Network > NetRemote PIN setup*
@ -80,8 +80,8 @@ is based on [tiwillam]'s fsapi project. Special thanks to both developers, this
## Notes and Limitations
<p class='note warning'>
The Frontier Silicon API does not provide a multi-user environment. There is always a single user (session) controlling a device, which means that once home assistant connects to a device all other sessions will be invalidated. This renders the usage of [UNDOK] almost impossible, as the home assistant component polls the device state every 30 seconds or issues a command by creating a new session.
*If you want to prevent home assistant to auto connect to your device, simply change the PIN code of the device to something else than: 1234*
The Frontier Silicon API does not provide a multi-user environment. There is always a single user (session) controlling a device, which means that once Home Assistant connects to a device all other sessions will be invalidated. This renders the usage of [UNDOK] almost impossible, as the Home Assistant component polls the device state every 30 seconds or issues a command by creating a new session.
*If you want to prevent Home Assistant to auto connect to your device, simply change the PIN code of the device to something else than: 1234*
</p>
[Frontier Silicon chipset]: http://www.frontier-silicon.com/digital-radio-solutions

3
source/_components/media_player.samsungtv.markdown
View file

@ -64,6 +64,7 @@ Currently tested but not working models:
- JU7500 - Unable to see state and unable to control
- JS9000 - State is always "on" and unable to control (but port 8001 *is* open)
- JS9500 - State is always "on" and unable to control (but port 8001 *is* open)
- MU6170UXZG (port set to 8001, `pip3 install websocket-client` must be executed, turning on works, status not working reliably, turning off is not permanent (it comes back on).)
If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/media_player.samsungtv.markdown).
The first letter (U, P, L, H & K) represent the screen type, e.g. LED or Plasma. The second letter represents the region, E is Europe, N is North America and A is Asia & Australia. The two numbers following that represent the screen size.
@ -71,4 +72,4 @@ If you add your model remember to remove these before adding them to the list.
Currently the ability to select a source is not implemented.
There's currently a [known issue](https://github.com/home-assistant/home-assistant/issues/2098) with some TVs receiving a *Key press UP* that can interrupt certain applications.
There's currently a [known issue](https://github.com/home-assistant/home-assistant/issues/2098) with some TVs receiving a *Key press UP* that can interrupt certain applications. This should be fixed as of March 2017.

2
source/_components/modbus.markdown
View file

@ -31,7 +31,7 @@ modbus:
Configuration variables:
- **type** (*Required*): Type of the connection to Modbus.
- **host** (*Required*): The IP address of your router, eg. 192.168.1.1.
- **host** (*Required*): The IP address of your Modbus device, eg. 192.168.1.1.
- **port** (*Required*): The port for the communication.
For a serial connection:

2
source/_components/mysensors.markdown
View file

@ -183,7 +183,7 @@ Sending a heartbeat from the MySensors device to Home Assistant activates the Sm
### {% linkable_title Message validation %}
Messages sent to or from Home Assistant from or to a MySensors device will be validated according to the MySensors [serial API](https://www.mysensors.org/download/serial_api_20). If a message doesn't pass validation, it will be dropped and not be passed forward either to or from home assistant. Make sure you follow the serial API for your version of MySensors when writing your Arduino sketch.
Messages sent to or from Home Assistant from or to a MySensors device will be validated according to the MySensors [serial API](https://www.mysensors.org/download/serial_api_20). If a message doesn't pass validation, it will be dropped and not be passed forward either to or from Home Assistant. Make sure you follow the serial API for your version of MySensors when writing your Arduino sketch.
If you experience dropped messages or that a device is not added to Home Assistant, please turn on debug logging for the `mysensors` component and the `mysensors` package.
```yaml

2
source/_components/notify.html5.markdown
View file

@ -39,10 +39,10 @@ Configuration variables:
- Then, click the cogwheel on top left and select "Project settings".
- Select 'Cloud Messaging' tab, listed beneath Project Credentials will be your 152 character 'Server Key' and 12 digit ID 'Sender ID'.
### {% linkable_title Requirements %}
The `html5` platform can only function if all of the following requirements are met:
(On Hass.io these requirements are already met.)
* You are using Chrome and/or Firefox on any desktop platform, ChromeOS, or Android.
* Your Home Assistant instance is exposed to the world.

2
source/_components/notify.telegram.markdown
View file

@ -122,7 +122,7 @@ Configuration variables:
- **inline_keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data.
<p class='note'>
Since Homeassistant version 0.48 you have to [whitelist the source folder](/docs/configuration/basic/) of the file you want to include in the notification.
Since Home Assistant version 0.48 you have to [whitelist the source folder](/docs/configuration/basic/) of the file you want to include in the notification.
```yaml
configuration.yaml

4
source/_components/pilight.markdown
View file

@ -15,9 +15,9 @@ ha_iot_class: "Local Push"
[Pilight](https://www.pilight.org/) is a modular and open source solution to communicate with 433 MHz devices and runs on various small form factor computers. A lot of common [protocols](https://wiki.pilight.org/doku.php/protocols) are already available.
This pilight hub connects to the [pilight-daemon](https://wiki.pilight.org/doku.php/pdaemon) via a socket connection to receive and send codes. Thus home assistant does not have to run on the computer in charge of the RF communication.
This pilight hub connects to the [pilight-daemon](https://wiki.pilight.org/doku.php/pdaemon) via a socket connection to receive and send codes. Thus Home Assistant does not have to run on the computer in charge of the RF communication.
The received and supported RF codes are put on the event bus of home assistant and are therefore directly usable by other components (e.g. automation). Additionally a send service is provided to send RF codes.
The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other components (e.g. automation). Additionally a send service is provided to send RF codes.
To integrate pilight into Home Assistant, add the following section to your `configuration.yaml` file:

24
source/_components/recorder.markdown
View file

@ -90,6 +90,8 @@ If you only want to hide events from e.g. your history, take a look at the [`his
| Database engine | `db_url` |
| :---------------|:---------------------------------------------------------|
| SQLite | `sqlite:///PATH/TO/DB_NAME` |
| MariaDB | `mysql://SERVER_IP/DB_NAME` |
| MariaDB         | `mysql://user:password@SERVER_IP/DB_NAME`       |
| MySQL | `mysql://SERVER_IP/DB_NAME` |
| MySQL           | `mysql://user:password@SERVER_IP/DB_NAME`       |
| MySQL (pymysql) | `mysql+pymysql://SERVER_IP/DB_NAME` |
@ -102,22 +104,28 @@ If you only want to hide events from e.g. your history, take a look at the [`his
Not all Python bindings for the chosen database engine can be installed directly. This section contains additional details which should help you to get it working.
### {% linkable_title MySQL %}
### {% linkable_title MariDB and MySQL %}
For MariaDB you may have to install a few dependencies. On the Python side we use the `mysqlclient`:
```bash
$ sudo apt-get install libmariadbclient-dev
$ pip3 install mysqlclient
```
For MySQL you may have to install a few dependencies. You can choose between `pymysql` and `mysqlclient`:
```bash
$ sudo apt-get install libmysqlclient-dev
$ sudo apt-get install default-libmysqlclient-dev
$ pip3 install mysqlclient
```
If you are in a virtual environment, don't forget to activate it before installing the pymysql package.
If you are in a virtual environment, don't forget to activate it before installing the `mysqlclient` Python package.
```bash
pi@homeassistant:~ $ sudo -i
root@homeassistant:~# su homeassistant
homeassistant@homeassistant:/root$ cd /srv/homeassistant/homeassistant_venv/
homeassistant@homeassistant:/srv/homeassistant/homeassistant_venv$ source bin/activate
(homeassistant_venv) homeassistant@homeassistant:/srv/homeassistant/homeassistant_venv$ pip3 install mysqlclient
pi@homeassistant:~ $ sudo su homeassistant -s /bin/bash
homeassistant@homeassistant:~$ source /srv/homeassistant/bin/activate
(homeassistant) homeassistant@homeassistant:~$ pip3 install mysqlclient
```
After installing the dependencies, it is required to create the database manually. During the startup, Home Assistant will look for the database specified in the `db_url`. If the database doesn't exist, it will not automatically create it for you.

10
source/_components/script.markdown
View file

@ -11,11 +11,9 @@ logo: home-assistant.png
ha_category: Automation
---
The script component allows users to specify a sequence of actions to be executed by Home Assistant when turned on. The script component will create an entity for each script and allow them to be controlled via services.
The `script` component allows users to specify a sequence of actions to be executed by Home Assistant when turned on. The script component will create an entity for each script and allow them to be controlled via services.
The sequence of actions is specified using the [Home Assistant Script Syntax].
[Home Assistant Script Syntax]: /getting-started/scripts/
The sequence of actions is specified using the [Home Assistant Script Syntax](/getting-started/scripts/).
```yaml
# Example configuration.yaml entry
@ -33,7 +31,8 @@ The preferred way to separate words for better readability is to use underscore
</p>
```yaml
 # Turns on the bedroom lights and then the living room lights 1 minute later
script: 
# Turns on the bedroom lights and then the living room lights 1 minute later
wakeup:
alias: Wake Up
sequence:
@ -99,6 +98,7 @@ automation:
```
Using the variables in the script requires the use of `data_template`:
```yaml
# Example configuration.yaml entry
script:

2
source/_components/sensor.android_ip_webcam.markdown
View file

@ -17,3 +17,5 @@ ha_iot_class: "Local Polling"
The `android_ip_webcam` sensor platform lets you observe states of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant.
Devices will be configured automatically. Please refer to the [component](/components/android_ip_webcam/) configuration on how to setup.
You can setup your own sensors by examining the JSON file from the webcam server: http://IP:8080/sensors.json

16
source/_components/sensor.openhardwaremonitor.markdown
View file

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: openhardwaremonitor.png
ha_category: Sensor
ha_category: System Monitor
ha_release: 0.48
ha_iot_class: "Local Polling"
---
@ -25,10 +25,16 @@ sensor:
host: IP_ADDRESS
```
Configuration variables:
- **host** (*Required*): The IP address or hostname of your Open Hardware Monitor.
- **port** (*Optional*): The port of your Open Hardware Monitor API. Default to 8085.
{% configuration %}
host:
description: The IP address or hostname of the system where Open Hardware Monitor is running.
required: true
type: string
port:
description: The port of your Open Hardware Monitor API. Defaults to 8085.
required: false
type: int
{% endconfiguration %}
<p class='note'>
OpenHardwareMonitor must be running on the host, with "Remote web server" active.

2
source/_components/sensor.pilight.markdown
View file

@ -14,7 +14,7 @@ ha_iot_class: depends
---
This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g. _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight home assistant hub has to be set up.
This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g. _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight Home Assistant hub has to be set up.
To use your sensor via pilight, make sure it is [supported](https://wiki.pilight.org/doku.php/protocols) and add the following to your `configuration.yaml` file:

1
source/_components/sensor.qnap.markdown
View file

@ -70,6 +70,7 @@ If your QNAP device uses self-signed certificates, set the `verify_ssl` option t
This component has been tested on the following devices:
- TS-259 Pro+ (QTS 4.2.6)
- TS-410 (QTS 4.2.3)
- TS-419 (QTS 4.2.3)
- TS-451 (QTS 4.2.2)

1
source/_components/sensor.worxlandroid.markdown
View file

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: worx.png
ha_category: DIY
ha_release: 0.54
ha_iot_class: "Local Polling"

4
source/_components/switch.rfxtrx.markdown
View file

@ -24,7 +24,7 @@ switch:
automatic_add: True
```
Launch your homeassistant and go the website.
Launch your Home Assistant and go the website.
Push your remote and your device should be added:
<p class='img'>
@ -62,7 +62,7 @@ If you need to generate codes for switches you can use a template (useful for ex
```
- Use this code to add a new switch in your configuration.yaml
- Launch your homeassistant and go the website.
- Launch your Home Assistant and go the website.
- Enable learning mode on your switch (i.e. push learn button or plug it in a wall socket)
- Toggle your new switch in the Home Assistant interface

4
source/_components/tradfri.markdown
View file

@ -55,7 +55,7 @@ $ make install
You will be prompted to configure the gateway through the Home Assistant interface, Enter the security key when prompted and click configure
<p class='note'>
If you see an "Unable to connect" message, restart the gateway and try again.
If you see an "Unable to connect" message, restart the gateway and try again. Don't forget to assign a permanent IP to your Trådfri gateway.
</p>
The gateway can also be manually configured by adding the following lines to your `configuration.yaml` file:
@ -71,4 +71,4 @@ Configuration variables:
- **host** (*Required*): The IP address or hostname of your Trådfri gateway.
- **api_key** (*Required*): Can be found listed as Security Key on the back of the Trådfri gateway.
- **allow_tradfri_groups** (*Optional*): (true/false) Enable this to stop Home Assistant from importing the groups defined on the Tradfri bridge.
- **allow_tradfri_groups** (*Optional*): (true/false) Enable this to stop Home Assistant from importing the groups defined on the Trådfri bridge.