reachy_mini/pr_1321/en/API/tools.md

Tools

Motor Setup Tools[[reachy_mini.tools.setup_motor]]

reachy_mini.tools.setup_motor[[reachy_mini.tools.setup_motor]]

reachy_mini.tools.setup_motor(motor_config: MotorConfig, serial_port: str, from_baudrate: int, target_baudrate: int, from_id: int)

Source

Set up the motor with the given configuration.

reachy_mini.tools.setup_motor.lookup_for_motor[[reachy_mini.tools.setup_motor.lookup_for_motor]]

reachy_mini.tools.setup_motor.lookup_for_motor(serial_port: str, id: int, baudrate: int, silent: bool = False)

Source

Check if a motor with the given ID is reachable on the specified serial port.

reachy_mini.tools.setup_motor.disable_torque[[reachy_mini.tools.setup_motor.disable_torque]]

reachy_mini.tools.setup_motor.disable_torque(serial_port: str, id: int, baudrate: int)

Source

Disable the torque of the motor with the given ID on the specified serial port.

reachy_mini.tools.setup_motor.change_baudrate[[reachy_mini.tools.setup_motor.change_baudrate]]

reachy_mini.tools.setup_motor.change_baudrate(serial_port: str, id: int, base_baudrate: int, target_baudrate: int)

Source

Change the baudrate of the motor with the given ID on the specified serial port.

reachy_mini.tools.setup_motor.change_id[[reachy_mini.tools.setup_motor.change_id]]

reachy_mini.tools.setup_motor.change_id(serial_port: str, current_id: int, new_id: int, baudrate: int)

Source

Change the ID of the motor with the given current ID on the specified serial port.

reachy_mini.tools.setup_motor.change_offset[[reachy_mini.tools.setup_motor.change_offset]]

reachy_mini.tools.setup_motor.change_offset(serial_port: str, id: int, offset: int, baudrate: int)

Source

Change the offset of the motor with the given ID on the specified serial port.

reachy_mini.tools.setup_motor.change_operating_mode[[reachy_mini.tools.setup_motor.change_operating_mode]]

reachy_mini.tools.setup_motor.change_operating_mode(serial_port: str, id: int, operating_mode: int, baudrate: int)

Source

Change the operating mode of the motor with the given ID on the specified serial port.

reachy_mini.tools.setup_motor.change_angle_limits[[reachy_mini.tools.setup_motor.change_angle_limits]]

reachy_mini.tools.setup_motor.change_angle_limits(serial_port: str, id: int, angle_limit_min: int, angle_limit_max: int, baudrate: int)

Source

Change the angle limits of the motor with the given ID on the specified serial port.

reachy_mini.tools.setup_motor.change_shutdown_error[[reachy_mini.tools.setup_motor.change_shutdown_error]]

reachy_mini.tools.setup_motor.change_shutdown_error(serial_port: str, id: int, baudrate: int, shutdown_error: int)

Source

Change the shutdown error of the motor with the given ID on the specified serial port.

reachy_mini.tools.setup_motor.change_return_delay_time[[reachy_mini.tools.setup_motor.change_return_delay_time]]

reachy_mini.tools.setup_motor.change_return_delay_time(serial_port: str, id: int, return_delay_time: int, baudrate: int)

Source

Change the return delay time of the motor with the given ID on the specified serial port.

reachy_mini.tools.setup_motor.light_led_up[[reachy_mini.tools.setup_motor.light_led_up]]

reachy_mini.tools.setup_motor.light_led_up(serial_port: str, id: int, baudrate: int)

Source

Light the LED of the motor with the given ID on the specified serial port.

reachy_mini.tools.setup_motor.light_led_down[[reachy_mini.tools.setup_motor.light_led_down]]

reachy_mini.tools.setup_motor.light_led_down(serial_port: str, id: int, baudrate: int)

Source

Light the LED of the motor with the given ID on the specified serial port.

reachy_mini.tools.setup_motor.check_configuration[[reachy_mini.tools.setup_motor.check_configuration]]

reachy_mini.tools.setup_motor.check_configuration(motor_config: MotorConfig, serial_port: str, baudrate: int)

Source

Check the configuration of the motor with the given ID on the specified serial port.

Motor Scanning Tools[[reachy_mini.tools.scan_motors.scan]]

reachy_mini.tools.scan_motors.scan[[reachy_mini.tools.scan_motors.scan]]

reachy_mini.tools.scan_motors.scan(port: str, baudrate: int)

Source

Scan the bus at the given baudrate and return detected IDs.

Motor Reflashing Tools[[reachy_mini.tools.reflash_motors.reflash_motors_if_needed]]

reachy_mini.tools.reflash_motors.reflash_motors_if_needed[[reachy_mini.tools.reflash_motors.reflash_motors_if_needed]]

reachy_mini.tools.reflash_motors.reflash_motors_if_needed(serialport: typing.Optional[str] = None, dont_light_up: bool = False)

Source

Reflash Reachy Mini's motors.