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. |
|
""" WalkthroughA new documentation section was added describing how to use UART RX pin multiplexing to read data from multiple SML meters with a single UART interface. The section includes an explanation and a YAML configuration example demonstrating dynamic switching of the UART RX pin to sequentially read from different meters. Changes
Suggested labels
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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 (
|
![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.
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.