Skip to content

Commit e0f90c5

Browse files
balloobballoob
committed
Merge remote-tracking branch 'origin/current' into rc
2 parents 5526af1 + efe4e28 commit e0f90c5

File tree

78 files changed

+709
-424
lines changed

Some content is hidden

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

78 files changed

+709
-424
lines changed

‎source/_addons/mosquitto.markdown

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Configuration variables:
4343

4444
### {% linkable_title Home Assistant configuration %}
4545

46-
To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own) add the following entry to the `configuration.yaml` file.
46+
To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), add the following entry to the `configuration.yaml` file.
4747

4848
```yaml
4949
# Example configuration.yaml entry
@@ -59,3 +59,20 @@ mqtt:
5959
username: YOUR_USERNAME
6060
password: YOUR_PASSWORD
6161
```
62+
63+
### {% linkable_title Listening simultaneously on SSL/TLS (8883) and insecure (1883) ports %}
64+
65+
1. Configure SSL/TLS as normal.
66+
2. Set `customize` flag to `true` in your configuration.
67+
3. Create a file in `/share/mosquitto` named `insecure.conf` with the following contents:
68+
69+
```text
70+
listener 1883
71+
protocol mqtt
72+
```
73+
74+
4. Restart MQTT
75+
76+
<p class='note warning'>
77+
It's recommened that you only open your firewall to the SSL/TLS port (8883) and only use the insecure port (1883) for local devices.
78+
</p>

‎source/_addons/nginx_proxy.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ footer: true
1111

1212
Setup an SSL proxy with NGINX and redirect port 80 to 443. Make sure you have generated a certificate before you start this add-on.
1313

14-
In the `http` section of the `configuration.yaml` file remove `ssl_certificate` and `ssl_key` and don't enter the port in the `base_url` to avoid a HTTP 502 error.
14+
In the `http` section of the `configuration.yaml` file remove `ssl_certificate` and `ssl_key` and don't enter the port in the `base_url` to avoid an HTTP 502 error.
1515

1616
```json
1717
{

‎source/_addons/samba.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Configuration variables:
3535
- **name** (*Optional*): Set netbios name of Hass.io device. Default is `hassio`.
3636
- **workgroup** (*Optional*): Set network workgroup name. Default is `WORKGROUP`.
3737
- **guest** (*Optional*): Allow login without a username or password. Default is `true`.
38-
- **map** (*Optional*): Control which folders will be exposed. `config` shares the Home Assistant configuration folder. `addons` shares the local custom repositiory. `share` shares a folder that can be accessed by add-ons and Home Assistant. `backup` shares access to snapshot files. `ssl` shares certificate storage. Be careful with the `ssl` option! Defaults are all set to `true`, except for `ssl`.
38+
- **map** (*Optional*): Control which folders will be exposed. `config` shares the Home Assistant configuration folder. `addons` shares the local custom repository. `share` shares a folder that can be accessed by add-ons and Home Assistant. `backup` shares access to snapshot files. `ssl` shares certificate storage. Be careful with the `ssl` option! Defaults are all set to `true`, except for `ssl`.
3939
- **username** (*Optional*): Username for logging in if guest login is not used.
4040
- **password** (*Optional*): Password for `username`. An empty password is not supported.
4141
- **interface** (*Optional*): Interface that will start the share. Normally this is `eth0` for ethernet wired connection and `wlan0` for wireless connection.

‎source/_components/amcrest.markdown

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,25 @@ ha_iot_class: "Local Polling"
1313
ha_release: 0.49
1414
---
1515

16-
The `amcrest` platform allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant.
16+
The `amcrest` camera platform allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant.
17+
18+
## {% linkable_title Configuration %}
1719

1820
To enable your camera in your installation, add the following to your `configuration.yaml` file:
1921

2022
```yaml
2123
# Example configuration.yaml entry
2224
amcrest:
23-
- host: IP_ADDRESS
24-
username: USERNAME
25-
password: PASSWORD
25+
- host: IP_ADDRESS_CAMERA_1
26+
username: YOUR_USERNAME
27+
password: YOUR_PASSWORD
2628
sensors:
2729
- motion_detector
2830
- sdcard
2931

30-
- host: IP_ADDRESS
31-
username: USERNAME
32-
password: PASSWORD
32+
- host: IP_ADDRESS_CAMERA_2
33+
username: YOUR_USERNAME
34+
password: YOUR_PASSWORD
3335
resolution: low
3436
stream_source: snapshot
3537
sensors:

‎source/_components/arlo.markdown

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,27 @@ ha_iot_class: "Cloud Polling"
1515

