Qudi
Public Member Functions | Public Attributes | List of all members
ok_fpga_switch.OkFpgaTtlSwitch Class Reference

Methods to control TTL switch running on OK FPGA. More...

Inheritance diagram for ok_fpga_switch.OkFpgaTtlSwitch:
Inheritance graph
[legend]
Collaboration diagram for ok_fpga_switch.OkFpgaTtlSwitch:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, kwargs)
 
def on_activate (self)
 
def on_deactivate (self)
 
def reset (self)
 
def getNumberOfSwitches (self)
 There are 8 TTL channels on the OK FPGA. More...
 
def getSwitchState (self, channel)
 Gives state of switch. More...
 
def switchOn (self, channel)
 
def switchOff (self, channel)
 
def getCalibration (self, switchNumber, state)
 
def setCalibration (self, switchNumber, state, value)
 
def getSwitchTime (self, switchNumber)
 
- 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

 lock
 
 fp
 
- Public Attributes inherited from core.module.BaseMixin
 module_state
 
 connectors
 

Detailed Description

Methods to control TTL switch running on OK FPGA.

Example config for copy-paste:

fpga_ok_switch: module 'switches.ok_fpga.ok_fpga_switch.OkFpgaTtlSwitch'

Member Function Documentation

◆ getNumberOfSwitches()

def ok_fpga_switch.OkFpgaTtlSwitch.getNumberOfSwitches (   self)

There are 8 TTL channels on the OK FPGA.

Chan PIN

Ch1 D10 Ch2 D15 Ch3 C7 Ch4 B12 Ch5 B16 Ch6 B14 Ch7 C17 Ch8 C13

Returns
int: number of switches

◆ getSwitchState()

def ok_fpga_switch.OkFpgaTtlSwitch.getSwitchState (   self,
  channel 
)

Gives state of switch.

Parameters
intswitchNumber: number of switch
Returns
bool: True if on, False if off, None on error

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