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

Public Member Functions

def __init__ (self, port=None, baud=57600, timeout=5.0, fix_pyserial_for_test=False)
 
def handleLoggingRequest (self, data)
 
def handleParameterRequest (self, data)
 
def handleTimeRequest (self, data)
 
def processWriteQueue (self)
 
def requestTopics (self)
 
def run (self)
 
def send (self, topic, msg)
 
def sendDiagnostics (self, level, msg_text)
 
def setPublishSize (self, bytes)
 
def setSubscribeSize (self, bytes)
 
def setupPublisher (self, data)
 
def setupServiceClientPublisher (self, data)
 
def setupServiceClientSubscriber (self, data)
 
def setupServiceServerPublisher (self, data)
 
def setupServiceServerSubscriber (self, data)
 
def setupSubscriber (self, data)
 
def tryRead (self, length)
 
def txStopRequest (self, signal, frame)
 

Public Attributes

 buffer_in
 
 buffer_out
 
 callbacks
 
 fix_pyserial_for_test
 
 last_read
 
 last_write
 
 lastsync
 
 lastsync_lost
 
 lastsync_success
 
 port
 
 protocol_ver
 
 protocol_ver1
 
 protocol_ver2
 
 pub_diagnostics
 
 publishers
 
 read_lock
 
 services
 
 subscribers
 
 synced
 
 timeout
 
 write_lock
 
 write_queue
 
 write_thread
 

Private Member Functions

def _send (self, topic, msg)
 
def _write (self, data)
 

Detailed Description

    ServiceServer responds to requests from the serial device.

Definition at line 319 of file SerialClient.py.

Constructor & Destructor Documentation

def rosserial_python.SerialClient.SerialClient.__init__ (   self,
  port = None,
  baud = 57600,
  timeout = 5.0,
  fix_pyserial_for_test = False 
)
Initialize node, connect to bus, attempt to negotiate topics. 

Definition at line 324 of file SerialClient.py.

Member Function Documentation

def rosserial_python.SerialClient.SerialClient._send (   self,
  topic,
  msg 
)
private
Send a message on a particular topic to the device.

Definition at line 752 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient._write (   self,
  data 
)
private
Writes raw data over the serial port. Assumes the data is formatting as a packet. http://wiki.ros.org/rosserial/Overview/Protocol

Definition at line 744 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.handleLoggingRequest (   self,
  data 
)
Forward logging information from serial device into ROS. 

Definition at line 723 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.handleParameterRequest (   self,
  data 
)
Send parameters to device. Supports only simple datatypes and arrays of such. 

Definition at line 687 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.handleTimeRequest (   self,
  data 
)
Respond to device with system time. 

Definition at line 678 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.processWriteQueue (   self)
Main loop for the thread that processes outgoing data to write to the serial port.

Definition at line 770 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.requestTopics (   self)
Determine topics to subscribe/publish. 

Definition at line 402 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.run (   self)
Forward recieved messages to appropriate publisher. 

Definition at line 446 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.send (   self,
  topic,
  msg 
)
Queues data to be written to the serial port.

Definition at line 738 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.sendDiagnostics (   self,
  level,
  msg_text 
)

Definition at line 793 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setPublishSize (   self,
  bytes 
)

Definition at line 559 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setSubscribeSize (   self,
  bytes 
)

Definition at line 564 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setupPublisher (   self,
  data 
)
Register a new publisher. 

Definition at line 569 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setupServiceClientPublisher (   self,
  data 
)
Register a new service client. 

Definition at line 640 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setupServiceClientSubscriber (   self,
  data 
)
Register a new service client. 

Definition at line 659 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setupServiceServerPublisher (   self,
  data 
)
Register a new service server. 

Definition at line 602 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setupServiceServerSubscriber (   self,
  data 
)
Register a new service server. 

Definition at line 621 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setupSubscriber (   self,
  data 
)
Register a new subscriber. 

Definition at line 582 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.tryRead (   self,
  length 
)

Definition at line 426 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.txStopRequest (   self,
  signal,
  frame 
)
send stop tx request to arduino when receive SIGINT(Ctrl-c)

Definition at line 414 of file SerialClient.py.

Member Data Documentation

rosserial_python.SerialClient.SerialClient.buffer_in

Definition at line 380 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.buffer_out

Definition at line 379 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.callbacks

Definition at line 382 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.fix_pyserial_for_test

Definition at line 340 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.last_read

Definition at line 336 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.last_write

Definition at line 337 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.lastsync

Definition at line 333 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.lastsync_lost

Definition at line 334 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.lastsync_success

Definition at line 335 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.port

Definition at line 349 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.protocol_ver

Definition at line 373 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.protocol_ver1

Definition at line 371 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.protocol_ver2

Definition at line 372 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.pub_diagnostics

Definition at line 342 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.publishers

Definition at line 375 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.read_lock

Definition at line 327 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.services

Definition at line 377 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.subscribers

Definition at line 376 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.synced

Definition at line 339 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.timeout

Definition at line 338 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.write_lock

Definition at line 329 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.write_queue

Definition at line 330 of file SerialClient.py.

rosserial_python.SerialClient.SerialClient.write_thread

Definition at line 331 of file SerialClient.py.


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


rosserial_python
Author(s): Michael Ferguson
autogenerated on Mon Jun 10 2019 14:53:29