Add support for cover toggle_action

[felipecrs]

Needs esphome/esphome#8049

Refs home-assistant/core#135099
Refs home-assistant/core#135103

[codspeed-hq]

CodSpeed Performance Report

Merging #1025 will not alter performance

_{Comparing felipecrs:cover-toggle (fab61cd) with main (0d0ec3c)}

Summary

✅ 2 untouched benchmarks

[coderabbitai]

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 buf (1.47.2)

aioesphomeapi/api.proto

Config file YAML parsing error: yaml: unmarshal errors:
line 1: cannot unmarshal !!str lint:{u... into bufconfig.externalFileVersion. Please check your buf configuration file for YAML syntax errors.

Walkthrough

The changes introduce support for a toggle functionality in the ESPHome API for cover entities. This enhancement is implemented across three files: api.proto, client.py, and model.py. A new boolean field supports_toggle is added to indicate whether a cover can be toggled, and a corresponding method parameter is introduced to enable toggling cover states when the API version supports it.

Changes

File	Change Summary
aioesphomeapi/api.proto	Added bool supports_toggle = 13; to ListEntitiesCoverResponse message
aioesphomeapi/client.py	Updated cover_command method signature to include toggle: bool = False parameter
aioesphomeapi/model.py	Added supports_toggle: bool = False field to CoverInfo class

Sequence Diagram

sequenceDiagram
    participant Client
    participant APIClient
    participant CoverEntity
    
    Client->>APIClient: cover_command(key, toggle=True)
    alt API Version ≥ 1.1
        APIClient->>CoverEntity: Toggle cover state
    else API Version < 1.1
        APIClient->>CoverEntity: Ignore toggle request
    end

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0d0ec3c and fab61cd.

📒 Files selected for processing (3)

• aioesphomeapi/api.proto (1 hunks)
• aioesphomeapi/client.py (2 hunks)
• aioesphomeapi/model.py (1 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

aioesphomeapi/client.py (1)

Pattern **: - Do not generate or add any sequence diagrams

aioesphomeapi/model.py (1)

Pattern **: - Do not generate or add any sequence diagrams

aioesphomeapi/api.proto (1)

Pattern **: - Do not generate or add any sequence diagrams

🔇 Additional comments (3)

aioesphomeapi/model.py (1)

225-225: LGTM! The new field follows the established pattern.

The addition of supports_toggle is well-placed and properly typed with a sensible default value.

aioesphomeapi/client.py (1)

Line range hint 964-976: LGTM! The toggle functionality is properly implemented.

The changes maintain backward compatibility by checking the API version before using the toggle feature. The parameter is well-placed in the method signature and follows the established pattern of other optional parameters.

aioesphomeapi/api.proto (1)

303-303: LGTM! The protobuf field is properly defined.

The new field follows the established pattern and uses an appropriate field number in sequence.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @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 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.