Conversation
home-assistant
bot
added
current
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR primarily adds documentation for the new GridX integration, but it also includes several unrelated documentation updates across other integrations, plus new tile-card feature docs and images.
Changes:
- Added new integration documentation pages for GridX and Dropbox.
- Added tile-card feature documentation (and screenshots) for media player sound mode and source selectors.
- Updated multiple existing integration docs (for example, MQTT Vacuum segment cleaning topics, Transmission/HTML5 event-entity documentation, and various supported platform/device lists).
Reviewed changes
Copilot reviewed 13 out of 15 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| source/_integrations/gridx.markdown | New integration documentation page for GridX. |
| source/_integrations/dropbox.markdown | New integration documentation page for Dropbox backup location. |
| source/dashboards/features.markdown | Adds two new tile-card feature sections for media players. |
| source/images/dashboards/features/media_player_sound_mode.png | Screenshot for the new “media player sound mode” feature docs. |
| source/images/dashboards/features/media_player_source.png | Screenshot for the new “media player source” feature docs. |
| source/_integrations/vacuum.mqtt.markdown | Documents segment-cleaning MQTT topics/templates and updates state payload schema. |
| source/_integrations/transmission.markdown | Adds documentation for an Event entity and example automation. |
| source/_integrations/html5.markdown | Adds event platform/category info and expands action + event documentation. |
| source/_integrations/fritz.markdown | Restructures sections (supported devices/functionality) and adds use cases. |
| source/_integrations/pjlink.markdown | Updates docs to config-flow-based setup and configuration_basic fields. |
| source/_integrations/switchbot_cloud.markdown | Adds Weather Station to supported devices + functionality list. |
| source/_integrations/smlight.markdown | Adds Remote platform/category and IR remote documentation + example. |
| source/_integrations/casper_glow.markdown | Adds Select platform/category and documents the new select entity. |
| source/_integrations/anthropic.markdown | Fixes/extends the “Enable web search” option description formatting/content. |
| --- | ||
| title: GridX | ||
| description: Instructions on how to integrate GridX energy systems within Home Assistant. | ||
| ha_category: | ||
| - Energy | ||
| - Sensor | ||
| ha_release: 2026.5 | ||
| ha_iot_class: Cloud Polling | ||
| ha_config_flow: true | ||
| ha_codeowners: | ||
| - '@unl0ck' | ||
| ha_domain: gridx | ||
| ha_platforms: | ||
| - diagnostics | ||
| - sensor | ||
| ha_integration_type: device |
There was a problem hiding this comment.
The PR title/description says this change is adding GridX integration docs, but this PR also modifies multiple unrelated integration docs (HTML5, Transmission, FRITZ!Box Tools, PJLink, etc.) and adds dashboard feature docs + images. Please either split this into focused PRs or update the PR title/description to reflect the full scope so review and release notes are accurate.
| description: The e-mail address you use to sign in to the GridX provider app. | ||
| Password: | ||
| description: The password for your GridX provider app account. | ||
| Energy provider: | ||
| description: The gridX provider realm to use. Currently, only `E.ON Home` is supported. |
There was a problem hiding this comment.
In this configuration_basic block, the description lines should be indented with 4 spaces (consistent with other integration docs, like source/_integrations/pjlink.markdown:23-28 and source/_integrations/fritz.markdown:62-75). The current 2-space indentation may render incorrectly in the generated configuration table.
| description: The e-mail address you use to sign in to the GridX provider app. | |
| Password: | |
| description: The password for your GridX provider app account. | |
| Energy provider: | |
| description: The gridX provider realm to use. Currently, only `E.ON Home` is supported. | |
| description: The e-mail address you use to sign in to the GridX provider app. | |
| Password: | |
| description: The password for your GridX provider app account. | |
| Energy provider: | |
| description: The gridX provider realm to use. Currently, only `E.ON Home` is supported. |
|
|
||
| {% configuration_basic %} | ||
| Username: | ||
| description: The e-mail address you use to sign in to the GridX provider app. |
There was a problem hiding this comment.
Use “email” instead of “e-mail” to match common usage and the Microsoft writing style used across the docs.
| description: The e-mail address you use to sign in to the GridX provider app. | |
| description: The email address you use to sign in to the GridX provider app. |
| - returning, | ||
| - error. | ||
|
|
||
| The optional `segments` attribute in the MQTT payload should contain a mapping of the available cleanable segments the MQTT vacuum can clean. When this mapping changes, Home Assistant can guide you through a repair flow will support to update the segment-to-area mapping for the vacuum. |
There was a problem hiding this comment.
This sentence is ungrammatical (“…repair flow will support to update…”) and has trailing whitespace at the end of the line. Please rephrase it (for example, “...guide you through a repair flow to update the segment-to-area mapping...”) and remove the extra spaces.
| The optional `segments` attribute in the MQTT payload should contain a mapping of the available cleanable segments the MQTT vacuum can clean. When this mapping changes, Home Assistant can guide you through a repair flow will support to update the segment-to-area mapping for the vacuum. | |
| The optional `segments` attribute in the MQTT payload should contain a mapping of the available cleanable segments that your MQTT vacuum can clean. When this mapping changes, Home Assistant will guide you through a repair flow to update the segment-to-area mapping for the vacuum. |
| - **State attribute**: `event_type` | ||
| - **Description**: The type of the last torrent event. Possible states are Started, Downloaded, and Removed. | ||
|
|
||
| - **State attribute**: `name` | ||
| - **Description**: The filename of the torrent. | ||
|
|
There was a problem hiding this comment.
The event_type attribute description lists possible values as “Started, Downloaded, and Removed”, but the example automation checks for state: "downloaded" (lowercase). Please align the documented possible values and the example so users can copy/paste reliably.
| ttl: | ||
| days: 28 |
There was a problem hiding this comment.
The example sets ttl as a time period mapping (ttl: { days: 28 }), but this action has historically documented ttl as a scalar (seconds). If the action really accepts a time period, the attribute description should explicitly say so; otherwise, change the example to an integer value (for example, 86400 for one day) to avoid users getting schema errors.
| ttl: | |
| days: 28 | |
| ttl: 2419200 |
| ## Example Automations and Scripts | ||
|
|
||
| ## Use cases | ||
|
|
||
| You can use the FRITZ!Box Tools integration for a variety of smart home scenarios, such as: | ||
|
|
||
| - _Automatically reconnect your internet connection at night_: Schedule a reconnect or reboot of your FRITZ!Box to refresh your external IP address or resolve connectivity issues. | ||
| - _Send Wi-Fi credentials to your phone when guest Wi-Fi is enabled_: Automate notifications with the guest Wi-Fi password when you turn on the guest network. | ||
| - _Control internet access for your kids' devices_: Use parental control switches to enable or disable internet access for specific devices at set times. | ||
| - _Monitor who is home_: Track presence based on connected devices, and trigger automations when people arrive or leave. | ||
| - _Monitor your network health_: Get alerts if your FRITZ!Box goes offline, or monitor network statistics and device status. | ||
| - _Automate port forwarding_: Enable or disable port forwarding rules for your Home Assistant host as needed for remote access or security. | ||
|
|
||
| Below are some example automations and scripts to help you get started: | ||
|
|
||
| ### Script: Reconnect / get new IP |
There was a problem hiding this comment.
Heading structure is currently broken: ## Example Automations and Scripts is immediately followed by another ## Use cases, making the “Example…” section empty and placing the examples under “Use cases”. Please reorder these sections (for example, put “Use cases” before “Example automations and scripts”, or make “Use cases” a subsection) so the examples remain under the correct heading.
| - [Water Leak Detector](https://www.switch-bot.com/products/switchbot-water-leak-detector) | ||
| - [Climate Panel](https://www.switch-bot.com/products/switchbot-home-climate-panel) | ||
| - [Presence Sensor](https://www.switch-bot.com/products/switchbot-presence-sensor) | ||
| - Weather Station |
There was a problem hiding this comment.
In the supported devices list, “Weather Station” is the only sensor entry without a link, unlike the other items in this section. Please add the official product URL (or remove the entry if it’s not an official supported device) to keep the list consistent and more useful.
| - Weather Station | |
| - [Weather Station](https://www.switch-bot.com/products/switchbot-weather-station) |
|
|
||
| | Data attribute | Required | Description | Example | | ||
| | ---------------------- | -------- | ----------- | ------- | | ||
| | `vehicle`| yes | device_id of the vehicle | |
There was a problem hiding this comment.
This table row appears to be missing the final cell/pipe for the “Example” column, which can break the Markdown table rendering. Align it with the other rows (for example, include an explicit empty example cell like | |).
| | `vehicle`| yes | device_id of the vehicle | | |
| | `vehicle`| yes | device_id of the vehicle | | |
| 4. Take note of the **App key** and **App secret**. These are the application credentials for your newly created app. | ||
| 5. In the **OAuth 2** section, under **Redirect URIs**, enter the following URL: `https://my.home-assistant.io/redirect/oauth` and select **Add**. | ||
| 6. On the **Permissions** tab, enable `files.content.write` and `files.content.read`. | ||
| 7. In Home Assistant, in {% my integrations title="**Settings** > **Devices & services**" %} in the top-right three dots {% icon "mdi:dots-vertical" %} menu > **Application credentials**, select the button to add an application credential. |
There was a problem hiding this comment.
Step 7 is hard to read because of repeated “in” (“In Home Assistant, in … in the top-right …”). Please rephrase it to remove the repetition and make the instruction clearer.
| 7. In Home Assistant, in {% my integrations title="**Settings** > **Devices & services**" %} in the top-right three dots {% icon "mdi:dots-vertical" %} menu > **Application credentials**, select the button to add an application credential. | |
| 7. In Home Assistant, open {% my integrations title="**Settings** > **Devices & services**" %}. Then, from the top-right three dots {% icon "mdi:dots-vertical" %} menu, go to **Application credentials** and select the button to add an application credential. |
home-assistant
bot
removed
current
Proposed change
Adds documentation for the new GridX integration being added to Home Assistant.
The page covers setup requirements, supported devices and functionality, data update behavior, known limitations, troubleshooting, and standard removal instructions for the GridX cloud integration.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.