toio.cube package

class toio.cube.ToioCoreCube(interface: CubeInterface, name: str | None = None)

Bases: CubeInterface

Access to toio Core Cube

interface

control interface (e.g. BleCube)

Type:

CubeInterface

name

cube name (optional)

Type:

str

api

API class

Type:

ToioCoreCubeLowLevelAPI

__init__(interface: CubeInterface, name: str | None = None)

async connect() → bool

async disconnect() → bool

async read(uuid: UUID) → bytearray

async write(uuid: UUID, data: bytes | bytearray | memoryview, response: bool = False)

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

async unregister_notification_handler(uuid: UUID) → bool

class toio.cube.ToioCoreCubeLowLevelAPI(interface: CubeInterface)

Bases: object

Control APIs This class has control APIs for each characteristic.

version

Version of supported API

Type:

str

battery

Interface to battery characteristic

Type:

api.Battery

button

Interface to button characteristic

Type:

api.Button

configuration

Interface to configuration characteristic

Type:

api.Configuration

id_information

Interface to id information characteristic

Type:

api.IdInformation

indicator

Interface to indicator characteristic

Type:

api.IdInformation

motor

Interface to motor characteristic

Type:

api.Motor

sensor

Interface to sensor characteristic ( Motion Posture Magnet )

Type:

api.Sensor

sound

Interface to sound characteristic

Type:

api.Sound

__init__(interface: CubeInterface)

toio.cube.BatteryResponseType

alias of BatteryInformation

class toio.cube.BatteryInformation(payload: bytearray)

Bases: CubeResponse

Cube remaining battery level response

battery_level

Battery level ( 0 <= battery_level <= 100)

Type:

int

References

https://toio.github.io/toio-spec/en/docs/ble_battery#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).

class toio.cube.Battery(interface)

Bases: CubeCharacteristic

Battery characteristic

References

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

static is_my_data(payload: bytearray) → BatteryInformation | 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)

async read() → BatteryInformation | None

Read the battery level

Returns:

BatteryInformation or None (None returns when read fails)

References

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

toio.cube.ButtonResponseType

alias of ButtonInformation

class toio.cube.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.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).

class toio.cube.Button(interface: CubeInterface)

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)

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

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

Bases: IntEnum

Notification conditions of ID notification

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#notification-conditions

Always = 0

ChangeDetection = 1

Periodic = 255

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

Bases: IntEnum

Disable = 0

MagnetState = 1

MagneticForce = 2

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

Bases: IntEnum

Always = 0

ChangeDetection = 1

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

Bases: IntEnum

Disable = 0

Enable = 1

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

Bases: IntEnum

Euler = 1

Quaternions = 2

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

Bases: IntEnum

Notification condition of posture angle detection

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#notification-conditions-1

Always = 0

ChangeDetection = 1

class toio.cube.ProtocolVersion(payload: bytearray)

Bases: CubeResponse

Protocol version response

version

version (UTF-8)

Type:

str

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#obtaining-the-ble-protocol-version

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.ResponseIdNotificationSettings(payload: bytearray)

Bases: CubeResponse

ID notification setting response

result

Result of the command

Type:

bool

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#responses-to-identification-sensor-id-notification-settings

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.ResponseIdMissedNotificationSettings(payload: bytearray)

Bases: CubeResponse

ID missed notification setting response

result

Result of the command

Type:

bool

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#responses-to-identification-sensor-id-missed-notification-settings

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.ResponseMagneticSensorSettings(payload: bytearray)

Bases: CubeResponse

Magnetic sensor setting response

result

Result of the command

Type:

bool

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#responses-to-magnetic-sensor-settings

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.ResponseMotorSpeedInformationAcquisitionSettings(payload: bytearray)

Bases: CubeResponse

Motor speed information setting response

result

Result of the command

Type:

bool

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#responses-to-motor-speed-information-acquisition-settings

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.ResponsePostureAngleDetectionSettings(payload: bytearray)

Bases: CubeResponse

Posture angle detection setting response

result

Result of the command

Type:

bool

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#responses-to-posture-angle-detection-settings-

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.Configuration(interface: CubeInterface)

Bases: CubeCharacteristic

Configuration characteristic

References

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

static is_my_data(payload: bytearray) → ProtocolVersion | ResponseIdNotificationSettings | ResponseIdMissedNotificationSettings | ResponseMagneticSensorSettings | ResponseMotorSpeedInformationAcquisitionSettings | ResponsePostureAngleDetectionSettings | 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) → None

async request_protocol_version() → None

Send protocol version request command

This function DO NOT return response payload. Receive the result by notification.

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#requesting-the-ble-protocol-version

async set_horizontal_detection_threshold(threshold: int) → None

Send horizontal detection threshold setting command

This function DO NOT return response payload. Receive the result by notification.

