Robot Library (Python)
Documentation
Installation
Robot Library Installation
Building Docs locally
Usage Guide
Configure MQTT
Subclass
VirtualRobot
Motion Control
Sensors
Communications
Indicators (NeoPixel)
Extensibility Guidelines
robot
robot package
Subpackages
Submodules
robot.motion module
robot.mqtt_client module
robot.robot_base module
robot.virtual_robot module
Module contents
Robot Library (Python)
Index
Index
A
|
B
|
C
|
D
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
AbstractIndicator (class in robot.indicators.abstract_indicator)
AbstractSensor (class in robot.sensors.abstract_sensor)
ADDITIONAL_DELAY (robot.helpers.motion_controller.MotionController attribute)
(robot.helpers.MotionController attribute)
(robot.MotionController attribute)
B
BEGIN (robot.interfaces.RobotState attribute)
C
change_color() (robot.indicators.NeoPixel method)
(robot.indicators.neopixel.NeoPixel method)
channel (robot.MQTTSettings attribute)
CM_2_MM (robot.helpers.motion_controller.MotionController attribute)
(robot.helpers.MotionController attribute)
(robot.MotionController attribute)
color_sensor (robot.Robot attribute)
(robot.robot_base.Robot attribute)
colors() (robot.types.proximity_reading_type.ProximityReadingType method)
(robot.types.ProximityReadingType method)
ColorSensor (class in robot.sensors)
(class in robot.sensors.color)
Communication (class in robot.communication.communication)
communication_interrupt() (robot.interfaces.IRobotState method)
(robot.Robot method)
(robot.robot_base.Robot method)
(robot.virtual_robot.VirtualRobot method)
(robot.VirtualRobot method)
compare_to() (robot.types.rgb_color_type.RGBColorType method)
(robot.types.RGBColorType method)
Coordinate (class in robot.helpers)
(class in robot.helpers.coordinate)
coordinates (robot.Robot attribute)
(robot.robot_base.Robot attribute)
D
delay() (robot.Robot method)
(robot.robot_base.Robot method)
directed_comm (robot.Robot attribute)
(robot.robot_base.Robot attribute)
DirectedCommunication (class in robot.communication)
(class in robot.communication.directed_comm)
dist_sensor (robot.Robot attribute)
(robot.robot_base.Robot attribute)
distances() (robot.types.proximity_reading_type.ProximityReadingType method)
(robot.types.ProximityReadingType method)
DistanceSensor (class in robot.sensors)
(class in robot.sensors.distance)
G
get_b() (robot.types.rgb_color_type.RGBColorType method)
(robot.types.RGBColorType method)
get_color() (robot.sensors.color.ColorSensor method)
(robot.sensors.ColorSensor method)
(robot.types.rgb_color_type.RGBColorType method)
(robot.types.RGBColorType method)
get_distance() (robot.sensors.distance.DistanceSensor method)
(robot.sensors.DistanceSensor method)
get_g() (robot.types.rgb_color_type.RGBColorType method)
(robot.types.RGBColorType method)
get_heading() (robot.helpers.Coordinate method)
(robot.helpers.coordinate.Coordinate method)
get_heading_rad() (robot.helpers.Coordinate method)
(robot.helpers.coordinate.Coordinate method)
get_id() (robot.Robot method)
(robot.robot_base.Robot method)
get_proximity() (robot.sensors.proximity.ProximitySensor method)
(robot.sensors.ProximitySensor method)
get_r() (robot.types.rgb_color_type.RGBColorType method)
(robot.types.RGBColorType method)
get_x() (robot.helpers.Coordinate method)
(robot.helpers.coordinate.Coordinate method)
get_y() (robot.helpers.Coordinate method)
(robot.helpers.coordinate.Coordinate method)
H
handle_subscribe_queue() (robot.Robot method)
(robot.robot_base.Robot method)
handle_subscription() (robot.communication.directed_comm.DirectedCommunication method)
(robot.communication.DirectedCommunication method)
(robot.communication.simple_comm.SimpleCommunication method)
(robot.communication.SimpleCommunication method)
(robot.helpers.Coordinate method)
(robot.helpers.coordinate.Coordinate method)
(robot.helpers.robot_mqtt.RobotMQTT method)
(robot.helpers.RobotMQTT method)
(robot.indicators.abstract_indicator.AbstractIndicator method)
(robot.indicators.NeoPixel method)
(robot.indicators.neopixel.NeoPixel method)
(robot.interfaces.IMqttHandler method)
(robot.sensors.abstract_sensor.AbstractSensor method)
(robot.sensors.color.ColorSensor method)
(robot.sensors.ColorSensor method)
(robot.sensors.distance.DistanceSensor method)
(robot.sensors.DistanceSensor method)
(robot.sensors.proximity.ProximitySensor method)
(robot.sensors.ProximitySensor method)
I
id (robot.Robot attribute)
(robot.robot_base.Robot attribute)
IMqttHandler (class in robot.interfaces)
in_queue_pop() (robot.mqtt.robot_mqtt_client.RobotMqttClient method)
(robot.mqtt.RobotMqttClient method)
IRobotState (class in robot.interfaces)
L
loop() (robot.interfaces.IRobotState method)
(robot.Robot method)
(robot.robot_base.Robot method)
(robot.virtual_robot.VirtualRobot method)
(robot.VirtualRobot method)
M
module
robot
robot.communication
robot.communication.communication
robot.communication.directed_comm
robot.communication.simple_comm
robot.exception
robot.helpers
robot.helpers.coordinate
robot.helpers.motion_controller
robot.helpers.robot_mqtt
robot.indicators
robot.indicators.abstract_indicator
robot.indicators.neopixel
robot.interfaces
robot.motion
robot.mqtt
robot.mqtt.mqtt_msg
robot.mqtt.robot_mqtt_client
robot.mqtt_client
robot.robot_base
robot.sensors
robot.sensors.abstract_sensor
robot.sensors.color
robot.sensors.distance
robot.sensors.proximity
robot.types
robot.types.proximity_reading_type
robot.types.rgb_color_type
robot.virtual_robot
motion (robot.Robot attribute)
(robot.robot_base.Robot attribute)
MotionController (class in robot)
(class in robot.helpers)
(class in robot.helpers.motion_controller)
MotionControllerException
move() (robot.helpers.motion_controller.MotionController method)
(robot.helpers.MotionController method)
(robot.MotionController method)
MQTT_TIMEOUT (robot.sensors.color.ColorSensor attribute)
(robot.sensors.ColorSensor attribute)
(robot.sensors.distance.DistanceSensor attribute)
(robot.sensors.DistanceSensor attribute)
(robot.sensors.proximity.ProximitySensor attribute)
(robot.sensors.ProximitySensor attribute)
MqttClientException
MqttMsg (class in robot.mqtt)
(class in robot.mqtt.mqtt_msg)
MQTTSettings (class in robot)
N
neo_pixel (robot.Robot attribute)
(robot.robot_base.Robot attribute)
NeoPixel (class in robot.indicators)
(class in robot.indicators.neopixel)
O
out_queue_pop() (robot.mqtt.robot_mqtt_client.RobotMqttClient method)
(robot.mqtt.RobotMqttClient method)
P
password (robot.MQTTSettings attribute)
port (robot.MQTTSettings attribute)
print() (robot.helpers.Coordinate method)
(robot.helpers.coordinate.Coordinate method)
(robot.MQTTSettings class method)
proximity_sensor (robot.Robot attribute)
(robot.robot_base.Robot attribute)
ProximityException
ProximityReadingType (class in robot.types)
(class in robot.types.proximity_reading_type)
ProximitySensor (class in robot.sensors)
(class in robot.sensors.proximity)
publish() (robot.mqtt.robot_mqtt_client.RobotMqttClient method)
(robot.mqtt.RobotMqttClient method)
publish_coordinate() (robot.helpers.Coordinate method)
(robot.helpers.coordinate.Coordinate method)
R
reality (robot.Robot attribute)
(robot.robot_base.Robot attribute)
reset() (robot.interfaces.IRobotState method)
(robot.Robot method)
(robot.robot_base.Robot method)
RGBColorException
RGBColorType (class in robot.types)
(class in robot.types.rgb_color_type)
robot
module
Robot (class in robot)
(class in robot.robot_base)
robot.communication
module
robot.communication.communication
module
robot.communication.directed_comm
module
robot.communication.simple_comm
module
robot.exception
module
robot.helpers
module
robot.helpers.coordinate
module
robot.helpers.motion_controller
module
robot.helpers.robot_mqtt
module
robot.indicators
module
robot.indicators.abstract_indicator
module
robot.indicators.neopixel
module
robot.interfaces
module
robot.motion
module
robot.mqtt
module
robot.mqtt.mqtt_msg
module
robot.mqtt.robot_mqtt_client
module
robot.mqtt_client
module
robot.robot_base
module
robot.sensors
module
robot.sensors.abstract_sensor
module
robot.sensors.color
module
robot.sensors.distance
module
robot.sensors.proximity
module
robot.types
module
robot.types.proximity_reading_type
module
robot.types.rgb_color_type
module
robot.virtual_robot
module
robot_create() (robot.helpers.robot_mqtt.RobotMQTT method)
(robot.helpers.RobotMQTT method)
ROBOT_LOG_LEVEL (robot.RobotSettings attribute)
robot_mqtt (robot.Robot attribute)
(robot.robot_base.Robot attribute)
robot_mqtt_client (robot.Robot attribute)
(robot.robot_base.Robot attribute)
ROBOT_RADIUS (robot.RobotSettings attribute)
ROBOT_SPEED_MAX (robot.RobotSettings attribute)
ROBOT_SPEED_MIN (robot.RobotSettings attribute)
ROBOT_WHEEL_RADIUS (robot.RobotSettings attribute)
ROBOT_WIDTH (robot.RobotSettings attribute)
RobotMQTT (class in robot.helpers)
(class in robot.helpers.robot_mqtt)
RobotMqttClient (class in robot.mqtt)
(class in robot.mqtt.robot_mqtt_client)
RobotSettings (class in robot)
RobotState (class in robot.interfaces)
rotate() (robot.helpers.motion_controller.MotionController method)
(robot.helpers.MotionController method)
(robot.MotionController method)
rotate_degree() (robot.helpers.motion_controller.MotionController method)
(robot.helpers.MotionController method)
(robot.MotionController method)
rotate_radians() (robot.helpers.motion_controller.MotionController method)
(robot.helpers.MotionController method)
(robot.MotionController method)
RUN (robot.interfaces.RobotState attribute)
run() (robot.Robot method)
(robot.robot_base.Robot method)
S
SEC_2_MS (robot.helpers.motion_controller.MotionController attribute)
(robot.helpers.MotionController attribute)
(robot.MotionController attribute)
send_color() (robot.sensors.color.ColorSensor method)
(robot.sensors.ColorSensor method)
send_distance() (robot.sensors.distance.DistanceSensor method)
(robot.sensors.DistanceSensor method)
send_message() (robot.communication.communication.Communication method)
(robot.communication.directed_comm.DirectedCommunication method)
(robot.communication.DirectedCommunication method)
(robot.communication.simple_comm.SimpleCommunication method)
(robot.communication.SimpleCommunication method)
send_message_with_distance() (robot.communication.communication.Communication method)
(robot.communication.directed_comm.DirectedCommunication method)
(robot.communication.DirectedCommunication method)
(robot.communication.simple_comm.SimpleCommunication method)
(robot.communication.SimpleCommunication method)
send_proximity() (robot.sensors.proximity.ProximitySensor method)
(robot.sensors.ProximitySensor method)
sensor_interrupt() (robot.interfaces.IRobotState method)
(robot.Robot method)
(robot.robot_base.Robot method)
(robot.virtual_robot.VirtualRobot method)
(robot.VirtualRobot method)
SensorException
server (robot.MQTTSettings attribute)
set_angles() (robot.sensors.proximity.ProximitySensor method)
(robot.sensors.ProximitySensor method)
set_color() (robot.types.rgb_color_type.RGBColorType method)
(robot.types.RGBColorType method)
set_color_from_hex_code() (robot.types.rgb_color_type.RGBColorType method)
(robot.types.RGBColorType method)
set_color_from_str() (robot.types.rgb_color_type.RGBColorType method)
(robot.types.RGBColorType method)
set_coordinate() (robot.helpers.Coordinate method)
(robot.helpers.coordinate.Coordinate method)
set_coordinate_heading() (robot.helpers.Coordinate method)
(robot.helpers.coordinate.Coordinate method)
set_heading() (robot.helpers.Coordinate method)
(robot.helpers.coordinate.Coordinate method)
set_heading_rad() (robot.helpers.Coordinate method)
(robot.helpers.coordinate.Coordinate method)
set_x() (robot.helpers.Coordinate method)
(robot.helpers.coordinate.Coordinate method)
set_y() (robot.helpers.Coordinate method)
(robot.helpers.coordinate.Coordinate method)
setup() (robot.Robot method)
(robot.robot_base.Robot method)
simple_comm (robot.Robot attribute)
(robot.robot_base.Robot attribute)
SimpleCommunication (class in robot.communication)
(class in robot.communication.simple_comm)
SPEED_FACTOR (robot.helpers.motion_controller.MotionController attribute)
(robot.helpers.MotionController attribute)
(robot.MotionController attribute)
start() (robot.interfaces.IRobotState method)
(robot.Robot method)
(robot.robot_base.Robot method)
state (robot.interfaces.IRobotState attribute)
(robot.Robot attribute)
(robot.robot_base.Robot attribute)
stop() (robot.interfaces.IRobotState method)
(robot.Robot method)
(robot.robot_base.Robot method)
subscribe() (robot.mqtt.robot_mqtt_client.RobotMqttClient method)
(robot.mqtt.RobotMqttClient method)
T
to_string_color() (robot.types.rgb_color_type.RGBColorType method)
(robot.types.RGBColorType method)
U
user_name (robot.MQTTSettings attribute)
V
VirtualRobot (class in robot)
(class in robot.virtual_robot)
W
WAIT (robot.interfaces.RobotState attribute)