receiver.IPSReceiver Class Reference

Public Member Functions
def	__init__ (self, type, required, optional)
def	callback (self, msg)
def	publish (self)
def	shutdown (self)

Public Attributes
	con
	opt
	rate
	rec_pub
	rec_send_sub
	req
	type

Detailed Description

Use this class to establish a connection with the metraTec IPS receiver or USB stick and publish the received
messages to the ips/receiver/raw topic. The node also listens to the ips/receiver/send topic and invokes a
callback that forwards these messages to the connected receiver when it is updated.

Definition at line 39 of file receiver.py.

Constructor & Destructor Documentation

def receiver.IPSReceiver.__init__	(		self,
			type,
			required,
			optional
	)

Initialize IPS receiver class by passing the IP address the receiver or port the USB stick is connected to.
:param type: String: type of the connection, either 'tcp' or 'usb'
:param required: String: Either HOST_IP or USB_PORT of the receiver
:param optional: Int: Either TCP_PORT or BAUDRATE to use for the connection

Definition at line 45 of file receiver.py.

Member Function Documentation

def receiver.IPSReceiver.callback	(		self,
			msg
	)

Send message to connected device when /ips/receiver/send topic is updated.
:param msg: String: message to be sent to the connected device

Definition at line 76 of file receiver.py.

def receiver.IPSReceiver.publish

(

self

)

Publish raw receiver messages to the ips/receiver/raw topic.

Definition at line 85 of file receiver.py.

def receiver.IPSReceiver.shutdown

(

self

)

Close USB connection on shutdown.

Definition at line 99 of file receiver.py.

Member Data Documentation

receiver.IPSReceiver.con

Definition at line 61 of file receiver.py.

receiver.IPSReceiver.opt

Definition at line 57 of file receiver.py.

receiver.IPSReceiver.rate

Definition at line 74 of file receiver.py.

receiver.IPSReceiver.rec_pub

Definition at line 72 of file receiver.py.

receiver.IPSReceiver.rec_send_sub

Definition at line 70 of file receiver.py.

receiver.IPSReceiver.req

Definition at line 55 of file receiver.py.

receiver.IPSReceiver.type

Definition at line 53 of file receiver.py.

---

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

• receiver.py