Skip to content

Commit 9faf94b

Browse files
fabafffabaff
committed
Merge branch 'current' into next
2 parents 6158057 + 9e6fe6c commit 9faf94b

34 files changed

+415
-146
lines changed

‎.github/stale.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Number of days of inactivity before an issue becomes stale
2+
daysUntilStale: 60
3+
# Number of days of inactivity before a stale issue is closed
4+
daysUntilClose: 7
5+
# Issues with these labels will never be considered stale
6+
#exemptLabels:
7+
# - pinned
8+
# - security
9+
# Label to use when marking an issue as stale
10+
staleLabel: Stale
11+
# Comment to post when marking an issue as stale. Set to `false` to disable
12+
markComment: >
13+
This issue has been automatically marked as stale because it has not had
14+
recent activity. It will be closed if no further activity occurs. Thank you
15+
for your contributions.
16+
# Comment to post when closing a stale issue. Set to `false` to disable
17+
closeComment: false

‎_config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,11 +140,11 @@ social:
140140
# Home Assistant release details
141141
current_major_version: 0
142142
current_minor_version: 57
143-
current_patch_version: 0
144-
date_released: 2017-11-04
143+
current_patch_version: 2
144+
date_released: 2017-11-05
145145

146146
# Either # or the anchor link to latest release notes in the blog post.
147147
# Must be prefixed with a # and have double quotes around it.
148148
# Major release:
149-
patch_version_notes: ""
149+
patch_version_notes: "#release-0572--november-5"
150150
# Minor release (Example #release-0431---april-25):

