Skip to content

Add Landis+Gyr E360 to known working meters #37043

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

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

NanoBob
Copy link
Contributor

@NanoBob NanoBob commented Jan 21, 2025

Proposed change

  • Add Landis+Gyr E360 to known working meters
  • Add additional elaboration regarding needing a special P1 cable

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

If desired I can add the link to the webstore where I purchased my working cable, however I am uncertain what the stance is towards promoting specific stores / products so I didn't include the link for now.

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
    • Corrected spelling of "DMSR" to "DSMR" in supported meters list
    • Added Landis+Gyr E360 (DSMR 5) to supported meters
    • Updated documentation to clarify M-Bus support for multiple gas and water meters

@home-assistant home-assistant bot added the current This PR goes into the current branch label Jan 21, 2025
Copy link

netlify bot commented Jan 21, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 94086fd
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67901371b285fa000806d04e
😎 Deploy Preview https://deploy-preview-37043--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 Jan 21, 2025

📝 Walkthrough

Walkthrough

The pull request updates the documentation for the DSMR Smart Meter integration, focusing on improving clarity and expanding device support. The changes include correcting the spelling of "DSMR" from "DMSR", adding support for the Landis+Gyr E360 (DSMR 5) smart meter, and providing additional details about M-Bus support for DSMR version 5B. The documentation now clarifies the requirements for the E360 meter and its special P1 cable, while also highlighting the integration's ability to handle multiple gas and water meters.

Changes

File Changes
source/_integrations/dsmr.markdown - Corrected spelling from "DMSR" to "DSMR" for Landis+Gyr E350 meter
- Added new supported meter: Landis+Gyr E360 (DSMR 5)
- Updated information about M-Bus support for DSMR 5B
- Added note about special P1 cable requirement for E360 meter

The changes are primarily documentation-related, improving the clarity and comprehensiveness of the DSMR Smart Meter integration documentation.


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 (1)
source/_integrations/dsmr.markdown (1)

68-69: Consider adding more context about the special P1 cable requirement.

While the remark about the E360's special cable requirement is valuable, it would be helpful to briefly explain why a special cable is needed (e.g., different voltage requirements, pin configuration, etc.). This would help users understand the importance of getting the correct cable.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 13e2019 and 94086fd.

📒 Files selected for processing (1)
  • source/_integrations/dsmr.markdown (2 hunks)
⏰ 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/dsmr.markdown (2)

57-57: LGTM! Spelling correction improves consistency.

The correction from "DMSR" to "DSMR" aligns with the correct terminology used throughout the documentation.


58-58: LGTM! New meter addition is well-documented.

The addition of Landis+Gyr E360 with DSMR 5 support follows the existing format and includes a helpful reference to special requirements.

Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @NanoBob 👍

@c0ffeeca7 c0ffeeca7 merged commit 86f1968 into home-assistant:current Jan 22, 2025
7 checks passed
@NanoBob NanoBob deleted the dsmr-e360-elaboration branch January 22, 2025 10:22
@github-actions github-actions bot locked and limited conversation to collaborators Jan 23, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants