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

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

Browse source
This commit is contained in:
Robbie Trencheny 2016-08-27 20:56:42 -07:00
commit 9e4330bed8
108 changed files with 3083 additions and 105 deletions
Download patch file Download diff file Expand all files Collapse all files

6
source/_components/arduino.markdown
View file

@ -45,3 +45,9 @@ If that's not working, check your `dmesg` or `journalctl -f` output. Keep in min
A word of caution: The Arduino boards are not storing states. This means that with every initialization the pins are set to off/low.
</p>
Add the user who is used to run Home Assistant to the groups to allow access to the serial port.
```bash
sudo usermod -a -G dialout,lock $USER
```

8
source/_components/binary_sensor.apcupsd.markdown
View file

@ -19,11 +19,11 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
```yaml
# Example configuration.yaml entry
binary_sensor:
platform: apcupsd
name: UPS Online
- platform: apcupsd
name: UPS Online
```
Configuration variables:
- **resource** (*Required*): The resource or endpoint that contains the value.
- **method** (*Optional*): The method of the request. Default is GET.
- **name** (*Optional*): Name to use in the front end.

5
source/_components/binary_sensor.enocean.markdown
View file

@ -23,9 +23,12 @@ To use your EnOcean device, you first have to set up your [EnOcean hub](/compone
binary_sensor:
- platform: enocean
id: [0x01,0x90,0x84,0x3C]
name: Door
sensor_class: opening
```
Configuration variables:
- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer.
- **platform** (*Required*): Set to `enocean`.
- **name** (*Optional*): An identifier for the Ligh in the frontend.
- **sensor_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.

6
source/_components/camera.netatmo.markdown
View file

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: netatmo.png
ha_category: Camera
ha_release: "0.22"
ha_release: 0.22
---
@ -29,8 +29,8 @@ camera:
Configuration variables:
- **home** (*Optionnal*): Will display the cameras of this home only.
- **cameras** array (*Optionnal*): Cameras to use. Multiple enties allowed.
- **home** (*Optional*): Will display the cameras of this home only.
- **cameras** array (*Optional*): Cameras to use. Multiple enties allowed.
- **camera_name**: Name of the camera to display.
If **home** and **cameras** is not provided, all cameras will be displayed.

6
source/_components/camera.uvc.markdown
View file

@ -28,7 +28,7 @@ camera:
Configuration variables:
- **nvr** *Required**: The IP or hostname of the NVR (Network Video Recorder) server.
- **port** *Optional*: The port number to use for accessing the NVR.
- **key** *Required*: The API key available from the NVR web interface.
- **nvr** (*Required*): The IP or hostname of the NVR (Network Video Recorder) server.
- **port** (*Optional*): The port number to use for accessing the NVR.
- **key** (*Required*): The API key available from the NVR web interface.

2
source/_components/ecobee.markdown
View file

@ -17,7 +17,7 @@ The Ecobee platform lets you control a thermostats and view sensor data from the
You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this component. To get the key, first you need to register your thermostat. Once you have done that, click on the 'Become a developer' link on the developer site. Login with your ecobee credentials, accept the SDK agreement, fill in the fields, and click save. Now login to the regular consumer portal, and in the hamburger menu there will br a new option 'Developer'. Select that, then select 'Create New'. Give your app a name (it appears to need to be unique across all users, as I tried 'home-assistant' and it said it was already in use) and a summary (neither of these are important as they are not used anywhere). For Authorization method select 'ecobee PIN'. You don't need an Application Icon or Detailed Description. Click Save. Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the 'X' to close the Developer section.
The first time you run Home-Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking 'Add Application' in the 'My Apps' section in the sidebar. Enter the PIN code from the Home Assistant screeen. To get the PIN code select the item in the Ecobee card. If you do not have an Ecobee card, you may be using groups with default_view that don't show the card. To get around this you can temporarily comment out the default_view section and restart Home Assistant. Once you enter the PIN on the Ecobee site, wait approximately 5 minutes and then click on the 'I have authorized the app' link at the bottom of the Ecobee popup window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full Ecobee card with all of the sensors populated. Now you can re-enable your default_view (if you had to disable it) and add the Ecobee sensors to a group and/or view.
The first time you run Home-Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking 'Add Application' in the 'My Apps' section in the sidebar. Enter the PIN code from the Home Assistant screeen. To get the PIN code select the item in the Ecobee card. If you do not have an Ecobee card, you may be using groups with default_view that don't show the card. To get around this you can temporarily comment out the default_view section or add the configurator.ecobee component to your default_view and restart Home Assistant. Once you enter the PIN on the Ecobee site, wait approximately 5 minutes and then click on the 'I have authorized the app' link at the bottom of the Ecobee popup window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full Ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your default_view (if you had to disable it) and add the Ecobee sensors to a group and/or view.
To set it up, add the following information to your `configuration.yaml` file:

16
source/_components/enocean.markdown
View file

@ -18,10 +18,10 @@ The `enocean` component adds support for some of these devices. You will need a
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](../binary_sensor.enocean) (wall switches)
- [Sensor](../sensor.enocean) (power meters)
- [Light](../light.enocean) (dimmers)
- [Switch](../switch.enocean)
- [Binary Sensor](/components/binary_sensor.enocean/) (wall switches)
- [Sensor](/components/sensor.enocean/) (power meters)
- [Light](/components/light.enocean/) (dimmers)
- [Switch](/components/switch.enocean/)
However, only a few devices have been confirmed to work. These are:
@ -29,9 +29,9 @@ However, only a few devices have been confirmed to work. These are:
- Eltako FT55 battery-less wall switch
- Permundo PSC234 (switch and power monitor)
Other devices will most likely need some changes in the Home-Assistant code in order to work. Support for teaching of devices is also missing at this time.
Other devices will most likely need some changes in the Home Assistant code in order to work. Support for teaching of devices is also missing at this time.
# Configuration
To integrate an EnOcean controller with Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -39,5 +39,7 @@ enocean:
device: /dev/ttyUSB0
```
If no device is specified, the default will be **/dev/ttyUSB0**
Configuration variables:
- **device** (*Required*): The port where your device is connected to your Home Assistant host.

4
source/_components/foursquare.markdown
View file

@ -28,7 +28,7 @@ Configuration variables:
- **access_token** (*Required*): A Foursquare API access token.
- **push_secret** (*Required*): The push secret that Foursquare provides to you in the app dashboard.
#### {% linkable_title Real-Time API %}
### {% linkable_title Real-Time API %}
The component accepts pushes from Foursquare at `/api/foursquare`. The route does not require authentication.
@ -45,7 +45,7 @@ automation:
entity_id: script.my_action
```
#### {% linkable_title Check ins %}
### {% linkable_title Check ins %}
To check a user in, use the `foursquare/checkin` service.

2
source/_components/group.markdown
View file

@ -13,7 +13,7 @@ ha_category: Organization
Groups allow the user to combine multiple entities into one. A group can be promoted to a **view** by setting the `view` option to `yes`. This will make the group available as a new tab in the frontend.
Check the **Set State** page from the **Developer Tools** and browse the **Current entities:** listing for all available entities.
Check the **Set State** page from the **Developer Tools** <img src='/images/screenshots/developer-tool-services-icon.png' class='no-shadow' height='38' /> and browse the **Current entities:** listing for all available entities.
By default, every group appears in the HOME tab. If you name a group `default_view` it will REPLACE the contents of the HOME tab so you can customize it as you wish.

9
source/_components/light.enocean.markdown
View file

@ -15,13 +15,13 @@ ha_release: 0.21
An EnOcean light can take many formes. Currently only one type has been tested: Eltako FUD61 dimmer.
To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file:
To use your EnOcean device, you first have to set up your [EnOcean hub](/components/enocean/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
- name: Living_room
platform: enocean
- platform: enocean
name: Living_room
id: [0x01,0x90,0x84,0x3C]
sender_id: [0xFF,0xC6,0xEA,0x04]
```
@ -30,5 +30,4 @@ Configuration variables:
- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer.
- **sender_id** (*Required*): The Sender ID of the device. This is a 4 bytes long number.
- **platform** (*Required*): Set to `enocean`.
- **name** (*Required*): An identifier for the switch
- **name** (*Optional*): An identifier for the Ligh in the frontend.

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

@ -51,6 +51,8 @@ light:
name: "Office light"
state_topic: "office/rgb1/light/status"
command_topic: "office/rgb1/light/switch"
brightness_state_topic: 'office/rgb1/light/brightness'
brightness_command_topic: 'office/rgb1/light/brightness/set'
qos: 0
payload_on: "ON"
payload_off: "OFF"

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

@ -34,9 +34,9 @@ To add MPC-HC to your installation, add the following to your `configuration.yam
# Example configuration.yaml entry
media_player:
platform: mpchc
host: http://192.168.0.123
port: 13579
name: MPC-HC
host: http://192.168.0.123
port: 13579
name: MPC-HC
```
Configuration variables:

12
source/_components/mqtt.markdown
View file

@ -48,7 +48,7 @@ Configuration variables:
The MQTT component needs you to run an MQTT broker for Home Assistant to connect to. There are four options, each with various degrees of ease of setup and privacy.
#### {% linkable_title Use the embedded broker %}
### {% linkable_title Embedded broker %}
Home Assistant contains an embedded MQTT broker. If no broker configuration is given, the [HBMQTT broker](https://pypi.python.org/pypi/hbmqtt) is started and Home Asssistant connects to it. Embedded broker default configuration:
@ -75,7 +75,7 @@ mqtt:
# http://hbmqtt.readthedocs.org/en/latest/references/broker.html#broker-configuration
```
#### {% linkable_title Run your own %}
### {% linkable_title Run your own %}
Most private option but requires a bit more work. There are two free and open-source brokers to pick from: [Mosquitto](http://mosquitto.org/) and [Mosca](http://www.mosca.io/).
@ -94,7 +94,7 @@ mqtt:
There is an issue with the Mosquitto package included in Ubuntu 14.04 LTS. Specify `protocol: 3.1` in your MQTT configuration to work around this issue.
</p>
#### {% linkable_title Public MQTT %}
### {% linkable_title Public broker %}
The Mosquitto project runs a [public broker](http://test.mosquitto.org). Easiest to setup but there is 0 privacy as all messages are public. Use this only for testing purposes and not for real tracking of your devices.
@ -110,7 +110,7 @@ mqtt:
certificate: /home/paulus/downloads/mosquitto.org.crt
```
#### {% linkable_title CloudMQTT %}
### {% linkable_title CloudMQTT %}
[CloudMQTT](https://www.cloudmqtt.com) is a hosted private MQTT instance that is free up to 10 connected devices. This is enough to get started with for example [OwnTracks](/components/device_tracker.owntracks/) and give you a taste of what is possible.
@ -174,7 +174,7 @@ The MQTT component will register the service `publish` which allows publishing m
### {% linkable_title Logging %}
The [logger](/components/logger/) component allow the logging of received MQTT messages.
The [logger](/components/logger/) component allow the logging of received MQTT messages.
```yaml
# Example configuration.yaml entry
@ -228,7 +228,7 @@ $ mosquitto_sub -h 127.0.0.1 -v -t "home-assistant/#"
For the embeeded MQTT broker the command looks like the sample below.
```bash
$ mosquitto_sub -v -V mqttv311 -t "#"
$ mosquitto_sub -v -V mqttv311 -t "#"
```
Add the username `homeassistant` and your API password if needed.

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

@ -13,7 +13,7 @@ ha_release: pre 0.7
---
The `arduino` sensor platform allows allow you to get an numerical values from an analog input pin of an [Arduino](https://www.arduino.cc/) board. Usually the value is between 0 and 1024.
The `arduino` sensor platform allows you to get an numerical values from an analog input pin of an [Arduino](https://www.arduino.cc/) board. Usually the value is between 0 and 1024.
To enable an Arduino sensor with Home Assistant, add the following section to your `configuration.yaml` file:

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

@ -15,18 +15,17 @@ ha_release: 0.21
An EnOcean switch can take many forms. Currently only one type has been tested: Permundo PSC234
To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file:
To use your EnOcean device, you first have to set up your [EnOcean hub](/components/enocean/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- name: Television
platform: enocean
- platform: enocean
name: Front door
id: [0x01,0x90,0x84,0x3C]
```
Configuration variables:
- **id** (*Required*): The ID of the device. This is a 4 bytes long number.
- **platform** (*Required*): Set to `enocean`.
- **name** (*Required*): An identifier for the switch
- **name** (*Optional*): An identifier for the switch. Default to `EnOcean Switch`.