1616
The `arlo` implementation allows you to integrate your [Arlo](https://arlo.netgear.com/) devices in Home Assistant.
1717

18+
## {% linkable_title Configuration %}
19+
1820
To enable device linked in your [Arlo](https://arlo.netgear.com/) account, add the following to your `configuration.yaml` file:
1921

2022
```yaml
2123
# Example configuration.yaml entry
2224
arlo:
23-
username: you@example.com
24-
password: secret
25+
username: YOUR_USERNAME
26+
password: YOUR_PASSWORD
2527
```
2628
27-
Configuration variables:
28-
29-
- **username** (*Required*): The username for accessing your Arlo account.
30-
- **password** (*Required*): The password for accessing your Arlo account.
29+
{% configuration %}
30+
username:
31+
description: The username for accessing your Arlo account.
32+
required: true
33+
type: string
34+
password:
35+
description: The password for accessing your Arlo account.
36+
required: true
37+
type: string
38+
{% endconfiguration %}
3139
3240
It is recommended to create a dedicated user on Arlo website to be used within Home Assistant and then share your Arlo cameras.
3341

‎source/_components/august.markdown

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
1515

1616
The `august` component allows you to integrate your [August](http://august.com) devices in Home Assistant. Currently this component supports August Lock and Doorbell.
1717

18+
## {% linkable_title Configuration %}
19+
1820
You will need your August login information (username (either phone# or email), and password) to use this module.
1921

2022
To set it up, add the following to your `configuration.yaml` file:
@@ -24,27 +26,27 @@ To set it up, add the following to your `configuration.yaml` file:
2426
august:
2527
login_method: phone
2628
username: "+16041234567"
27-
password: secret
29+
password: YOUR_PASSWORD
2830
```
2931
3032
{% configuration %}
31-
login_method:
32-
description: Method to login to your August account, either "email" or "phone". A verification code will be sent to your email or phone during setup.
33-
required: true
34-
type: string
35-
username:
36-
description: The username for accessing your August account. This depends on your login_method, if login_method is email, this will be your email of the account. Otherwise, this will be your phone number.
37-
required: true
38-
type: string
39-
password:
40-
description: The password for accessing your August account.
41-
required: true
42-
type: string
43-
timeout:
44-
description: Timeout to wait for connections.
45-
required: false
46-
type: int
47-
default: 10
33+
login_method:
34+
description: Method to login to your August account, either "email" or "phone". A verification code will be sent to your email or phone during setup.
35+
required: true
36+
type: string
37+
username:
38+
description: The username for accessing your August account. This depends on your login_method, if login_method is email, this will be your email of the account. Otherwise, this will be your phone number.
39+
required: true
40+
type: string
41+
password:
42+
description: The password for accessing your August account.
43+
required: true
44+
type: string
45+
timeout:
46+
description: Timeout to wait for connections.
47+
required: false
48+
type: int
49+
default: 10
4850
{% endconfiguration %}
4951
5052
Once Home Assistant is started, a configurator will pop up asking you to enter verification code that is sent to your phone number or email.

‎source/_components/binary_sensor.hikvision.markdown

Lines changed: 37 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -15,58 +15,60 @@ ha_iot_class: "Local Push"
1515

1616
The Hikvision Binary Sensor is a platform that parses the event stream of a [Hikvision IP Camera or NVR](http://www.hikvision.com/) and presents the camera/nvr events to Home Assistant as binary sensors with either an "off" or "on" state.
1717

18-
The platform will automatically add all sensors to Home Assistant that are configured within the camera/nvr interface to "Notify the surveillance center" as a trigger. If you would like to hide a sensor type you can do so by either unchecking "Notify the surveillance center" in the camera configuration or by using the "ignored" customize option detailed below.
18+
The platform will automatically add all sensors to Home Assistant that are configured within the camera/nvr interface to "Notify the surveillance center" as a trigger. If you would like to hide a sensor type you can do so by either unchecking "Notify the surveillance center" in the camera configuration or by using the "ignored" customize option detailed below.
1919

2020
<p class='note'>
21-
In order for the sensors to work the hikvision user must have the 'Remote: Notify Surveillance Center / Trigger Alarm Output' permission which can be enabled from the user managment section of the web interace. Also the 'WEB Authentication' needs to be set to 'digest/basic' in the security / authentication section.
21+
In order for the sensors to work the hikvision user must have the 'Remote: Notify Surveillance Center/Trigger Alarm Output' permission which can be enabled from the user management section of the web interface. Also the 'WEB Authentication' needs to be set to 'digest/basic' in the security/authentication section.
2222
</p>
2323

2424
For example, if you configure a camera with the name "Front Porch" that has motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:
2525

26-
```
26+
```text
2727
binary_sensor.front_porch_motion
2828
binary_sensor.front_port_line_crossing
2929
```
3030

31-
When used with a NVR device the sensors will be appended with the channel number they represent. For example, if you configure an NVR with the name "Home" that supports 2 cameras with motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:
31+
When used with a NVR device the sensors will be appended with the channel number they represent. For example, if you configure an NVR with the name "Home" that supports 2 cameras with motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:
3232

33-
```
33+
```text
3434
binary_sensor.home_motion_1
3535
binary_sensor.home_motion_2
3636
binary_sensor.home_line_crossing_1
3737
binary_sensor.home_line_crossing_2
3838
```
3939

4040
This platform should work with all Hikvision cameras and nvrs, and has been confirmed to work with the following models:
41+
4142
- DS-2CD3132-I
4243
- DS-2CD2232-I5
4344
- DS-2CD2032-I
4445
- DS-2CD2042WD-I
4546
- DS-2CD2142FWD-I
4647

47-
To enable this sensor, the following lines are required in your `configuration.yaml`:
48+
To enable this sensor, the following lines are required in your `configuration.yaml` file:
4849

4950
```yaml
5051
binary_sensor:
51-
platform: hikvision
52-
host: IP_ADDRESS
53-
username: user
54-
password: pass
52+
- platform: hikvision
53+
host: IP_ADDRESS
54+
username: user
55+
password: pass
5556
```
5657
5758
Configuration options for a Hikvision Sensor:
5859
59-
- **name** (*Optional*): The name you'd like to give the camera in Home Assistant, defaults to name defined in the camera.
6060
- **host** (*Required*): The IP address of the camera you would like to connect to.
61-
- **port** (*Optional*): The port to connect to the camera on, defaults to 80.
62-
- **ssl** (*Optional*): True if you want to connect with https. Be sure to set the port also.
6361
- **username** (*Required*): The username to authenticate with.
6462
- **password** (*Required*): The password to authenticate with.
63+
- **name** (*Optional*): The name you'd like to give the camera in Home Assistant, defaults to name defined in the camera.
64+
- **port** (*Optional*): The port to connect to the camera on, defaults to 80.
65+
- **ssl** (*Optional*): True if you want to connect with https. Be sure to set the port also.
6566
- **customize** (*Optional*): This attribute contains sensor-specific override values. Only sensor name needs defined:
6667
- **ignored** (*Optional*): Ignore this sensor completely. It won't be shown in the Web Interface and no events are generated for it.
6768
- **delay** (*Optional*): Specify the delay to wait after a sensor event ends before notifying Home Assistant. This is useful to catch multiple quick trips in one window without the state toggling on and off. The default delay is 5 seconds.
6869
6970
Supported sensor/event types are:
71+
7072
- Motion
7173
- Line Crossing
7274
- Field Detection
@@ -84,37 +86,36 @@ Supported sensor/event types are:
8486
- Face Detection
8587
- Scene Change Detection
8688
87-
8889
Example of a configuration in your `configuration.yaml` that utilizes the customize options for a camera:
8990

9091
```yaml
9192
binary_sensor:
92-
platform: hikvision
93-
host: 192.168.X.X
94-
port: 80
95-
ssl: False
96-
username: user
97-
password: pass
98-
customize:
99-
motion:
100-
delay: 30
101-
line_crossing:
102-
ignored: True
93+
- platform: hikvision
94+
host: 192.168.X.X
95+
port: 80
96+
ssl: False
97+
username: user
98+
password: pass
99+
customize:
100+
motion:
101+
delay: 30
102+
line_crossing:
103+
ignored: True
103104
```
104105

105106
Example of a configuration in your `configuration.yaml` that utilizes the customize options for a nvr:
106107

107108
```yaml
108109
binary_sensor:
109-
platform: hikvision
110-
host: 192.168.X.X
111-
port: 80
112-
ssl: False
113-
username: user
114-
password: pass
115-
customize:
116-
motion_1:
117-
delay: 30
118-
field_detection_2:
119-
ignored: True
110+
- platform: hikvision
111+
host: 192.168.X.X
112+
port: 80
113+
ssl: False
114+
username: user
115+
password: pass
116+
customize:
117+
motion_1:
118+
delay: 30
119+
field_detection_2:
120+
ignored: True
120121
```

‎source/_components/binary_sensor.mqtt.markdown

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ The `mqtt` binary sensor platform uses an MQTT message payload to set the binary
1717

1818
The binary sensor state will be updated only after a new message is published on `state_topic` matching `payload_on` or `payload_off`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be `unknown`.
1919

20+
## {% linkable_title Configuration %}
21+
2022
The `mqtt` binary sensor platform optionally supports an `availability_topic` to receive online and offline messages (birth and LWT messages) from the MQTT device. During normal operation, if the MQTT cover device goes offline (i.e., publishes `payload_not_available` to `availability_topic`), Home Assistant will display the binary sensor as `unavailable`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant update after subscription and Home Assistant will display the correct availability state of the binary sensor when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the binary sensor as `unavailable` when Home Assistant starts up. If no `availability_topic` is defined, Home Assistant will consider the MQTT device to be available.
2123

2224
To use an MQTT binary sensor in your installation, add the following to your `configuration.yaml` file:
@@ -42,12 +44,12 @@ payload_on:
4244
description: The payload that represents the on state.
4345
required: false
4446
type: string
45-
default: ON
47+
default: "ON"
4648
payload_off:
4749
description: The payload that represents the off state.
4850
required: false
4951
type: string
50-
default: OFF
52+
default: "OFF"
5153
availability_topic:
5254
description: "The MQTT topic subscribed to receive birth and LWT messages from the MQTT device. If `availability_topic` is not defined, the binary sensor availability state will always be `available`. If `availability_topic` is defined, the binary sensor availability state will be `unavailable` by default."
5355
required: false

0 commit comments

Comments
 (0)