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:
Paulus Schoutsen 2017-03-01 23:40:45 -08:00
commit 8d7811c7c4
31 changed files with 375 additions and 65 deletions
Download patch file Download diff file Expand all files Collapse all files

3
source/_components/automation.markdown
View file

@ -19,12 +19,13 @@ Starting with 0.28 your automation rules can be controlled with the frontend.
<img src='{{site_root}}/images/screenshots/automation-switches.png' />
</p>
This allows one to reload the automation without restarting Home Assistant itself. If you don't want to see the automation rule in your frontend use `hide_entity: True` to hide it.
This allows one to reload the automation without restarting Home Assistant itself. If you don't want to see the automation rule in your frontend use `hide_entity: True` to hide it. You can also use `initial_state: 'off'` so that the automation is not automatically turned on after a Home assistant reboot.
```yaml
automation:
- alias: Door alarm
hide_entity: True
initial_state: 'off'
trigger:
- platform: state
...

22
source/_components/binary_sensor.insteon_plm.markdown Normal file
View file

@ -0,0 +1,22 @@
---
layout: page
title: "Insteon PLM Binary Sensor"
description: "Instructions how to setup the Insteon PLM switches locally within Home Assistant."
date: 2017-02-19 17:00
sidebar: true
comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: Binary Sensor
ha_iot_class: "Local Push"
ha_version: 0.39
---
The `insteon_plm` binary sensor platform lets you control your sensors through
an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a
USB or serial port. To add support, set up the primary [insteon_plm]
component.
[insteon_plm]: /components/insteon_plm/

5
source/_components/device_tracker.gpslogger.markdown
View file

@ -27,7 +27,7 @@ device_tracker:
To configure GPSLogger, you must set up the app to send a `GET` request to your Home Assistant server at
```yaml
`http://<ha_server>/api/gpslogger?latitude=%LAT&longitude=%LON&device=%SER&accuracy=%ACC&battery=%BATT&speed=%SPD&direction=%DIR&altitude=%ALT&provider=%PROV&activity=%ACT`
http://<ha_server>/api/gpslogger?latitude=%LAT&longitude=%LON&device=%SER&accuracy=%ACC&battery=%BATT&speed=%SPD&direction=%DIR&altitude=%ALT&provider=%PROV&activity=%ACT
```
. Make sure to include the API password if you have configured a password in Home Assistant (add `&api_password=<password>` to the end of the URL). Configure that options under "General Options":
@ -40,8 +40,9 @@ Set the URL under "General Options -> Logging details":
- Log to KML: no
- Log to custom URL: yes and set
```yaml
`http://<ha_server>/api/gpslogger?latitude=%LAT&longitude=%LON&device=%SER&accuracy=%ACC&battery=%BATT&speed=%SPD&direction=%DIR&altitude=%ALT&provider=%PROV&activity=%ACT` (be sure you include API password (`&api_password=<password>`) if needed, or you can also use HTTP Basic authentication `http://<username>:<password>@<ha_server>/api/gpslogger...`)
http://<ha_server>/api/gpslogger?latitude=%LAT&longitude=%LON&device=%SER&accuracy=%ACC&battery=%BATT&speed=%SPD&direction=%DIR&altitude=%ALT&provider=%PROV&activity=%ACT
```
(be sure you include API password (`&api_password=<password>`) if needed, or you can also use HTTP Basic authentication `http://<username>:<password>@<ha_server>/api/gpslogger...`)
- Log to OpenGTS Server: no
- Log to Plain Text: no
- Log to NMEA: no

7
source/_components/hdmi_cec.markdown
View file

@ -133,10 +133,9 @@ hdmi_cec:
Then you set individual platform for devices in customizations:
```yaml
homeassistant:
customize:
hdmi_cec.hdmi_5:
platform: media_player
hdmi_cec:
types:
hdmi_cec.hdmi_5: media_player
```
And the last option is `host`. PyCEC supports bridging CEC commands over TCP. When you start pyCEC on machine with HDMI port (`python -m pycec`), you can then run homeassistant on another machine and connect to CEC over TCP. Specify TCP address of pyCEC server:

89
source/_components/insteon_plm.markdown Normal file
View file

