Qudi
Public Member Functions | Public Attributes | List of all members
ok_s6_switch.HardwareSwitchFpga Class Reference
Inheritance diagram for ok_s6_switch.HardwareSwitchFpga:
Inheritance graph
[legend]
Collaboration diagram for ok_s6_switch.HardwareSwitchFpga:
Collaboration graph
[legend]

Public Member Functions

def on_activate (self)
 Connect and configure the access to the FPGA.
 
def on_deactivate (self)
 Deactivate the FPGA.
 
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 reset (self)
 Reset TTL outputs to zero.
 
def getCalibration (self, switchNumber, state)
 
def setCalibration (self, switchNumber, state, value)
 
def getSwitchTime (self, switchNumber)
 Give switching time for switch. 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

 threadlock
 
- Public Attributes inherited from core.module.BaseMixin
 module_state
 
 connectors
 

Member Function Documentation

◆ getNumberOfSwitches()

def ok_s6_switch.HardwareSwitchFpga.getNumberOfSwitches (   self)

There are 8 TTL channels on the OK FPGA.

Chan PIN

Ch1 B14 Ch2 B16 Ch3 B12 Ch4 C7 Ch5 D15 Ch6 D10 Ch7 D9 Ch8 D11

Returns
int: number of switches

◆ getSwitchState()

def ok_s6_switch.HardwareSwitchFpga.getSwitchState (   self,
  channel 
)

Gives state of switch.

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

◆ getSwitchTime()

def ok_s6_switch.HardwareSwitchFpga.getSwitchTime (   self,
  switchNumber 
)

Give switching time for switch.

Parameters
intswitchNumber: number of switch
Returns
float: time needed for switch state change

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