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-06-18 12:06:50 -07:00
commit 14a04556ac
27 changed files with 193 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: enocean.png
ha_category: Binary Sensor
ha_release: 0.21
---
This can typically be one of those batteryless wall switches. Currently only one type has been tested: Eltako FT55. Other devices will most likely not work without changing the Home-Asisstant code.

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

@ -17,7 +17,7 @@ The `generic` camera platform allows you to integrate any IP camera into Home As
Home Assistant will serve the images via its server, making it possible to view your IP camera's while outside of your network. The endpoint is `/api/camera_proxy/camera.[name]?time=[timestamp]`.
To enable this camery in your installation, add the following to your `configuration.yaml` file:
To enable this camera in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -31,7 +31,7 @@ camera:
Configuration variables:
- **still_image_url** *Required*: The URL your camera serves the image on, eg. http://192.168.1.21:2112/
- **name** *Optional*: This parameter allows you to override the name of your camera.
- **username** *Optional*: The username for accessing your camera.
- **password** *Optional*: The password for accessing your camera.
- **still_image_url** (*Required*): The URL your camera serves the image on, eg. http://192.168.1.21:2112/
- **name** (*Optional*): This parameter allows you to override the name of your camera.
- **username** (*Optional*): The username for accessing your camera.
- **password** (*Optional*): The password for accessing your camera.

8
source/_components/camera.mjpeg.markdown
View file

@ -31,10 +31,10 @@ camera:
Configuration variables:
- **mjpeg_url** *Required*: The URL your camera serves the video on, eg. http://192.168.1.21:2112/
- **name** *Optional*: This parameter allows you to override the name of your camera.
- **username** *Optional*: The username for accessing your camera.
- **password** *Optional*: The password for accessing your camera.
- **mjpeg_url** (*Required*): The URL your camera serves the video on, eg. http://192.168.1.21:2112/
- **name** (*Optional*): This parameter allows you to override the name of your camera.
- **username** (*Optional*): The username for accessing your camera.
- **password** (*Optional*): The password for accessing your camera.
<p class='note'>
There is a <a href="https://github.com/shazow/urllib3/issues/800" target="_blank">known issue in urllib3</a> that you will get error messages in your logs like <code>[StartBoundaryNotFoundDefect(), MultipartInvariantViolationDefect()], unparsed data: ''</code> but the component still works fine. You can ignore the messages.

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

@ -14,7 +14,9 @@ ha_release: 0.17
---
The `rpi` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application "raspistill" to store the image from camera.
The `rpi` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera.
To enable this camera in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -33,14 +35,14 @@ 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 <t>ms (default: 1000)
- **file_path** (optional): Save the picture in a custom file path (default: camera components folder)
- **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)
The given **file_path** must be an existing file because the camera platform setup make a writeable check on it.

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

@ -9,9 +9,9 @@ sharing: true
footer: true
logo: ddwrt.png
ha_category: Presence Detection
ha_release: pre 0.7
---
This platform offers presence detection by looking at connected devices to a [DD-WRT](http://www.dd-wrt.com/site/index) based router.
To use a DD-WRT router in your installation, add the following to your `configuration.yaml` file:

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

@ -10,6 +10,7 @@ footer: true
logo: netgear.png
ha_category: Presence Detection
ha_iot_class: "Local Polling"
ha_release: pre 0.7
---

4
source/_components/ecobee.markdown
View file

@ -15,7 +15,9 @@ featured: true
The Ecobee platform lets you control a thermostats and view sensor data from the [Ecobee](https://ecobee.com) thermostat.
You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this component. 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.
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.
To set it up, add the following information to your `configuration.yaml` file:

1
source/_components/enocean.markdown
View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: enocean.png
ha_category: Hub
ha_release: 0.21
---
The [EnOcean](https://en.wikipedia.org/wiki/EnOcean) standard is supported by many different vendors. There are switches and sensors of many different kinds, and typically they employ energy harvesting to get power such that no batteries are unnecessary.

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: enocean.png
ha_category: Light
ha_release: 0.21
---
An EnOcean light can take many formes. Currently only one type has been tested: Eltako FUD61 dimmer.

2
source/_components/light.markdown
View file

@ -49,7 +49,7 @@ Turns one or multiple lights off.
| 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.
### {% linkable_title Service `light.toggle` %}

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: osramlightify.png
ha_category: Light
ha_release: 0.21
---
The `osramlightify` platform allows you to integrate your [Osram Lightify](http://www.osram.com/osram_com/products/led-technology/lightify/index.jsp) into Home Assistant.

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: enocean.png
ha_category: Sensor
ha_release: 0.21
---

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

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: enocean.png
ha_category: Switch
ha_release: 0.21
---
An EnOcean switch can take many forms. Currently only one type has been tested: Permundo PSC234