Add info for multiplexing to sml.rst #5062
Conversation
Add info on how multiple meters can be read using a single HardwareSerial UART.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Caution Review failedAn error occurred during the review process. Please try again later. ✨ Finishing Touches🧪 Generate unit tests
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
components/sml.rst (2)
227-233: Minor wording & punctuation tweaks improve clarityConsider tightening the phrasing and fixing the “more than 2” → “more than two” style nit. It reads more naturally in docs and is consistent with the rest of the page.
259-282: Duplicate sensor filter blocks – consider extracting commentBoth sensor definitions share identical
filters. To keep the sample concise:filters: - multiply: 0.0001 # applies to both metersYou can mention once in a comment that both sensors need the same scaling.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/sml.rst(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**: - Do not generate or add any sequence diagrams
⚙️ Source: CodeRabbit Configuration File
List of files the instruction was applied to:
components/sml.rst
🧠 Learnings (1)
📓 Common learnings
Learnt from: jesserockz
PR: esphome/esphome-docs#4865
File: .github/workflows/needs-docs.yml:0-0
Timestamp: 2025-05-01T03:29:47.922Z
Learning: In the esphome-docs repository, the "current" label is automatically added by a bot to pull requests, making it a reliable indicator for the target branch.
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Check
- GitHub Check: build
🔇 Additional comments (1)
components/sml.rst (1)
246-258: Verifyload_settings(true)– API may have changed
UARTComponent::load_settings()in ESPHome currently takes no arguments (it reloads pins & parity automatically). Passingtruecould break compilation for users who paste this snippet verbatim.Please double-check against the current ESPHome API and adjust if needed, e.g.:
id(uart_multiplexed).load_settings();If an argument is indeed required, add a short explanation.
components/sml.rst
Outdated
| uart: | ||
| - baud_rate: 9600 | ||
| data_bits: 8 | ||
| rx_pin: | ||
| number: 17 # Set to the first of the GPIO pins | ||
| id: uart_multiplex_rx_pin | ||
| stop_bits: 1 | ||
| rx_buffer_size: 512 | ||
| id: uart_multiplexed | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
YAML indentation & trailing-space issues will break copy-paste usage
The example block contains:
- Trailing spaces after
uart:(line 236) – these are rendered in the docs and copy-paste ends up with an invalid key. - List indentation is off (list items should be indented two spaces under the key).
Current indentation confuses YAML linters and ESPHome rejects the config.
Proposed fix:
- uart:
- - baud_rate: 9600
- data_bits: 8
- rx_pin:
- number: 17 # Set to the first of the GPIO pins
- id: uart_multiplex_rx_pin
- stop_bits: 1
- rx_buffer_size: 512
- id: uart_multiplexed
+ uart:
+ - baud_rate: 9600
+ data_bits: 8
+ rx_pin:
+ number: 17 # first GPIO pin
+ id: uart_multiplex_rx_pin
+ stop_bits: 1
+ rx_buffer_size: 512
+ id: uart_multiplexed📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| uart: | |
| - baud_rate: 9600 | |
| data_bits: 8 | |
| rx_pin: | |
| number: 17 # Set to the first of the GPIO pins | |
| id: uart_multiplex_rx_pin | |
| stop_bits: 1 | |
| rx_buffer_size: 512 | |
| id: uart_multiplexed | |
| uart: | |
| - baud_rate: 9600 | |
| data_bits: 8 | |
| rx_pin: | |
| number: 17 # first GPIO pin | |
| id: uart_multiplex_rx_pin | |
| stop_bits: 1 | |
| rx_buffer_size: 512 | |
| id: uart_multiplexed |
🤖 Prompt for AI Agents
In components/sml.rst around lines 236 to 245, fix the YAML indentation by
removing trailing spaces after the key 'uart:' and ensure list items under
'uart:' are indented exactly two spaces. Adjust the nested keys accordingly to
conform to proper YAML structure so that linters and ESPHome accept the
configuration without errors.
Co-authored-by: Jesse Hills <[email protected]>
…5314) Co-authored-by: J. Nick Koston <[email protected]>
|
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions. |
Co-authored-by: Copilot <[email protected]> Co-authored-by: Jesse Hills <[email protected]>
|
@jesserockz Is there any interest in merging something like this? Or should I close this and post it somewhere else outside of the official esphome docs? |
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for reading multiple SML meters using UART multiplexing when the controller has insufficient UARTs. It provides a practical solution for users who need to connect more than two meters to an ESP32.
- Adds a new "Reading multiple meters" section explaining UART multiplexing concept
- Provides a complete YAML configuration example showing how to switch between meters
- Includes sensor definitions for multiple meters with different server IDs
content/components/sml.md
Outdated
| .. code-block:: yaml | ||
|
|
||
| uart: | ||
| - baud_rate: 9600 | ||
| data_bits: 8 | ||
| rx_pin: | ||
| number: GPIO17 # Set to the first of the GPIO pins in multiplex_pins | ||
| id: uart_multiplex_rx_pin | ||
| stop_bits: 1 | ||
| rx_buffer_size: 512 | ||
| id: uart_multiplexed | ||
|
|
||
| sml: | ||
| - id: sml_multiplexed | ||
| uart_id: uart_multiplexed | ||
| on_data: | ||
| - lambda: |- | ||
| std::vector<gpio_num_t> multiplex_pins = {::GPIO_NUM_17,::GPIO_NUM_19}; | ||
| static size_t current_index = 0; | ||
| current_index = (current_index + 1) % multiplex_pins.size(); | ||
| gpio_num_t new_rx_pin = multiplex_pins[current_index]; | ||
| id(uart_multiplex_rx_pin).set_pin(new_rx_pin); | ||
| id(uart_multiplexed).load_settings(true); | ||
|
|
||
| sensor: | ||
| - platform: sml | ||
| name: "Solar Roof" | ||
| sml_id: sml_multiplexed | ||
| server_id: "12345ab" # IMPORTANT! Set the correct server id | ||
| obis_code: "1-0:2.8.0" | ||
|
|
||
| - platform: sml | ||
| name: "Solar Carport" | ||
| sml_id: sml_multiplexed | ||
| server_id: "67890cd" # IMPORTANT! Set the correct server id | ||
| obis_code: "1-0:2.8.0" | ||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
The code block should use yaml syntax highlighting instead of the reStructuredText .. code-block:: yaml directive. This file uses Markdown format, so it should use triple backticks with yaml language identifier: ```yaml
| .. code-block:: yaml | |
| uart: | |
| - baud_rate: 9600 | |
| data_bits: 8 | |
| rx_pin: | |
| number: GPIO17 # Set to the first of the GPIO pins in multiplex_pins | |
| id: uart_multiplex_rx_pin | |
| stop_bits: 1 | |
| rx_buffer_size: 512 | |
| id: uart_multiplexed | |
| sml: | |
| - id: sml_multiplexed | |
| uart_id: uart_multiplexed | |
| on_data: | |
| - lambda: |- | |
| std::vector<gpio_num_t> multiplex_pins = {::GPIO_NUM_17,::GPIO_NUM_19}; | |
| static size_t current_index = 0; | |
| current_index = (current_index + 1) % multiplex_pins.size(); | |
| gpio_num_t new_rx_pin = multiplex_pins[current_index]; | |
| id(uart_multiplex_rx_pin).set_pin(new_rx_pin); | |
| id(uart_multiplexed).load_settings(true); | |
| sensor: | |
| - platform: sml | |
| name: "Solar Roof" | |
| sml_id: sml_multiplexed | |
| server_id: "12345ab" # IMPORTANT! Set the correct server id | |
| obis_code: "1-0:2.8.0" | |
| - platform: sml | |
| name: "Solar Carport" | |
| sml_id: sml_multiplexed | |
| server_id: "67890cd" # IMPORTANT! Set the correct server id | |
| obis_code: "1-0:2.8.0" | |
| ```yaml | |
| uart: | |
| - baud_rate: 9600 | |
| data_bits: 8 | |
| rx_pin: | |
| number: GPIO17 # Set to the first of the GPIO pins in multiplex_pins | |
| id: uart_multiplex_rx_pin | |
| stop_bits: 1 | |
| rx_buffer_size: 512 | |
| id: uart_multiplexed | |
| sml: | |
| - id: sml_multiplexed | |
| uart_id: uart_multiplexed | |
| on_data: | |
| - lambda: |- | |
| std::vector<gpio_num_t> multiplex_pins = {::GPIO_NUM_17,::GPIO_NUM_19}; | |
| static size_t current_index = 0; | |
| current_index = (current_index + 1) % multiplex_pins.size(); | |
| gpio_num_t new_rx_pin = multiplex_pins[current_index]; | |
| id(uart_multiplex_rx_pin).set_pin(new_rx_pin); | |
| id(uart_multiplexed).load_settings(true); | |
| sensor: | |
| - platform: sml | |
| name: "Solar Roof" | |
| sml_id: sml_multiplexed | |
| server_id: "12345ab" # IMPORTANT! Set the correct server id | |
| obis_code: "1-0:2.8.0" | |
| - platform: sml | |
| name: "Solar Carport" | |
| sml_id: sml_multiplexed | |
| server_id: "67890cd" # IMPORTANT! Set the correct server id | |
| obis_code: "1-0:2.8.0" | |
Copilot uses AI. Check for mistakes.
| obis_code: "1-0:2.8.0" | ||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
Remove the extra blank lines at the end of the new section. Only one blank line is needed before the next section.
Copilot uses AI. Check for mistakes.
|
Reopened in new format in #5341 |
Add info on how multiple meters can be read using a single HardwareSerial UART.
Description:
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause 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.rstwhen creating new documents for new components or cookbook.