Merge branch 'current' into z-wave-command-class-specific-functions

This commit is contained in:
c0ffeeca7 2023-04-13 09:15:04 +02:00 committed by GitHub
commit c27efaecd6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 151 additions and 34 deletions

View File

@ -26,6 +26,16 @@
Add-ons are additional standalone third-party software packages that can be Add-ons are additional standalone third-party software packages that can be
installed on Home Assistant OS. installed on Home Assistant OS.
- term: Area
definition: >-
Locations within your home such as living room, dance floor, etc.
Devices can be associated to an area for easier sorting and automatically
generated cards, such as the [Area card](/dashboards/area/).
excerpt: >-
Places within your home such as rooms, spaces, etc.
aliases:
- areas
- term: Automation - term: Automation
definition: >- definition: >-
Automations connect one or more triggers to one or more actions in a Automations connect one or more triggers to one or more actions in a

View File

@ -43,7 +43,9 @@ Note that it depends on the appliance and on API permissions which of the featur
- OAuth Flow: Authorization Code Grant Flow - OAuth Flow: Authorization Code Grant Flow
- Redirect URI: `https://my.home-assistant.io/redirect/oauth` - Redirect URI: `https://my.home-assistant.io/redirect/oauth`
*Important*: *Important*:
- **Power on** all your appliances during the integration configuration process; otherwise appliance programs list will be empty.
- To update the appliance programs list, you can reload the Home Connect integration when an appliance is turned on. If the re-initialization process is not triggered by reload, restart the Home Assistant when an appliance is turned on.
- After performing the steps above **log out** of your Home Connect Developer account. If you don't do this, the configuration steps below will fail during OAuth authentication with the message `“error”: “unauthorized_client”`. - After performing the steps above **log out** of your Home Connect Developer account. If you don't do this, the configuration steps below will fail during OAuth authentication with the message `“error”: “unauthorized_client”`.
- The provided Home Connect User Account email address **must** be all lowercase otherwise it will result in authentication failures. - The provided Home Connect User Account email address **must** be all lowercase otherwise it will result in authentication failures.
- All changes in the developer portal take 15 minutes before the change is implemented. - All changes in the developer portal take 15 minutes before the change is implemented.

View File

