Skip to content

Commit 2581fb1

Browse files
balloobballoob
committed
Merge branch 'current' into next
2 parents 3570a1e + ba27a12 commit 2581fb1

File tree

71 files changed

+994
-485
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+994
-485
lines changed

‎source/_addons/git_pull.markdown

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,30 @@ Load and update configuration files for Home Assistant from a GIT repository.
1818
"repeat": {
1919
"active": false,
2020
"interval": 300
21-
}
21+
},
22+
"deployment_key": [
23+
"-----BEGIN RSA PRIVATE KEY-----",
24+
"MIIEowIBAAKCAQEAv3hUrCvqGZKpXQ5ofxTOuH6pYSOZDsCqPqmaGBdUzBFgauQM",
25+
"xDEcoODGHIsWd7t9meAFqUtKXndeiKjfP0MMKsttnDohL1kb9mRvHre4VUqMsT5F",
26+
"...",
27+
"i3RUtnIHxGi1NqknIY56Hwa3id2yk7cEzvQGAAko/t6PCbe20AfmSQczs7wDNtBD",
28+
"HgXRyIqIXHYk2+5w+N2eunURIBqCI9uWYK/r81TMR6V84R+XhtvM",
29+
"-----END RSA PRIVATE KEY-----"
30+
],
31+
"deployment_key_protocol": "rsa"
2232
}
2333
```
2434

2535
- **repository** (*Required*): GIT url to your repository.
2636
- **auto_restart** (*Optional*): Make a restart of Home-Assistant if the config have change and is valid.
2737
- **repeat/active** (*Optional*): Pull periodic for GIT updates.
2838
- **repeat/interval** (*Optional*): Pull all x seconds and look for changes.
39+
- **deployment_key** (*Optional*): A private SSH key that will be used for communication during git operations. This key is mandatory for ssh-accessed repositories, which are the ones with the following pattern: `<user>@<host>:<repository path>`.
40+
- **deployment_key_protocol** (*Optional*): The key protocol. Default is "rsa". Valid protocols are:
41+
42+
* **dsa**
43+
* **ecdsa**
44+
* **ed25519**
45+
* **rsa**
46+
47+
The protocol is typically known by the suffix of the private key --e.g., a key file named `id_rsa` will be a private key using "rsa" protocol.

‎source/_components/apple_tv.markdown

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ logo: apple.png
1111
ha_category: Hub
1212
ha_iot_class: "Local Push"
1313
ha_release: 0.49
14-
featured: true
1514
---
1615

1716
The `apple_tv` platform allows you to control an Apple TV (3rd and 4th generation). See the [remote platform](/components/remote.apple_tv/) if you want to send remote control buttons, e.g. arrow keys.

‎source/_components/binary_sensor.bayesian.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ binary_sensor:
6969
prob_given_true: 0.5
7070
platform: 'state'
7171
to_state: 'on'
72-
- entity_id: 'sensor.sun'
72+
- entity_id: 'sun.sun'
7373
prob_given_true: 0.7
7474
platform: 'state'
7575
to_state: 'below_horizon'

‎source/_components/binary_sensor.knx.markdown

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -18,43 +18,49 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary
1818
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
1919

2020
```yaml
21+
# Example configuration.yaml entry
2122
binary_sensor:
22-
- platform: knx
23-
name: "Entrance.Motion.Sensor"
24-
address: '6/0/2'
25-
device_class: 'motion'
26-
#significant_bit: 2
23+
- platform: knx
24+
name: "Entrance.Motion.Sensor"
25+
address: '6/0/2'
26+
device_class: 'motion'
27+
#significant_bit: 2
2728
```
2829

29-
* **name** (*Optional*): A name for this device used within Home Assistant.
30-
* **address**: KNX group address of the binary sensor
31-
* **device_class**: (Optional) HASS device class e.g. "motion"
32-
* **significant_bit**: (Optional) Specify which significant bit of the KNX value should be used. Default is 1.
30+
Configuration variables:
31+
32+
- **name** (*Optional*): A name for this device used within Home Assistant.
33+
- **address**: KNX group address of the binary sensor.
34+
- **device_class** (Optional): HASS device class e.g. "motion".
35+
- **significant_bit** (Optional): Specify which significant bit of the KNX value should be used. Default is 1.
3336

3437
You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time.
3538

3639
```yaml
40+
# Example configuration.yaml entry
3741
binary_sensor:
38-
- platform: knx
39-
name: Livingroom.3Switch3
40-
address: '5/0/26'
41-
automation:
42-
- counter: 1
43-
hook: 'on'
44-
action:
45-
- entity_id: light.hue_color_lamp_1
46-
service: homeassistant.turn_on
47-
- counter: 2
48-
hook: 'on'
49-
action:
50-
- entity_id: light.hue_bloom_1
51-
service: homeassistant.turn_on
52-
- entity_id: light.hue_bloom_2
53-
service: homeassistant.turn_on
42+
- platform: knx
43+
name: Livingroom.3Switch3
44+
address: '5/0/26'
45+
automation:
46+
- counter: 1
47+
hook: 'on'
48+
action:
49+
- entity_id: light.hue_color_lamp_1
50+
service: homeassistant.turn_on
51+
- counter: 2
52+
hook: 'on'
53+
action:
54+
- entity_id: light.hue_bloom_1
55+
service: homeassistant.turn_on
56+
- entity_id: light.hue_bloom_2
57+
service: homeassistant.turn_on
5458
```
5559
60+
Configuration variables:
61+
5662
- **name** (*Optional*): A name for this device used within Home Assistant.
57-
- **counter**: (*Optional*) Set to 2 if your only want the action to be executed if the button was pressed twice. To 3 for three times button pressed. Defaults to 1.
58-
- **hook**: (Optional): Indicates if the automation should be executed on what state of the binary sensor. Values: "on" or "off". Defaults to "on".
59-
- **action**: Specify a list of actions analog to the [HASS automation rules](https://home-assistant.io/docs/automation/action/).
63+
- **counter** (*Optional*): Set to 2 if your only want the action to be executed if the button was pressed twice. To 3 for three times button pressed. Defaults to 1.
64+
- **hook** (Optional): Indicates if the automation should be executed on what state of the binary sensor. Values: "on" or "off". Defaults to "on".
65+
- **action**: Specify a list of actions analog to the [automation rules](/docs/automation/action/).
6066

‎source/_components/binary_sensor.markdown

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@ sharing: true
99
footer: true
1010
---
1111

12-
Binary sensors gather information about state of switches, contacts, pins, and alike. The return value of those sensors is usually digital (1/0). This means that those sensors knows only two states: **0/off/low/closed/false** and **1/on/high/open/true**.
13-
14-
Knowing that there are only two states allows Home Assistant to represent these sensors in a better way in the frontend according to their functionality.
12+
Binary sensors gather information about the state of devices which have a "digital" return value (either 1 or 0). These can be switches, contacts, pins, etc. These sensors only have two states: **0/off/low/closed/false** and **1/on/high/open/true**. Knowing that there are only two states allows Home Assistant to represent these sensors in a better way in the frontend according to their functionality.
1513

1614
The way these sensors are displayed in the frontend can be modified in the [customize section](/getting-started/customizing-devices/). The following device classes are supported for binary sensors:
1715

‎source/_components/climate.ephember.markdown

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: page
3+
title: "EPH Controls Ember Thermostat"
4+
description: "Instructions on how to integrate EPH Controls Ember thermostats within Home Assistant."
5+
date: 2017-10-07 12:40
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: ephcontrolsember.png
11+
ha_category: Climate
12+
ha_release: "0.55"
13+
ha_iot_class: "Local Polling"
14+
---
15+
16+
17+
The `ephember` climate platform lets you control [EPH Controls](http://emberapp.ephcontrols.com/) thermostats. The module only works if you have a WiFi gateway to control your EPH system and an account on the ember app.
18+
19+
To set it up, add the following information to your `configuration.yaml` file:
20+
21+
```yaml
22+
climate:
23+
- platform: ephember
24+
username: YOUR_EMAIL
25+
password: YOUR_PASSWORD
26+
```
27+
28+
A single interface can handle up to 32 connected devices.
29+
30+
Configuration variables:
31+
32+
- **username** (*Required*): The email address you used to sign up to the ember app
33+
- **password** (*Required*): The password you used to sign up to the ember app

‎source/_components/climate.knx.markdown

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ The `knx` component must be configured correctly, see [KNX Component](/component
2121
To use your KNX thermostats in your installation, add the following lines to your `configuration.yaml` file:
2222

2323
```yaml
24+
# Example configuration.yaml entry
2425
climate:
2526
- platform: knx
2627
name: HASS-Kitchen.Temperature
@@ -33,31 +34,33 @@ climate:
3334
Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode:
3435
3536
```yaml
37+
# Example configuration.yaml entry
3638
climate:
37-
- platform: knx
38-
name: HASS-Kitchen.Temperature
39-
temperature_address: '6/2/1'
40-
setpoint_address: '5/1/2'
41-
target_temperature_address: '5/1/1'
42-
operation_mode_frost_protection_address: '5/1/3'
43-
operation_mode_night_address: '5/1/4'
44-
operation_mode_comfort_address: '5/1/5'
39+
- platform: knx
40+
name: HASS-Kitchen.Temperature
41+
temperature_address: '6/2/1'
42+
setpoint_address: '5/1/2'
43+
target_temperature_address: '5/1/1'
44+
operation_mode_frost_protection_address: '5/1/3'
45+
operation_mode_night_address: '5/1/4'
46+
operation_mode_comfort_address: '5/1/5'
4547
```
4648
49+
Configuration variables:
4750
48-
* **name** (*Optional*): A name for this device used within Home Assistant.
49-
* **temperature_address**: KNX group address for reading current room temperature from KNX bus.
50-
* **target_temperature_address**: KNX group address for reading current target temperature from KNX bus.
51-
* **setpoint_address**: KNX group address for basis setpoint
51+
- **name** (*Optional*): A name for this device used within Home Assistant.
52+
- **temperature_address**: KNX group address for reading current room temperature from KNX bus.
53+
- **target_temperature_address**: KNX group address for reading current target temperature from KNX bus.
54+
- **setpoint_address**: KNX group address for basis setpoint
5255
53-
* **operation_mode_address** (*Optional*) KNX address for operation mode (Frost protection/night/comfort).
54-
* **operation_mode_state_address** (*Optional*) Explicit KNX address for reading operation mode
55-
* **controller_status_address** (*Optional*) KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3)
56-
* **controller_status_state_address** (*Optional*) Explicit KNX address for reading HVAC controller status
56+
- **operation_mode_address** (*Optional*): KNX address for operation mode (Frost protection/night/comfort).
57+
- **operation_mode_state_address** (*Optional*): Explicit KNX address for reading operation mode
58+
- **controller_status_address** (*Optional*): KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3)
59+
- **controller_status_state_address** (*Optional*): Explicit KNX address for reading HVAC controller status
5760
58-
* **operation_mode_frost_protection_address** (*Optional*) KNX address for switching on/off frost/heat protection mode.
59-
* **operation_mode_night_address** (*Optional*) KNX address for switching on/off night mode.
60-
* **operation_mode_comfort_address** (*Optional*) KNX address for switching on/off comfort mode.
61+
- **operation_mode_frost_protection_address** (*Optional*): KNX address for switching on/off frost/heat protection mode.
62+
- **operation_mode_night_address** (*Optional*): KNX address for switching on/off night mode.
63+
- **operation_mode_comfort_address** (*Optional*): KNX address for switching on/off comfort mode.
6164
6265
`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` was specified.
6366

