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. |
TheJulianJES
added
the
needs review
| > [!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.
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.
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. |
| @@ -9,6 +9,9 @@ ZHA device handlers bridge the functionality gap created when manufacturers devi | |||
|
|
|||
| Custom quirks implementations for zigpy implemented as ZHA Device Handlers are a similar concept to that of [Hub-connected Device Handlers for the SmartThings Classics platform](https://stdavedemo.readthedocs.io/en/latest/device-type-developers-guide/) as well that of [Zigbee-Herdsman Converters (formerly Zigbee-Shepherd Converters) as used by Zigbee2mqtt](https://www.zigbee2mqtt.io/advanced/support-new-devices/01_support_new_devices.html), meaning they are virtual representation of a physical device that expose additional functionality that is not provided out-of-the-box by the existing integration between these platforms. See [Device Specifics](#Device-Specifics) for details. | |||
|
|
|||
|
|
|||
| For supporting Tuya devices, see [using the TuyaQuirkBuilder](/tuya.md). | |||
There was a problem hiding this comment.
Very minor, but just realized this link isn't clickable on PyPi now, as it leads to https://pypi.org/tuya.md then.
We may want to use the full link here? Or at least see what (our) other repos do. Probably doesn't really matter though 😄
There was a problem hiding this comment.
Didn't even consider PyPi when I did that. Once we get this latest batch of PRs through, I need to add the new convenience methods to the docs and will change this to the full link on that PR.
There was a problem hiding this comment.
Yeah, I don't think anybody reads the docs there, but.. 😄
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-commitchecks pass / the code has been formatted using Black