-
-
- {% active_link /hassio/ Hass.io %} +
- {% active_link /hassio/ Home Assistant %}
- {% active_link /docs/installation/updating/ Updating %}
-
{% active_link /docs/installation/troubleshooting/ Troubleshooting
diff --git a/source/_includes/asides/hassio_navigation.html b/source/_includes/asides/hassio_navigation.html
index ffb99b948b0..c30771e6e65 100644
--- a/source/_includes/asides/hassio_navigation.html
+++ b/source/_includes/asides/hassio_navigation.html
@@ -3,7 +3,7 @@
Topics
-
- {% active_link /hassio/ Hass.io %}
+ {% active_link /hassio/ Home Assistant %}
- {% active_link /hassio/installation/ Installation %}
- {% active_link /addons/ Available add-ons %} diff --git a/source/_includes/edit_github.html b/source/_includes/edit_github.html index b5fa2329b84..3b6c57980eb 100644 --- a/source/_includes/edit_github.html +++ b/source/_includes/edit_github.html @@ -1,4 +1,4 @@ {% assign url_parts = page.url | split: '/' %} {% if page.hide_github_edit != true %} - + {% endif %} diff --git a/source/_integrations/binary_sensor.mqtt.markdown b/source/_integrations/binary_sensor.mqtt.markdown index 1b551075472..6154fd3c550 100644 --- a/source/_integrations/binary_sensor.mqtt.markdown +++ b/source/_integrations/binary_sensor.mqtt.markdown @@ -8,9 +8,9 @@ ha_iot_class: Configurable ha_domain: mqtt --- -The `mqtt` binary sensor platform uses an MQTT message payload to set the binary sensor to one of two states: `on` or `off`. +The `mqtt` binary sensor platform uses an MQTT message received to set the binary sensor's state to `on` or `off`. -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 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`. @@ -19,7 +19,7 @@ Stateless devices such as buttons, remote controls etc are better represented by ## Configuration 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 sensor 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. +is defined, Home Assistant will consider the MQTT device to be `available` and will display its state. To use an MQTT binary sensor in your installation, add the following to your `configuration.yaml` file: @@ -33,7 +33,7 @@ binary_sensor: {% configuration %} availability_topic: - 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." + description: "The MQTT topic subscribed to receive birth and LWT messages from the MQTT device. If `availability_topic` is not defined, the binary sensor will always be considered `available` and its state will be `on`, `off` or `unknown`. If `availability_topic` is defined, the binary sensor will be considered as `unavailable` by default and the sensor's state will be `unavailable`." required: false type: string device: @@ -70,11 +70,11 @@ device_class: required: false type: string expire_after: - description: "Defines the number of seconds after the value expires if it's not updated. After expiry, the value is cleared, and the availability is set to false" + description: "Defines the number of seconds after the sensor's state expires if it's not updated. After expiry, the sensor's state becomes `unavailable` if `availability_topic` is defined and `unknown` otherwise." required: false type: integer force_update: - description: Sends update events even if the value hasn't changed. Useful if you want to have meaningful value graphs in history. + description: Sends update events (which results in update of [state object](/docs/configuration/state_object/)'s `last_changed`) even if the sensor's state hasn't changed. Useful if you want to have meaningful value graphs in history or want to create an automation that triggers on *every* incoming state message (not only when the sensor's new state is different to the current one). required: false type: boolean default: false @@ -92,26 +92,26 @@ name: type: string default: MQTT Binary Sensor off_delay: - description: "For sensors that only sends `On` state updates, this variable sets a delay in seconds after which the sensor state will be updated back to `Off`." + description: "For sensors that only send `on` state updates (like PIRs), this variable sets a delay in seconds after which the sensor's state will be updated back to `off`." required: false type: integer payload_available: - description: The payload that represents the online state. + description: The string that represents the `online` state. required: false type: string default: online payload_not_available: - description: The payload that represents the offline state. + description: The string that represents the `offline` state. required: false type: string default: offline payload_off: - description: The payload that represents the off state. + description: The string that represents the `off` state. It will be compared to the message in the `state_topic` (see `value_template` for details) required: false type: string default: "OFF" payload_on: - description: The payload that represents the on state. + description: The string that represents the `on` state. It will be compared to the message in the `state_topic` (see `value_template` for details) required: false type: string default: "ON" @@ -121,7 +121,7 @@ qos: type: integer default: 0 state_topic: - description: The MQTT topic subscribed to receive sensor values. + description: The MQTT topic subscribed to receive sensor's state. required: true type: string unique_id: @@ -129,7 +129,7 @@ unique_id: required: false type: string value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload. Available variables: `entity_id`. Remove this option when 'payload_on' and 'payload_off' are sufficient to match your payloads." + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) that returns a string to be compared to `payload_on`/`payload_off`. Available variables: `entity_id`. Remove this option when 'payload_on' and 'payload_off' are sufficient to match your payloads (i.e no pre-processing of original message is required)." required: false type: string {% endconfiguration %} diff --git a/source/_integrations/filesize.markdown b/source/_integrations/filesize.markdown index b71079ea6d2..50613cb1ef9 100644 --- a/source/_integrations/filesize.markdown +++ b/source/_integrations/filesize.markdown @@ -8,7 +8,13 @@ ha_release: 0.64 ha_domain: filesize --- -The `filesize` sensor for displaying the size in MB of a file. Note that paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). +The `filesize` sensor is for displaying the size in MB of a file. + +
+ +File paths must also be added to [whitelist_external_dirs](/docs/configuration/basic/) in your `configuration.yaml`. + +## Configuration diff --git a/source/_integrations/homematic.markdown b/source/_integrations/homematic.markdown index b7ea20cca01..ee22deabef7 100644 --- a/source/_integrations/homematic.markdown +++ b/source/_integrations/homematic.markdown @@ -477,7 +477,7 @@ The `homematic` notification platform enables invoking Homematic devices. To use this notification platform in your installation, add the following to your `configuration.yaml` file: -## Configuration +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/opnsense.markdown b/source/_integrations/opnsense.markdown index df643f73c88..6be0886ece4 100644 --- a/source/_integrations/opnsense.markdown +++ b/source/_integrations/opnsense.markdown @@ -32,6 +32,8 @@ Where the `api_key` and `api_secret` values are acquired from your OPNsense router using the web interface. For more information on this procedure, refer to the OPNsense [documentation](https://docs.opnsense.org/development/how-tos/api.html#creating-keys). +User with API Key requires privileges for Type: GUI Name: Diagnostics: ARP Table. + {% configuration %} url: description: The URL for the OPNsense API endpoint of your router. diff --git a/source/_integrations/tplink.markdown b/source/_integrations/tplink.markdown index 1b0ac783fb9..bfe2e596fbf 100644 --- a/source/_integrations/tplink.markdown +++ b/source/_integrations/tplink.markdown @@ -140,7 +140,7 @@ Devices that are confirmed to support Consumption Reading; 1. HS110 2. HS300 -In order to get the power consumption readings from a TP-Link HS110 device, you'll have to create a [template sensor](/integrations/switch.template/). +In order to get the power consumption readings from a TP-Link HS110 device, you'll have to create a [template sensor](/integrations/template/). In the example below, change all of the `my_tp_switch`'s to match your device's entity ID. {% raw %} diff --git a/source/_posts/2020-03-15-community-highlights.markdown b/source/_posts/2020-03-15-community-highlights.markdown new file mode 100644 index 00000000000..cf196fea07d --- /dev/null +++ b/source/_posts/2020-03-15-community-highlights.markdown @@ -0,0 +1,102 @@ +--- +title: "Community Highlights: 5th edition" +description: "DIY Smart key holder, Marine aquariums and Live energy consumption" +date: 2020-03-15 00:00:00 +date_formatted: "March 15, 2020" +author: Franck Nijhof +author_twitter: frenck +categories: Community +og_image: /images/blog/2020-03-15-community-highlights/social.png +--- + +Time for the fifth enactment of the Community Highlights! + +We've received quite a few recommendations, but also closely monitored +social media and found some gems to share again! + +## Controlling 7! marine aquariums with Home Assistant + +Let's start with showcasing a highly unusual, but impressive, Home Assistant setup. +It is shared on our [Facebook group][facebook-group] by Kevin McPeake. Kevin's +setup has a total of 5 Home Assistant instances, controlling 7x marine aquariums! + ++ +
+ +Those are some big views Kevin! I bet you will be happy with the new Lovelace +features that are coming in Home Assistant Core 0.107. It will help +you to trim down that a bit, into multiple Lovelace Dashboards (now in +[beta, sneak peak?](https://rc.home-assistant.io/latest-release-notes/)). + +[Click here to check out Kevin's post on our Facebook group.](https://www.facebook.com/groups/HomeAssistant/permalink/2597624533842234/) + +_Thanks, Walt_H for [sending in](/suggest-community-highlight) this item! 👍_ + +## Live energy consumption screen + +Energy saving is good for the environment (and your wallet). However, to do that, +you have to become aware of your actual usage. `/u/Lau-ie` shared his energy +consumption screen on our [subreddit][reddit]. + +This gives insight into the current usage, but also in the usage & costs of the +consumed energy of the last 24 hours. + +
+
+ Kevin's impressive setup for his 7 aquariums.
+New energyconsumption screen, still tweaking it. from r/homeassistant +
+ + +Do you actively monitor your energy usage? What does your dashboard look like? + +## A DIY smart magnetic key holder + +And here is one from [James Callaghan](https://twitter.com/jamescallaghan), who +created really smart and easy to replicate magnet key holder, using a Xiaomi +Aqara Door/Window sensor. Yes, this key holder works on Zigbee. + +
+ +## Consumer Reports: Open call for non-resident technologist fellows + +Consumer Reports is an American non-profit organization that does independent, +(product) testing and research for consumers to provide truth, transparency and +fairness. Their results are published in a monthly magazine and on their website. + +The Consumer Reports Digital Lab offers paid, non-resident fellowships to study +the effects of connected (IoT) products and services. They welcome anyone +interested in public technology research to apply for the fellowship. + +If you are interested in this, more information can be found here: + +- [Consumer Reports Digital Lab - Fellows](https://digital-lab.consumerreports.org/fellows/) +- [Blog: An open call for non-resident technologist fellows](https://medium.com/cr-digital-lab/coming-soon-an-open-call-for-non-resident-technologist-fellows-95de2f3399fe) + +## Got a tip for the next edition? + +Have you seen (or made) something awesome, interesting, unique, amazing, inspirational, unusual or funny, using Home Assistant? + +[Click here to send us your Community Highlight suggestion](/suggest-community-highlight). + +Also, don't forget to share your creations with us via Social Media: + +- Twitter it! Be sure to mention [@home_assistant][twitter] +- Share it on our [Facebook group][facebook-group] +- Post it to our [subreddit][reddit] +- Tag [@homeasssistant][instagram] on Instagram +- Or via chat, drop us a line in the [#lounge at Discord][chat] + +See you next edition! + +[chat]: https://www.home-assistant.io/join-chat +[facebook-group]: https://www.facebook.com/groups/HomeAssistant/ +[instagram]: https://www.instagram.com/homeassistant/ +[reddit]: https://www.reddit.com/r/homeassistant +[twitter]: https://www.twitter.com/home_assistant diff --git a/source/images/blog/2020-03-15-community-highlights/marine-aquariums.png b/source/images/blog/2020-03-15-community-highlights/marine-aquariums.png new file mode 100644 index 00000000000..e75dc5fbbc8 Binary files /dev/null and b/source/images/blog/2020-03-15-community-highlights/marine-aquariums.png differ diff --git a/source/images/blog/2020-03-15-community-highlights/social.png b/source/images/blog/2020-03-15-community-highlights/social.png new file mode 100644 index 00000000000..49a54df6ef1 Binary files /dev/null and b/source/images/blog/2020-03-15-community-highlights/social.png differMy mind goes crazy at the number of problems a single sensor can solve. For me, this was for reassurance using @****home_assistant**** but when you think how this could be applied elsewhere concierge services to those with memory issues etc.. #smarthome #inclusivity #accessibility #IoT pic.twitter.com/sirygbCE7p
— James Callaghan #Microsoft (@jamescallaghan) March 9, 2020 +
-
- {% active_link /hassio/ Hass.io %}
+ {% active_link /hassio/ Home Assistant %}