jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-20 15:56:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/current' into next

Browse Source
This commit is contained in:
Paulus Schoutsen 2018-03-11 15:05:02 -07:00
commit b9a1dc052c
27 changed files with 144 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
_config.yml
View File

@ -140,13 +140,13 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 65
current_patch_version: 0
date_released: 2018-03-09
current_patch_version: 3
date_released: 2018-03-11
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
# Major release:
patch_version_notes: "#"
patch_version_notes: "#release-0652---march-11"
# Minor release (Example #release-0431---april-25):
# Date we moved to Discourse for comments

46
source/_components/calendar.caldav.markdown
View File

@ -33,9 +33,38 @@ To integrate a WebDav calendar in Home Assistant, add the following section to y
# Example configuration.yaml entry
calendar:
- platform: caldav
username: john.doe@test.com
password: !secret caldav
url: https://baikal.my-server.net/cal.php/calendars/john.doe@test.com/default
```
This example will generate default binary sensors for each calendar you have in your account. Those calendars will be `on` when there is an ongoing event and `off` if not. Events that last a whole day are ignored in those calendars. You have to setup custom calendars in order to take them into account or for advanced event filtering.
### {% linkable_title Custom calendars %}
You have the possibility to create multiple binary sensors for events that match certain conditions.
```yaml
# Example configuration.yaml entry
calendar:
- platform: caldav
username: john.doe@test.com
password: !secret caldav
url: https://baikal.my-server.net/cal.php/calendars/john.doe@test.com/default
custom_calendars:
- name: 'HomeOffice'
calendar: 'Agenda'
search: 'HomeOffice'
- name: 'WarmupFlat'
calendar: 'Agenda'
search: 'Warmup'
```
This will create two binary sensors for the calendar name Agenda: "HomeOffice" and "WarmupFlat". Those sensors will be `on` if there is an ongoing event matching the regular expression specified in `search`. In custom calendars, events that last a whole day are taken into account.
Please note that when you configure custom calendars, the default ones are not created anymore.
{% configuration %}
url:
required: true
@ -68,7 +97,7 @@ custom_calendars:
type: string
search:
required: true
pending_charges: Regular expression for filtering the events
pending_charges: Regular expression for filtering the events based on the content of their summary, description or location.
type: string
{% endconfiguration %}
@ -82,18 +111,3 @@ custom_calendars:
- **location**: The event Location.
- **start_time**: Start time of event.
- **end_time**: End time of event.
### {% linkable_title Sensor attributes %}
```yaml
# Example configuration.yaml entry
calendar:
- platform: caldav
url: https://baikal.my-server.net/cal.php/calendars/john.doe@test.com/default
username: john.doe@test.com
password: !secret caldav
custom_calendars:
- name: 'HomeOffice'
calendar: 'Agenda'
search: 'HomeOffice'
```

28
source/_components/google_assistant.markdown
View File

@ -41,7 +41,6 @@ google_assistant:
aliases:
- bright lights
- entry lights
type: light
light.living_room:
expose: false
room: living room
@ -102,10 +101,6 @@ entity_config:
description: Aliases that can also be used to refer to this entity
required: false
type: list
type:
description: Override how Google Assistant interprets the domain of the entity. For example, set to `light` for a switch entity to have it be handled as a light.
required: false
type: string
room:
description: Allows for associating this device to a Room in Google Assistant. This is currently non-functional, but will be enabled in the near future.
required: false
@ -115,15 +110,16 @@ entity_config:
### {% linkable_title Available domains %}
Currently, the following domains are available to be used with Google Assistant, listed with their default types:
- group = switch (on/off)
- scene = scene (on)
- script = scene (on)
- switch = switch (on/off)
- fan = switch (on/off)
- light = light (on/off/brightness/rgb color/color temp)
- cover = switch (on/off/set position (brightness) )
- media_player = switch (on/off/set volume (brightness) )
- climate = thermostat (temperature setting)
- group (on/off)
- input boolean (on/off)
- scene (on)
- script (on)
- switch (on/off)
- fan (on/off)
- light (on/off/brightness/rgb color/color temp)
- cover (on/off/set position (via set brightness))
- media_player (on/off/set volume (via set brightness))
- climate (temperature setting)
It's very important that you use very long strings for `client_id` and `access_token`. Those are essentially the credentials to your Home Assistant instance. You can generate them with the following command:
@ -162,8 +158,8 @@ If you're not using Linux, you can use sites such as [this one](https://www.brow
3. Create a new project in the [developer console](https://console.actions.google.com/).
a. Add/Import project
b. Go to Build under the Actions SDK box
c. Copy the command that looks like:
c. Copy the command that looks like:
`gactions update --action_package PACKAGE_NAME --project doctest-2d0b8`
4. Replace `PACKAGE_NAME` with `project.json` and run that command in a console from the same directory you saved `project.json` in (you'll need to put `./` before `gactions` so that it reads `./gactions` if you're running it on Linux or Windows). It should output a URL like `https://console.actions.google.com/project/doctest-2d0b8/overview` - go there.
5. You'll need to fill out most of the information on that page, but none of it really matters since you won't be addressing the App directly, only through the Smart Home functionality built into Google Assistant.

