8000 Gaposa integration documentation by mwatson2 · Pull Request #37521 · home-assistant/home-assistant.io · GitHub
[go: up one dir, main page]

Skip to content

Gaposa integration documentation #37521

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 22 commits into from
Closed

Conversation

mwatson2
Copy link
@mwatson2 mwatson2 commented Feb 18, 2025

Proposed change

Adds initial documentation for the Gaposa integration (PR)

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 a new integration for motorized blinds control.
    • Enhanced voice assistant capabilities including analog phone calls, thermostat control, and shared conversation history.
    • Improved backup management with options for unencrypted downloads and customizable scheduling.
    • Added support for Bluetooth advertisement listening and bundling for Shelly Gen2+ devices.
    • New section detailing multiple collections for energy cards in dashboards.
  • Bug Fixes

    • Patch release 2025.2.1 addresses various integration issues and overall stability improvements.
  • Documentation

    • Updated guides for dashboard configurations, integration setups (e.g., Bluetooth, Flexit, OneDrive, Reolink), and troubleshooting.
    • Enhanced explanations regarding encryption key management for backups.
    • Refreshed community links for easier access.

dependabot bot and others added 21 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
* Update energy.markdown

* Update energy.markdown

* Typo

---------

Co-authored-by: Franck Nijhof <git@frenck.dev>
* Add IRK instructions for android

* Update source/_integrations/private_ble_device.markdown

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Tiny tweaks

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
* Update squeezebox.markdown

Adds specific examples for entering call_method in the Visual Editor with working parameter syntax, as well as showing the properly formed YAML generated.

Squeezebox increment / decrement parameters require a preceding plus or minus, which will be dropped by the Visual Editor if not double-quoted.

* Update squeezebox.markdown

Correct missing closing pipes in tables per Code Rabbit suggestion.
* Update troubleshooting.markdown

Added media source fix for no TTS in YAML config.

* Update troubleshooting.markdown

streamlined media source text and added refence for default config. added local network header for more consistent style.
…37341)

Bumps [ruby-lsp](https://github.com/Shopify/ruby-lsp) from 0.23.8 to 0.23.9.
- [Release notes](https://github.com/Shopify/ruby-lsp/releases)
- [Commits](Shopify/ruby-lsp@v0.23.8...v0.23.9)

---
updated-dependencies:
- dependency-name: ruby-lsp
  dependency-type: direct:development
  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>
* Clarify hardware needs for flexit_bacnet

* Fix typo

* Tiny tweaks

---------

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
* Update onedrive.markdown

* Improve readability of OneDrive integration documentation
@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 18, 2025
Copy link
netlify bot commented Feb 18, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit c90fb2b
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67b3f54cb45764000873dc9a
😎 Deploy Preview https://deploy-preview-37521--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 18, 2025

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The pull request applies a series of documentation and configuration updates across Home Assistant components. It updates the Ruby LSP gem version and Home Assistant release configuration, introduces new sections and clarifications in dashboards, integration documentation, and troubleshooting guides, and revises social media links and redirects. A new integration for Gaposa motorized blinds is added, while several integrations receive expanded support notes and improved examples. Release notes have also been updated with details about patch releases and bug fixes.

Changes

File(s) Change Summary
Gemfile, _config.yml Configuration Updates: Ruby LSP gem version updated from 0.23.8 to 0.23.9 in Gemfile (development group) and Home Assistant release variables updated (_config.yml): current_patch_version from 0 to 1, and date_released from 2025-02-05 to 2025-02-07.
source/_dashboards/energy.markdown, source/_dashboards/statistics-graph.markdown Dashboard Documentation: Added a "Using Multiple Collections" section in energy dashboards, and updated the collection_key description in statistics-graph documentation with a reference to energy documentation.
source/_posts/2025-02-05-release-20252.markdown, source/changelogs/core-2025.2.markdown Release Notes: Introduced a new "Patch releases" section (including 2025.2.1 dated February 7) detailing bug fixes, automation of backup options, and voice assistant improvements along with dependency updates.
source/_integrations/bluetooth.markdown, flexit_bacnet.markdown, gaposa.markdown, Integration Documentation - Part 1:
- Bluetooth: Updated to include Shelly Gen2+ support for advertisement listening and bundling.
- Flexit BACnet: Added prerequisites (e.g., Ethernet port) and expanded shutdown warning.
- Gaposa: New integration added for motorized blinds with setup instructions via Home Assistant UI (API key, RollApp credentials) and automation examples.
- Generic: Example updated to use a GIF from the USA National Weather Service.
source/_integrations/onedrive.markdown, openai_conversation.markdown, Integration Documentation - Part 2:
- Microsoft OneDrive: Updated title and descriptions; added sections on backup folder naming and troubleshooting.
- OpenAI Conversation: YAML formatting adjustments for prompt and template structure.
source/_integrations/private_ble_device.markdown, reolink.markdown, squeezebox.markdown Integration Documentation - Part 3:
- Private BLE Device: Added a new "On Windows / For Android" section for retrieving the IRK.
- Reolink: Number and select entities updated to indicate push updates support.
- Squeezebox: Enhanced examples with clear YAML parameter formatting for the Visual Editor.
source/_includes/common-tasks/backups.md, source/_includes/site/footer.html, _redirects, Miscellaneous Documentation:
- Backups: Added details on on-the-fly decryption when downloading backups.
- Footer: Social media links updated by adjusting line breaks and adding a new Bluesky link.
- _redirects: Added new redirect entries for /mastodon and /bluesky.
- more-info/backup-emergency-kit.markdown: Expanded instructions on encryption key management for backups.
- voice_control/troubleshooting.markdown: Introduced sections on Local Network Settings and Missing Media Source for Assist feature troubleshooting.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant HA as Home Assistant
    participant GH as Gaposa Hub

    U->>HA: Initiate Gaposa integration setup
    HA->>U: Request API key and RollApp credentials
    U->>HA: Submit credentials
    HA->>GH: Authenticate and request device list
    GH-->>HA: Return device list and status
    HA->>U: Display configured devices and integration options
Loading

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d34f9f2 and c90fb2b.

📒 Files selected for processing (3)
  • source/_integrations/flexit_bacnet.markdown (1 hunks)
  • source/_integrations/onedrive.markdown (4 hunks)
  • source/_integrations/squeezebox.markdown (1 hunks)

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

🧹 Nitpick comments (17)
source/_dashboards/energy.markdown (2)

242-242: Refine Wording for Clarity
The line “All energy cards support use of collection_key option.” reads a bit awkwardly due to the phrasing. Consider revising it to:

-All energy cards support use of `collection_key` option.
+All energy cards support the `collection_key` option.

244-244: Markdown Formatting: Heading Spacing
The heading “### Examples” should be surrounded by blank lines to comply with markdownlint (MD022). Please add a blank line before this heading to improve the markdown readability.

🧰 Tools
🪛 LanguageTool

[grammar] ~244-~244: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...rt use of collection_key option. ### Examples Example view with multiple collections: ```yam...

(REPEATED_VERBS)

🪛 markdownlint-cli2 (0.17.2)

244-244: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

source/voice_control/troubleshooting.markdown (2)

95-105: Ensure Proper Markdown Heading Spacing for "Local Network Settings"
The added "Local Network Settings" section is clear and helpful. However, static analysis (MD022) indicates that headings should be surrounded by blank lines. Consider inserting a blank line before and after the heading to improve readability and conform to markdown style guidelines.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

95-95: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


103-103: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


104-104: Unordered list indentation
Expected: 0; Actual: 2

(MD007, ul-indent)


104-104: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


107-109: Ensure Consistent Markdown Formatting for "Missing Media Source" Heading
The new "Missing Media Source" section is a useful addition. To satisfy markdown lint rules (MD022), please add a blank line before and after the "### Missing Media Source" heading. This small change will enhance visual clarity.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

107-107: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

source/_integrations/gaposa.markdown (4)

11-11: Remove placeholder comment.

Remove the placeholder comment that asks to replace with your GitHub username.

-  - '@mwatson2'  # Replace with your GitHub username
+  - '@mwatson2'

47-49: Add missing comma after introductory phrase.

Add a comma after the introductory phrase for better readability.

-During setup you will need to provide:
+During setup, you will need to provide:
🧰 Tools
🪛 LanguageTool

[uncategorized] ~49-~49: A comma is probably missing here.
Context: ...n** and searching for "Gaposa". During setup you will need to provide: 1. Gaposa AP...

(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)


63-65: Fix list formatting.

Add blank lines around the list for proper markdown formatting.

2. Verify that you can log in to the RollApp application on your phone and control the blinds from there
+
- If not, follow troubleshooting instructions for RollApp
+
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

63-63: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


64-64: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


100-100: Add newline at end of file.

Add a newline character at the end of the file to follow markdown best practices.

      entity_id: cover.gaposa_bedroom
-```
+```
+
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

100-100: Files should end with a single newline character
null

(MD047, single-trailing-newline)

source/more-info/backup-emergency-kit.markdown (2)

26-28: Clarify and streamline encryption key instructions.
The newly added bullet points clearly explain that Home Assistant tracks the current encryption key and highlights the need for the old key if it has been changed. Consider rephrasing “in the meantime” (e.g., “after a key change”) to reduce wordiness for improved clarity.

🧰 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-46: Refine retrieval instructions for lost encryption keys.
In the “I lost my backup encryption key” section:

  • Consider inserting a comma after “instance” in line ~43 for improved readability.
  • Change “can not” to “cannot” in line ~46 to adhere to common usage.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~43-~43: Possible missing comma found.
Context: ...till have access to your Home Assistant instance you can download the encryption key aga...

(AI_HYDRA_LEO_MISSING_COMMA)


[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/private_ble_device.markdown (1)

43-57: Addition of "On Windows / For Android" section.
The new section providing guidance on retrieving the IRK via a rooted Android phone and through Wireshark is detailed and helpful.
Minor suggestion: Remove the extra space before the comma in line 51 (i.e. change “phone ,then” to “phone, then”) for smoother reading.

source/_integrations/onedrive.markdown (3)

26-28: Important note on folder naming due to API issues.
The highlighted note about Microsoft's API causing the application folder to be named Graph is well documented.
Note: Ensure that the formatting does not include any trailing spaces (as flagged by markdownlint on related lines).


73-79: New section "Backup folder is called Graph" added.
This section elaborates on how the folder may be named due to an issue with Microsoft’s Graph API and explains the naming scheme if multiple folders exist.
Minor markdown note: Remove any trailing spaces on lines similar to those flagged (e.g. on lines akin to 75 and 77) to comply with markdown style guidelines.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

75-75: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)


77-77: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)


68-68: Markdown style suggestion: Reduce consecutive blank lines.
Static analysis indicates multiple consecutive blank lines (expected: 1; actual: 2) around line 68. Consider reducing extra blank lines for a cleaner document.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

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

(MD012, no-multiple-blanks)

source/_integrations/squeezebox.markdown (1)

99-132: Clarify Parameter Formatting in Visual Editor Instructions
The newly added instructions for specifying additional parameters are clear and provide very helpful examples. To further improve clarity, consider emphasizing that each parameter must begin with a hyphen followed by a space and remind users that numeric increment values (like the “+5” in the example) must be enclosed in double quotes. For example, you might add a brief note immediately after the first example.

source/_posts/2025-02-05-release-20252.markdown (1)

518-568: Address Markdown Reference Duplicates and Unused Definitions
Static analysis has flagged several duplicate or unused link/image reference definitions (for example, references for #137448, @allenporter, @gjohansson-ST, @starkillerOG, and @zweckj). Cleaning these up would improve maintainability and eliminate warnings from markdownlint.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

518-518: Link and image reference definitions should be needed
Unused link or image reference definition: "#137448"

(MD053, link-image-reference-definitions)


548-548: Link and image reference definitions should be needed
Duplicate link or image reference definition: "@allenporter"

(MD053, link-image-reference-definitions)


557-557: Link and image reference definitions should be needed
Unused link or image reference definition: "@frenck"

(MD053, link-image-reference-definitions)


558-558: Link and image reference definitions should be needed
Duplicate link or image reference definition: "@gjohansson-ST"

(MD053, link-image-reference-definitions)


563-563: Link and image reference definitions should be needed
Duplicate link or image reference definition: "@starkillerOG"

(MD053, link-image-reference-definitions)


567-567: Link and image reference definitions should be needed
Duplicate link or image reference definition: "@zweckj"

(MD053, link-image-reference-definitions)

source/changelogs/core-2025.2.markdown (1)

1395-1448: Unused Link Reference Detected

A static analysis warning has flagged an unused link reference for #137448. If this reference is not used elsewhere in the document, please remove it to satisfy markdownlint guidelines and to keep the file clean.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

1395-1395: Link and image reference definitions should be needed
Unused link or image reference definition: "#137448"

(MD053, link-image-reference-definitions)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d48f754 and d34f9f2.

⛔ Files ignored due to path filters (4)
  • 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
  • source/images/integrations/onedrive/onedrive-app-registration.png is excluded by !**/*.png
📒 Files selected for processing (20)
  • Gemfile (1 hunks)
  • _config.yml (1 hunks)
  • source/_dashboards/energy.markdown (1 hunks)
  • source/_dashboards/statistics-graph.markdown (1 hunks)
  • source/_includes/common-tasks/backups.md (1 hunks)
  • source/_includes/site/footer.html (1 hunks)
  • source/_integrations/bluetooth.markdown (1 hunks)
  • source/_integrations/flexit_bacnet.markdown (1 hunks)
  • source/_integrations/gaposa.markdown (1 hunks)
  • source/_integrations/generic.markdown (1 hunks)
  • source/_integrations/onedrive.markdown (4 hunks)
  • source/_integrations/openai_conversation.markdown (1 hunks)
  • source/_integrations/private_ble_device.markdown (1 hunks)
  • source/_integrations/reolink.markdown (2 hunks)
  • source/_integrations/squeezebox.markdown (1 hunks)
  • source/_posts/2025-02-05-release-20252.markdown (2 hunks)
  • source/_redirects (1 hunks)
  • source/changelogs/core-2025.2.markdown (1 hunks)
  • source/more-info/backup-emergency-kit.markdown (2 hunks)
  • source/voice_control/troubleshooting.markdown (2 hunks)
✅ Files skipped from review due to trivial changes (3)
  • source/_includes/common-tasks/backups.md
  • _config.yml
  • source/_integrations/openai_conversation.markdown
🧰 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/voice_control/troubleshooting.markdown

95-95: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


107-107: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

source/_dashboards/energy.markdown

244-244: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

source/_integrations/onedrive.markdown

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

(MD012, no-multiple-blanks)


75-75: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)


77-77: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

source/_integrations/gaposa.markdown

63-63: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


64-64: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


100-100: Files should end with a single newline character
null

(MD047, single-trailing-newline)

source/_posts/2025-02-05-release-20252.markdown

518-518: Link and image reference definitions should be needed
Unused link or image reference definition: "#137448"

(MD053, link-image-reference-definitions)


548-548: Link and image reference definitions should be needed
Duplicate link or image reference definition: "@allenporter"

(MD053, link-image-reference-definitions)


557-557: Link and image reference definitions should be needed
Unused link or image reference definition: "@frenck"

(MD053, link-image-reference-definitions)


558-558: Link and image reference definitions should be needed
Duplicate link or image reference definition: "@gjohansson-ST"

(MD053, link-image-reference-definitions)


563-563: Link and image reference definitions should be needed
Duplicate link or image reference definition: "@starkillerOG"

(MD053, link-image-reference-definitions)


567-567: Link and image reference definitions should be needed
Duplicate link or image reference definition: "@zweckj"

(MD053, link-image-reference-definitions)

source/changelogs/core-2025.2.markdown

1395-1395: Link and image reference definitions should be needed
Unused link or image reference definition: "#137448"

(MD053, link-image-reference-definitions)

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


[uncategorized] ~43-~43: Possible missing comma found.
Context: ...till have access to your Home Assistant instance you can download the encryption key aga...

(AI_HYDRA_LEO_MISSING_COMMA)


[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/_dashboards/energy.markdown

[grammar] ~244-~244: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...rt use of collection_key option. ### Examples Example view with multiple collections: ```yam...

(REPEATED_VERBS)

source/_integrations/gaposa.markdown

[uncategorized] ~49-~49: A comma is probably missing here.
Context: ...n** and searching for "Gaposa". During setup you will need to provide: 1. Gaposa AP...

(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)


[style] ~54-~54: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ice list and names from the app. If you make changes to the device list or device names in the ...

(MAKE_CHANGES)

🪛 GitHub Check: Lint Text
source/_integrations/gaposa.markdown

[failure] 52-52:
This is a commonly misspelled word. Correct it to there, their, the

🪛 GitHub Actions: home-assistant.io Test
source/_integrations/gaposa.markdown

[error] 52-52: This is a commonly misspelled word. Correct it to there, their, the (common-misspellings)

🔇 Additional comments (19)
source/_dashboards/statistics-graph.markdown (1)

97-98: Enhanced collection_key Description with Documentation Link
The updated description now includes a reference to the energy documentation. This added context helps users understand how to use multiple date selection cards. Please verify that the URL remains valid as the documentation evolves.

source/_dashboards/energy.markdown (1)

237-243: Addition of the "Using Multiple Collections" Section
This new section clearly explains how to link multiple energy-date-selection cards by using the collection_key variable. The explanation and example are both informative and helpful. Ensure that this section consistently aligns with references elsewhere in the documentation.

source/_redirects (1)

12-13: LGTM!

The new social media redirects for Mastodon and Bluesky are correctly formatted and point to the official Home Assistant profiles.

Gemfile (1)

15-15: LGTM!

The ruby-lsp gem version update is a minor version bump that follows proper version pinning practices.

source/_integrations/flexit_bacnet.markdown (1)

26-26: LGTM!

The changes improve the documentation by:

  1. Clarifying the ethernet port requirement and BACnet protocol usage
  2. Adding important safety warnings about device shutdown, including potential risks and necessary precautions

Also applies to: 87-91

source/more-info/backup-emergency-kit.markdown (1)

38-38: Clear instruction update for generating a new encryption key.
The step “Select Next, then select Change encryption key” is straightforward and aligns with the intended user actions.

source/_integrations/onedrive.markdown (4)

2-2: Title updated to "Microsoft OneDrive".
This change correctly reflects the integration’s full name and clarifies the intended branding.


19-19: Updated integration description.
The revised text on line 19 now directly links to Microsoft OneDrive and clearly specifies its use with Home Assistant Backups.


57-60: Addition of a tip for Azure tenant requirements.
This tip provides essential context for users who may want to use custom credentials. It is clear and useful.


91-96: Introduction of the troubleshooting section.
The new “Troubleshooting” section is a welcome addition that offers practical advice to resolve errors when adding the integration.

source/_integrations/generic.markdown (1)

62-67: Updated weather graph example.
The title change to “Weather graph from USA National Weather Service” and the accompanying instruction that a GIF can be used as a still image make the example current and clear. The updated still image URL also correctly reflects the new source.

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

88-88: Line break added after the GitHub link.
The newly added <br /> tag at line 88 improves the visual separation of the social links section.


89-100: Addition of the Bluesky social link.
The new Bluesky link, complete with its icon, is a welcome enhancement that ensures emerging social platforms are represented in the footer.


107-107: Line break added after the X link.
The <br /> tag at line 107 further refines the layout, ensuring consistent spacing in the social links section.

source/_integrations/bluetooth.markdown (1)

285-286: Added Shelly Gen2+ Bluetooth Feature Details
The addition of the two new lines indicating that Shelly Gen2+ devices support both Bluetooth advertisement listening and bundling nicely expands the documentation. This extra detail will help users understand that these devices now offer enhanced Bluetooth capabilities. Just ensure that any related integration code (or release notes) is updated accordingly for consistency.

source/_posts/2025-02-05-release-20252.markdown (2)

74-76: Enhanced Table of Contents with Patch Releases
The addition of the "Patch releases" entry in the table of contents greatly improves document navigability for readers looking for the latest bug fixes. Please double-check that the anchor link (#patch-releases) exactly matches the section header later in the file.


478-516: Comprehensive Patch Release Section
The new section detailing patch release 2025.2.1 is thorough and clearly formatted. It provides a detailed list of fixes and enhancements with corresponding PR links, which is very useful for end users. One minor suggestion is to verify that all URL references are up-to-date. Also, consider a brief concluding sentence that summarises the patch release’s purpose.

source/_integrations/reolink.markdown (1)

142-147: Improved Notation for Push Update Support on Entities
Adding a plus sign (+) next to the number entities (Image brightness, Image contrast, Image saturation, Image sharpness, Image hue) as well as to the "Day night mode" select entity effectively communicates that these entities support push updates for near-instant state changes. This update enhances user clarity regarding the update mechanism. Please ensure that this new notation is consistently applied throughout the documentation where similar functionalities are described.

source/changelogs/core-2025.2.markdown (1)

1361-1392: New Release Notes Section Added

The new release segment for "Release 2025.2.1 - February 7" is clearly added with a list of fixes and updates that include the appropriate pull request references and version bumps. Please double‑check that all updates listed here (e.g. version changes and fixes) accurately reflect the intended release notes for Home Assistant Core 2025.2.1 and that they follow the documentation standards.

During setup you will need to provide:

1. Gaposa API key for cloud service access
2. Your username and password for ther RollApp app
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo in word "ther".

Correct the misspelled word.

-2. Your username and password for ther RollApp app
+2. Your username and password for the RollApp app
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
2. Your username and password for ther RollApp app
2. Your username and password for the RollApp app
🧰 Tools
🪛 GitHub Check: Lint Text

[failure] 52-52:
This is a commonly misspelled word. Correct it to there, their, the

🪛 GitHub Actions: home-assistant.io Test

[error] 52-52: This is a commonly misspelled word. Correct it to there, their, the (common-misspellings)

@mwatson2 mwatson2 closed this Feb 18, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Feb 19, 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.

0