Update balboa documentation for new time support

[natekspencer]

Proposed change

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.
• 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: Add time entity to balboa core#138248
• Link to parent pull request in the Brands repository:
• This PR fixes or closes issue: fixes #

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
  • Introduced a new "Time" device type for managing filter cycle start and end times.
  • Added an option to automatically sync the spa’s internal clock with Home Assistant daily.

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

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

[coderabbitai]

📝 Walkthrough

Walkthrough

This change enhances the Balboa Spa Client integration for Home Assistant by adding a new device type, "Time (Filter cycle start/end)", and a new configuration option, sync_time. The updates enable users to specify filter cycle start and end times and allow for the daily synchronization of the spa's internal clock with Home Assistant.

Changes

File(s)	Change Summary
source/_integrations/balboa.markdown	Added new device type "Time (Filter cycle start/end)" to the supported list and introduced the sync_time configuration option.

Sequence Diagram(s)

sequenceDiagram
    participant HA as Home Assistant
    participant Integration as Balboa Spa Client Integration
    participant Spa as Spa Device

    HA->>Integration: Load configuration (includes sync_time setting)
    Integration->>Spa: Request current clock time
    Spa-->>Integration: Provide current time
    alt sync_time enabled
        Integration->>Spa: Update internal spa clock to match HA time
        Spa-->>Integration: Confirm clock synchronization
    else
        Integration-->>HA: Continue without clock update
    end
    Integration-->>HA: Return updated status

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>, 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 or @coderabbitai title 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

source/_integrations/balboa.markdown (1)

55-57: New Configuration Option: sync_time
The new configuration option sync_time is clearly introduced to enable the daily synchronization of the spa's internal clock with Home Assistant. The description is succinct and informative.

Consider adding an example configuration snippet in the documentation to guide users on how to enable this feature.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3dfaaf9 and f6217b9.

📒 Files selected for processing (1)

• source/_integrations/balboa.markdown (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Redirect rules - home-assistant-docs
• GitHub Check: Header rules - home-assistant-docs
• GitHub Check: Pages changed - home-assistant-docs

🔇 Additional comments (2)

source/_integrations/balboa.markdown (2)

19-19: New Platform Entry in ha_platforms
The addition of - time in the ha_platforms list reflects the new device type for time-based functionalities. Ensure that the lowercase usage here aligns with the platform naming conventions while the display name later uses a capitalized "Time".

---

37-37: Addition of New Device Type in Supported List
The supported device types list now includes - Time (Filter cycle start/end), which clearly communicates the new functionality. This change is consistent with the PR's objective to introduce new time support features.

[c0ffeeca7]

Thank you, @natekspencer 👍