@ -0,0 +1,89 @@
---
layout: page
title: "Insteon PLM"
description: "Instructions how to setup an Insteon USB PLM locally within Home Assistant."
date: 2017-02-19 16:00
sidebar: true
comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: Hub
ha_iot_class: "Local Push"
ha_version: 0.39
---
This component adds "local push" support for INSTEON PowerLinc Modems allowing
linked INSTEON devices to be used within Home Assistant as lights, switches,
and binary sensors. Device support is provided by the underlying [insteonplm]
package. It is known to work with both the [2413U] USB and [2412S]
RS242 flavors of PLM. This component does not work with the IP-based hub
products. For that, you'll want the "Insteon (Local)" component instead.
[insteonplm]: https://github.com/nugget/python-insteonplm
[2413U]: https://www.insteon.com/powerlinc-modem-usb
[2412S]: https://www.insteon.com/powerlinc-modem-serial
```yaml
# insteon_plm supported configuration variables
insteon_plm:
port: SERIAL_PORT
device_override:
- address: INSTEON_ADDRESS
platform: DEVICE_PLATFORM
```
Configuration variables:
- **port** (*Required*): The port for your device, e.g. `/dev/ttyUSB0`
- **device_override** (*Optional*): Override the default device platform
### {% linkable_title Customization %}
The only configuration item that is absolutely necessary is the port so that
Home Assistant can connect to the PLM. This will expose all the supported INSTEON
devices which exist in the modem's ALL-Link database. However, devices will
only be shown by their INSTEON hex address (e.g. "1A.2B.3C") which can be a bit
unwieldy. As you link and unlink devices using the 'Set' buttons, they'll be
added and removed from Home Assistant automatically.
You can use the normal Home Assistant [device customization] section of your
configuration to assign friendly names and special icons to your devices. This
is especially useful for setting device_class on your binary_sensor INSTEON
devices.
[device customization]: /getting-started/customizing-devices/
### {% linkable_title Device Overrides %}
INSTEON devices are added to Home Assistant using the platform(s) that make the
most sense given the model and features of the hardware. In most cases this is
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
can set any device (by address) to explicitly use a specific platform if the
default is not correct.
### {% linkable_title Example Configuration with Options%}
```yaml
# Full example of insteon_plm configuration with customizations and overrides
homeassistant:
customize:
light.a1b2c3:
friendly_name: Bedside Lamp
binary_sensor.a2b3c4:
friendly_name: Garage Door
device_class: opening
insteon_plm:
port: /dev/ttyUSB0
device_override:
- address: a1b2c3 # Icon Appliance Module for bedside lamp
platform: light # make it a light instead of a switch
```

22
source/_components/light.insteon_plm.markdown Normal file
View file

@ -0,0 +1,22 @@
---
layout: page
title: "Insteon PLM Light"
description: "Instructions how to setup Insteon PLM lights locally within Home Assistant."
date: 2017-02-19 17:00
sidebar: true
comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: Light
ha_iot_class: "Local Push"
ha_version: 0.39
---
The `insteon_plm` light platform lets you control your sensors through
an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a
USB or serial port. To add support, set up the primary [insteon_plm]
component.
[insteon_plm]: /components/insteon_plm/

4
source/_components/media_player.gstreamer.markdown
View file

@ -52,10 +52,10 @@ sudo yum install -y python-gstreamer1 gstreamer1-plugins-good \
For Fedora replace `yum` with `dnf`.
If you're running Home Assistant in a virtual environment, you'll need to symlink the system Python's `gst` module into your virtual environment:
If you're running Home Assistant in a virtual environment, you'll need to symlink the system Python's `gi` module into your virtual environment:
```bash
ln -s /path/to/your/installation/of/gst /path/to/your/venv/lib/python3.4/site-packages
ln -s /path/to/your/installation/of/gi /path/to/your/venv/lib/python3.4/site-packages
```
On a Raspberry PI, you may need to add the Home Assistant user to the `audio` group:

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