‎source/_components/climate.mqtt.markdown

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,6 @@ A full configuration example looks like the one below.
7070
climate:
7171
- platform: mqtt
7272
name: Study
73-
target_sensor: sensor.study_temperature
7473
modes:
7574
- off
7675
- cool

‎source/_components/counter.markdown

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,10 @@ Configuration variables:
3232
- **step** (*Optional*): Incremental/step value for the counter. Defaults to 1 (increments by 1).
3333
- **icon** (*Optional*): Icon for entry.
3434
35-
Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`.
35+
Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance` or `mdi:motorbike`.
3636

3737
## {% linkable_title Services %}
3838

39-
### {% linkable_title Media control services %}
4039
Available services: `increment`, `decrement`, and `reset`.
4140

4241
#### {% linkable_title Service `counter.increment` %}

‎source/_components/cover.knx.markdown

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,27 @@ To use your KNX covers in your installation, add the following to your `configur
2323
```yaml
2424
# Example configuration.yaml entry
2525
cover:
26-
- platform: knx
27-
name: "Kitchen.Shutter"
28-
move_long_address: '3/0/0'
29-
move_short_address: '3/0/1'
30-
position_address: '3/0/3'
31-
position_state_address: '3/0/2'
32-
travelling_time_down: 51
33-
travelling_time_up: 61
26+
- platform: knx
27+
name: "Kitchen.Shutter"
28+
move_long_address: '3/0/0'
29+
move_short_address: '3/0/1'
30+
position_address: '3/0/3'
31+
position_state_address: '3/0/2'
32+
travelling_time_down: 51
33+
travelling_time_up: 61
3434
```
3535
36+
Configuration variables:
37+
3638
- **name** (*Optional*): A name for this device used within Home Assistant.
3739
- **move_long_address**: KNX group address for moving the cover full up or down.
38-
- **move_short_address**: (*Optional*) KNX group address for moving the cover short time up or down.
39-
- **position_address**: (*Optional*) KNX group address for moving the cover to the dedicated position.
40-
- **position_state_address**: (*Optional*) Separate KNX group address for requesting the current position of the cover.
41-
- **angle_address**: (*Optional*) KNX group address for moving the cover to the dedicated angle.
42-
- **angle_state_address**: (*Optional*) Separate KNX group address for requesting the current angle of cover.
43-
- **travelling_time_down**: (*Optional*) Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
44-
- **travelling_time_up**: (*Optional*) Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
45-
- **invert_position**: (*Optional*) Set this to true if your actuator report fully closed as 100%
46-
- **invert_angle**: (*Optional*) Set this to true if your actuator reports tilt fully closed as 100%
40+
- **move_short_address** (*Optional*): KNX group address for moving the cover short time up or down.
41+
- **position_address** (*Optional*): KNX group address for moving the cover to the dedicated position.
42+
- **position_state_address** (*Optional*): Separate KNX group address for requesting the current position of the cover.
43+
- **angle_address** (*Optional*): KNX group address for moving the cover to the dedicated angle.
44+
- **angle_state_address** (*Optional*): Separate KNX group address for requesting the current angle of cover.
45+
- **travelling_time_down** (*Optional*): Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
46+
- **travelling_time_up** (*Optional*): Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
47+
- **invert_position** (*Optional*): Set this to true if your actuator report fully closed as 100%.
48+
- **invert_angle** (*Optional*): Set this to true if your actuator reports tilt fully closed as 100%.
4749

0 commit comments

Comments
 (0)