Qudi
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
simple_data_acq.SimpleAcq Class Reference

Read human readable numbers from serial port. More...

Inheritance diagram for simple_data_acq.SimpleAcq:
Inheritance graph
[legend]
Collaboration diagram for simple_data_acq.SimpleAcq:
Collaboration graph
[legend]

Public Member Functions

def on_activate (self)
 Activate module.
 
def on_deactivate (self)
 Deactivate module.
 
def getData (self)
 Read one value from serial port. More...
 
def getChannels (self)
 Number of channels. More...
 
- Public Member Functions inherited from core.module.BaseMixin
def __init__ (self, manager, name, config=None, callbacks=None, kwargs)
 Initialise Base class object and set up its state machine. More...
 
def log (self)
 Returns a logger object.
 
def is_module_threaded (self)
 Returns whether the module shall be started in a thread.
 
def on_activate (self)
 Method called when module is activated. More...
 
def on_deactivate (self)
 Method called when module is deactivated. More...
 
def getStatusVariables (self)
 Return a dict of variable names and their content representing the module state for saving. More...
 
def setStatusVariables (self, variableDict)
 Give a module a dict of variable names and their content representing the module state. More...
 
def getConfiguration (self)
 Return the configration dictionary for this module. More...
 
def get_connector (self, connector_name)
 Return module connected to the given named connector. More...
 
- Public Member Functions inherited from core.module.ModuleMeta
def __new__ (cls, name, bases, attrs)
 Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More...
 

Public Attributes

 rm
 
 my_instrument
 
- Public Attributes inherited from core.module.BaseMixin
 module_state
 
 connectors
 

Static Public Attributes

 resource = ConfigOption('interface', 'ASRL1::INSTR', missing='warn')
 
 baudrate = ConfigOption('baudrate', 115200, missing='warn')
 

Detailed Description

Read human readable numbers from serial port.

Example config for copy-paste:

simple_data_acq: module 'simple_data_acq.SimpleAcq' interface 'ASRL1::INSTR' baudrate 115200

Member Function Documentation

◆ getChannels()

def simple_data_acq.SimpleAcq.getChannels (   self)

Number of channels.

Returns
int: number of channels

◆ getData()

def simple_data_acq.SimpleAcq.getData (   self)

Read one value from serial port.

Returns
int: vaue form serial port

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