From feb89d498ad77d272683fc2c4336c70c9d7be2c8 Mon Sep 17 00:00:00 2001 From: watts Date: Wed, 26 Oct 2022 14:43:33 +0200 Subject: [PATCH] Update Config_Controller --- Config_Controller.md | 104 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 87 insertions(+), 17 deletions(-) diff --git a/Config_Controller.md b/Config_Controller.md index 88b7adf..2bcf919 100644 --- a/Config_Controller.md +++ b/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**::
+## NewPort + +**serverAddress**::
 String value that defines the network address where the controller can be accessed. Used together with **serverPort**
+ **Default**: empty string - **serverPort**::
+**serverPort**::
 Integer value that defines the port over which the controller can be accessed. Used together with **serverAddress**
+ **Default**: 0 + +**timeout**::
+ Double value that defines the controller timeout in seconds.
+ **Default**: 1.0 - **deviceName**::
+## NexLine + +**serverAddress**::
+ String value that defines the network address where the controller can be accessed.
+ **Default**: empty string + +**serverPort**::
+ Integer value that defines the port over which the controller can be accessed.
+ **Default**: 0 + + +## SmarAct + +**deviceName**::
 String value that defines the filesystem path where the controller can be accessed.
+ **Default**: empty string - - **timeout**::
- Float value that defines the controller timeout.
- - - **loopName**::
- String value that defines which Orchestra loop the controller is associated with.
- - - **nAxes**::
- Integer value that defines the number of `axis` objects that the controller handles.
- - - **baudRate**::
+**baudRate**::
 Integer value that defines communication rate of the controller.
+ **Default**: 9600 + + +## SmarActUsb + +**deviceName**::
+ String value that defines the USB object name where the controller can be accessed.
+ **Default**: empty string + + +## SmarActTcp + +**ipAddress**::
+ String value that defines the network address where the controller can be accessed.
+ **Default**: empty string + +**port**::
+ Integer value that defines the port over which the controller can be accessed.
+ **Default**: 55551 + + +## Orchestra + +**loopName**::
+ String value that defines which Orchestra loop the controller is associated with.
+ **Default**: "ControlLoop" + +**Sensor3Name**::
+ String value that defines ???
+ **Default**: "AttoCube_Sensor" + +**nAxes**::
+ Integer value that defines the number of `axis` objects that the controller handles.
+ **Default**: 2 + + +## Zaber + +**deviceName**::
+ String value that defines the filesystem path where the controller can be accessed.
+ **Default**: empty string + +**baudRate**::
+ Integer value that defines communication rate of the controller.
+ **Default**: 9600 + + +## ZmiEpics + +**loopName**::
+ String value that defines which Orchestra loop the controller is associated with.
+ **Default**: "ControlLoop" + +**Sensor3Name**::
+ String value that defines ???
+ **Default**: "AttoCube_Sensor" + +**nAxes**::
+ Integer value that defines the number of `axis` objects that the controller handles.
+ **Default**: 2 +