-The "Limited" plan (which is what new users are given by default) is limited to 500 API requests per day. In order to leave a buffer, the `openuv` component queries the API every 30 minutes by default. This value can be modifed (via the `scan_interval` key), but please note that over-running the API will require -you to upgrade to a paid plan (and may disable your access in the meantime). +The "Limited" plan (which is what new users are given by default) is limited to 500 API requests per day. In order to leave a buffer, the `openuv` component queries the API every 30 minutes by default. This value can be modifed (via the `scan_interval` key), but please note that over-running the API will require you to upgrade to a paid plan (and may disable your access in the meantime).
-## {% linkable_title Base Configuration %} +## {% linkable_title Configuration %} -To retrieve data from OpenUV, add the following to your `configuration.yaml` -file: +To retrieve data from OpenUV, add the following to your `configuration.yaml` file: ```yaml openuv: api_key: YOUR_OPENUV_API_KEY ``` -To configure additional functionality, add configuration options beneath a `binary_sensor` and/or `sensor` key within the `openuv` section of `configuration.yaml` as below: +{% configuration %} +api_key: + description: The OpenUV API key. + required: true + type: string +scan_interval: + description: the frequency (in seconds) between data updates. + required: false + type: integer + default: 1800 +binary_sensors: + description: The binary sensor-related configuration options. + required: false + type: map + keys: + monitored_conditions: + description: The conditions to create sensors from. + required: false + type: list + default: all + keys: + uv_protection_window: + description: Displays if UV protection (sunscreen, etc.) is recommended at the current date and time. +sensors: + description: The sensor-related configuration options. + required: false + type: map + keys: + monitored_conditions: + description: The conditions to create sensors from. + required: false + type: list + default: all + keys: + current_ozone_level: + description: The current ozone level in du (Dobson Units). + current_uv_index: + description: The current UV index. + current_uv_level: + description: "The level of current UV index, which is calculated based on [UV Index Levels & Colors](https://www.openuv.io/kb/uv-index-levels-colors)." + max_uv_index: + description: The maximum UV index that will be encountered that day (at solar noon). + safe_exposure_time_type_1: + description: The approximate exposure time for skin type I. + safe_exposure_time_type_2: + description: The approximate exposure time for skin type II. + safe_exposure_time_type_3: + description: The approximate exposure time for skin type III. + safe_exposure_time_type_4: + description: The approximate exposure time for skin type IV. + safe_exposure_time_type_5: + description: The approximate exposure time for skin type V. + safe_exposure_time_type_6: + description: The approximate exposure time for skin type VI. +{% endconfiguration %} + +The approximate number of minutes of a particular skin type can be exposed to the sun before burning/tanning starts is based on the [Fitzpatrick scale](https://en.wikipedia.org/wiki/Fitzpatrick_scale). + +## {% linkable_title Full example %} + +To configure additional functionality, add configuration options beneath a `binary_sensor` and/or `sensor` key within the `openuv` section of the `configuration.yaml` file as below: ```yaml openuv: api_key: YOUR_OPENUV_API_KEY binary_sensors: - # binary sensor configuration options... + - uv_protection_window sensors: - # sensor configuration options... + - current_ozone_level + - current_uv_index + - current_uv_level + - max_uv_index + - safe_exposure_time_type_1 + - safe_exposure_time_type_2 + - safe_exposure_time_type_3 + - safe_exposure_time_type_4 + - safe_exposure_time_type_5 + - safe_exposure_time_type_6 ``` -{% configuration %} -api_key: - description: your OpenUV API key - required: true - type: string -scan_interval: - description: the frequency (in seconds) between data updates - required: false - type: integer - default: 1800 -binary_sensors: - description: binary sensor-related configuration options - required: false - type: map - keys: - monitored_conditions: - description: the conditions to create sensors from - required: false - type: list - default: all (`uv_protection_window`) -sensors: - description: sensor-related configuration options - required: false - type: map - keys: - monitored_conditions: - description: the conditions to create sensors from - required: false - type: list - default: all ( `current_ozone_level`, `current_uv_index`, `current_uv_level`, `max_uv_index`, `safe_exposure_time_type_1`, `safe_exposure_time_type_2`, `safe_exposure_time_type_3`, `safe_exposure_time_type_4`, `safe_exposure_time_type_5`, `safe_exposure_time_type_6` ) -{% endconfiguration %} - -## {% linkable_title Binary Sensor Types %} - -### {% linkable_title `uv_protection_window` %} - -This sensor displays `true` if UV protection (sunscreen, etc.) is recommended at the current date and time; displays `false` otherwise. - -## {% linkable_title Sensor Types %} - -### {% linkable_title `current_ozone_level` %} - -This sensor displays the current ozone level in du (Dobson Units). - -### {% linkable_title `current_uv_index` %} - -This sensor displays the current UV index. - -### {% linkable_title `current_uv_level` %} - -This sensor displays the level of current UV index, which is calculated based on [UV Index Levels & Colors](https://www.openuv.io/kb/uv-index-levels-colors). - -### {% linkable_title `max_uv_index` %} - -This sensor displays the maximum UV index that will be encountered that day (at solar noon). - -### {% linkable_title `safe_exposure_time_type_X` %} - -These sensors display the approximate number of minutes a particular skin type can be exposed to the sun before burning/tanning starts. Each sensor depicts a skin type based on the -[Fitzpatrick scale](https://en.wikipedia.org/wiki/Fitzpatrick_scale): - -* Skin Type I -* Skin Type II -* Skin Type III -* Skin Type IV -* Skin Type V -* Skin Type VI --The above guidelines constitute estimates and are intended to help informed decision making. They should not replace analysis, advice, or diagnosis from a trained medical professional. +The above guidelines constitute estimates and are intended to help informed decision making. They should not replace analysis, advice or diagnosis from a trained medical professional.
diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown index 0b2182a83f6..f29e5299776 100644 --- a/source/_components/sensor.mqtt.markdown +++ b/source/_components/sensor.mqtt.markdown @@ -33,7 +33,7 @@ state_topic: required: true type: string name: - description: Name of the MQTT sensor. + description: The name of the MQTT sensor. required: false type: string default: MQTT Sensor @@ -47,7 +47,7 @@ unit_of_measurement: required: false type: string icon: - description: Icon for the sensor. + description: The icon for the sensor. required: false type: icon expire_after: @@ -128,18 +128,18 @@ In this section you find some real-life examples of how to use this sensor. ### {% linkable_title JSON attributes configuration %} -The example sensor below shows a configuration example which uses JSON in the state topic to add extra attributes. It also makes use of the availability topic. Attributes can then be extracted in [Templates](/docs/configuration/templating/#attributes). For example, to extract the `ClientName` attribute from the sensor below, use a template similar to: {% raw %}`{{ state_attr('sensor.bs_rssi', 'ClientName') }}`{% endraw %}. +The example sensor below shows a configuration example which uses JSON in the state topic to add extra attributes. It also makes use of the `availability` topic. Attributes can then be extracted in [Templates](/docs/configuration/templating/#attributes). For example, to extract the `ClientName` attribute from the sensor below, use a template similar to: {% raw %}`{{ state_attr('sensor.bs_rssi', 'ClientName') }}`{% endraw %}. {% raw %} ```yaml # Example configuration.yaml entry sensor: - platform: mqtt - name: "BS RSSI" - state_topic: "HUISHS/BunnyShed/NodeHealthJSON" + name: "RSSI" + state_topic: "home/sensor1/infojson" unit_of_measurement: 'dBm' value_template: "{{ value_json.RSSI }}" - availability_topic: "HUISHS/BunnyShed/status" + availability_topic: "home/sensor1/status" payload_available: "online" payload_not_available: "offline" json_attributes: diff --git a/source/_components/sensor.zestimate.markdown b/source/_components/sensor.zestimate.markdown index 1d24b3f0dfd..aa74b086daf 100644 --- a/source/_components/sensor.zestimate.markdown +++ b/source/_components/sensor.zestimate.markdown @@ -13,11 +13,13 @@ ha_release: 0.65 ha_iot_class: "Cloud Polling" --- -The `zestimate` sensor allows one to track the Zestimate value of properties using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). +The `zestimate` sensor allows one to track the Zestimate® value of properties using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). According to Zillow's website, a Zestimate® home valuation is Zillow's estimated market value. It is not an appraisal. Use it as a starting point to determine a home's value. The Zestimate® is provided by [Zillow](https://www.zillow.com), a website primarily for listing homes to buy/sell/rent in the United States. + +This component adds one entity per zpid specified, named `sensor.zestimate` with numbers appended if you choose to track more than one Zestimate. ## {% linkable_title Configuration %} -You will need to sign up for the Zillow API at the following link [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). You will also need the Zillow property ID for each property you'd like to track. This information is available from the URL of a property you are interested in. +You will need to sign up for the Zillow API at the following link [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). You will also need the Zillow property ID for each property you'd like to track. This information is available from the URL of a property you are interested in. If you're the owner of this property, it's recommended to claim the listing and update the property information to help the information be as accurate as possible. For example, the White House zpid is 84074482 and can be found in its Zillow URL: [https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/](https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/) @@ -34,11 +36,11 @@ sensor: {% configuration %} api_key: - description: The API key to access the service. + description: The API key to access the service. Obtain yours using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm) required: true type: string zpid: - description: Property IDs to track in the front end. + description: Property IDs to track in the front end. Can be found in it's Zillow URL as described above. Include only the numbers, do not include the "_zpid" required: true type: list {% endconfiguration %} @@ -56,3 +58,7 @@ These attributes are available: - Address - Currency - Amount + +Example screenshot + +
diff --git a/source/_docs/installation/updating.markdown b/source/_docs/installation/updating.markdown
index a9884322b60..4bc5d375eb1 100644
--- a/source/_docs/installation/updating.markdown
+++ b/source/_docs/installation/updating.markdown
@@ -44,6 +44,14 @@ In the event that a Home Assistant version doesn't play well with your hardware
$ pip3 install homeassistant==0.XX.X
```
+#### {% linkable_title Run the beta version %}
+
+If you would like to test next release before anyone else, you can install the beta version released every two weeks:
+
+```bash
+$ pip3 install --pre --upgrade homeassistant
+```
+
#### {% linkable_title Run the development version %}
If you want to stay on the bleeding-edge Home Assistant development branch, you can upgrade to `dev`.
diff --git a/source/_posts/2018-10-12-release-80.markdown b/source/_posts/2018-10-12-release-80.markdown
index 6a7a8ec30d8..1f413af08ed 100644
--- a/source/_posts/2018-10-12-release-80.markdown
+++ b/source/_posts/2018-10-12-release-80.markdown
@@ -84,6 +84,25 @@ On the devices side, we got basic support for the new IKEA TRÅDFRI switches, Ho
[sensor.blink docs]: /components/sensor.blink/
[telegram_bot docs]: /components/telegram_bot/
+## {% linkable_title Release 0.80.3 - October 18 %}
+
+- Update hangups to 0.4.6 and fix Issue #16593 hangouts reconnects. ([@hobbypunk90] - [#17518]) ([hangouts docs])
+- Update to async-upnp-client==0.12.5 ([@StevenLooman] - [#17401]) ([upnp docs]) ([media_player.dlna_dmr docs])
+- Upgrade async_upnp_client to 0.12.6 ([@StevenLooman] - [#17560]) ([upnp docs]) ([media_player.dlna_dmr docs])
+- Update snapcast to 2.0.9 ([@balloob] - [#17573]) ([media_player.snapcast docs])
+
+[#17401]: https://github.com/home-assistant/home-assistant/pull/17401
+[#17518]: https://github.com/home-assistant/home-assistant/pull/17518
+[#17560]: https://github.com/home-assistant/home-assistant/pull/17560
+[#17573]: https://github.com/home-assistant/home-assistant/pull/17573
+[@StevenLooman]: https://github.com/StevenLooman
+[@balloob]: https://github.com/balloob
+[@hobbypunk90]: https://github.com/hobbypunk90
+[hangouts docs]: https://www.home-assistant.io/components/hangouts/
+[media_player.dlna_dmr docs]: https://www.home-assistant.io/components/media_player.dlna_dmr/
+[media_player.snapcast docs]: https://www.home-assistant.io/components/media_player.snapcast/
+[upnp docs]: https://www.home-assistant.io/components/upnp/
+
## {% linkable_title New Features %}
- Add faucet, shower, sprinkler, valve to HomeKit ([@cdce8p] - [#17145]) ([homekit docs]) (new-feature)
diff --git a/source/images/components/zestimate/zestimateexample.png b/source/images/components/zestimate/zestimateexample.png
new file mode 100644
index 00000000000..1ab53b1bb88
Binary files /dev/null and b/source/images/components/zestimate/zestimateexample.png differ