TwinCAT Library for PZT Driver

Transcription

1 LIGO Laboratory / LIGO Scientific Collaboration LIGO- E v2 Advanced LIGO 2/7/2018 TwinCAT Library for PZT Driver Daniel Sigg Distribution of this document: LIGO Scientific Collaboration This is an internal working note of the LIGO Laboratory. California Institute of Technology LIGO Project MS E. California Blvd. Pasadena, CA Phone (626) Fax (626) info@ligo.caltech.edu Massachusetts Institute of Technology LIGO Project NW Albany St Cambridge, MA Phone (617) Fax (617) info@ligo.mit.edu LIGO Hanford Observatory P.O. Box 159 Richland WA Phone Fax LIGO Livingston Observatory P.O. Box 940 Livingston, LA Phone Fax

2 Library Title Version 1 TwinCAT version 2.11 Name space Author PztDriver Daniel Sigg Interfaces the PZT driver, D This library provides a function block to support a single channel of the 4-channel PZT driver. The board has a voltage monitor that represents the PZT output driver voltage, and an offset adjustment. The offset adjustment is controlled locally or externally using the front panel D-sub connector. Calibration parameters and min/max voltages are used to calibrate the voltage monitor and the offset adjustment. Each PZT driver also supports optional low and high limits; the user chooses which ones to enforce. The hardware readbacks of the power ok and external switch are daisy chained among the 4 channels of a board. Error codes Each PZT implements a scan feature with an option trigger to stop the scan. This can be used to scan an optical resonator and trigger on the transmitted power to find a resonance. Both scan and trigger fuinctionality are supported at a fast update rate. PZT Driver: 0x01 Power supply voltages out-of-range 0x02 External offset adjustment switch 0x04 PZT gain is zero 0x08 PZT monitor gain is zero 0x10 Drive voltage out-of-range 0x20 PZT voltage too low 0x40 PZT voltage too high 0x80 Power limits exceeded (either too low or too high) 0x100 Scan/trigger error PZT Scan: 0x01 Illegal period 0x02 Trigger error Library dependencies Trigger: 0x01 Illegal parameters 0x02 Timeout Error, ReadADC, WriteDAC, SaveRestore 2

3 Hardware Input Type TYPE PztDriverInStruct: Monitor: PowerOk: External: END_ Element Element Element INT; PztDriverInStruct Structure of the hardware inputs that are wired up for the PZT Name: Monitor Type: INT : Monitors the PZT voltage Name: PowerOk : Voltage monitor readback Name: External : Monitors the external switch state Hardware Output Type TYPE PztDriverOutStruct: Offset: PowerOk: External: END_ Element Element Element INT; PztDriverOutStruct Structure of the hardware output that are wired up for the PZT Name: Offset Type: INT : Offset applied to the PZT Name: PowerOk : Voltage monitor readback (daisy chained from input) Name: External : Monitors the external switch state (daisy chained from input) 3

4 User Interface Type TYPE PztDriverEnum : (HVPZT, MVPZT, LVPZT); PztDriverEnum List of available PZT driver configurations ENUM Name: HVPZT : High voltage PZT driver (-120V to +240V) Name: MVPZT : Medium voltage PZT driver (-10V to +200V) Name: LVPZT : Low voltage PZT driver (-10V to +120V) User Interface Type TYPE PztDriverLimitsEnum : (PztLimitsNone, PztLimitsLow, PztLimitsHigh, PztLimitsHiLo); PztDriverLimitsEnum List of optional limit choices ENUM Name: PztLimitsNone : No limit Name: PztLimitsLow : Check low limit Name: PztLimitsHigh : Check high limit Name: PztLimitsHiLo : Check low and high limit 4

