Skip to content

Conversation

CalamityDeadshot
Copy link

Proposed change

Adding a zero-to-hero guide on writing V2 quirks, as I was asked to in this discussion.

Copy link

codecov bot commented Sep 18, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.13%. Comparing base (2e2bbd9) to head (45b772b).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #4349   +/-   ##
=======================================
  Coverage   92.13%   92.13%           
=======================================
  Files         358      358           
  Lines       11919    11919           
=======================================
  Hits        10981    10981           
  Misses        938      938           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@TheJulianJES TheJulianJES self-assigned this Sep 18, 2025
@Hedda
Copy link
Contributor

Hedda commented Sep 22, 2025

Thanks for this! Wondering if the PR supersede this previous not-yet-merged PR with "Initial quirks v2 documentation thoughts"?

Also see the related discussions here which is a request for a complete guide on how to write v2 quirks for ZHA:

PS: FYI, btw, I submitted a PR for a guide on how-to test custom quirks in zha as a compliment to this howto guide:

@CalamityDeadshot
Copy link
Author

Wondering if the PR supersede this previous not-yet-merged PR with "Initial quirks v2 documentation thoughts"?

I don't think so, cuz the PR you linked goes a lot more in depth regarding the actual API - signatures, meaning of arguments and so on. This should definitely be available for people who don't want to or cannot read the actual code to understand what a function does. This PR is about how to write a quirk, whereas the one you linked focuses on how to write a quirk.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants