MicroSpectro/Pixelator
Private
Public Access
11
1
Wiki

Move Controller settings to new page

watts
2022-10-17 15:44:59 +02:00
parent d1bd0d5d04
commit db889dbe37
1 changed files with 3 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
PixelatorControllerSettings.md

@@ -126,7 +126,7 @@ Each of these settings files is described in a section below.
 [Axis](#axis)
**controllerConfigFileName**::<BR>
&emsp;[Controller](#controller)
&emsp;[Controller](Config_Controller)
**detectorConfigFileName**::<BR>
&emsp;[Detector](#detector)
@@ -150,7 +150,7 @@ Each of these settings files is described in a section below.
&emsp;[Polarization](#polarization)
**positionerConfigFileName**::<BR>
&emsp;[Positioner](#positioner)
&emsp;[Positioner](Config_Positioner)
**topupConfigFileName**::<BR>
&emsp;**Optional**: no topup handling when this setting is missing or the file cannot be read. <BR>
@@ -162,61 +162,6 @@ Each of these settings files is described in a section below.
## Axis
Definition of coordinate axes names to be referenced by positioners with the **axisName** setting.
## Controller
Definition of a set of hardware controllers.
**type**::<BR>
&emsp;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**::<BR>
&emsp;Integer value that defines if the controller should be used (value of 1) or ignored (value of 0). <BR>
&emsp;**Default**: 0
**serverAddress**::<BR>
&emsp;String value that defines the network address where the controller can be accessed. Used together with **serverPort**<BR>
&emsp;**Default**: ?
**serverPort**::<BR>
&emsp;Integer value that defines the port over which the controller can be accessed. Used together with **serverAddress**<BR>
&emsp;**Default**: ?
**deviceName**::<BR>
&emsp;String value that defines the filesystem path where the controller can be accessed. <BR>
&emsp;**Default**: ?
**timeout**::<BR>
&emsp;Float value that defines the controller timeout. <BR>
&emsp;**Default**: ?
**loopName**::<BR>
&emsp;String value that defines which Orchestra loop the controller is associated with. <BR>
&emsp;**Default**: ?
**nAxes**::<BR>
&emsp;Integer value that defines the number of `axis` objects that the controller handles. <BR>
&emsp;**Default**: ?
**baudRate**::<BR>
&emsp;Integer value that defines communication rate of the controller. <BR>
&emsp;**Default**: ?
## Detector
Definitions of the set of detector hardware available.
**active**::<BR>
&emsp;Integer value that defines if the detector should be used (value of 1) or ignored (value of 0). <BR>
&emsp;**Default**: 0
**type**::<BR>
&emsp;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.
@@ -349,5 +294,4 @@ See source:trunk/PixelatorController/config/pixelClock.json for an example.
&emsp;Double value defines the timeout (in seconds) used in waitUntilDone(). running() is called until it returns false or until waitUntilDoneTimeout is exceeded.<BR>
&emsp;**Default**: 10.0
## Polarization
## Polarization