5 User Interface Type TYPE PztScanWaveformEnum : (ScanSawtooth, ScanTriangle, ScanSine, ScanSquarewave); PztScanWaveformEnum List of scan waveformt choices ENUM Name: ScanSawtooth : Sawtooth waveform Name: ScanTriangle : Trinagular waveform Name: ScanSine : Sinewave Name: ScanSquarewave : Squarewave User Interface Type TYPE TriggerSelectionEnum : (TrigEdge, TrigLevel); TriggerSelectionEnum List of available trigger selection choices ENUM Name: TrigEdge : Triggers on edges only Name: TrigLevel : Triggers on levele User Interface Type TYPE TriggerSlopeEnum : (TrigPositive, TrigNegative, TrigBoth); TriggerSlopeEnum List of available trigger slope choices ENUM Name: TrigPositive : Triggers on positive edges or upon an exceeded level Name: TrigNegative : Triggers on negative edges or below a level Name: TrigBoth : Triggers on either negative edges (not relevant for level) 5

6 User Interface Type TYPE TriggerStruct : Error: Selection: Slope: Reset: Arm: Event: Timeout: TimeoutError: Value: Level: END_ ErrorStruct; TriggerSelectionEnum; TriggerSlopeEnum; TriggerStruct Structure of the user interface tags that is used to define a trigger Name: Error Type: ErrorStruct : Error handling Name: Selection Type: TriggerSelectionEnum : Type of trigger (Edge or level) Name: Slope Type: TriggerSlopeEnum : Select the slope/level for the trigger Name: Reset : Resets the trigger (Arm, Event and TimeoutError) Name: Arm : Arms the trigger (value is reset when trigger is met) Name: Event : A trigger event has happened Name: Timeout : Timeout for trigger in sec 6

7 Name: TimeoutError : Trigger has timed out Name: Value : Trigger input signal Name: Level : Level to trigger at, above or below 7

8 User Interface Type TYPE PztScanStruct : Error: Enable: UseTrigger: Reset: Waveform: Period: Trigger: Start: Stop: Offset: Previous: END_ ErrorStruct; PztScanWaveformEnum; TriggerStruct; PztScanStruct Structure of the user interface tags that sets up a PZT scan Name: Error Type: ErrorStruct : Error handling Name: Enable : Enables the scanning Name: UseTrigger : Use the trigger to stop the scan Name: Reset : Resets the scan (Enable, Previous, Offset and Trigger) Name: Waveform Type: PztScanWaveformEnum : Selects the scanning waveform Name: Period : Period of the waveform in sec Name: Trigger Type: TriggerStruct : Trigger parameters 8

9 Name: Start : Start offset for the scan waveform Name: Stop : Stop offset for the scan waveform Name: Offset : Current offset of scanning waverform Name: Previous : Offset when last trigger event happened 9

10 User Interface Type TYPE PztDriverStruct: Error: PztDriverType: Volts: Offset: Monitor: Drive: PztLow: PztHigh: PztGain: PztMonGain: PztOffset: Limits: Range: Low: High: Normalized: External: ExternalNom: PowerOk: PztDriverStruct ErrorStruct; PztDriverEnum; PztDriverLimitsEnum; Structure of the user interface tags that are used to control the PZT driver Name: Error Type: ErrorStruct : Error handling Name: PztDriverType Type: PztDriverEnum : PZT driver type Name: Volts : Represents the PZT driver output voltage in V Name: Offset : Offset to the PZT driver output in V Name: Monitor : Monitor readback voltage (used to derive Volts) 10

11 In/Out Tag Name: Drive : Output drive voltage for offset (derived from Offset) Name: PztLow : Low limit of PZT drive Name: PztHigh : High limit of PZT drive Name: PztGain : Gain of the PZT drive Name: PztMonGain : Inverse of the PZT monitor gain Name: PztOffset : Intrinsic offset of the PZT drive (usually 0) Name: Limits Type: PztDriverLimitsEnum : Specifies optional limits Name: Range : True, if limits exceeded Name: Low : Low limit for PZT output voltage Name: High : High limit for PZT output voltage Name: Normalized : Normalized output voltage, 100% is the absolute maximum of the allowed output voltage Name: External : Monitors the external switch state Name: ExternalNom : Nominal setting of the external switch state 11

12 Name: PowerOk : Voltages are ok 12

