-
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 pzemac.rst #4563
base: current
Are you sure you want to change the base?
Update pzemac.rst #4563
Conversation
Add a wiring diagram, some text and add id for pzemac platform
WalkthroughThe changes to the 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 (3)
components/sensor/pzemac.rst (3)
21-24
: Fix grammar and enhance hardware descriptionThe sentence has a grammar error and could be more specific about configurations.
-The sensor may comes in plastic enclosure, with or without a current transformer. Thus it can be connected in various configurations - please see the `manufacturer's website <https://innovatorsguru.com/pzem-004t-v3/>`__ +The sensor comes in a plastic enclosure, with or without a current transformer. It supports both split-core and solid-core current transformer configurations - please see the `manufacturer's website <https://innovatorsguru.com/pzem-004t-v3/>`__
27-27
: Replace spaces in image filename with underscoresUsing spaces in filenames can cause issues in some systems. Consider renaming the file.
-.. figure:: images/pzem004t v3 wiring.png +.. figure:: images/pzem004t_v3_wiring.png
111-115
: Add explanation for template button usageWhile the template button implementation is good, consider adding a brief explanation of why this approach is preferred over other methods.
Add a note before the code block:
This example uses a template button to create a virtual button in the frontend, providing a user-friendly way to reset the energy counter:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/sensor/pzemac.rst
(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
components/sensor/pzemac.rst (1)
Pattern **
: - Do not generate or add any sequence diagrams
🔇 Additional comments (2)
components/sensor/pzemac.rst (2)
36-36
: LGTM! Important compatibility information addedThe added warning about voltage levels and the suggestion to use a logic level converter is valuable for preventing hardware damage.
66-66
: LGTM! Good ID additionThe added ID makes the configuration example more complete and is properly referenced in the reset energy action example.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Add a wiring diagram, some text and id in pzemac code
The action of energy reset is better in a virtual button ready to use , instead of dummy action
The new image pzem004t v3 wiring.png :
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.