toio.cube.api.base_class module

class toio.cube.api.base_class.CubeCommand

Bases: object

abstract __bytes__() → bytes

Returns the byte representation of this class to be sent to cube.

Returns:

byte representation of this class to be sent to cube.

Return type:

bytes

class toio.cube.api.base_class.CubeResponse

Bases: object

abstract static is_myself(data: bytearray) → bool

If argument data is a byte representation of this class, this function converts the byte representation to an object and returns it.

Parameters:

data (GattReadData) – received data from the cube.

class toio.cube.api.base_class.CubeCharacteristic(interface: CubeInterface, uuid: UUID)

Bases: object

abstract static is_my_data(payload: bytearray) → CubeResponse | None

If payload is my characteristic response, this function returns CubeResponse object. Otherwise, it returns None.

Parameters:

payload (GattReadData) – received data from the cube.

__init__(interface: CubeInterface, uuid: UUID)

async register_notification_handler(handler: Callable[[bytearray], None | Awaitable[None]]) → bool

User interface to GATT for registering handler function.

async unregister_notification_handler(handler: Callable[[bytearray], None | Awaitable[None]] | None) → bool

User interface to GATT for unregistering handler function.