Skip to content

Conversation

@Boilerplate4u
Copy link

@Boilerplate4u Boilerplate4u commented Oct 20, 2025

Added supported frameworks information for DSMR component.

Description:

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable):

  • esphome/esphome#

Checklist:

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • Link added in /components/index.rst when creating new documents for new components or cookbook.

New Component Images

If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.

To generate a component image:

  1. Comment on this pull request with the following command, replacing COMPONENT_NAME with your component name in UPPER_CASE format with underscores (e.g., BME280, SHT3X, DALLAS_TEMP):

    @esphomebot generate image COMPONENT_NAME
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the images/ folder of this repository.

  4. Use the image in your component's index table entry in /components/index.rst.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image DHT22

Added supported frameworks information for DSMR component.
@esphome esphome bot added the current label Oct 20, 2025
@netlify
Copy link

netlify bot commented Oct 20, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit fde7c0e
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/68f61395cb7b10000896d30f
😎 Deploy Preview https://deploy-preview-5501--esphome.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
Copy link
Contributor

coderabbitai bot commented Oct 20, 2025

Walkthrough

A single documentation line was added to the DSMR component file indicating supported frameworks (Arduino, with ESP-IDF work in progress). No functional changes or control flow modifications were made.

Changes

Cohort / File(s) Summary
Documentation update
content/components/sensor/dsmr.md
Added supported frameworks information to DSMR component documentation

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5 minutes

Suggested labels

component: dsmr

Suggested reviewers

  • swoboda1337

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "Update DSMR documentation with supported frameworks" directly and clearly describes the main change in the changeset. According to the raw summary, the PR adds documentation about supported frameworks (Arduino and ESP-IDF work in progress for ESP-IDF) to the DSMR component documentation. The title is concise, specific, and would allow a teammate scanning the git history to immediately understand that this change updates the DSMR documentation with framework support information.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed The pull request description states "Added supported frameworks information for DSMR component," which directly and accurately reflects the actual changes shown in the raw summary. The summary confirms that a documentation line about supported frameworks was added to the DSMR component docs. The description is specific and clearly conveys the purpose of the changeset, indicating what was added and to which component, making it both relevant and meaningful.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@PolarGoose
Copy link

This pull request is related to the changes:
[DSMR] Remove dependency on Arduino framework. Various bug fixes. #11036

@PolarGoose
Copy link

@Boilerplate4u,

Could you also please add this to your pull request:

Also be sure to update the Arduino to ESP-IDF guide as well in the docs as it currently mentions there is no dsmr option for IDF which can now be removed

@Boilerplate4u
Copy link
Author

Boilerplate4u commented Oct 22, 2025

@PolarGoose,
Is this a request to the doc maintainers, or do you want me to add something like this?

Supported frameworks: Arduino (Work in progress for ESP-IDF)

Also be sure to update the Arduino to ESP-IDF guide as well in the docs as it currently mentions there is no dsmr option for IDF which can now be removed

I’m not entirely sure I understand the full context here, so please clarify if I’m missing something.

@PolarGoose
Copy link

@Boilerplate4u,

I’m not entirely sure I understand the full context here, so please clarify if I’m missing something.

The comment: esphome/esphome#11036 (comment)

@Boilerplate4u
Copy link
Author

Okay, if you put together a draft for the full text, I’ll add the changes so you can reference it in your PR.

By the way, nice work on your PR! I’ve been running your solution for a few days now and it’s been working great so far. //Cheers.

@PolarGoose
Copy link

Okay, if you put together a draft for the full text, I’ll add the changes so you can reference it in your PR.

Changes:
Remove the line {{< docref "/components/sensor/dsmr" "dsmr" >}} - Dutch Smart Meter integration from content/guides/esp32_arduino_to_idf.md

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants