Skip to content

Commit cc81f09

Browse files
balloobballoob
committed
Merge branch 'current' into next
2 parents f09c0dd + 535c17a commit cc81f09

36 files changed

+736
-85
lines changed

‎_config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,10 +138,10 @@ social:
138138

139139
# Home Assistant release details
140140
current_major_version: 0
141-
current_minor_version: 41
141+
current_minor_version: 42
142142
current_patch_version: 0
143-
date_released: 2017-03-25
143+
date_released: 2017-04-08
144144

145145
# Either # or the anchor link to latest release notes in the blog post.
146146
# Must be prefixed with a # and have double quotes around it.
147-
#patch_version_notes: "#release-0411---march-xx"
147+
patch_version_notes: "#"

‎source/_components/automation.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ logo: home-assistant.png
1111
ha_category: Automation
1212
---
1313

14-
Please see the [getting started section](/getting-started/automation/) for in-depth documentation on how to use the automation component.
14+
Please see the [docs section](/docs/automation/) for in-depth documentation on how to use the automation component.
1515

1616
Starting with 0.28 your automation rules can be controlled with the frontend.
1717

‎source/_components/binary_sensor.aurora.markdown

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ sharing: true
99
footer: true
1010
ha_category: Binary Sensor
1111
ha_release: 0.39
12+
logo: noaa.png
1213
---
14+
1315
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.
1416

1517
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:
2426
- platform: aurora
2527
```
2628
27-
#### Configuration variables:
29+
Configuration variables:
2830
2931
- **forecast_threshold** (*Optional*): Provide your own threshold number above which the sensor will trigger. Defaults to 75.
32+
- **name** (*Optional*): The name of the sensor. Default is 'Aurora Visibility'.
3033
3134
```yaml
3235
binary_sensor:

‎source/_components/device_tracker.bluetooth_le_tracker.markdown

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,24 @@ ha_iot_class: "Local Poll"
1313
ha_release: 0.27
1414
---
1515

16-
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!
16+
<p class='note warning'>
17+
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.
18+
</p>
19+
20+
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.
1721

1822
Devices discovered are stored with 'BLE_' as the prefix for device mac addresses in `known_devices.yaml`.
1923

20-
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`
24+
This platform requires pybluez to be installed. On Debian based installs, run
25+
26+
```bash
27+
$ sudo apt install bluetooth libbluetooth-dev pkg-config libboost-python-dev libboost-thread-dev libglib2.0-dev python-dev
28+
```
2129

2230
Before you get started with this platform, please note that:
31+
2332
- This platform is incompatible with Windows
2433
- This platform requires root privileges
25-
- Don't use on a Raspberry Pi. It will become unusable slow when using this platform.
2634

2735
To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:
2836

‎source/_components/emulated_hue.markdown

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,21 @@ The virtual bridge has the ability to turn entities on or off, or change the bri
2525
To enable the emulated Hue bridge, add one of the following configs to your `configuration.yaml` file:
2626

2727
```yaml
28-
# Amazon Echo example configuration.yaml entry
28+
# Google Home example configuration.yaml entry
2929
emulated_hue:
30+
# Google Home does not work on different ports.
3031
```
3132

3233
```yaml
33-
# Google Home example configuration.yaml entry
34+
# Amazon Echo example configuration.yaml entry
3435
emulated_hue:
35-
type: google_home
36-
# Google Home does not work on different ports.
36+
type: alexa
3737
listen_port: 80
3838
```
3939
4040
Configuration variables:
4141
42-
- **type** (*Optional*): The type of assistant who we are emulated for. Either `alexa` or `google_home`, defaults to `alexa`.
42+
- **type** (*Optional*): The type of assistant who we are emulated for. Either `alexa` or `google_home`, defaults to `google_home`.
4343
- **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.
4444
- **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.
4545

‎source/_components/light.mqtt.markdown

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ logo: mqtt.png
1111
ha_category: Light
1212
---
1313

14-
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.
14+
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.
1515

16-
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.
16+
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.
1717

1818
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`).
1919

@@ -45,6 +45,7 @@ Configuration variables:
4545
- **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF".
4646
- **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON".
4747
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
48+
- **retain** (*Optional*): If the published message should have the retain flag on or not.
4849
- **rgb_command_topic** (*Optional*): The MQTT topic to publish commands to change the light's RGB state.
4950
- **rgb_state_topic** (*Optional*): The MQTT topic subscribed to receive RGB state updates.
5051
- **rgb_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract the RGB value.
@@ -127,4 +128,5 @@ light:
127128

128129
### {% linkable_title Implementations %}
129130

130-
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).
131+
- 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).
132+
- 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).

‎source/_components/light.mqtt_json.markdown

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ light:
121121

122122
### {% linkable_title Implementations %}
123123

124-
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.
124+
- 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.
125125

126-
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)
126+
- 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).
127+
128+
- [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/).

‎source/_components/light.rflink.markdown

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ Configuration variables:
4747
Device configuration variables:
4848

4949
- **name** (*Optional*): Name for the device, defaults to Rflink ID.
50-
- **type** (*Optional*): Override automatically detected type of the light device, can be: switchable, dimmable, hybrid or toggle. See 'Light Types' below.
50+
- **type** (*Optional*): Override automatically detected type of the light device, can be: switchable, dimmable, hybrid or toggle. See 'Light Types' below. (default: Switchable)
5151
- **aliasses** (*Optional*): Alternative Rflink ID's this device is known by.
5252
- **fire_event** (*Optional*): Fire an `button_pressed` event if this device is turned on or off (default: False).
53-
- **signal_repetitions** (*Optional*): Repeat every Rflink command this number of times (default: 1)
53+
- **signal_repetitions** (*Optional*): Repeat every Rflink command this number of times (default: 1).
5454
- **fire_event_** (*Optional*): Set default `fire_event` for RFLink switch devices (see below).
5555
- **signal_repetitions** (*Optional*): Set default `signal_repetitions` for RFLink switch devices (see below).
5656

@@ -71,6 +71,10 @@ light:
7171
aliasses:
7272
- newkaku_000000001_2
7373
- kaku_000001_a
74+
Ansluta_ce30_0:
75+
name: Kitchen Under Counter Lights
76+
Maclean_0d82_01:
77+
name: Bedroom Lamp
7478
```
7579

7680
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.

‎source/_components/logger.markdown

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,9 @@ data:
6767
homeassistant.components: warning
6868
homeassistant.components.media_player.yamaha: debug
6969
```
70+
71+
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:
72+
73+
```bash
74+
$ tail -f /home/pi/.homeassistant/home-assistant.log
75+
```

‎source/_components/lutron_caseta.markdown

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
layout: page
3+
title: "Lutron Caseta"
4+
description: "Instructions how to use Lutron Caseta devices with Home Assistant."
5+
date: 2017-01-28 13:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: lutron.png
11+
ha_category: Hub
12+
featured: False
13+
ha_release: 0.41
14+
---
15+
16+
[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.
17+
18+
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.
19+
20+
When configured, the `lutron_caseta` component will automatically discover dimmers and switches as setup in the Lutron SmartBridge.
21+
22+
To use Lutron Caseta devices in your installation, add the following to your configuration.yaml file using the IP of your lutron Smartbridge:
23+
24+
``` yaml
25+
lutron_caseta:
26+
host: <ip_address>
27+
username: lutron
28+
password: integration
29+
```
30+
31+
Configuration variables:
32+
33+
- **host** (*Required*): The IP address of the Lutron SmartBridge.
34+
- **username** (*Required*): The login name of the user. The user `lutron` always exists.
35+
- **password** (*Required*): The password for the user specified above. `integration` is the password for the always-present `lutron` user.
36+
37+
<p class='note'>
38+
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.
39+
</p>

‎source/_components/media_player.nad.markdown

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,6 @@ To add an NAD receiver to your installation, add the following to your `configur
2323
media_player:
2424
- platform: nad
2525
serial_port: /dev/ttyUSB0
26-
name: NAD Receiver
27-
min_volume: -60
28-
max_volume: -20
29-
sources:
30-
1: 'Kodi'
31-
2: 'TV'
3226
```
3327
3428
Configuration variables:
@@ -39,12 +33,25 @@ Configuration variables:
3933
- **max_volume** (*optional*): Maximum volume in dB to use with the slider. Default is `-20`
4034
- **sources** (*Optional*): A list of mappings from source to source name. Valid sources are `1 to 10`.
4135

42-
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.
43-
You can still force it to go higher or lower than the values set with the plus and minus buttons.
36+
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.
4437

4538
<p class='note warning'>
4639
On linux the user running home-assistant needs `dialout` permissions to access the serial port.
4740
This can be added to the user by doing `sudo usermod -a -G dialout <username>`.
4841
Be aware that the user might need to logout and logon again to activate these permissions.
4942
</p>
5043

44+
A full configuration example could look like this:
45+
46+
```yaml
47+
# Example configuration.yaml entry
48+
media_player:
49+
- platform: nad
50+
serial_port: /dev/ttyUSB0
51+
name: NAD Receiver
52+
min_volume: -60
53+
max_volume: -20
54+
sources:
55+
1: 'Kodi'
56+
2: 'TV'
57+
```

‎source/_components/rflink.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ha_category: Hub
1212
ha_release: 0.38
1313
---
1414

15-
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).
15+
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).
1616

