Add support for water_heater entities

[kpfleming]

Part of https://github.com/esphome/feature-requests/issues/2047.

[coderabbitai[bot]]

Walkthrough

The code changes enhance the aioesphomeapi library with support for managing water heaters. This includes the introduction of a new RPC method, message types, enums, and client methods to facilitate control and state reporting for water heaters. Additionally, comprehensive tests have been implemented to validate the new features.

Changes

Files	Change Summaries
aioesphomeapi/api.proto	Introduced new RPC method water_heater_command and message types like WaterHeaterMode, WaterHeaterCommandRequest, WaterHeaterStateResponse, and ListEntitiesWaterHeaterResponse.
aioesphomeapi/client.py	Added water_heater_command method to the Client class for controlling water heater operations.
aioesphomeapi/model.py	Added new classes related to water heaters: WaterHeaterMode, WaterHeaterInfo, and WaterHeaterState.
tests/test_client.py	Added tests for water_heater_command including checks for WaterHeaterCommandRequest and WaterHeaterMode.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant Client as Client
    participant APIConnection as APIConnection
    participant WaterHeater as WaterHeater

    User->>Client: Initiate water_heater_command
    Client->>APIConnection: water_heater_command(WaterHeaterCommandRequest)
    APIConnection->>WaterHeater: Execute command
    WaterHeater->>APIConnection: Acknowledge/State update
    APIConnection->>Client: Return response
    Client->>User: Command executed

---

Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

Commits

Files that changed from the base of the PR and between b9135c49db7743aa3e81f0c46ec3ba91042a314b and 2ee4240efff3ceed855765cd648e53d9d3cc35ea.

Files selected for processing (4)

• aioesphomeapi/api.proto (2 hunks)
• aioesphomeapi/client.py (3 hunks)
• aioesphomeapi/model.py (2 hunks)
• tests/test_client.py (5 hunks)

Additional context used

Path-based instructions (4)

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

aioesphomeapi/client.py (1)

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

tests/test_client.py (1)

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

Additional comments not posted (12)

aioesphomeapi/model.py (4)

1301-1308: LGTM! Enumeration for water heater modes is well-defined.

The WaterHeaterMode class correctly defines various operational modes for water heaters.

---

1312-1329: LGTM! Water heater information is well-structured.

The WaterHeaterInfo class encapsulates attributes related to water heater capabilities effectively.

---

1333-1348: LGTM! Water heater state is well-defined.

The WaterHeaterState class effectively maintains the current operational mode and temperature settings for water heaters.

---

1375-1375: LGTM! Dictionary update for water heater info is correct.

The _TYPE_TO_NAME dictionary correctly maps WaterHeaterInfo to "water_heater".

aioesphomeapi/api.proto (5)

1954-1968: LGTM! Message type for water heater command request is well-structured.

The WaterHeaterCommandRequest message type is correctly structured to include parameters for mode and target temperatures.

---

1941-1952: LGTM! Message type for water heater state response is well-defined.

The WaterHeaterStateResponse message type is correctly structured to report the water heater's mode and temperature settings.

---

1920-1940: LGTM! Message type for listing water heater entities is well-structured.

The ListEntitiesWaterHeaterResponse message type is correctly structured to include capabilities and current states of water heaters.

---

1911-1919: LGTM! Enumeration for water heater modes is well-defined.

The WaterHeaterMode enum specifies various operational modes for water heaters.

---

67-67: LGTM! RPC method for water heater command is well-defined.

The water_heater_command RPC method is correctly defined to accept WaterHeaterCommandRequest.

Ensure that the implementation supports this new RPC method.

Verification successful

---

The water_heater_command RPC method is implemented and tested.

The water_heater_command RPC method is referenced and tested in the following files:

• aioesphomeapi/client.py: Client-side implementation.
• tests/test_client.py: Test for the RPC method.

These references indicate that the method is implemented and its functionality is being verified through tests.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the implementation of the `water_heater_command` RPC method.

# Test: Search for the implementation of the `water_heater_command` method. Expect: Implementation details.
rg --type proto -A 5 $'rpc water_heater_command'

Length of output: 79

---

Script:

#!/bin/bash
# Description: Verify the implementation of the `water_heater_command` RPC method.

# Test: Search for the implementation of the `water_heater_command` method without specifying file type.
rg -A 5 $'rpc water_heater_command'

Length of output: 316

---

Script:

#!/bin/bash
# Description: Search for references to the `water_heater_command` RPC method in the codebase.

# Test: Find all occurrences of `water_heater_command` to verify its implementation or usage.
rg 'water_heater_command'

Length of output: 50848

aioesphomeapi/client.py (1)

1427-1449: LGTM! Ensure the new types are correctly integrated.

The water_heater_command method is well-implemented and consistent with existing patterns in the codebase.

However, verify that WaterHeaterCommandRequest and WaterHeaterMode are correctly defined and integrated within the codebase.

Verification successful

---

Verification Successful: Classes are Correctly Integrated

The WaterHeaterCommandRequest and WaterHeaterMode are appropriately defined and integrated within the codebase:

• WaterHeaterCommandRequest is defined in aioesphomeapi/api_pb2.py and used across multiple files, including aioesphomeapi/client.py and tests/test_client.py.
• WaterHeaterMode is defined as an enum in aioesphomeapi/api.proto and is used in aioesphomeapi/model.py and aioesphomeapi/client.py.

These definitions confirm that the new method water_heater_command in aioesphomeapi/client.py is correctly utilizing these types. No issues were found regarding their integration.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the definitions and integration of `WaterHeaterCommandRequest` and `WaterHeaterMode`.

# Test: Search for the definitions and ensure they are correctly implemented.
ast-grep --lang python --pattern $'class WaterHeaterCommandRequest { $$$ }'
ast-grep --lang python --pattern $'class WaterHeaterMode { $$$ }'

Length of output: 1057

---

Script:

#!/bin/bash
# Description: Verify the definitions of `WaterHeaterCommandRequest` and `WaterHeaterMode`.

# Corrected Test: Search for the class definitions using the correct pattern syntax.
ast-grep --lang python --pattern 'class WaterHeaterCommandRequest'
ast-grep --lang python --pattern 'class WaterHeaterMode'

Length of output: 817

---

Script:

#!/bin/bash
# Description: Search for import statements or references to `WaterHeaterCommandRequest` and `WaterHeaterMode`.

# Search for any import statements or references to these classes.
rg 'WaterHeaterCommandRequest'
rg 'WaterHeaterMode'

Length of output: 103258

tests/test_client.py (2)

77-77: Imports are correctly added for new functionality.

The imports WaterHeaterCommandRequest and WaterHeaterMode are necessary for the new water heater command tests.

Also applies to: 116-116

---

2607-2635: Test function test_water_heater_command is well-structured and comprehensive.

The test function effectively covers various scenarios for water heater commands, ensuring that the send function is called with the correct request. The use of pytest.mark.parametrize enhances coverage by testing multiple input cases.

---

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.

[bdraco]

Is there an ESPHome PR for this ?

[kpfleming]

There is not yet, although I could begin working on one. I'm not aware of any method for an ESPHome PR to build against this one, so the CI jobs on the ESPHome PR will fail (but I can build locally).

[bdraco]

There is not yet, although I could begin working on one. I'm not aware of any method for an ESPHome PR to build against this one, so the CI jobs on the ESPHome PR will fail (but I can build locally).

You should be able to build it without updating aioesphomeapi there as there is a separate api.proto in that repo