2
source/_components/panel_iframe.markdown
View File

@ -15,7 +15,7 @@ ha_release: 0.25
The `panel_iframe` support allows you to add additional panels to your Home Assistant frontend. The panels are listed in the sidebar and can contain external resources like the web frontend of your router, your monitoring system, or your media server.
<p class='note warning'>If you are accessing home Assistant over HTTPS using SSL, you cannot access HTTP sites through an iframe panel.</p>
<p class='note warning'>If you are accessing Home Assistant over HTTPS using SSL, you cannot access HTTP sites through an iframe panel.</p>
To enable Panel iFrames in your installation, add the following to your `configuration.yaml` file:

2
source/_components/persistent_notification.markdown
View File

@ -67,5 +67,3 @@ Choose <img src='/images/screenshots/developer-tool-services-icon.png' alt='serv
}
```
This will create the notification entry shown above.
NOTE: if you have defined a ```default_view:``` in your ```Groups:``` configuration you will need to include ```persistent_notification.<notification_id>``` e.g. ```persistent_notification.1234``` as per the example above, to your Groups configuration, in order to see the notification after creating it.

2
source/_components/sensor.folder.markdown
View File

@ -13,7 +13,7 @@ ha_iot_class: "Local Polling"
ha_release: 0.64
---
Sensor for monitoring the contents of a folder. Note that folder paths must be added to [whitelist_external_dirs](https://home-assistant.io/docs/configuration/basic/). Optionally a [wildcard filter]((http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm)) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria. The number of filtered files in the folder and total size in bytes of those files are exposed as attributes.
Sensor for monitoring the contents of a folder. Note that folder paths must be added to [whitelist_external_dirs](https://home-assistant.io/docs/configuration/basic/). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria. The number of filtered files in the folder and total size in bytes of those files are exposed as attributes.
To enable the `folder` sensor in your installation, add the following to your `configuration.yaml` file:

1
source/_components/weblink.markdown
View File

@ -22,6 +22,7 @@ weblink:
entities:
- name: Router
url: http://192.168.1.1/
icon: mdi:router-wireless
- name: Home Assistant
url: https://home-assistant.io
- name: Grafana

1
source/_docs/configuration/remote.markdown
View File

@ -7,7 +7,6 @@ sidebar: true
comments: false
sharing: true
footer: true
redirect_from: /getting-started/basic/#remote-access
---
If you're interested in logging in to Home Assistant while away, you'll have to make your instance remotely accessible. Remember to follow the [securing checklist](/docs/configuration/securing/) before doing this.

2
source/_docs/installation/docker.markdown
View File

@ -20,7 +20,7 @@ $ docker run -d --name="home-assistant" -v /path/to/your/config:/config -v /etc/
### {% linkable_title macOS %}
When using `docker-ce` (or `boot2docker`) on macOS, you are unable to map the local timezone to your Docker container (see Docker issue https://github.com/docker/for-mac/issues/44). Instead of `-v /etc/localtime:/etc/localtime:ro`, just pass in the timezone environment variable when you launch the container, ex: `-e "TZ=America/Los_Angeles"`. Replace "America/Los_Angeles" with [your timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
When using `docker-ce` (or `boot2docker`) on macOS, you are unable to map the local timezone to your Docker container ([Docker issue](https://github.com/docker/for-mac/issues/44)). Instead of `-v /etc/localtime:/etc/localtime:ro`, just pass in the timezone environment variable when you launch the container, ex: `-e "TZ=America/Los_Angeles"`. Replace "America/Los_Angeles" with [your timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
If you wish to browse directly to `http://localhost:8123` from your macOS host, meaning forward ports directly to the container, replace the `--net=host` switch with `-p 8123:8123`. More detail can be found in [the docker forums](https://forums.docker.com/t/should-docker-run-net-host-work/14215/10).

