Skip to content

Add cover entity #38894

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 1 commit into from
Closed

Conversation

markhannon
Copy link

@markhannon markhannon commented May 6, 2025

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).
  • [x ] 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

  • [x ] 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.
  • [x ] The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features

    • Added documentation for the Zimi integration, enabling support for Zimi Cloud Connect devices and their connected devices in Home Assistant.
    • Introduced new integration documentation files for Balay, Constructa, Gaggenau, Google Gemini, Imeon Inverter, Miele, National Grid US, Neff, Nuki Matter, Pitsos, Profilo, Rehlko, S3, Siemens, Thermador, and Zimi.
    • Expanded documentation for several integrations, including new entity types, configuration options, and troubleshooting sections.
    • Added new configuration options and supported device types for existing integrations such as HomeKit, ESPHome, Matter, Teslemetry, and others.
  • Documentation

    • Updated and clarified documentation across numerous integrations, including configuration details, supported platforms, usage examples, troubleshooting guidance, and removal instructions.
    • Improved descriptions, added new sections, and expanded supported device and entity lists for multiple integrations.
    • Revised and standardized configuration schemas and terminology in several integration documents.
  • Bug Fixes

    • Corrected and clarified documentation wording and configuration examples to improve accuracy and usability.
  • Chores

    • Updated spell checker dictionary to recognize "Zimi."
    • Assigned documentation ownership for the Maytag integration.
    • Added or updated integration metadata for new and existing integrations.

Copy link
Contributor

coderabbitai bot commented May 6, 2025

📝 Walkthrough

Walkthrough

This update introduces multiple new integrations and expands documentation across several Home Assistant components. It adds new configuration options, updates entity support, clarifies setup and troubleshooting procedures, and enhances YAML schemas for various integrations and dashboard cards. Several new integration metadata files are included, while some documentation files are removed or replaced. The changes also standardize terminology and add new device/platform support in existing integrations.

Changes