Parameters:

threshold (int) – Threshold

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#horizontal-detection-threshold-settings

async set_collision_detection_threshold(threshold: int) → None

Send collision detection threshold setting request command

This function DO NOT return response payload. Receive the result by notification.

Parameters:

threshold (int) – Threshold

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#collision-detection-threshold-settings

async set_double_tap_detection_threshold(threshold: int) → None

Send double-tap detection threshold setting request command

This function DO NOT return response payload. Receive the result by notification.

Parameters:

threshold (int) – Threshold

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#double-tap-detection-time-interval-settings

async set_id_notification(interval_ms: int, condition: NotificationCondition) → None

Send id information notification setting request command

This function DO NOT return response payload. Receive the result by notification.

Parameters:

• interval_ms (int) – Notification interval [ms]

• condition (NotificationCondition) – Condition

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#identification-sensor-id-notification-settings

async set_id_missed_notification(sensitivity_ms: int) → None

Send ID missed notification setting request command

This function DO NOT return response payload. Receive the result by notification.

Parameters:

sensitivity_ms (int) – Sensitivity [ms]

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#identification-sensor-id-missed-notification-settings

async set_magnetic_sensor(function_type: MagneticSensorFunction, interval_ms: int, condition: MagneticSensorCondition) → None

Send magnetic sensor setting request command

This function DO NOT return response payload. Receive the result by notification.

Parameters:

• function_type (MagneticSensorFunction) – Function type

• interval_ms (int) – Notification interval [ms]

• condition (MagneticSensorCondition) – Condition

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#magnetic-sensor-settings-

async set_motor_speed_information_acquisition(state: MotorSpeedInformationAcquisitionState) → None

Send motor speed information acquisition setting request command

This function DO NOT return response payload. Receive the result by notification.

Parameters:

state (MotorSpeedInformationAcquisitionState) – state

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#motor-speed-information-acquisition-settings

async set_posture_angle_detection(detection_type: PostureAngleDetectionType, interval_ms: int, condition: PostureAngleDetectionCondition) → None

Send posture angle setting request command

This function DO NOT return response payload. Receive the result by notification.

Parameters:

• detection_type (PostureAngleDetectionType) – Detection type

• interval_ms (int) – Notification interval [ms]

• condition (PostureAngleDetectionCondition) – Condition

References

https://toio.github.io/toio-spec/en/docs/ble_configuration#posture-angle-detection-settings-

class toio.cube.PositionId(payload: bytearray)

Bases: CubeResponse

Position id information response

References

https://toio.github.io/toio-spec/en/docs/ble_id#position-id

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.StandardId(payload: bytearray)

Bases: CubeResponse

Standard id information response

References

https://toio.github.io/toio-spec/en/docs/ble_id#standard-id

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.

__init__(payload: bytearray)

__str__() → str

Return str(self).

class toio.cube.PositionIdMissed(payload: bytearray)

Bases: CubeResponse

Position id missed response

References

https://toio.github.io/toio-spec/en/docs/ble_id#position-id-missed

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.

__init__(payload: bytearray)

__str__() → str

Return str(self).

class toio.cube.StandardIdMissed(payload: bytearray)

Bases: CubeResponse

Standard id information response

References

https://toio.github.io/toio-spec/en/docs/ble_id#standard-id-missed

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.

__init__(payload: bytearray)

__str__() → str

Return str(self).

class toio.cube.IdInformation(interface: CubeInterface)

Bases: CubeCharacteristic

ID sensor characteristic

References

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

static is_my_data(payload: bytearray) → PositionId | StandardId | PositionIdMissed | StandardIdMissed | 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() → PositionId | StandardId | PositionIdMissed | StandardIdMissed | None

Read id information response

Returns:

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

class toio.cube.Color(r: int, g: int, b: int)

Bases: object

Indicator color in RGB

r: int

R value (0 - 255)

g: int

G value (0 - 255)

b: int

B value (0 - 255)

flatten()

Return the tuple representation of this dataclass

__init__(r: int, g: int, b: int) → None

class toio.cube.IndicatorParam(duration_ms: int, color: Color)

Bases: object

Indicator color and lighting period

duration_ms: int

Duration of lighting:

Any fraction less than 10ms will be truncated.

0 - 9: no time limit

10 - 2550: duration [ms]

color: Color

RGB value

flatten()

__init__(duration_ms: int, color: Color) → None

class toio.cube.Indicator(interface: CubeInterface)

Bases: CubeCharacteristic

Indicator characteristic

References

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

static is_my_data(_payload: bytearray) → 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 turn_on(param: IndicatorParam) → None

Send indicator turn on / off command

Parameters:

param – Indicator parameter

References

https://toio.github.io/toio-spec/en/docs/ble_light#repeated-turning-on-and-off-of-indicator

