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 2016-08-21 16:52:41 -07:00
commit 04b4f58407
31 changed files with 284 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

4
source/_components/sensor.ecobee.markdown → source/_components/binary_sensor.ecobee.markdown
View file

@ -1,6 +1,6 @@
---
layout: page
title: "Ecobee Sensor"
title: "Ecobee Binary Sensor"
description: "Instructions how to setup the Ecobee sensors within Home Assistant."
date: 2015-11-30 18:00
sidebar: true
@ -11,4 +11,4 @@ logo: ecobee.png
ha_category: Sensor
---
To get your Ecobee sensors working with Home Assistant, follow the instructions for the general [Ecobee component](/components/ecobee/).
To get your Ecobee binary sensors working with Home Assistant, follow the instructions for the general [Ecobee component](/components/ecobee/).

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

@ -22,6 +22,7 @@ binary_sensor:
monitored_conditions:
- 'fan'
- 'hvac_ac_state'
- 'hvac_heater_state'
- 'hvac_aux_heater_state'
- 'hvac_heat_x2_state'
- 'hvac_heat_x3_state'

2
source/_components/camera.ffmpeg.markdown
View file

@ -33,7 +33,7 @@ camera:
Configuration variables:
- **input** (*Required*): A ffmpeg compatible input file, stream or feet.
- **input** (*Required*): A ffmpeg compatible input file, stream or feed.
- **name** (*Optional*): This parameter allows you to override the name of your camera.
- **ffmpeg_bin** (*Optional*): Default 'ffmpeg'.
- **extra_arguments** (*Optional*): Extra option they will pass to ffmpeg. i.e. image quality or video filter options.

76
source/_components/input_slider.markdown
View file

@ -34,3 +34,79 @@ Configuration variables:
- **max** (*Optional*): Maximum value for the slider.
- **step** (*Optional*): Step value for the slider.
## {% linkable_title Automation Examples %}
Here's an example of `input_slider` being used as a trigger in an automation.
```yaml
{% raw %}
# Example configuration.yaml entry using 'input_slider' as a trigger in an automation
# Define input_slider
input_slider:
bedroom_brightness:
name: Brightness
initial: 254
min: 0
max: 254
step: 1
# Automation.
automation:
- alias: Bedroom Light - Adjust Brightness
trigger:
platform: state
entity_id: input_slider.bedroom_brightness
action:
- service: light.turn_on
# Note the use of 'data_template:' below rather than the normal 'data:' if you weren't using an input variable
data_template:
entity_id: light.bedroom
brightness: '{{ trigger.to_state.state | int }}'
{% endraw %}
```
Another code example using `input_slider`, this time being used in an action in an automation.
```yaml
{% raw %}
# Example configuration.yaml entry using 'input_slider' in an action in an automation
# Define 'input_select'
input_select:
scene_bedroom:
name: Scene
options:
- Select
- Concentrate
- Energize
- Reading
- Relax
- 'OFF'
initial: 'Select'
# Define input_slider
input_slider:
bedroom_brightness:
name: Brightness
initial: 254
min: 0
max: 254
step: 1
# Automation.
automation:
- alias: Bedroom Light - Custom
trigger:
platform: state
entity_id: input_select.scene_bedroom
to: CUSTOM
action:
- service: light.turn_on
# Again, note the use of 'data_template:' rather than the normal 'data:' if you weren't using an input variable.
data_template:
entity_id: light.bedroom
brightness: '{{ states.input_slider.bedroom_brightness.state | int }}'
{% endraw %}
```

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

@ -19,6 +19,7 @@ Supported devices:
- Denon DRA-N5
- Denon RCD-N8 (untested)
- Denon RCD-N9 (partial support)
- Denon AVR receivers with Integrated Network support (partial support)
To add a Denon Network Receiver to your installation, add the following to your `configuration.yaml` file:

10
source/_components/media_player.snapcast.markdown
View file