@ -13,7 +13,7 @@ ha_release: 0.32
---
The `matrix` platform allows you to deliver notifications from Home Assistant to a Matrix room. Rooms can be both direct as well as group chats.
The `matrix` platform allows you to deliver notifications from Home Assistant to a [Matrix](http://matrix.org) room. Rooms can be both direct as well as group chats.
To enable Matrix notifications in your installation, add the following to your `configuration.yaml` file:

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

@ -53,3 +53,23 @@ This is a quote from the Pushover website regarding free/open source apps:
When setting up the application you can use this [icon](https://home-assistant.io/images/favicon-192x192.png).
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
When sending a notification, optional parameters can also be set as per the pushover [API documentation](https://pushover.net/api).
Example notification triggered from the Alexa component for an intents is shown below which also uses [Automation Templating](/getting-started/automation-templating/) for the message:
```yaml
# Example configuration.yaml entries
alexa:
intents:
LocateIntent:
action:
service: notify.notify
data_template:
message: "The location of {% raw %}{{ User }}{% endraw %} has been queried via Alexa."
data:
title: "Home Assistant"
sound: falling
device: pixel
url: "https://home-assistant.io/"
```

57
source/_components/sensor.fido.markdown Normal file
View file

@ -0,0 +1,57 @@
---
layout: page
title: "Fido"
description: "Instructions how to integrate Fido data usage within Home Assistant."
date: 2017-01-01 17:17
sidebar: true
comments: false
sharing: true
footer: true
logo: fido.png
ha_category: Sensor
ha_release: 0.39
ha_iot_class: "Cloud Polling"
---
Integrate your [Fido](https://www.fido.ca/) account information into Home Assistant.
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
sensor:
- platform: fido
username: MYUSERNAME
password: MYPASSWORD
monitored_variables:
- fido_dollar
- balance
- data_used
```
Configuration variables:
- **username** (*Required*): You Fido username (your Fido phone number).
- **password** (*Required*): Your Fido password.
- **monitored_variables** array (*Required*): Variables to monitor.
- **fido_dollar**: Your Fido dollar balance
- **balance**: Your account balance
- **data_used**: Current data used
- **data_limit**: Current data limit
- **data_remaining**: Current data remaining
- **text_used**: SMS sent
- **text_limit**: SMS limit
- **text_remaining**: SMS remaining
- **mms_used**: MMS sent
- **mms_limit**: MMS limit
- **mms_remaining**: MMS remaining
- **text_int_used**: International SMS sent
- **text_int_limit**: International SMS limit
- **text_int_remaining**: International SMS remaining
- **talk_used**: Talk time used
- **talk_limit**: Talk time limit
- **talt_remaining**: Talk time remaining
- **other_talk_used**: Other talk time used (It could be internation calls)
- **other_talk_limit**: Other talk time limit
- **other_talt_remaining**: Other talk time remaining

27
source/_components/sensor.pocketcasts.markdown Normal file
View file

@ -0,0 +1,27 @@
---
layout: page
title: PocketCasts
description: "Instructions on how to set up PocketCasts sensors within Home Assistant."
date: 2017-02-14 08:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_release: 0.39
---
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
sensor:
- platform: pocketcasts
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
Configuration options for the PocketCasts Sensor:
- **username** (*Required*): The username to access the PocketCasts service.
- **password** (*Required*): The password for the given username.

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

@ -32,7 +32,7 @@ Configuration variables:
- **locations** (*Required*): a list of location names to look for air quality data. In case a specific location has multiple registered stations all of them will be added to Home Assistant
- **token** (*Required*): a token for the AQICN public API. Please obtain one at (AQICN API token)[http://aqicn.org/data-platform/token/#/]
- **token** (*Required*): a token for the AQICN public API. Please obtain one at [AQICN API token](http://aqicn.org/data-platform/token/#/)
- **stations** (*Optional*): a list of station names to look for air quality data. Station should be within locations specified above.

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

@ -17,7 +17,7 @@ ha_iot_class: "Cloud Polling"
The `wunderground` platform uses [Weather Underground](http://www.wunderground.com) as a source for current weather information.
<p class='note warning'>
Obtain a WUnderground API key [here](https://www.wunderground.com/weather/api). A free account allows 500 requests per day or 10 per minute.
Obtain a WUnderground API key [here](https://www.wunderground.com/weather/api). A free account allows 500 requests per day and also a maximum of 10 per minute. See details [here](https://www.wunderground.com/weather/api/d/pricing.html).
</p>
To add Wunderground to your installation, add the following to your `configuration.yaml` file:

22
source/_components/switch.insteon_plm.markdown Normal file
View file

@ -0,0 +1,22 @@
---
layout: page
title: "Insteon PLM Switch"
description: "Instructions how to setup the Insteon PLM switches locally within Home Assistant."
date: 2017-02-19 17:00
sidebar: true
comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: Switch
ha_iot_class: "Local Push"
ha_version: 0.39
---
The `insteon_plm` switch platform lets you control your switches through
an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a
USB or serial port. To add support, set up the primary [insteon_plm]
component.
[insteon_plm]: /components/insteon_plm/

2
source/_components/zabbix.markdown
View file

@ -35,7 +35,7 @@ Configuration variables:
```yaml
# Example configuration.yaml entry
zoneminder:
zabbix:
host: ZABBIX_HOST
path: ZABBIX_PATH
ssl: False