Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

A Python toolset for event-based, asynchronous programming of robot controllers

Project description

pyRobots: a toolkit for robot executive control
[![Documentation Status](](

`pyRobots` provides a set of Python decorators to easily turn standard functions
into background tasks which can be cancelled at anytime and to make your controller
*resource aware* (no, a robot can not turn left AND right at the same time).

It also provides a event-based mechanism to monitor specific conditions and
asynchronously trigger actions.

It finally provides a library of convenient tools to manage poses in a uniform way
(quaternions, Euler angles and 4D matrices, I look at you) and to interface with
existing middlewares (ROS, naoqi, aseba...).

`pyRobots` took some inspiration from the
[URBI]( language.


$ pip install pyRobots

(or, of course, from the source)

Main features

- Turns any Python function into a background *action* with the decorator
- Robot actions are non-blocking by default: they are instanciated as futures
(lightweight threads),
- Actions can be cancelled at any time via signals (the `ActionCancelled` signal
is raised).
- Lock specific resources with a simple `@lock(...)` in front of the actions.
When starting, actions will wait for resources to be available if needed.
- Supports *compound resources* (like `WHEELS` == `LEFTWHEEL` + `RIGHTWHEEL`)
- Create event with `robot.whenever(<condition>).do(<action>)`
- Poses are managed explicitely and can easily be transformed from one reference
frame to another one (integrates with ROS TF when available).
- Extensive logging support to debug and replay experiments.

Support for a particular robot only require to subclass `GenericRobot` for this
robot (and, obviously, to code the actions you want your robot to perform).


[Head to readthedocs]( Sparse for now.

Minimum Working Example

...that includes the creation of a specific robot

import time
from robots import GenericRobot
from robots.decorators import action, lock
from robots.resources import Resource
from robots.signals import ActionCancelled

# create a 'lockable' resource for our robot
WHEELS = Resource("wheels")

class MyRobot(GenericRobot):

def __init__(self):
super(MyRobot, self).__init__()

# create (and set) one element in the robot's state. Here a bumper.
self.state.my_bumper = False

# do whatever other initialization you need :-)

def send_goal(self, pose):
# move your robot using your favorite middleware
print("Starting to move towards %s" % pose)

def stop(self):
# stop your robot using your favorite middleware
print("Motion stopped")

def whatever_lowlevel_method_you_need(self):

def move_forward(robot):
""" We write action in a simple imperative, blocking way.

# the target pose: simply x += 1.0m in the robot's frame. pyRobots
# will handle the frames transformations as needed.
target = [1.0, 0., 0., "base_link"]


while(robot.pose.distance(robot.pose.myself(), target) > 0.1):
# robot.sleep is exactly like time.sleep, except it lets the pyrobots
# signals pass through.

print("Motion succeeded")

except ActionCancelled:
# if the action is cancelled, clean up your state

with MyRobot() as robot:

# Turn on DEBUG logging.
# Shortcut for logging.getLogger("robots").setLevel(logging.DEBUG)

robot.whenever("my_bumper", value = True).do(move_forward)

while True:
except KeyboardInterrupt:


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pyRobots-2.2.linux-x86_64.tar.gz (85.3 kB) Copy SHA256 hash SHA256 Dumb Binary any May 20, 2016
pyRobots-2.2.tar.gz (40.4 kB) Copy SHA256 hash SHA256 Source None May 20, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page