irobotcreate3 module

class irobotcreate3.Create3AudioNote

Bases: object

class irobotcreate3.Create3Euler

Bases: object

class irobotcreate3.Create3LedColor

Bases: object

class irobotcreate3.Create3Lightring

Bases: object

class irobotcreate3.Create3Odometry

Bases: object

class irobotcreate3.Create3Pose

Bases: object

class irobotcreate3.Create3Quaternion

Bases: object

class irobotcreate3.Create3Twist

Bases: object

irobotcreate3.console_clear()

Clears the UI’s console.

irobotcreate3.create3_audio_append(notes, count)

Append the given audio to the current audio queue.

irobotcreate3.create3_audio_overwrite(notes, count)

Overwrite the current audio queue with the given audio.

irobotcreate3.create3_audio_play(notes, count, overwrite)

Play audio on the iRobot Create 3.

irobotcreate3.create3_connect()

Connect to the iRobot Create3.

irobotcreate3.create3_connect_manual(host, port)

Connects to the iRobot Create 3.

irobotcreate3.create3_dock()

Dock the iRobot Create 3 on the closest Home Base.

irobotcreate3.create3_drive_arc_degrees(radius, angle, max_linear_speed)

Drive the iRobot Create 3 in an arc (degrees).

irobotcreate3.create3_drive_arc_radians(radius, angle, max_linear_speed)

Drive the iRobot Create 3 in an arc (radians).

irobotcreate3.create3_drive_straight(distance, max_linear_speed)

Drive the iRobot Create 3 in a straight line.

irobotcreate3.create3_execute_next_command_immediately()

Execute the next command immediately.

irobotcreate3.create3_execute_next_command_post_haste()

An alias for create3_execute_next_command_immediately().

irobotcreate3.create3_follow_wall(follow, max_seconds)

Follow the given wall for the given amount of time.

irobotcreate3.create3_is_connected()

Check if the iRobot Create 3 is connected.

irobotcreate3.create3_led_animation(animation_type, lightring, max_runtime)

Run the given LED animation on the iRobot Create 3.

irobotcreate3.create3_led_color(r, g, b)

Create an LED color from the given RGB values.

irobotcreate3.create3_lightring(led0, led1, led2, led3, led4, led5)

Create a light ring from the given LED colors.

irobotcreate3.create3_lightring_set(lightring)

Set the light ring of the iRobot Create 3.

irobotcreate3.create3_navigate_to_pose(pose, max_linear_speed, max_angular_speed, achieve_goal_heading)

Navigate the iRobot Create 3 to the given pose.

irobotcreate3.create3_navigate_to_position(x, y, max_linear_speed, max_angular_speed)

Navigate the iRobot Create 3 to the given position.

irobotcreate3.create3_navigate_to_position_with_heading(x, y, theta, max_linear_speed, max_angular_speed)

Navigate the iRobot Create 3 to the given position with the given heading.

irobotcreate3.create3_odometry_get()

Get the odometry of the iRobot Create 3.

irobotcreate3.create3_orientation_get_euler()

Get the orientation (as Euler angles) of the iRobot Create 3.

irobotcreate3.create3_orientation_get_quaternion()

Get the orientation (as a quaternion) of the iRobot Create 3.

irobotcreate3.create3_pose_get()

Get the pose of the iRobot Create 3.

irobotcreate3.create3_rotate_degrees(angle, max_angular_speed)

Rotate the iRobot Create 3 in place (degrees).

irobotcreate3.create3_rotate_radians(angle, max_angular_speed)

Rotate the iRobot Create 3 in place (radians).

irobotcreate3.create3_sensor_bump(sensor_id)

Get the bump sensor value for given port.

irobotcreate3.create3_sensor_cliff(sensor_id)

Get the cliff sensor value for given port.

irobotcreate3.create3_sensor_ir(sensor_id)

Get the IR sensor value for given port.

irobotcreate3.create3_undock()

Undock the iRobot Create 3 from the Home Base.

irobotcreate3.create3_velocity_get()

Get the velocity of the iRobot Create 3.

irobotcreate3.create3_velocity_set(twist)

Set the velocity of the iRobot Create 3.

irobotcreate3.create3_velocity_set_components(linear_x, angular_z)

Set the velocity of the iRobot Create 3.

irobotcreate3.create3_wait()

Wait for the last command to finish executing.