1717
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.
1818

‎source/_components/scene.wink.markdown

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: page
3+
title: "Wink Scene"
4+
description: "Instructions how to setup the Wink scenes(shortcuts) within Home Assistant."
5+
date: 2017-04-01 16:45
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: wink.png
11+
ha_category: Scene
12+
ha_release: 0.41
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
17+
The Wink scene platform allows you to control your [Wink](http://www.wink.com/) shortcuts.
18+
19+
The requirement is that you have setup [Wink](/components/wink/).

‎source/_components/sensor.crimereports.markdown

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
layout: page
3+
title: "Crime Reports"
4+
description: "Instructions on how to integrate CrimeReports.com into Home Assistant."
5+
date: 2017-02-16 11:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
ha_category: Sensor
11+
featured: false
12+
ha_release: 0.42
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
The `crimereports` sensor allows one to track reported incidents occurring in a Home Assistant zone. Incidents include anything reported to [Crime Reports](http://crimereports.com). Your regional emergency services may or may not report data. The sensor only counts incidents from the current day.
17+
18+
## Configuration
19+
20+
To enable this sensor, add the following lines to your `configuration.yaml`. Your `zone` should be of sufficient size to capture incidents in your area. Your `home` zone is probably too small.
21+
22+
```yaml
23+
zone:
24+
- name: neighborhood
25+
latitude: <your latitude>
26+
longitude: <your longitude>
27+
radius: <your neighborhood radius>
28+
29+
sensor:
30+
- platform: crimereports
31+
zone: neighborhood
32+
```
33+
34+
Configuration options for the Crime Reports Sensor:
35+
36+
- **zone** (*Required*): The zone to monitor.
37+
- **include** (*Optional*): List of incident types to include.
38+
- **exclude** (*Optional*): List of incident types to exclude.
39+
- **update_inverval** (*Optional*): Minimum time interval between updates. Default is 30 minutes. Supported formats:
40+
- `update_interval: 'HH:MM:SS'`
41+
- `update_interval: 'HH:MM'`
42+
- Time period dictionary, e.g.:
43+
<pre>update_interval:
44+
# At least one of these must be specified:
45+
days: 0
46+
hours: 0
47+
minutes: 3
48+
seconds: 30
49+
milliseconds: 0
50+
</pre>
51+
52+
## Notes
53+
54+
### Area
55+
56+
Crime Reports captures all incidents in a region defined by a square shape. Home Assistant zones are circular. Therefore, the region defined by a Home Assistant zone in a Crime Reports context is a square that is big enough to fit the zone circle. Practically, this means some incidents may be captured that are outside your zone.
57+
58+
### Incident Types
59+
60+
You can explicitly include or exclude incident types. Specifying `include`s restricts the incidents to those types. Specifying `exclude`s will return all incident types except those specified.
61+
62+
These incident types are available:
63+
64+
- Alarm
65+
- Arson
66+
- Assault
67+
- Assault with Deadly Weapon
68+
- Breaking & Entering
69+
- Community Policing
70+
- Death
71+
- Disorder
72+
- Drugs
73+
- Emergency
74+
- Family Offense
75+
- Fire
76+
- Homicide
77+
- Kidnapping
78+
- Liquor
79+
- Missing Person
80+
- Other
81+
- Other Sexual Offense
82+
- Pedestrian Stop
83+
- Proactive Policing
84+
- Property Crime
85+
- Property Crime Commercial
86+
- Property Crime Residential
87+
- Quality of Life
88+
- Robbery
89+
- Sexual Assault
90+
- Sexual Offense
91+
- Theft
92+
- Theft from Vehicle
93+
- Theft of Vehicle
94+
- Traffic
95+
- Vehicle Recovery
96+
- Vehicle Stop
97+
- Weapons Offense
98+
99+
### Events
100+
101+
The `crimealerts` sensor fires a `crimealerts_incident` event when a new incident is detected, including the type, description, time, location, and coordinates of the incident.

‎source/_components/sensor.lyft.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ footer: true
1010
logo: lyft.png
1111
ha_category: Transport
1212
ha_iot_class: "Cloud Polling"
13-
ha_release: 0.42
13+
ha_release: 0.41
1414
---
1515

1616

0 commit comments

Comments
 (0)