Public Member Functions | Private Attributes | List of all members
rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton Class Reference
Inheritance diagram for rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, breaker_name, breaker_index)
 
def control (self, breaker, cmd)
 
def control3 (self, cmd)
 
def on_disable (self)
 
def on_disable_all (self)
 
def on_enable (self)
 
def on_enable_all (self)
 
def on_standby (self)
 
def on_standby_all (self)
 
def reset (self)
 
def set_disable (self)
 
def set_disable_all (self)
 
def set_enable (self)
 
def set_enable_all (self)
 
def set_error (self)
 
def set_ok (self)
 
def set_power_board_state_msg (self, msg)
 
def set_stale (self)
 
def set_standby (self)
 
def set_standby_all (self)
 
def set_warn (self)
 

Private Attributes

 _index
 
 _last_status_msg
 
 _name
 
 _power_board_state
 
 _power_control
 
 _serial
 

Detailed Description

Dashboard widget to display and interact with the PR2 Breaker state.

Definition at line 47 of file pr2_breaker.py.

Constructor & Destructor Documentation

◆ __init__()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.__init__ (   self,
  breaker_name,
  breaker_index 
)
:param breaker_name: Name of the breaker
:type breaker_name: str
:param breaker_index: Index of the breaker
:type breaker_index: int

Definition at line 51 of file pr2_breaker.py.

Member Function Documentation

◆ control()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.control (   self,
  breaker,
  cmd 
)
Sends a PowerBoardCommand srv to the pr2

:param breaker: breaker index to send command to
:type breaker: int
:param cmd: command to be sent to the pr2 breaker
:type cmd: str

Definition at line 96 of file pr2_breaker.py.

◆ control3()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.control3 (   self,
  cmd 
)

Definition at line 128 of file pr2_breaker.py.

◆ on_disable()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.on_disable (   self)

Definition at line 143 of file pr2_breaker.py.

◆ on_disable_all()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.on_disable_all (   self)

Definition at line 152 of file pr2_breaker.py.

◆ on_enable()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.on_enable (   self)

Definition at line 137 of file pr2_breaker.py.

◆ on_enable_all()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.on_enable_all (   self)

Definition at line 146 of file pr2_breaker.py.

◆ on_standby()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.on_standby (   self)

Definition at line 140 of file pr2_breaker.py.

◆ on_standby_all()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.on_standby_all (   self)

Definition at line 149 of file pr2_breaker.py.

◆ reset()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.reset (   self)

Definition at line 215 of file pr2_breaker.py.

◆ set_disable()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.set_disable (   self)

Definition at line 167 of file pr2_breaker.py.

◆ set_disable_all()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.set_disable_all (   self)

Definition at line 182 of file pr2_breaker.py.

◆ set_enable()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.set_enable (   self)

Definition at line 155 of file pr2_breaker.py.

◆ set_enable_all()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.set_enable_all (   self)

Definition at line 170 of file pr2_breaker.py.

◆ set_error()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.set_error (   self)

Definition at line 225 of file pr2_breaker.py.

◆ set_ok()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.set_ok (   self)

Definition at line 219 of file pr2_breaker.py.

◆ set_power_board_state_msg()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.set_power_board_state_msg (   self,
  msg 
)
Sets state of button based on msg

:param msg: message containing the PR2 powerboard state
:type msg: pr2_msgs.msg.PowerBoardState

Definition at line 185 of file pr2_breaker.py.

◆ set_stale()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.set_stale (   self)

Definition at line 228 of file pr2_breaker.py.

◆ set_standby()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.set_standby (   self)

Definition at line 161 of file pr2_breaker.py.

◆ set_standby_all()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.set_standby_all (   self)

Definition at line 176 of file pr2_breaker.py.

◆ set_warn()

def rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton.set_warn (   self)

Definition at line 222 of file pr2_breaker.py.

Member Data Documentation

◆ _index

rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton._index
private

Definition at line 90 of file pr2_breaker.py.

◆ _last_status_msg

rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton._last_status_msg
private

Definition at line 93 of file pr2_breaker.py.

◆ _name

rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton._name
private

Definition at line 91 of file pr2_breaker.py.

◆ _power_board_state

rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton._power_board_state
private

Definition at line 92 of file pr2_breaker.py.

◆ _power_control

rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton._power_control
private

Definition at line 88 of file pr2_breaker.py.

◆ _serial

rqt_pr2_dashboard.pr2_breaker.PR2BreakerButton._serial
private

Definition at line 89 of file pr2_breaker.py.


The documentation for this class was generated from the following file:


rqt_pr2_dashboard
Author(s): Aaron Blasdel
autogenerated on Fri Jul 26 2024 02:34:09