MicroSpectro/Pixelator
Private
Public Access
11
1
Wiki

Update Config_Controller

watts
2022-10-26 14:43:33 +02:00
parent 65bddefa04
commit feb89d498a
1 changed files with 87 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
Config_Controller.md

@@ -12,28 +12,98 @@ Definition of a set of hardware controllers. The file contains a JSON structure
All further parameters are passed to the specific controller code without checking. Therefore, any default values or subtleties in usage will depend on the controller type.
**serverAddress**::<BR>
## NewPort
**serverAddress**::<BR>
&emsp;String value that defines the network address where the controller can be accessed. Used together with **serverPort**<BR>
&emsp;**Default**: empty string
**serverPort**::<BR>
**serverPort**::<BR>
&emsp;Integer value that defines the port over which the controller can be accessed. Used together with **serverAddress**<BR>
&emsp;**Default**: 0
**timeout**::<BR>
&emsp;Double value that defines the controller timeout in seconds. <BR>
&emsp;**Default**: 1.0
**deviceName**::<BR>
## NexLine
**serverAddress**::<BR>
&emsp;String value that defines the network address where the controller can be accessed.<BR>
&emsp;**Default**: empty string
**serverPort**::<BR>
&emsp;Integer value that defines the port over which the controller can be accessed.<BR>
&emsp;**Default**: 0
## SmarAct
**deviceName**::<BR>
&emsp;String value that defines the filesystem path where the controller can be accessed. <BR>
&emsp;**Default**: empty string
**timeout**::<BR>
&emsp;Float value that defines the controller timeout. <BR>
**loopName**::<BR>
&emsp;String value that defines which Orchestra loop the controller is associated with. <BR>
**nAxes**::<BR>
&emsp;Integer value that defines the number of `axis` objects that the controller handles. <BR>
**baudRate**::<BR>
**baudRate**::<BR>
&emsp;Integer value that defines communication rate of the controller. <BR>
&emsp;**Default**: 9600
## SmarActUsb
**deviceName**::<BR>
&emsp;String value that defines the USB object name where the controller can be accessed. <BR>
&emsp;**Default**: empty string
## SmarActTcp
**ipAddress**::<BR>
&emsp;String value that defines the network address where the controller can be accessed.<BR>
&emsp;**Default**: empty string
**port**::<BR>
&emsp;Integer value that defines the port over which the controller can be accessed.<BR>
&emsp;**Default**: 55551
## Orchestra
**loopName**::<BR>
&emsp;String value that defines which Orchestra loop the controller is associated with. <BR>
&emsp;**Default**: "ControlLoop"
**Sensor3Name**::<BR>
&emsp;String value that defines ??? <BR>
&emsp;**Default**: "AttoCube_Sensor"
**nAxes**::<BR>
&emsp;Integer value that defines the number of `axis` objects that the controller handles. <BR>
&emsp;**Default**: 2
## Zaber
**deviceName**::<BR>
&emsp;String value that defines the filesystem path where the controller can be accessed. <BR>
&emsp;**Default**: empty string
**baudRate**::<BR>
&emsp;Integer value that defines communication rate of the controller. <BR>
&emsp;**Default**: 9600
## ZmiEpics
**loopName**::<BR>
&emsp;String value that defines which Orchestra loop the controller is associated with. <BR>
&emsp;**Default**: "ControlLoop"
**Sensor3Name**::<BR>
&emsp;String value that defines ??? <BR>
&emsp;**Default**: "AttoCube_Sensor"
**nAxes**::<BR>
&emsp;Integer value that defines the number of `axis` objects that the controller handles. <BR>
&emsp;**Default**: 2