Skip to content
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

Add sensor platform to laundrify integration #33596

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

xLarry
Copy link
Contributor

@xLarry xLarry commented Jul 6, 2024

Proposed change

Sensor platform (showing latest measurement and total consumption) has been added to HA.

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

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

  • New Features
    • Added sensor platform to the laundrify integration in Home Assistant.
    • Introduced new entities to monitor washing machine or dryer status:
      • Wash Cycle indicating whether the cycle is running or not.
      • Power reporting the latest power measurement in Watts.
      • Energy tracking total energy consumption in kWh.

@home-assistant
Copy link

home-assistant bot commented Jul 6, 2024

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.

@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 next This PR goes into the next branch labels Jul 6, 2024
Copy link
Contributor

coderabbitai bot commented Jul 6, 2024

Walkthrough

Walkthrough

The laundrify integration in Home Assistant now includes a new sensor platform with entities like Wash Cycle, Power, and Energy. These entities help users monitor the status, power consumption, and energy consumption of their washing machines or dryers. The addition enhances the integration's functionality by providing more detailed insights into laundry appliance operations.

Changes

File(s) Change Summary
source/_integrations/laundrify.markdown Added description and documentation for the new sensor platform and its supported entities.
...laundrify.markdown Modified ha_platforms to include the sensor platform, alongside the existing binary_sensor.
...laundrify.markdown Added documentation for new Wash Cycle, Power, and Energy entities, detailing their states.

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 1de6d75 and eae069e.

Files selected for processing (1)
  • source/_integrations/laundrify.markdown (2 hunks)
Additional context used
LanguageTool
source/_integrations/laundrify.markdown

[misspelling] ~18-~18: Possible spelling mistake found.
Context: ...or dryer within Home Assistant using a laundrify WiFi power plug...

(MORFOLOGIK_RULE_EN_US)


[misspelling] ~18-~18: Did you mean “Wi-Fi”? (This is the officially approved term by the Wi-Fi Alliance.)
Context: ...ng a laundrify WiFi power plug. The following platforms/en...

(WIFI)

Additional comments not posted (4)
source/_integrations/laundrify.markdown (4)

11-11: Correctly added the sensor platform.

The sensor platform is correctly added to the list of platforms supported by the Laundrify integration.


23-23: Correctly added the Wash Cycle entity under the Binary sensor platform.

The Wash Cycle entity with states _running_ and _not running_ is correctly added under the Binary sensor platform.


24-26: Correctly added the Sensor platform and its entities.

The Sensor platform with entities Power (latest measurement in Watts) and Energy (total consumption in kWh) is correctly added.


18-18: Correct the spelling of "WiFi".

The correct term is "Wi-Fi" as per the Wi-Fi Alliance.
[misspelling]

-  using a [laundrify](https://laundrify.de/) WiFi power plug.
+  using a [laundrify](https://laundrify.de/) Wi-Fi power plug.
Tools
LanguageTool

[misspelling] ~18-~18: Possible spelling mistake found.
Context: ...or dryer within Home Assistant using a laundrify WiFi power plug...

(MORFOLOGIK_RULE_EN_US)


[misspelling] ~18-~18: Did you mean “Wi-Fi”? (This is the officially approved term by the Wi-Fi Alliance.)
Context: ...ng a laundrify WiFi power plug. The following platforms/en...

(WIFI)


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
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 Configration 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 Jul 6, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit eae069e
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/66895bab4d5a990008c803c5
😎 Deploy Preview https://deploy-preview-33596--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.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo and removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Jul 6, 2024
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Approved. Can be merged as soon as the parent PR gets merged.

@frenck frenck added the awaits-parent Awaits the merge of an parent PR label Jul 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaits-parent Awaits the merge of an parent PR has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants