From 5a38f7897c06915efec7b48c575e675340e44687 Mon Sep 17 00:00:00 2001 From: watts Date: Mon, 17 Oct 2022 14:43:05 +0200 Subject: [PATCH] Update PixelatorControllerSettings --- PixelatorControllerSettings.md | 55 ++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/PixelatorControllerSettings.md b/PixelatorControllerSettings.md index e1fcb64..3d8a460 100644 --- a/PixelatorControllerSettings.md +++ b/PixelatorControllerSettings.md @@ -165,9 +165,59 @@ Definition of coordinate axes names to be referenced by positioners with the **a ## Controller Definition of a set of hardware controllers. + **type**::
+ String value that identifies which hardware interface will handle the controller behaviour. The set of allowed values is listed near the beginning of [`Controller.h`](https://gitlab.psi.ch/microspectro/pixelator/-/blob/master/PixelatorController/src/Controller.h#L19), for example: + +`enum Type { NewPort, NexLine, SmarAct, SmarActUsb, SmarActTcp, Orchestra, Galil, Zaber, ZmiEpics };` + + **active**::
+ Integer value that defines if the controller should be used (value of 1) or ignored (value of 0).
+ **Default**: 0 + + **serverAddress**::
+ String value that defines the network address where the controller can be accessed. Used together with **serverPort**
+ **Default**: ? + + **serverPort**::
+ Integer value that defines the port over which the controller can be accessed. Used together with **serverAddress**
+ **Default**: ? + + **deviceName**::
+ String value that defines the filesystem path where the controller can be accessed.
+ **Default**: ? + + **timeout**::
+ Float value that defines the controller timeout.
+ **Default**: ? + + **loopName**::
+ String value that defines which Orchestra loop the controller is associated with.
+ **Default**: ? + + **nAxes**::
+ Integer value that defines the number of `axis` objects that the controller handles.
+ **Default**: ? + + **baudRate**::
+ Integer value that defines communication rate of the controller.
+ **Default**: ? + + ## Detector Definitions of the set of detector hardware available. + **active**::
+ Integer value that defines if the detector should be used (value of 1) or ignored (value of 0).
+ **Default**: 0 + + + **type**::
+ String value that identifies which hardware interface will handle the detector behaviour. The set of allowed values is listed near the beginning of [`Detector.h`](https://gitlab.psi.ch/microspectro/pixelator/-/blob/master/PixelatorController/src/Detector.h#L23), for example: + +`enum Type { Base, Counter, Analog, Interferometer, Orchestra, Epics, Tcp, Zmq };` + + + ## Epics This file contains global epics settings. @@ -319,6 +369,11 @@ The remaining entries are positioner names with their settings. The settings dep ### base settings The following settings are available for all types of positioners: + **type**::
+ String value that identifies which hardware interface will handle the positioner behaviour. The list of allowed values is listed near the beginning of [`Positioner.h`](https://gitlab.psi.ch/microspectro/pixelator/-/blob/master/PixelatorController/src/Positioner.h#L28), for example: + +`enum Type { Base, Epics, Tango, NewPort, NexLine, SmarAct, SmarActUsb, SmarActTcp, Interferometer, BeamShutter, AnalogOut, Transform, Galil, Zaber, ZmiEpics };` + **active**::
 Integer value that defines if the positioner should be used (value of 1) or ignored (value of 0).
 **Default**: 0