Skip to content

feat: add V1 product nicknames for models that fall back to PEARLPLUS - #1046

Open
infy1995 wants to merge 3 commits into
Python-roborock:mainfrom
infy1995:feat/v1-product-nicknames
Open

infy1995 wants to merge 3 commits into
Python-roborock:mainfrom
infy1995:feat/v1-product-nicknames

Conversation

@infy1995

@infy1995 infy1995 commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Part of #738 (dock controls): the per-model option lists need these product nicknames.

Adds the V1 vacuum product nicknames that RoborockProductNickname lacked, with their base product features. Today these models fall back to PEARLPLUS, so they get Qrevo MaxV product features they do not have, for example the remote view.

The nicknames, short models and features were compared with the model configuration in the current Roborock app V1 plugins. Combining each product's own features with the features it inherits, minus the same exclusion lists as PRODUCTS_WITHOUT_*, reproduces the library's existing entries, and the new entries are derived the same way.

New nicknames

Nickname Short models Base features
BERYLLITE, BERYL, BERYLS, BERYLE, BERYLC, CRAG a244/a245, a120/a121, a306/a307, a311/a312, a327/a328, a390/a391 BERYL_FEATURES (Max+, RGB camera)
BERYLCE a388, a389 Max+, AI pet, single-line camera
VIVIANSPROC, VIDA, VIDAS, CORALPROSAW a297/a298, a295/a296, a373/a376, a287/a288 VIVIANSPROC_FEATURES (Max+, RGB camera, spin mop)
VIVIANF, VIVIANS, VIVIANSC, VIVIANSPRO, HERA, PANDORA, PEARLFPRO, CORALPROS, R50 a182, a184/a185, a196/a197, a225/a226, a224/a249, a243/a250, a216/a217, a219/a220, a157/a179 PEARL_PLUS_FEATURES
PEARLCLITE, PEARLEH, QUINN, QUINNE, QUINNS, VIVIANSPROE a198/a199/a205, a325/a326, a293/a294, a358/a359, a404/a405, a374/a375 PEARL_FEATURES
VERDELITES a278, a279 Max+, RGB camera, shake mop
TALCSC a360, a361 electronic mop

Existing nicknames also get the short models that belong to them: VIVIANC + a186, a187, a209, a210, a246; CORALPRO + a231, a232, a236, a308.

None of the new products joins a PRODUCTS_WITHOUT_* set. Existing nicknames keep exactly their features: the first commit adds a per-nickname snapshot of PRODUCT_FEATURE_MAP generated on main, and those entries do not change. PEARLELITE (a169/a170) keeps its name; newer app versions call it PearlEPro, with the same features.

Roller-mop models

The Beryl products (e.g. P30 Pro a306, Saros 20 Flow a307, Qrevo Curv 2 Flow a245) use a roller mop and have no mop-module product feature, so today they get no water modes and no custom clean mode although they mop. is_support_water_mode and is_customized_clean_supported now also follow is_roller_mop_supported, as is_clean_route_setting_supported already does, so the roller mop counts as a mop module like a shake or spin mop.

Behaviour changes

Models that used to fall back to PEARLPLUS now get their own features:

  • All new products except those with PEARL_PLUS_FEATURES (and the VivianC extras) no longer report is_new_remote_view_supported, because they have no remote view.
  • VERDELITES (Saros 20 Sonic) gets the shake module, so its water modes are named mild / standard / intense instead of low / medium / high (same codes).
  • TALCSC loses Max+ suction and obstacle photos (no camera).
  • Beryl products that do not report the roller-mop bit get no water modes.

The existing test samples affected are the P30 Pro (a306) and the Qrevo 2 Pro (a294, now QUINN): is_new_remote_view_supported True -> False. The device-info CLI test now expects QUINN for a294 and keeps an unrecognised model for Unknown. Device features are cached, so existing installs keep their old values until the cache is rebuilt; recomputing them from the cached raw flags could be a follow-up.

Three existing entries differ from the app plugin and are left unchanged here: TOPAZSPOWER (remote view), TANOSSPLUS (3D map) and ULTRONSE (no electronic mop or pure clean mop). Happy to follow up separately.

Overlap with open PRs

Happy to rebase on either of them.

Test plan

  • uv run pre-commit run --all-files
  • uv run pytest
  • New tests: per-nickname PRODUCT_FEATURE_MAP snapshot, short model to nickname table, short-model uniqueness, product_nickname fallback, roller-mop water mode and custom clean.

Related issues

@infy1995 infy1995 mentioned this pull request Nov 14, 2026
9 tasks
@Lash-L Lash-L added Feature New feature Data model changes Changes to data models, device info, or feature mappings V1 V1 platform labels Nov 15, 2026
@infy1995
infy1995 force-pushed the feat/v1-product-nicknames branch from d217801 to ccf43c0 Compare November 15, 2026 20:34
@infy1995 infy1995 changed the title feat: add V1 product nicknames from the Roborock app feat: add V1 product nicknames for models that fall back to PEARLPLUS Nov 17, 2026

@Lash-L Lash-L left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Automated code review by Gemini 4 Hydrogen in Antigravity using our /review (/code-review) skill (.agents/skills/code-review/SKILL.md / AGENTS.md).

No defects found; the PR is clean and ready to approve.

Summary by Layer

  • Priority 1: Public Trait APIs & Consumer Contracts — RoborockProductNickname (roborock/data/code_mappings.py) and DeviceFeatures / PRODUCT_FEATURE_MAP (roborock/device_features.py) preserve strong typing and RoborockBase inheritance. All new product nicknames (BERYL*, CRAG, CORALPROS, CORALPROSAW, HERA, PANDORA, PEARLCLITE, PEARLEH, PEARLFPRO, QUINN*, R50, TALCSC, VERDELITES, VIDA*, VIVIAN*), their short-model tuples, and the short-model additions to CORALPRO and VIVIANC match the app's model configuration without duplicate short models or regressions to existing nicknames.
  • Priority 2: Data Lifecycle & State Management — DeviceFeatures.from_feature_flags remains a pure value-returning factory. Updating is_support_water_mode and is_customized_clean_supported to include is_roller_mop_supported matches the app's capability gating for roller-mop models (which lack a mop-module product feature), alongside is_clean_route_setting_supported.
  • Priority 3: Wire Protocols & Resilient Enums — HomeDataProduct.product_nickname retains its PEARLPLUS fallback for unrecognized models.
  • Tests & Docs — Colocated unit tests (tests/data/test_code_mappings.py, tests/data/test_containers.py, tests/test_supported_features.py, tests/test_cli.py), per-nickname PRODUCT_FEATURE_MAP snapshots (tests/__snapshots__/test_supported_features.ambr), device_info.yaml, SUPPORTED_FEATURES.md, and docs/V1_DEVICE_FEATURES.md are all consistent. Targeted pytest (226 passed, 78 snapshots passed) and ruff check passed on the PR worktree, and mypy reported zero errors on all modified files.

@Lash-L Lash-L added /review run Code review skill (/review) has been run Passed /review Passed the /review skill check labels Nov 18, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Data model changes Changes to data models, device info, or feature mappings Feature New feature Passed /review Passed the /review skill check /review run Code review skill (/review) has been run V1 V1 platform

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants