Add once flag to SubscribeHomeAssistantStateResponse

[jesserockz]

This will allow one-shot state/attribute retrieval from the device.

Related PRs:

• [api] Add new flag to request state/attribute once from HA only esphome#7258
• [homeassistant] Native number entity import and control esphome#6455

The attributes of the number only need to be retrieved once per connection.
If they are changed at runtime, I think a restart/reconnection of the ESPHome device is sufficient to allow us not to have another state subscription sitting there.

[coderabbitai]

Walkthrough

The recent update enhances the SubscribeHomeAssistantStateResponse message within the API by adding a new boolean field, once. This modification allows clients to specify whether their subscription to Home Assistant state updates should be a one-time event or a continuous stream. This flexibility optimizes resource usage for clients that require occasional updates rather than continuous streams, improving the overall efficiency of the API interactions.

Changes

Files	Change Summary
aioesphomeapi/api.proto	Added a boolean field once to the SubscribeHomeAssistantStateResponse message, allowing specification of one-time or continuous subscription.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant HomeAssistant

    Client->>API: Subscribe to Home Assistant State (with once = true)
    API->>HomeAssistant: Request state update
    HomeAssistant-->>API: Provide current state
    API-->>Client: Send state update (once)

Loading

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.