Add Leneda integration documentation (revamp after integration overhaul) #39347
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA new documentation file has been introduced for the Leneda integration with Home Assistant. This file details the setup process, configuration options, supported features, data update intervals, and troubleshooting steps for connecting Home Assistant to the Leneda Luxembourg Energy Platform. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant LenedaPlatform
User->>HomeAssistant: Initiate Leneda integration setup
HomeAssistant->>User: Prompt for Energy ID, API key, metering point IDs
User->>HomeAssistant: Provide credentials and configuration
HomeAssistant->>LenedaPlatform: Authenticate using API key
LenedaPlatform-->>HomeAssistant: Confirm authentication
HomeAssistant->>LenedaPlatform: Request metering points/OBIS codes
LenedaPlatform-->>HomeAssistant: Return available OBIS codes/data
HomeAssistant->>User: Display metering points (auto/manual selection)
User->>HomeAssistant: Select metering points
HomeAssistant->>LenedaPlatform: Fetch energy/gas data (hourly, 1-day delay)
LenedaPlatform-->>HomeAssistant: Return historical consumption/production data
HomeAssistant->>User: Show data via statistics objects on dashboard
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
source/_integrations/leneda.markdown (5)
23-27: Add blank line before lists for Markdown readability.Per markdownlint (MD032), lists should be surrounded by blank lines. Insert a blank line between the introductory sentence and the list of prerequisites:
-Before setting up the integration, you need: - An Energy ID and API key from your Leneda platform account +Before setting up the integration, you need: +An Energy ID and API key from your Leneda platform account🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
24-24: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
57-66: Fix nested list indentation.Nested list items under the setup options are indented with three spaces; Home Assistant style uses two spaces. For example:
- - The integration scans all OBIS codes for your metering point. + - The integration scans all OBIS codes for your metering point.Apply this change to lines 60–62 and 65–66.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
60-60: Unordered list indentation
Expected: 2; Actual: 3(MD007, ul-indent)
61-61: Unordered list indentation
Expected: 2; Actual: 3(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 2; Actual: 3(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 3(MD007, ul-indent)
66-66: Unordered list indentation
Expected: 2; Actual: 3(MD007, ul-indent)
98-104: Hyphenate “long term” in header.Use a hyphen for the compound adjective in the heading:
-### Accurate long term statistics +### Accurate long-term statistics🧰 Tools
🪛 LanguageTool
[uncategorized] ~100-~100: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...orical data for analysis. ### Accurate long term statistics Despite the one-day lag, th...(EN_COMPOUND_ADJECTIVE_INTERNAL)
128-130: Use “ensure” instead of “make sure” for formal tone.Replace informal phrasing:
-please make sure that you can access the API +please ensure you can access the API🧰 Tools
🪛 LanguageTool
[style] ~130-~130: Consider using a different verb to strengthen your wording.
Context: ...gging in or accessing your data, please make sure that you can access the API from the in...(MAKE_SURE_ENSURE)
132-135: Use “verify” instead of “check” for consistency.Replace casual wording:
-please first check that you can see your gas consumption +please first verify that you can see your gas consumption🧰 Tools
🪛 LanguageTool
[style] ~134-~134: Try using a more formal synonym for ‘check’.
Context: ... for gas but don't see it, please first check that you can see your gas consumption i...(VERIFY)
📜 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
📒 Files selected for processing (1)
source/_integrations/leneda.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/leneda.markdown
[uncategorized] ~100-~100: If this is a compound adjective that modifies the fo
8FE8
llowing noun, use a hyphen.
Context: ...orical data for analysis. ### Accurate long term statistics Despite the one-day lag, th...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~130-~130: Consider using a different verb to strengthen your wording.
Context: ...gging in or accessing your data, please make sure that you can access the API from the in...
(MAKE_SURE_ENSURE)
[style] ~134-~134: Try using a more formal synonym for ‘check’.
Context: ... for gas but don't see it, please first check that you can see your gas consumption i...
(VERIFY)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/leneda.markdown
24-24: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
60-60: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
61-61: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
66-66: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
⏰ 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 (7)
source/_integrations/leneda.markdown (7)
1-16: Frontmatter metadata correct.The YAML frontmatter includes all required fields (
title,description,ha_category,ha_release,ha_iot_class,ha_config_flow,ha_codeowners,ha_domain,ha_quality_scale,ha_platforms,ha_integration_type) and follows Home Assistant documentation conventions.
19-19: Introduction is clear and concise.The description succinctly explains the purpose of the Leneda integration and links to the official platform.
29-36: Configuration snippet usage is correct.The
config_flowinclude andconfiguration_basicmacro are used appropriately to render the YAML config UI in the docs.
38-48: Adding metering points steps are clear.The step-by-step instructions for adding metering points via the UI are well structured and easy to follow.
70-93: Available sensors section is comprehensive.The breakdown of OBIS codes into electricity consumption, production, and gas consumption is well organized and informative.
106-117: Energy dashboard instructions are well-written.The steps and notes for adding Leneda statistics to the energy dashboard are clear and map correctly to the UI.
136-143: Integration removal instructions follow standards.The use of the
remove_device_serviceinclude and guidance on revoking API keys aligns with best practices for clean uninstallation.
Proposed change
This PR introduces documentation for the upcoming Leneda integration. The Leneda integration allows to connect HomeAssistant to the Leneda Luxembourg Energy Platform (www.leneda.eu)
There was an earlier documentation PR here: #38994
The integration PR has been redone, and so the documentation has been updated accordingly.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit