rosserial_python.SerialClient.SerialClient Class Reference

List of all members.

Public Member Functions
def	__init__
def	handleLoggingRequest
def	handleParameterRequest
def	handleTimeRequest
def	requestTopics
def	run
def	send
def	sendDiagnostics
def	setPublishSize
def	setSubscribeSize
def	setupPublisher
def	setupServiceClientPublisher
def	setupServiceClientSubscriber
def	setupServiceServerPublisher
def	setupServiceServerSubscriber
def	setupSubscriber
def	tryRead
def	txStopRequest
Public Attributes
	buffer_in
	buffer_out
	callbacks
	lastsync
	lastsync_lost
	mutex
	port
	protocol_ver
	protocol_ver1
	protocol_ver2
	pub_diagnostics
	publishers
	services
	subscribers
	synced
	timeout

---

Detailed Description

    ServiceServer responds to requests from the serial device.

Definition at line 322 of file SerialClient.py.

---

Constructor & Destructor Documentation

def rosserial_python.SerialClient.SerialClient.__init__	(		self,
			port = None,
			baud = 57600,
			timeout = 5.0
	)

Initialize node, connect to bus, attempt to negotiate topics. 

Definition at line 327 of file SerialClient.py.

---

Member Function Documentation

def rosserial_python.SerialClient.SerialClient.handleLoggingRequest	(		self,
			data
	)

Forward logging information from serial device into ROS. 

Definition at line 671 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 635 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.handleTimeRequest	(		self,
			data
	)

Respond to device with system time. 

Definition at line 625 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.requestTopics

(

self

)

Determine topics to subscribe/publish. 

Definition at line 390 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.run

(

self

)

Forward recieved messages to appropriate publisher. 

Definition at line 427 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.send	(		self,
			topic,
			msg
	)

Send a message on a particular topic to the device. 

Definition at line 686 of file SerialClient.py.

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

Definition at line 704 of file SerialClient.py.

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

Definition at line 508 of file SerialClient.py.

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

Definition at line 513 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setupPublisher	(		self,
			data
	)

Register a new publisher. 

Definition at line 518 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setupServiceClientPublisher	(		self,
			data
	)

Register a new service client. 

Definition at line 588 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setupServiceClientSubscriber	(		self,
			data
	)

Register a new service client. 

Definition at line 606 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setupServiceServerPublisher	(		self,
			data
	)

Register a new service server. 

Definition at line 551 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setupServiceServerSubscriber	(		self,
			data
	)

Register a new service server. 

Definition at line 569 of file SerialClient.py.

def rosserial_python.SerialClient.SerialClient.setupSubscriber	(		self,
			data
	)

Register a new subscriber. 

Definition at line 531 of file SerialClient.py.

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

Definition at line 404 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 396 of file SerialClient.py.

---

Member Data Documentation

rosserial_python::SerialClient.SerialClient::buffer_in

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::buffer_out

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::callbacks

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::lastsync

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::lastsync_lost

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::mutex

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::port

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::protocol_ver

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::protocol_ver1

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::protocol_ver2

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::pub_diagnostics

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::publishers

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::services

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::subscribers

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::synced

Definition at line 327 of file SerialClient.py.

rosserial_python::SerialClient.SerialClient::timeout

Definition at line 327 of file SerialClient.py.

---

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

• SerialClient.py