Skip to content

Deprecating the Forecast sensor, adding note about new action #39072

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: next
Choose a base branch
from
Open

Deprecating the Forecast sensor, adding note about new action #39072

wants to merge 4 commits into from

Conversation

madpilot
Copy link
Contributor

@madpilot madpilot commented May 17, 2025 •
edited by coderabbitai bot
Loading

Proposed change

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

  • Documentation
    • Updated Amber Electric integration to deprecate the "Forecast" sensor, with removal planned for version 2025.11.
    • Introduced a new get_forecasts action for retrieving forecast data, supporting optional parameters for site and channel type.

@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 May 17, 2025
@netlify Netlify
Copy link

netlify bot commented May 17, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 8e5df2a
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6828748e04e5740008649ec9
😎 Deploy Preview https://deploy-preview-39072--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 project configuration.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 17, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

The documentation for the Amber Electric integration was updated to deprecate the existing "Forecast" sensor, announcing its removal in version 2025.11. Users are now instructed to use the new get_forecasts action, which provides forecast data for specified channel types with optional parameters for site and channel selection.

Changes

File(s) Change Summary
source/_integrations/amberelectric.markdown Updated documentation to deprecate the "Forecast" sensor, introduce the get_forecasts action, and describe its usage and parameters.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AmberElectric Integration

    User->>AmberElectric Integration: Call get_forecasts(site_id, channel_type)
    AmberElectric Integration-->>User: Return array of forecast data for specified channel
Loading

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@madpilot madpilot mentioned this pull request May 17, 2025
Draft
19 tasks
coderabbitai[bot]
coderabbitai bot reviewed May 17, 2025
View reviewed changes
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 (1)
source/_integrations/amberelectric.markdown (1)

64-64: Add trailing newline
Markdown files should end with a single newline character to satisfy MD047 (single-trailing-newline).

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

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

(MD047, single-trailing-newline)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 1e9a6eb and d2998c1.

📒 Files selected for processing (1)
  • source/_integrations/amberelectric.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/amberelectric.markdown

[uncategorized] ~62-~62: A punctuation mark might be missing here.
Context: ...--------------------------------------- | | site_id | Yes | ID of the...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

🪛 markdownlint-cli2 (0.17.2)
source/_integrations/amberelectric.markdown

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

(MD047, single-trailing-newline)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (2)
source/_integrations/amberelectric.markdown (2)

47-47: Deprecate Forecast sensor and guide users to use the new action
The deprecation note is clear and specifies the removal version (2025.11). It correctly instructs users to switch to the get_forecasts action.

55-64: Document new get_forecasts action
The new Actions section and get_forecasts action table accurately describe the endpoint and optional parameters (site_id, channel_type). Please verify that these attribute names and descriptions align with the implementation in core PR #144848 to ensure consistency.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~62-~62: A punctuation mark might be missing here.
Context: ...--------------------------------------- | | site_id | Yes | ID of the...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

🪛 markdownlint-cli2 (0.17.2)

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

(MD047, single-trailing-newline)

coderabbitai[bot]
coderabbitai bot reviewed May 17, 2025
View reviewed changes
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

🔭 Outside diff range comments (1)
source/_integrations/amberelectric.markdown (1)

61-65: ⚠️ Potential issue

Fix typo in channel_type option

The table lists controller_load, but the channel type is named “Controlled Load” elsewhere. Update the option to avoid confusion:

-| `channel_type` | Yes      | The channel type to fetch. Options: general, controller_load, feed_in |
+| `channel_type` | Yes      | The channel type to fetch. Options: general, controlled_load, feed_in |
🧰 Tools
🪛 LanguageTool

[uncategorized] ~62-~62: A punctuation mark might be missing here.
Context: ...--------------------------------------- | | site_id | Yes | ID of the...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

🧹 Nitpick comments (1)
source/_integrations/amberelectric.markdown (1)

55-59: Add a versionadded directive for the new action

To help users understand when this feature was introduced, consider adding a version directive immediately before the action:

+:::versionadded 2025.11
+Introduced the `get_forecasts` action, replacing the deprecated Forecast sensor.
+:::
### `get_forecasts`
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between d2998c1 and 123d4ae.

📒 Files selected for processing (1)
  • source/_integrations/amberelectric.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/amberelectric.markdown

[uncategorized] ~62-~62: A punctuation mark might be missing here.
Context: ...--------------------------------------- | | site_id | Yes | ID of the...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs

coderabbitai[bot]
coderabbitai bot reviewed May 17, 2025
View reviewed changes
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

♻️ Duplicate comments (1)
source/_integrations/amberelectric.markdown (1)

50-52: Deprecation admonition implemented correctly
Great use of a dedicated deprecation block for the Forecast sensor, making the impending removal in version 2025.11 and the migration path to get_forecasts unmissable.

🧹 Nitpick comments (1)
source/_integrations/amberelectric.markdown (1)

65-68: Punctuation consistency in the parameter table
Add a trailing period to the channel_type description for consistency with the site_id row:

- | `channel_type` | Yes      | The channel type to fetch. Options: general, controller_load, feed_in |
+ | `channel_type` | Yes      | The channel type to fetch. Options: general, controller_load, feed_in. |
🧰 Tools
🪛 LanguageTool

[uncategorized] ~66-~66: A punctuation mark might be missing here.
Context: ...--------------------------------------- | | site_id | Yes | ID of the...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 123d4ae and 8e5df2a.

📒 Files selected for processing (1)
  • source/_integrations/amberelectric.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/amberelectric.markdown

[uncategorized] ~66-~66: A punctuation mark might be missing here.
Context: ...--------------------------------------- | | site_id | Yes | ID of the...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

🔇 Additional comments (1)
source/_integrations/amberelectric.markdown (1)

59-63: Well-structured Actions section for get_forecasts
The new "Actions" section with clear headings and concise description aligns with Home Assistant's documentation style and guides users to the new functionality effectively.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@madpilot
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy