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:
Fabian Affolter 2016-07-13 19:30:14 +02:00
commit 60bb3f4e20
No known key found for this signature in database
GPG key ID: DDF3D6F44AAB1336
47 changed files with 577 additions and 153 deletions
Download patch file Download diff file Expand all files Collapse all files

3
source/_components/device_tracker.bluetooth_tracker.markdown
View file

@ -13,7 +13,8 @@ ha_iot_class: "Local Poll"
ha_release: 0.18
---
This tracker discovers new devices on boot and tracks bluetooth devices periodically based on interval_seconds value. Devices discovered are stored with 'bt_' as the prefix for device mac in `known_devices.yaml`.
This tracker discovers new devices on boot and tracks bluetooth devices periodically based on interval_seconds value. It is not requiered to pair the devices with eachother!
Devices discovered are stored with 'bt_' as the prefix for device mac address in `known_devices.yaml`.
<p class='note'>
Requires PyBluez. If you are on raspbian, make sure you first install `bluetooth` and `libbluetooth-dev` by running `sudo apt install bluetooth libbluetooth-dev`

2
source/_components/device_tracker.nmap_scanner.markdown
View file

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: nmap.png
ha_category: Presence Detection
featured: true
featured: false
---

2
source/_components/device_tracker.unifi.markdown
View file

@ -25,6 +25,7 @@ device_tracker:
port: PORT
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
site_id: SITE_ID
```
Configuration variables:
@ -33,5 +34,6 @@ Configuration variables:
- **port** (*Optional*): The port of your controller's web interface. Defaults to 8443.
- **username** (*Required*: The username of an user with administrative privileges, usually *admin*.
- **password** (*Required*): The password for your given admin account.
- **site_id** (*Optional*): Allows you to specify a site_id for device tracking. Defaults to "default". Found in the URL of the controller (i.e. https://CONTROLLER:PORT/manage/site/SITE_ID/dashboard)
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

2
source/_components/discovery.markdown
View file

@ -20,7 +20,7 @@ Home Assistant can discover and automatically configure zeroconf/mDNS and uPnP d
* Netgear routers
* Plex Media Server
It will be able to add Google Chreomcasts and Belkin WeMo switches automatically, for Philips Hue it will require some configuration from the user.
It will be able to add Google Chromecasts and Belkin WeMo switches automatically, for Philips Hue it will require some configuration from the user.
To load this component, add the following lines to your `configuration.yaml`:

5
source/_components/hdmi_cec.markdown
View file

@ -25,9 +25,14 @@ 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, make sure it can access the system module, by either symlinking it or using the `--system-site-packages` flag.
#### {% linkable_title Symlinking into virtual environment %}
`ln -s /usr/local/lib/python3.4/dist-packages/cec <your venv>/lib/python3.4/site-packages`
## {% linkable_title Configuration Example %}
In the following example, a Pi Zero running Home Assistant is on a TV's HDMI port 1. HDMI port 2 is attached to a AV receiver. Three devices are attached to the AV receiver on HDMI ports 1 through 3.
```yaml
hdmi_cec:
devices:

2
source/_components/http.markdown
View file

@ -18,7 +18,6 @@ The `http` component serves all files and data required for the Home Assistant f
http:
api_password: YOUR_PASSWORD
server_port: 12345
development: 1
ssl_certificate: /etc/letsencrypt/live/hass.example.com/fullchain.pem
ssl_key: /etc/letsencrypt/live/hass.example.com/privkey.pem
cors_allowed_origins:
@ -29,6 +28,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_port** (*Optional*): Let you set a port to use. Defaults to 8123.
- **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.

5
source/_components/light.markdown
View file

