Skip to content

Commit c1148f8

Browse files
balloobballoob
committed
Merge remote-tracking branch 'origin/current' into next
2 parents 2ad0aa0 + 3285374 commit c1148f8

File tree

89 files changed

+1460
-186
lines changed

Some content is hidden

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

89 files changed

+1460
-186
lines changed

‎README.markdown

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,3 @@ In order to make the preview available on [http://127.0.0.1:4000](http://127.0.0
1313
```bash
1414
$ rake preview
1515
```
16-
17-
### Setup on Fedora and CentOS
18-
On Fedora 22 and later or CentOS 7.1.1503, Ruby is not available by default. Please take the notes here as a little guide for the Ruby installation process.
19-
20-
```bash
21-
$ curl -sSL https://rvm.io/mpapis.asc | gpg2 --import -
22-
$ curl -L get.rvm.io | bash -s stable
23-
$ source ~/.profile
24-
$ rvm requirements
25-
$ rvm install ruby-2.2.3
26-
$ rvm use ruby-2.2.3 --default
27-
$ ruby -v
28-
```
29-
30-
The last command will give you something like this: `ruby 2.2.3p173 (2015-08-18 revision 51636) [x86_64-linux]`. Then install `bundler`.
31-
32-
```bash
33-
$ gem install bundler
34-
```
35-
36-
Now you can follow the [setup instructions](https://home-assistant.io/developers/website/).

‎_config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ collections:
7272
output: true
7373
cookbook:
7474
output: true
75+
ecosystem:
76+
output: true
77+
details:
78+
output: true
7579
topics:
7680
output: true
7781

‎source/_components/alexa.markdown

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -337,19 +337,24 @@ Please refer to the [Amazon documentation][flash-briefing-api-docs] for more inf
337337
### {% linkable_title Configuring your Flash Briefing skill %}
338338

339339
- Log in to [Amazon developer console][amazon-dev-console]
340-
- Click the Alexa button at the top of the console
340+
- Click the Alexa navigation tab at the top of the console
341+
- Click on the "Get Started >" button under "Alexa Skills Kit"
341342
- Click the yellow "Add a new skill" button in the top right
342343
- Skill Information
343-
- For Skill Type select Flash Briefing Skill API
344+
- For Skill Type select "Flash Briefing Skill API"
344345
- You can enter whatever name you want
345-
- Hit next
346+
- Hit "Next"
346347
- Interaction Model
347348
- Nothing to do here
348349
- Configuration
349350
- Add new feed
350-
- For URL, enter `https://YOUR_HOST/api/alexa/flash_briefings/BRIEFING_ID?api_password=YOUR_API_PASSWORD` where `BRIEFING_ID` is the key you entered in your configuration (such as `whoishome` in the above example)
351+
- For URL, enter `https://YOUR_HOST/api/alexa/flash_briefings/BRIEFING_ID?api_password=YOUR_API_PASSWORD` where `BRIEFING_ID` is the key you entered in your configuration (such as `whoishome` in the above example). **NOTE:** Do not use a non-standard http or https port, AWS will not connect to it.
351352
- You can use this [specially sized Home Assistant logo][large-icon] as the Feed Icon
352353
- All other settings are up to you
354+
- Hit "Next"
355+
- Test
356+
- Having passed all validations to reach this screen you can now click on "< Back to All Skills" as your flash briefing is now available as in "Development" service.
357+
- To invoke your flash briefing, open the Alexa app on your phone or go to [Alexa|http://alexa.amazon.com/], open the "Skills" configuration section, select "Your Skills", scroll to the bottom, tap on the Flash Briefing Skill you just created, enable it, then manage Flash Briefing and adjust ordering as necessary. Finally ask your Echo for your "news","flash briefing", or "briefing".
353358

354359
[amazon-dev-console]: https://developer.amazon.com
355360
[flash-briefing-api]: https://developer.amazon.com/alexa-skills-kit/flash-briefing

‎source/_components/binary_sensor.concord232.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ comments: false
88
sharing: true
99
footer: true
1010
logo: interlogix.png
11-
ha_category: Binary sensor
11+
ha_category: Binary Sensor
1212
ha_release: 0.31
1313
---
1414

‎source/_components/binary_sensor.rest.markdown

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,13 @@ Configuration variables:
5656
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract the value.
5757
- **payload** (*Optional*): The payload to send with a POST request. Usualy formed as a dictionary.
5858
- **verify_ssl** (*Optional*): Verify the certification of the endpoint. Default to True.
59+
- **authentication** (*Optional*): Type of the HTTP authentication. `basic` or `digest`.
60+
- **username** (*Optional*): The username for accessing the REST endpoint.
61+
- **password** (*Optional*): The password for accessing the REST endpoint.
62+
- **headers** (*Optional*): The headers for the requests.
5963

6064
<p class='note warning'>
61-
Make sure that the URL matches exactly your endpoint or resource.
65+
Make sure that the URL exactly matches your endpoint or resource.
6266
</p>
6367

6468

@@ -68,7 +72,7 @@ In this section you find some real life examples of how to use this sensor.
6872

6973
### {% linkable_title aREST sensor %}
7074

71-
Instead of using an [aREST](/components/binary_sensor.arest/) binary sensor could the value of a device supporting aREST directly retrieved with a REST binary sensor.
75+
Instead of using an [aREST](/components/binary_sensor.arest/) binary sensor, you could retrieve the value of a device supporting aREST directly with a REST binary sensor.
7276

7377
```yaml
7478
binary_sensor:
@@ -77,6 +81,31 @@ binary_sensor:
7781
method: GET
7882
name: Light
7983
sensor_class: light
80-
value_template: '{{ value_json.return_value }}'
84+
value_template: {% raw %}'{{ value_json.return_value }}'{% endraw %}
8185
```
8286

87+
### {% linkable_title Accessing an HTTP authentication protected endpoint %}
88+
89+
The REST sensor supports HTTP authentication and customized headers.
90+
91+
```yaml
92+
binary_sensor:
93+
- platform: rest
94+
resource: http://IP_ADDRESS:5000/binary_sensor
95+
username: ha1
96+
password: test1
97+
authentication: basic
98+
headers:
99+
User-Agent: Home Assistant
100+
Content-Type: application/json
101+
```
102+
103+
The headers will contain all relevant details. This will also give you the ability to access endpoints that are protected by tokens.
104+
105+
```bash
106+
Content-Length: 1024
107+
Host: IP_ADDRESS1:5000
108+
Authorization: Basic aGExOnRlc3Qx
109+
Accept-Encoding: identity
110+
Content-Type: application/json
111+
User-Agent: Home Assistant

‎source/_components/device_tracker.icloud.markdown

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,14 @@ device_tracker:
2525
- platform: icloud
2626
username: USERNAME
2727
password: PASSWORD
28+
account_name: accountname
2829
```
2930
3031
Configuration variables:
3132
3233
- **username** (*Required*): The username for the iCloud account.
3334
- **password** (*Required*): The password for your given username.
35+
- **account_name** (*Optional*): The friendly name for the account_name. If this isn't given, it will use the account_name of the username (so the part before the `@` in the email address).
3436

3537
<p class='note warning'>
3638
This may cause battery drainage as it wakes up your device to get the current location.
@@ -40,7 +42,12 @@ This may cause battery drainage as it wakes up your device to get the current lo
4042
You may receive an email from Apple stating that someone has logged into your account.
4143
</p>
4244

43-
<p class='note warning'>
44-
If you have two-factor authentication enabled on your iCloud account you will not be able to use this presence detection in HA, even with an app-specific password.
45-
</p>
45+
To disable the drainage of the battery, a dynamic interval is being used for each individual device instead of a fixed interval for all devices linked to one account. The dynamic interval is based on the current zone of a device, the distance towards home and the battery level of the device.
46+
47+
2 Factor Authentication is enabled for iCloud. The component will ask which device you want to use as Trusted Device and then you can enter the code that has been sent to that device. The duration of this authentication is determined by Apple, but is now at 2 months, so you will only need to verify your account each two months, even after restarting Home Assistant.
4648

49+
4 services are available for this component:
50+
- **icloud_update**: This service can be used to ask for an update of a certain iDevice. The `account_name` and `device_name` are optional.
51+
- **icloud_lost_iphone**: This service will play the Lost iPhone sound on a certain iDevice. The `account_name` and `device_name` are optional.
52+
- **icloud_set_interval**: This service will change the dynamic interval of an iDevice. The `account_name` and `device_name` are optional. If `interval` is used in the service_data, the iDevice will be updated with that new interval. That interval will be fixed until the iDevice changes zone or if this service is called again. If `interval` isn't used in the service_data, the interval for that iDevice will revert back to it's default dynamic interval based on it's current zone, it's distance towards home and it's battery level.
53+
- **icloud_reset_account**: This service can be used to reset an iCloud account. This is helpful when not all devices are being found by the component or if you have added a new iDevice to your account. The `account_name` is optional.

‎source/_components/device_tracker.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ devicename:
7373
| `name` | Host name or "Unnamed Device" | The friendly name of the device |
7474
| `mac` | None | The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP |
7575
| `icon` | None | A name of an MDI Icon. |
76-
| `picture` | None | A picture that you can use to easily identify the person or device, if provided, will override 'icon' |
76+
| `picture` | None | A picture that you can use to easily identify the person or device. You can also save the image file in a folder "www" in the same location (can be obtained from developer tools) where you have your configuration.yaml file and just use `picture: /local/favicon-192x192.png`. |
7777
| `gravatar` | None | An email address for the device's owner. If provided, it will override `picture` |
7878
| `track` | False | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update |
7979
| `hide_if_away` | False | If `yes`/`on`/`true` then the device will be hidden if it is not at home |

‎source/_components/device_tracker.tomato.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ ha_release: pre 0.7
1515

1616
The `tomato` platform requires an extra config variable called `http_id`. The value can be obtained by logging in to the Tomato admin interface and search for `http_id` in the page source code.
1717

18+
Because of a limitation in Tomato's API, this platform will only track wireless devices. If tracking wired devices like a Philips Hue Hub is necessary, it is possible to use another platform like [NMAP](/components/device_tracker.nmap_tracker/).
19+
1820
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
1921

2022
```yaml

‎source/_components/discovery.markdown

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,13 @@ Home Assistant can discover and automatically configure zeroconf/mDNS and uPnP d
1818
* Belkin WeMo switches
1919
* Philips Hue
2020
* Netgear routers
21-
* Plex Media Server
21+
* Plex media server
22+
* Panasonic Viera
23+
* Roku media player
24+
* Sono Speaker
25+
* Yamaha media player
26+
* Logitech media server (Squeezebox)
27+
* DirecTV
2228

2329
It will be able to add Google Chromecasts and Belkin WeMo switches automatically, for Philips Hue it will require some configuration from the user.
2430

@@ -30,8 +36,8 @@ discovery:
3036
```
3137
3238
<p class='note'>
33-
The home-assistant server must be on the same network as the devices for uPnP discovery to work.
34-
If running home-assistant in a docker container use switch `--net=host` to put it on the host's network.
39+
Home Assistant must be on the same network as the devices for uPnP discovery to work.
40+
If running Home Assistant in a Docker container use switch `--net=host` to put it on the host's network.
3541
</p>
3642

3743
If you are developing a new platform, please read [how to make your platform discoverable]({{site_root}}/developers/add_new_platform/#discovery).

‎source/_components/emulated_hue.markdown

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,13 @@ The following are attributes that can be applied in the `customize` section:
8484
- **emulated_hue** (*Optional*): Whether or not the entity should be exposed by the emulated Hue bridge. The default value for this attribute is controlled by the `expose_by_default` option.
8585
- **emulated_hue_name** (*Optional*): The name that the emulated Hue will use. The default for this is the entity's friendly name.
8686

87+
### {% linkable_title Troubleshooting %}
88+
89+
You can verify that the `emulated_hue` component has been loaded and is responding by pointing a local browser to the following URL:
90+
http://`<HA IP Address>`:8300/description.xml - This URL should return a descriptor file in the form of an XML file.
91+
http://`<HA IP Address>`:8300/api/pi/lights - This will return a list of devices, lights, scenes, groups, etc.. that `emulated_hue` is exposing to Alexa.
92+
93+
8794
### {% linkable_title License %}
8895

8996
Much of this code is based on work done by Bruce Locke on his [ha-local-echo](https://github.com/blocke/ha-local-echo) project, originally released under the MIT License. The license is located [here](https://github.com/blocke/ha-local-echo/blob/b9bf5dcaae6d8e305e2283179ffba64bde9ed29e/LICENSE).

‎source/_components/fan.mqtt.markdown

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,27 @@ fan:
3232
3333
Configuration variables:
3434
35-
- **name** (*Optional*): The name of the lock. Default is 'MQTT Lock'.
35+
- **command_topic** (*Required*): The MQTT topic to publish commands to change the fan state.
3636
- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
37-
- **command_topic** (*Required*): The MQTT topic to publish commands to change the lock state.
37+
- **name** (*Optional*): The name of the fan. Default is 'MQTT Fan'.
3838
- **payload_on** (*Optional*): The payload that represents the running state. Default is "ON".
3939
- **payload_off** (*Optional*): The payload that represents the stop state. Default is "OFF".
4040
- **optimistic** (*Optional*): Flag that defines if lock works in optimistic mode. Default is `true` if no state topic defined, else `false`.
4141
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
4242
- **retain** (*Optional*): If the published message should have the retain flag on or not.
43-
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
43+
- **state_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the state.
44+
- **speed_state_topic** (*Optional*): The MQTT topic subscribed to receive speed updates.
45+
- **speed_command_topic** (*Optional*): The MQTT topic to publish commands to change the fan speed.
46+
- **speed_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the speed.
47+
- **oscillation_state_topic** (*Optional*): The MQTT topic subscribed to receive oscillation updates.
48+
- **oscillation_command_topic** (*Optional*): The MQTT topic to publish commands to change the fan oscillation.
49+
- **oscillation_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the oscillation.
50+
- **payload_oscillation_on** (*Optional*): The payload that represents the oscillation state. Default is "ON".
51+
- **payload_oscillation_off** (*Optional*): The payload that represents the oscillation state. Default is "OFF".
52+
- **payload_low_speed** (*Optional*): The payload that represents the low speed state. Default is "low".
53+
- **payload_medium_speed** (*Optional*): The payload that represents the low speed state. Default is "med".
54+
- **payload_high_speed** (*Optional*): The payload that represents the low speed state. Default is "high".
55+
- **speeds** array (*Optional*): Valid entries for the list are `off`, `low`, `med`, and `high`.
4456

4557
<p class='note warning'>
4658
Make sure that your topic match exact. `some-topic/` and `some-topic` are different topics.

‎source/_components/ifttt.markdown

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,11 @@ automation:
7171

7272
To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web. This can be achieved by forwarding port 8123 from your router to the device running Home Assistant. If your ISP is giving you a new IP address from time to time, consider using [DuckDNS][duck-dns].
7373

74+
In the URL field, you can then put an [API URL][rest-api]. You probably want to use a POST action, so select `POST` as method. After your request line, you need to add your Home Assistant password, which you defined in the [http section of your config][http-configuration], in the form off `?api_password=<your_password>`. For the message body, refer to the API page linked above.
75+
7476
[duck-dns]: https://duckdns.org
77+
[rest-api]: https://home-assistant.io/developers/rest_api/
78+
[http-configuration]: https://home-assistant.io/getting-started/basic/#password-protecting-the-web-interface
7579

7680
<p class='img'>
7781
<img src='/images/components/ifttt/IFTTT_to_HA.png' />

‎source/_components/influxdb.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ comments: false
88
sharing: true
99
footer: true
1010
logo: influxdb.png
11-
ha_category: "History"
11+
ha_category: History
1212
ha_release: 0.9
1313
---
1414

‎source/_components/media_player.webostv.markdown

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ To add a TV to your installation, add the following to your `configuration.yaml`
2323
# Example configuration.yaml entry
2424
media_player:
2525
- platform: webostv
26-
host: 192.168.0.10
2726
```
2827
2928
Configuration variables:

‎source/_components/media_player.yamaha.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ A few notes:
4343
- For receivers that support more than one zone, Home Assistant will add one media player per zone supported by the player, named "$name Zone 2" and "$name Zone 3".
4444
- In some cases, autodiscovery fails due to a known bug in the receiver's firmware. It is possible to manually specify the reveiver's IP address or via it's hostname (if it is discoverably by your DNS) then.
4545
- Please note: If adding the IP address or hostname manually, you **must** enable network standby on your receiver, or else startup of Home Assistant will hang if you have your receiver switched off.
46-
- Currently, this component supports powering on/off, mute, volume control and source selection.
46+
- Currently, this component supports powering on/off, mute, volume control and source selection. Playback controls, for instance play and stop are available for sources that supports it.
4747

4848
A full configuration example will look like the sample below:
4949
```yaml

‎source/_components/notify.xmpp.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ ha_release: pre 0.7
1515

1616
The `xmpp` platform allows you to deliver notifications from Home Assistant to a [Jabber (XMPP)](http://xmpp.org) account.
1717

18+
To enable Jabber notifications in your installation, add the following to your `configuration.yaml` file:
19+
1820
```yaml
1921
# Example configuration.yaml entry
2022
notify:

‎source/_components/rfxtrx.markdown

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,7 @@ Configuration variables:
2727
- **device** (*Required*): The path to your device, e.g. `/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0`
2828
- **debug** (*Optional*): If you want to receive debug output.
2929
- **dummy** (*Optional*): Then you have need a connected drive to test your settings. Can be usefull for debugging and testing.
30+
31+
Supported protocols
32+
33+
Not all protocols as advertised are enabled on inital setup of your transceiver. Enabling all protocols is not recommmended either. Your 433.92 product not showing in the logs? Visit the RFXtrx website to [download RFXmgmr](http://www.rfxcom.com/epages/78165469.sf/nl_NL/?ObjectPath=/Shops/78165469/Categories/Downloads) and enable the required protocol.

‎source/_components/sensor.efergy.markdown

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,15 @@ ha_iot_class: "Cloud Polling"
1414
---
1515

1616

17-
Integrate your [Efergy](https://efergy.com) meter information into Home Assistant. To get an app token, log in to your efergy account, go to the Settings page, click on App tokens, and click "Add token".
17+
Integrate your [Efergy](https://efergy.com) meter information into Home Assistant. To get an app token:
18+
19+
1. Log in to your efergy account
20+
21+
2. Go to the Settings page
22+
23+
3. Click on App tokens
24+
25+
4. Click "Add token"
1826

1927
```yaml
2028
# Example configuration.yaml entry

‎source/_components/sensor.fixer.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ha_release: 0.23
1616

1717
The `fixer` sensor will show you the current exchange rate from [Fixer.io](http://fixer.io/) which is using data from the [European Central Bank (ECB)](https://www.ecb.europa.eu).
1818

19-
To get an owerview about the available [currencies](http://api.fixer.io/latest).
19+
To get an overview about the available [currencies](http://api.fixer.io/latest).
2020

2121
To enable this sensor, add the following lines to your `configuration.yaml` file:
2222

0 commit comments

Comments
 (0)