From d1bd0d5d04f9b1e5237c5995d75b03ef45fac63e Mon Sep 17 00:00:00 2001 From: watts Date: Mon, 17 Oct 2022 15:44:25 +0200 Subject: [PATCH] Create Config_Controller --- Config_Controller.md | 55 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 Config_Controller.md diff --git a/Config_Controller.md b/Config_Controller.md new file mode 100644 index 0000000..709a553 --- /dev/null +++ b/Config_Controller.md @@ -0,0 +1,55 @@ +# 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 };` + +