@ -1,21 +1,21 @@
---
layout: page
title: "SnapCast"
description: "Instructions on how to integrate SnapCast into Home Assistant."
title: "Snapcast"
description: "Instructions on how to integrate Snapcast into Home Assistant."
date: 2016-02-01 19:00
sidebar: true
comments: false
sharing: true
footer: true
logo:
logo: snapcast.png
ha_category: Media Player
featured: false
ha_release: 0.13
---
The `snapcast` platform allows you to control [SnapCast](https://github.com/badaix/snapcast) from Home Assistant.
The `snapcast` platform allows you to control [Snapcast](https://github.com/badaix/snapcast) from Home Assistant.
To add SnapCast to your installation, add the following to your `configuration.yaml` file:
To add Snapcast to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

2
source/_components/modbus.markdown
View file

@ -29,7 +29,7 @@ modbus:
Configuration variables:
- **type** (*Required*): Type of the connection to Modebus.
- **type** (*Required*): Type of the connection to Modbus.
- **host** (*Required*): The IP address of your router, eg. 192.168.1.1.
- **port** (*Required*): The port for the comminication.

10
source/_components/notify.pushbullet.markdown
View file

@ -1,6 +1,6 @@
---
layout: page
title: "PushBullet"
title: "Pushbullet"
description: "Instructions how to add user notifications to Home Assistant."
date: 2015-01-20 22:36
sidebar: true
@ -12,9 +12,9 @@ ha_category: Notifications
featured: true
---
The `pushbullet` notification platform sends messages to [PushBullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends.
The `pushbullet` notification platform sends messages to [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends.
To enable PushBullet notifications in your installation, add the following to your `configuration.yaml` file:
To enable Pushbullet notifications in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -26,12 +26,12 @@ notify:
Configuration variables:
- **api_key** (*Required*): Enter the API key for PushBullet. Go to https://www.pushbullet.com/ to retrieve your API key.
- **api_key** (*Required*): Enter the API key for Pushbullet. Go to https://www.pushbullet.com/ to retrieve your API key.
- **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`.
### {% linkable_title Usage %}
PushBullet is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send a notification to all devices registered in the PushBullet account. An optional **target** parameter can be given to PushBullet to specify specific account's devices, contacts or channels.
Pushbullet is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send a notification to all devices registered in the Pushbullet account. An optional **target** parameter can be given to Pushbullet to specify specific account's devices, contacts or channels.
Type | Prefix | Suffix | Example
---- | ------ | ------ | -------

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

@ -35,7 +35,7 @@ notify:
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*): The slack API token to use for sending slack messages. You can get your slack API token here https://api.slack.com/web?sudo=1
- **api_key** (*Required*): The slack API token to use for sending slack messages.
- **default_channel** (*Required*): The default channel to post to if no channel is explicitly specified when sending the notification message.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

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

@ -38,11 +38,11 @@ Configuration variables:
- **port** (*Optional*): The port that the SMTP server is using, eg. 587 for Google Mail and STARTTLS or 465/993 depending on your SMTP servers. Defaults to 25.
- **sender** (*Optional*): E-mail address of the sender.
- **username** (*Optional*): Username for the SMTP account.
- **password** (*Optional*):Password for the SMTP server that belongs to the given username. If the password contains a colon it need to be wrapped in apostrophes.
- **password** (*Optional*): Password for the SMTP server that belongs to the given username. If the password contains a colon it need to be wrapped in apostrophes.
- **recipient** (*Required*): Recipient of the notification.
- **starttls** (*Optional*): Enables STARTTLS, eg. 1 or 0. Defaults to 0.
To use the smtp notification, refer to it in an automation or script like in this example:
To use the SMTP notification, refer to it in an automation or script like in this example:
```yaml
burglar:
@ -61,7 +61,7 @@ To use the smtp notification, refer to it in an automation or script like in thi
- /home/pi/snapshot2.jpg
```
The optional **images** field adds in-line image attachments to the email. This sends a text/HTML multi-part message instead of the plain text default.
The optional `images` field adds in-line image attachments to the email. This sends a text/HTML multi-part message instead of the plain text default.
This platform is fragile and not able to catch all exceptions in a smart way because of the large number of possible configuration combinations.

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

@ -17,6 +17,7 @@ The `rfxtrx` platform supports Siemens/LightwaveRF and RFY roller shutters that
First you have to set up your [rfxtrx hub](/components/rfxtrx/).
### {% linkable_title Configuration %}
##### Siemens/LightwaveRF
The easiest way to find your roller shutters is to add this to your `configuration.yaml`:

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

@ -36,7 +36,7 @@ Configuration variables:
- **resources** array (*Required*): Contains all entries to display.
#### Example
### {% linkable_title Example %}
Given the following output from `apcaccess`:

7
source/_components/sensor.dte_energy_bridge.markdown
View file

@ -19,11 +19,12 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
```yaml
# Example configuration.yaml entry
sensor:
platform: dte_energy_bridge
ip: 192.168.1.11
- platform: dte_energy_bridge
ip: 192.168.1.11
name: DTE Energy
```
Configuration variables:
- **ip** (*Required*): The IP address of your bridge.
- **name** (*Optional*): Name to use in the frontend.

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

@ -65,7 +65,7 @@ sensor:
If you are using a DHT sensor and a NodeMCU board (esp8266), you can retrieve temperature and humidity with a MQTT sensor. A code example can be found [here](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_sensor_dht22). A regular MQTT message from this example looks like this:
```
```json
office/sensor1
{
"temperature": 23.20,

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

@ -14,7 +14,7 @@ ha_release: 0.26
---
The `ohmconnect` sensor will show you the current [OhmConnect](https://ohmconnect.com) status for the given OhmConnect ID.
The `ohmconnect` sensor will show you the current [OhmConnect](https://www.ohmconnect.com/) status for the given OhmConnect ID.
> OhmConnect monitors real-time conditions on the electricity grid. When dirty and unsustainable power plants turn on, our users receive a notification to save energy. By saving energy at that time, California does not have to turn on additional power plants and California's energy authorities pay you for that.

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: network-snmp.png
ha_category: Sensor
ha_category: System Monitor
ha_iot_class: "Local Polling"
ha_release: "0.22"
---

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

@ -45,6 +45,7 @@ sensor:
platform: yweather
woeid: YOUR_WOEID
forecast: 3
name: OPTIONAL_NAME
monitored_conditions:
- weather
- temp_min
@ -55,6 +56,7 @@ Configuration variables:
- **woeid** (*Optional*): See above.
- **forecast** (*Optional*): Day of forecast. The default is the current day to display conditions.
- **name** (*Optional*): The name of the sensor. To easily recognize each sensor when adding more than one Yahoo weather sensor, it is recommended to use the name option.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend.
- **weather**: A human-readable text summary with picture from yahoo.
- **weather_current**: A human-readable text summary with picture from yahoo from current conditon.

10
source/_components/zeroconf.markdown
View file

@ -19,3 +19,13 @@ zeroconf:
```
The registration will include metadata about the Home Assistant instance, including a base URL that can be used to access Home Assistant, the currently running Home Assistant version, and whether an API password is needed to access the instance.
```bash
$ avahi-browse -alr
+ eth0 IPv4 Home _home-assistant._tcp local
= eth0 IPv4 Home _home-assistant._tcp local
hostname = [Home._home-assistant._tcp.local]
address = [192.168.0.5]
port = [8123]
txt = ["version=0.27.0.dev0" "base_url=http://192.168.0.5:8123" "requires_api_password=true"]
```