feat: add data subpackage (#551)

* feat: add data subpackage

BREAKING CHANGE: you can no longer import .container or .code_mappings, instead import .data

Author: Lash-L

roborock/__init__.py

@@ -3,19 +3,14 @@
 .. include:: ../README.md
 """
 
-from roborock.b01_containers import *
-from roborock.code_mappings import *
-from roborock.containers import *
+from roborock.data import *
 from roborock.exceptions import *
 from roborock.roborock_typing import *
 
 from . import (
-    b01_containers,
-    clean_modes,
     cloud_api,
-    code_mappings,
     const,
-    containers,
+    data,
     exceptions,
     roborock_typing,
     version_1_apis,
@@ -27,13 +22,10 @@
     "web_api",
     "version_1_apis",
     "version_a01_apis",
-    "containers",
-    "b01_containers",
     "const",
     "cloud_api",
-    "clean_modes",
-    "code_mappings",
     "roborock_typing",
     "exceptions",
+    "data",
     # Add new APIs here in the future when they are public e.g. devices/
 ]

roborock/api.py

@@ -8,7 +8,7 @@
 from abc import ABC, abstractmethod
 from typing import Any
 
-from .containers import (
+from .data import (
     DeviceData,
 )
 from .exceptions import (

roborock/broadcast_protocol.py

@@ -19,7 +19,7 @@
 from Crypto.Cipher import AES
 
 from roborock import RoborockException
-from roborock.containers import BroadcastMessage
+from roborock.data import BroadcastMessage
 from roborock.protocol import EncryptionAdapter, Utils, _Parser
 
 _LOGGER = logging.getLogger(__name__)

roborock/cli.py

@@ -42,7 +42,7 @@
 from pyshark.packet.packet import Packet  # type: ignore
 
 from roborock import SHORT_MODEL_TO_ENUM, RoborockCommand
-from roborock.containers import CombinedMapInfo, DeviceData, HomeData, NetworkInfo, RoborockBase, UserData
+from roborock.data import CombinedMapInfo, DeviceData, HomeData, NetworkInfo, RoborockBase, UserData
 from roborock.device_features import DeviceFeatures
 from roborock.devices.cache import Cache, CacheData
 from roborock.devices.device import RoborockDevice

roborock/cloud_api.py

@@ -14,7 +14,7 @@
 from paho.mqtt.reasoncodes import ReasonCode  # type: ignore
 
 from .api import KEEPALIVE, RoborockClient
-from .containers import DeviceData, UserData
+from .data import DeviceData, UserData
 from .exceptions import RoborockException, VacuumError
 from .protocol import (
     Decoder,

roborock/data/__init__.py

@@ -0,0 +1,9 @@
+"""This module is meant to hold dataclasses and codemappings for various devices and protocols."""
+
+from .b01_q7 import *
+from .b01_q10 import *
+from .code_mappings import *
+from .containers import *
+from .dyad import *
+from .v1 import *
+from .zeo import *

roborock/data/b01_q10/__init__.py

@@ -0,0 +1,2 @@
+from .b01_q10_code_mappings import *
+from .b01_q10_containers import *

roborock/data/b01_q10/b01_q10_code_mappings.py

@@ -0,0 +1,213 @@
+from ..code_mappings import RoborockModeEnum
+
+
+class B01_Q10_DP(RoborockModeEnum):
+    CLEAN_TIME = ("dpCleanTime", 6)
+    CLEAN_AREA = ("dpCleanArea", 7)
+    SEEK = ("dpSeek", 11)
+    REMOTE = ("dpRemote", 12)
+    MAP_RESET = ("dpMapReset", 13)
+    REQUEST = ("dpRequest", 16)
+    RESET_SIDE_BRUSH = ("dpResetSideBrush", 18)
+    RESET_MAIN_BRUSH = ("dpResetMainBrush", 20)
+    RESET_FILTER = ("dpResetFilter", 22)
+    RAG_LIFE = ("dpRagLife", 23)
+    RESET_RAG_LIFE = ("dpResetRagLife", 24)
+    NOT_DISTURB = ("dpNotDisturb", 25)
+    VOLUME = ("dpVolume", 26)
+    BEAK_CLEAN = ("dpBeakClean", 27)
+    TOTAL_CLEAN_AREA = ("dpTotalCleanArea", 29)
+    TOTAL_CLEAN_COUNT = ("dpTotalCleanCount", 30)
+    TOTAL_CLEAN_TIME = ("dpTotalCleanTime", 31)
+    TIMER = ("dpTimer", 32)
+    NOT_DISTURB_DATA = ("dpNotDisturbData", 33)
+    DEVICE_INFO = ("dpDeviceInfo", 34)
+    VOICE_PACKAGE = ("dpVoicePackage", 35)
+    VOICE_LANGUAGE = ("dpVoiceLanguage", 36)
+    DUST_SWITCH = ("dpDustSwitch", 37)
+    CUSTOM_MODE = ("dpCustomMode", 39)
+    MOP_STATE = ("dpMopState", 40)
+    UNIT = ("dpUnit", 42)
+    CARPET_CLEAN_PREFER = ("dpCarpetCleanPrefer", 44)
+    AUTO_BOOST = ("dpAutoBoost", 45)
+    CHILD_LOCK = ("dpChildLock", 47)
+    DUST_SETTING = ("dpDustSetting", 50)
+    MAP_SAVE_SWITCH = ("dpMapSaveSwitch", 51)
+    CLEAN_RECORD = ("dpCleanRecord", 52)
+    RECEND_CLEAN_RECORD = ("dpRecendCleanRecord", 53)
+    RESTRICTED_ZONE = ("dpRestrictedZone", 54)
+    RESTRICTED_ZONE_UP = ("dpRestrictedZoneUp", 55)
+    VIRTUAL_WALL = ("dpVirtualWall", 56)
+    VIRTUAL_WALL_UP = ("dpVirtualWallUp", 57)
+    ZONED = ("dpZoned", 58)
+    ZONED_UP = ("dpZonedUp", 59)
+    MULTI_MAP_SWITCH = ("dpMultiMapSwitch", 60)
+    MULTI_MAP = ("dpMultiMap", 61)
+    CUSTOMER_CLEAN = ("dpCustomerClean", 62)
+    CUSTOMER_CLEAN_REQUEST = ("dpCustomerCleanRequest", 63)
+    GET_CARPET = ("dpGetCarpet", 64)
+    CARPET_UP = ("dpCarpetUp", 65)
+    SELF_IDENTIFYING_CARPET = ("dpSelfIdentifyingCarpet", 66)
+    SENSOR_LIFE = ("dpSensorLife", 67)
+    RESET_SENSOR = ("dpResetSensor", 68)
+    REQUEST_TIMER = ("dpRequestTimer", 69)
+    REMOVE_ZONED = ("dpRemoveZoned", 70)
+    REMOVE_ZONED_UP = ("dpRemoveZonedUp", 71)
+    ROOM_MERGE = ("dpRoomMerge", 72)
+    ROOM_SPLIT = ("dpRoomSplit", 73)
+    RESET_ROOM_NAME = ("dpResetRoomName", 74)
+    REQUSET_NOT_DISTURB_DATA = ("dpRequsetNotDisturbData", 75)
+    CARPET_CLEAN_TYPE = ("dpCarpetCleanType", 76)
+    BUTTON_LIGHT_SWITCH = ("dpButtonLightSwitch", 77)
+    CLEAN_LINE = ("dpCleanLine", 78)
+    TIME_ZONE = ("dpTimeZone", 79)
+    AREA_UNIT = ("dpAreaUnit", 80)
+    NET_INFO = ("dpNetInfo", 81)
+    CLEAN_ORDER = ("dpCleanOrder", 82)
+    ROBOT_TYPE = ("dpRobotType", 83)
+    LOG_SWITCH = ("dpLogSwitch", 84)
+    FLOOR_MATERIAL = ("dpFloorMaterial", 85)
+    LINE_LASER_OBSTACLE_AVOIDANCE = ("dpLineLaserObstacleAvoidance", 86)
+    CLEAN_PROGESS = ("dpCleanProgess", 87)
+    GROUND_CLEAN = ("dpGroundClean", 88)
+    IGNORE_OBSTACLE = ("dpIgnoreObstacle", 89)
+    FAULT = ("dpFault", 90)
+    CLEAN_EXPAND = ("dpCleanExpand", 91)
+    NOT_DISTURB_EXPAND = ("dpNotDisturbExpand", 92)
+    TIMER_TYPE = ("dpTimerType", 93)
+    CREATE_MAP_FINISHED = ("dpCreateMapFinished", 94)
+    ADD_CLEAN_AREA = ("dpAddCleanArea", 95)
+    ADD_CLEAN_STATE = ("dpAddCleanState", 96)
+    RESTRICTED_AREA = ("dpRestrictedArea", 97)
+    RESTRICTED_AREA_UP = ("dpRestrictedAreaUp", 98)
+    SUSPECTED_THRESHOLD = ("dpSuspectedThreshold", 99)
+    SUSPECTED_THRESHOLD_UP = ("dpSuspectedThresholdUp", 100)
+    COMMON = ("dpCommon", 101)
+    JUMP_SCAN = ("dpJumpScan", 101)
+    REQUETDPS = ("dpRequetdps", 102)  # NOTE: THIS TYPO IS FOUND IN SOURCE CODE
+    CLIFF_RESTRICTED_AREA = ("dpCliffRestrictedArea", 102)
+    CLIFF_RESTRICTED_AREA_UP = ("dpCliffRestrictedAreaUp", 103)
+    BREAKPOINT_CLEAN = ("dpBreakpointClean", 104)
+    VALLEY_POINT_CHARGING = ("dpValleyPointCharging", 105)
+    VALLEY_POINT_CHARGING_DATA_UP = ("dpValleyPointChargingDataUp", 106)
+    VALLEY_POINT_CHARGING_DATA = ("dpValleyPointChargingData", 107)
+    VOICE_VERSION = ("dpVoiceVersion", 108)
+    ROBOT_COUNTRY_CODE = ("dpRobotCountryCode", 109)
+    HEARTBEAT = ("dpHeartbeat", 110)
+    STATUS = ("dpStatus", 121)
+    BATTERY = ("dpBattery", 122)
+    FUN_LEVEL = ("dpfunLevel", 123)
+    WATER_LEVEL = ("dpWaterLevel", 124)
+    MAIN_BRUSH_LIFE = ("dpMainBrushLife", 125)
+    SIDE_BRUSH_LIFE = ("dpSideBrushLife", 126)
+    FILTER_LIFE = ("dpFilterLife", 127)
+    TASK_CANCEL_IN_MOTION = ("dpTaskCancelInMotion", 132)
+    OFFLINE = ("dpOffline", 135)
+    CLEAN_COUNT = ("dpCleanCount", 136)
+    CLEAN_MODE = ("dpCleanMode", 137)
+    CLEAN_TASK_TYPE = ("dpCleanTaskType", 138)
+    BACK_TYPE = ("dpBackType", 139)
+    CLEANING_PROGRESS = ("dpCleaningProgress", 141)
+    FLEEING_GOODS = ("dpFleeingGoods", 142)
+    START_CLEAN = ("dpStartClean", 201)
+    START_BACK = ("dpStartBack", 202)
+    START_DOCK_TASK = ("dpStartDockTask", 203)
+    PAUSE = ("dpPause", 204)
+    RESUME = ("dpResume", 205)
+    STOP = ("dpStop", 206)
+    USER_PLAN = ("dpUserPlan", 207)
+
+
+class YXFanLevel(RoborockModeEnum):
+    UNKNOWN = "unknown", -1
+    CLOSE = "close", 0
+    QUITE = "quite", 1
+    NORMAL = "normal", 2
+    STRONG = "strong", 3
+    MAX = "max", 4
+    SUPER = "super", 5
+
+
+class YXWaterLevel(RoborockModeEnum):
+    UNKNOWN = "unknown", -1
+    CLOSE = "close", 0
+    LOW = "low", 1
+    MIDDLE = "middle", 2
+    HIGH = "high", 3
+
+
+class YXCleanLine(RoborockModeEnum):
+    FAST = "fast", 0
+    DAILY = "daily", 1
+    FINE = "fine", 2
+
+
+class YXRoomMaterial(RoborockModeEnum):
+    HORIZONTAL_FLOOR_BOARD = "horizontalfloorboard", 0
+    VERTICAL_FLOOR_BOARD = "verticalfloorboard", 1
+    CERAMIC_TILE = "ceramictile", 2
+    OTHER = "other", 255
+
+
+class YXCleanType(RoborockModeEnum):
+    UNKNOWN = "unknown", -1
+    BOTH_WORK = "bothwork", 1
+    ONLY_SWEEP = "onlysweep", 2
+    ONLY_MOP = "onlymop", 3
+
+
+class YXDeviceState(RoborockModeEnum):
+    UNKNOWN = "unknown", -1
+    SLEEP_STATE = "sleepstate", 2
+    STANDBY_STATE = "standbystate", 3
+    CLEANING_STATE = "cleaningstate", 5
+    TO_CHARGE_STATE = "tochargestate", 6
+    REMOTEING_STATE = "remoteingstate", 7
+    CHARGING_STATE = "chargingstate", 8
+    PAUSE_STATE = "pausestate", 10
+    FAULT_STATE = "faultstate", 12
+    UPGRADE_STATE = "upgradestate", 14
+    DUSTING = "dusting", 22
+    CREATING_MAP_STATE = "creatingmapstate", 29
+    MAP_SAVE_STATE = "mapsavestate", 99
+    RE_LOCATION_STATE = "relocationstate", 101
+    ROBOT_SWEEPING = "robotsweeping", 102
+    ROBOT_MOPING = "robotmoping", 103
+    ROBOT_SWEEP_AND_MOPING = "robotsweepandmoping", 104
+    ROBOT_TRANSITIONING = "robottransitioning", 105
+    ROBOT_WAIT_CHARGE = "robotwaitcharge", 108
+
+
+class YXBackType(RoborockModeEnum):
+    UNKNOWN = "unknown", -1
+    IDLE = "idle", 0
+    BACK_DUSTING = "backdusting", 4
+    BACK_CHARGING = "backcharging", 5
+
+
+class YXDeviceWorkMode(RoborockModeEnum):
+    UNKNOWN = "unknown", -1
+    BOTH_WORK = "bothwork", 1
+    ONLY_SWEEP = "onlysweep", 2
+    ONLY_MOP = "onlymop", 3
+    CUSTOMIZED = "customized", 4
+    SAVE_WORRY = "saveworry", 5
+    SWEEP_MOP = "sweepmop", 6
+
+
+class YXDeviceCleanTask(RoborockModeEnum):
+    UNKNOWN = "unknown", -1
+    IDLE = "idle", 0
+    SMART = "smart", 1
+    ELECTORAL = "electoral", 2
+    DIVIDE_AREAS = "divideareas", 3
+    CREATING_MAP = "creatingmap", 4
+    PART = "part", 5
+
+
+class YXDeviceDustCollectionFrequency(RoborockModeEnum):
+    DAILY = "daily", 0
+    INTERVAL_15 = "interval_15", 15
+    INTERVAL_30 = "interval_30", 30
+    INTERVAL_45 = "interval_45", 45
+    INTERVAL_60 = "interval_60", 60

roborock/data/b01_q10/b01_q10_containers.py

@@ -0,0 +1,53 @@
+from ..containers import RoborockBase
+
+
+class dpCleanRecord(RoborockBase):
+    op: str
+    result: int
+    id: str
+    data: list
+
+
+class dpMultiMap(RoborockBase):
+    op: str
+    result: int
+    data: list
+
+
+class dpGetCarpet(RoborockBase):
+    op: str
+    result: int
+    data: str
+
+
+class dpSelfIdentifyingCarpet(RoborockBase):
+    op: str
+    result: int
+    data: str
+
+
+class dpNetInfo(RoborockBase):
+    wifiName: str
+    ipAdress: str
+    mac: str
+    signal: int
+
+
+class dpNotDisturbExpand(RoborockBase):
+    disturb_dust_enable: int
+    disturb_light: int
+    disturb_resume_clean: int
+    disturb_voice: int
+
+
+class dpCurrentCleanRoomIds(RoborockBase):
+    room_id_list: list
+
+
+class dpVoiceVersion(RoborockBase):
+    version: int
+
+
+class dpTimeZone(RoborockBase):
+    timeZoneCity: str
+    timeZoneSec: int

roborock/data/b01_q7/__init__.py

@@ -0,0 +1,2 @@
+from .b01_q7_code_mappings import *
+from .b01_q7_containers import *