roborock.devices.traits.v1.dust_collection_mode

Trait for dust collection mode.

View Source

 1"""Trait for dust collection mode."""
 2
 3from roborock.data import DustCollectionMode
 4from roborock.device_features import is_valid_dock
 5from roborock.devices.traits.v1 import common
 6from roborock.roborock_typing import RoborockCommand
 7
 8
 9class DustCollectionModeTrait(DustCollectionMode, common.V1TraitMixin):
10    """Trait for dust collection mode."""
11
12    command = RoborockCommand.GET_DUST_COLLECTION_MODE
13    converter = common.DefaultConverter(DustCollectionMode)
14    requires_dock_type = is_valid_dock

class DustCollectionModeTrait(roborock.data.v1.v1_containers.DustCollectionMode, roborock.devices.traits.v1.common.V1TraitMixin): View Source

10class DustCollectionModeTrait(DustCollectionMode, common.V1TraitMixin):
11    """Trait for dust collection mode."""
12
13    command = RoborockCommand.GET_DUST_COLLECTION_MODE
14    converter = common.DefaultConverter(DustCollectionMode)
15    requires_dock_type = is_valid_dock

Trait for dust collection mode.

command = <RoborockCommand.GET_DUST_COLLECTION_MODE: 'get_dust_collection_mode'>

The RoborockCommand used to fetch the trait data from the device (internal only).

converter = DefaultConverter

The converter used to parse the response from the device (internal only).

def requires_dock_type( dock_type: roborock.data.v1.v1_code_mappings.RoborockDockTypeCode) -> bool: View Source

665def is_valid_dock(dock_type: RoborockDockTypeCode) -> bool:
666    """Check if device supports a dock."""
667    return dock_type != RoborockDockTypeCode.no_dock

Check if device supports a dock.

Inherited Members

roborock.data.v1.v1_containers.DustCollectionMode: DustCollectionMode; mode
roborock.data.containers.RoborockBase: from_dict; convert_dict; as_dict
roborock.devices.traits.v1.common.V1TraitMixin: rpc_channel; refresh