Reachy Mini documentation

Tools

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v1.9.0).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Tools

Motor Setup Tools

reachy_mini.tools.setup_motor

< >

( motor_config: MotorConfigserial_port: strfrom_baudrate: inttarget_baudrate: intfrom_id: int )

Set up the motor with the given configuration.

reachy_mini.tools.setup_motor.lookup_for_motor

< >

( serial_port: strid: intbaudrate: intsilent: bool = False )

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

reachy_mini.tools.setup_motor.disable_torque

< >

( serial_port: strid: intbaudrate: int )

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

reachy_mini.tools.setup_motor.change_baudrate

< >

( serial_port: strid: intbase_baudrate: inttarget_baudrate: int )

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

reachy_mini.tools.setup_motor.change_id

< >

( serial_port: strcurrent_id: intnew_id: intbaudrate: int )

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

reachy_mini.tools.setup_motor.change_offset

< >

( serial_port: strid: intoffset: intbaudrate: int )

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

reachy_mini.tools.setup_motor.change_operating_mode

< >

( serial_port: strid: intoperating_mode: intbaudrate: int )

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

reachy_mini.tools.setup_motor.change_angle_limits

< >

( serial_port: strid: intangle_limit_min: intangle_limit_max: intbaudrate: int )

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

reachy_mini.tools.setup_motor.change_shutdown_error

< >

( serial_port: strid: intbaudrate: intshutdown_error: int )

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

< >

( serial_port: strid: intreturn_delay_time: intbaudrate: int )

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

< >

( serial_port: strid: intbaudrate: int )

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

reachy_mini.tools.setup_motor.light_led_down

< >

( serial_port: strid: intbaudrate: int )

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

reachy_mini.tools.setup_motor.check_configuration

< >

( motor_config: MotorConfigserial_port: strbaudrate: int )

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

Motor Scanning Tools

reachy_mini.tools.scan_motors.scan

< >

( port: strbaudrate: int )

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

Motor Reflashing Tools

reachy_mini.tools.reflash_motors.reflash_motors_if_needed

< >

( serialport: typing.Optional[str] = Nonedont_light_up: bool = False )

Reflash Reachy Mini’s motors.

Update on GitHub