diff --git a/Gemfile b/Gemfile index a7def5a3d57..ad87f57237b 100644 --- a/Gemfile +++ b/Gemfile @@ -19,7 +19,7 @@ group :jekyll_plugins do gem 'jekyll-toc', '0.17.1' end -gem 'sinatra', '3.0.1' +gem 'sinatra', '3.0.2' gem 'nokogiri', '1.13.8' # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem diff --git a/Gemfile.lock b/Gemfile.lock index a1f33b89f49..92b16c14161 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -80,7 +80,7 @@ GEM public_suffix (5.0.0) racc (1.6.0) rack (2.2.4) - rack-protection (3.0.1) + rack-protection (3.0.2) rack rake (13.0.6) rb-fsevent (0.11.2) @@ -97,10 +97,10 @@ GEM ffi (~> 1.9) sassc (2.1.0-x64-mingw32) ffi (~> 1.9) - sinatra (3.0.1) + sinatra (3.0.2) mustermann (~> 3.0) rack (~> 2.2, >= 2.2.4) - rack-protection (= 3.0.1) + rack-protection (= 3.0.2) tilt (~> 2.0) stringex (2.8.5) terminal-table (2.0.0) @@ -127,7 +127,7 @@ DEPENDENCIES rake (= 13.0.6) sass-globbing (= 1.1.5) sassc (= 2.1.0) - sinatra (= 3.0.1) + sinatra (= 3.0.2) stringex (= 2.8.5) tzinfo (~> 2.0) tzinfo-data diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown index 1b0c5405cb9..8fd9bd0aecb 100644 --- a/source/_docs/configuration/templating.markdown +++ b/source/_docs/configuration/templating.markdown @@ -75,7 +75,7 @@ Not supported in [limited templates](#limited-templates). - `states('device_tracker.paulus')` will return the state string (not the object) of the given entity, `unknown` if it doesn't exist, `unavailable` if the object exists but is not yet available. - `is_state('device_tracker.paulus', 'home')` will test if the given entity is the specified state. - `state_attr('device_tracker.paulus', 'battery')` will return the value of the attribute or None if it doesn't exist. -- `is_state_attr('device_tracker.paulus', 'battery', 40)` will test if the given entity attribute is the specified state (in this case, a numeric value). Note that the attribute can be `None` and you want to check if it is `None`, you need to use `state_attr('sensor.my_sensor', 'attr') == None`. +- `is_state_attr('device_tracker.paulus', 'battery', 40)` will test if the given entity attribute is the specified state (in this case, a numeric value). Note that the attribute can be `None` and you want to check if it is `None`, you need to use `state_attr('sensor.my_sensor', 'attr') is none` or `state_attr('sensor.my_sensor', 'attr') == None` (note the difference in the capitalization of none in both versions).
Avoid using `states.sensor.temperature.state`, instead use `states('sensor.temperature')`. It is strongly advised to use the `states()`, `is_state()`, `state_attr()` and `is_state_attr()` as much as possible, to avoid errors and error message when the entity isn't ready yet (e.g., during Home Assistant startup). diff --git a/source/_docs/mqtt/discovery.markdown b/source/_docs/mqtt/discovery.markdown index 09892697175..6fa07ef00e7 100644 --- a/source/_docs/mqtt/discovery.markdown +++ b/source/_docs/mqtt/discovery.markdown @@ -329,7 +329,7 @@ The following software has built-in support for MQTT discovery: - [room-assistant](https://github.com/mKeRix/room-assistant) (starting with 1.1.0) - [SmartHome](https://github.com/roncoa/SmartHome) - [Tasmota](https://github.com/arendst/Tasmota) (starting with 5.11.1e, development halted) -- [Teleinfo MQTT](https://fmartinou.github.io/teleinfo-mqtt/) (starting with 3.0.0) +- [Teleinfo MQTT](https://fmartinou.github.io/teleinfo2mqtt) (starting with 3.0.0) - [Tydom2MQTT](https://fmartinou.github.io/tydom2mqtt/) - [What's up Docker?](https://fmartinou.github.io/whats-up-docker/) (starting with 3.5.0) - [WyzeSense2MQTT](https://github.com/raetha/wyzesense2mqtt) diff --git a/source/_docs/scripts.markdown b/source/_docs/scripts.markdown index bd7aa752e95..f0056fb0cbc 100644 --- a/source/_docs/scripts.markdown +++ b/source/_docs/scripts.markdown @@ -95,7 +95,7 @@ Variables can be templated. Variables have local scope. This means that if a variable is changed in a nested sequence block, that change will not be visible in an outer sequence block. -The following example will always say "There are 0 people home". Inside the `if` sequence the `variables` action will only alter the `people` variable for that sequence. +Inside the `if` sequence the `variables` action will only alter the `people` variable for that sequence. {% raw %} @@ -114,11 +114,13 @@ sequence: - variables: people: "{{ people + 1 }}" # At this scope, people will now be 1 ... + - service: notify.notify + data: + message: "There are {{ people }} people home" # "There are 1 people home" # ... but at this scope it will still be 0 - # Announce the count of people home - service: notify.notify data: - message: "There are {{ people }} people home" + message: "There are {{ people }} people home" # "There are 0 people home" ``` {% endraw %} diff --git a/source/_faq/usb_boot.markdown b/source/_faq/usb_boot.markdown index f12de8219f3..faddd59b92d 100644 --- a/source/_faq/usb_boot.markdown +++ b/source/_faq/usb_boot.markdown @@ -9,4 +9,4 @@ Home Assistant offers a data disk feature that offloads all data to an attached Due to the complexity of USB and the USB mass storage device class, booting from a USB device is delicate. When booting from a USB drive this process has to be done multiple times (firmware/boot loader and the operating system), and there is a high chance that it doesn't complete during one of these stages. -That said, booting Home Assistant OS completely from a USB drive (SSD or any other USB mass storage device) works with *some* USB devices. USB Devices that are known to work with Raspberry Pi OS (check the Raspberry Pi Forum) are more likely to work with Home Assistant OS. However, because Home Assistant OS also has U-Boot in the boot chain, there are devices which are known to work with Raspberry Pi OS but do *not* work with Home Assistant OS. Finding the right combination of hardware can require expirimentation. +That said, booting Home Assistant OS completely from a USB drive (SSD or any other USB mass storage device) works with *some* USB devices. USB Devices that are known to work with Raspberry Pi OS (check the Raspberry Pi Forum) are more likely to work with Home Assistant OS. However, because Home Assistant OS also has U-Boot in the boot chain, there are devices which are known to work with Raspberry Pi OS but do *not* work with Home Assistant OS. Finding the right combination of hardware can require experimentation. diff --git a/source/_integrations/august.markdown b/source/_integrations/august.markdown index 066c182a400..1e8db269dc9 100644 --- a/source/_integrations/august.markdown +++ b/source/_integrations/august.markdown @@ -40,6 +40,7 @@ The `august` integration allows you to integrate your [August](https://august.co | August Doorbell Cam (Gen 1, Gen2) | no | | August View | no | | Yale Assure Lock | yes | +| Yale Assure Lock 2 | yes | | Yale Conexis L1 | yes | | Yale Linus | yes | @@ -107,20 +108,20 @@ If you have an August Keypad, once you have enabled the August component, you sh Following Assa Abloy, Yale's parent company, purchasing August in 2017, most newer devices use the Yale Access branding. -The [Yale Access Bluetooth](/integrations/yalexe_ble) provides local control over Bluetooth of many Yale Access locks and some August locks that use the same system. +The [Yale Access Bluetooth](/integrations/yalexs_ble) integration provides local control over Bluetooth of many Yale Access locks and some August locks that use the same system. For locks that support the Yale Access system, the August integration can keep your offline access keys up to date to ensure you can operate your lock over Bluetooth. The following requirements must be met for the offline key updates to work: - The August integration must support the lock. -- The [Yale Access Bluetooth integration](/integrations/yalexe_ble) must support the lock. +- The [Yale Access Bluetooth integration](/integrations/yalexs_ble) must support the lock. - The Bluetooth integration must be active and functional. -- The lock must be discoverable by the [Yale Access Bluetooth integration](/integrations/yalexe_ble). +- The lock must be discoverable by the [Yale Access Bluetooth integration](/integrations/yalexs_ble). - The account logged in with the August integration must have the offline keys. ### Troubleshooting offline keys updates - If you do not know which account has the offline keys, configure August integration with each different Owner account until you find the one that holds the keys. You may need to make a new owner account and grant the account access to your lock to force the keys to synchronize with the cloud service. -- Ensure the lock is in range and discoverable by the [Yale Access Bluetooth integration](/integrations/yalexe_ble). +- Ensure the lock is in range and discoverable by the [Yale Access Bluetooth integration](/integrations/yalexs_ble). ## Presence Detection with Lock Operation diff --git a/source/_integrations/aussie_broadband.markdown b/source/_integrations/aussie_broadband.markdown index 7a9db20a484..6fa2d00d91d 100644 --- a/source/_integrations/aussie_broadband.markdown +++ b/source/_integrations/aussie_broadband.markdown @@ -17,7 +17,7 @@ ha_platforms: ha_integration_type: integration --- -The Aussie Broadband integration displays various service metrics using the [Aussie Broadband API](https://myaussie-api.aussiebroadband.com.au). +The Aussie Broadband integration displays various service metrics using the Aussie Broadband API. ## Prerequisites diff --git a/source/_integrations/bayesian.markdown b/source/_integrations/bayesian.markdown index 781c4d2f6f4..d2adc35eadc 100644 --- a/source/_integrations/bayesian.markdown +++ b/source/_integrations/bayesian.markdown @@ -33,7 +33,7 @@ In the configuration use the probability of the observation (the sensor state in 4. Use your Home Assistant history to help estimate the probabilities. - `prob_given_true:` - Select the sensor in question over a time range when you think the `bayesian` sensor should have been `true`. `prob_given_true:` is the fraction of the time the sensor was in `to_state:`. - `prob_given_false:` - Select the sensor in question over a time range when you think the `bayesian` sensor should have been `false`. `prob_given_false:` is the fraction of the time the sensor was in `to_state:`. -5. Don't work backwards by tweaking `prob_given_true:` and `prob_given_false:` to give the results and behaviors you want, use #4 to try and get probabilities as close to the 'truth' as you can, if your behavior is not as expected consider adding more sensors or see #7. +5. Don't work backwards by tweaking `prob_given_true:` and `prob_given_false:` to give the results and behaviors you want, use #4 to try and get probabilities as close to the 'truth' as you can, if your behavior is not as expected consider adding more sensors or see #6. 6. If your Bayesian sensor ends up triggering `on` too easily, re-check that the probabilities set and estimated make sense, then consider increasing `probability_threshold:` and vice-versa. ## Configuration @@ -103,7 +103,7 @@ observations: required: true type: float prob_given_false: - description: Assuming the bayesian binary_sensor is `false` the probability of this entity state is occurring. + description: Assuming the bayesian binary_sensor is `false` the probability the entity state is occurring. required: true type: float {% endconfiguration %} @@ -124,12 +124,12 @@ binary_sensor: entity_id: "sensor.living_room_motion" prob_given_true: 0.05 # If I am in bed then I shouldn't be in the living room, very occasionally I have guests, however prob_given_false: 0.2 # My sensor history shows If I am not in bed I spend about a fifth of my time in the living room - to_state: "off" + to_state: "on" - platform: "state" entity_id: "sensor.basement_motion" prob_given_true: 0.5 # My sensor history shows, when I am in bed, my basement motion sensor is active about half the time because of my cat prob_given_false: 0.3 # As above but my cat tends to spend more time upstairs or outside when I am awake and I rarely use the basement - to_state: "off" + to_state: "on" - platform: "state" entity_id: "sensor.bedroom_motion" prob_given_true: 0.5 # My sensor history shows when I am in bed the sensor picks me up about half the time @@ -138,6 +138,7 @@ binary_sensor: - platform: "state" entity_id: "sun.sun" prob_given_true: 0.7 # If I am in bed then there is a good chance the sun will be down, but in the summer mornings I may still be in bed + prob_given_false: 0.45 # If I am am awake then there is a reasonable chance the sun will be below the horizon - especially in winter to_state: "below_horizon" - platform: "state" entity_id: "sensor.android_charger_type" diff --git a/source/_integrations/binary_sensor.rest.markdown b/source/_integrations/binary_sensor.rest.markdown index 6e74ad12d7d..bb03c7c15b5 100644 --- a/source/_integrations/binary_sensor.rest.markdown +++ b/source/_integrations/binary_sensor.rest.markdown @@ -58,7 +58,7 @@ or a template based request: ```yaml # Example configuration.yaml entry -sensor: +binary_sensor: - platform: rest resource_template: "http://IP_ADDRESS/{{ now().strftime('%Y-%m-%d') }}" ``` @@ -99,6 +99,10 @@ payload: description: The payload to send with a POST request. Usually formed as a dictionary. required: false type: string +unique_id: + description: An ID that uniquely identifies this entity. This allows changing the `name`, `icon` and `entity_id` from the web interface. + required: false + type: string verify_ssl: description: Verify the certification of the endpoint. required: false diff --git a/source/_integrations/bluetooth.markdown b/source/_integrations/bluetooth.markdown index e20ab3d36a0..b7ae7314c9a 100644 --- a/source/_integrations/bluetooth.markdown +++ b/source/_integrations/bluetooth.markdown @@ -50,6 +50,13 @@ For Bluetooth to function on Linux systems: For most systems, the Dbus socket is in `/run/dbus`. The socket must be available in the container for Home Assistant to be able to connect to Dbus and access the Bluetooth adapter. When starting with `docker run`, this can be accomplished by adding `-v /run/dbus:/run/dbus:ro` to the command. If the Dbus socket is in `/var/run/dbus` on the host system, use `-v /var/run/dbus:/run/dbus:ro` instead. +If you are using Docker Compose, add something like the following (adjust as necessary) to your `volumes` section: + +```dockerfile +volumes: + - /run/dbus:/run/dbus:ro +``` + {% enddetails %} {% details Switching from dbus-daemon to dbus-broker %} diff --git a/source/_integrations/dlink.markdown b/source/_integrations/dlink.markdown index edf137690b6..e604a87b619 100644 --- a/source/_integrations/dlink.markdown +++ b/source/_integrations/dlink.markdown @@ -11,7 +11,7 @@ ha_platforms: ha_integration_type: integration --- -The `dlink` switch platform allows you to control the state of your [D-Link Wi-Fi Smart Plugs](https://us.dlink.com/en/consumer/smart-plugs). +The `dlink` switch platform allows you to control the state of your [D-Link Wi-Fi Smart Plugs](https://us.dlink.com/en/consumer/smart-home). Supported devices (tested): diff --git a/source/_integrations/entur_public_transport.markdown b/source/_integrations/entur_public_transport.markdown index c35580a1d5b..69877d2353a 100644 --- a/source/_integrations/entur_public_transport.markdown +++ b/source/_integrations/entur_public_transport.markdown @@ -17,7 +17,7 @@ The `entur_public_transport` sensor gives real-time departure information for th For each stop place given in the configuration, a sensor will be mounted for that stop place. It will give remaining minutes until the nearest departure in the state, but also next departures in the attributes. Information about if the departure is monitored in real-time or is from scheduled times, and how many minutes there is in delays, are included as well. -Real-time data is fetched from [Entur](https://www.entur.org). Entur is a service which collects and delivers information about all public transport available in Norway under an [open source license](https://data.norge.no/nlod/no). +Real-time data is fetched from [Entur](https://www.entur.no). Entur is a service which collects and delivers information about all public transport available in Norway under an [open source license](https://data.norge.no/nlod/no).
Note that the underlying API is rate limited and to avoid getting your instance blocked from entur the sensor is only fetching new information every 45 seconds. It's recommended to not schedule updates more often than this. @@ -108,11 +108,11 @@ sensor: ## Obtaining a stop id -[Entur's travel planer](https://en-tur.no) has a map of all stops used in Norway. Use the map to find the stops you're interested in. When you have found one of your stops, click on it. +[Entur's travel planer](https://entur.no) has a map of all stops used in Norway. Use the map to find the stops you're interested in. When you have found one of your stops, click on it. Now the web browser should contain a URL with the id in it. Such as this: -`https://en-tur.no/nearby-stop-place-detail?id=NSR:StopPlace:32376` +`https://entur.no/nearby-stop-place-detail?id=NSR:StopPlace:32376` The stop id is the content after `id=` parameter in the URL. Copy paste this into the configuration. diff --git a/source/_integrations/environment_canada.markdown b/source/_integrations/environment_canada.markdown index dda4f393227..5beb67e31a1 100644 --- a/source/_integrations/environment_canada.markdown +++ b/source/_integrations/environment_canada.markdown @@ -29,22 +29,20 @@ The integration automatically determines the closest weather station based on th You can also specify a weather station to use by providing a identification code of the form `AB/s0000123`, based on those listed in [this CSV file](https://dd.weather.gc.ca/citypage_weather/docs/site_list_towns_en.csv). +Note that not all weather stations provide a complete set of data weather/sensor data. The data that is retrieved by this integration can be found [here](https://dd.weather.gc.ca/citypage_weather/xml/). Browsing the XML data for your station will help understand what data is available. + ## Entities -The integration will create the entities listed below. - -Note that many of the entities, such as radar imagery and hourly forecasts, are disabled by default and can be enabled via the Entity status settings available through the Configuration / Entities screen. +The integration will create the entities listed below. Some of the entities are disabled by default and can be enabled via the integration's Entities page. ### Weather - Current conditions and daily forecast -- Current conditions and hourly forecast +- Current conditions and hourly forecast (disabled by default) ### Camera -- Loop of radar imagery from the last 3 hours - -By default, the radar entity uses the rain layer from 1 April to 30 November and the snow layer from 1 December to 31 March. +- Loop of radar imagery from the last 3 hours (disabled by default). Also, by default this entity uses the radar rain layer from 1 April to 30 November and the snow layer from 1 December to 31 March. The rain/snow layer can be changed using the service described below. ### Sensors @@ -58,6 +56,7 @@ By default, the radar entity uses the rain layer from 1 April to 30 November and - Humidity - Visibility - UV index +- Air Quality (AQHI) #### Temperature diff --git a/source/_integrations/flux_led.markdown b/source/_integrations/flux_led.markdown index 2eb1d2360e4..0e28bc21b0e 100644 --- a/source/_integrations/flux_led.markdown +++ b/source/_integrations/flux_led.markdown @@ -110,7 +110,7 @@ These devices have been sold under at least the following brands: - Mowelai - Nexlux - OBSESS -- [Offdarks](http://offdarks.net) +- Offdarks - PH LED - PHOPOLLO - [Pin Stadium Pinball Lights](https://pinstadium.com/) diff --git a/source/_integrations/forecast_solar.markdown b/source/_integrations/forecast_solar.markdown index 8bdf54eb6fa..a7cc29abf52 100644 --- a/source/_integrations/forecast_solar.markdown +++ b/source/_integrations/forecast_solar.markdown @@ -35,7 +35,7 @@ As an example automation idea, you could determine if: ## Prerequisites -Forecast.Solar relies on data provided by the [EU Photovoltaic geographical information system](https://re.jrc.ec.europa.eu/pvg_tools/en/tools.html) and your solar panels must be in a location that is covered by this tool. Data is currently not available for most of the Asia Pacific region. +Forecast.Solar relies on data provided by the [EU Photovoltaic geographical information system](https://re.jrc.ec.europa.eu/pvg_tools/en/tools.html) and your solar panels must be in a location that is covered by this tool. Data is available for almost the entire world. To use the Forecast.Solar integration, it will need some information about your solar panel system: **latitude**, **longitude**, **declination**, **azimuth** diff --git a/source/_integrations/github.markdown b/source/_integrations/github.markdown index b87ed9c6720..fc1cabf2ccb 100644 --- a/source/_integrations/github.markdown +++ b/source/_integrations/github.markdown @@ -16,24 +16,152 @@ ha_codeowners: ha_integration_type: integration --- -The GitHub integration allows you to monitor your favorite [GitHub][github] repositories. +The GitHub integration allows you to monitor your favorite [GitHub](https://github.com/) repositories. {% include integrations/config_flow.md %} -When you set up this integration, you will first be guided to allow the integration to use the [GitHub API][github_api] on your behalf. If you do not yet have a [GitHub][github] account you will be prompted to create one during the configuration of the integration. +When you set up this integration, you will first be guided to allow the integration to use the [GitHub API](https://docs.github.com/en/rest) on your behalf. If you do not yet have a [GitHub](https://github.com/) account you will be prompted to create one during the configuration of the integration. -When you have authorized the integration, you select repositories you want to monitor, the list contains repositories you have created and [starred][github_starred] on GitHub with your account. +When you have authorized the integration, you select repositories you want to monitor, the list contains repositories you have created and [starred](https://github.com/stars) on GitHub with your account. + +The integration works by subscribing to events on the repository to provide a push-like experience for the entities, which means that when a new issue is created or when someone open up a pull request with some fixes or when that new release you have been waiting for just got released this integration will help you get the information as soon as it happens. ## Remove authorization After you have removed the integration from {% my integrations title="Settings -> Devices & Services" %}, you need to manually revoke OAuth app authorization. -1. Go to your [Authorized OAuth Apps][github_apps] +1. Go to your [Authorized OAuth Apps](https://github.com/settings/applications) 2. Find the "Home Assistant GitHub Integration" application 3. Click the 3 dots (`...`) to the right of the name 4. Select "Revoke" -[github]: https://github.com/ -[github_api]: https://docs.github.com/en/rest -[github_starred]: https://github.com/stars -[github_apps]: https://github.com/settings/applications +## Service + +When you configure a repository to be tracked in this integration it will be represented as a service in the device panel and all entities related to the repository will be nested under that device. The device also provides a link to the repository on GitHub and an option to download [diagnostics](/integrations/diagnostics) for the service. + + + + +

+ + +## Provided entities + +### Latest commit + +This sensor shows the message of the latest commit done in the default branch as +the state. + +The sensor provides additional attributes for the latest commit: + +- `sha`: The SHA for the commit +- `url`: A URL that will show you the commit on GitHub + +### Latest discussion + +This sensor shows the title of the latest discussion that was created as the state. + +The sensor provides additional attributes for the latest discussion: + +- `number`: The numerical ID that discussion was assigned +- `url`: A URL that will show you the discussion on GitHub + +### Latest issue + +This sensor shows the title of the latest issue that was created as the state. + +The sensor provides additional attributes for the latest issue: + +- `number`: The numerical ID that issue was assigned +- `url`: A URL that will show you the issue on GitHub + +### Latest pull request + +This sensor shows the title of the latest pull request that was created as the state. + +The sensor provides additional attributes for the latest pull request: + +- `number`: The numerical ID that pull request was assigned +- `url`: A URL that will show you the pull request on GitHub + +### Latest release + +This sensor shows the title of the latest release that was created in the repository. + +The sensor provides additional attributes for the latest release: + +- `tag`: The tag name that the release is created for +- `url`: A URL that will show you the release on GitHub + +### Latest tag + +This sensor shows the title of the latest tag that was created in the repository. + +The sensor provides additional attributes for the latest tag: + +- `url`: A URL that will show you the commit the tag was created for on GitHub + +### Diagnostic entities + +These entities are simpler diagnostic entities without any additional attributes: + +- **Discussions**: Shows the number of discussions +- **Forks**: Shows the number of forks +- **Issues**: Shows the number of open issues +- **Pull requests**: Shows the number of open pull requests +- **Stars**: Shows the number of stars +- **Watchers**: Shows the number of watchers + +## Automation + +Here are some small examples on how you can automate using the provided entities from this integration. + +

+ +Remember that the service names and entity IDs used in these examples are examples as well, +you need to replace it with services and entities that you have in your installation. + +
+ +### Notify new releases + +This example uses the [Latest release](#latest-release) entity provided by this integration, and a [notify](/integrations/notify) service, + +{% raw %} + +```yaml +trigger: + - platform: state + entity_id: sensor.awesome_repository_latest_release +action: + - service: notify.notify + data: + title: "New github/repository release" + message: >- + Link to the new release: + https://github.com/github/repository/releases/{{ trigger.to_state.state }} + +``` + +{% endraw %} + +### Notify new stars + +This example uses the [Stars](#diagnostic-entities) diagnostic entity provided by this integration, and a [notify](/integrations/notify) service, + +{% raw %} + +```yaml +trigger: + - platform: state + entity_id: sensor.awesome_repository_stars +action: + - service: notify.notify + data: + title: "New github/repository new star" + message: >- + github/repository was starred again! + Total stars are now: {{ trigger.to_state.state }} +``` + +{% endraw %} diff --git a/source/_integrations/google.markdown b/source/_integrations/google.markdown index 217fc49c960..34293376d7a 100644 --- a/source/_integrations/google.markdown +++ b/source/_integrations/google.markdown @@ -135,6 +135,8 @@ This will only be available if you have given Home Assistant `read-write` access
+A calendar `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields: + | Service data attribute | Optional | Description | Example | | ---------------------- | -------- | ----------- | --------| | `summary` | no | Acts as the title of the event. | Bowling @@ -151,6 +153,18 @@ You either use `start_date_time` and `end_date_time`, or `start_date` and `end_d
+This is a full example of service call in YAML: + +```yaml +service: google.create_event +target: + entity_id: calendar.device_automation_schedules +data: + summary: "Example" + start_date: "2022-10-1" + end_date: "2022-10-2" +``` + {% enddetails %} ## More Configuration diff --git a/source/_integrations/google_assistant.markdown b/source/_integrations/google_assistant.markdown index 3740b33a15b..ec1576277a2 100644 --- a/source/_integrations/google_assistant.markdown +++ b/source/_integrations/google_assistant.markdown @@ -94,7 +94,7 @@ If you want to allow other household users to control the devices: If you want to support active reporting of state to Google's server (configuration option `report_state`) and synchronize Home Assistant devices with the Google Home app (`google_assistant.request_sync` service), you will need to create a service account. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have set up this component, you will need to call this service (or command) each time you add a new device in Home Assistant that you wish to control via the Google Assistant integration. This allows you to update devices without unlinking and relinking an account (see [below](#troubleshooting)). 1. Service Account - 1. In the Google Cloud Platform Console, go to the [Create Service account key](https://console.cloud.google.com/apis/credentials/serviceaccountkey) page. + 1. In the Google Cloud Platform Console, go to the [Create Service account key](https://console.cloud.google.com/iam-admin/serviceaccounts/create) page. 2. At the top left of the page next to "Google Cloud Platform" logo, select your project created in the Actions on Google console. Confirm this by reviewing the project ID and it ensure it matches. 3. From the Service account list, select `CREATE SERVICE ACCOUNT`. 4. In the Service account name field, enter a name. @@ -279,6 +279,12 @@ For the Alarm Control Panel if a code is set it must be the same as the `secure_ Entities that have not been explicitly assigned to rooms but have been placed in Home Assistant areas will return room hints to Google with the devices in those areas. +
+ +Some devices, such as `scene` or `script`, must be assigned to an `area` before other members of a shared Google Home Household can use them. This is because household members in a shared Google Home will not be able to view devices that are not assigned to a room _unless_ they were the user who linked the service to Google Home. This issue isn't immediately apparent because `script` and `scene` devices aren't visible in the main Google Home dashboard. + +
+ ### Climate Operation Modes There is not an exact 1-1 match between Home Assistant and Google Assistant for the available operation modes. diff --git a/source/_integrations/group.markdown b/source/_integrations/group.markdown index 3c6c1fa7518..6e256132c3c 100644 --- a/source/_integrations/group.markdown +++ b/source/_integrations/group.markdown @@ -112,7 +112,7 @@ To add or remove entities from an existing group, click on `Group options`, all ## YAML Configuration -Alternatlively, this integration can be configured and set up manually via YAML +Alternatively, this integration can be configured and set up manually via YAML instead. Here are example of how to configure groups when using the `configuration.yaml` file. Example YAML configuration of a binary sensor group: diff --git a/source/_integrations/hunterdouglas_powerview.markdown b/source/_integrations/hunterdouglas_powerview.markdown index 4a7f8c1ddc2..71a968f9428 100644 --- a/source/_integrations/hunterdouglas_powerview.markdown +++ b/source/_integrations/hunterdouglas_powerview.markdown @@ -26,7 +26,7 @@ ha_dhcp: true ha_integration_type: integration --- -The `hunterdouglas_powerview` integration allows you to integrate your [Hunter Douglas PowerView](https://www.hunterdouglas.com/operating-systems/powerview-motorization/support) devices in Home Assistant. The product is also known by the brand name Luxaflex Powerview in Europe and Australia [as explained on their website](https://www.hunterdouglasgroup.com/company/brands-in-action/), however this integration should work for both brands. +The `hunterdouglas_powerview` integration allows you to integrate your [Hunter Douglas PowerView](https://help.hunterdouglas.com/s/?tabset-9157f=849ff) devices in Home Assistant. The product is also known by the brand name Luxaflex Powerview in Europe and Australia [as explained on their website](https://www.hunterdouglasgroup.com/company/brands-in-action/), however this integration should work for both brands. There is currently support for the following device types within Home Assistant: diff --git a/source/_integrations/insteon.markdown b/source/_integrations/insteon.markdown index 9b8ca83dffd..bfa1fc9480c 100644 --- a/source/_integrations/insteon.markdown +++ b/source/_integrations/insteon.markdown @@ -43,7 +43,7 @@ Overview of supported Insteon modems & hubs [pyinsteon]: https://github.com/pyinsteon/pyinsteon [2413U]: https://www.insteon.com/powerlinc-modem-usb [2412S]: https://www.insteon.com/powerlinc-modem-serial -[2448A7]: https://www.smarthome.com/insteon-2448a7-portable-usb-adapter.html +[2448A7]: https://www.insteon.com/support-knowledgebase/2014/12/10/usb-wireless-adapter-quick-start-guide [2245]: https://www.insteon.com/insteon-hub/ [2242]: https://www.insteon.com/support-knowledgebase/2014/9/26/insteon-hub-owners-manual diff --git a/source/_integrations/knx.markdown b/source/_integrations/knx.markdown index 94d75a1bfbe..ba10dfebaf2 100644 --- a/source/_integrations/knx.markdown +++ b/source/_integrations/knx.markdown @@ -624,11 +624,11 @@ The following values are valid for the Home Assistant [Climate](/integrations/cl The following presets are valid for the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute. Supported values for your KNX thermostats can be specified via `operation_modes` configuration variable: -- `Auto` (maps internally to `PRESET_NONE` within Home Assistant) -- `Comfort` (maps internally to `PRESET_COMFORT` within Home Assistant) -- `Standby` (maps internally to `PRESET_AWAY` within Home Assistant) -- `Night` (maps internally to `PRESET_SLEEP` within Home Assistant) -- `Frost` Protection (maps internally to `PRESET_ECO` within Home Assistant) +- `Auto` (maps to `none` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute) +- `Comfort` (maps to `comfort` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute) +- `Standby` (maps to `away` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute) +- `Night` (maps to `sleep` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute) +- `Frost Protection` (maps to `eco` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute) {% configuration %} name: diff --git a/source/_integrations/lacrosse_view.markdown b/source/_integrations/lacrosse_view.markdown index 6eebf42513f..87776173bb5 100644 --- a/source/_integrations/lacrosse_view.markdown +++ b/source/_integrations/lacrosse_view.markdown @@ -16,6 +16,8 @@ ha_integration_type: integration [**LaCrosse View**](https://www.lacrossetechnology.com/pages/la-crosse-view) is the service provided by LaCrosse Technology that allows access to LaCrosse sensors. +It is also available in Europe as [**TFA View**](https://www.tfa-dostmann.de/en/produkte/weather-stations/wifi-weather-stations/). +
If you are looking for an integration for [**Jeelink LaCrosse sensors**](/integrations/lacrosse), you can find that integration [**here**](/integrations/lacrosse). diff --git a/source/_integrations/light.markdown b/source/_integrations/light.markdown index 6fc536df7be..f5c5e864f46 100644 --- a/source/_integrations/light.markdown +++ b/source/_integrations/light.markdown @@ -45,7 +45,7 @@ Most lights do not support all attributes. You can check the integration documen | `transition` | yes | Number that represents the time (in seconds) the light should take to transition to the new state. | `profile` | yes | String with the name of one of the [built-in profiles](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/light/light_profiles.csv) (relax, energize, concentrate, reading) or one of the custom profiles defined in `light_profiles.csv` in the current working directory. Light profiles define an xy color, brightness and a transition value (if no transition is desired, set to 0 or leave out the column entirely). If a profile is given, and a brightness is set, then the profile brightness will be overwritten. | `hs_color` | yes | A list containing two floats representing the hue and saturation of the color you want the light to be. Hue is scaled 0-360, and saturation is scaled 0-100. -| `xy_color` | yes | A list containing two floats representing the xy color you want the light to be. Two comma-separated floats that represent the color in XY. You can find a great chart here: [Hue Color Chart](https://developers.meethue.com/documentation/core-concepts#color_gets_more_complicated). +| `xy_color` | yes | A list containing two floats representing the xy color you want the light to be. Two comma-separated floats that represent the color in XY. | `rgb_color` | yes | A list containing three integers between 0 and 255 representing the RGB color you want the light to be. Three comma-separated integers that represent the color in RGB, within square brackets. | `rgbw_color` | yes | A list containing four integers between 0 and 255 representing the RGBW color you want the light to be. Four comma-separated integers that represent the color in RGBW (red, green, blue, white), within square brackets. This attribute will be ignored by lights which do not support RGBW colors. | `rgbww_color` | yes | A list containing five integers between 0 and 255 representing the RGBWW color you want the light to be. Five comma-separated integers that represent the color in RGBWW (red, green, blue, cold white, warm white), within square brackets. This attribute will be ignored by lights which do not support RGBWW colors. diff --git a/source/_integrations/mqtt.markdown b/source/_integrations/mqtt.markdown index 5d00203ceab..bded17ba423 100644 --- a/source/_integrations/mqtt.markdown +++ b/source/_integrations/mqtt.markdown @@ -38,8 +38,7 @@ Your first step to get MQTT and Home Assistant working is to choose a [broker](/ ### Advanced broker configuration -Some broker configuration options can't be set via the user interface, but require changes of your `configuration.yaml` file. -This includes configuring SSL [certificate](/docs/mqtt/certificate/) options. +Some broker configuration options can't be set via the user interface, but require changes to your `configuration.yaml` file. See [advanced broker configuration](/docs/mqtt/broker/#advanced-broker-configuration) for all configuration variables. ## Additional features diff --git a/source/_integrations/overkiz.markdown b/source/_integrations/overkiz.markdown index c5f2de20f57..e895f88ffdd 100644 --- a/source/_integrations/overkiz.markdown +++ b/source/_integrations/overkiz.markdown @@ -87,4 +87,4 @@ Another option if you are only using Somfy IO compatible devices is to purchase #### Local API via HomeKit Controller -If your hub (e.g. Somfy TaHoma) supports HomeKit natively, your setup code will be added as a sensor in Home Assistant. Look up your hub in Home Assistant and retrieve the value from the 'HomeKit Setup Code' sensor. You can now configure the [HomeKit Controller](/integrations/homekit_controller/) integration in Home Assistant and benefit from local support. Only a [limited amount of devices is supported](https://service.somfy.com/downloads/nl_v5/tahoma-homekitcompatibilitylist_eng.pdf). +If your hub (e.g. Somfy TaHoma) supports HomeKit natively, your setup code will be added as a sensor in Home Assistant. Look up your hub in Home Assistant and retrieve the value from the 'HomeKit Setup Code' sensor. You can now configure the [HomeKit Controller](/integrations/homekit_controller/) integration in Home Assistant and benefit from local support. Only a [limited set of devices is supported](https://service.somfy.com/downloads/nl_v5/tahoma-homekitcompatibilitylist_eng.pdf). diff --git a/source/_integrations/plaato.markdown b/source/_integrations/plaato.markdown index eeecd27f457..093a25fd407 100644 --- a/source/_integrations/plaato.markdown +++ b/source/_integrations/plaato.markdown @@ -43,6 +43,6 @@ To be able to query the API an `auth_token` is required which can be obtained by ### Webhook (Airlock only) The configuration step will give you the webhook URL to use in the PLAATO mobile app. It should be pasted in configuration on the tab "Webhook". -More information can be found [here](https://plaato.io/apps/help-center#!hc-general). +More information can be found [here](https://intercom.help/plaato/en/articles/5004719-webhook-plaato-airlock). This sensor platform was not made by Plaato. It is not official, not developed, and not supported by Plaato. diff --git a/source/_integrations/powerwall.markdown b/source/_integrations/powerwall.markdown index abd64e67d50..dfe91bea7e4 100644 --- a/source/_integrations/powerwall.markdown +++ b/source/_integrations/powerwall.markdown @@ -67,5 +67,5 @@ The following sensors show the direction of energy: ### Device Info -- Model number: PowerWall 2 (GW2) by Tesla +- Model Number - Firmware Revision diff --git a/source/_integrations/qld_bushfire.markdown b/source/_integrations/qld_bushfire.markdown index b4b42bf1be8..e95c5db4514 100644 --- a/source/_integrations/qld_bushfire.markdown +++ b/source/_integrations/qld_bushfire.markdown @@ -14,8 +14,7 @@ ha_integration_type: integration --- The `qld_bushfire` platform lets you integrate a -[GeoRSS feed](https://www.ruralfire.qld.gov.au/map/Pages/default.aspx) -containing bushfire alerts for Queensland. It retrieves alerts from a feed +GeoRSS feed containing [bushfire alerts](https://www.qfes.qld.gov.au/Current-Incidents) for Queensland. It retrieves alerts from a feed and shows information of those alerts filtered by distance to Home Assistant's location. diff --git a/source/_integrations/rest.markdown b/source/_integrations/rest.markdown index 706722ff966..18133c729eb 100644 --- a/source/_integrations/rest.markdown +++ b/source/_integrations/rest.markdown @@ -1,6 +1,6 @@ --- -title: RESTful -description: Instructions on how to set up rest sensors within Home Assistant. +title: "RESTful" +description: "Instructions on how to integrate REST sensors and binary sensors into Home Assistant." ha_category: - Binary Sensor - Sensor @@ -17,7 +17,7 @@ ha_integration_type: integration The `rest` sensor platform is consuming a given endpoint which is exposed by a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) of a device, an application, or a web service. The sensor has support for GET and POST requests. -[RESTful Sensor](/integrations/sensor.rest) and [RESTful Binary_sensor](/integrations/binary_sensor.rest) can also be set up as platforms if there is only a single sensor per endpoint. +[RESTful Sensor](/integrations/sensor.rest) and [RESTful Binary Sensor](/integrations/binary_sensor.rest) can also be set up as platforms if there is only a single sensor per endpoint. ```yaml # Example configuration.yaml entry @@ -163,11 +163,11 @@ scan_interval: type: integer default: 30 sensor: - description: A list of [RESTful Sensor](/integrations/sensor.rest) to create from the shared data. All configuration settings that the supported by [RESTful Sensor](/integrations/sensor.rest#configuration-variables) not listed above can be used here. + description: A list of sensors to create from the shared data. All configuration settings that are supported by [RESTful Sensor](/integrations/sensor.rest#configuration-variables) not listed above can be used here. required: false type: list binary_sensor: - description: A list of [RESTful Binary_sensor](/integrations/binary_sensor.rest) to create from the shared data All configuration settings that the supported by [RESTful Binary_sensor](/integrations/binary_sensor.rest#configuration-variables) not listed above can be used here. + description: A list of binary sensors to create from the shared data. All configuration settings that are supported by [RESTful Binary Sensor](/integrations/binary_sensor.rest#configuration-variables) not listed above can be used here. required: false type: list {% endconfiguration %} diff --git a/source/_integrations/tibber.markdown b/source/_integrations/tibber.markdown index 8ba2eebf8b3..87be40a5b62 100644 --- a/source/_integrations/tibber.markdown +++ b/source/_integrations/tibber.markdown @@ -20,7 +20,7 @@ ha_integration_type: integration --- The `tibber` integration provides a sensor with the current electricity price if you are a [Tibber](https://tibber.com/) customer. -If you have a [Tibber Pulse](https://norge.tibber.com/products/pulse/) or [Watty](https://tibber.com/se/store/produkt/watty-smart-energimatare) it will also show the electricity consumption in real-time. You get a sensor for monthly consumption, monthly cost, and monthly peak hour. If you do have a real-time meter it is updated once every hour, otherwise it is updated once per day. Statistics with hourly consumption and cost data is generated that can be used in the [Energy Dashboard](/docs/energy/) (the ids are `tibber:energy_consumption_HOMEID` and `tibber:energy_totalcost_HOMEID`). If you produce energy there are also statistics with hourly production and profit data generated which can also be used there (the ids are `tibber:energy_production_HOMEID` and `tibber:energy_profit_HOMEID`). +If you have a [Tibber Pulse](https://tibber.com/no/store/produkt/pulse) or [Watty](https://tibber.com/se/store/produkt/watty-smart-energimatare) it will also show the electricity consumption in real-time. You get a sensor for monthly consumption, monthly cost, and monthly peak hour. If you do have a real-time meter it is updated once every hour, otherwise it is updated once per day. Statistics with hourly consumption and cost data is generated that can be used in the [Energy Dashboard](/docs/energy/) (the ids are `tibber:energy_consumption_HOMEID` and `tibber:energy_totalcost_HOMEID`). If you produce energy there are also statistics with hourly production and profit data generated which can also be used there (the ids are `tibber:energy_production_HOMEID` and `tibber:energy_profit_HOMEID`). There is currently support for the following device types within Home Assistant: diff --git a/source/_integrations/timer.markdown b/source/_integrations/timer.markdown index d8002cb77cd..3bcf43802fb 100644 --- a/source/_integrations/timer.markdown +++ b/source/_integrations/timer.markdown @@ -12,7 +12,7 @@ ha_integration_type: helper The `timer` integration aims to simplify automations based on (dynamic) durations. -When a timer finishes or gets canceled the corresponding events are fired. This allows you to differentiate if a timer has switched from `active` to `idle` because the given duration has elapsed or it has been canceled. To control timers in your automations you can use the services mentioned below. When calling the `start` service on a timer that is already running, it resets the duration it will need to finish and restart the timer without triggering a canceled or finished event. This, for example, makes it easy to create timed lights that get triggered by motion. Starting a timer triggers a started event unless the timer is paused, in that case, it triggers a restarted event. +When a timer finishes or gets canceled the corresponding events are fired. This allows you to differentiate if a timer has switched from `active` to `idle` because the given duration has elapsed or it has been canceled. To control timers in your automations you can use the services mentioned below. When calling the `start` service on a timer that is already running, it resets the duration it will need to finish and restarts the timer without triggering a canceled or finished event. This, for example, makes it easy to create timed lights that get triggered by motion. Starting a timer triggers a started event unless the timer is paused, in that case, it triggers a restarted event. ## Configuration diff --git a/source/_integrations/touchline.markdown b/source/_integrations/touchline.markdown index f1b23a1a0db..1dcf6aa8b69 100644 --- a/source/_integrations/touchline.markdown +++ b/source/_integrations/touchline.markdown @@ -11,7 +11,7 @@ ha_platforms: ha_integration_type: integration --- -The `touchline` climate platform let you control [ROTH Touchline](https://www.roth-danmark.dk/dk/roth-touchline-3092.htm) floor heating thermostats from Roth. +The `touchline` climate platform let you control [ROTH Touchline](https://www.roth-uk.com/en/roth-touchline.htm) floor heating thermostats from Roth. To set it up, add the following information to your `configuration.yaml` file: diff --git a/source/_integrations/uk_transport.markdown b/source/_integrations/uk_transport.markdown index 1220993ff54..0519fb0e7f0 100644 --- a/source/_integrations/uk_transport.markdown +++ b/source/_integrations/uk_transport.markdown @@ -11,7 +11,7 @@ ha_platforms: ha_integration_type: integration --- -The `uk_transport` sensor will display the time in minutes until the next departure in a specified direction from of a configured train station or bus stop. The sensor uses [transportAPI](https://www.transportapi.com/) to query live departure data and requires a developer application ID and key which can be obtained [here](https://developer.transportapi.com/). The [free tier]([https://www.transportapi.com/benefits/](https://www.transportapi.com/blog/2022/08/introducing-the-home-use-plan-for-transportapi/)) allows 30 requests a day, which is sufficient for a single sensor refreshing every 48 minutes. +The `uk_transport` sensor will display the time in minutes until the next departure in a specified direction from of a configured train station or bus stop. The sensor uses [transportAPI](https://www.transportapi.com/) to query live departure data and requires a developer application ID and key which can be obtained [here](https://developer.transportapi.com/). The [free tier](https://www.transportapi.com/blog/2022/08/introducing-the-home-use-plan-for-transportapi/) allows 30 requests a day, which is sufficient for a single sensor refreshing every 48 minutes.
diff --git a/source/_integrations/upnp.markdown b/source/_integrations/upnp.markdown index 9cf224054b0..5f6b4336c15 100644 --- a/source/_integrations/upnp.markdown +++ b/source/_integrations/upnp.markdown @@ -30,11 +30,17 @@ Please note that UPnP or NAT-PMP needs to be enabled on your router for this int {% include integrations/config_flow.md %} -## Manual configuration +## Debugging integration -Alternatively, you can use YAML by adding the following section to your `configuration.yaml` file: +If you have problems with this integration you can add debug prints to the log. ```yaml -# Example configuration.yaml entry -upnp: +logger: + default: info + logs: + homeassistant.components.upnp: debug + async_upnp_client: debug + async_upnp_client.traffic: error ``` + +When creating an issue, please include the (relevant) logging with the issue. Any sensitive information such as IPs can be obfuscated. diff --git a/source/_integrations/xiaomi_ble.markdown b/source/_integrations/xiaomi_ble.markdown index 767df7fa920..f38dc3bd8ec 100644 --- a/source/_integrations/xiaomi_ble.markdown +++ b/source/_integrations/xiaomi_ble.markdown @@ -44,6 +44,8 @@ It also supports the following classes of binary sensors: - Smoke - Moisture +The entities for the sensor classes are added after the values are first received. This means entities for values that are broadcasted at a lower interval (e.g., battery) might show up later. + ## Encryption Some devices use AES encryption to protect the sensor values they are broadcasting. diff --git a/source/_integrations/yalexs_ble.markdown b/source/_integrations/yalexs_ble.markdown index 6d4e24de8ce..5c5d5796bcf 100644 --- a/source/_integrations/yalexs_ble.markdown +++ b/source/_integrations/yalexs_ble.markdown @@ -34,6 +34,8 @@ Devices must have a Yale Access module installed to function with this integrati - YRD226 (Yale Assure Lock Touchscreen Deadbolt with Physical Key) - YRL226 (Yale Assure Door Lever Lock Keypad) - YRD256 (Yale Assure Lock Keypad) +- YRD420 (Yale Assure Lock 2) +- YRD450 (Yale Assure Lock 2 Key Free) - ASL-05 (August WiFi Smart Lock - Gen 4) - ASL-03 (August Smart Lock Pro - Gen 3) - ASL-02 (August Smart Lock Pro - Gen 2) diff --git a/source/_integrations/zone.markdown b/source/_integrations/zone.markdown index cf7ee2b1e55..04c050ae77b 100644 --- a/source/_integrations/zone.markdown +++ b/source/_integrations/zone.markdown @@ -86,7 +86,7 @@ It is preferred to pick an icon to use for your zone. Pick any icon that you can ## State -The state of a zone is a number, which represends the number of +The state of a zone is a number, which represents the number of {% my people title="persons" %} that are currently in a zone. The number of persons in a zone can be helpful for automations, for example, diff --git a/source/_posts/2020-08-18-the-month-of-what-the-heck.markdown b/source/_posts/2020-08-18-the-month-of-what-the-heck.markdown index 090198cbb18..4b94a08c7ab 100644 --- a/source/_posts/2020-08-18-the-month-of-what-the-heck.markdown +++ b/source/_posts/2020-08-18-the-month-of-what-the-heck.markdown @@ -1,5 +1,5 @@ --- -title: The month of 'What the Heck?!' +title: The month of 'What the Heck?! (2020)' description: "Ever felt that 'What the heck Home Assistant?!' moment? This month, we would like to learn about your 'what the heck?!' moments..." date: 2020-08-18 00:00:00 date_formatted: "August 18, 2020" diff --git a/source/_posts/2022-09-30-the-month-of-what-the-heck.markdown b/source/_posts/2022-09-30-the-month-of-what-the-heck.markdown new file mode 100644 index 00000000000..6ee83b3e722 --- /dev/null +++ b/source/_posts/2022-09-30-the-month-of-what-the-heck.markdown @@ -0,0 +1,168 @@ +--- +title: The month of 'What the Heck?!' 2022 +description: "Ever felt that 'What the heck Home Assistant?!' moment? This month, we would like to learn about your 'what the heck?!' moments..." +date: 2022-09-30 00:00:00 +date_formatted: "September 30, 2022" +author: Franck Nijhof +author_twitter: frenck +categories: Announcements +og_image: /images/blog/2022-09-30-the-month-of-what-the-heck/social.png +--- + + + +**TL;DR**: For all of October, we are opening up to report any issue, +suggestion, or annoyance you have with Home Assistant [on the forums!][forum] + +## Welcome to the month of “What the heck?!” 2022! 🎉 + +[Two years ago], we had the first month of "What the heck?!", +and [it was great]! So, this year, for the entire month of October, +we are doing it again! + +Home Assistant is growing fast, and the development pace is high! Every month's +release almost feels like a birthday present, full of new features and +improvements. But did everything turn out the way it should? Are there +things missing? Could it be [streamlined] more? Or, worse, maybe something +started annoying you? + +That is what this month is about! + +## Lowering the barrier for sharing WTH?! moments + +We realize reporting bugs on our [GitHub][github-issues] might be a steep hill +and, for some, maybe even a bit scary (although you shouldn't be). You need a +GitHub account, report an issue following issue templates and forms, and the +report itself needs to be written in a way a developer can work with it. +Above all, we use our issue tracker for tracking actual issues and bugs, +not small feature requests or annoyances. + +While this is a common and reasonable process to collect, track, and process +bugs, our issue tracking process might not be the ideal way to learn about +your _"What the heck?!"_ moments, small tweaks, and improvements that can make +us all enjoy Home Assistant even more. + +Today, we have opened up a [Community Forum category][forum] as a safe, lower +barrier place to tell about your Home Assistant “What the heck?!” moments. +More importantly: discuss and vote on topics your fellow home +automators have brought up. + +## What are we looking for? + +Last week I've [sent out a Twitter message][tweet] asking: + +> Enlighten me 💡 The whole community would celebrate and be shedding happy +> tears of joy if just this tiny little thing was added to Home Assistant... + +The goal of that question: finding those little additions, annoyances, +inconsistencies, and more. Things that, if addressed, could make a +big difference or provide a more streamlined experience, making Home Assistant +even more enjoyable. + +I've got a whopping 200+ responses to that [tweet], and the truth is: Most +of them are exactly what this month is about! I've picked a few of them to +show you what I mean: + +- _Helper entity to add/sum multiple sensor values like multiple energy + metering sensors._ + ([@NoahM_M](https://twitter.com/NoahM_M/status/1572216035452899331)) +- _More of an app thing maybe, but moving the top dashboards view menu to the + bottom when on the phone. + ([@teachingbirds](https://twitter.com/teachingbirds/status/1572105538288373761))_ +- _It be great if automations were aware that another process/interaction/human + had changed a setting. E.g., if I turn the lights back up, I don’t want the + auto-dimmer to continue auto-dimming. + “Abandon automation if the state is modified,” or something. + ([@jameswood](https://twitter.com/jameswood/status/1571973440567123968))_ +- _Being able to select (using the mouse) the time period I want from a graph + instead of manually selecting hours/days from the dropdown would be a great + improvement in my humble opinion! + ([@WouterSchoot](https://twitter.com/WouterSchoot/status/1572505967023226888))_ +- _Toggling two lights should put them all in the same state. So if 1 light is + on and 1 off, toggling them together should make them both on, then next + toggle turn both off. + ([@balloob](https://twitter.com/balloob/status/1572406925844946946))_ +- _Option to retain associated history when renaming entity id + ([@SadGamerGeek](https://twitter.com/SadGamerGeek/status/1571964442237337600))_ + +These are great examples of the things we are looking for, the things we +should share this month. + +We are looking forward to all the things that will be brought up! +And are hoping it will be just as [successful as the previous edition][fixed]. + +**[Join us on the forums!][forum]**, or read the **[FAQ](#faq)** below. + +

+Image of a person expressing a what the heck moment +So, when does Home Assistant trigger this moment for you? +

+ +## Hacktoberfest 2022 + +This is not just the month of “What the heck?!”, it is also the month of +"[Hacktoberfest]"! 🎉 + +[Hacktoberfest] is a worldwide, month-long celebration of open source. An event +open to everyone. Whether you’re a developer, student learning to code, +documenter, or designer, you can help drive open-source projects, +like Home Assistant. + +The idea is that open source projects will gather entry-level bugs, +features, and small improvements that current or future contributors can pick +up and address; The month of “What the heck?!”, is a great way to provide these! + +By participating in Hacktoberfest and by contributing four GitHub pull +requests, you will complete the challenge and earn either a free t-shirt +or have a tree planted. + +This year, just like previous years, Home Assistant is open to and welcomes +participants of Hacktoberfest ❤️ + +## FAQ + +- **_“I have multiple things! Should I put all my stuff in a single topic?!”_** + + **No**, please create **multiple**, **smaller** topics. There is no limitation + on how many forums topics one can create for WTH. Each topic can be + voted on, picked up, and resolved. Having multiple things stacked in a single + forum topic makes resolving, discussing, and voting on them hard. + +- **_"Is everything reported going to be fixed/addressed?"_** + + There is no guarantee that will happen. The goal is to lower the barrier to + report things for one month. Home Assistant mostly relies on contributors + to address or improve the project. However, we think collecting feedback + this way can tremendously help during [Hacktoberfest]. + +- **_"I really want this new integration or add-on to be implemented, so I can + use my devices. Is this the right place for it?"_** + + **No**, this event is **not** for requesting new add-ons or device/services + integrations. Please use the [“Feature Requests”][fr] forum category instead. + +- **_"My WTH topic is one of the top-voted ones, so it is going to be + fixed/addressed, right?"_** + + This is **not** a contest. Voting will help with visibility and getting a + feeling of the impact the suggestion might have. However, it might be + difficult or too big to implement. Home Assistant mostly relies on + contributors to address or improve the project. A topic with lots of votes + is more likely to be noticed by a contributor, but it is not guaranteed + to be picked up. + +- **_"I’ve found a bug and am comfortable with GitHub. Where should I report my + issue now?"_** + + If you are comfortable with using GitHub, please, by all means, [file an issue + report on GitHub][github-issues] instead. + +[fixed]: /blog/2020/09/19/summing-up-the-month-of-what-the-heck/#so-what-was-fixed +[forum]: https://community.home-assistant.io/c/what-the-heck/56 +[fr]: https://community.home-assistant.io/c/feature-requests/13 +[github-issues]: https://github.com/home-assistant/core/issues/new/choose +[Hacktoberfest]: https://hacktoberfest.com/ +[streamlined]: /blog/2022/01/19/streamlining-experiences/ +[tweet]:https://twitter.com/Frenck/status/1571961147305218055 +[Two years ago]: /blog/2020/08/18/the-month-of-what-the-heck/ +[it was great]: /blog/2020/09/19/summing-up-the-month-of-what-the-heck/ \ No newline at end of file diff --git a/source/_posts/2022-10-03-short-term-solutions-save-energy-and-money-europe.markdown b/source/_posts/2022-10-03-short-term-solutions-save-energy-and-money-europe.markdown new file mode 100644 index 00000000000..be31271c4b1 --- /dev/null +++ b/source/_posts/2022-10-03-short-term-solutions-save-energy-and-money-europe.markdown @@ -0,0 +1,102 @@ +--- +title: Short-term solutions on how to use smart home tech to save energy and money in Europe +description: "Overview of things that Europeans can do to start saving energy and money today – even if they rent a home." +date: 2022-10-03 00:00:00 +date_formatted: "October 3, 2022" +author: Paulus Schoutsen +author_twitter: balloob +categories: Announcements +og_image: /images/blog/2022-10-03-short-term-solutions-save-energy-and-money-europe/shelly-trv.png +--- + +Europe has entered an energy crisis and prices for electricity and gas are skyrocketing. Rates of €1/kWh and €3,40 per m³ of gas are not uncommon. People are turning to their friends in the Home Assistant community asking for help on how to save energy. With winter around the corner, they want a solution that they can apply before it gets really cold. + +The goal of this post is to give an overview of things that Europeans can do to start saving energy and money today – even if they rent a home. The focus is on homes using radiators and a boiler connected to a thermostat. + +Heating is a complicated topic and you will probably still have questions after reading this post. Don’t hesitate to join the Home Assistant community to discuss how to save energy (do make sure to search before asking a question). Join us [in the forums][forums] in the energy category or come hang out in the #energy channel on our [Discord chat server][discord]. + +## Take control of your heating + +Most of your energy usage goes into heating your house in the winter. + +Gas is more efficient than electricity to heat your house, unless you have a heat pump. So don’t turn off your gas heating and replace it with an electric heater as it will cost you a lot more money. + +There are two ways of saving energy with heating. The first approach is to invest in more efficient technology to generate heat and improve the home insulation to stay warm. Things like getting a heat pump, improving insulation and getting thicker windows. Those things are not achievable before winter kicks in, so they are out of scope for this post. + +The second way of saving energy is to use less of it. Governments have been advising to lower the overall temperature of your home, but putting the temperature too low can get a little too cold. Instead, you can be smarter about how you heat your home by installing smart thermostats, temperature sensors and thermostatic radiator valves (TRV). + +

+ +Photo of a Shelly TRV +

+ +## Smart Thermostats + +A thermostat works by measuring the temperature. If the current temperature is below the target temperature set by the user, it turns on the heating until the home is the right temperature. + +If you’re renting your home, you can skip this section as upgrading a thermostat is generally not an option. + +The way a thermostat can help you save the most energy is by controlling the boiler, and preferably the boiler temperature. Heating the water is what drives the energy usage, so you wouldn’t want the boiler to heat the water to a higher temperature than is necessary to reach your target temperature. + +Thermostats measure the temperature from the thermostat device. If the thermostat hangs in the last place in your home that gets warm, it might be heating more than you need. A smart thermostat can help by allowing you to pair extra temperature sensors to report the temperature in different rooms in your home. This allows the thermostat to turn off the heating earlier. + +An extra bonus feature of a smart thermostat with remote control is that you’ll be able to change the temperature if you realize that you won’t be home at the scheduled time. + +If you’re going to be in it for the long haul and want the easiest solution, you should invest in a smart thermostat that is part of a heating/cooling ecosystem that also has an API. Optimizing heating energy use is complicated and not something Home Assistant is good at out of the box. Instead, let that be managed by the ecosystem. The API allows you to still observe and influence it from Home Assistant to integrate presence and other data points the ecosystem is not aware of. + +If you want full control over every part of heating your home, you don’t need to take the ecosystem route and instead invest in locally controllable thermostats, temperature sensors and TRVs and tie them together with Home Assistant. [Here is an example to get started.](https://community.home-assistant.io/t/smart-heating-scheduler-for-home-assistant-extra-multi-zones-version/237966) + +### Recommended thermostats + +It’s hard to give a single product recommendation here because there are so many different heating configurations and we are not aware of a single solution that works best in every case. Always check if the thermostat works with your boiler or other heating system you might use. + +Home Assistant core developer Frenck researched this topic a couple of months ago for his own home and settled on [Plugwise](https://www.plugwise.com/). It controls his boiler and radiators and has a local API to integrate with Home Assistant. + +Another popular solution is [Homematic IP](https://homematic-ip.com). It too has a local API to integrate with Home Assistant. + +Here at Home Assistant we prefer devices that work locally. Any device that stores your data in the cloud will eventually need a way to recoup the cost of hosting your data. It also means that if the company goes out of business, the devices tend to stop working. However, we understand that your priority today is saving energy. If the above solutions don’t work well for your home, you can also consider [Netatmo](https://www.netatmo.com) or [Tado](https://www.tado.com). + +We don’t recommend Google Nest because its ecosystem is not fully featured enough, as it does not support TRVs. + +## Thermostatic Radiator Valves (TRV) + +A TRV will replace the existing knob on your radiator with a smart one. This works too if you rent: just swap the old knob back when you move out. Installation generally takes just 5 minutes. + +A TRV works like the thermostat of your house, but at the level of your radiator: you set the temperature that you want to reach, and it will open/close your radiator to get to the controlled temperature. + +Having a TRV allows you to tune the temperature in individual rooms based on your schedule and/or planned usage, like only heating up the bathroom in the morning and around bedtime. + +TRVs should be used to opt a room in/out of heating. Because heating the water in your boiler is still the biggest use of your energy, you should not use TRVs to turn off all radiators in your home or to reduce the temperature throughout the home. This should be done at the boiler level (usually via the thermostat). Keeping your boiler at the right (and not too high) temperature required to heat your home to the desired temperature is the biggest energy saver move you can do. + +### Recommended TRVs + +All three smart thermostats that we recommended are part of a product range that include TRVs. If you went with one of those, we suggest you stick to the ecosystem. + +There are two devices that we recommend. Both work independently but also have a local API to allow plugging it into Home Assistant. + +#### Shelly TRV + +This device works standalone and does not require a hub. Battery life is claimed to be 2 years. It offers a local API and integrates perfectly with Home Assistant. + +[Buy Shelly TRV](https://shop.shelly.cloud/shelly-trv-wifi-smart-home-automation?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq) _(affiliate link)_ + + + +#### Aqara Smart Radiator Thermostat E1 + +The new kid on the block as it was just released. This TRV can be controlled directly from Home Assistant using Zigbee or via the Aqara hub. The hub can be locally integrated with Home Assistant via the [HomeKit Controller integration](/integrations/homekit_controller/). + +Note: The vendor claims the device will support Matter in the future. It is unclear from their documentation if the device will speak Matter over Thread or that it will require their hub to expose the device over Matter. Our money is on the latter as that’s how they do HomeKit too. + +[Buy Aqara Smart Radiator Thermostat E1](https://www.aqara.com/eu/product/radiator-thermostat-e1) + + + +## Wrap up + +Sadly, there is no golden solution to save energy that works for everyone everywhere. I hope that the above overview and tips will help you through the winter. + +If some things are still not clear, don’t hesitate to join us in the forums in the energy category or come hang out in the #energy channel on our Discord chat server. + +[forums]: https://community.home-assistant.io/c/energy/57 +[discord]: /join-chat/ diff --git a/source/images/blog/2022-09-30-the-month-of-what-the-heck/social.png b/source/images/blog/2022-09-30-the-month-of-what-the-heck/social.png new file mode 100644 index 00000000000..286313445e7 Binary files /dev/null and b/source/images/blog/2022-09-30-the-month-of-what-the-heck/social.png differ diff --git a/source/images/blog/2022-10-03-short-term-solutions-save-energy-and-money-europe/shelly-trv.png b/source/images/blog/2022-10-03-short-term-solutions-save-energy-and-money-europe/shelly-trv.png new file mode 100644 index 00000000000..de11406415d Binary files /dev/null and b/source/images/blog/2022-10-03-short-term-solutions-save-energy-and-money-europe/shelly-trv.png differ diff --git a/source/images/integrations/github/service_dark.png b/source/images/integrations/github/service_dark.png new file mode 100644 index 00000000000..bd5477b4744 Binary files /dev/null and b/source/images/integrations/github/service_dark.png differ diff --git a/source/images/integrations/github/service_light.png b/source/images/integrations/github/service_light.png new file mode 100644 index 00000000000..02aa1230171 Binary files /dev/null and b/source/images/integrations/github/service_light.png differ diff --git a/source/index.html b/source/index.html index 16b66ca833f..7970700cfe3 100644 --- a/source/index.html +++ b/source/index.html @@ -90,14 +90,16 @@ feedback: false
-
+ >