MagnetController
Namespace: Endorphin.Instrument.Twickenham.MagnetController
Parent Module: Instrument
Functions posting comands and performing queries to a Twickenham Scientific superconducting magnet controller.
Nested types and modules
| Module | Description |
| Output | Functions related to setting the magnet controller output. |
| Ramp | Functions related to controlling output ramping for the magnet controller. |
| Settings | Functions related to the magnet controller settings. |
Functions and values
| Function or value | Description |
closeInstrument(arg1)
Signature: MagnetController -> Async<unit>
|
Closes a connection to a Twickenham Scientific superconducting magnet controller. |
openInstrument(...)
Signature: visaAddress:string -> timeout:int<MeasureProduct<ms,MeasureOne>> -> settings:Settings -> Async<MagnetController>
|
Opens a connection to a Twickenham Scientific superconducting magnet controller with the specified VISA address and settings. |
queryCurrentParameters
Signature: MagnetController -> Async<CurrentParameters>
|
Queries the current parameters of the magnet controller, containing the ramp target and flags indicating whether the target has been reached and whether ramping is paused. |
queryOperatingParameters
Signature: MagnetController -> Async<OperatingParameters>
|
Queries the operating parameters of the magnet controller, containing the ramp rate and current direction. |
queryOutputParameters
Signature: MagnetController -> Async<OutputParameters>
|
Queries the output parameters of the magnet controller, containing the output current, voltage and ramp target. |
querySetPointParameters
Signature: MagnetController -> Async<SetPointParameters>
|
Queries the set-point parameters of the magnet controller, containing the lower and upper set points and the trip voltage. |
settings(arg1)
Signature: MagnetController -> Settings
|
Gets the settings for the magnet controller. |