@ -33,7 +33,7 @@ Turns one light on or multiple lights on using [groups]({{site_root}}/components
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings that point at `entity_id`s of lights. Else targets all.
| `transition` | yes | Integer that represents the time the light should take to transition to the new state. *not supported by Wink
| `transition` | yes | Integer that represents the time the light should take to transition to the new state in seconds. *not supported by Wink
| `profile` | yes | String with the name of one of the built-in profiles (relax, energize, concentrate, reading) or one of the custom profiles defined in `light_profiles.csv` in the current working directory. Light profiles define a xy color and a brightness. If a profile is given and a brightness or xy color then the profile values will be overwritten.
| `xy_color` | yes | A list containing two floats representing the xy color you want the light to be. Two comma seperated floats that represent the color in XY.
| `rgb_color` | yes | A list containing three integers representing the xy color you want the light to be. Three comma seperated integers that represent the color in RGB
@ -41,6 +41,7 @@ Turns one light on or multiple lights on using [groups]({{site_root}}/components
| `color_name` | yes | A human readable string of a color name, such as `blue` or `goldenrod` or [`chucknorris`](http://stackoverflow.com/questions/8318911/why-does-html-think-chucknorris-is-a-color). If your browser can display it, so can Home Assistant.
| `brightness` | yes | Integer between 0 and 255 for how bright the color should be.
| `flash` | yes | Tell light to flash, can be either value `short` or `long`. *not supported by Wink
| `effect`| yes | Applies an effect such as `colorloop` or `random`.
### {% linkable_title Service `light.turn_off` %}
@ -60,4 +61,4 @@ Toggles the state of one or multiple lights using [groups]({{site_root}}/compone
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings that point at `entity_id`s of lights. Else targets all.
| `transition` | yes | Integer that represents the time the light should take to transition to the new state.
| `transition` | yes | Integer that represents the time the light should take to transition to the new state in seconds.

40
source/_components/lirc.markdown
View file

@ -23,9 +23,39 @@ Sending IR commands is not supported in this component (yet), but can be accompl
To allow Home Assistant to talk to your IR receiver, you need to first make sure you have the correct dependencies installed:
```bash
$ sudo apt-get install lirc
$ sudo apt-get install lirc python3-lirc
```
Check the version of `python3-lirc`:
```bash
$ apt-cache show python3-lirc
Package: python3-lirc
Source: python-lirc
Version: 1.2.1-2
```
If you do not have this version or you are running in a virtual environment, then your system will completely freeze with this component active. You will need to build `python3-lirc` from source. The version of this library in the Python package index is also broken, so the typical dependency system cannot fix this. Build it from source like this:
As regular user:
```bash
sudo apt-get install liblircclient-dev
```
As the user that runs hass:
```bash
(hass) $ git clone https://github.com/tompreston/python-lirc.git
(hass) $ cd python-lirc
(hass) $ make py3
(hass) $ python3 setup.py build
(hass) $ python3 setup.py install
```
If you are not using a virtual environment setup, then you'll need a `sudo` before the install line above.
<p class='note'>
If you are configuring on a Raspberry Pi, there are excellent instructions with GPIO schematics and driver configurations [here](http://alexba.in/blog/2013/01/06/setting-up-lirc-on-the-raspberrypi/). Consider following these.
</p>
@ -60,10 +90,10 @@ end
Test your LIRC installation before proceeding by running:
```bash
$ irexec -n home-assistant
$ ircat home-assistant
```
and pressing some buttons on the remote.
and pressing some buttons on the remote. You should see them register on the screen if LIRC is properly configured.
### {% linkable_title Configuration Home Assistant %}
@ -73,10 +103,6 @@ and pressing some buttons on the remote.
lirc:
```
<p class='note'>
If you are on a Debian based system (like Raspberry Pi) and are having issues loading the component due to it being unable to install python-lirc, install it manually using `apt-get install python3-lirc`.
</p>
#### {% linkable_title Events %}
The LIRC component fires `ir_command_received` events on the bus. You can capture the events and respond to them in automation scripts like this:

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

@ -37,4 +37,4 @@ Configuration variables:
- **name** (*Optional*): The name of the device used in the frontend.
- **username** (*Optional*): The XBMC/Kodi HTTP username.
- **password** (*Optional*): The XBMC/Kodi HTTP password.
- **turn_off_action** (*Optional*): The desired turn off action. Options are `none`, `quit`, `hibernate`, `suspend`, `reboot`, or `poweroff`. Default `none`.
- **turn_off_action** (*Optional*): The desired turn off action. Options are `none`, `quit`, `hibernate`, `suspend`, `reboot`, or `shutdown`. Default `none`.

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

@ -17,6 +17,8 @@ The `instapush` platform uses [Instapush](https://instapush.im) to delivery noti
The Instapush [Getting Started page](https://instapush.im/home/start/) will guide through the process of creating the required items.
To add Instapush to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
notify:
@ -33,10 +35,26 @@ Configuration variables:
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **api_key** (*Required*): Your API key for Instapush.
- **app_secret** (*Required*): The secret for your created application.
- **event** (*Required*): TThe event
- **event** (*Required*): The event
- **tracker** (*Required*): The name of tracker inside Instapush.
To retrieve those values for existing settings, log into your account at https://instapush.im and go to your **Dashboard**. Then click **APPS** tab, choose an app, and check the **Basic Info** section. The *Application ID* is the ``api_key`` and ``app_secret`` is the *Application Secret*.
To retrieve those values for existing settings, log into your account at [https://instapush.im](https://instapush.im) and go to your **Dashboard**. Then click **APPS** tab, choose an app, and check the **Basic Info** section. The *Application ID* is the ``api_key`` and ``app_secret`` is the *Application Secret*.
Assuming that your setup looks look in the image below...
<p class='img'>
<img src='{{site_root}}/images/screenshots/instapush.png' />
</p>
...then your entry for the `configuration.yaml` file needs to be like this sample.
```yaml
notify:
platform: instapush
[...]
event: msg
tracker: state
```
It's easy to test your Instapush setup outside of Home Assistant. Assuming you have an event *notification* and a tracker *home-assistant*, just fire a request and check the Instapush dashboard for a new entry.
@ -48,6 +66,7 @@ curl -X POST \
-d '{"event":"notification","trackers":{"home-assistant":"Switch 1"}}' \
https://api.instapush.im/v1/post
```
For further details, please check the [API](https://instapush.im/developer/rest).
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

2
source/_components/notify.markdown
View file

@ -50,7 +50,7 @@ action:
### {% linkable_title Test if it works %}
A simple way to test if you have set up your notify platform correctly is to use **Call Service** from the **Developer Tools** to call your notify service. Choose your service (*notify/xyz*) from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**.
A simple way to test if you have set up your notify 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 (*notify/xyz*) from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**.
```json
{

2
source/_components/persistent_notification.markdown
View file

@ -52,3 +52,5 @@ Choose <img src='/images/screenshots/developer-tool-services-icon.png' alt='serv
}
```
This will create the notification entry shown above.
NOTE: if you have defined a ```default_view:``` in your ```Groups:``` configuration you will need to include ```persistent_notification.<notification_id>``` e.g. ```persistent_notification.1234``` as per the example above, to your Groups configuration, in order to see the notification after creating it.

2
source/_components/proximity.markdown
View file

@ -54,5 +54,5 @@ Configuration variables:
- **zone** (*Optional*): The zone to which this component is measuring the distance to. Default is the home zone.
- **ignored_zones** array (*Optional*): Where proximity is not calculated for a device (either the device being monitored or ones being compared (e.g. work or school).
- **devices** array (*Optional*): A list of devices to compare location against to check closeness to the configured zone.
- **tollerance** (*Optional*): The tolerance used to calculate the direction of travel in meters (m) to filter out small GPS coordinate changes.
- **tolerance** (*Optional*): The tolerance used to calculate the direction of travel in meters (m) to filter out small GPS coordinate changes.

6
source/_components/scene.markdown
View file

@ -43,7 +43,7 @@ automation:
entity_id: device_tracker.sweetheart
from: 'not_home'
to: 'home'
action:
service: scene.turn_on
entity_id: scene.romantic
action:
service: scene.turn_on
entity_id: scene.romantic
```

4
source/_components/sensor.dweet.markdown
View file

@ -33,9 +33,9 @@ Configuration variables:
- **value_template** (*Required*): The variable to extract a value from the content.
- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any.
## {% linkable_title Interacting with Dweet.io %}
### {% linkable_title Interacting with Dweet.io %}
You can easily send dweets from the commandline to test your sensor.
You can easily send dweets from the commandline 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

31
source/_components/sensor.glances.markdown
View file

@ -10,6 +10,7 @@ footer: true
logo: glances.png
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_release: 0.7.3
---
@ -18,7 +19,7 @@ The `glances` sensor platform is consuming the system information provided by th
This sensors needs a running instance of `glances` on the host. The minimal supported version of `glances` is 2.3:
```bash
glances -w
$ sudo glances -w
Glances web server started on http://0.0.0.0:61208/
```
@ -61,18 +62,18 @@ Configuration variables:
- **port** (*Option*): The network port to connect to. Default is 61208.
- **name** (*Optional*): Name of the Glances sensor.
- **resources** (*Required*): Entries to monitor.
- **'disk_use_percent'**: Used disk space in percent
- **'disk_use'**: Used disk space
- **'disk_free'**: Free disk space
- **'memory_use_percent'**: Used memory in percent
- **'memory_use'**: Used memory
- **'memory_free'**: Free memory
- **'swap_use_percent'**: Used swap space in percent
- **'swap_use'**: Used swap space
- **'swap_free'**: Free swap space
- **'processor_load'**: Load
- **'process_running'**: Number of running processes
- **'process_total'**: Total number of processes
- **'process_thread'**: Number of threads
- **'process_sleeping'**: Number of sleeping processes
- **disk_use_percent**: Used disk space in percent
- **disk_use**: Used disk space
- **disk_free**: Free disk space
- **memory_use_percent**: Used memory in percent
- **memory_use**: Used memory
- **memory_free**: Free memory
- **swap_use_percent**: Used swap space in percent
- **swap_use**: Used swap space
- **swap_free**: Free swap space
- **processor_load**: Load
- **process_running**: Number of running processes
- **process_total**: Total number of processes
- **process_thread**: Number of threads
- **process_sleeping**: Number of sleeping processes

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

@ -31,9 +31,11 @@ sensor:
platform: onewire
names:
some_id: your name
mount_dir: "/mnt/1wire"
```
Configuration variables:
- **names** array (*Optional*): ID and friendly name of your sensors.
- **mount_dir** (*Optional*): Location of device tree if owfs driver used.

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

@ -15,6 +15,8 @@ ha_release: pre 0.7
The `transmission` platform allows you to monitor your downloads with [Transmission](http://www.transmissionbt.com/) from within Home Assistant and setup automation based on the information.
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
sensor:

45
source/_components/switch.flux.markdown
View file

@ -11,23 +11,15 @@ ha_category: Switch
ha_release: 0.21
---
The Flux switch platform will change the temperature of your lights similar to
the way flux works on your computer, using circadian rhythm. They will be bright
during the day, and gradually fade to a red/orange at night.
The `flux` switch platform will change the temperature of your lights similar to the way flux works on your computer, using circadian rhythm. They will be bright during the day, and gradually fade to a red/orange at night.
The component will update your lights based on the the time of day. It will only
affect lights that are turned on and listed in the flux configuration.
The component will update your lights based on the the time of day. It will only affect lights that are turned on and listed in the flux configuration.
During the day (in between `start time` and `sunset time`), it will fade the lights from
the `start_colortemp` to the `sunset_colortemp`. After sunset (between `sunset_time`
and `stop_time`), the lights will fade from the the `sunset_colortemp` to the
`stop_colortemp`. If the lights are still on after the `stop_time` it will continue
to change the light to the `stop_colortemp` until the light is turned off. The fade
effect is created by updating the lights every 30 seconds with a 30 second transition time.
During the day (in between `start time` and `sunset time`), it will fade the lights from the `start_colortemp` to the `sunset_colortemp`. After sunset (between `sunset_time` and `stop_time`), the lights will fade from the the `sunset_colortemp` to the `stop_colortemp`. If the lights are still on after the `stop_time` it will continue to change the light to the `stop_colortemp` until the light is turned off. The fade effect is created by updating the lights every 30 seconds with a 30 second transition time.
If you don't wish to have flux update on 30 second intervals, you can leave the
switch turned off and use automation rules that call the service `switch.flux_update`
whenever you want the lights updated.
If you don't wish to have flux update on 30 second intervals, you can leave the switch turned off and use automation rules that call the service `switch.flux_update` whenever you want the lights updated.
To use your TPLink switch in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -36,12 +28,23 @@ switch:
lights:
- light.desk
- light.lamp
name: Fluxer # optional, default Flux
start_time: 7:00 # optional, default sunrise
stop_time: 23:00 # optional, default 22:00
start_colortemp: 4000 # optional, default 4000
sunset_colortemp: 3000 # optional, default 3000
stop_colortemp: 1900 # optional, default 1900
brightness: 200 # optional, default calculated by RGB_to_xy
name: Fluxer
start_time: '7:00'
stop_time: '23:00'
start_colortemp: 4000
sunset_colortemp: 3000
stop_colortemp: 1900
brightness: 200
```
Configuration variables:
- **lights** (*Required*) array: List of light entities.
- **name** (*Optional*): The name to use when displaying this switch.
- **start_time** (*Optional*): The start time. Default to sunrise.
- **stop_time** (*Optional*): The stop time. Defaults to 22:00.
- **start_colortemp** (*Optional*): The color temperature at the start. Defaults to `4000`.
- **sunset_colortemp** (*Optional*): The sun set color temperature. Defaults to `3000`.
- **stop_colortemp** (*Optional*): The color temperature at the end. Defaults to `1900`.
- **brightness** (*Optional*): The brightness of the lights. Calculated with `RGB_to_xy` by default.

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

@ -56,6 +56,7 @@ switch:
name: Movment2
0b1111e003af16aa10000060:
name: Door
fire_event: True
```
Configuration variables: