toio.simple package

Submodules

• toio.simple.async_simple module
  • Direction
    • Direction.Forward
    • Direction.Backward
    • Direction.Right
    • Direction.Left
  • AsyncSimpleCube
    • AsyncSimpleCube.DEFAULT_ROTATION_OPTION
    • AsyncSimpleCube.DEFAULT_MOVEMENT_TYPE
    • AsyncSimpleCube.DEFAULT_TIMEOUT
    • AsyncSimpleCube.DEFAULT_ONE_STEP
    • AsyncSimpleCube.CELL_SIZE
    • AsyncSimpleCube.MONITORING_CYCLE
    • AsyncSimpleCube.ensure_event_loop()
    • AsyncSimpleCube.search()
    • AsyncSimpleCube.__init__()
    • AsyncSimpleCube.connect()
    • AsyncSimpleCube.disconnect()
    • AsyncSimpleCube.sleep()
    • AsyncSimpleCube.move()
    • AsyncSimpleCube.spin()
    • AsyncSimpleCube.run_motor()
    • AsyncSimpleCube.stop_motor()
    • AsyncSimpleCube.move_steps()
    • AsyncSimpleCube.turn()
    • AsyncSimpleCube.move_to()
    • AsyncSimpleCube.set_orientation()
    • AsyncSimpleCube.move_to_the_grid_cell()
    • AsyncSimpleCube.get_current_position()
    • AsyncSimpleCube.get_x()
    • AsyncSimpleCube.get_y()
    • AsyncSimpleCube.get_orientation()
    • AsyncSimpleCube.get_grid()
    • AsyncSimpleCube.get_grid_x()
    • AsyncSimpleCube.get_grid_y()
    • AsyncSimpleCube.is_on_the_gird_cell()
    • AsyncSimpleCube.is_touched()
    • AsyncSimpleCube.get_touched_card()
    • AsyncSimpleCube.get_cube_name()
    • AsyncSimpleCube.get_battery_level()
    • AsyncSimpleCube.get_3d_angle()
    • AsyncSimpleCube.get_posture()
    • AsyncSimpleCube.is_button_pressed()
    • AsyncSimpleCube.turn_on_cube_lamp()
    • AsyncSimpleCube.turn_on_smooth_flashing()
    • AsyncSimpleCube.turn_off_cube_lamp()
    • AsyncSimpleCube.play_sound()
    • AsyncSimpleCube.stop_sound()
    • AsyncSimpleCube.is_magnet_in_contact()
    • AsyncSimpleCube.request_remote_power_off()
    • AsyncSimpleCube.set_speaker_mute()
    • AsyncSimpleCube.reset_configuration()

Module contents

class toio.simple.SimpleCube(name: str | None = None, timeout: int = 5, coordinate_system_class: ~typing.Type[~toio.coordinate_systems.ToioRelativeCoordinateSystem | ~toio.coordinate_systems.VisualProgrammingCoordinateSystem] = <class 'toio.coordinate_systems.VisualProgrammingCoordinateSystem'>, log_level: int = 0)

Bases: object

Access to toio core cube by easier method Functions that like blocks in visual programming

__init__(name: str | None = None, timeout: int = 5, coordinate_system_class: ~typing.Type[~toio.coordinate_systems.ToioRelativeCoordinateSystem | ~toio.coordinate_systems.VisualProgrammingCoordinateSystem] = <class 'toio.coordinate_systems.VisualProgrammingCoordinateSystem'>, log_level: int = 0) → None

move(speed: int, duration: float, wait_to_complete: bool = True) → None

spin(speed: int, duration: float, wait_to_complete: bool = True) → None

run_motor(left_speed: int, right_speed: int, duration: float, wait_to_complete: bool = True) → None

stop_motor() → None

move_steps(direction: Direction, speed: int, step: int) → bool

turn(speed: int, degree: int) → bool

move_to(speed: int, x: int, y: int) → bool

set_orientation(speed: int, degree: int) → bool

move_to_the_grid_cell(speed: int, cell_x: int, cell_y: int) → bool

get_current_position() → Tuple[int, int] | None

get_x() → int | None

get_y() → int | None

get_orientation() → int | None

get_grid() → Tuple[int, int] | None

get_grid_x() → int | None

get_grid_y() → int | None

is_on_the_gird_cell(cell_x: int, cell_y: int) → bool

is_touched(item: StandardIdCard) → bool

get_touched_card() → int | None

get_cube_name() → str | None

get_battery_level() → int | None

get_3d_angle() → Tuple[int, int, int] | None

get_posture() → int | None

is_button_pressed() → int | None

turn_on_cube_lamp(r: int, g: int, b: int, duration: float) → None

turn_off_cube_lamp() → None

play_sound(note: int, duration: float, wait_to_complete: bool = True) → bool

stop_sound() → None

is_magnet_in_contact() → int | None

turn_on_smooth_flashing(r: int, g: int, b: int, repeat: int, cycle: float) → None

turn_on_smooth_flashing.

Parameters:

• r (int) – Red (0-255)

• g (int) – Green (0-255)

• b (int) – Blue (0-255)

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

• cycle (float) – Cycle of flashing [s]

Return type:

None

request_remote_power_off(time_s: int) → None

request_remote_power_off.

Parameters:

time_s (int) – Time until power off [s]

Return type:

None

set_speaker_mute(mute: SpeakerMute) → None

set_speaker_mute.

Parameters:

mute (SpeakerMute) – Mute setting

Return type:

None

reset_configuration() → None

reset_configuration.

Return type:

None

class toio.simple.AsyncSimpleCube(name: str | None = None, timeout: int = 5, coordinate_system_class: ~typing.Type[~toio.coordinate_systems.ToioRelativeCoordinateSystem | ~toio.coordinate_systems.VisualProgrammingCoordinateSystem] = <class 'toio.coordinate_systems.VisualProgrammingCoordinateSystem'>, log_level: int = 0, cube: ~toio.cube.ToioCoreCube | None = None)

Bases: object

Access to toio core cube by easier method Functions that like blocks in visual programming

DEFAULT_ROTATION_OPTION: ClassVar[RotationOption] = 0

DEFAULT_MOVEMENT_TYPE: ClassVar[MovementType] = 0

DEFAULT_TIMEOUT: ClassVar[int] = 10

DEFAULT_ONE_STEP: ClassVar[int] = 1

CELL_SIZE: ClassVar[float] = 43.43

MONITORING_CYCLE: ClassVar[float] = 0.01

static ensure_event_loop() → AbstractEventLoop

async classmethod search(name: str | None = None, timeout: int = 5) → ToioCoreCube

__init__(name: str | None = None, timeout: int = 5, coordinate_system_class: ~typing.Type[~toio.coordinate_systems.ToioRelativeCoordinateSystem | ~toio.coordinate_systems.VisualProgrammingCoordinateSystem] = <class 'toio.coordinate_systems.VisualProgrammingCoordinateSystem'>, log_level: int = 0, cube: ~toio.cube.ToioCoreCube | None = None) → None

async connect() → None

async disconnect() → None

async sleep(sleep_second: float) → None

async move(speed: int, duration: float, wait_to_complete: bool = True) → None

async spin(speed: int, duration: float, wait_to_complete: bool = True) → None

speed: (negative value: anticlockwise)

async run_motor(left_speed: int, right_speed: int, duration: float, wait_to_complete: bool = True) → None

async stop_motor() → None

stop_motor.

Args:

Return type:

None

async move_steps(direction: Direction, speed: int, step: int) → bool

async turn(speed: int, degree: int) → bool

async move_to(speed: int, x: int, y: int) → bool

async set_orientation(speed: int, degree: int) → bool

async move_to_the_grid_cell(speed: int, cell_x: int, cell_y: int) → bool

async get_current_position() → Tuple[int, int] | None

async get_x() → int | None

async get_y() → int | None

async get_orientation() → int | None

async get_grid() → Tuple[int, int] | None

async get_grid_x() → int | None

async get_grid_y() → int | None

async is_on_the_gird_cell(cell_x: int, cell_y: int) → bool

async is_touched(item: StandardIdCard) → bool

async get_touched_card() → int | None

async get_cube_name() → str | None

async get_battery_level() → int | None

async get_3d_angle() → Tuple[int, int, int] | None

async get_posture() → int | None

async is_button_pressed() → int | None

async turn_on_cube_lamp(r: int, g: int, b: int, duration: float) → None

async turn_on_smooth_flashing(r: int, g: int, b: int, repeat: int, cycle: float) → None

turn_on_smooth_flashing.

Parameters:

• r (int) – Red (0-255)

• g (int) – Green (0-255)

• b (int) – Blue (0-255)

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

• cycle (float) – Cycle of flashing [s]

Return type:

None

async turn_off_cube_lamp() → None

async play_sound(note: int, duration: float, wait_to_complete: bool = True) → bool

async stop_sound() → None

async is_magnet_in_contact() → int | None

async request_remote_power_off(time_s: int) → None

request_remote_power_off.

Parameters:

time_s (int) – Time until power off [s]

Return type:

None

async set_speaker_mute(mute: SpeakerMute) → None

set_speaker_mute.

Parameters:

mute (SpeakerMute) – Mute setting

Return type:

None

async reset_configuration() → None

reset_configuration.

Return type:

None

class toio.simple.SimpleCube_v1_0(name: str | None = None, timeout: int = 5, coordinate_system_class: ~typing.Type[~toio.coordinate_systems.ToioRelativeCoordinateSystem | ~toio.coordinate_systems.VisualProgrammingCoordinateSystem] = <class 'toio.coordinate_systems.VisualProgrammingCoordinateSystem'>, log_level: int = 0, dbg_name: str = '')

Bases: object

Access to toio core cube by easier method Functions that like blocks in visual programming

DEFAULT_ROTATION_OPTION: ClassVar[RotationOption] = 0

DEFAULT_MOVEMENT_TYPE: ClassVar[MovementType] = 0

DEFAULT_TIMEOUT: ClassVar[int] = 10

DEFAULT_ONE_STEP: ClassVar[int] = 1

CELL_SIZE: ClassVar[float] = 43.43

MONITORING_CYCLE: ClassVar[float] = 0.01

static ensure_event_loop() → AbstractEventLoop

async classmethod search(name: str | None = None, timeout: int = 5) → ToioCoreCube

__init__(name: str | None = None, timeout: int = 5, coordinate_system_class: ~typing.Type[~toio.coordinate_systems.ToioRelativeCoordinateSystem | ~toio.coordinate_systems.VisualProgrammingCoordinateSystem] = <class 'toio.coordinate_systems.VisualProgrammingCoordinateSystem'>, log_level: int = 0, dbg_name: str = '') → None

disconnect()

sleep(sleep_second: float)

move(speed: int, duration: float, wait_to_complete: bool = True) → None

spin(speed: int, duration: float, wait_to_complete: bool = True) → None

speed: (negative value: anticlockwise)

run_motor(left_speed: int, right_speed: int, duration: float, wait_to_complete: bool = True) → None

stop_motor() → None

move_steps(direction: Direction, speed: int, step: int) → bool

turn(speed: int, degree: int) → bool

move_to(speed: int, x: int, y: int) → bool

set_orientation(speed: int, degree: int) → bool

move_to_the_grid_cell(speed: int, cell_x: int, cell_y: int) → bool

get_current_position() → Tuple[int, int] | None

get_x() → int | None

get_y() → int | None

get_orientation() → int | None

get_grid() → Tuple[int, int] | None

get_grid_x() → int | None

get_grid_y() → int | None

is_on_the_gird_cell(cell_x: int, cell_y: int) → bool

is_touched(item: StandardIdCard) → bool

get_touched_card() → int | None

get_cube_name() → str | None

get_battery_level() → int | None

get_3d_angle() → Tuple[int, int, int] | None

get_posture() → int | None

is_button_pressed() → int | None

turn_on_cube_lamp(r: int, g: int, b: int, duration: float) → None

turn_off_cube_lamp() → None

play_sound(note: int, duration: float, wait_to_complete: bool = True) → bool

stop_sound() → None

is_magnet_in_contact() → int | None

turn_on_smooth_flashing(r: int, g: int, b: int, repeat: int, cycle: float) → None

turn_on_smooth_flashing.

Parameters:

• r (int) – Red (0-255)

• g (int) – Green (0-255)

• b (int) – Blue (0-255)

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

• cycle (float) – Cycle of flashing [s]

Return type:

None

request_remote_power_off(time_s: int) → None

request_remote_power_off.

Parameters:

time_s (int) – Time until power off [s]

Return type:

None

set_speaker_mute(mute: SpeakerMute) → None

set_speaker_mute.

Parameters:

mute (SpeakerMute) – Mute setting

Return type:

None

reset_configuration() → None

reset_configuration.

Return type:

None