Skip to content

Add rexense doc #38635

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 92 commits into from
Closed

Add rexense doc #38635

wants to merge 92 commits into from

Conversation

GorgeOu
Copy link

@GorgeOu GorgeOu commented Apr 19, 2025

Additional information

Proposed change

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Summary by CodeRabbit

  • Documentation
    • Added comprehensive user guide for the new Rexense integration, including installation steps, configuration options, supported device types (sensors and switches), example automation, and removal instructions.
    • Added new documentation files for multiple integrations including Bosch Alarm, Balay, Constructa, Eve Matter, Gaggenau, Miele, Neff, Pitsos, Profilo, Siemens, Thermador, and Rexense.
    • Updated Airthings, Airzone, Airzone Cloud, Assist Satellite, Homee, HomeKit, INKBIRD, Konnected, Kulersky, La Marzocco, LG ThinQ, Light MQTT, MCP, MCP Server, Music Assistant, Nuki, Ohme, Pterodactyl, QNAP QSW, Reolink, Squeezebox, SwitchBot, Template, Total Connect, Vodafone Station, Weheat, Worx Landroid, and other integrations with new features, clarifications, or formatting improvements.
    • Removed Sun WEG integration documentation and added redirect for its URL.
    • Added new blog post announcing Motionblinds joining Works with Home Assistant.
    • Improved documentation clarity and added new configuration options, entity descriptions, and troubleshooting sections across various integrations.
  • New Features
    • Added new queue management actions to Denon HEOS integration.
    • Added new optional configuration flags (flash, transition) to MQTT light integration.
    • Added new template function device_name(lookup_value) documented.
    • Added new supported devices to SwitchBot integration.
    • Added new sensor options and event types to various integrations.
  • Bug Fixes
    • Corrected links and wording in automation and blueprint documentation.
    • Fixed YAML example indentation in Worx Landroid integration.
  • Chores
    • Updated dependency versions in Gemfile and package.json.
    • Removed redundant code ownership assignment for Sun WEG documentation.

formatBCE and others added 30 commits September 20, 2024 20:57
Co-authored-by: Artur Pragacz <[email protected]>
Co-authored-by: Joost Lekkerkerker <[email protected]>
@home-assistant home-assistant bot added current This PR goes into the current branch has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 19, 2025
@home-assistant
Copy link

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 next branch. Please change the target branch of this PR to next and rebase if needed.

Copy link

netlify bot commented Apr 19, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 6dfacc1
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6803a6a7cf1b480008cce719
😎 Deploy Preview https://deploy-preview-38635--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@GorgeOu GorgeOu closed this Apr 19, 2025
@home-assistant home-assistant bot removed in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 19, 2025
Copy link
Contributor

coderabbitai bot commented Apr 19, 2025

Warning

Rate limit exceeded

@home-assistant[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 40 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between c51b56e and 6dfacc1.

⛔ Files ignored due to path filters (10)
  • Gemfile.lock is excluded by !**/*.lock
  • package-lock.json is excluded by !**/package-lock.json
  • source/images/blog/2025-03-motionblinds/art.jpg is excluded by !**/*.jpg
  • source/images/blog/2025-03-motionblinds/matter-hub.jpg is excluded by !**/*.jpg
  • source/images/blog/2025-03-motionblinds/powered-by-eve.png is excluded by !**/*.png
  • source/images/dashboards/clock_card_default.png is excluded by !**/*.png
  • source/images/dashboards/clock_card_large.png is excluded by !**/*.png
  • source/images/dashboards/clock_card_medium.png is excluded by !**/*.png
  • source/images/integrations/mcp_server/cursor-lights-control.png is excluded by !**/*.png
  • source/images/screenshots/nmbs-card-example.png is excluded by !**/*.png
📒 Files selected for processing (79)
  • CODEOWNERS (0 hunks)
  • Gemfile (2 hunks)
  • package.json (1 hunks)
  • source/_dashboards/clock.markdown (1 hunks)
  • source/_dashboards/picture-glance.markdown (1 hunks)
  • source/_docs/automation/templating.markdown (1 hunks)
  • source/_docs/blueprint/schema.markdown (1 hunks)
  • source/_docs/configuration/state_object.markdown (1 hunks)
  • source/_docs/configuration/templating.markdown (6 hunks)
  • source/_docs/scripts/perform-actions.markdown (1 hunks)
  • source/_docs/z-wave/controllers.markdown (2 hunks)
  • source/_includes/custom/news.html (1 hunks)
  • source/_integrations/aemet.markdown (1 hunks)
  • source/_integrations/airthings.markdown (1 hunks)
  • source/_integrations/airzone.markdown (2 hunks)
  • source/_integrations/airzone_cloud.markdown (1 hunks)
  • source/_integrations/assist_satellite.markdown (2 hunks)
  • source/_integrations/balay.markdown (1 hunks)
  • source/_integrations/bosch_alarm.markdown (1 hunks)
  • source/_integrations/constructa.markdown (1 hunks)
  • source/_integrations/eheimdigital.markdown (3 hunks)
  • source/_integrations/esphome.markdown (3 hunks)
  • source/_integrations/eve.markdown (1 hunks)
  • source/_integrations/file.markdown (2 hunks)
  • source/_integrations/gaggenau.markdown (1 hunks)
  • source/_integrations/generic_thermostat.markdown (1 hunks)
  • source/_integrations/gree.markdown (1 hunks)
  • source/_integrations/group.markdown (1 hunks)
  • source/_integrations/heos.markdown (3 hunks)
  • source/_integrations/hikvision.markdown (1 hunks)
  • source/_integrations/home_connect.markdown (1 hunks)
  • source/_integrations/homee.markdown (1 hunks)
  • source/_integrations/homekit.markdown (5 hunks)
  • source/_integrations/inkbird.markdown (1 hunks)
  • source/_integrations/jvc_projector.markdown (1 hunks)
  • source/_integrations/konnected.markdown (1 hunks)
  • source/_integrations/kulersky.markdown (1 hunks)
  • source/_integrations/lamarzocco.markdown (4 hunks)
  • source/_integrations/lg_thinq.markdown (1 hunks)
  • source/_integrations/light.mqtt.markdown (2 hunks)
  • source/_integrations/matter.markdown (1 hunks)
  • source/_integrations/mcp.markdown (3 hunks)
  • source/_integrations/mcp_server.markdown (2 hunks)
  • source/_integrations/miele.markdown (1 hunks)
  • source/_integrations/motionblinds_matter.markdown (2 hunks)
  • source/_integrations/mqtt.markdown (2 hunks)
  • source/_integrations/music_assistant.markdown (2 hunks)
  • source/_integrations/neff.markdown (1 hunks)
  • source/_integrations/nmbs.markdown (0 hunks)
  • source/_integrations/nuki.markdown (2 hunks)
  • source/_integrations/number.markdown (2 hunks)
  • source/_integrations/nut.markdown (3 hunks)
  • source/_integrations/ohme.markdown (1 hunks)
  • source/_integrations/pitsos.markdown (1 hunks)
  • source/_integrations/profilo.markdown (1 hunks)
  • source/_integrations/prusalink.markdown (1 hunks)
  • source/_integrations/pterodactyl.markdown (2 hunks)
  • source/_integrations/qnap_qsw.markdown (1 hunks)
  • source/_integrations/reolink.markdown (2 hunks)
  • source/_integrations/rexense.markdown (1 hunks)
  • source/_integrations/rpi_power.markdown (1 hunks)
  • source/_integrations/sensor.markdown (1 hunks)
  • source/_integrations/siemens.markdown (1 hunks)
  • source/_integrations/snoo.markdown (1 hunks)
  • source/_integrations/squeezebox.markdown (1 hunks)
  • source/_integrations/sun.markdown (1 hunks)
  • source/_integrations/sunweg.markdown (0 hunks)
  • source/_integrations/switchbot.markdown (2 hunks)
  • source/_integrations/template.markdown (6 hunks)
  • source/_integrations/thermador.markdown (1 hunks)
  • source/_integrations/totalconnect.markdown (0 hunks)
  • source/_integrations/vodafone_station.markdown (1 hunks)
  • source/_integrations/weheat.markdown (2 hunks)
  • source/_integrations/worxlandroid.markdown (1 hunks)
  • source/_posts/2025-03-27-motionblinds-joins-wwha.markdown (1 hunks)
  • source/_redirects (1 hunks)
  • source/integrations/index.html (1 hunks)
  • source/more-info/backup-emergency-kit.markdown (1 hunks)
  • source/voice_control/voice_remote_cloud_assistant.markdown (1 hunks)
📝 Walkthrough

Walkthrough

This update introduces several new integration documentation files (e.g., for Bosch Alarm, Eve, Miele, and multiple Home Connect brands), expands and clarifies existing integration docs, and removes the Sun WEG integration documentation. It adds new configuration options and supported entities to various integrations, corrects and improves documentation for templating, automation, and entity naming, and updates metadata for integrations and packages. The update also includes new blog content, a redirect for the removed Sun WEG integration, and minor improvements to UI logic and documentation clarity throughout the project.

Changes

File(s) / Path(s) Change Summary
source/_integrations/bosch_alarm.markdown, source/_integrations/eve.markdown, source/_integrations/miele.markdown, source/_integrations/balay.markdown, source/_integrations/constructa.markdown, source/_integrations/gaggenau.markdown, source/_integrations/neff.markdown, source/_integrations/pitsos.markdown, source/_integrations/profilo.markdown, source/_integrations/siemens.markdown, source/_integrations/thermador.markdown, source/_integrations/rexense.markdown Added new integration documentation files with metadata, configuration, and supported platforms for Bosch Alarm, Eve, Miele, Balay, Constructa, Gaggenau, Neff, Pitsos, Profilo, Siemens, Thermador, and Rexense.
source/_integrations/sunweg.markdown Deleted Sun WEG integration documentation file.
CODEOWNERS Removed code ownership assignment for the deleted Sun WEG documentation file.
source/_redirects Added redirect from /integrations/sunweg to /more-info/removed-integration.
Gemfile, package.json Updated gem and npm package versions for dependencies (sass-embedded, rubocop, ruby-lsp, nokogiri, textlint).
source/_dashboards/clock.markdown Added new documentation for the Clock card dashboard widget, including configuration, screenshots, and examples.
source/_dashboards/picture-glance.markdown Added new optional fit_mode parameter to the picture glance card configuration.
source/_docs/automation/templating.markdown Fixed link to device triggers section (pluralized anchor).
source/_docs/blueprint/schema.markdown Added required domain: automation key to minimal blueprint example.
source/_docs/configuration/state_object.markdown Clarified screenshot description to specify Developer Tools States page.
source/_docs/configuration/templating.markdown Documented new device_name(lookup_value) template function and clarified lookup options for floor_id and area_id.
source/_docs/scripts/perform-actions.markdown Clarified wording: changed "call a configuration" to "perform action".
source/_docs/z-wave/controllers.markdown Clarified compatibility issues for Z-Wave.Me UZB1 and generalized Aeotec Z-Stick compatibility note.
source/_includes/custom/news.html Added promotional card for "State of the Open Home 2025" event.
source/_integrations/aemet.markdown, source/_integrations/airzone.markdown, source/_integrations/airzone_cloud.markdown, source/_integrations/qnap_qsw.markdown Added "Removing the integration" section referencing standard removal procedure and device removal snippet.
source/_integrations/airthings.markdown Clarified role of SmartLink hub for live updates in Airthings integration.
source/_integrations/eheimdigital.markdown Documented new number and sensor entities for EHEIM devices; updated metadata for categories/platforms.
source/_integrations/esphome.markdown Clarified entity naming rules; removed legacy naming section.
source/_integrations/file.markdown Updated example file paths to /config/ and simplified value templates.
source/_integrations/generic_thermostat.markdown Clarified heater start condition for cold_tolerance option.
source/_integrations/gree.markdown Improved formatting for switch feature descriptions.
source/_integrations/group.markdown Clarified that group actions apply only to old-style groups.
source/_integrations/heos.markdown Added documentation for new queue management actions: heos.move_queue_item, heos.remove_from_queue, and example for playing queue items.
source/_integrations/hikvision.markdown Added new supported camera model to compatibility list.
source/_integrations/home_connect.markdown Added note clarifying event sensors are created only after appliance reports an event.
source/_integrations/homee.markdown Added climate to supported platforms; removed redundant device type list.
source/_integrations/homekit.markdown Added air purifier support for fan entities, new configuration keys, and updated documentation for HomeKit integration.
source/_integrations/inkbird.markdown Added IAM-T1 device support and troubleshooting instructions.
source/_integrations/jvc_projector.markdown Added password hashing instructions for NZ800/NZ900 models.
source/_integrations/konnected.markdown Clarified and updated API host override option naming and descriptions.
source/_integrations/kulersky.markdown Added ha_bluetooth: true to metadata; removed detailed Bluetooth installation notes.
source/_integrations/lamarzocco.markdown Changed IoT class to "Cloud Push", removed local/Bluetooth support, updated entity descriptions and controllability, added new sensors, and revised documentation accordingly.
source/_integrations/lg_thinq.markdown Removed detailed user guide and automation script; replaced with minimal automation example; removed duplicate codeowners entry.
source/_integrations/light.mqtt.markdown, source/_integrations/mqtt.markdown Documented new optional flash and transition flags in MQTT light JSON schema; added MQTT discovery abbreviations flsh and trns.
source/_integrations/matter.markdown Added "Car" to supported categories in Matter integration metadata.
source/_integrations/mcp.markdown, source/_integrations/mcp_server.markdown Documented OAuth authentication support for MCP integration and specification; added Cursor client example and OAuth details.
source/_integrations/music_assistant.markdown Streamlined documentation, clarified payload formats, consolidated manual config section, and added removal instructions.
source/_integrations/motionblinds_matter.markdown Updated domain, expanded and categorized supported device list, and added connectivity requirements.
source/_integrations/nmbs.markdown Removed screenshot and caption for NMBS card.
source/_integrations/nuki.markdown Expanded introduction, clarified prerequisites, and listed local integration alternatives (HomeKit, MQTT, Matter).
source/_integrations/number.markdown, source/_integrations/sensor.markdown Added "kvar" as a valid unit for reactive_power device class.
source/_integrations/nut.markdown Added reconfiguration instructions, reformatted command list, and clarified polling interval customization.
source/_integrations/ohme.markdown Added use cases, examples, troubleshooting, data update intervals, and limitations sections.
source/_integrations/pterodactyl.markdown Added button and sensor platform categories; documented new button and sensor entities for game servers.
source/_integrations/prusalink.markdown Updated related link title for accuracy.
source/_integrations/reolink.markdown Added new select entity option and troubleshooting section for battery drain.
source/_integrations/rpi_power.markdown Expanded and clarified description, added functionality and limitation notes.
source/_integrations/snoo.markdown Added "Config change" event to Snoo event documentation.
source/_integrations/squeezebox.markdown Added documentation for new switch entities: Alarm and Alarms Enabled.
source/_integrations/sun.markdown Added introductory paragraph explaining sun event calculation based on home location.
source/_integrations/switchbot.markdown Added Roller Shade and HubMini Matter to supported devices; described Roller Shade as a cover entity.
source/_integrations/template.markdown Improved clarity and consistency; expanded explanation of optimistic mode and added dedicated section.
source/_integrations/totalconnect.markdown Removed documentation of triggered_source attribute for triggered state.
source/_integrations/vodafone_station.markdown Changed ha_quality_scale metadata from "silver" to "platinum".
source/_integrations/weheat.markdown Added descriptions for Central heating flow and DHW pump flow sensors.
source/_integrations/worxlandroid.markdown Corrected YAML example indentation for sensor platform configuration.
source/_posts/2025-03-27-motionblinds-joins-wwha.markdown Added new blog post announcing Motionblinds as a Works with Home Assistant partner.
source/integrations/index.html Updated logic to clear "brands" filter when selecting a category filter in the integration filter dropdown.
source/more-info/backup-emergency-kit.markdown Streamlined wording regarding backup encryption choice.
source/voice_control/voice_remote_cloud_assistant.markdown Changed plain text "default configuration" reference to a markdown link.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistantDocs

    User->>HomeAssistantDocs: Requests integration documentation (e.g., Bosch Alarm, Eve, Miele)
    HomeAssistantDocs-->>User: Returns new/updated documentation with metadata, configuration, and supported features

    User->>HomeAssistantDocs: Requests removed integration (Sun WEG)
    HomeAssistantDocs-->>User: Redirects to removed integration info page

    User->>HomeAssistantDocs: Requests dashboard or automation documentation
    HomeAssistantDocs-->>User: Returns updated docs with new options, examples, and clarifications

    User->>HomeAssistantDocs: Requests MQTT integration documentation
    HomeAssistantDocs-->>User: Returns docs with new feature flags and abbreviation mappings

    User->>HomeAssistantDocs: Accesses UI with filter selections
    HomeAssistantDocs-->>User: Updates URL and filter state according to new logic
Loading

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 19, 2025
@home-assistant
Copy link

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 next branch. Please change the target branch of this PR to next and rebase if needed.

@github-actions github-actions bot locked and limited conversation to collaborators Apr 20, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.