Skip to content

Vesync Switch for Display #37334

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

Closed
wants to merge 8 commits into from
Closed

Conversation

cdnninja
Copy link
Contributor

@cdnninja cdnninja commented Feb 6, 2025

home-assistant/core#137493

Proposed change

home-assistant/core#137493

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

    • Introduced updated social media links in the footer, including a new Bluesky profile and improved redirects for Mastodon and Bluesky access.
  • Documentation

    • Expanded backup guides with clear instructions on on-the-fly decryption and encryption key management.
    • Enhanced integration documentation for Reolink by highlighting push update support for image settings and refining day/night mode details.
    • Improved VeSync documentation with additional details for device display functionality.

dependabot bot and others added 8 commits February 6, 2025 08:05
…e-assistant#37322)

Bumps [sorbet-runtime](https://github.com/sorbet/sorbet) from 0.5.11801 to 0.5.11805.
- [Release notes](https://github.com/sorbet/sorbet/releases)
- [Commits](https://github.com/sorbet/sorbet/commits)

---
updated-dependencies:
- dependency-name: sorbet-runtime
  dependency-type: indirect
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…37321)

Bumps [parser](https://github.com/whitequark/parser) from 3.3.7.0 to 3.3.7.1.
- [Changelog](https://github.com/whitequark/parser/blob/master/CHANGELOG.md)
- [Commits](whitequark/parser@v3.3.7.0...v3.3.7.1)

---
updated-dependencies:
- dependency-name: parser
  dependency-type: indirect
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…t#37324)

* When downloading from backup page, backup is decrypted

* Update source/_includes/common-tasks/backups.md

Co-authored-by: Franck Nijhof <git@frenck.dev>

---------

Co-authored-by: Franck Nijhof <git@frenck.dev>
* Storing emergency kit: clarify steps

* Apply parallelism
@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Feb 6, 2025
Copy link

netlify bot commented Feb 6, 2025

Deploy Preview for home-assistant-docs ready!

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

Copy link
Contributor

coderabbitai bot commented Feb 6, 2025

📝 Walkthrough

Walkthrough

The pull request updates several documentation files. The backups documents now describe on‐the‐fly decryption during download and provide clearer guidance on encryption key management. The footer and redirects files have adjustments to social media links, including the addition of a Bluesky link and updated line breaks. Integration documentation for Reolink now marks certain number entities with a plus sign to indicate push update support (with an adjustment for the day/night mode entity), and VeSync documentation introduces a new “display” attribute for switch sections.

Changes

Files Change Summary
source/_includes/common-tasks/backups.md
source/more-info/backup-emergency-kit.markdown
Updated backup documentation to detail on‐the‐fly decryption during download and to expand instructions on encryption key management.
source/_includes/site/footer.html
source/_redirects
Modified social media links by adding a Bluesky link and adjusting line breaks in the footer; added new redirects for Mastodon and Bluesky.
source/_integrations/reolink.markdown
source/_integrations/vesync.markdown
Revised integration documentation: Reolink now indicates push update support for number entities (with a correction for the day/night mode entity), and VeSync documentation adds a new “display” attribute in switch sections.

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (4)
source/more-info/backup-emergency-kit.markdown (3)

26-28: Reword and clarify encryption key instructions.
The added bullet points (lines 26–28) clearly explain that Home Assistant tracks the current encryption key and that if the key has been changed, the old key is still required for restoring older backups. Consider rephrasing line 27 to remove the phrase “in the meantime” (e.g., “- But if you have changed the encryption key, you still need the old key that matches previous backups.”) for enhanced clarity and conciseness.

🧰 Tools
🪛 LanguageTool

[style] ~27-~27: ‘in the meantime’ might be wordy. Consider a shorter alternative.
Context: ... if you have changed the encryption key in the meantime, you still need the old key that matche...

(EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)


43-44: Enhance key retrieval instructions.
The added lines (43–44) explain that if the user still has access to their Home Assistant instance, the encryption key can be re-downloaded from the backup settings. To further assist the reader, consider adding a direct link or reference to the backup settings page.


45-46: Standardize language for clarity.
In line 46, please update “can not” to “cannot” for a more standard and concise expression. Additionally, reformatting the bullet points for parallel structure might improve readability, for example:

  • If you have not changed the encryption key: Home Assistant retains it and decrypts the backup on the fly.
  • If you have changed the encryption key: Home Assistant cannot decrypt the backup on the fly, so you need the corresponding encryption key.
🧰 Tools
🪛 LanguageTool

[style] ~46-~46: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...ed the encryption key**: Home Assistant can not decrypt it on the fly. You need the enc...

(CAN_NOT_PREMIUM)

source/_integrations/vesync.markdown (1)

138-138: Remove extra blank line.

Remove one of the consecutive blank lines to maintain consistent formatting.

 | `child_lock`            | The current status of the child lock (Core200S/300s/400s)                         | off             |
-
-
+
 ## Humidifier
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

138-138: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ab361cc and dc048a2.

⛔ Files ignored due to path filters (3)
  • Gemfile.lock is excluded by !**/*.lock
  • source/images/dashboards/history_graph.png is excluded by !**/*.png
  • source/images/dashboards/history_graph_lines.png is excluded by !**/*.png
📒 Files selected for processing (6)
  • source/_includes/common-tasks/backups.md (1 hunks)
  • source/_includes/site/footer.html (1 hunks)
  • source/_integrations/reolink.markdown (2 hunks)
  • source/_integrations/vesync.markdown (3 hunks)
  • source/_redirects (1 hunks)
  • source/more-info/backup-emergency-kit.markdown (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • source/_includes/common-tasks/backups.md
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in doc...

*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
  • source/_redirects
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - I...

*/**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.
  • source/_redirects
`*/**(html|markdown|md)`: - Be brief in your replies and don...

*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"

  • source/_redirects
`*/**(html|markdown|md)`: - Use sentence-style capitalizatio...

*/**(html|markdown|md): - Use sentence-style capitalization also in headings.

  • source/_redirects
`*/**(html|markdown|md)`: do not comment on HTML used for ic...

*/**(html|markdown|md): do not comment on HTML used for icons

  • source/_redirects
`*/**(html|markdown|md)`: Avoid flagging inline HTML for emb...

*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

  • source/_redirects
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/vesync.markdown

138-138: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

🪛 LanguageTool
source/more-info/backup-emergency-kit.markdown

[style] ~27-~27: ‘in the meantime’ might be wordy. Consider a shorter alternative.
Context: ... if you have changed the encryption key in the meantime, you still need the old key that matche...

(EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)


[style] ~46-~46: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...ed the encryption key**: Home Assistant can not decrypt it on the fly. You need the enc...

(CAN_NOT_PREMIUM)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Lint Text
🔇 Additional comments (5)
source/more-info/backup-emergency-kit.markdown (1)

38-38: Step clarity and numbering consistency.
The newly added step (line 38) instructs users on how to generate a new encryption key. The numbering is consistent with the previous steps and the instruction is clear.

source/_redirects (1)

12-13: LGTM!

The new redirects for Mastodon and Bluesky are correctly configured.

source/_includes/site/footer.html (1)

88-88: LGTM!

The line breaks improve readability, and the Bluesky social media link is properly configured with the correct attributes.

Also applies to: 95-100, 107-107

source/_integrations/vesync.markdown (1)

120-122: LGTM!

The display switch attribute is properly documented for both Power & energy sensors and Humidifier sections.

Also applies to: 151-153

source/_integrations/reolink.markdown (1)

142-146: LGTM!

The plus (+) sign is correctly added to indicate push update support for image-related number entities, and the day night mode select entity is properly updated.

Also applies to: 192-192

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.

Oh hi there @cdnninja 👋

There are unrelated changes in this PR. Could you please take a look?

Thanks! 👍

../Frenck

@home-assistant home-assistant bot marked this pull request as draft February 6, 2025 18:27
@home-assistant
Copy link

home-assistant bot commented Feb 6, 2025

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

Learn more about our pull request process.

@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Apr 14, 2025
@c0ffeeca7
Copy link
Contributor

Thank you for contributing, @cdnninja 👍

  1. It looks like this PR was created based on the current branch. Please rebase to next and then point this PR against the next branch.

@frenck frenck added this to the 2025.5 milestone Apr 30, 2025
@cdnninja
Copy link
Contributor Author

cdnninja commented May 1, 2025

Closing to replace with: #38830

@cdnninja cdnninja closed this May 1, 2025
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label May 1, 2025
@cdnninja cdnninja deleted the patch-5 branch May 1, 2025 00:27
@github-actions github-actions bot locked and limited conversation to collaborators May 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants