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

Merge branch 'current' into next

Browse source
This commit is contained in:
Fabian Affolter 2017-11-08 09:22:04 +01:00
commit 9faf94b30e
No known key found for this signature in database
GPG key ID: DDF3D6F44AAB1336
34 changed files with 415 additions and 146 deletions
Download patch file Download diff file Expand all files Collapse all files

9
source/_components/arduino.markdown
View file

@ -30,9 +30,12 @@ arduino:
port: /dev/ttyACM0
```
Configuration variables:
- **port** (*Required*): The port where your board is connected to your Home Assistant host. If you are using an original Arduino, the port will be named `ttyACM*` otherwise `ttyUSB*`.
{% configuration %}
port:
description: The port where your board is connected to your Home Assistant host. If you are using an original Arduino, the port will be named `ttyACM*` otherwise `ttyUSB*`.
required: true
type: string
{% endconfiguration %}
The exact number can be determined with the command shown below.

53
source/_components/binary_sensor.template.markdown
View file

@ -39,31 +39,36 @@ binary_sensor:
required: true
type: map
keys:
friendly_name:
description: Name to use in the frontend.
required: false
type: string
entity_id:
description: Add a list of entity IDs so the sensor only reacts to state changes of these entities. This will reduce the number of times the sensor will try to update its state.
required: false
type: string, list
device_class:
description: The type/class of the sensor to set the icon in the frontend.
required: false
type: device_class
default: None
value_template:
description: Defines a template to set the state of the sensor.
sensor_name:
description: The slug of the sensor.
required: true
type: template
delay_on:
description: The amount of time the template state must be ***met*** before this sensor will switch to `on`.
required: false
type: time
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
type: map
keys:
friendly_name:
description: Name to use in the frontend.
required: false
type: string
entity_id:
description: Add a list of entity IDs so the sensor only reacts to state changes of these entities. This will reduce the number of times the sensor will try to update its state.
required: false
type: string, list
device_class:
description: The type/class of the sensor to set the icon in the frontend.
required: false
type: device_class
default: None
value_template:
description: Defines a template to set the state of the sensor.
required: true
type: template
delay_on:
description: The amount of time the template state must be ***met*** before this sensor will switch to `on`.
required: false
type: time
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
{% endconfiguration %}
## {% linkable_title Considerations %}

2
source/_components/camera.markdown
View file

@ -43,6 +43,8 @@ Take a snapshot from a camera.
| `entity_id` | no | Name(s) of entities to create a snopshot from, e.g., `camera.living_room_camera`. |
| `filename ` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}`{% endraw %}. |
The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
### {% linkable_title Test if it works %}
A simple way to test if you have set up your `camera` platform correctly, is to use <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools**. Choose your service from the dropdown menu **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**.

58
source/_components/camera.rpi_camera.markdown
View file

