-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
Update pzemdc.rst #4538
base: current
Are you sure you want to change the base?
Update pzemdc.rst #4538
Conversation
Added details on RS485 converter requirements, independent power supply usage, and configuring shunt values using the manufacturer’s software.
WalkthroughThe documentation for the Peacefair PZEM-00X DC Energy Monitor has been comprehensively updated. The changes focus on providing detailed guidance for sensor setup, including critical information about RS485 communication, power supply requirements, and specific model capabilities. The documentation now offers more precise instructions on using RS485 converters, power supply considerations, and configuration details for different PZEM sensor models. Changes
Suggested Reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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.
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 (4)
components/sensor/pzemdc.rst (4)
22-24
: Enhance visibility using RST admonitionsThe RS485 converter requirements are crucial for proper operation. Consider using RST admonitions to make this information more prominent.
-To use these devices with ESPHome, you will need an RS485 to UART TTL converter. -If your converter does not include a built-in 120-ohm resistor, you may experience unreliable readings or "unknown" values in Home Assistant. -In such cases, connect a 120-ohm resistor between the A and B terminals of the RS485 bus. +.. important:: + + To use these devices with ESPHome, you will need an RS485 to UART TTL converter. + +.. warning:: + + If your converter does not include a built-in 120-ohm resistor, you may experience unreliable readings or "unknown" values in Home Assistant. + In such cases, connect a 120-ohm resistor between the A and B terminals of the RS485 bus.
26-28
: Fix grammar and improve formattingThe power supply requirements section contains valuable information but needs grammatical fixes and consistent formatting.
-These sensors require an independent power supply to operate if the Test input Voltage is lower then 7v. The USB input powers the internal measurement circuit, while the RS485 communication circuit requires a separate power supply via the screw terminal block. ( tested on PZEM-017 ) -For isolation and safety, use different power sources for these circuits. For example, a 5V 1A adapter can power the USB input externally , while the RS485 input can be powered with ESP32 5V supply with a common Ground . -This separation helps prevent potential interference and ensures Safe operation. +.. warning:: + + These sensors require an independent power supply to operate if the test input voltage is lower than 7V. The USB input powers the internal measurement circuit, while the RS485 communication circuit requires a separate power supply via the screw terminal block. (Tested on PZEM-017) + + For isolation and safety, use different power sources for these circuits. For example: + + * A 5V 1A adapter can power the USB input externally + * The RS485 input can be powered with ESP32 5V supply with a common ground + + This separation helps prevent potential interference and ensures safe operation.
30-32
: Add details about manufacturer's softwareThe shunt configuration section should include more information about accessing and using the manufacturer's software.
Consider adding:
- Where to obtain the manufacturer's software
- Basic steps for configuring the shunt value
- Any prerequisites for using the software
34-34
: Remove unnecessary quotation marks and improve formattingThe PZEM model capabilities information should be properly formatted as a note or table.
-"The PZEM-003 and PZEM-014 do not require an external shunt and can measure up to 10 amps, while the PZEM-016 is an AC meter that uses a CT (current transformer)." +.. note:: + + Model capabilities: + + * PZEM-003 and PZEM-014: No external shunt required, can measure up to 10 amps + * PZEM-016: AC meter that uses a CT (current transformer)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/sensor/pzemdc.rst
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
components/sensor/pzemdc.rst (1)
Pattern **
: - Do not generate or add any sequence diagrams
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Added details on RS485 converter requirements, independent power supply usage, and configuring shunt values using the manufacturer’s software.
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
/index.rst
when creating new documents for new components or cookbook.