Add documentation for Hydrawise services

[dknowles2]

Proposed change

Add documentation for Hydrawise services added in https://github.com/home-assistant/core/pull/120883

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).
  • [ ] I've opened up a PR to add logos and icons in Brands repository.
• [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: https://github.com/home-assistant/core/pull/120883
• 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 service to start a watering cycle in an irrigation zone.
  • Added service to suspend automatic watering in an irrigation zone until a specified date.
  • Added service to resume automatic watering in an irrigation zone.

These updates enhance user control over irrigation operations within the Hydrawise integration.

[coderabbitai[bot]]

Walkthrough

Walkthrough

The latest updates to the Hydrawise integration introduce three new custom services—hydrawise.start_watering, hydrawise.suspend, and hydrawise.resume. These services enhance user control over irrigation zones, enabling manual initiation of watering cycles for a specified duration, the ability to suspend automatic watering until a designated date, and the option to resume automatic watering. This significantly improves the management of irrigation operations.

Changes

File Path	Change Summary
source/_integrations/hydrawise.markdown	Introduced new services: hydrawise.start_watering, hydrawise.suspend, and hydrawise.resume, enhancing control over irrigation zones.

Sequence Diagram(s)

Starting a Watering Cycle

sequenceDiagram
    participant User
    participant HomeAssistant
    participant HydrawiseService

    User->>HomeAssistant: Call `hydrawise.start_watering` with `entity_id` and `duration`
    HomeAssistant->>HydrawiseService: Forward request to start watering
    HydrawiseService-->>HomeAssistant: Confirm start of watering cycle
    HomeAssistant-->>User: Notify watering cycle started

Suspending Automatic Watering

sequenceDiagram
    participant User
    participant HomeAssistant
    participant HydrawiseService

    User->>HomeAssistant: Call `hydrawise.suspend` with `entity_id` and `until`
    HomeAssistant->>HydrawiseService: Forward request to suspend watering
    HydrawiseService-->>HomeAssistant: Confirm watering suspended
    HomeAssistant-->>User: Notify watering is suspended

Resuming Automatic Watering

sequenceDiagram
    participant User
    participant HomeAssistant
    participant HydrawiseService

    User->>HomeAssistant: Call `hydrawise.resume` with `entity_id`
    HomeAssistant->>HydrawiseService: Forward request to resume watering
    HydrawiseService-->>HomeAssistant: Confirm watering resumed
    HomeAssistant-->>User: Notify watering is resumed

---

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.

[netlify[bot]]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	c2a563d5adaecef03367649ae5ade9a3d4edb11c
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/66a8d5de7f378f00084a72e2
😎 Deploy Preview	https://deploy-preview-33495--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle 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[bot]]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:

Learn more about our pull request process.