@ -24,17 +24,53 @@ camera:
- platform: rpi_camera
```
Configuration variables:
- **name** (*Optional*): Name of the camera
- **image_width** (*Optional*): Set the image width (default: 640)
- **image_height** (*Optional*): Set the image height (default: 480)
- **image_quality** (*Optional*): Set the image quality (from 0 to 100, default: 7)
- **image_rotation** (*Optional*): Set image rotation (0-359, default: 0)
- **horizontal_flip** (*Optional*): Set horizontal flip (0 to disable, 1 to enable, default: 0)
- **vertical_flip** (*Optional*): Set vertical flip (0 to disable, 1 to enable, default: 0)
- **timelapse** (*Optional*): Takes a picture every ms (default: 1000)
- **file_path** (*Optional*): Save the picture in a custom file path (default: camera components folder)
{% configuration %}
image_width:
description: Set the image width.
required: false
default: 640
type: int
name:
description: Name of the camera.
required: false
default: Raspberry Pi Camera
type: string
image_height:
description: Set the image height.
required: false
default: 480
type: int
image_quality:
description: Set the image quality (from 0 to 100).
required: false
default: 7
type: int
image_rotation:
description: Set image rotation (0-359).
required: false
default: 0
type: int
horizontal_flip:
description: Set horizontal flip (0 to disable, 1 to enable).
required: false
default: 0
type: int
vertical_flip:
description: Set vertical flip (0 to disable, 1 to enable).
required: false
default: 0
type: int
timelapse:
description: Takes a picture every millisecond.
required: false
default: 1000
type: int
file_path:
description: Save the picture in a custom file path.
required: false
default: The camera components folder.
type: string
{% endconfiguration %}
The given **file_path** must be an existing file because the camera platform setup make a writeable check on it.

2
source/_components/climate.ephember.markdown
View file

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: ephcontrolsember.png
ha_category: Climate
ha_release: "0.55"
ha_release: 0.57
ha_iot_class: "Local Polling"
---

5
source/_components/input_number.markdown
View file

@ -145,13 +145,12 @@ input_number:
icon: mdi:target
# Automation.
# This automation script runs when a value is received via MQTT on retained topic: setTemperature
# It sets the value slider on the GUI. This slides also had its own automation when the value is changed.
# This automation script runs when a value is received via MQTT on retained topic: setTemperature
# It sets the value slider on the GUI. This slides also had its own automation when the value is changed.
- alias: Set temp slider
trigger:
platform: mqtt
topic: "setTemperature"
# entity_id: input_number.target_temp
action:
service: input_number.set_value
data_template:

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

@ -97,4 +97,7 @@ Vizio SmartCast service is accessible through HTTPS with self-signed certificate
`InsecureRequestWarning: Unverified HTTPS request is being made. Adding certificate verification is strongly advised.`
You can adjust the log level for `media_player` components with the [logger](https://home-assistant.io/components/logger/) component, or if you need to keep a low log level for `media_player` you could proxy calls to your TV through an NGINX reverse proxy.
If you want to only ignore only this specific [python urllib3 SSL warning](https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings), you will need to run Home Assistant with the python flag `-W` or the environment variable `PYTHONWARNINGS` set to:
`ignore:Unverified HTTPS request is being made`
</p>

26
source/_components/notify.slack.markdown
View file

@ -52,8 +52,10 @@ The following attributes can be placed `data` for extended functionality.
| `username` | yes | Username if the url requires authentication. Is placed inside `file`.
| `password` | yes | Password if the url requires authentication. Is placed inside `file`.
| `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing HTTP-BASIC-Authentication is used. Is placed inside `file`.
| `attachments` | yes | Array of [Slack attachments](https://api.slack.com/docs/message-attachments). See [the attachment documentation](https://api.slack.com/docs/message-attachments) for how to format. *NOTE*: if using `attachments`, they are shown **in addition** to `message`
Example for posting file from URL:
Example for posting file from URL
```json
{
"message":"Message that will be added as a comment to the file.",
@ -68,7 +70,9 @@ Example for posting file from URL
}
}
```
Example for posting file from local path
Example for posting file from local path:
```json
{
"message":"Message that will be added as a comment to the file.",
@ -82,5 +86,23 @@ Example for posting file from local path
```
Please note that `path` is validated against the `whitelist_external_dirs` in the `configuration.yaml`.
Example for posting formatted attachment:
```json
{
"message": "",
"data": {
"attachments": [
{
"title": "WHAT A HORRIBLE NIGHT TO HAVE A CURSE.",
"image_url": "http://i.imgur.com/JEExnsI.gif"
}
]
}
}
```
Please note that both `message` is a required key, but is always shown, so use an empty (`""`) string for `message` if you don't want the extra text.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

4
source/_components/remember_the_milk.markdown
View file

@ -26,7 +26,7 @@ To be able to use this component, you need a Remember The Milk account and you n
# Example configuration.yaml entry
remember_the_milk:
your_rtm_account:
- name: your_rtm_account
api_key: <your secret api key goes here>
shared_secret: <your secret shared secret goes here>
@ -35,7 +35,7 @@ remember_the_milk:
Configuration variables:
{% configuration %}
account_name:
name:
description: Name of the RTM account, as you can have serveral accounts in RTM. The name must be unique.
required: true
type: string

21
source/_components/sensor.arduino.markdown
View file

@ -27,14 +27,23 @@ sensor:
name: Door switch
0:
name: Brightness
```
Configuration variables:
- **pins** array (*Required*): Array of pins to use.
- **[number]** (*Required*): The pin number that corresponds with the pin numbering schema of your board.
- **name** (*Optional*): Name that will be used in the frontend for the pin.
{% configuration %}
pins:
description: List of pins to use.
required: true
type: map
keys:
pin_number:
description: The pin number that corresponds with the pin numbering schema of your board.
required: true
type: map
keys:
name:
default: Name that will be used in the frontend for the pin.
type: string
{% endconfiguration %}
The 6 analog pins of an Arduino UNO are numbered from A0 to A5.

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

@ -10,7 +10,7 @@ footer: true
logo: irishrail.png
ha_category: Transport
ha_iot_class: "Cloud Polling"
ha_release: 0.56
ha_release: 0.57
---

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

@ -36,7 +36,6 @@ sensor:
- Enfield
- Greenwich
- Hackney
- Hammersmith and Fulham
- Haringey
- Harrow
- Havering

10
source/_components/sensor.luftdaten.markdown
View file

@ -46,7 +46,7 @@ sensor:
default: Luftdaten Sensor
type: string
resource:
description: The URL of the API endpoint. Usually this has not to be changed.
description: The URL of the API endpoint. Usually this has not to be changed.
required: false
default: https://api.luftdaten.info/v1/sensor/
type: string
@ -62,19 +62,11 @@ sensor:
keys:
P1:
description: Show the particle sensors (particles 10 microns and below).
required: false
type: string
P2:
description: Show the particle sensors (particles 2.5 microns and below).
required: false
type: string
temperature:
description: Display the temperature from a weather sensor.
required: false
type: string
humidity:
description: Display the humidity from a weather sensor.
required: false
type: string
{% endconfiguration %}

60
source/_components/sensor.openweathermap.markdown
View file

@ -29,21 +29,49 @@ sensor:
- weather
```
Configuration variables:
- **api_key** (*Required*): Your API key for http://openweathermap.org/.
- **name** (*Optional*): Additional name for the sensors. Default to platform name.
- **forecast** (*Optional*): Enables the forecast. The default is to display the current conditions.
- **language** (*Optional*): The language in which you want text results to be returned. It's a two-characters string, eg. `en`, `es`, `ru`, `it`, etc. Defaults to English.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend.
- **weather**: A human-readable text summary.
- **temperature**: The current temperature.
- **wind_speed**: The wind speed.
- **wind_bearing**: The wind bearing.
- **humidity**: The relative humidity.
- **pressure**: The sea-level air pressure in millibars.
- **clouds**: Description about cloud coverage.
- **rain**: The rain volume.
- **snow**: The snow volume
{% configuration %}
apk_key:
description: Your API key for OpenWeatherMap.
required: true
type: string
name:
description: Additional name for the sensors. Default to platform name.
required: false
default: OWM
type: string
forecast:
description: Enables the forecast. The default is to display the current conditions.
required: false
default: false
type: string
language:
description: The language in which you want text results to be returned. It's a two-characters string, eg. `en`, `es`, `ru`, `it`, etc.
required: false
default: en
type: string
monitored_conditions:
description: Conditions to display in the frontend.
required: true
type: list
keys:
weather:
description: A human-readable text summary.
temperature:
description: The current temperature.
wind_speed:
description: The wind speed.
wind_bearing:
description: The wind bearing.
humidity:
description: The relative humidity.
pressure:
description: The sea-level air pressure in millibars.
clouds:
description: Description about cloud coverage.
rain:
description: The rain volume.
snow:
description: The snow volume.
{% endconfiguration %}
Details about the API are available in the [OpenWeatherMap documentation](http://openweathermap.org/api).

33
source/_components/switch.arduino.markdown
View file

@ -31,13 +31,32 @@ switch:
negate: true
```
Configuration variables:
- **pins** array (*Required*): List of pins to use.
- **[number]** (*Required*): The pin number that corresponds with the pin numbering schema of your board.
- **name** (*Required*): Name that will be used in the frontend for the pin.
- **initial** (*Optional*): The initial value for this port. Defaults to `False` .
- **negate** (*Optional*): If this pin should be inverted. Defaults to `False`.
{% configuration %}
pins:
description: List of of pins to use.
required: true
type: map
keys:
pin_number:
description: The pin number that corresponds with the pin numbering schema of your board.
required: true
type: map
keys:
name:
default: Name that will be used in the frontend for the pin.
type: string
required: false
initial:
default: The initial value for this port.
type: boolean
required: false
default: false
negate:
default: If this pin should be inverted.
type: boolean
required: false
default: false
{% endconfiguration %}
The digital pins are numbered from 0 to 13 on a Arduino UNO. The available pins are 2 till 13. For testing purposes you can use pin 13 because with that pin you can control the internal LED.

2
source/_components/switch.rainbird.markdown
View file

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: rainbird.png
ha_category: Hub
ha_release: 0.50
ha_release: 0.57
ha_iot_class: "Local Polling"
---

6
source/_components/tradfri.markdown
View file

@ -22,6 +22,10 @@ You will be prompted to configure the gateway through the Home Assistant interfa
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>
<p class='note'>
The Python version 3.4.4 or greater is required for this component. The component will not initialize without this and will report a `Could not install all requirements` error in the logs.
</p>
You can add the following to your `configuration.yaml` file if you are not using the [`discovery:`](/components/discovery/) component:
```yaml
@ -33,7 +37,7 @@ tradfri:
Configuration variables:
- **host** (*Required*): The IP address or hostname of your Trådfri gateway.
- **allow_tradfri_groups** (*Optional*): Enable this to stop Home Assistant from importing the groups defined on the Trådfri bridge. Defaults to `true`.
- **allow_tradfri_groups** (*Optional*): Set this to `false` to stop Home Assistant from importing the groups defined on the Trådfri bridge. Defaults to `true`.
<p class='note'>
Do not use the `api_key` variable. The key is only needed once at initial setup.