Methods to control slow (mechaincal) laser switching devices. More...
Inheritance diagram for switch_interface.SwitchInterface:
Collaboration diagram for switch_interface.SwitchInterface:
Public Member Functions | |
| def | getNumberOfSwitches (self) |
| Gives the number of switches connected to this hardware. More... | |
| def | getSwitchState (self, switchNumber) |
| Gives state of switch. More... | |
| def | getCalibration (self, switchNumber, state) |
| Get calibration parameter for switch. More... | |
| def | setCalibration (self, switchNumber, state, value) |
| Set calibration parameter for switch. More... | |
| def | switchOn (self, switchNumber) |
| Switch on. More... | |
| def | switchOff (self, switchNumber) |
| Switch off. More... | |
| def | getSwitchTime (self, switchNumber) |
| Give switching time for switch. More... | |
 Public Member Functions inherited from core.module.ModuleMeta | |
| def | __new__ (cls, name, bases, attrs) |
| Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More... | |
Detailed Description
Methods to control slow (mechaincal) laser switching devices.
Member Function Documentation
◆ getCalibration()
| def switch_interface.SwitchInterface.getCalibration | ( | self, | |
| switchNumber, | |||
| state | |||
| ) |
Get calibration parameter for switch.
- Parameters
-
int switchNumber: number of switch for which to get calibration parameter str switchState: state ['On', 'Off'] for which to get calibration parameter
- Returns
- str: calibration parameter fir switch and state.
◆ getNumberOfSwitches()
| def switch_interface.SwitchInterface.getNumberOfSwitches | ( | self | ) |
Gives the number of switches connected to this hardware.
- Returns
- int: number of swiches on this hardware
◆ getSwitchState()
| def switch_interface.SwitchInterface.getSwitchState | ( | self, | |
| switchNumber | |||
| ) |
Gives state of switch.
- Parameters
-
int switchNumber: number of switch
- Returns
- bool: True if on, False if off, None on error
◆ getSwitchTime()
| def switch_interface.SwitchInterface.getSwitchTime | ( | self, | |
| switchNumber | |||
| ) |
Give switching time for switch.
- Parameters
-
int switchNumber: number of switch
- Returns
- float: time needed for switch state change
◆ setCalibration()
| def switch_interface.SwitchInterface.setCalibration | ( | self, | |
| switchNumber, | |||
| state, | |||
| value | |||
| ) |
Set calibration parameter for switch.
- Parameters
-
int switchNumber: number of switch for which to get calibration parameter str switchState: state ['On', 'Off'] for which to get calibration parameter int value: calibration parameter to be set.
- Returns
- bool: True if suceeds, False otherwise
◆ switchOff()
| def switch_interface.SwitchInterface.switchOff | ( | self, | |
| switchNumber | |||
| ) |
Switch off.
- Parameters
-
int switchNumber: number of switch to be switched
- Returns
- bool: True if suceeds, False otherwise
◆ switchOn()
| def switch_interface.SwitchInterface.switchOn | ( | self, | |
| switchNumber | |||
| ) |
Switch on.
- Parameters
-
int switchNumber: number of switch to be switched
- Returns
- bool: True if suceeds, False otherwise
The documentation for this class was generated from the following file:
- interface/switch_interface.py