async repeated_turn_on(repeat: int, param_list: list[toio.cube.api.indicator.IndicatorParam] | tuple[toio.cube.api.indicator.IndicatorParam, ...]) → None

Send repeated indicator turning on / off command

Parameters:

• repeat (int) – Number of repetitions

• param_list (Union[list[IndicatorParam], tuple[IndicatorParam]]) – List of indicator parameters

References

https://toio.github.io/toio-spec/en/docs/ble_light#repeated-turning-on-and-off-of-indicator

async turn_off_all() → None

Send all off command

References

https://toio.github.io/toio-spec/en/docs/ble_light#turn-off-all-indicators

async turn_off(indicator_id: int) → None

Send off command

Parameters:

indicator_id (int) – Indicator ID

References

https://toio.github.io/toio-spec/en/docs/ble_light#turn-off-a-specific-indicator

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

Bases: IntEnum

Movement type

References

https://toio.github.io/toio-spec/en/docs/ble_motor#movement-type

Curve = 0

CurveWithoutReverse = 1

Linear = 2

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

Bases: IntEnum

Rotation Option

Angle of the cube at the target point

References

https://toio.github.io/toio-spec/en/docs/ble_motor#%CE%B8-angle-of-the-cube-at-the-target-point

AbsoluteOptimal = 0

AbsolutePositive = 1

AbsoluteNegative = 2

RelativePositive = 3

RelativeNegative = 4

WithoutRotation = 5

SameAsAtWriting = 6

class toio.cube.TargetPosition(cube_location: CubeLocation, rotation_option: RotationOption = RotationOption.AbsoluteOptimal)

Bases: object

Target position parameter

cube_location: CubeLocation

Target position of the cube

rotation_option: RotationOption = 0

Rotation option

flatten()

__init__(cube_location: CubeLocation, rotation_option: RotationOption = RotationOption.AbsoluteOptimal) → None

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

Bases: IntEnum

Speed change type

References

https://toio.github.io/toio-spec/en/docs/ble_motor#motor-speed-change-types

Constant = 0

Acceleration = 1

Deceleration = 2

AccelerationAndDeceleration = 3

class toio.cube.Speed(max: int = 0, speed_change_type: SpeedChangeType = SpeedChangeType.Constant)

Bases: object

Speed parameter

max: int = 0

Max speed

speed_change_type: SpeedChangeType = 0

Speed change type

flatten()

__init__(max: int = 0, speed_change_type: SpeedChangeType = SpeedChangeType.Constant) → None

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

Bases: IntEnum

Write mode of MotorControlMultipleTargets()

References

https://toio.github.io/toio-spec/en/docs/ble_motor#additional-write-operation-settings

Overwrite = 0

Append = 1

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

Bases: IntEnum

Rotational direction when the cube is changing orientation

References

https://toio.github.io/toio-spec/en/docs/ble_motor/#rotational-direction-when-cube-changes-orientation

Positive = 0

Negative = 1

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

Bases: IntEnum

Direction of cube travel

References

https://toio.github.io/toio-spec/en/docs/ble_motor/#direction-of-cube-travel

Forward = 0

Backward = 1

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

Bases: IntEnum

Priority to the translational speed or the rotational velocity

References

https://toio.github.io/toio-spec/en/docs/ble_motor/#priority-designation

TranslationalVelocity = 0

RotationalVelocity = 1

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

Bases: Enum

Response code of motor control APIs

References

https://toio.github.io/toio-spec/en/docs/ble_motor#response-content

SUCCESS = 0

ERROR_TIMEOUT = 1

ERROR_ID_MISSED = 2

ERROR_INVALID_PARAMETER = 3

ERROR_INVALID_CUBE_STATE = 4

SUCCESS_WITH_OVERWRITE = 5

ERROR_NOT_SUPPORTED = 6

ERROR_FAILED_TO_APPEND = 7

class toio.cube.ResponseMotorControlTarget(payload: bytearray)

Bases: CubeResponse

Target specified motor control response

response_code

Response code

Type:

MotorResponseCode

References

https://toio.github.io/toio-spec/en/docs/ble_motor#responses-to-motor-control-with-target-specified

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.ResponseMotorControlMultipleTargets(payload: bytearray)

Bases: CubeResponse

Multiple target specified motor control response

response_code

Response code

Type:

MotorResponseCode

References

https://toio.github.io/toio-spec/en/docs/ble_motor#responses-to-motor-control-with-multiple-targets-specified

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.ResponseMotorSpeed(payload: bytearray)

Bases: CubeResponse

Motor speed response

left

motor speed (left)

Type:

int

right

motor speed (right)

Type:

int

References

https://toio.github.io/toio-spec/en/docs/ble_motor#obtaining-motor-speed-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.Motor(interface: CubeInterface)