2
source/_docs/installation/hassbian/common-tasks.markdown
View File

@ -37,7 +37,7 @@ To get the current state of the `homeassistant.service` replace `stop` with `sta
### {% linkable_title Update Home Assistant %}
<p class='note'>
You can also use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade homeassistant`
You can also use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade home-assistant`
</p>
Log in as the `pi` account and execute the following commands:

2
source/_docs/installation/virtualenv.markdown
View File

@ -10,7 +10,7 @@ footer: true
redirect_from: /getting-started/installation-virtualenv/
---
If you already have Python 3.5 or later installed, you can easily give Home Assistant a spin.
If you already have Python 3.5.3 or later installed, you can easily give Home Assistant a spin.
It's recommended when installing Python packages that you use a [virtual environment](https://docs.python.org/3.5/library/venv.html#module-venv). This will make sure that your Python installation and Home Assistant installation won't impact one another. The following steps will work on most unix like systems.

1
source/_docs/mqtt/broker.markdown
View File

@ -8,7 +8,6 @@ comments: false
sharing: true
footer: true
logo: mqtt.png
redirect_from: /components/mqtt/#picking-a-broker
---
The MQTT component needs you to run an MQTT broker for Home Assistant to connect to. There are four options, each with various degrees of ease of setup and privacy.

1
source/_docs/mqtt/discovery.markdown
View File

@ -8,7 +8,6 @@ comments: false
sharing: true
footer: true
logo: mqtt.png
redirect_from: /components/mqtt/#discovery
---
The discovery of MQTT devices will enable one to use MQTT devices with only minimal configuration effort on the side of Home Assistant. The configuration is done on the device itself and the topic used by the device. Similar to the [HTTP binary sensor](/components/binary_sensor.http/) and the [HTTP sensor](/components/sensor.http/). The basic idea is that the device itself adds its configuration into your `configuration.yaml` automatically. To prevent multiple identical entries if a device reconnects a unique identifier is necessary. Two parts are required on the device side: The configuration topic which contains the necessary device type and unique identifier and the remaining device configuration without the device type.

1
source/_docs/mqtt/logging.markdown
View File

@ -8,7 +8,6 @@ comments: false
sharing: true
footer: true
logo: mqtt.png
redirect_from: /components/mqtt/#logging
---
The [logger](/components/logger/) component allow the logging of received MQTT messages.

1
source/_docs/mqtt/processing_json.markdown
View File

@ -8,7 +8,6 @@ comments: false
sharing: true
footer: true
logo: mqtt.png
redirect_from: /components/mqtt/#processing-json
---
The MQTT [switch](/components/switch.mqtt/) and [sensor](/components/sensor.mqtt/) platforms support processing JSON over MQTT messages and parsing them using JSONPath. JSONPath allows you to specify where in the JSON the value resides that you want to use. The following examples will always return the value `100`.

1
source/_docs/mqtt/service.markdown
View File

@ -8,7 +8,6 @@ comments: false
sharing: true
footer: true
logo: mqtt.png
redirect_from: /components/mqtt/#publish-service
---
The MQTT component will register the service `publish` which allows publishing messages to MQTT topics. There are two ways of specifying your payload. You can either use `payload` to hard-code a payload or use `payload_template` to specify a [template](/topics/templating/) that will be rendered to generate the payload.

1
source/_docs/mqtt/testing.markdown
View File

@ -8,7 +8,6 @@ comments: false
sharing: true
footer: true
logo: mqtt.png
redirect_from: /components/mqtt/#testing-your-setup
---
The `mosquitto` broker package ships commandline tools (often as `*-clients` package) to send and receive MQTT messages. As an alternative have a look at [hbmqtt_pub](http://hbmqtt.readthedocs.org/en/latest/references/hbmqtt_pub.html) and [hbmqtt_sub](http://hbmqtt.readthedocs.org/en/latest/references/hbmqtt_sub.html) which are provided by HBMQTT. For sending test messages to a broker running on localhost check the example below:

1
source/_docs/tools/benchmark.markdown
View File

@ -7,7 +7,6 @@ sidebar: true
comments: false
sharing: true
footer: true
redirect_from: /docs/tools/scripts/#benchmark
---
For testing the performance of Home Assistant the Benchmark script runs until you exit using Control+C.

1
source/_docs/tools/check_config.markdown
View File

@ -7,7 +7,6 @@ sidebar: true
comments: false
sharing: true
footer: true
redirect_from: /docs/tools/scripts/#configuration-check
---
Test any changes to your `configuration.yaml` file before launching Home Assistant. This script allows you to test changes without the need to restart Home Assistant.

1
source/_docs/tools/credstash.markdown
View File

@ -7,7 +7,6 @@ sidebar: true
comments: false
sharing: true
footer: true
redirect_from: /docs/configuration/secrets/#storing-passwords-securely-in-aws
---
Using [Credstash](https://github.com/fugue/credstash) is an alternative way to `secrets.yaml`. They can be managed from the command line via the credstash script.

1
source/_docs/tools/db_migrator.markdown
View File

@ -7,7 +7,6 @@ sidebar: true
comments: false
sharing: true
footer: true
redirect_from: /components/influxdb/#data-migration
---
<p class='note warning'>

1
source/_docs/tools/ensure_config.markdown
View File

@ -7,7 +7,6 @@ sidebar: true
comments: false
sharing: true
footer: true
redirect_from: /docs/tools/scripts/#existence-of-configuration
---
This script checks if the `configuration.yaml` file exists. If the file is not available, one is created.

1
source/_docs/tools/influxdb_import.markdown
View File

@ -7,7 +7,6 @@ sidebar: true
comments: false
sharing: true
footer: true
redirect_from: /components/influxdb/#data-import-script
---
If you want to import all the recorded data from your recorder database you can use the data import script. It will read all your state_change events from the database and add them as data-points to the InfluxDB. You can specify the source database either by pointing the `--config` option to the config directory which includes the default SQLite database or by giving a sqlalchemy connection URI with `--uri`.

1
source/_docs/tools/keyring.markdown
View File

@ -7,7 +7,6 @@ sidebar: true
comments: false
sharing: true
footer: true
redirect_from: /docs/configuration/secrets/#storing-passwords-in-a-keyring-managed-by-your-os
---
Using [Keyring](https://github.com/jaraco/keyring) is an alternative way to `secrets.yaml`. The secrets can be managed from the command line via the `keyring` script.

92
source/_posts/2018-03-09-release-65.markdown
View File

@ -114,6 +114,38 @@ intent_script:
- Add support for alarm system, switch and thermostat to homekit ([@maxclaey] - [#12819]) ([homekit docs]) (new-platform)
- Add camera proxy ([@PhracturedBlue] - [#12006]) ([camera.proxy docs]) (new-platform)
## {% linkable_title Release 0.65.1 - March 10 %}
- allow ios device tracker see calls to go through ([@balloob] - [#13020]) ([device_tracker docs])
- Fix config component loading YAML ([@kellerza] - [#13024])
- Make Throttle async aware ([@balloob] - [#13027])
- Add support for input boolean to Google Assistant ([@balloob] - [#13030]) ([google_assistant docs])
- HomeKit Bugfix: names ([@cdce8p] - [#13031]) ([homekit docs])
## {% linkable_title Release 0.65.2 - March 10 %}
- Fix translations sometimes not loading in the frontend ([@armills])
- Fix sensibo's min/max_temp properties ([@jra3] - [#12996]) ([climate.sensibo docs])
- Use request.query ([@ptarjan] - [#13037]) ([wink docs])
- Ensure we have valid config AFTER merging packages #13015 ([@kellerza] - [#13038])
- Bump pysabnzbd version ([@jeradM] - [#13042]) ([sensor.sabnzbd docs])
- Fix async lifx_set_state ([@amelchio] - [#13045]) ([light.lifx docs])
- Yeelight version bumped. ([@syssi] - [#13056]) ([light.yeelight docs])
- Don't call async from sync ([@balloob] - [#13057]) ([xiaomi_aqara docs])
- Convert decimals from SQL results ([@balloob] - [#13059]) ([sensor.sql docs])
## {% linkable_title Release 0.65.3 - March 11 %}
- Implement Hue available property ([@balloob] - [#12939]) ([light.hue docs])
- Catch async from sync context by running asyncio event loop in debug mode during tests ([@balloob] - [#13058]) ([camera.arlo docs]) ([climate.generic_thermostat docs])
- Fixes KNX fire event problem, issue https://github.com/home-assistant/home-assistant/issues/13049 ([@Julius2342] - [#13062]) ([knx docs])
- Bump iGlo Version ([@jesserockz] - [#13063]) ([light.iglo docs])
- Fix Tado doing async wrong ([@balloob] - [#13078]) ([device_tracker.tado docs])
- Synology Camera: auto-renew session when it's expired ([@snjoetw] - [#13079]) ([camera.synology docs])
- Revert "Cast automatically drop connection (#12635)" ([@OttoWinter] - [#13094]) ([media_player.cast docs])
- Bump pyvera to 0.2.42. Improve event loop robustness. ([@pavoni] - [#13095]) ([vera docs])
- Fix Kodi by updateding jsonrpc-websocket to 0.6 ([@Tadly] - [#13096]) ([media_player.kodi docs])
## {% linkable_title If you need help... %}
...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks.
@ -602,3 +634,63 @@ Experiencing issues introduced by this release? Please report them in our [issue
[zabbix docs]: https://home-assistant.io/components/zabbix/
[zha docs]: https://home-assistant.io/components/zha/
[zwave docs]: https://home-assistant.io/components/zwave/
[#13020]: https://github.com/home-assistant/home-assistant/pull/13020
[#13024]: https://github.com/home-assistant/home-assistant/pull/13024
[#13027]: https://github.com/home-assistant/home-assistant/pull/13027
[#13030]: https://github.com/home-assistant/home-assistant/pull/13030
[#13031]: https://github.com/home-assistant/home-assistant/pull/13031
[@balloob]: https://github.com/balloob
[@cdce8p]: https://github.com/cdce8p
[@kellerza]: https://github.com/kellerza
[device_tracker docs]: https://home-assistant.io/components/device_tracker/
[google_assistant docs]: https://home-assistant.io/components/google_assistant/
[homekit docs]: https://home-assistant.io/components/homekit/
[#12996]: https://github.com/home-assistant/home-assistant/pull/12996
[#13037]: https://github.com/home-assistant/home-assistant/pull/13037
[#13038]: https://github.com/home-assistant/home-assistant/pull/13038
[#13042]: https://github.com/home-assistant/home-assistant/pull/13042
[#13045]: https://github.com/home-assistant/home-assistant/pull/13045
[#13056]: https://github.com/home-assistant/home-assistant/pull/13056
[#13057]: https://github.com/home-assistant/home-assistant/pull/13057
[#13059]: https://github.com/home-assistant/home-assistant/pull/13059
[@amelchio]: https://github.com/amelchio
[@balloob]: https://github.com/balloob
[@jeradM]: https://github.com/jeradM
[@jra3]: https://github.com/jra3
[@kellerza]: https://github.com/kellerza
[@armills]: https://github.com/armills
[@ptarjan]: https://github.com/ptarjan
[@syssi]: https://github.com/syssi
[climate.sensibo docs]: https://home-assistant.io/components/climate.sensibo/
[light.lifx docs]: https://home-assistant.io/components/light.lifx/
[light.yeelight docs]: https://home-assistant.io/components/light.yeelight/
[sensor.sabnzbd docs]: https://home-assistant.io/components/sensor.sabnzbd/
[sensor.sql docs]: https://home-assistant.io/components/sensor.sql/
[wink docs]: https://home-assistant.io/components/wink/
[xiaomi_aqara docs]: https://home-assistant.io/components/xiaomi_aqara/
[#12939]: https://github.com/home-assistant/home-assistant/pull/12939
[#13058]: https://github.com/home-assistant/home-assistant/pull/13058
[#13062]: https://github.com/home-assistant/home-assistant/pull/13062
[#13063]: https://github.com/home-assistant/home-assistant/pull/13063
[#13078]: https://github.com/home-assistant/home-assistant/pull/13078
[#13079]: https://github.com/home-assistant/home-assistant/pull/13079
[#13094]: https://github.com/home-assistant/home-assistant/pull/13094
[#13095]: https://github.com/home-assistant/home-assistant/pull/13095
[#13096]: https://github.com/home-assistant/home-assistant/pull/13096
[@Julius2342]: https://github.com/Julius2342
[@OttoWinter]: https://github.com/OttoWinter
[@Tadly]: https://github.com/Tadly
[@balloob]: https://github.com/balloob
[@jesserockz]: https://github.com/jesserockz
[@pavoni]: https://github.com/pavoni
[@snjoetw]: https://github.com/snjoetw
[camera.arlo docs]: https://home-assistant.io/components/camera.arlo/
[camera.synology docs]: https://home-assistant.io/components/camera.synology/
[climate.generic_thermostat docs]: https://home-assistant.io/components/climate.generic_thermostat/
[device_tracker.tado docs]: https://home-assistant.io/components/device_tracker.tado/
[knx docs]: https://home-assistant.io/components/knx/
[light.hue docs]: https://home-assistant.io/components/light.hue/
[light.iglo docs]: https://home-assistant.io/components/light.iglo/
[media_player.cast docs]: https://home-assistant.io/components/media_player.cast/
[media_player.kodi docs]: https://home-assistant.io/components/media_player.kodi/
[vera docs]: https://home-assistant.io/components/vera/

2
source/developers/development_testing.markdown
View File

@ -54,7 +54,7 @@ $ pydocstyle homeassistant/core.py
$ py.test tests/test_core.py
```
You can also run linting tests against all changed files, as reported by `git diff upstream/dev... --name-only`, using the `lint` script:
You can also run linting tests against all changed files, as reported by `git diff upstream/dev... --diff-filter=d --name-only`, using the `lint` script:
```bash
$ script/lint

BIN
source/images/blog/2018-03-0.65/components.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 60 KiB