Switch: Difference between revisions
| Line 20: | Line 20: | ||
To use the section 'Configuration' of the GUI, one does not need to insert additional functions. When the button 'Set value' is used, the standard semantic functions [[connnect]], [[initialize]], [[configure]], [[start]] and [[apply]] are called. The new set value 'self.value' is automatically handed over and cooresponds to value in the field 'Configuration' of the GUI. When the stop button is clicked, the standard semantic functions [[connect]], [[unconfigure]], [[deinitialize]], [[disconnect]] are called. As the programmer of the driver, you just have to make sure that after calling these functions, the new set value is either applied or the instrument is stopped. | To use the section 'Configuration' of the GUI, one does not need to insert additional functions. When the button 'Set value' is used, the standard semantic functions [[connnect]], [[initialize]], [[configure]], [[start]] and [[apply]] are called. The new set value 'self.value' is automatically handed over and cooresponds to value in the field 'Configuration' of the GUI. When the stop button is clicked, the standard semantic functions [[connect]], [[unconfigure]], [[deinitialize]], [[disconnect]] are called. As the programmer of the driver, you just have to make sure that after calling these functions, the new set value is either applied or the instrument is stopped. | ||
=== Apply & Stop buttons === | |||
In the test section of the module, there are the button "Apply" and "Stop" that can be used to do basic communication tests with the driver. | |||
These buttons trigger a series of semantic standard functions so that each driver automatically supports these buttons if semantic standard functions are correctly filled. | |||
Apply triggers the following functions: | |||
* connect | |||
* initialize | |||
* configure | |||
* poweron | |||
* signin | |||
* start | |||
* apply | |||
* disconnect | |||
Stop triggers the following functions: | |||
* connect | |||
* signout | |||
* unconfigure | |||
* poweroff | |||
* deinitialize | |||
* disconnect | |||
[[Category:Modules]] | [[Category:Modules]] | ||
[[Category:Device Modules]] | [[Category:Device Modules]] | ||
Revision as of 18:02, 24 March 2023
The Switch module is generic one that can be used to create and load instrument drivers that do not match to any of the more specific device modules.
Typical instruments
Typical instruments are ones where the main task is to apply a value rather than reading values.
- Motor
- Relais or switching matrix
- Lamp
- Digital or analog outputs
- Filter wheel
GUI
The Switch module has a section 'Configuration' that can be used to apply a value according to the current Sweep Mode. It can be used to apply a value and stop the instrument if no measurement is running in order to test the instrument or to apply a value to adjust the setup.
Device class programming
The module Switch has the standard fields 'Label', 'Device', 'Port', and 'Channel'. Further parameters can be arbitrarily chosen and will be presented in the field 'Paremeters'. How to creaete drivers and define custom user input fields is described on the page Device Class Programming.
To use the section 'Configuration' of the GUI, one does not need to insert additional functions. When the button 'Set value' is used, the standard semantic functions connnect, initialize, configure, start and apply are called. The new set value 'self.value' is automatically handed over and cooresponds to value in the field 'Configuration' of the GUI. When the stop button is clicked, the standard semantic functions connect, unconfigure, deinitialize, disconnect are called. As the programmer of the driver, you just have to make sure that after calling these functions, the new set value is either applied or the instrument is stopped.
Apply & Stop buttons
In the test section of the module, there are the button "Apply" and "Stop" that can be used to do basic communication tests with the driver. These buttons trigger a series of semantic standard functions so that each driver automatically supports these buttons if semantic standard functions are correctly filled.
Apply triggers the following functions:
- connect
- initialize
- configure
- poweron
- signin
- start
- apply
- disconnect
Stop triggers the following functions:
- connect
- signout
- unconfigure
- poweroff
- deinitialize
- disconnect