home-assistant.io icon indicating copy to clipboard operation
home-assistant.io copied to clipboard

Fix documentation: update invalid example of venetian blind in `cover.mqtt.markdown`

Open ma-zal opened this issue 1 year ago • 3 comments

Proposed change

This PR fixes the example in documentation page "MQTT Cover". Fixes:

  • Incorrect property name tilt_value. Correct is tilt_position.
  • Minor issues in code syntax
  • Unclear local variable names

Referenced PR, where the test for tilt_position has been added: https://github.com/home-assistant/core/pull/50236 Reference to code, where tilt_position is implemented: https://github.com/home-assistant/core/blob/94506c3c90bd3bd1e289880edf0bf6bd9fbbd900/homeassistant/components/mqtt/cover.py#L437

Type of change

  • [ ] Spelling, grammar or other readability improvements (current branch).
  • [x] 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

  • Link to parent pull request in the codebase: N/A
  • Link to parent pull request in the Brands repository: N/A
  • This PR fixes or closes issue: N/A

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

    • Enhanced documentation for MQTT cover integration, including detailed configuration options and states.
    • Introduction of "Optimistic Mode" for covers without state and position topics.
    • Expanded availability features for online/offline status updates.
  • Deprecations

    • Old configuration format under the cover platform key is deprecated.
  • Documentation

    • Improved examples for various MQTT cover configurations, including tilt and advanced templating.

ma-zal avatar Oct 18 '24 12:10 ma-zal

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

home-assistant[bot] avatar Oct 18 '24 12:10 home-assistant[bot]

Deploy Preview for home-assistant-docs ready!

Name Link
Latest commit acdd388b2a98f83f7f602ab31db6e4adc2e90104
Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67125765dc4c840007d66656
Deploy Preview https://deploy-preview-35283--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.

netlify[bot] avatar Oct 18 '24 12:10 netlify[bot]

📝 Walkthrough

Walkthrough

The changes in this pull request focus on updating the MQTT cover integration documentation for Home Assistant. Key updates include clarifications on configuration options, the introduction of "Optimistic Mode," and expanded details on availability topics. The documentation now highlights the interaction between state_topic and position_topic, while also deprecating the old configuration format. Enhanced examples for various configurations are provided, including those for tilt and advanced templating, ensuring clearer guidance for users on setting up MQTT covers.

Changes

File Path Change Summary
source/_integrations/cover.mqtt.markdown Updated documentation to clarify configuration options for MQTT covers, including states, topics, and availability. Added "Optimistic Mode" section and deprecated old configuration format. Enhanced examples for various configurations, including tilt and advanced templating.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MQTT
    participant Cover

    User->>MQTT: Send command (open/close)
    MQTT->>Cover: Command received
    Cover-->>MQTT: State change (if state_topic defined)
    Cover-->>User: Acknowledge command
sequenceDiagram
    participant User
    participant MQTT
    participant Cover

    User->>MQTT: Send command (open/close)
    MQTT->>Cover: Command received
    Cover-->>MQTT: State change (if optimistic mode)
    Cover-->>User: Acknowledge command

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>, 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 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[bot] avatar Oct 18 '24 12:10 coderabbitai[bot]