‎sass/custom/_paulus.scss

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -394,15 +394,15 @@ p.note {
394394

395395
.aside-module {
396396
.section {
397-
margin-bottom: 16px;
397+
margin-bottom: 10px;
398398
}
399399

400400
.brand-logo-container {
401401
text-align: center;
402-
height: 97px;
402+
height: 87px;
403403

404404
img {
405-
max-height: 97px;
405+
max-height: 67px;
406406
}
407407
}
408408
}

‎source/_components/arduino.markdown

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,12 @@ arduino:
3030
port: /dev/ttyACM0
3131
```
3232
33-
Configuration variables:
34-
35-
- **port** (*Required*): The port where your board is connected to your Home Assistant host. If you are using an original Arduino, the port will be named `ttyACM*` otherwise `ttyUSB*`.
33+
{% configuration %}
34+
port:
35+
description: The port where your board is connected to your Home Assistant host. If you are using an original Arduino, the port will be named `ttyACM*` otherwise `ttyUSB*`.
36+
required: true
37+
type: string
38+
{% endconfiguration %}
3639

3740
The exact number can be determined with the command shown below.
3841

‎source/_components/binary_sensor.template.markdown

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -39,31 +39,36 @@ binary_sensor:
3939
required: true
4040
type: map
4141
keys:
42-
friendly_name:
43-
description: Name to use in the frontend.
44-
required: false
45-
type: string
46-
entity_id:
47-
description: Add a list of entity IDs so the sensor only reacts to state changes of these entities. This will reduce the number of times the sensor will try to update its state.
48-
required: false
49-
type: string, list
50-
device_class:
51-
description: The type/class of the sensor to set the icon in the frontend.
52-
required: false
53-
type: device_class
54-
default: None
55-
value_template:
56-
description: Defines a template to set the state of the sensor.
42+
sensor_name:
43+
description: The slug of the sensor.
5744
required: true
58-
type: template
59-
delay_on:
60-
description: The amount of time the template state must be ***met*** before this sensor will switch to `on`.
61-
required: false
62-
type: time
63-
delay_off:
64-
description: The amount of time the template state must be ***not met*** before this sensor will switch to `off`.
65-
required: false
66-
type: time
45+
type: map
46+
keys:
47+
friendly_name:
48+
description: Name to use in the frontend.
49+
required: false
50+
type: string
51+
entity_id:
52+
description: Add a list of entity IDs so the sensor only reacts to state changes of these entities. This will reduce the number of times the sensor will try to update its state.
53+
required: false
54+
type: string, list
55+
device_class:
56+
description: The type/class of the sensor to set the icon in the frontend.
57+
required: false
58+
type: device_class
59+
default: None
60+
value_template:
61+
description: Defines a template to set the state of the sensor.
62+
required: true
63+
type: template
64+
delay_on:
65+
description: The amount of time the template state must be ***met*** before this sensor will switch to `on`.
66+
required: false
67+
type: time
68+
delay_off:
69+
description: The amount of time the template state must be ***not met*** before this sensor will switch to `off`.
70+
required: false
71+
type: time
6772
{% endconfiguration %}
6873

6974
## {% linkable_title Considerations %}

‎source/_components/camera.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ Take a snapshot from a camera.
4343
| `entity_id` | no | Name(s) of entities to create a snopshot from, e.g., `camera.living_room_camera`. |
4444
| `filename ` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}`{% endraw %}. |
4545

46+
The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
47+
4648
### {% linkable_title Test if it works %}
4749

4850
A simple way to test if you have set up your `camera` platform correctly, is to use <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools**. Choose your service from the dropdown menu **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**.

‎source/_components/camera.rpi_camera.markdown

Lines changed: 47 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,53 @@ camera:
2424
- platform: rpi_camera
2525
```
2626
27-
Configuration variables:
28-
29-
- **name** (*Optional*): Name of the camera
30-
- **image_width** (*Optional*): Set the image width (default: 640)
31-
- **image_height** (*Optional*): Set the image height (default: 480)
32-
- **image_quality** (*Optional*): Set the image quality (from 0 to 100, default: 7)
33-
- **image_rotation** (*Optional*): Set image rotation (0-359, default: 0)
34-
- **horizontal_flip** (*Optional*): Set horizontal flip (0 to disable, 1 to enable, default: 0)
35-
- **vertical_flip** (*Optional*): Set vertical flip (0 to disable, 1 to enable, default: 0)
36-
- **timelapse** (*Optional*): Takes a picture every ms (default: 1000)
37-
- **file_path** (*Optional*): Save the picture in a custom file path (default: camera components folder)
27+
{% configuration %}
28+
image_width:
29+
description: Set the image width.
30+
required: false
31+
default: 640
32+
type: int
33+
name:
34+
description: Name of the camera.
35+
required: false
36+
default: Raspberry Pi Camera
37+
type: string
38+
image_height:
39+
description: Set the image height.
40+
required: false
41+
default: 480
42+
type: int
43+
image_quality:
44+
description: Set the image quality (from 0 to 100).
45+
required: false
46+
default: 7
47+
type: int
48+
image_rotation:
49+
description: Set image rotation (0-359).
50+
required: false
51+
default: 0
52+
type: int
53+
horizontal_flip:
54+
description: Set horizontal flip (0 to disable, 1 to enable).
55+
required: false
56+
default: 0
57+
type: int
58+
vertical_flip:
59+
description: Set vertical flip (0 to disable, 1 to enable).
60+
required: false
61+
default: 0
62+
type: int
63+
timelapse:
64+
description: Takes a picture every millisecond.
65+
required: false
66+
default: 1000
67+
type: int
68+
file_path:
69+
description: Save the picture in a custom file path.
70+
required: false
71+
default: The camera components folder.
72+
type: string
73+
{% endconfiguration %}
3874
3975
The given **file_path** must be an existing file because the camera platform setup make a writeable check on it.
4076

‎source/_components/climate.ephember.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sharing: true
99
footer: true
1010
logo: ephcontrolsember.png
1111
ha_category: Climate
12-
ha_release: "0.55"
12+
ha_release: 0.57
1313
ha_iot_class: "Local Polling"
1414
---
1515

‎source/_components/input_number.markdown

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,13 +145,12 @@ input_number:
145145
icon: mdi:target
146146
147147
# Automation.
148-
# This automation script runs when a value is received via MQTT on retained topic: setTemperature
149-
# It sets the value slider on the GUI. This slides also had its own automation when the value is changed.
148+
# This automation script runs when a value is received via MQTT on retained topic: setTemperature
149+
# It sets the value slider on the GUI. This slides also had its own automation when the value is changed.
150150
- alias: Set temp slider
151151
trigger:
152152
platform: mqtt
153153
topic: "setTemperature"
154-
# entity_id: input_number.target_temp
155154
action:
156155
service: input_number.set_value
157156
data_template:

‎source/_components/media_player.vizio.markdown

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,4 +97,7 @@ Vizio SmartCast service is accessible through HTTPS with self-signed certificate
9797
`InsecureRequestWarning: Unverified HTTPS request is being made. Adding certificate verification is strongly advised.`
9898

9999
You can adjust the log level for `media_player` components with the [logger](https://home-assistant.io/components/logger/) component, or if you need to keep a low log level for `media_player` you could proxy calls to your TV through an NGINX reverse proxy.
100+
101+
If you want to only ignore only this specific [python urllib3 SSL warning](https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings), you will need to run Home Assistant with the python flag `-W` or the environment variable `PYTHONWARNINGS` set to:
102+
`ignore:Unverified HTTPS request is being made`
100103
</p>

‎source/_components/notify.slack.markdown

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,10 @@ The following attributes can be placed `data` for extended functionality.
5252
| `username` | yes | Username if the url requires authentication. Is placed inside `file`.
5353
| `password` | yes | Password if the url requires authentication. Is placed inside `file`.
5454
| `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing HTTP-BASIC-Authentication is used. Is placed inside `file`.
55+
| `attachments` | yes | Array of [Slack attachments](https://api.slack.com/docs/message-attachments). See [the attachment documentation](https://api.slack.com/docs/message-attachments) for how to format. *NOTE*: if using `attachments`, they are shown **in addition** to `message`
56+
57+
Example for posting file from URL:
5558

56-
Example for posting file from URL
5759
```json
5860
{
5961
"message":"Message that will be added as a comment to the file.",
@@ -68,7 +70,9 @@ Example for posting file from URL
6870
}
6971
}
7072
```
71-
Example for posting file from local path
73+
74+
Example for posting file from local path:
75+
7276
```json
7377
{
7478
"message":"Message that will be added as a comment to the file.",
@@ -82,5 +86,23 @@ Example for posting file from local path
8286
```
8387
Please note that `path` is validated against the `whitelist_external_dirs` in the `configuration.yaml`.
8488

89+
Example for posting formatted attachment:
90+
91+
```json
92+
{
93+
"message": "",
94+
"data": {
95+
"attachments": [
96+
{
97+
"title": "WHAT A HORRIBLE NIGHT TO HAVE A CURSE.",
98+
"image_url": "http://i.imgur.com/JEExnsI.gif"
99+
}
100+
]
101+
}
102+
}
103+
```
104+
105+
Please note that both `message` is a required key, but is always shown, so use an empty (`""`) string for `message` if you don't want the extra text.
106+
85107
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
86108

‎source/_components/remember_the_milk.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To be able to use this component, you need a Remember The Milk account and you n
2626
# Example configuration.yaml entry
2727

2828
remember_the_milk:
29-
your_rtm_account:
29+
- name: your_rtm_account
3030
api_key: <your secret api key goes here>
3131
shared_secret: <your secret shared secret goes here>
3232

@@ -35,7 +35,7 @@ remember_the_milk:
3535
Configuration variables:
3636

3737
{% configuration %}
38-
account_name:
38+
name:
3939
description: Name of the RTM account, as you can have serveral accounts in RTM. The name must be unique.
4040
required: true
4141
type: string

‎source/_components/sensor.arduino.markdown

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,23 @@ sensor:
2727
name: Door switch
2828
0:
2929
name: Brightness
30-
3130
```
3231
33-
Configuration variables:
34-
35-
- **pins** array (*Required*): Array of pins to use.
36-
- **[number]** (*Required*): The pin number that corresponds with the pin numbering schema of your board.
37-
- **name** (*Optional*): Name that will be used in the frontend for the pin.
32+
{% configuration %}
33+
pins:
34+
description: List of pins to use.
35+
required: true
36+
type: map
37+
keys:
38+
pin_number:
39+
description: The pin number that corresponds with the pin numbering schema of your board.
40+
required: true
41+
type: map
42+
keys:
43+
name:
44+
default: Name that will be used in the frontend for the pin.
45+
type: string
46+
{% endconfiguration %}
3847
3948
The 6 analog pins of an Arduino UNO are numbered from A0 to A5.
4049

‎source/_components/sensor.irish_rail_transport.markdown

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

1616

‎source/_components/sensor.london_air.markdown

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ sensor:
3636
- Enfield
3737
- Greenwich
3838
- Hackney
39-
- Hammersmith and Fulham
4039
- Haringey
4140
- Harrow
4241
- Havering

‎source/_components/sensor.luftdaten.markdown

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ sensor:
4646
default: Luftdaten Sensor
4747
type: string
4848
resource:
49-
description: The URL of the API endpoint. Usually this has not to be changed.
49+
description: The URL of the API endpoint. Usually this has not to be changed.
5050
required: false
5151
default: https://api.luftdaten.info/v1/sensor/
5252
type: string
@@ -62,19 +62,11 @@ sensor:
6262
keys:
6363
P1:
6464
description: Show the particle sensors (particles 10 microns and below).
65-
required: false
66-
type: string
6765
P2:
6866
description: Show the particle sensors (particles 2.5 microns and below).
69-
required: false
70-
type: string
7167
temperature:
7268
description: Display the temperature from a weather sensor.
73-
required: false
74-
type: string
7569
humidity:
7670
description: Display the humidity from a weather sensor.
77-
required: false
78-
type: string
7971
{% endconfiguration %}
8072

0 commit comments

Comments
 (0)