Bases: CubeCharacteristic

Motor characteristic

References

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

static is_my_data(payload: bytearray) → ResponseMotorControlTarget | ResponseMotorControlMultipleTargets | ResponseMotorSpeed | 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 motor_control(left: int, right: int, duration_ms: int | None = None) → None

Send motor control command

Parameters:

• left (int) – Motor speed (left)

• right (int) – Motor speed (right)

• duration_ms (Optional[int], optional) – Motor driving period [ms]. Defaults to None.

References

https://toio.github.io/toio-spec/en/docs/ble_motor#motor-control

async motor_control_target(timeout: int, movement_type: MovementType, speed: Speed, target: TargetPosition) → None

Send target specified motor control command

Parameters:

• timeout (int) – Timeout [s] (Note: not [ms])

• movement_type (MovementType) – Movement type

• speed (Speed) – Speed parameter

• target (TargetPosition) – Target parameter

References

https://toio.github.io/toio-spec/en/docs/ble_motor#motor-control-with-target-specified

async motor_control_multiple_targets(timeout: int, movement_type: MovementType, speed: Speed, mode: WriteMode, target_list: list[toio.cube.api.motor.TargetPosition]) → None

Send multiple target specified motor control command

Parameters:

• timeout (int) – Timeout [s] (Note: not [ms])

• movement_type (MovementType) – Movement type

• speed (Speed) – Speed parameter

• mode (WriteMode) – Write mode

• target_list (list[TargetPosition]) – Target parameter

References

https://toio.github.io/toio-spec/en/docs/ble_motor#motor-control-with-multiple-targets-specified

async motor_control_acceleration(translation: int, acceleration: int, rotation_velocity: int, rotation_direction: AccelerationRotation, cube_direction: AccelerationDirection, priority: AccelerationPriority, duration_ms: int) → None

Send acceleration specified motor control command

Parameters:

• translation (int) – Speed at which the cube moves in relation to the direction of travel.

• acceleration (int) – Specify the increment (or decrement) in speed every 100 milliseconds.

• rotation_velocity (int) – Rotational velocity when the cube is changing orientation.

• rotation_direction (AccelerationRotation) – Rotational direction when the cube is changing orientation.

• cube_direction (AccelerationDirection) – Direction the cube travels.

• priority (AccelerationPriority) – Priority to the translational speed or the rotational velocity.

• duration_ms (int) – Motor driving period [ms].

References

https://toio.github.io/toio-spec/en/docs/ble_motor/#motor-control-with-acceleration-specified

class toio.cube.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.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.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.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.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.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)

class toio.cube.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

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

Bases: IntEnum

Sound effect ID

References

https://toio.github.io/toio-spec/en/docs/ble_sound#sound-effect-id

Enter = 0

Selected = 1

Cancel = 2

Cursor = 3

MatIn = 4

MatOut = 5

Get1 = 6

Get2 = 7

Get3 = 8

Effect1 = 9

Effect2 = 10

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

Bases: IntEnum

Midi notes

References

https://toio.github.io/toio-spec/en/docs/ble_sound#midi-note-number-and-note-name

C0 = 0

CS0 = 1

D0 = 2

DS0 = 3

E0 = 4

F0 = 5

FS0 = 6

G0 = 7

GS0 = 8

A0 = 9

AS0 = 10

B0 = 11

C1 = 12

CS1 = 13

D1 = 14

DS1 = 15

E1 = 16

F1 = 17

FS1 = 18

G1 = 19

GS1 = 20

A1 = 21

AS1 = 22

B1 = 23

C2 = 24

CS2 = 25

D2 = 26

DS2 = 27

E2 = 28

F2 = 29

FS2 = 30

G2 = 31

GS2 = 32

A2 = 33

AS2 = 34

B2 = 35

C3 = 36

CS3 = 37

D3 = 38

DS3 = 39

E3 = 40

F3 = 41

FS3 = 42

G3 = 43

GS3 = 44

A3 = 45

AS3 = 46

B3 = 47

C4 = 48

CS4 = 49

D4 = 50

DS4 = 51

E4 = 52

F4 = 53

FS4 = 54

G4 = 55

GS4 = 56

A4 = 57

AS4 = 58

B4 = 59

C5 = 60

CS5 = 61

D5 = 62

DS5 = 63

E5 = 64

F5 = 65

FS5 = 66

G5 = 67

GS5 = 68

A5 = 69

AS5 = 70

B5 = 71

C6 = 72

CS6 = 73

D6 = 74

DS6 = 75

E6 = 76

F6 = 77

FS6 = 78

G6 = 79

GS6 = 80

A6 = 81

AS6 = 82

B6 = 83

C7 = 84

CS7 = 85

D7 = 86

DS7 = 87

E7 = 88

F7 = 89

FS7 = 90

G7 = 91

GS7 = 92

A7 = 93

AS7 = 94

B7 = 95

C8 = 96

CS8 = 97

D8 = 98

DS8 = 99

E8 = 100

F8 = 101

FS8 = 102

G8 = 103

GS8 = 104

A8 = 105

AS8 = 106

B8 = 107

C9 = 108

CS9 = 109

D9 = 110

DS9 = 111

E9 = 112

F9 = 113

FS9 = 114

G9 = 115

GS9 = 116

A9 = 117

AS9 = 118

B9 = 119

C10 = 120

CS10 = 121

D10 = 122

DS10 = 123

E10 = 124

F10 = 125

FS10 = 126

G10 = 127

NO_SOUND = 128

class toio.cube.MidiNote(duration_ms: int, note: Note, volume: int)

Bases: object

Midi note

duration_ms: int

Duration of sounding note:

Any fraction less than 10ms will be truncated.

0 - 9: zero

10 - 2550: duration [ms]

note: Note

Midi note

volume: int

Volume:

0: off

1 - 255: max volume

flatten()

__init__(duration_ms: int, note: Note, volume: int) → None

class toio.cube.Sound(interface: CubeInterface)

Bases: CubeCharacteristic

Sound characteristic

References

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

static is_my_data(_payload: bytearray) → 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 play_sound_effect(sound_id: SoundId, volume: int)

Send play sound effect command

Parameters:

• sound_id (SoundId) – Sound ID

• volume (int) – Volume

async play_midi(repeat: int, midi_notes: list[toio.cube.api.sound.MidiNote] | tuple[toio.cube.api.sound.MidiNote, ...])

Send play midi note command

Parameters:

• repeat (int) – Number of repetitions (0: Infinite)

• midi_notes (Union[list[MidiNote], tuple[MidiNote, ...]]) – List of midi notes

async stop()

Send sound stop command

Subpackages

