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

Merge branch 'master' into next

Browse source
This commit is contained in:
Paulus Schoutsen 2016-05-07 10:44:11 -07:00
commit fa222258cd
93 changed files with 854 additions and 6675 deletions
Download patch file Download diff file Expand all files Collapse all files

1
source/_components/arduino.markdown
View file

@ -10,6 +10,7 @@ footer: true
logo: arduino.png
ha_category: DIY
featured: true
ha_release: pre 0.7
---
The [Arduino](https://www.arduino.cc/) device family are microcontroller boards that are often based on the ATmega328 chip. They come with digital input/output pins (some can be used as PWM outputs), analog inputs, and a USB connection. The equipment depends on the [type](https://www.arduino.cc/en/Main/Products) of board. The most common ones are the Arduino Uno and the Arduino Leonardo with 14 digital input/output pins and 6 analog input pins.

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

@ -23,6 +23,7 @@ binary_sensor:
platform: command_line
command: cat /proc/sys/net/ipv4/ip_forward
name: 'IP4 forwarding'
sensor_class: opening
payload_on: "1"
payload_off: "0"
value_template: '{% raw %}{{ value.x }}{% endraw %}'
@ -32,6 +33,7 @@ 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.
- **sensor_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".
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.

1
source/_components/binary_sensor.http.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: http.png
ha_category: Binary Sensor
ha_release: pre 0.7
---
The URL for a binary sensor looks like the example below:

1
source/_components/binary_sensor.rpi_gpio.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Sensor
ha_release: pre 0.7
---

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

@ -28,10 +28,9 @@ Configuration variables:
- **sensors** array (*Required*): List of your sensors.
- **friendly_name** (*Optional*): Name to use in the Frontend.
- **sensor_class** (*Optional*): Defines the class of the sensor (motion, heat, moisture, etc)
- **sensor_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
## {% linkable_title Examples %}
In this section you find some real life examples of how to use this sensor.

1
source/_components/camera.generic.markdown
View file

@ -8,6 +8,7 @@ comments: false
sharing: true
footer: true
ha_category: Camera
ha_release: pre 0.7
---

1
source/_components/device_tracker.asuswrt.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: asus.png
ha_category: Presence Detection
ha_release: pre 0.7
---

1
source/_components/device_tracker.owntracks.markdown
View file

@ -10,6 +10,7 @@ footer: true
logo: owntracks.png
ha_category: Presence Detection
featured: true
ha_release: 0.7.4
---

1
source/_components/device_tracker.tplink.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: tp-link.png
ha_category: Presence Detection
ha_release: pre 0.7
---

1
source/_components/downloader.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: home-assistant.png
ha_category: Other
ha_release: pre 0.7
---
The `downloader` component provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist.

1
source/_components/isy994.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: universal_devices.png
ha_category: Hub
ha_release: pre 0.7
---
The ISY994 is a home automation controller that is capable of controlling Insteon and X10 devices. The controller is also capable of controlling Z-Wave devices but that functionality has not yet been confirmed with Home Assistant.

1
source/_components/light.limitlessled.markdown
View file

@ -10,6 +10,7 @@ sharing: true
footer: true
ha_category: Light
ha_iot_class: "Assumed State"
ha_release: pre 0.7
---
`limitlessled` can control your [LimitlessLED](http://www.limitlessled.com/) lights from within Home Assistant. The lights are also known as EasyBulb, AppLight, AppLamp, MiLight, LEDme, dekolight or iLight.

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

@ -15,7 +15,7 @@ ha_iot_class: "Assumed State"
This `tellstick` light platform allows you to control your [TellStick](http://www.telldus.se/products/tellstick) dimmers.
To use your TellStick device in your installation, add the following to your `configuration.yaml` file:
To use your TellStick device, you first have to set up your [Tellstick hub](https://home-assistant.io/components/tellstick/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

1
source/_components/media_player.itunes.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: itunes.png
ha_category: Media Player
ha_release: 0.7.3
---

1
source/_components/media_player.kodi.markdown
View file

@ -10,6 +10,7 @@ footer: true
logo: kodi.png
ha_category: Media Player
featured: true
ha_release: pre 0.7
---

1
source/_components/media_player.mpd.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: mpd.png
ha_category: Media Player
ha_release: pre 0.7
---

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

@ -10,10 +10,11 @@ footer: true
logo: plex.png
ha_category: Media Player
featured: true
ha_release: 0.7.4
---
The Plex platform allows you to connect a [Plex Media Server](https://plex.tv) to Home Assistant. It will allow you to control media playback and see the current playing item. The preferred way to setup the Plex platform is by enabling the the [the discovery component](/components/discovery/) and requires GDM to be enabled.
The `plex` platform allows you to connect a [Plex Media Server](https://plex.tv) to Home Assistant. It will allow you to control media playback and see the current playing item. The preferred way to setup the Plex platform is by enabling the the [the discovery component](/components/discovery/) and requires GDM to be enabled.
If local authentication is enabled or multiple users are defined, HASS requires an authentication token to be entered in the webinterface. See [Finding your account token / X-Plex-Token](https://support.plex.tv/hc/en-us/articles/204059436).

1
source/_components/media_player.sonos.markdown
View file

@ -10,6 +10,7 @@ footer: true
logo: sonos.png
ha_category: Media Player
featured: true
ha_release: 0.7.3
---

1
source/_components/media_player.squeezebox.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: logitech.png
ha_category: Media Player
ha_release: pre 0.7
---

1
source/_components/modbus.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: modbus.png
ha_category: Hub
ha_release: pre 0.7
---

1
source/_components/mqtt.markdown
View file

@ -10,6 +10,7 @@ footer: true
logo: mqtt.png
ha_category: Hub
featured: true
ha_release: pre 0.7
---
MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things" connectivity protocol on top of TCP/IP. It allows extremely lightweight publish/subscribe messaging transport.

1
source/_components/notify.instapush.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: instapush.png
ha_category: Notifications
ha_release: pre 0.7
---

1
source/_components/notify.nma.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: nma.png
ha_category: Notifications
ha_release: pre 0.7
---

1
source/_components/notify.pushover.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: pushover.png
ha_category: Notifications
ha_release: pre 0.7
---

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: slack.png
ha_category: Notifications
ha_release: pre 0.7
---

1
source/_components/notify.smtp.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: smtp.png
ha_category: Notifications
ha_release: pre 0.7
---

1
source/_components/notify.syslog.markdown
View file

@ -8,6 +8,7 @@ comments: false
sharing: true
footer: true
ha_category: Notifications
ha_release: pre 0.7
---

1
source/_components/notify.xmpp.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: xmpp.png
ha_category: Notifications
ha_release: pre 0.7
---

4
source/_components/rfxtrx.markdown
View file

@ -8,8 +8,10 @@ comments: false
sharing: true
footer: true
ha_category: Hub
ha_release: pre 0.7
---
The rfxtrx component supports RFXtrx devices by [RFXCOM](http://www.rfxcom.com) which communicate in the frequency range of 433.92 MHz.
The `rfxtrx` component supports RFXtrx devices by [RFXCOM](http://www.rfxcom.com) which communicate in the frequency range of 433.92 MHz.
To enable RFXtrx in your installation, add the following to your `configuration.yaml` file:

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: arduino.png
ha_category: DIY
ha_release: pre 0.7
---

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: bitcoin.png
ha_category: Sensor
ha_release: pre 0.7
---

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: efergy.png
ha_category: Sensor
ha_release: pre 0.7
---

9
source/_components/sensor.forecast.markdown
View file

@ -10,6 +10,7 @@ footer: true
logo: forecast.png
ha_category: Weather
featured: true
ha_release: pre 0.7
---
The `forecast` platform uses the [Forecast.io](https://forecast.io/) web service as a source of meteorological data for your location. The location is based on the `longitude` and `latitude` coordinates configured in `configuration.yaml`. The coordinates are auto-detected but to take advantage of the hyper-local weather reported by forecast.io, you can refine them down to your exact home address. GPS coordinates can be found by using Google Maps and clicking on your home.
@ -41,13 +42,16 @@ sensor:
- pressure
- visibility
- ozone
- minutely_summary
- hourly_summary
- daily_summary
```
Configuration variables:
- **api_key** (*Required*): Your API key for http://forecast.io/.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend.
- **summary**: A human-readable text summary.
- **summary**: A human-readable text summary of the current conditions.
- **precip_type**: The type of precipitation occurring.
- **precip_intensity**: The average expected intensity of precipitation occurring.
- **precip_probability**: A value between 0 and 1 which is representing the probability of precipitation.
@ -61,6 +65,9 @@ Configuration variables:
- **pressure**: The sea-level air pressure in millibars.
- **visibility**: The average visibility.
- **ozone**: The columnar density of total atmospheric ozone in Dobson.
- **minutely_summary**: A human-readable text summary for the next hour.
- **hourly_summary**: A human-readable text summary for the next 24 hours.
- **daily_summary**: A human-readable text summary for the next 7 days.
- **units** (*Optional*): Specify the unit system. Default to `si` or `us` based on the temperature preference in Home Assistant. Other options are `auto`, `us`, `si`, `ca`, and `uk2`.
`auto` will let forecast.io decide the unit system based on location.

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: http.png
ha_category: Sensor
ha_release: pre 0.7
---
The URL for a sensor looks like the example below:

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: modbus.png
ha_category: Sensor
ha_release: pre 0.7
---

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: openweathermap.png
ha_category: Weather
ha_release: pre 0.7
---

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

@ -8,6 +8,7 @@ comments: false
sharing: true
footer: true
ha_category: Sensor
ha_release: 0.7.4
---

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: sabnzbd.png
ha_category: Sensor
ha_release: pre 0.7
---

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

@ -9,6 +9,7 @@ sharing: true
footer: true
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_release: pre 0.7
---

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

@ -8,6 +8,7 @@ comments: false
sharing: true
footer: true
ha_category: Sensor
ha_release: pre 0.7
---
The `systemmonitor` sensor platform to allow you to monitor disk usage, memory usage, CPU usage, and running processes. This platform has superseded the process component which is now considered deprecated.

3
source/_components/sensor.tellstick.markdown
View file

@ -14,7 +14,8 @@ ha_category: Sensor
The `tellstick` sensor platform allows you to get current meteorological data from a [TellStick](http://www.telldus.se/products/tellstick) device.
To use your TellStick device in your installation, add the following to your `configuration.yaml` file:
To use your TellStick device, you first have to set up your [Tellstick hub](https://home-assistant.io/components/tellstick/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

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

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Sensor
ha_iot_class: "Local Push"
ha_release: pre 0.7
---

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: transmission.png
ha_category: Sensor
ha_release: pre 0.7
---

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

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png
ha_category: Sensor
ha_iot_class: "Local Push"
ha_release: pre 0.7
---

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

@ -9,10 +9,11 @@ sharing: true
footer: true
logo: arduino.png
ha_category: DIY
ha_release: pre 0.7
---
The `arduino` switch platform allows you to control the digital pins of your [Arduino](https://www.arduino.cc/) board. Support for switching pins is limited to high/on and low/off of the digital pins. PWM (pin 3,5,6,9,10, and 11 on an Arduino Uno) is not supported yet.
The `arduino` switch platform allows you to control the digital pins of your [Arduino](https://www.arduino.cc/) board. Support for switching pins is limited to high/on and low/off of the digital pins. PWM (pin 3, 5, 6, 9, 10, and 11 on an Arduino Uno) is not supported yet.
To enable the Arduino pins with Home Assistant, add the following section to your `configuration.yaml` file:

9
source/_components/switch.command_line.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: command_line.png
ha_category: Switch
ha_release: pre 0.7
---
@ -91,10 +92,9 @@ switch:
### {% linkable_title Control Foscam Motion Sensor %}
This switch will control the motion sensor of Foscam Webcams which Support CGI Commands ([Source](http://www.ipcamcontrol.net/files/Foscam%20IPCamera%20CGI%20User%20Guide-V1.0.4.pdf)). This switch supports statecmd, which checks the current state of motion detection.
```yaml
# Example configuration.yaml entry
# Replace admin and password with an "Admin" priviledged Foscam user
# Replace ipaddress with the local IP address of your Foscam
switch:
platform: command_line
switches:
@ -102,5 +102,8 @@ switch:
oncmd: 'curl -k "https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=setMotionDetectConfig&isEnable=1&usr=admin&pwd=password"'
offcmd: 'curl -k "https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=setMotionDetectConfig&isEnable=0&usr=admin&pwd=password"'
statecmd: 'curl -k --silent "https://ipaddress:443/cgi-bin/CGIProxy.fcgi?cmd=getMotionDetectConfig&usr=admin&pwd=password" | grep -oP "(?<=isEnable>).*?(?=</isEnable>)"'
value_template: '{{ value == "1" }}'
value_template: {% raw %}'{{ value == "1" }}'{% endraw %}
```
- Replace admin and password with an "Admin" priviledged Foscam user
- Replace ipaddress with the local IP address of your Foscam

1
source/_components/switch.edimax.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: edimax.png
ha_category: Switch
ha_release: pre 0.7
---

1
source/_components/switch.hikvision.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: hikvision.png
ha_category: Switch
ha_release: pre 0.7
---

1
source/_components/switch.modbus.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: modbus.png
ha_category: Switch
ha_release: pre 0.7
---

1
source/_components/switch.rpi_gpio.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Switch
ha_release: pre 0.7
---

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

@ -15,7 +15,7 @@ ha_iot_class: "Assumed State"
This `tellstick` switch platform allows you to control [TellStick](http://www.telldus.se/products/tellstick) devices.
To use your TellStick device in your installation, add the following to your `configuration.yaml` file:
To use your TellStick device, you first have to set up your [Tellstick hub](https://home-assistant.io/components/tellstick/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

1
source/_components/switch.transmission.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: transmission.png
ha_category: Switch
ha_release: pre 0.7
---

2
source/_components/thermostat.heat_control.markdown
View file

@ -32,4 +32,4 @@ Configuration variables:
- **target_sensor** (*Required*): `entity_id` for a temperature sensor, target_sensor.state must be temperature.
- **min_temp** (*Optional*): Set minimum set point available (default: 7)
- **max_temp** (*Optional*): Set maximum set point available (default: 35)
- **target_temp** (*Required*): Set default target temperature. Failure to set this variable will result in target temperature being set to null on startup.
- **target_temp** (*Required*): Set intital target temperature. Failure to set this variable will result in target temperature being set to null on startup.

11
source/_components/verisure.markdown
View file

@ -9,19 +9,18 @@ sharing: true
footer: true
logo: verisure.png
ha_category: Hub
ha_release: pre 0.7
---
Home Assistant has support to integrate your [Verisure](https://www.verisure.com/) devices.
We support:
* Alarm
* Smartplugs
* Reading from thermometers and hygrometers integrated in various devices
* [Alarm](/components/alarm_control_panel.verisure/)
* [Smartplugs](/components/switch.verisure/)
* Reading from thermometers and hygrometers integrated in various [devices](/components/sensor.verisure/)
* Mouse Detector
* Locks
* [Locks](/components/lock.verisure/)
To integrate Verisure with Home Assistant, add the following section to your `configuration.yaml` file: