-
Notifications
You must be signed in to change notification settings - Fork 707
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
Add Tuya quirk builder docs #3480
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev #3480 +/- ##
==========================================
+ Coverage 89.44% 89.79% +0.34%
==========================================
Files 311 323 +12
Lines 10033 10414 +381
==========================================
+ Hits 8974 9351 +377
- Misses 1059 1063 +4 ☔ View full report in Codecov by Sentry. |
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.
Awesome, I've made some minor changes that I'll commit in a second.
I'll take another look at the finished text then.
> [!IMPORTANT] | ||
> The following should work for most Tuya devices. Some devices may require additional reverse engineering to unlock all functions. |
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.
Ok, now that I actually look at it, maybe we don't really need the fancy markdown here.
Preview: https://github.com/zigpy/zha-device-handlers/blob/b4fc995f9833a0a173c6aac9310815f0fcf860aa/tuya.md
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.
eh, but maybe it's fine 😄
Thanks! This merge will be pull requested to official zha quirks tree? It includes tuya rain sensor quirk? |
This is just a doc PR, never heard any feedback on the rain sensor, if you want to test and let me know, I can PR it. |
Yes, I want to test tuya rain sensor quirk. |
Please move conversation to #3475 There is a quirk in the comments section you can try. |
Proposed change
This adds initial documentation for using the TuyaQuirkBuilder. We have a few examples, but nothing as far as documentation. We also don't have documentation for the V2 QuirkBuilder, may need that prior to adding this.
Formatted Version
Additional information
As plainly evident, technical documentation is not one of my strongpoints, any suggestions would be welcome.
Checklist
pre-commit
checks pass / the code has been formatted using Black