@ -68,7 +68,7 @@ sql:
db_url: db_url:
description: The URL which points to your database. See [supported engines](/integrations/recorder/#custom-database-engines). description: The URL which points to your database. See [supported engines](/integrations/recorder/#custom-database-engines).
required: false required: false
default: "Defaults to the default recorder `db_url` (not the current `db_url` of recorder)." default: "Defaults to the recorder `db_url`."
type: string type: string
name: name:
description: The name of the sensor. description: The name of the sensor.

View File

@ -50,7 +50,7 @@ The Z-Wave integration allows you to control a Z-Wave network via the [Z-Wave JS
To run a Z-Wave network, you need the following elements: To run a Z-Wave network, you need the following elements:
* A [supported Z-Wave controller](/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-modules). First-time user? For recommendations on what to buy, go [here](integrations/zwave_js/#which-z-wave-controller-should-i-buy). * A [supported Z-Wave controller](/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-modules). First-time user? For recommendations on what to buy, go [here](#which-z-wave-controller-should-i-buy).
* A running Z-Wave JS server. * A running Z-Wave JS server.
* An installed Z-Wave integration in Home Assistant. * An installed Z-Wave integration in Home Assistant.
@ -124,6 +124,45 @@ While your Z-Wave mesh is permanently stored on your dongle, the additional meta
1. Put the device you want to remove in exclusion mode. Refer to its manual how this is done. 1. Put the device you want to remove in exclusion mode. Refer to its manual how this is done.
1. The UI should confirm that the device was removed and the device and entities will be removed from Home Assistant. 1. The UI should confirm that the device was removed and the device and entities will be removed from Home Assistant.
## Using advanced features (UI only)
While the integration aims to provide as much functionality as possible through existing Home Assistant constructs (entities, states, automations, services, etc.), there are some features that are only available through the UI.
All of these features can be accessed either in the Z-Wave integration configuration panel or in a Z-Wave device's device panel.
### Integration configuration panel
The following features can be accessed from the integration configuration panel:
![Z-Wave integration configuration panel](/images/integrations/z-wave/z-wave-integration-config-panel.png)
* **Add device:** Allows you to pre-provision a SmartStart device or start the inclusion process for adding a new device to your network.
* **Remove device:** Starts the exclusion process for removing a device from your network.
* **Heal network:** Forces your network to rediscover routes to the controller from each device. This is useful when devices or the controller have moved to a new location, or if you are having significant problems with your network, but it also generates a lot of network traffic and should be used sparingly.
* **[Controller statistics](https://zwave-js.github.io/node-zwave-js/#/api/controller?id=quotstatistics-updatedquot):** Provides statistics about communication between the controller and other devices, allowing you to troubleshoot your network's RF quality.
* **Third-party data opt-in/out:** Allows you to opt-in or out of telemetry that the Z-Wave JS project collects to help inform development decisions, influence manufacturers, etc. This telemetry is disabled by default and has to be opted in to be activated.
### Integration menu
Some features can be accessed from the menu of integration itself. As they are not specific to Z-Wave, they are not described here in detail.
![Z-Wave integration configuration panel](/images/integrations/z-wave/z-wave-integration-menu.png)
* **[Download diagnostics](/docs/configuration/troubleshooting/#download-diagnostics):** Exports a JSON file describing the entities of all devices registered with this integration.
### Device panel
The following features can be accessed from the device panel of a Z-Wave device:
![Z-Wave device panel](/images/integrations/z-wave/z-wave-device-info.png)
* **Configure:** Provides an easy way to look up and update configuration parameters for the device. While there is an existing service for setting configuration parameter values, this UI may sometimes be quicker to use for one-off changes.
* **Re-interview:** Forces the device to go through the interview process again so that Z-Wave-JS can discover all of its capabilities. Can be helpful if you don't see all the expected entities for your device.
* **Heal:** Forces the device to rediscover its optimal route back to the controller. Use this if you think you are experiencing unexpected delays or RF issues with your device. Your device may be less responsive during this process.
* **Remove failed:** Forces the controller to remove the device from the controller. Can be used when a device has failed and it can't go through the normal exclusion process.
* **[Statistics](https://zwave-js.github.io/node-zwave-js/#/api/node?id=quotstatistics-updatedquot):** Provides statistics about communication between this device and the controller, allowing you to troubleshoot RF issues with the device.
* **Update:** Updates a device's firmware using a manually uploaded firmware file. Only some devices support this feature (controllers and devices with the Firmware Update Metadata Command Class).
* **Download diagnostics:** Exports a JSON file describing the entities of this specific device.
## Services ## Services
### Service `zwave_js.set_config_parameter` ### Service `zwave_js.set_config_parameter`
@ -615,33 +654,6 @@ In addition to the [standard automation trigger data](/docs/automation/templatin
| `trigger.event` | Name of event. | | `trigger.event` | Name of event. |
| `trigger.event_data` | Any data included in the event. | | `trigger.event_data` | Any data included in the event. |
## Advanced Features (UI Only)
While the integration aims to provide as much functionality as possible through existing Home Assistant constructs (entities, states, automations, services, etc.), there are some features that are only available through the UI.
All of these features can be accessed either in the Z-Wave integration configuration panel or in a Z-Wave device's device panel.
### Integration Configuration Panel
The following features can be accessed from the integration configuration panel:
* **Add device:** Allows you to pre-provision a SmartStart device or start the inclusion process for adding a new device to your network.
* **Remove device:** Starts the exclusion process for removing a device from your network.
* **Heal network:** Forces your network to rediscover routes to the controller from each device. This is useful when devices or the controller have moved to a new location, or if you are having significant problems with your network, but it also generates a lot of network traffic and should be used sparingly.
* **Third-party data opt-in/out:** Allows you to opt-in or out of telemetry that the Z-Wave JS project collects to help inform development decisions, influence manufacturers, etc. This telemetry is disabled by default and has to be opted in to be activated.
* **[Controller statistics](https://zwave-js.github.io/node-zwave-js/#/api/controller?id=quotstatistics-updatedquot):** Provides statistics about communication between the controller and other devices, allowing you to troubleshoot your network's RF quality.
### Device Panel
The following features can be accessed from the device panel of a Z-Wave device:
* **Configure:** Provides an easy way to look up and update configuration parameters for the device. While there is an existing service for setting configuration parameter values, this UI may sometimes be quicker to use for one off changes.
* **Re-interview:** Forces the device to go through the interview process again so that zwave-js can discover all of its capabilities. Can be helpful if you don't see all the expected entities for your device.
* **Heal:** Forces the device to rediscover its optimal route back to the controller. Use this if you think you are experiencing unexpected delays or RF issues with your device. Your device may be less responsive during this process.
* **Remove failed:** Forces the controller to remove the device from the controller. Can be used when a device has failed and it can't go through the normal exclusion process.
* **[Statistics](https://zwave-js.github.io/node-zwave-js/#/api/node?id=quotstatistics-updatedquot):** Provides statistics about communication between this device and the controller, allowing you to troubleshoot RF issues with the device.
* **Update firmware:** Updates a device's firmware using a manually uploaded firmware file. Only some devices support this feature (controllers and devices with the Firmware Update Metadata Command Class).
## Advanced installation instructions ## Advanced installation instructions
If you are using Home Assistant Container, Home Assistant Core, or you don't want to use the built-in Z-Wave JS Server add-on, you will need to run the Z-Wave JS server yourself, to which the Z-Wave integration will connect. If you are using Home Assistant Container, Home Assistant Core, or you don't want to use the built-in Z-Wave JS Server add-on, you will need to run the Z-Wave JS server yourself, to which the Z-Wave integration will connect.

View File

@ -46,6 +46,7 @@ Happy Easter! 🐣 and enjoy the release!
- [Integrations now available to set up from the UI](#integrations-now-available-to-set-up-from-the-ui) - [Integrations now available to set up from the UI](#integrations-now-available-to-set-up-from-the-ui)
- [Release 2023.4.1 - April 6](#release-202341---april-6) - [Release 2023.4.1 - April 6](#release-202341---april-6)
- [Release 2023.4.2 - April 8](#release-202342---april-8) - [Release 2023.4.2 - April 8](#release-202342---april-8)
- [Release 2023.4.3 - April 12](#release-202343---april-12)
- [Need help? Join the community!](#need-help-join-the-community) - [Need help? Join the community!](#need-help-join-the-community)
- [Breaking Changes](#breaking-changes) - [Breaking Changes](#breaking-changes)
- [Farewell to the following](#farewell-to-the-following) - [Farewell to the following](#farewell-to-the-following)
@ -667,6 +668,98 @@ The following integrations are now available via the Home Assistant UI:
[zeroconf docs]: /integrations/zeroconf/ [zeroconf docs]: /integrations/zeroconf/
[zha docs]: /integrations/zha/ [zha docs]: /integrations/zha/
## Release 2023.4.3 - April 12
- Fix configuring Flo instances ([@amattas] - [#90990]) ([flo docs])
- Fall back to polling if webhook cannot be registered on Nuki ([@pree] - [#91013]) ([nuki docs])
- Track availability of source sensor in utility meter ([@dgomes] - [#91035]) ([utility_meter docs])
- Bump aiopyarr to 23.4.0 ([@tkdrob] - [#91110]) ([sonarr docs]) ([radarr docs]) ([lidarr docs])
- Bump env_canada to 0.5.32 ([@michaeldavie] - [#91126]) ([environment_canada docs])
- Relax calendar event validation to allow existing zero duration events ([@allenporter] - [#91129]) ([google docs]) ([calendar docs]) ([caldav docs])
- Bump ulid-transform to 0.6.3 ([@bdraco] - [#91133])
- Fix false positive in SQL sensor full table scan check ([@bdraco] - [#91134]) ([sql docs])
- Reolink config flow fix custom port when USE_HTTPS not selected ([@starkillerOG] - [#91137]) ([reolink docs])
- Fix all day event coercion logic ([@allenporter] - [#91169]) ([calendar docs]) ([local_calendar docs])
- Reduce startup time for System Bridge integration ([@timmo001] - [#91171]) ([system_bridge docs])
- Cleanup ZHA from Zigpy deprecated property removal ([@dmulcahey] - [#91180]) ([zha docs])
- Bump `pytile` to 2023.04.0 ([@bachya] - [#91191]) ([tile docs])
- Flush conversation name cache when an entity is renamed ([@emontnemery] - [#91214]) ([conversation docs])
- Update frontend to 20230411.0 ([@bramkragten] - [#91219]) ([frontend docs])
- Fix switch_as_x name ([@emontnemery] - [#91232]) ([switch_as_x docs])
- Update Inovelli Blue Series switch support in ZHA ([@codyhackw] - [#91254]) ([zha docs])
- Bump ZHA dependencies ([@puddly] - [#91291]) ([zha docs])
- Restore use of local timezone for MariaDB/MySQL in SQL integration ([@bdraco] - [#91313]) ([recorder docs]) ([sql docs])
- Google Assistant SDK: Fix broadcast command for Portuguese ([@tronikos] - [#91293]) ([google_assistant_sdk docs])
- Remove codecov from Python test requirements ([@frenck] - [#91295])
[#91293]: https://github.com/home-assistant/core/pull/91293
[#91295]: https://github.com/home-assistant/core/pull/91295
[@frenck]: https://github.com/frenck
[@tronikos]: https://github.com/tronikos
[google_assistant_sdk docs]: /integrations/google_assistant_sdk/
[#90855]: https://github.com/home-assistant/core/pull/90855
[#90956]: https://github.com/home-assistant/core/pull/90956
[#90990]: https://github.com/home-assistant/core/pull/90990
[#91013]: https://github.com/home-assistant/core/pull/91013
[#91035]: https://github.com/home-assistant/core/pull/91035
[#91110]: https://github.com/home-assistant/core/pull/91110
[#91111]: https://github.com/home-assistant/core/pull/91111
[#91126]: https://github.com/home-assistant/core/pull/91126
[#91129]: https://github.com/home-assistant/core/pull/91129
[#91133]: https://github.com/home-assistant/core/pull/91133
[#91134]: https://github.com/home-assistant/core/pull/91134
[#91137]: https://github.com/home-assistant/core/pull/91137
[#91169]: https://github.com/home-assistant/core/pull/91169
[#91171]: https://github.com/home-assistant/core/pull/91171
[#91180]: https://github.com/home-assistant/core/pull/91180
[#91191]: https://github.com/home-assistant/core/pull/91191
[#91214]: https://github.com/home-assistant/core/pull/91214
[#91219]: https://github.com/home-assistant/core/pull/91219
[#91232]: https://github.com/home-assistant/core/pull/91232
[#91254]: https://github.com/home-assistant/core/pull/91254
[#91291]: https://github.com/home-assistant/core/pull/91291
[#91313]: https://github.com/home-assistant/core/pull/91313
[@allenporter]: https://github.com/allenporter
[@amattas]: https://github.com/amattas
[@bachya]: https://github.com/bachya
[@balloob]: https://github.com/balloob
[@bdraco]: https://github.com/bdraco
[@bramkragten]: https://github.com/bramkragten
[@codyhackw]: https://github.com/codyhackw
[@dgomes]: https://github.com/dgomes
[@dmulcahey]: https://github.com/dmulcahey
[@emontnemery]: https://github.com/emontnemery
[@frenck]: https://github.com/frenck
[@michaeldavie]: https://github.com/michaeldavie
[@pree]: https://github.com/pree
[@puddly]: https://github.com/puddly
[@starkillerOG]: https://github.com/starkillerOG
[@timmo001]: https://github.com/timmo001
[@tkdrob]: https://github.com/tkdrob
[actiontec docs]: /integrations/actiontec/
[advantage_air docs]: /integrations/advantage_air/
[airly docs]: /integrations/airly/
[caldav docs]: /integrations/caldav/
[calendar docs]: /integrations/calendar/
[conversation docs]: /integrations/conversation/
[environment_canada docs]: /integrations/environment_canada/
[flo docs]: /integrations/flo/
[frontend docs]: /integrations/frontend/
[google docs]: /integrations/google/
[lidarr docs]: /integrations/lidarr/
[local_calendar docs]: /integrations/local_calendar/
[nuki docs]: /integrations/nuki/
[radarr docs]: /integrations/radarr/
[recorder docs]: /integrations/recorder/
[reolink docs]: /integrations/reolink/
[sonarr docs]: /integrations/sonarr/
[sql docs]: /integrations/sql/
[switch_as_x docs]: /integrations/switch_as_x/
[system_bridge docs]: /integrations/system_bridge/
[tile docs]: /integrations/tile/
[utility_meter docs]: /integrations/utility_meter/
[zha docs]: /integrations/zha/
## Need help? Join the community! ## Need help? Join the community!
Home Assistant has a great community of users who are all more than willing Home Assistant has a great community of users who are all more than willing

View File

@ -6,9 +6,9 @@ sidebar: false
If you have an installation, a setup or a configuration issue please use our [Forum](https://community.home-assistant.io/) to get help. We have a big community which will help you if they can. If you have an installation, a setup or a configuration issue please use our [Forum](https://community.home-assistant.io/) to get help. We have a big community which will help you if they can.
If you found a bug then please report it in one of our [trackers](/help/#bugs-feature-requests-and-alike). To help you and our developers to identify the issue quickly, please fill out the provided template. The "weird" content you will see is there to render your entry in a nice format after submitting. It's just [markdown](https://guides.github.com/features/mastering-markdown/). If you found a bug then please report it in one of our [trackers](/help/#bugs-feature-requests-and-alike). To help you and our developers to identify the issue quickly, please fill out the provided template. The "weird" content you will see is there to render your entry in a nice format after submitting. It's just [markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
Please refer to the **Settings** -> **About** page, which is accessible inside the Home Assistant frontend. Please refer to the [**Settings** -> **About**](https://my.home-assistant.io/redirect/info/) page, which is accessible inside the Home Assistant frontend.
## First Home Assistant release with the issue ## First Home Assistant release with the issue
@ -26,8 +26,8 @@ There are many different ways to run Home Assistant. In this section please ment
Please add the link to the documentation of the integration in question. E.g., Please add the link to the documentation of the integration in question. E.g.,
- issue with the `random` sensor: [/integrations/random#sensor](/integrations/random#sensor) - Issue with the `random` sensor: [/integrations/random#sensor](/integrations/random#sensor).
- issue with the `hue` integration: [/integrations/hue/](/integrations/hue/) - Issue with the `hue` integration: [/integrations/hue/](/integrations/hue/).
### Description of problem ### Description of problem

Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB