Skip to content
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

Add actronair neo integration documentation #36727

Conversation

kclif9
Copy link

@kclif9 kclif9 commented Jan 5, 2025

Proposed change

This PR is to contribute the documentation for the Actron Air Neo integration being contributed to Home Assistant.

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

Based on the comprehensive summary of changes, here are the high-level release notes:

  • Documentation Updates

    • Reorganized documentation structure for common tasks
    • Updated backup and configuration documentation
    • Improved integration documentation for multiple services
  • New Integrations

    • Added support for Actron Air Neo
    • Introduced Harvey water softener integration
  • Integration Enhancements

    • Added new platforms like assist_satellite, camera, binary_sensor
    • Expanded device and functionality support for various integrations
    • Updated quality scales and integration types
  • Configuration Changes

    • Updated version information
    • Modified dependency versions
    • Refined integration metadata
  • Miscellaneous

    • Updated code owners for several integrations
    • Improved troubleshooting sections
    • Minor text and formatting corrections

mrdarrengriffin and others added 30 commits December 23, 2024 16:13
* Fix display issues when :target is active

* Content update

* Change :target to display block

* Added Australian distributors
It's gpt-4o-mini.

Fixes #36304
* Fix limitations wording

* Reorder limitations section
Bumps [rbs](https://github.com/ruby/rbs) from 3.7.0 to 3.8.0.
- [Release notes](https://github.com/ruby/rbs/releases)
- [Changelog](https://github.com/ruby/rbs/blob/master/CHANGELOG.md)
- [Commits](ruby/rbs@v3.7.0...v3.8.0)

---
updated-dependencies:
- dependency-name: rbs
  dependency-type: indirect
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [bigdecimal](https://github.com/ruby/bigdecimal) from 3.1.8 to 3.1.9.
- [Release notes](https://github.com/ruby/bigdecimal/releases)
- [Changelog](https://github.com/ruby/bigdecimal/blob/master/CHANGES.md)
- [Commits](ruby/bigdecimal@v3.1.8...v3.1.9)

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

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Add troubleshooting and known limitations

* Remove quotes for non-code

* CRAI nitpicks

* Add suggestions
Example in Legacy binary sensor section was missing quote marks.
Point to the correct repository and not to a forked one.
@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch labels Jan 5, 2025
@home-assistant
Copy link

home-assistant bot commented Jan 5, 2025

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

Copy link

netlify bot commented Jan 5, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 2b85ad8
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/677a29363f741a0008941fd5
😎 Deploy Preview https://deploy-preview-36727--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.

@kclif9 kclif9 closed this Jan 5, 2025
@home-assistant home-assistant bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch in-progress This PR/Issue is currently being worked on labels Jan 5, 2025
Copy link
Contributor

coderabbitai bot commented Jan 5, 2025

Warning

Rate limit exceeded

@home-assistant[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 16 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 29d08bd and 2b85ad8.

⛔ Files ignored due to path filters (26)
  • Gemfile.lock is excluded by !**/*.lock
  • package-lock.json is excluded by !**/package-lock.json
  • source/images/blog/2025-01-backups/art.jpg is excluded by !**/*.jpg
  • source/images/blog/2025-01-backups/backups.png is excluded by !**/*.png
  • source/images/blog/2025-01-backups/encrypt.png is excluded by !**/*.png
  • source/images/blog/2025-01-backups/locations.png is excluded by !**/*.png
  • source/images/blog/2025-01-backups/wizard.png is excluded by !**/*.png
  • source/images/blog/2025-01/backups-backup-now.png is excluded by !**/*.png
  • source/images/blog/2025-01/backups-encryption.png is excluded by !**/*.png
  • source/images/blog/2025-01/backups-home-assistant-cloud.png is excluded by !**/*.png
  • source/images/blog/2025-01/backups-integration-location.png is excluded by !**/*.png
  • source/images/blog/2025-01/backups-retention.png is excluded by !**/*.png
  • source/images/blog/2025-01/backups-status.png is excluded by !**/*.png
  • source/images/blog/2025-01/backups-wizard.png is excluded by !**/*.png
  • source/images/blog/2025-01/dashboards-background-settings.png is excluded by !**/*.png
  • source/images/blog/2025-01/social.jpg is excluded by !**/*.jpg
  • source/images/blog/2025-01/tile-card-feature-volume-slider.png is excluded by !**/*.png
  • source/images/blog/2025-01/wth-category-labels-new-automation.png is excluded by !**/*.png
  • source/images/blog/2025-01/wth-default-expose-to-assist.png is excluded by !**/*.png
  • source/images/blog/2025-01/wth-quickbar-devices.png is excluded by !**/*.png
  • source/images/blog/2025-01/wth-zoom-graphs.gif is excluded by !**/*.gif
  • source/images/more-info/backup_emergency_kit_01.png is excluded by !**/*.png
  • source/images/screenshots/network-storage/backup_locations_all.png is excluded by !**/*.png
  • source/images/screenshots/network-storage/backup_select_local_default.png is excluded by !**/*.png
  • source/images/screenshots/network-storage/change_backup_dark.png is excluded by !**/*.png
  • source/images/screenshots/network-storage/change_backup_light.png is excluded by !**/*.png
📒 Files selected for processing (82)
  • CODEOWNERS (13 hunks)
  • Gemfile (1 hunks)
  • _config.yml (1 hunks)
  • package.json (1 hunks)
  • source/_dashboards/button.markdown (1 hunks)
  • source/_docs/configuration.markdown (1 hunks)
  • source/_includes/asides/common_tasks_navigation.html (1 hunks)
  • source/_includes/asides/docs_sitemap.html (1 hunks)
  • source/_includes/common-tasks/backups.md (5 hunks)
  • source/_includes/common-tasks/commandline.md (1 hunks)
  • source/_includes/common-tasks/data_disk.md (2 hunks)
  • source/_includes/common-tasks/network_storage.md (1 hunks)
  • source/_includes/common-tasks/specific_version.md (1 hunks)
  • source/_includes/common-tasks/update.md (1 hunks)
  • source/_integrations/actronair_neo.markdown (1 hunks)
  • source/_integrations/aemet.markdown (1 hunks)
  • source/_integrations/alexa.smart_home.markdown (3 hunks)
  • source/_integrations/backup.markdown (2 hunks)
  • source/_integrations/bang_olufsen.markdown (1 hunks)
  • source/_integrations/cambridge_audio.markdown (1 hunks)
  • source/_integrations/cookidoo.markdown (1 hunks)
  • source/_integrations/decora_wifi.markdown (1 hunks)
  • source/_integrations/eastron.markdown (1 hunks)
  • source/_integrations/easyenergy.markdown (2 hunks)
  • source/_integrations/eheimdigital.markdown (1 hunks)
  • source/_integrations/elevenlabs.markdown (1 hunks)
  • source/_integrations/energyzero.markdown (1 hunks)
  • source/_integrations/esphome.markdown (1 hunks)
  • source/_integrations/fronius.markdown (1 hunks)
  • source/_integrations/fyta.markdown (1 hunks)
  • source/_integrations/go2rtc.markdown (1 hunks)
  • source/_integrations/google_sheets.markdown (1 hunks)
  • source/_integrations/govee_ble.markdown (0 hunks)
  • source/_integrations/harvey.markdown (1 hunks)
  • source/_integrations/honeywell.markdown (1 hunks)
  • source/_integrations/husqvarna_automower.markdown (1 hunks)
  • source/_integrations/idasen_desk.markdown (2 hunks)
  • source/_integrations/iotty.markdown (0 hunks)
  • source/_integrations/iron_os.markdown (2 hunks)
  • source/_integrations/ituran.markdown (1 hunks)
  • source/_integrations/lock.template.markdown (1 hunks)
  • source/_integrations/london_underground.markdown (1 hunks)
  • source/_integrations/mastodon.markdown (1 hunks)
  • source/_integrations/monzo.markdown (1 hunks)
  • source/_integrations/mpd.markdown (1 hunks)
  • source/_integrations/mqtt.markdown (1 hunks)
  • source/_integrations/myuplink.markdown (1 hunks)
  • source/_integrations/niko_home_control.markdown (1 hunks)
  • source/_integrations/nordpool.markdown (1 hunks)
  • source/_integrations/ohme.markdown (1 hunks)
  • source/_integrations/onkyo.markdown (1 hunks)
  • source/_integrations/openai_conversation.markdown (1 hunks)
  • source/_integrations/overkiz.markdown (3 hunks)
  • source/_integrations/palazzetti.markdown (2 hunks)
  • source/_integrations/peblar.markdown (1 hunks)
  • source/_integrations/pinecil.markdown (2 hunks)
  • source/_integrations/plugwise.markdown (3 hunks)
  • source/_integrations/powerfox.markdown (1 hunks)
  • source/_integrations/renault.markdown (1 hunks)
  • source/_integrations/reolink.markdown (1 hunks)
  • source/_integrations/roomba.markdown (1 hunks)
  • source/_integrations/russound_rio.markdown (1 hunks)
  • source/_integrations/sabnzbd.markdown (2 hunks)
  • source/_integrations/scrape.markdown (2 hunks)
  • source/_integrations/sensor.rest.markdown (2 hunks)
  • source/_integrations/shell_command.markdown (1 hunks)
  • source/_integrations/sky_remote.markdown (1 hunks)
  • source/_integrations/slide_local.markdown (1 hunks)
  • source/_integrations/statistics.markdown (1 hunks)
  • source/_integrations/suez_water.markdown (1 hunks)
  • source/_integrations/template.markdown (1 hunks)
  • source/_integrations/tesla_fleet.markdown (1 hunks)
  • source/_integrations/totalconnect.markdown (4 hunks)
  • source/_integrations/tplink_tapo.markdown (2 hunks)
  • source/_integrations/tradfri.markdown (1 hunks)
  • source/_integrations/transmission.markdown (1 hunks)
  • source/_integrations/twentemilieu.markdown (1 hunks)
  • source/_integrations/valve.markdown (3 hunks)
  • source/_integrations/vicare.markdown (1 hunks)
  • source/_integrations/voip.markdown (1 hunks)
  • source/_integrations/watergate.markdown (2 hunks)
  • source/_integrations/weheat.markdown (1 hunks)
📝 Walkthrough

Walkthrough

This pull request encompasses a comprehensive set of updates across multiple files in the Home Assistant documentation repository. The changes span various integrations, configuration files, and documentation sections, focusing on metadata updates, platform expansions, code ownership modifications, and documentation improvements. The updates reflect ongoing refinements to Home Assistant's integration ecosystem, including version updates, quality scale classifications, and enhanced platform support.

Changes

File/Category Change Summary
CODEOWNERS Added/removed code owners for multiple integration documentation files
Gemfile Updated nokogiri gem from 1.17.2 to 1.18.1
_config.yml Updated version information to 2025.1.0, released on 2025-01-03
package.json Updated textlint dependency to ^14.4.2
Integration Metadata Added/updated ha_quality_scale, ha_platforms, ha_integration_type for multiple integrations
Integration Platforms Added platforms like assist_satellite, binary_sensor, button, camera, diagnostics, number, select, switch to various integrations
Documentation Links Updated links from /common-tasks/os/ to /common-tasks/general/
Code Ownership Added/removed code owners for several integrations

Sequence Diagram

sequenceDiagram
    participant PR as Pull Request
    participant Repo as Home Assistant Repository
    participant Docs as Documentation Files
    participant Metadata as Integration Metadata
    participant Platforms as Integration Platforms

    PR->>Repo: Submits changes
    Repo->>Docs: Update documentation files
    Docs->>Metadata: Modify integration metadata
    Metadata->>Platforms: Expand supported platforms
    Platforms-->>Metadata: Confirm platform updates
    Metadata-->>Docs: Update documentation
    Docs-->>Repo: Commit changes
    Repo-->>PR: Validate and merge
Loading

The sequence diagram illustrates the process of updating the Home Assistant documentation, showing how changes propagate through different components of the repository, from pull request submission to final validation and merging.


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.

@home-assistant home-assistant bot added the in-progress This PR/Issue is currently being worked on label Jan 5, 2025
@home-assistant
Copy link

home-assistant bot commented Jan 5, 2025

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

@home-assistant home-assistant bot added the needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch label Jan 5, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Jan 6, 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 in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.