File(s) / Path(s) Change Summary
.vscode/cSpell.json Added "Zimi" to spell checker dictionary.
CODEOWNERS Assigned @abmantis as owner of source/_integrations/maytag.markdown.
source/_dashboards/clock.markdown Added a newline at end of file.
source/_dashboards/energy.markdown Updated energy card config section; added YAML options for Sankey energy graph.
source/_dashboards/gauge.markdown Added optional attribute YAML parameter and example for gauge card.
source/_dashboards/picture-glance.markdown Added optional fit_mode parameter to picture glance card configuration.
source/_docs/configuration/templating.markdown Documented new device_name() template function and clarified floor_id/area_id input types.
source/_includes/common-tasks/backups.md Inserted step for automatic backup before update; renumbered following steps.
source/_integrations/airzone.markdown Added battery and signal_strength zone sensors to Airzone integration docs.
source/_integrations/backup.markdown Added documentation for "Last attempted automatic backup" sensor.
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 Added new integration metadata files for Balay, Constructa, Gaggenau, Neff, Pitsos, Profilo, Siemens, Thermador (Home Connect family).
source/_integrations/bluetooth.markdown Added "Advertisement monitor" and "Connection monitor" troubleshooting sections.
source/_integrations/bosch_alarm.markdown Added sensor entity support to Bosch Alarm Panel integration documentation.
source/_integrations/dhcp.markdown, source/_integrations/ssdp.markdown, source/_integrations/zeroconf.markdown Added troubleshooting sections describing DHCP, SSDP/UPnP, and Zeroconf browsers.
source/_integrations/eheimdigital.markdown Added Number, Sensor, Switch, and Time platform support; expanded entity documentation.
source/_integrations/esphome.markdown Clarified entity naming and added section on device reconfiguration and name conflict resolution.
source/_integrations/eve.markdown Removed "works_with: matter" from metadata.
source/_integrations/fritz.markdown Added "Enable network device tracking" option; updated descriptions to plain text.
source/_integrations/generic_thermostat.markdown Clarified cold_tolerance description (removes "equals or").
source/_integrations/google_gemini.markdown Added new integration metadata and configuration documentation for Google Gemini.
source/_integrations/google_travel_time.markdown Updated to reflect switch from Distance Matrix API to Google Maps Routes API; revised quotas, intervals, and billing info.
source/_integrations/govee_ble.markdown Added H5110 Hygrometer Thermometer to supported devices.
source/_integrations/hassio.markdown Removed documentation for hassio.addon_update action.
source/_integrations/heos.markdown Added documentation for heos.move_queue_item and heos.remove_from_queue actions.
source/_integrations/home_connect.markdown Added note: event sensors provided only after appliance reports event.
source/_integrations/homee.markdown Added climate to supported platforms; removed explicit device type list.
source/_integrations/homekit.markdown Added air purifier support for fan entities; new entity config keys for linked sensors; updated docs and tables.
source/_integrations/imeon_inverter.markdown Added new integration documentation for Imeon Inverter.
source/_integrations/inkbird.markdown Added IAM-T1 Air Quality Monitor support and troubleshooting guidance.
source/_integrations/jewish_calendar.markdown Updated count_omer action: date now optional, new after_sunset parameter, language now optional.
source/_integrations/kulersky.markdown Added ha_bluetooth: true to metadata; removed Linux Bluetooth setup notes.
source/_integrations/lamarzocco.markdown Shifted from local/cloud polling to cloud push; removed local config/host, revised entity lists and update intervals.
source/_integrations/light.mqtt.markdown Added optional boolean flash and transition flags to MQTT light config.
source/_integrations/matter.markdown Added "Car" and "Water heater" categories/platforms to Matter integration metadata.
source/_integrations/maytag.markdown Added new integration metadata for Maytag (Whirlpool Appliances family).
source/_integrations/mcp.markdown Documented OAuth support in MCP integration; added config fields and authorization section.
source/_integrations/miele.markdown Added new integration documentation for Miele appliances.
source/_integrations/motionblinds_matter.markdown Changed domain; expanded and categorized supported devices list; added product/spec links.
source/_integrations/mqtt.markdown Added Light integration link; recognized new MQTT discovery abbreviations: flshflash, trnstransition.
source/_integrations/national_grid_us.markdown Added new integration metadata for National Grid US (Opower family).
source/_integrations/ntfy.markdown Added new integration documentation for ntfy notification service.
source/_integrations/nuki.markdown Updated title/description to specify "Nuki Bridge" only.
source/_integrations/nuki_matter.markdown Added new integration metadata for Nuki Matter.
source/_integrations/number.markdown, source/_integrations/sensor.markdown Added "kvar" as supported unit for reactive_power device class; expanded volume_flow_rate units.
source/_integrations/nut.markdown Added instructions for reconfiguring NUT device and clarified polling interval customization.
source/_integrations/ohme.markdown Added use cases, automation example, troubleshooting, data update intervals, and known limitations.
source/_integrations/oncue.markdown Removed Oncue by Kohler integration documentation file.
source/_integrations/opower.markdown Expanded utility list; added guidance for tracking energy returned to grid.
source/_integrations/overkiz.markdown Clarified Somfy TaHoma Developer Mode activation and token use; updated config example.
source/_integrations/pitsos.markdown Added new integration metadata for Pitsos (Home Connect family).
source/_integrations/pterodactyl.markdown Added button and sensor platforms; documented new button/sensor entities for game servers.
source/_integrations/rehlko.markdown Added new integration documentation for Rehlko (formerly Oncue/Kohler Energy).
source/_integrations/renault.markdown Added data update rate limits and polling interval explanation.
source/_integrations/reolink.markdown Added "Recording packing time" select entity to supported camera entities.
source/_integrations/s3.markdown Added new integration documentation for S3 backup integration.
source/_integrations/sensor.markdown Expanded supported units for reactive_power and volume_flow_rate device classes.
source/_integrations/squeezebox.markdown Split "Entities" into "Switches" and "Binary sensors"; added "Alarm" and "Alarms Enabled" switches.
source/_integrations/switchbot.markdown Added Fan device support (Circulator Fan) and described its features.
source/_integrations/template.markdown Added cover, light, switch entity support; standardized plural keys (triggers, conditions, actions); added cover config schema.
source/_integrations/teslemetry.markdown Added note on device tracker scope; documented many new binary sensors, sensors, and a switch entity.
source/_integrations/totalconnect.markdown Removed documentation for triggered_source attribute in alarm state.
source/_integrations/vesync.markdown Added "display" switch attribute to air purifier, humidifier, and fan/air quality sensors.
source/_integrations/weheat.markdown Added "Central heating flow" and "DHW pump flow" sensors to Weheat integration docs.
source/_integrations/whirlpool.markdown Added binary_sensor platform and documented washer/dryer door state.
source/_integrations/zimi.markdown Added new integration documentation for Zimi Cloud Controller.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant ZimiCloudConnect
    participant ZimiDevices

    User->>HomeAssistant: Initiate Zimi integration setup
    HomeAssistant->>ZimiCloudConnect: Discover Zimi Cloud Connect devices
    alt One device found
        ZimiCloudConnect-->>HomeAssistant: Return device info
        HomeAssistant->>User: Auto-configure integration
    else Multiple devices found
        ZimiCloudConnect-->>HomeAssistant: Return device list
        HomeAssistant->>User: Prompt user to select device
        User->>HomeAssistant: Select device
    else Discovery fails
        HomeAssistant->>User: Prompt for manual IP/port entry
        User->>HomeAssistant: Enter IP/port
    end
    HomeAssistant->>ZimiCloudConnect: Connect and retrieve device list
    ZimiCloudConnect-->>HomeAssistant: Return connected Zimi devices
    HomeAssistant->>ZimiDevices: Map Zimi device types to Home Assistant entities
    Note right of HomeAssistant: Entities created for lights, covers, switches, fans, outlets, etc.
    ZimiCloudConnect-->>HomeAssistant: Send real-time updates
    HomeAssistant->>User: Display/control Zimi devices in UI
Loading
sequenceDiagram
    participant User
    participant HomeAssistant
    participant ESPHomeDevice

    User->>HomeAssistant: Add/reconfigure ESPHome device
    HomeAssistant->>ESPHomeDevice: Attempt connection
    alt Name conflict detected
        HomeAssistant->>User: Trigger Name Conflict Resolution
        User->>HomeAssistant: Choose "Migrate" or "Overwrite"
        alt Migrate
            HomeAssistant->>ESPHomeDevice: Transfer config, preserve history
        else Overwrite
            HomeAssistant->>ESPHomeDevice: Replace config, erase history
        end
    else No conflict
        HomeAssistant->>ESPHomeDevice: Complete setup/reconfiguration
    end
    HomeAssistant->>User: Device available in Home Assistant
Loading
sequenceDiagram
    participant User
    participant HomeAssistant
    participant ntfyService

    User->>HomeAssistant: Configure ntfy integration (URL, credentials, topics)
    HomeAssistant->>ntfyService: Register/validate topic(s)
    HomeAssistant->>User: Create notify entities for each topic
    User->>HomeAssistant: Send notification via notify service
    HomeAssistant->>ntfyService: Publish message to topic
    ntfyService-->>User: Deliver notification to devices
Loading
sequenceDiagram
    participant User
    participant HomeAssistant
    participant S3Service

    User->>HomeAssistant: Configure S3 backup integration (credentials, bucket, endpoint)
    HomeAssistant->>S3Service: Validate credentials and bucket
    HomeAssistant->>User: Confirm S3 backup location
    HomeAssistant->>S3Service: Upload backup files as scheduled
    S3Service-->>HomeAssistant: Confirm upload success
Loading
sequenceDiagram
    participant User
    participant HomeAssistant
    participant MCPServer

    User->>HomeAssistant: Configure MCP integration (host, protocol, OAuth credentials)
    HomeAssistant->>MCPServer: Authenticate via OAuth (if required)
    MCPServer-->>HomeAssistant: Provide access token
    HomeAssistant->>MCPServer: Establish connection (SSE or stdio)
    MCPServer-->>HomeAssistant: Stream data/events
    HomeAssistant->>User: Display/control MCP devices
Loading
sequenceDiagram
    participant User
    participant HomeAssistant
    participant HomeConnectIntegration
    participant Appliance

    User->>HomeAssistant: Add Home Connect family integration (e.g., Balay, Gaggenau)
    HomeAssistant->>HomeConnectIntegration: Register new brand/domain
    HomeConnectIntegration->>Appliance: Discover/control appliance
    Appliance-->>HomeConnectIntegration: Report status/events
    HomeConnectIntegration-->>HomeAssistant: Update entities
    HomeAssistant->>User: Show appliance status in UI
Loading
sequenceDiagram
    participant User
    participant HomeAssistant
    participant ZimiCloudConnect

    User->>HomeAssistant: Change device/entity name in Zimi app
    ZimiCloudConnect-->>HomeAssistant: No automatic update (requires restart)
    User->>HomeAssistant: Restart Home Assistant
    HomeAssistant->>ZimiCloudConnect: Refresh device/entity names
    HomeAssistant->>User: Display updated names
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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

Copy link

netlify bot commented May 6, 2025

Deploy Preview for home-assistant-docs failed.

Name Link
🔨 Latest commit b7b2cc3
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6819b7d1e61e9300084479f4

@markhannon markhannon changed the base branch from current to next May 6, 2025 07:19
@home-assistant home-assistant bot removed the current This PR goes into the current branch label May 6, 2025
@home-assistant
Copy link

home-assistant bot commented May 6, 2025

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

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

Wrong branch

@c0ffeeca7
Copy link
Contributor

c0ffeeca7 commented May 6, 2025

the build failure was not your fault. it's an error I introduced elsewhere, see #38896. The indent was wrong there. So, if this PR has a related parent in core, next is the right branch.

@markhannon markhannon deleted the zimi-garage branch May 6, 2025 08:20
@github-actions github-actions bot locked and limited conversation to collaborators May 7, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants