Package intera_interface :: Module cuff :: Class Cuff

Class Cuff

object --+
         |
        Cuff

Interface class for cuff on the Intera robots.

Instance Methods

[hide private]

__init__(self, limb='right')
Constructor. source code

_config_callback(self, msg)
config topic callback

source code

bool

lower_button(self)
Returns a boolean describing whether the lower button on cuff is pressed.

source code

bool

upper_button(self)
Returns a boolean describing whether the upper button on cuff is pressed.

source code

bool

cuff_button(self)
Returns a boolean describing whether the cuff button on cuff is pressed.

source code

str

register_callback(self, callback_function, signal_name, poll_rate=10)
Registers a supplied callback to a change in state of supplied signal_name's value.

source code

bool

deregister_callback(self, callback_id)
Deregisters a callback based on the supplied callback_id.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, limb=`'right'`)
(Constructor)

source code

Constructor.

Parameters:

limb (str) - limb side to interface

Overrides: object.__init__

lower_button(self)

source code

Returns a boolean describing whether the lower button on cuff is pressed.

Returns: bool: a variable representing button state: (True: pressed, False: unpressed)

upper_button(self)

source code

Returns a boolean describing whether the upper button on cuff is pressed. (True: pressed, False: unpressed)

Returns: bool: a variable representing button state: (True: pressed, False: unpressed)

cuff_button(self)

source code

Returns a boolean describing whether the cuff button on cuff is pressed. (True: pressed, False: unpressed)

Returns: bool: a variable representing cuff button state: (True: pressed, False: unpressed)

register_callback(self, callback_function, signal_name, poll_rate=10)

source code

Registers a supplied callback to a change in state of supplied signal_name's value. Spawns a thread that will call the callback with the updated value.

Parameters:

callback_function (function) - function handle for callback function
signal_name (str) - the name of the signal to poll for value change
poll_rate (int) - the rate at which to poll for a value change (in a separate thread)

Returns: str

callback_id retuned if the callback was registered, and an empty string if the requested signal_name does not exist in the Navigator

deregister_callback(self, callback_id)

source code

Deregisters a callback based on the supplied callback_id.

Parameters:

callback_id (str) - the callback_id string to deregister

Returns: bool

returns bool True if the callback was successfully deregistered, and False otherwise.

Class Cuff

__init__(self, limb='right') (Constructor)

lower_button(self)

upper_button(self)

cuff_button(self)

register_callback(self, callback_function, signal_name, poll_rate=10)

deregister_callback(self, callback_id)

init(self, limb=`'right'`)
(Constructor)