toio.cube.api.sensor module

class toio.cube.api.sensor.RequestMotionDetection

Bases: CubeCommand

Motion information request command

References

https://toio.github.io/toio-spec/en/docs/ble_sensor#requesting-motion-detection-information

__init__()

__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.sensor.PostureDataType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Euler = 1

Quaternions = 2

class toio.cube.api.sensor.RequestPostureAngleDetection(data_type: PostureDataType)

Bases: CubeCommand

Posture angle information request command

References

https://toio.github.io/toio-spec/en/docs/ble_high_precision_tilt_sensor#requesting-posture-angle-detection

__init__(data_type: PostureDataType)

__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.sensor.RequestMagneticSensor

Bases: CubeCommand

Magnetic sensor information request command

References

https://toio.github.io/toio-spec/en/docs/ble_magnetic_sensor#requests-for-magnetic-sensor-information

__init__()

__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.sensor.Posture(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Orientation of the cube.

Reference:

https://toio.github.io/toio-spec/en/docs/ble_sensor/#posture-detection

Unknown = 0

Top = 1

Bottom = 2

Rear = 3

Front = 4

Right = 5

Left = 6

class toio.cube.api.sensor.MotionDetectionData(payload: bytearray)

Bases: CubeResponse

Information on the cube’s motion detection.

horizontal

Horizontal detection

Type:

bool

collision

Collision detection

Type:

bool

double_tap

Double-tap detection

Type:

bool

posture

Posture detection

Type:

Posture

shake

Shake detection (0:no shake, 1:Level1 - 10:Level10)

Type:

int

Reference:

https://toio.github.io/toio-spec/en/docs/ble_sensor/#obtaining-motion-detection-information

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).

class toio.cube.api.sensor.PostureAngleEulerData(payload: bytearray)

Bases: CubeResponse

Information of posture angle (Euler angle)

roll

Roll (X axis)

Type:

int

pitch

Pitch (Y axis)

Type:

int

yaw

Yaw (Z axis)

Type:

nt

References

https://toio.github.io/toio-spec/en/docs/ble_high_precision_tilt_sensor#obtaining-posture-angle-information-notifications-in-euler-angles

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).

class toio.cube.api.sensor.PostureAngleQuaternionsData(payload: bytearray)

Bases: CubeResponse

PostureAngleQuaternionData

Information of posture angle (Quaternion)

w

Type:

int

x

Type:

int

y

Type:

int

z

Type:

int

References

https://toio.github.io/toio-spec/en/docs/ble_high_precision_tilt_sensor#obtaining-posture-angle-information-notifications-in-quaternions

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).

class toio.cube.api.sensor.MagneticSensorData(payload: bytearray)

Bases: CubeResponse

Information of magnetic sensor

state

Magnet state

Type:

int

strength

Magnetic force strength

Type:

int

x

Magnetic force direction (X axis)

Type:

int

y

Magnetic force direction (Y axis)

Type:

int

z

Magnetic force direction (Z axis)

Type:

int

References

https://toio.github.io/toio-spec/en/docs/ble_magnetic_sensor/#obtaining-magnetic-sensor-information-

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)

toio.cube.api.sensor.SensorResponseType

Response types of Sensor characteristic

alias of Union[MotionDetectionData, PostureAngleEulerData, PostureAngleQuaternionsData, MagneticSensorData]

class toio.cube.api.sensor.Sensor(interface: CubeInterface)

Bases: CubeCharacteristic

Sensor information characteristic

References

Motion detection

Posture angle detection

Magnetic sensor

static is_my_data(payload: bytearray) → MotionDetectionData | PostureAngleEulerData | PostureAngleQuaternionsData | MagneticSensorData | 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)

async read() → MotionDetectionData | PostureAngleEulerData | PostureAngleQuaternionsData | MagneticSensorData | None

Read sensor information response

Returns:

One of SensorInformationData or None (None returns when read fails)

async request_motion_information() → None

Send motion information request command

async request_posture_angle_information(data_type: PostureDataType) → None

Send posture angle information request command

async request_magnetic_sensor_information() → None

Send magnetic sensor information request