docs: lovelace template corrections for binary_sensors

[geertmeersman]

Summary by CodeRabbit

• Documentation
  • Updated feature descriptions for clarity on MQTT and REST sensor behavior.
  • Expanded installation instructions for HACS and manual methods.
  • Enhanced service descriptions with parameters and examples.
  • Modified Lovelace examples to use correct entity types.
  • Improved markdown structure for Lovelace card examples.

[coderabbitai]

Walkthrough

The changes in this pull request focus on enhancing the README.md documentation for the Robonect integration with Home Assistant. Key updates include clarifications in feature descriptions, expanded installation instructions for both HACS and manual methods, and detailed service descriptions. Additionally, modifications were made to Lovelace card examples to ensure proper entity references and improve code structure for better readability.

Changes

File	Change Summary
README.md	- Clarified feature descriptions, emphasizing MQTT over REST sensors. - Expanded installation instructions with detailed steps. - Updated service descriptions with parameters and examples. - Modified Lovelace card examples to use binary sensors for specific conditions. - Improved markdown code structure for Lovelace cards.

Possibly related PRs

• fix: limit direct service timeout to 5000ms, fixes #205 #206: This PR enhances the README.md documentation for the Robonect integration, similar to the main PR's focus on improving service descriptions and installation instructions.
• docs: lovelace card change vacuum to lawn_mower #212: This PR updates the README.md to reflect changes in entity types and Lovelace card configurations, which aligns with the main PR's modifications to Lovelace examples and service descriptions.

Suggested labels

patch, docs

🐰 In the garden where bunnies play,
The README blooms in a clearer way.
With features bright and steps so neat,
For Robonect, a guide complete!
Installation made easy, oh what a treat! 🌼

---

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 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 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

🧹 Outside diff range and nitpick comments (3)

README.md (3)

350-351: LGTM: Corrected entity types in Lovelace example

The changes from sensors to binary sensors for automower_mower_stopped and automower_weather_data_break are correct and will improve the accuracy of the Lovelace card's conditional logic.

Consider adding a comment in the code to explain why these entities are binary sensors, as it might not be immediately obvious to users unfamiliar with the Robonect integration.

Also applies to: 400-401

---

Line range hint 570-700: LGTM: Comprehensive service documentation added

The additions to the Available Services section greatly enhance the documentation. Each service now has a clear description, fields, examples, and options where applicable. This will be very helpful for users implementing these services in their Home Assistant setup.

Consider adding a brief example of how to call each service using the Home Assistant service call syntax. This would provide a complete picture for users who are new to using custom services.

---

Line range hint 740-746: LGTM: Clarification on REST sensor behavior

The new section on REST sensors and the REST category provides valuable information about sensor update behavior. This clarification will help users understand why certain sensors might not update during the mower's sleep phase.

Consider adding a brief explanation of why non-status REST sensors are not updated during sleep mode. This could help users understand the reasoning behind this behavior.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2339afc and 92ba573.

📒 Files selected for processing (1)

• README.md (2 hunks)

🧰 Additional context used

🔇 Additional comments (2)

README.md (2)

Line range hint 9-21: LGTM: Improved clarity in feature descriptions

The changes in the Features section provide better clarity on sensor priorities and behavior. The explanation of REST sensor updates during sleep mode is particularly helpful for users to understand the system's operation.

---

Line range hint 702-738: LGTM: Comprehensive screenshot additions

The new screenshots added to the documentation provide excellent visual context for users. They cover various aspects of the integration, including the device page, diagnostics, configuration flow, and options. This visual guide will be very helpful for users setting up and using the Robonect integration.