• toio.cube.api package
  • Submodules
    • toio.cube.api.base_class module
      • CubeCommand
        • CubeCommand.__bytes__()
      • CubeResponse
        • CubeResponse.is_myself()
      • CubeCharacteristic
        • CubeCharacteristic.is_my_data()
        • CubeCharacteristic.__init__()
        • CubeCharacteristic.register_notification_handler()
        • CubeCharacteristic.unregister_notification_handler()
    • toio.cube.api.battery module
      • BatteryInformation
        • BatteryInformation.battery_level
        • BatteryInformation.is_myself()
        • BatteryInformation.__init__()
        • BatteryInformation.__str__()
      • BatteryResponseType
      • Battery
        • Battery.is_my_data()
        • Battery.__init__()
        • Battery.read()
    • toio.cube.api.button module
      • ButtonState
        • ButtonState.RELEASED
        • ButtonState.PRESSED
      • ButtonInformation
        • ButtonInformation.state
        • ButtonInformation.is_myself()
        • ButtonInformation.__init__()
        • ButtonInformation.__str__()
      • ButtonResponseType
      • Button
        • Button.is_my_data()
        • Button.__init__()
        • Button.read()
    • toio.cube.api.configuration module
      • RequestProtocolVersion
        • RequestProtocolVersion.__init__()
        • RequestProtocolVersion.__bytes__()
      • SetHorizontalDetectionThreshold
        • SetHorizontalDetectionThreshold.__init__()
        • SetHorizontalDetectionThreshold.__bytes__()
      • SetCollisionDetectionThreshold
        • SetCollisionDetectionThreshold.__init__()
        • SetCollisionDetectionThreshold.__bytes__()
      • SetDoubleTapDetectionTimeInterval
        • SetDoubleTapDetectionTimeInterval.__init__()
        • SetDoubleTapDetectionTimeInterval.__bytes__()
      • NotificationCondition
        • NotificationCondition.Always
        • NotificationCondition.ChangeDetection
        • NotificationCondition.Periodic
      • SetIdNotification
        • SetIdNotification.__init__()
        • SetIdNotification.__bytes__()
      • SetIdMissedNotification
        • SetIdMissedNotification.__init__()
        • SetIdMissedNotification.__bytes__()
      • MagneticSensorFunction
        • MagneticSensorFunction.Disable
        • MagneticSensorFunction.MagnetState
        • MagneticSensorFunction.MagneticForce
      • MagneticSensorCondition
        • MagneticSensorCondition.Always
        • MagneticSensorCondition.ChangeDetection
      • SetMagneticSensor
        • SetMagneticSensor.__init__()
        • SetMagneticSensor.__bytes__()
      • MotorSpeedInformationAcquisitionState
        • MotorSpeedInformationAcquisitionState.Disable
        • MotorSpeedInformationAcquisitionState.Enable
      • SetMotorSpeedInformationAcquisition
        • SetMotorSpeedInformationAcquisition.__init__()
        • SetMotorSpeedInformationAcquisition.__bytes__()
      • PostureAngleDetectionType
        • PostureAngleDetectionType.Euler
        • PostureAngleDetectionType.Quaternions
      • PostureAngleDetectionCondition
        • PostureAngleDetectionCondition.Always
        • PostureAngleDetectionCondition.ChangeDetection
      • SetPostureAngleDetection
        • SetPostureAngleDetection.__init__()
        • SetPostureAngleDetection.__bytes__()
      • ProtocolVersion
        • ProtocolVersion.version
        • ProtocolVersion.is_myself()
        • ProtocolVersion.__init__()
        • ProtocolVersion.__str__()
      • ResponseIdNotificationSettings
        • ResponseIdNotificationSettings.result
        • ResponseIdNotificationSettings.is_myself()
        • ResponseIdNotificationSettings.__init__()
        • ResponseIdNotificationSettings.__str__()
      • ResponseIdMissedNotificationSettings
        • ResponseIdMissedNotificationSettings.result
        • ResponseIdMissedNotificationSettings.is_myself()
        • ResponseIdMissedNotificationSettings.__init__()
        • ResponseIdMissedNotificationSettings.__str__()
      • ResponseMagneticSensorSettings
        • ResponseMagneticSensorSettings.result
        • ResponseMagneticSensorSettings.is_myself()
        • ResponseMagneticSensorSettings.__init__()
        • ResponseMagneticSensorSettings.__str__()
      • ResponseMotorSpeedInformationAcquisitionSettings
        • ResponseMotorSpeedInformationAcquisitionSettings.result
        • ResponseMotorSpeedInformationAcquisitionSettings.is_myself()
        • ResponseMotorSpeedInformationAcquisitionSettings.__init__()
        • ResponseMotorSpeedInformationAcquisitionSettings.__str__()
      • ResponsePostureAngleDetectionSettings
        • ResponsePostureAngleDetectionSettings.result
        • ResponsePostureAngleDetectionSettings.is_myself()
        • ResponsePostureAngleDetectionSettings.__init__()
        • ResponsePostureAngleDetectionSettings.__str__()
      • ConfigurationResponseType
      • Configuration
        • Configuration.is_my_data()
        • Configuration.__init__()
        • Configuration.request_protocol_version()
        • Configuration.set_horizontal_detection_threshold()
        • Configuration.set_collision_detection_threshold()
        • Configuration.set_double_tap_detection_threshold()
        • Configuration.set_id_notification()
        • Configuration.set_id_missed_notification()
        • Configuration.set_magnetic_sensor()
        • Configuration.set_motor_speed_information_acquisition()
        • Configuration.set_posture_angle_detection()
    • toio.cube.api.id_information module
      • PositionId
        • PositionId.is_myself()
        • PositionId.__init__()
        • PositionId.__str__()
      • StandardId
        • StandardId.is_myself()
        • StandardId.__init__()
        • StandardId.__str__()
      • PositionIdMissed
        • PositionIdMissed.is_myself()
        • PositionIdMissed.__init__()
        • PositionIdMissed.__str__()
      • StandardIdMissed
        • StandardIdMissed.is_myself()
        • StandardIdMissed.__init__()
        • StandardIdMissed.__str__()
      • IdInformationResponseType
      • IdInformation
        • IdInformation.is_my_data()
        • IdInformation.__init__()
        • IdInformation.read()
    • toio.cube.api.indicator module
      • Color
        • Color.r
        • Color.g
        • Color.b
        • Color.flatten()
        • Color.__init__()
      • IndicatorParam
        • IndicatorParam.duration_ms
        • IndicatorParam.color
        • IndicatorParam.flatten()
        • IndicatorParam.__init__()
      • TurningOnAndOff
        • TurningOnAndOff.__init__()
        • TurningOnAndOff.__bytes__()
      • RepeatedTurningOnAndOff
        • RepeatedTurningOnAndOff.REPEAT_INFINITE
        • RepeatedTurningOnAndOff.__init__()
        • RepeatedTurningOnAndOff.__bytes__()
      • TurnOffAll
        • TurnOffAll.__init__()
        • TurnOffAll.__bytes__()
      • TurnOff
        • TurnOff.__init__()
        • TurnOff.__bytes__()
      • Indicator
        • Indicator.is_my_data()
        • Indicator.__init__()
        • Indicator.turn_on()
        • Indicator.repeated_turn_on()
        • Indicator.turn_off_all()
        • Indicator.turn_off()
    • toio.cube.api.motor module
      • MotorControl
        • MotorControl.__init__()
        • MotorControl.speed_to_param()
        • MotorControl.__bytes__()
        • MotorControl.__str__()
      • MovementType
        • MovementType.Curve
        • MovementType.CurveWithoutReverse
        • MovementType.Linear
      • RotationOption
        • RotationOption.AbsoluteOptimal
        • RotationOption.AbsolutePositive
        • RotationOption.AbsoluteNegative
        • RotationOption.RelativePositive
        • RotationOption.RelativeNegative
        • RotationOption.WithoutRotation
        • RotationOption.SameAsAtWriting
      • TargetPosition
        • TargetPosition.cube_location
        • TargetPosition.rotation_option
        • TargetPosition.flatten()
        • TargetPosition.__init__()
      • SpeedChangeType
        • SpeedChangeType.Constant
        • SpeedChangeType.Acceleration
        • SpeedChangeType.Deceleration
        • SpeedChangeType.AccelerationAndDeceleration
      • Speed
        • Speed.max
        • Speed.speed_change_type
        • Speed.flatten()
        • Speed.__init__()
      • MotorControlTarget
        • MotorControlTarget.__init__()
        • MotorControlTarget.__bytes__()
        • MotorControlTarget.__str__()
      • WriteMode
        • WriteMode.Overwrite
        • WriteMode.Append
      • MotorControlMultipleTargets
        • MotorControlMultipleTargets.__init__()
        • MotorControlMultipleTargets.__bytes__()
        • MotorControlMultipleTargets.__str__()
      • AccelerationRotation
        • AccelerationRotation.Positive
        • AccelerationRotation.Negative
      • AccelerationDirection
        • AccelerationDirection.Forward
        • AccelerationDirection.Backward
      • AccelerationPriority
        • AccelerationPriority.TranslationalVelocity
        • AccelerationPriority.RotationalVelocity
      • MotorControlAcceleration
        • MotorControlAcceleration.__init__()
        • MotorControlAcceleration.__bytes__()
        • MotorControlAcceleration.__str__()
      • MotorResponseCode
        • MotorResponseCode.SUCCESS
        • MotorResponseCode.ERROR_TIMEOUT
        • MotorResponseCode.ERROR_ID_MISSED
        • MotorResponseCode.ERROR_INVALID_PARAMETER
        • MotorResponseCode.ERROR_INVALID_CUBE_STATE
        • MotorResponseCode.SUCCESS_WITH_OVERWRITE
        • MotorResponseCode.ERROR_NOT_SUPPORTED
        • MotorResponseCode.ERROR_FAILED_TO_APPEND
      • ResponseMotorControlTarget
        • ResponseMotorControlTarget.response_code
        • ResponseMotorControlTarget.is_myself()
        • ResponseMotorControlTarget.__init__()
        • ResponseMotorControlTarget.__str__()
      • ResponseMotorControlMultipleTargets
        • ResponseMotorControlMultipleTargets.response_code
        • ResponseMotorControlMultipleTargets.is_myself()
        • ResponseMotorControlMultipleTargets.__init__()
        • ResponseMotorControlMultipleTargets.__str__()
      • ResponseMotorSpeed
        • ResponseMotorSpeed.left
        • ResponseMotorSpeed.right
        • ResponseMotorSpeed.is_myself()
        • ResponseMotorSpeed.__init__()
        • ResponseMotorSpeed.__str__()
      • MotorResponseType
      • Motor
        • Motor.is_my_data()
        • Motor.__init__()
        • Motor.motor_control()
        • Motor.motor_control_target()
        • Motor.motor_control_multiple_targets()
        • Motor.motor_control_acceleration()
    • toio.cube.api.sensor module
      • RequestMotionDetection
        • RequestMotionDetection.__init__()
        • RequestMotionDetection.__bytes__()
      • PostureDataType
        • PostureDataType.Euler
        • PostureDataType.Quaternions
      • RequestPostureAngleDetection
        • RequestPostureAngleDetection.__init__()
        • RequestPostureAngleDetection.__bytes__()
      • RequestMagneticSensor
        • RequestMagneticSensor.__init__()
        • RequestMagneticSensor.__bytes__()
      • Posture
        • Posture.Unknown
        • Posture.Top
        • Posture.Bottom
        • Posture.Rear
        • Posture.Front
        • Posture.Right
        • Posture.Left
      • MotionDetectionData
        • MotionDetectionData.horizontal
        • MotionDetectionData.collision
        • MotionDetectionData.double_tap
        • MotionDetectionData.posture
        • MotionDetectionData.shake
        • MotionDetectionData.is_myself()
        • MotionDetectionData.__init__()
        • MotionDetectionData.__str__()
      • PostureAngleEulerData
        • PostureAngleEulerData.roll
        • PostureAngleEulerData.pitch
        • PostureAngleEulerData.yaw
        • PostureAngleEulerData.is_myself()
        • PostureAngleEulerData.__init__()
        • PostureAngleEulerData.__str__()
      • PostureAngleQuaternionsData
        • PostureAngleQuaternionsData.w
        • PostureAngleQuaternionsData.x
        • PostureAngleQuaternionsData.y
        • PostureAngleQuaternionsData.z
        • PostureAngleQuaternionsData.is_myself()
        • PostureAngleQuaternionsData.__init__()
        • PostureAngleQuaternionsData.__str__()
      • MagneticSensorData
        • MagneticSensorData.state
        • MagneticSensorData.strength
        • MagneticSensorData.x
        • MagneticSensorData.y
        • MagneticSensorData.z
        • MagneticSensorData.is_myself()
        • MagneticSensorData.__init__()
      • SensorResponseType
      • Sensor
        • Sensor.is_my_data()
        • Sensor.__init__()
        • Sensor.read()
        • Sensor.request_motion_information()
        • Sensor.request_posture_angle_information()
        • Sensor.request_magnetic_sensor_information()
    • toio.cube.api.sound module
      • SoundId
        • SoundId.Enter
        • SoundId.Selected
        • SoundId.Cancel
        • SoundId.Cursor
        • SoundId.MatIn
        • SoundId.MatOut
        • SoundId.Get1
        • SoundId.Get2
        • SoundId.Get3
        • SoundId.Effect1
        • SoundId.Effect2
      • Note
        • Note.C0
        • Note.CS0
        • Note.D0
        • Note.DS0
        • Note.E0
        • Note.F0
        • Note.FS0
        • Note.G0
        • Note.GS0
        • Note.A0
        • Note.AS0
        • Note.B0
        • Note.C1
        • Note.CS1
        • Note.D1
        • Note.DS1
        • Note.E1
        • Note.F1
        • Note.FS1
        • Note.G1
        • Note.GS1
        • Note.A1
        • Note.AS1
        • Note.B1
        • Note.C2
        • Note.CS2
        • Note.D2
        • Note.DS2
        • Note.E2
        • Note.F2
        • Note.FS2
        • Note.G2
        • Note.GS2
        • Note.A2
        • Note.AS2
        • Note.B2
        • Note.C3
        • Note.CS3
        • Note.D3
        • Note.DS3
        • Note.E3
        • Note.F3
        • Note.FS3
        • Note.G3
        • Note.GS3
        • Note.A3
        • Note.AS3
        • Note.B3
        • Note.C4
        • Note.CS4
        • Note.D4
        • Note.DS4
        • Note.E4
        • Note.F4
        • Note.FS4
        • Note.G4
        • Note.GS4
        • Note.A4
        • Note.AS4
        • Note.B4
        • Note.C5
        • Note.CS5
        • Note.D5
        • Note.DS5
        • Note.E5
        • Note.F5
        • Note.FS5
        • Note.G5
        • Note.GS5
        • Note.A5
        • Note.AS5
        • Note.B5
        • Note.C6
        • Note.CS6
        • Note.D6
        • Note.DS6
        • Note.E6
        • Note.F6
        • Note.FS6
        • Note.G6
        • Note.GS6
        • Note.A6
        • Note.AS6
        • Note.B6
        • Note.C7
        • Note.CS7
        • Note.D7
        • Note.DS7
        • Note.E7
        • Note.F7
        • Note.FS7
        • Note.G7
        • Note.GS7
        • Note.A7
        • Note.AS7
        • Note.B7
        • Note.C8
        • Note.CS8
        • Note.D8
        • Note.DS8
        • Note.E8
        • Note.F8
        • Note.FS8
        • Note.G8
        • Note.GS8
        • Note.A8
        • Note.AS8
        • Note.B8
        • Note.C9
        • Note.CS9
        • Note.D9
        • Note.DS9
        • Note.E9
        • Note.F9
        • Note.FS9
        • Note.G9
        • Note.GS9
        • Note.A9
        • Note.AS9
        • Note.B9
        • Note.C10
        • Note.CS10
        • Note.D10
        • Note.DS10
        • Note.E10
        • Note.F10
        • Note.FS10
        • Note.G10
        • Note.NO_SOUND
      • MidiNote
        • MidiNote.duration_ms
        • MidiNote.note
        • MidiNote.volume
        • MidiNote.flatten()
        • MidiNote.__init__()
      • PlaySoundEffect
        • PlaySoundEffect.__init__()
        • PlaySoundEffect.__bytes__()
      • PlayMidi
        • PlayMidi.__init__()
        • PlayMidi.__bytes__()
      • Stop
        • Stop.__init__()
        • Stop.__bytes__()
      • Sound
        • Sound.is_my_data()
        • Sound.__init__()
        • Sound.play_sound_effect()
        • Sound.play_midi()
        • Sound.stop()