robot.util.buttons.free_motion_button.FreeMotionButtonRosWrapper

class documentation

class FreeMotionButtonRosWrapper:

Constructor: FreeMotionButtonRosWrapper(hardware_version)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method get_and_wait_press_duration Waits for the button to be pressed and returns the press time. Returns 0 if no press is detected after the timeout duration.
Method is_pressed Button press state
Method wait_for_action Waits until a specific action occurs and returns true. Returns false if the timeout is reached.
Method wait_for_any_action Returns the detected action. Returns ButtonAction.NO_ACTION if the timeout is reached without action.
Instance Variable callback Undocumented
Property hardware_version Undocumented
Property state Get the button state from the ButtonAction class
Method __callback_save_pos_button_status Undocumented
Method __check_ned_2_version Undocumented
Method __clear Undocumented
Method __get_press_time Undocumented
Method __set Undocumented
Method __wait Undocumented
Method __wait_any Undocumented
Instance Variable __action_events Undocumented
Instance Variable __action_lock Undocumented
Instance Variable __free_motion_button_state Undocumented
Instance Variable __free_motion_button_topic Undocumented
Instance Variable __hardware_version Undocumented
def __init__(self, hardware_version='ned2'):

Undocumented

def get_and_wait_press_duration(self, timeout=0):

Waits for the button to be pressed and returns the press time. Returns 0 if no press is detected after the timeout duration.

Parameters
timeout:foatUndocumented
Returns
floatUndocumented
def is_pressed(self):

Button press state

Returns
boolUndocumented
def wait_for_action(self, action, timeout=0):

Waits until a specific action occurs and returns true. Returns false if the timeout is reached.

Parameters
action:int self.__save_button_topicint value from the ButtonAction class
timeout:float ref_countUndocumented
Returns
intReturns the detected action, or ButtonAction.NO_ACTION if the timeout is reached without any action.
def wait_for_any_action(self, timeout=0):

Returns the detected action. Returns ButtonAction.NO_ACTION if the timeout is reached without action.

Parameters
timeout:floatUndocumented
Returns
intReturns the detected action, or ButtonAction.NO_ACTION if the timeout is reached without any action.
callback =

Undocumented

@property
hardware_version =

Undocumented

@property
state: int =

Get the button state from the ButtonAction class

def __callback_save_pos_button_status(self, free_motion_button_status):

Undocumented

def __check_ned_2_version(self):

Undocumented

def __clear(self):

Undocumented

def __get_press_time(self, timeout=0.0):

Undocumented

def __set(self, action):

Undocumented

def __wait(self, action, timeout=0.0):

Undocumented

def __wait_any(self, timeout=0.0):

Undocumented

__action_events =

Undocumented

__action_lock =

Undocumented

__free_motion_button_state =

Undocumented

__free_motion_button_topic =

Undocumented

__hardware_version =

Undocumented