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:
Fabian Affolter 2017-04-06 09:29:33 +02:00
commit bdc3a02fb5
No known key found for this signature in database
GPG key ID: E23CD2DD36A4397F
25 changed files with 197 additions and 63 deletions
Download patch file Download diff file Expand all files Collapse all files

2
source/_components/automation.markdown
View file

@ -11,7 +11,7 @@ logo: home-assistant.png
ha_category: Automation
---
Please see the [getting started section](/getting-started/automation/) for in-depth documentation on how to use the automation component.
Please see the [docs section](/docs/automation/) for in-depth documentation on how to use the automation component.
Starting with 0.28 your automation rules can be controlled with the frontend.

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

@ -9,7 +9,9 @@ sharing: true
footer: true
ha_category: Binary Sensor
ha_release: 0.39
logo: noaa.png
---
The `aurora` platform uses the [NOAA aurora forecast](http://www.swpc.noaa.gov/products/aurora-30-minute-forecast) service to let you know if an aurora might be visible at your home location in the next 30 minutes, based off of current solar flare activity.
This service gives a number 0-100 representing the current likelihood of visible auroras at your latitude/longitude. By default this sensor is set up to trigger when the reported likelihood for your location is > 75. It updates every 5 minutes.
@ -24,9 +26,10 @@ binary_sensor:
- platform: aurora
```
#### Configuration variables:
Configuration variables:
- **forecast_threshold** (*Optional*): Provide your own threshold number above which the sensor will trigger. Defaults to 75.
- **name** (*Optional*): The name of the sensor. Default is 'Aurora Visibility'.
```yaml
binary_sensor:

14
source/_components/device_tracker.bluetooth_le_tracker.markdown
View file

@ -13,16 +13,24 @@ ha_iot_class: "Local Poll"
ha_release: 0.27
---
This tracker discovers new devices on boot and in regular intervals and tracks bluetooth low-energy devices periodically based on interval_seconds value. It is not required to pair the devices with each other!
<p class='note warning'>
We have received <a href='https://github.com/home-assistant/home-assistant/issues/4442'>numerous reports</a> that this integration will have a big impact on the performance of the server.
</p>
This tracker discovers new devices on boot and in regular intervals and tracks bluetooth low-energy devices periodically based on interval_seconds value. It is not required to pair the devices with each other.
Devices discovered are stored with 'BLE_' as the prefix for device mac addresses in `known_devices.yaml`.
This platform requires pybluez to be installed. On Debian based installs, run `sudo apt install bluetooth libbluetooth-dev pkg-config libboost-python-dev libboost-thread-dev libglib2.0-dev python-dev`
This platform requires pybluez to be installed. On Debian based installs, run
```bash
$ sudo apt install bluetooth libbluetooth-dev pkg-config libboost-python-dev libboost-thread-dev libglib2.0-dev python-dev
```
Before you get started with this platform, please note that:
- This platform is incompatible with Windows
- This platform requires root privileges
- Don't use on a Raspberry Pi. It will become unusable slow when using this platform.
To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:

2
source/_components/emulated_hue.markdown
View file

@ -39,7 +39,7 @@ emulated_hue:
Configuration variables:
- **type** (*Optional*): The type of assistant who we are emulated for. Either `alexa` or `google_home`, defaults to `alexa`.
- **type** (*Optional*): The type of assistant who we are emulated for. Either `alexa` or `google_home`, defaults to `google_home`.
- **host_ip** (*Optional*): The IP address that your Home Assistant installation is running on. If you do not specify this option, the component will attempt to determine the IP address on its own.
- **listen_port** (*Optional*): The port the Hue bridge API web server will run on. If not specified, this defaults to 8300. This can be any free port on your system.

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

@ -11,9 +11,9 @@ logo: mqtt.png
ha_category: Light
---
The `mqtt` light platform lets you control your MQTT enabled light. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values.
The `mqtt` light platform lets you control your MQTT enabled lights. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values.
In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with RETAIN flag, the MQTT switch will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/off.
In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with RETAIN flag, the MQTT light will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/off.
When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from device (message from `state_topic`).
@ -127,4 +127,5 @@ light:
### {% linkable_title Implementations %}
A basic example using a nodeMCU board (ESP8266) to control its built-in led (on/off) can be found [here](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_light). [Here](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_rgb_light) is another example to control a RGB led (on/off, brightness and colors).
- A [basic example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_light) using a nodeMCU board (ESP8266) to control its built-in LED (on/off).
- Another [example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_rgb_light) to control a RGB LED (on/off, brightness, and colors).

6
source/_components/light.mqtt_json.markdown
View file

@ -121,6 +121,8 @@ light:
### {% linkable_title Implementations %}
A full example of custom lighting using this platform and an ESP8266 microcontroller can be found [here](https://github.com/corbanmailloux/esp-mqtt-rgb-led). It supports on/off, brightness, transitions, RGB colors, and flashing.
- A full example of custom lighting using this platform and an ESP8266 microcontroller can be found [here](https://github.com/corbanmailloux/esp-mqtt-rgb-led). It supports on/off, brightness, transitions, RGB colors, and flashing.
There is also another implementation forked from the above repo, it supports all the same features but is made for addressable LED strips using FastLED on a NodeMCU V3 it can be found [here](https://github.com/JammyDodger231/nodemcu-mqtt-rgb-led)
- There is also another implementation forked from the above repo, it supports all the same features but is made for addressable LED strips using FastLED on a NodeMCU V3 it can be found [here](https://github.com/JammyDodger231/nodemcu-mqtt-rgb-led).
- [MQTT JSON Light](https://github.com/mertenats/Open-Home-Automation/tree/master/ha_mqtt_rgbw_light_with_discovery) is another implementation for ESP8266 including [MQTT discovery](/docs/mqtt/discovery/).

8
source/_components/light.rflink.markdown
View file

@ -47,10 +47,10 @@ Configuration variables:
Device configuration variables:
- **name** (*Optional*): Name for the device, defaults to Rflink ID.
- **type** (*Optional*): Override automatically detected type of the light device, can be: switchable, dimmable, hybrid or toggle. See 'Light Types' below.
- **type** (*Optional*): Override automatically detected type of the light device, can be: switchable, dimmable, hybrid or toggle. See 'Light Types' below. (default: Switchable)
- **aliasses** (*Optional*): Alternative Rflink ID's this device is known by.
- **fire_event** (*Optional*): Fire an `button_pressed` event if this device is turned on or off (default: False).
- **signal_repetitions** (*Optional*): Repeat every Rflink command this number of times (default: 1)
- **signal_repetitions** (*Optional*): Repeat every Rflink command this number of times (default: 1).
- **fire_event_** (*Optional*): Set default `fire_event` for RFLink switch devices (see below).
- **signal_repetitions** (*Optional*): Set default `signal_repetitions` for RFLink switch devices (see below).
@ -71,6 +71,10 @@ light:
aliasses:
- newkaku_000000001_2
- kaku_000001_a
Ansluta_ce30_0:
name: Kitchen Under Counter Lights
Maclean_0d82_01:
name: Bedroom Lamp
```
Any on/off command from any allias ID updates the current state of the light. However when sending a command through the frontend only the primary ID is used.

6
source/_components/logger.markdown
View file

@ -67,3 +67,9 @@ data:
homeassistant.components: warning
homeassistant.components.media_player.yamaha: debug
```
The log information are stored in the [configuration directory](/docs/configuration/) as `home-assistant.log` and you can read it with the command-line tool `cat` or follow it dynamicly with `tail -f`. If you are a Rasbian user then like the example below:
```bash
$ tail -f /home/pi/.homeassistant/home-assistant.log
```

39
source/_components/lutron_caseta.markdown Normal file
View file

@ -0,0 +1,39 @@
---
layout: page
title: "Lutron Caseta"
description: "Instructions how to use Lutron Caseta devices with Home Assistant."
date: 2017-01-28 13:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lutron.png
ha_category: Hub
featured: False
ha_release: 0.41
---
[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches/dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` component in Home Assistant is responsible for communicating with the Lutron SmartBridge for these systems.
This component only supports the Caseta line of products. Current only supports Caseta dimmers as Home Assistant lights and caseta wall switches as Home Assistant switches.
When configured, the `lutron_caseta` component will automatically discover dimmers and switches as setup in the Lutron SmartBridge.
To use Lutron Caseta devices in your installation, add the following to your configuration.yaml file using the IP of your lutron Smartbridge:
``` yaml
lutron_caseta:
host: <ip_address>
username: lutron
password: integration
```
Configuration variables:
- **host** (*Required*): The IP address of the Lutron SmartBridge.
- **username** (*Required*): The login name of the user. The user `lutron` always exists.
- **password** (*Required*): The password for the user specified above. `integration` is the password for the always-present `lutron` user.
<p class='note'>
It is recommended to assign a static IP address to your Lutron SmartBridge. This ensures that it won't change IP address, so you won't have to change the `host` if it reboots and comes up with a different IP address.
</p>

23
source/_components/media_player.nad.markdown
View file

@ -23,12 +23,6 @@ To add an NAD receiver to your installation, add the following to your `configur
media_player:
- platform: nad
serial_port: /dev/ttyUSB0
name: NAD Receiver
min_volume: -60
max_volume: -20
sources:
1: 'Kodi'
2: 'TV'
```
Configuration variables:
@ -39,8 +33,7 @@ Configuration variables:
- **max_volume** (*optional*): Maximum volume in dB to use with the slider. Default is `-20`
- **sources** (*Optional*): A list of mappings from source to source name. Valid sources are `1 to 10`.
The min_volume and max_volume are there to protect you against misclicks on the slider so you will not blow up your speakers when you go from -92dB to +20dB.
You can still force it to go higher or lower than the values set with the plus and minus buttons.
The min_volume and max_volume are there to protect you against misclicks on the slider so you will not blow up your speakers when you go from -92dB to +20dB. You can still force it to go higher or lower than the values set with the plus and minus buttons.
<p class='note warning'>
On linux the user running home-assistant needs `dialout` permissions to access the serial port.
@ -48,3 +41,17 @@ This can be added to the user by doing `sudo usermod -a -G dialout <username>`.
Be aware that the user might need to logout and logon again to activate these permissions.
</p>
A full configuration example could look like this:
```yaml
# Example configuration.yaml entry
media_player:
- platform: nad
serial_port: /dev/ttyUSB0
name: NAD Receiver
min_volume: -60
max_volume: -20
sources:
1: 'Kodi'
2: 'TV'
```

2
source/_components/rflink.markdown
View file

@ -12,7 +12,7 @@ ha_category: Hub
ha_release: 0.38
---
The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
The 433 Mhz spectrum is used by many manufacturers mostly using their own protocol/standard and includes devices like: light switches, blinds, weather stations, alarms and various other sensors.

19
source/_components/scene.wink.markdown Normal file
View file

@ -0,0 +1,19 @@
---
layout: page
title: "Wink Scene"
description: "Instructions how to setup the Wink scenes(shortcuts) within Home Assistant."
date: 2017-04-01 16:45
sidebar: true
comments: false
sharing: true
footer: true
logo: wink.png
ha_category: Scene
ha_release: 0.41
ha_iot_class: "Cloud Polling"
---
The Wink scene platform allows you to control your [Wink](http://www.wink.com/) shortcuts.
The requirement is that you have setup [Wink](/components/wink/).

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

@ -39,7 +39,7 @@ sensor:
Configuration variables:
- **entity_ids** (*Required*): At least two entities to monitor
- **entity_ids** (*Required*): At least two entities to monitor. The unit of measurement of the first entry will be the one that's used. All entities must use the same unit of measurement.
- **type** (*Optional*): The type of sensor: `min`, `max` or `mean`. Defaults to `max`.
- **name** (*Optional*): Name of the sensor to use in the frontend.
- **round_digits** (*Optional*): Round mean value to specified number of digits. Defaults to 2.

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

@ -13,7 +13,7 @@ ha_release: 0.24
---
The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/) as an source for current meteorological data. The `forecast` will show you the condition for 5 days, 0 is the current day. You can use only `weather`, `temp_min`, and `temp_max` with forecast.
The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/) as an source for current meteorological data. The `forecast` will show you the condition for 5 days, 0 is the current day. You can use only `weather`, `temp_min`, and `temp_max` with forecast. It's important to note that a yweather sensor will only show ONE days forecast at a time so to show multiple days forecasts, you will need to use the 'name:' option and give each sensor a unique name.
<p class='note warning'>
Use of the Yahoo Weather API should not exceed reasonable request volume. Access is limited to 2,000 signed calls per day.
@ -55,6 +55,37 @@ Configuration variables:
- **pressure**: The sea-level air pressure in millibars.
- **visibility**: The average visibility.
Example of forecast using multiple days. In example, first sensor shows tomorrow's forecast, second sensor shows the next day and so on:
```yaml
# Example configuration.yaml entry
sensor:
- platform: yweather
forecast: 1
name: yw_day1
monitored_conditions:
- weather
- temp_min
- temp_max
- platform: yweather
forecast: 2
name: yw_day2
monitored_conditions:
- weather
- temp_min
- temp_max
- platform: yweather
forecast: 3
name: yw_day3
monitored_conditions:
- weather
- temp_min
- temp_max
```
Details about the API are available in the [Yahoo! Developer Network](https://developer.yahoo.com/weather/).