13 Function Block FUNCTION_BLOCK TriggerFB VAR_INPUT Request: SaveRestoreEnum := NoOp; VAR_IN_OUT Trigger: TriggerStruct; TriggerInit: TriggerStruct; Name In/out argument In/out argument TriggerFB Controls the setup of a trigger and checks for errors, but does not evaluate the trigger condition Name: Request Type: SaveRestoreEnum : Save/restore command Name: Trigger Type: TriggerStruct : Trigger parameters Name: TriggerInit Type: TriggerStruct : Trigger initialization parameters 13

14 Function Block FUNCTION_BLOCK TriggerFastFB VAR_INPUT Value: VAR_IN_OUT Trigger: TriggerStruct; VAR_OUTPUT Event: Name In/out argument Output argument TriggerFastFB Evaluates the trigger condition (called by a fast updating task) Name: Value : Signal to trigger on Name: Trigger Type: TriggerStruct : Trigger parameters Name: Event : Indicates a trigger has happened 14

15 Function Block FUNCTION_BLOCK PztScanFB VAR_INPUT Request: SaveRestoreEnum; PztMin: LREAL := -1E9; PztMax: LREAL := +1E9; VAR_IN_OUT Scan: PztScanStruct; ScanInit: PztScanStruct; Name In/out argument In/out argument PztScanFB Controls the setup of a PZT scan, but does not calculate the waveform Name: Request Type: SaveRestoreEnum : Save/restore command Name: PztMin : Minimum voltage of the PZT output Name: PztMax : Maximum voltage of the PZT output Name: Scan Type: PztScanStruct : PZT scan parameters Name: ScanInit Type: PztScanStruct : PZT scan initialization parameters 15

16 Function Block FUNCTION_BLOCK PztScanFastFB VAR_INPUT Value: Tick: LREAL := 0.001; VAR_IN_OUT Scan: PztScanStruct; Name In/out argument PztScanFastFB Calculates the scan waveform (called by a fast updating task) Name: Value : Signal to trigger on Name: Tick : Tick of update task in sec Name: Scan Type: PztScanStruct : Scan parameters 16

17 Function Block FUNCTION_BLOCK PztDriverFB VAR_INPUT Request: SaveRestoreEnum; PztDriverIn: PztDriverInStruct; VAR_IN_OUT PztDriverInit: PztDriverStruct; PztDriver: PztDriverStruct; Name In/out argument In/out argument PztDriverFB Sets up a channel of the PZT driver and checks for errors, but doesn t apply the offset Name: Request Type: SaveRestoreEnum : Save/restore command Name: PztDriverIn Type: PztDriverInStruct : Input hardware structure Name: PztDriverInit Type: PztDriverStruct : Interface structure for save/restore Name: PztDriver Type: PztDriverStruct : User Interface structure 17

18 Function Block FUNCTION_BLOCK PztDriverFastFB VAR_INPUT PztType: PztDriverEnum := LVPZT; PztMin: LREAL := -1E9; PztMax: LREAL := +1E9; PztGain: LREAL := 0; PztMonGain: LREAL := 0; PztOffset: LREAL := 0; Value: Tick: LREAL := 0.001; VAR_OUTPUT PztDriverOut: PztDriverOutStruct; VAR_IN_OUT PztDriver: PztDriverStruct; Name PztDriverFastFB Outputs the PZT voltage and applies the scan and trigger functions. Called by a fast updating task. The values for min, max, gain, mongain and offset will be initialized according to the selected PZT driver type, if left untouched. Name: PztType Type: PztDriverEnum Default: LVPZT : PZT driver type Name: PztDriverIn Type: PztDriverInStruct : Input hardware structure Name: PztMin : Minimum voltage of the PZT output Name: PztMax : Maximum voltage of the PZT output Name: PztGain : PZT gain 18

19 Output argument In/out argument Name: PztMonGain : Inverse of PZT monitor gain Name: PztOffset : Intrinsic PZT offset (usually 0) Name: Value : Signal to trigger on (used by the scan/trigger feature) Name: Tick : Tick of update task in sec (used by the scan) Name: PztDriverOut Type: PztDriverOutStruct : Output hardware structure Name: PztDriver Type: PztDriverStruct : User Interface structure 19