Skip to content

Commit 9bbbf21

Browse files
balloobballoob
committed
Merge remote-tracking branch 'origin/next' into rc
2 parents 8255351 + 8aaf154 commit 9bbbf21

38 files changed

+843
-96
lines changed

‎plugins/environment_variables.rb

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
module Jekyll
2+
class EnvironmentVariablesGenerator < Generator
3+
def generate(site)
4+
# https://www.netlify.com/docs/continuous-deployment/#build-environment-variables
5+
repo_url = ENV['REPOSITORY_URL'] || 'https://github.com/home-assistant/home-assistant.github.io'
6+
7+
# Rewrite urls if repo url is the ssh format.
8+
if repo_url.start_with? 'git@github.com:'
9+
repo_url = repo_url.sub 'git@github.com:', 'https://github.com/'
10+
end
11+
12+
# These values will be available as {{ site.NLY_REPOSITORY_URL }}
13+
site.config['NLY_REPOSITORY_URL'] = repo_url
14+
site.config['NLY_HEAD'] = ENV['HEAD'] || 'current'
15+
end
16+
end
17+
end

‎source/_components/amcrest.markdown

+6
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ amcrest:
2828
sensors:
2929
- motion_detector
3030
- sdcard
31+
switches:
32+
- motion_detection
33+
- motion_recording
3134

3235
- host: IP_ADDRESS_CAMERA_2
3336
username: YOUR_USERNAME
@@ -54,6 +57,9 @@ Configuration variables:
5457
- **motion_detector**: Return True/False when a motion is detected
5558
- **sdcard**: Return the SD card usage by reporting the total and used space
5659
- **ptz_preset**: Return the number of PTZ preset positions configured for the given camera
60+
- **switches** array (*Optional*): Switches to display in the frontend. By default, *none* of the switches are shown. The following switches can be monitored.
61+
- **motion_detection**: Enable/disable motion detection setting
62+
- **motion_recording**: Enable/disable recording on motion detection setting
5763

5864
**Note:** Amcrest cameras with newer firmware no longer have the ability to stream `high` definition video with MJPEG encoding. You may need to use `low` resolution stream or the `snapshot` stream source instead. If the quality seems too poor, lower the `Frame Rate (FPS)` and max out the `Bit Rate` settings in your camera's configuration manager. If you defined the *stream_source* to **mjpeg**, make sure your camera supports *Basic* HTTP authentication. Newer Amcrest firmware may not work, then **rtsp** is recommended instead.
5965

‎source/_components/binary_sensor.workday.markdown

+4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ ha_release: 0.41
1515

