ArduRPC

class ardurpc.ArduRPC(handlers=None, **kwargs)

Functions with camel-case names are directly mapped to a function on the device. Functions without camel-case names are not mapped. The second function type should be preferred.

getHandlerList()

Get a handler list.

Function ‘get_handlers()’ should be preferred.

Returns:Raw value returned by the device

getHandlerName(handler_id)

Get a handler name by its ID.

Parameters:handler_id (Integer) – The ID of the handler Returns:The name of the handler Return type:String

getLibraryVersion()

Get the version of the ArduRPC library running on the device.

Returns:Raw value returned by the device

getMaxPacketSize()

Get the max packet size supported by the device.

Returns:Raw value returned by the device

getProtocolVersion()

Get supported protocol version.

Returns:Value returned by the device

get_handler(handler_id)

Return a instance of the handler.

Parameters:handler_id (Integer) – The ID of the handler Returns:Class instance or None Return type:Instance

get_handler_by_name(name)

Return a instance of the handler.

Parameters:name (String) – The name of the handler Returns:Class instance or None Return type:Instance

get_handler_cache()

Get a list of all cached handlers.

Returns:Dict: Key = Name, Value = Instance Return type:Dict

get_handler_names()

Return a list of handler names present on the device.

Returns:List of names Return type:List

get_handlers()

Get a list of all available handlers.

Returns:Dict: Key = Name, Value = Instance Return type:Dict

get_version()

Get the version of the ArduRPC library running on the device.

Returns:A Dict with major, minor and patch level Return type:Dict

ardurpc.load_handlers()

Load build-in handlers.

ardurpc.register(handler_type, handler, mask=16)

Register a new handler.

Parameters:

• handler_type (Integer) – The ID of the handler type
• handler (Class) – The handler class (Not an instance)
• mask (Integer) – The mask to group handlers

ArduRPC exceptions.

• Failure
  • FunctionNotFound
  • HandlerNotFound
  • CommandNotFound
• Timeout

exception ardurpc.exception.ArduRPCException(value='')

Base ArduRPC Exception.

__weakref__

list of weak references to the object (if defined)

exception ardurpc.exception.CommandNotFound(value='')

The command is not available on the microcontroller.

exception ardurpc.exception.Failure(value='')

Something went wrong while executing a command.

But no reason was given.

exception ardurpc.exception.FunctionNotFound(value='')

The function is not available on the microcontroller.

exception ardurpc.exception.HandlerNotFound(value='')

The handler is not available on the microcontroller.

exception ardurpc.exception.InvalidHeader(value='')

The header was malformed

exception ardurpc.exception.InvalidRequest(value='')

The request was malformed

exception ardurpc.exception.Timeout(value='')

A timeout occurred.

exception ardurpc.exception.UnknownReturnCode(value='')

.