plux.SignalsDev Class Reference

Base class for PLUX signal-acquiring devices. More...

Inheritance diagram for plux.SignalsDev:

Public Member Functions
	__init__ (self, path)
	Connects to a PLUX device.
	__init__ (self, baseDev)
	Promotes a BaseDev instance to SignalsDev.
	getSensors (self)
	Returns information about attached sensors and internal sensors.
	start (self, baseFreq, sources)
	Starts a real-time acquisition session.
	start (self, freq, portMask, nBits)
	Starts a real-time acquisition session.
	start (self, freq, ports, nBits)
	Starts a real-time acquisition session.
	stop (self)
	Stops a real-time acquisition session.
	getNumChannels (self)
	Returns the total number of acquisition channels.
	setDOut (self, state)
	Sets the digital output state.
	onRawFrame (self, nSeq, data)
	Raw frames callback.
Public Member Functions inherited from plux.BaseDev
	getProperties (self)
	Returns the device properties.
	setParameter (self, port, index, data)
	Sets a system or sensor parameter value.
	getBattery (self)
	Returns a float number with the remaining battery charge as a percentage of full capacity.
	setTimeout (self, timeout=-1)
	Sets the receiving timeout value for loop().
	loop (self)
	Runs the device message loop.
	interrupt (self, param=None)
	Sends an interrupt signal to loop().
	onEvent (self, event)
	Event callback.
	onTimeout (self)
	Timeout callback.
	onInterrupt (self, param)
	Interrupt signal callback.
	close ()
	Disconnects from the device.

Additional Inherited Members
Static Public Member Functions inherited from plux.BaseDev
	findDevices (domain='')
	Finds PLUX devices within the given domain.

Detailed Description

Base class for PLUX signal-acquiring devices.

Constructor & Destructor Documentation

__init__() [1/2]

plux.SignalsDev.__init__	(		self,
			path
	)

Connects to a PLUX device.

Parameters

path	A string with the path to the PLUX device. It has the same meaning as in BaseDev.__init__().

Reimplemented from plux.BaseDev.

Reimplemented in plux.MemoryDev, plux.BITalinoDev, plux.MemoryDev, and plux.BITalinoDev.

__init__() [2/2]

plux.SignalsDev.__init__	(		self,
			baseDev
	)

Promotes a BaseDev instance to SignalsDev.

Parameters

baseDev

The BaseDev instance to be promoted. If promotion is successful, baseDev is no longer valid.

Reimplemented from plux.BaseDev.

Reimplemented in plux.MemoryDev, plux.BITalinoDev, plux.MemoryDev, and plux.BITalinoDev.

Member Function Documentation

getSensors()

plux.SignalsDev.getSensors

(

self

)

Returns information about attached sensors and internal sensors.

The data is returned as a dictionary of Sensor objects indexed by each sensor port.

start() [1/3]

plux.SignalsDev.start	(		self,
			baseFreq,
			sources
	)

Starts a real-time acquisition session.

Parameters

baseFreq	Acquisition base sampling frequency in Hertz.
sources	A sequence of Source objects, or a single Source object. Each Source object represents a signal source to acquire.

Remarks

This method is not supported on BITalino devices.

start() [2/3]

plux.SignalsDev.start	(		self,
			freq,
			portMask,
			nBits
	)

Starts a real-time acquisition session.

This method is a shortcut to start(self, baseFreq, sources). It can be called if all requested sources are to be sampled at the same frequency and resolution, and at their channel 0 only.

Parameters

freq	Acquisition sampling frequency in Hertz.
portMask	An integer representing a bitmask of the device ports to acquire. The least significant bit corresponds to port 1, the next bit to port 2, etc. See Source.port.
nBits	Sampling resolution in bits. It can be 8 or 16. This parameter is ignored for BITalino devices.

start() [3/3]

plux.SignalsDev.start	(		self,
			freq,
			ports,
			nBits
	)

Starts a real-time acquisition session.

This method is a shortcut to start(self, baseFreq, sources). It can be called if all requested sources are to be sampled at the same frequency and resolution, and at their channel 0 only.

Parameters

freq	Acquisition sampling frequency in Hertz.
ports	A sequence of integers representing the ports to acquire. See Source.port.
nBits	Sampling resolution in bits. It can be 8 or 16. This parameter is ignored for BITalino devices.

stop()

plux.SignalsDev.stop

(

self

)

Stops a real-time acquisition session.

Remarks

Call MemoryDev.stopSessionAcq() to stop an internal acquisition session.

getNumChannels()

plux.SignalsDev.getNumChannels

(

self

)

Returns the total number of acquisition channels.

The returned value is the total number of channels across all the acquisition sources, or zero if the device is stopped. This value is the number of elements of the data tuple passed to the onRawFrame() callback.

setDOut()

plux.SignalsDev.setDOut	(		self,
			state
	)

Sets the digital output state.

Parameters

state

A boolean to define output state. If True, output is set to High, otherwise it is set to Low.

Remarks

On BITalino devices, only the first output (O1) is assigned to the given state. The other outputs are set to Low. Call BITalinoDev.setDOut() to assign all digital outputs.

Reimplemented in plux.BITalinoDev.

onRawFrame()

plux.SignalsDev.onRawFrame	(		self,
			nSeq,
			data
	)

Raw frames callback.

This callback is called by message loop when a real-time data acquisition frame is received from the device. In order to receive data frames, an application must derive SignalsDev class (or any of its derived classes) to a new class and override this method in the new class.

Parameters

nSeq

The sequence number of the frame. This number is zero for the first frame of the acquisition session, and then incremented by one for every subsequent frame. If this number differs more than one between consecutive frames, it means that data frames for the missing sequence numbers were lost, possibly due to connection problems.

data

The frame sampling data as a tuple of integers. Each value is acquired from a channel of each requested source, in the same source order as given in start(self, baseFreq, sources), or in the same port order as given in start(self, freq, ports, nBits), or from lower ports to higher ports in start(self, freq, portMask, nBits). For each multi-channel source, the values are presented from lower channels to higher channels. The values range for 16-bit samples is 0...65535 and for 8-bit samples is 0...255 . The values for a source with a frequency divisor greater than one are updated only in the frames with a sequence number multiple of the frequency divisor value. The number of elements of this tuple can be obtained by calling getNumChannels().

Returns

Return True to exit message loop or False otherwise. Default callback returns False.