server Package

rest Module

class pypot.server.rest.RESTRobot(robot)

Bases: object

REST API for a Robot.

Through the REST API you can currently access:

• the motors list (and the aliases)
• the registers list for a specific motor
• read/write a value from/to a register of a specific motor
• the sensors list
• the registers list for a specific motor
• read/write a value from/to a register of a specific motor
• the primitives list (and the active)
• start/stop primitives

get_motors_list(alias='motors')

get_motor_registers_list(motor)

get_registers_list(motor)

get_motor_register_value(motor, register)

get_register_value(motor, register)

set_motor_register_value(motor, register, value)

set_register_value(motor, register, value)

get_motors_alias()

set_goto_position_for_motor(motor, position, duration)

get_sensors_list()

get_sensors_registers_list(sensor)

get_sensor_register_value(sensor, register)

set_sensor_register_value(sensor, register, value)

get_primitives_list()

get_running_primitives_list()

start_primitive(primitive)

stop_primitive(primitive)

pause_primitive(primitive)

resume_primitive(primitive)

get_primitive_properties_list(primitive)

get_primitive_property(primitive, property)

set_primitive_property(primitive, property, value)

get_primitive_methods_list(primitive)

call_primitive_method(primitive, method, kwargs)

start_move_recorder(move_name, motors_name=None)

attach_move_recorder(move_name, motors_name)

get_move_recorder_motors(move_name)

stop_move_recorder(move_name)

Allow more easily than stop_primitive() to save in a filename the recorded move

start_move_player(move_name, speed=1.0, backwards=False)

Move player need to have a move file <move_name.record> in the working directory to play it

get_available_record_list()

Get list of json recorded movement files

remove_move_record(move_name)

Remove the json recorded movement file

httpserver Module

class pypot.server.httpserver.MyJSONEncoder(skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, encoding='utf-8', default=None)

Bases: json.encoder.JSONEncoder

JSONEncoder which tries to call a json property before using the enconding default function.

Constructor for JSONEncoder, with sensible defaults.

If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, long, float or None. If skipkeys is True, such items are simply skipped.

If ensure_ascii is true (the default), all non-ASCII characters in the output are escaped with uXXXX sequences, and the results are str instances consisting of ASCII characters only. If ensure_ascii is False, a result may be a unicode instance. This usually happens if the input contains unicode strings or the encoding parameter is used.

If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an OverflowError). Otherwise, no such check takes place.

If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.

If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.

If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation. Since the default item separator is ‘, ‘, the output might include trailing whitespace when indent is specified. You can use separators=(‘,’, ‘: ‘) to avoid this.

If specified, separators should be a (item_separator, key_separator) tuple. The default is (‘, ‘, ‘: ‘). To get the most compact JSON representation you should specify (‘,’, ‘:’) to eliminate whitespace.

If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a TypeError.

If encoding is not None, then all input strings will be transformed into unicode using that encoding prior to JSON-encoding. The default is UTF-8.

default(obj)

Implement this method in a subclass such that it returns a serializable object for o, or calls the base implementation (to raise a TypeError).

For example, to support arbitrary iterators, you could implement default like this:

def default(self, o):
    try:
        iterable = iter(o)
    except TypeError:
        pass
    else:
        return list(iterable)
    # Let the base class default method raise the TypeError
    return JSONEncoder.default(self, o)

class pypot.server.httpserver.PoppyRequestHandler(application, request, **kwargs)

Bases: tornado.web.RequestHandler

Custom request handler.

Automatically sets CORS and cache headers, and manages every OPTIONS request.

set_default_headers()

Override this to set HTTP headers at the beginning of the request.

For example, this is the place to set a custom Server header. Note that setting such headers in the normal flow of request processing may not do what you want, since headers may be reset during error handling.

options(*args, **kwargs)

write_json(obj)

class pypot.server.httpserver.IndexHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get(*args)

class pypot.server.httpserver.MotorsListHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get(alias='motors')

class pypot.server.httpserver.SensorsListHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get()

class pypot.server.httpserver.MotorsAliasesListHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get()

class pypot.server.httpserver.MotorRegistersListHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get(motor_name)

class pypot.server.httpserver.MotorRegisterHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get(motor_name, register_name)

class pypot.server.httpserver.UpdateMotorRegisterHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

post(motor_name, register_name)

class pypot.server.httpserver.PrimitivesListHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get()

class pypot.server.httpserver.RunningPrimitivesListHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get()

class pypot.server.httpserver.StartPrimitiveHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get(primitive_name)

class pypot.server.httpserver.StopPrimitiveHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get(primitive_name)

class pypot.server.httpserver.PausePrimitiveHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get(primitive_name)

class pypot.server.httpserver.ResumePrimitiveHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get(primitive_name)

class pypot.server.httpserver.PrimitivePropertiesListHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get(primitive_name)

class pypot.server.httpserver.PrimitivePropertyHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get(primitive_name, prop)

class pypot.server.httpserver.SetPrimitivePropertyHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

post(primitive_name, prop)

class pypot.server.httpserver.ListPrimitiveMethodsHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get(primitive_name)

class pypot.server.httpserver.CallPrimitiveMethodHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

post(primitive_name, method_name)

class pypot.server.httpserver.MotorsRegistersHandler(application, request, **kwargs)

Bases: pypot.server.httpserver.PoppyRequestHandler

get(register_name)

class pypot.server.httpserver.HTTPRobotServer(robot, host='0.0.0.0', port='8080', cross_domain_origin='*', **kwargs)

Bases: pypot.server.server.AbstractServer

Refer to the REST API for an exhaustive list of the possible routes.

make_app()

run(**kwargs)

Start the tornado server, run forever

zmqserver Module

class pypot.server.zmqserver.ZMQRobotServer(robot, host, port)

Bases: pypot.server.server.AbstractServer

A ZMQServer allowing remote access of a robot instance.

The server used the REQ/REP zmq pattern. You should always first send a request and then read the answer.

run()

Run an infinite REQ/REP loop.

handle_request(request)

snap Module

pypot.server.snap.get_snap_user_projects_directory()

pypot.server.snap.find_local_ip(host=None)

pypot.server.snap.set_snap_server_variables(host, port, snap_extension='.xml', path=None)

Change dynamically port and host variable in xml Snap! project file

class pypot.server.snap.EnableCors(origin='*')

Bases: object

Enable CORS (Cross-Origin Resource Sharing) headers

name = 'enable_cors'

api = 2

apply(fn, context)

class pypot.server.snap.CacheBuster

Bases: object

Add response headers to disable cache

name = 'cache_buster'

api = 2

apply(fn, context)

class pypot.server.snap.SnapRobotServer(robot, host='0.0.0.0', port='6969', quiet=True)

Bases: pypot.server.server.AbstractServer

run(quiet=None, server='')

Start the tornado server, run forever. ‘quiet’ and ‘server’ arguments are no longer used, they are keep only for backward compatibility