1616
The `workday` binary sensor indicates, whether the current day is a workday or not. It allows specifying, which days of the week counts as workdays and also uses the python module [holidays](https://pypi.python.org/pypi/holidays) to incorporate information about region-specific public holidays.
1717

18+
## {% linkable_title Configuration %}
19+
20+
Check the [country list](https://github.com/dr-prodigy/python-holidays#available-countries) for available province.
21+
1822
To enable the `workday` sensor in your installation, add the following to your `configuration.yaml` file:
1923

2024
```yaml

‎source/_components/bmw_connected_drive.markdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ bmw_connected_drive:
2525
name:
2626
username: USERNAME_BMW_CONNECTED_DRIVE
2727
password: PASSWORD_BMW_CONNECTED_DRIVE
28-
country: COUNTRY_BMW_CONNECTED_DRIVE
28+
region: one of "north_america", "china" , "rest_of_world"
2929
```
3030
3131
{% configuration %}
@@ -46,8 +46,8 @@ bmw_connected_drive:
4646
description: Your BMW Connected Drive password.
4747
required: true
4848
type: string
49-
country:
50-
description: "The country of your Connected Drive account. Please use the exact names for the country as listed on the [Connected Drive website](https://www.bmw-connecteddrive.com/)."
49+
region:
50+
description: "The region of your Connected Drive account. Please use of these values: `north_america`, `china`, `rest_of_world`"
5151
required: true
5252
type: string
5353
{% endconfiguration %}

‎source/_components/cover.gogogate2.markdown

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
layout: page
3+
title: "Gogogate2 Cover"
4+
description: "Instructions on how to integrate Gogogate2-Enabled garage door covers into Home Assistant."
5+
date: 2018-03-26 20:02
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: gogogate2.png
11+
ha_category: Cover
12+
ha_release: 0.67
13+
ha_iot_class: Local Polling
14+
---
15+
16+
The `gogogate2` cover platform lets you control Gogogate2-Enabled garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your Gogogate2 mobile app.
17+
18+
## {% linkable_title Configuration %}
19+
20+
To use your Gogogate2 cover in your installation, add the following to your `configuration.yaml` file:
21+
22+
```yaml
23+
# Example configuration.yml entry
24+
cover:
25+
- platform: gogogate2
26+
username: email@email.com
27+
password: password
28+
ip_address: 192.168.1.200
29+
```
30+
31+
{% configuration %}
32+
username:
33+
description: Your Gogogate2 account username.
34+
required: true
35+
type: string
36+
password:
37+
description: Your Gogogate2 account password.
38+
required: true
39+
type: string
40+
ip_address:
41+
description: The IP Address of your Gogogate2 device.
42+
required: true
43+
type: string
44+
name:
45+
description: Allows you to override the default name.
46+
default: gogogate2
47+
required: false
48+
type: string
49+
{% endconfiguration %}

‎source/_components/device_tracker.asuswrt.markdown

+40-9
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ The `asuswrt` platform offers presence detection by looking at connected devices
1919
This platform is **NOT** available for [Microsoft Windows installations](http://pexpect.readthedocs.io/en/stable/overview.html#pexpect-on-windows).
2020
</p>
2121

22+
### {% linkable_title Configuration %}
23+
2224
To use an ASUSWRT router in your installation, add the following to your `configuration.yaml` file:
2325

2426
```yaml
@@ -29,15 +31,44 @@ device_tracker:
2931
username: YOUR_ADMIN_USERNAME
3032
```
3133
32-
Configuration variables:
33-
34-
- **host** (*Required*): The IP address of your router, eg. `192.168.1.1`.
35-
- **username** (*Required*: The username of an user with administrative privileges, usually `admin`.
36-
- **password** (*Optional*): The password for your given admin account (use this if no SSH key is given).
37-
- **protocol** (*Optional*): The protocol (`ssh` or `telnet`) to use. Defaults to `ssh`.
38-
- **port** (*Optional*): SSH port to use. Defaults to `22`.
39-
- **mode** (*Optional*): The operating mode of the router (`router` or `ap`). Defaults to `router`.
40-
- **ssh_key** (*Optional*): The path to your SSH private key file associated with your given admin account (instead of password).
34+
{% configuration %}
35+
host:
36+
description: "The IP address of your router, eg. `192.168.1.1`."
37+
required: true
38+
type: string
39+
username:
40+
description: "The username of an user with administrative privileges, usually `admin`."
41+
required: true
42+
type: string
43+
password:
44+
description: "The password for your given admin account (use this if no SSH key is given)."
45+
required: false
46+
type: string
47+
protocol:
48+
description: "The protocol (`ssh` or `telnet`) to use."
49+
required: false
50+
type: string
51+
default: ssh
52+
port:
53+
description: SSH port to use.
54+
required: false
55+
type: int
56+
default: 22
57+
mode:
58+
description: "The operating mode of the router (`router` or `ap`)."
59+
required: false
60+
type: string
61+
default: router
62+
ssh_key:
63+
description: The path to your SSH private key file associated with your given admin account (instead of password).
64+
required: false
65+
type: string
66+
require_ip:
67+
description: If the router is in access point mode.
68+
required: false
69+
type: boolean
70+
default: true
71+
{% endconfiguration %}
4172

4273
<p class='note warning'>
4374
You need to [enable telnet](https://www.asus.com/support/faq/1005449/) on your router if you choose to use `protocol: telnet`.

‎source/_components/device_tracker.bluetooth_tracker.markdown

+8
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,14 @@ device_tracker:
2727
- platform: bluetooth_tracker
2828
```
2929
30+
{% configuration %}
31+
request_rssi:
32+
description: Performs a request for the "Received signal strength indication" (RSSI) of each tracked device
33+
required: false
34+
type: boolean
35+
default: False
36+
{% endconfiguration %}
37+
3038
In some cases it can be that your device is not discovered. In that case let your phone scan for Bluetooth devices while you restart Home Assistant. Just hit `Scan` on your phone all the time until Home Assistant is fully restarted and the device should appear in `known_devices.yaml`.
3139

3240
For additional configuration variables check the [Device tracker page](/components/device_tracker/).

‎source/_components/device_tracker.google_maps.markdown

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
layout: page
3+
title: "Google Maps Location Sharing"
4+
description: "Instructions how to use Google Maps Location Sharing to track devices in Home Assistant."
5+
date: 2017-02-12 10:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: google_maps.png
11+
ha_release: 0.67
12+
ha_category: Presence Detection
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
The `google_maps` platform allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing).
17+
18+
You first need to create an additional Google account and share your location with that account. This platform will use that account to fetch the location of your device(s). You have to setup sharing through the Google Maps app on your mobile phone. You can find more information [here](https://support.google.com/accounts?p=location_sharing).
19+
20+
This platform will create a file named `google_maps_location_sharing.conf` where it caches your login session.
21+
22+
<p class='note warning'>
23+
Since this platform is using an official API with the help of [locationsharinglib](https://github.com/costastf/locationsharinglib), Google seems to block access to your data the first time you've logged in with this component.
24+
This issue can be fixed by logging in with your new account and approving your login on the [Device Activity](https://myaccount.google.com/device-activity) page.
25+
</p>
26+
27+
To integrate Google Maps Location Sharing in Home Assistant, add the following section to your `configuration.yaml` file:
28+
29+
```yaml
30+
# Example configuration.yaml entry
31+
device_tracker:
32+
platform: google_maps
33+
username: example@gmail.com
34+
password: password
35+
```
36+
37+
{% configuration %}
38+
username:
39+
description: The email address for the Google account that has access to your shared location.
40+
required: true
41+
type: string
42+
password:
43+
description: The password for your given username.
44+
required: true
45+
type: string
46+
{% endconfiguration %}

‎source/_components/device_tracker.xiaomi_miio.markdown

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
layout: page
3+
title: "Xiaomi Mi WiFi Repeater 2"
4+
description: "Instructions how to integrate your Xiaomi Mi WiFi Repeater 2 within Home Assistant."
5+
date: 2018-04-01 21:06
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: xiaomi.png
11+
ha_category: Sensor
12+
ha_version: 0.67
13+
ha_iot_class: "Local Polling"
14+
---
15+
16+
The `xiaomi_miio` device tracker platform is observing your Xiaomi Mi WiFi Repeater 2 and reporting all associated WiFi clients.
17+
18+
Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token.
19+
20+
To add a Xiaomi Mi Air Quality Monitor to your installation, add the following to your `configuration.yaml` file:
21+
22+
```yaml
23+
device_tracker:
24+
- platform: xiaomi_miio
25+
host: 192.168.130.73
26+
token: YOUR_TOKEN
27+
```
28+
29+
{% configuration %}
30+
host:
31+
description: The IP address of your miio device.
32+
required: true
33+
type: string
34+
token:
35+
description: The API token of your miio device.
36+
required: true
37+
type: string
38+
{% endconfiguration %}

‎source/_components/doorbird.markdown

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Configuration variables:
3131
- **username** (*Required*): The username of a non-administrator user account on the device.
3232
- **password** (*Required*): The password for the user specified.
3333
- **doorbell_events** (*Optional*): Setting this to `true` this will register a callback URL with the device so that events can be published to the event bus when the doorbell rings.
34+
- **hass_url_override** (*Optional*): If your DoorBird cannot connect to the machine running Home Assistant because you are using dynamic DNS or some other HTTP configuration, specify the LAN IP of the machine here to force a LAN connection.
3435

3536
<p class="note warning">
3637
Enabling `doorbell_events` will delete all other registered push notification services with the device every time Home Assistant starts. This will not affect notifications delivered by the DoorBird mobile app.

0 commit comments

Comments
 (0)