Skip to content

Conversation

@rmie
Copy link

@rmie rmie commented Dec 6, 2025

Description:

I spent some time today trying to use the wrong module for a board marked PZEM-004T-100A-D-P(V1.0).
Hope this is helpful for others.

Checklist:

  • 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.

@esphome esphome bot added the current label Dec 6, 2025
@netlify
Copy link

netlify bot commented Dec 6, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 3e9a57e
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/69369ab0f5a2f60008396ba7
😎 Deploy Preview https://deploy-preview-5737--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 Dec 6, 2025

Walkthrough

Documentation updates for PZEM sensors: warning in pzem004t.md expanded to mention V3 and PZEM-004T-100A-D-P(V1.0). pzemac.md adds an "Other Devices" subsection describing the PZEM-004T-100A-D-P(V1.0) silkscreen/version, 5-pin header pinout, 3.3V use on the 5V pin, and an image; the subsection appears twice.

Changes

Cohort / File(s) Change Summary
PZEM sensor warning update
content/components/sensor/pzem004t.md
Expanded warning/documentation to include the newer V3 variant and boards marked PZEM-004T-100A-D-P(V1.0); updated reference text.
PZEM "Other Devices" subsection addition
content/components/sensor/pzemac.md
Added an "Other Devices" subsection documenting PZEM-004T-100A-D-P(V1.0) silkscreen/version marking, a 5-pin header pinout (5V, RX, TX, CF, GND), noted that 5V can be driven with 3.3V without level shifting, and included an image. The new subsection is duplicated within the file.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Documentation-only changes; small additions and an image.
  • Review attention:
    • Confirm pinout text matches the included image in pzemac.md.
    • Verify silkscreen/version wording and correct placement.
    • Remove or justify the duplicated subsection in pzemac.md.

Suggested reviewers

  • frenck

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main change in the PR, which adds documentation for the PZEM-004T-100A-D-P(V1.0) variant across two documentation files.
Description check ✅ Passed The description is directly related to the changeset, explaining the motivation for adding documentation about the PZEM-004T-100A-D-P(V1.0) variant to help prevent confusion.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5f3560a and 3e9a57e.

⛔ Files ignored due to path filters (1)
  • content/components/sensor/images/pzem-004t-100a-d-p-v1.0.jpg is excluded by !**/*.jpg
📒 Files selected for processing (2)
  • content/components/sensor/pzem004t.md (1 hunks)
  • content/components/sensor/pzemac.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • content/components/sensor/pzem004t.md
  • content/components/sensor/pzemac.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6de0df0 and f3816da.

📒 Files selected for processing (1)
  • content/components/sensor/pzemac.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**

⚙️ CodeRabbit configuration file

  • Do not generate or add any sequence diagrams

Files:

  • content/components/sensor/pzemac.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: jesserockz
Repo: esphome/esphome-docs PR: 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.
🪛 LanguageTool
content/components/sensor/pzemac.md

[grammar] ~161-~161: Ensure spelling is correct
Context: ...using {{< docref "pzem004t/" >}}. - One noteable difference to other boards is the 5 pin...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~161-~161: Use a hyphen to join words.
Context: ...able difference to other boards is the 5 pin connection labeled 5V, RX, TX,...

(QB_NEW_EN_HYPHEN)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build
🔇 Additional comments (3)
content/components/sensor/pzemac.md (3)

154-157: Section structure and organization look good.

The new "Other Devices" subsection is well-positioned and the naming clearly identifies the specific variant being documented.


160-163: Content effectively addresses the PR objective.

The documentation clearly explains the distinguishing features of the PZEM-004T-100A-D-P(V1.0) variant, specifically calling out the silkscreen marking confusion and providing practical technical details (pinout, voltage compatibility). This should help users select the correct variant and connection method.


158-158: The review comment references incorrect content. Line 158 of pzemac.md contains - {{< docref "pzemdc/" >}}, not an image reference. The actual image reference in the file is on line 27 and correctly uses pzem-ac.png, which exists in the repository. The filename pzem-004t-100a-d-p-v1.0.jpg does not exist anywhere in the repository and does not appear in this file.

Likely an incorrect or invalid review comment.

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.

1 participant