toio.cube.api.button module

class toio.cube.api.button.ButtonState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Value of the state of cube button

RELEASED = 0

PRESSED = 128

class toio.cube.api.button.ButtonInformation(payload: bytearray)

Bases: CubeResponse

Cube button state response

state

State of the cube button

Type:

ButtonState

References

https://toio.github.io/toio-spec/en/docs/ble_button#read-operations

static is_myself(payload: 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.

__init__(payload: bytearray)

__str__() → str

Return str(self).

toio.cube.api.button.ButtonResponseType

Response type of button characteristic

class toio.cube.api.button.Button(interface: CubeInterface, device: Any)

Bases: CubeCharacteristic

Button characteristic

References

https://toio.github.io/toio-spec/en/docs/ble_button

static is_my_data(payload: bytearray) → ButtonInformation | 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, device: Any)

async read() → ButtonInformation | None

Read the state of button

Returns:

ButtonInformation or None (None returns when read fails)

References

https://toio.github.io/toio-spec/en/docs/ble_button#read-operations