feat: add core ZeoApi with ZeoCommandTrait and ZeoFeatureTrait - #897
feat: add core ZeoApi with ZeoCommandTrait and ZeoFeatureTrait#897NOisi-x wants to merge 7 commits into
Conversation
Add MqttQos enum (AT_MOST_ONCE=0, AT_LEAST_ONCE=1, EXACTLY_ONCE=2) and thread a qos parameter through the publish chain (MqttSession -> MqttChannel -> send_decoded_command). All existing callers keep default AT_MOST_ONCE (backward compatible). Also add a unix timestamp field to A01 encode_mqtt_payload, required by Zeo/Dyad devices for command acceptance.
… all 56 devices covered Expand RoborockZeoProtocol from 31 to 67 DP entries, ordered by numeric ID. Add all missing enum classes (ZeoFeatureBits, ZeoDryingMethod, ZeoSteamVolume, ZeoDryAndCare, ZeoDryerStartError) and extend existing enums to cover every state/value found in the official app plugin bundle. Add ZeoStartParams, ZeoCustomMode, and ZeoDryerCustomMode data containers inheriting from RoborockBase, placed in zeo_containers.py per reviewer guidance.
Update ZeoStartParams, ZeoCustomMode, and ZeoDryerCustomMode to use typed enum fields (ZeoMode, ZeoProgram, ZeoTemperature, etc.) instead of raw int, aligning with the V1 container pattern in v1_containers.py. Rename shorthand fields (rinse_times→rinse, spin_level→spin) for consistency across all three classes. Unify drying-mode field naming.
…overy Subscribes to the device DPS MQTT topic after connection. Incoming RPC_RESPONSE messages are decoded and merged into _dps_cache with incremental updates. _discover_features() queries FEATURE_BITS (DP 237) to wake the device and cache capabilities — equivalent to V1's discover_features(). Also fixes TraitUpdateListener init in ZeoApi and a01_properties routing in connect().
5c3ec4e to
97f4940
Compare
ZeoCommandTrait (new: command.py, 165 lines) - start_program: bundles start params via FIELD_TO_DP, QoS 1 - pause / resume / shutdown: single-DP commands - Start param sets split by device type (washer 10 DPs, dryer 7 DPs) - Feature-gated DPs conditionally included from cache - Dependencies injected: channel, dps_cache, feature_trait, proto_entries ZeoFeatureTrait (new: device_features.py, 185 lines) - ZeoFeatures dataclass (24 bool flags): from_feature_bits() via name reflection - Product type detection: static model ID whitelists (dryer/Hyperion/M1) - is_dryer / is_hyperion_halia_hera / is_m1_muse_metis — no device query - refresh(): query DP 237 once, cache in memory ZeoStartParams (zeo_containers.py): expanded to 13 fields covering washer + dryer ZEO_PROTOCOL_ENTRIES (__init__.py): expanded to ~69 DP-type mappings RoborockZeoProtocol: add UNKNOWN_246, UNKNOWN_259 placeholders Builds on Python-roborock#895 (MQTT push subscription).
cbb254f to
c57f0b7
Compare
allenporter
left a comment
There was a problem hiding this comment.
Great work articulating the differences between the washer and dryer. Given the differences (e.g. params, modes, etc). This seems like a perfect use for separate traits. It seems like a "washer trait" and "dryer trait" now make sense to introduce.
Can you review the existing trait pattern for prior art?
|
@allenporter The difference between washer and dryer in V1's Given the minimal difference, is the current single-trait approach acceptable, or would you still prefer separate classes? |
What this PR does
Finally, this PR gives us the ability to really start a wash programe on Zeo devices.
What you can now do
The start command reads the device's current mode, program, temperature, rinse, spin, and drying settings via the MQTT cache — no extra network round-trip if the values were already pushed. It bundles everything together and sends it as one MQTT message, the same way the official app does.
How it knows what the device supports
ZeoFeatureTraitdoes two things at connection time:Product type detection — looks at the model ID (e.g.
roborock.wm.a234) and immediately knows whether it's a dryer or a specific washer series. No device query needed, this info is static per model.Feature discovery — queries DP 237 once and parses a 24-bit capability mask into readable flags like
smart_hosting,ion_deodorization,wash_dry_linkage. These flags control which optional DPs get included in start commands.RoborockZeoProtocol additions
UNKNOWN_246 = 246— placeholder to prevent "unknown code" errors if a device reports this protocol numberUNKNOWN_259 = 259— same; reserved protocol slot, not found in the plugin bundle