robot package
Subpackages
- robot.communication package
- robot.exception package
- robot.helpers package
- Submodules
- robot.helpers.coordinate module
CoordinateCoordinate.get_heading()Coordinate.get_heading_rad()Coordinate.get_x()Coordinate.get_y()Coordinate.handle_subscription()Coordinate.print()Coordinate.publish_coordinate()Coordinate.set_coordinate()Coordinate.set_coordinate_heading()Coordinate.set_heading()Coordinate.set_heading_rad()Coordinate.set_x()Coordinate.set_y()
- robot.helpers.motion_controller module
- robot.helpers.robot_mqtt module
- Module contents
CoordinateCoordinate.get_heading()Coordinate.get_heading_rad()Coordinate.get_x()Coordinate.get_y()Coordinate.handle_subscription()Coordinate.print()Coordinate.publish_coordinate()Coordinate.set_coordinate()Coordinate.set_coordinate_heading()Coordinate.set_heading()Coordinate.set_heading_rad()Coordinate.set_x()Coordinate.set_y()
MotionControllerRobotMQTT
- robot.indicators package
- robot.interfaces package
- robot.mqtt package
- robot.sensors package
- robot.types package
Submodules
robot.motion module
Motion controller algorithms (re-export).
robot.mqtt_client module
Compatibility re-export for RobotMqttClient.
The implementation lives in robot.mqtt.robot_mqtt_client.
robot.robot_base module
Abstract Robot base class mirroring swarm.robot.Robot (Java).
Method names are provided in snake_case.
- class robot.robot_base.Robot(id, x, y, heading, reality)
Bases:
IRobotState- color_sensor: ColorSensor
- communication_interrupt(msg)
- Return type:
None
- coordinates: Coordinate
- delay(milliseconds)
- Return type:
None
- directed_comm: DirectedCommunication
- dist_sensor: DistanceSensor
- get_id()
- Return type:
int
- handle_subscribe_queue()
- Return type:
None
- id: int
- loop()
- Return type:
None
- motion: MotionController
- proximity_sensor: ProximitySensor
- reality: str
- reset()
- Return type:
None
- robot_mqtt_client: RobotMqttClient
- run()
- Return type:
None
- sensor_interrupt(sensor, value)
- Return type:
None
- setup()
- Return type:
None
- simple_comm: SimpleCommunication
- start()
- Return type:
None
- state: RobotState = 'WAIT'
- stop()
- Return type:
None
robot.virtual_robot module
Module contents
Top-level package for robot library (Python port of robot-library-java).
- class robot.MQTTSettings
Bases:
object- channel: str | None = None
- password: str | None = None
- port: int = 1883
- classmethod print()
- Return type:
None
- server: str | None = None
- user_name: str | None = None
- class robot.MotionController(coordinate=None)
Bases:
object- ADDITIONAL_DELAY = 500
- CM_2_MM = 10
- SEC_2_MS = 1000
- SPEED_FACTOR = 0.1
- move(left_speed, right_speed, duration=None)
- Return type:
None
- rotate(speed, duration=None)
- Return type:
None
- rotate_degree(speed, degree)
- Return type:
None
- rotate_radians(speed, radians)
- Return type:
None
- class robot.Robot(id, x, y, heading, reality)
Bases:
IRobotState- color_sensor: ColorSensor
- communication_interrupt(msg)
- Return type:
None
- coordinates: Coordinate
- delay(milliseconds)
- Return type:
None
- directed_comm: DirectedCommunication
- dist_sensor: DistanceSensor
- get_id()
- Return type:
int
- handle_subscribe_queue()
- Return type:
None
- id: int
- loop()
- Return type:
None
- motion: MotionController
- proximity_sensor: ProximitySensor
- reality: str
- reset()
- Return type:
None
- robot_mqtt_client: RobotMqttClient
- run()
- Return type:
None
- sensor_interrupt(sensor, value)
- Return type:
None
- setup()
- Return type:
None
- simple_comm: SimpleCommunication
- start()
- Return type:
None
- state: RobotState = 'WAIT'
- stop()
- Return type:
None