From 67ca02d6c309ca7db49d43b1be4ebe67ae84de4a Mon Sep 17 00:00:00 2001 From: watts Date: Wed, 19 Oct 2022 14:51:07 +0200 Subject: [PATCH] Update Config_Detector --- Config_Detector.md | 78 +++++++++++++++++++++++++++++++++++----------- 1 file changed, 59 insertions(+), 19 deletions(-) diff --git a/Config_Detector.md b/Config_Detector.md index b3ec128..cdd449c 100644 --- a/Config_Detector.md +++ b/Config_Detector.md @@ -12,7 +12,7 @@ Definitions of the set of detector hardware available. The file contains a JSON `enum Type { Base, Counter, Analog, Interferometer, Orchestra, Epics, Tcp, Zmq };` **subType**::
- String value that defines how the detector.
+ String value that defines how the detector. Only current usage is "time" for a "Base"-type detector that reports the linux epoch (clock value in terms of seconds since 1970).
 **Default**: empty string **nexus_name**::
@@ -48,6 +48,20 @@ Definitions of the set of detector hardware available. The file contains a JSON Further configuration parameters are type-dependent. +## Counter + + **devicePath**::
+ String value that defines the filesystem address of the device. May be used together with **subdevice** and **channel**
+ + **subdevice**::
+ Integer value that defines part of a device address. May be used together with **devicePath** and **channel**.
+ **Default**: 0 + + **clockSource**::
+ Integer value that defines the address of the clock used to define the counting time intervals.
+ **Default**: 0 + +## Analog **devicePath**::
 String value that defines the filesystem address of the device. May be used together with **subdevice** and **channel**
@@ -57,43 +71,69 @@ Further configuration parameters are type-dependent.  **Default**: 0 **channel**::
-* "Counter" type: Integer value that defines part of a device address. Used together with **devicePath** and **subdevice**.
+ Integer value that defines part of a device address. Used together with **devicePath** and **subdevice**.
 **Default**: 0 -* "Epics" type: String value that defines the EPICS channel that the detector will source data from.
- **Default**: empty string - **clockSource**::
- Integer value that defines the address of the clock used to define the counting time intervals.
- **Default**: 0 +## Orchestra and Interferometer **controller**::
 String value that defines the controller that handles the detector.
- **axis**::
 Integer value that defines which axis the "Interferometer" type detector measures along.
 **Default**: 0 +## Epics + + **channel**::
+ String value that defines the EPICS channel that the detector will source data from.
+ **Default**: empty string + + **channeldetails**::
+ String value that defines ???.
+ **Default**: empty string + **setTimeChannel**::
- String value that defines ??? for an "Epics" detector.
+ String value that defines (for an "Epics" detector) the EPICS channel that should be given the dwell time for a measurement. This is commonly used for the exposure setting of an area detector.
+ **Default**: empty string + + **channelStart**::
+ String value that defines ???
+ **Default**: empty string + + **channelCtr**::
+ String value that defines ???
+ **Default**: empty string + + **channelFilename**::
+ String value that defines the EPICS channel where _Pixelator_ provides the file name where the detector should record data during the scan. This is for cases where the detector sends the full data directly to the file and only the summary data is sent to _Pixelator_.
+ **Default**: empty string + + **channelFilepath**::
+ String value that defines the EPICS channel where _Pixelator_ provides the file path where the detector should record data during the scan. To be used together with **channelFilenam**.
+ **Default**: empty string + + **hardwareTimeFactor**::
+ Double value that defines if .
 **Default**: ? + **hardwareTimeOffset**::
+ Double value that defines if .
+ **Default**: ? + + **getDataTimeout**::
+ Double value that defines the number of seconds to wait for data to be received before moving on to the next scan point.
+ **Default**: 0.15 + **details**::
- Integer value that defines ??? for an "Epics" detector.
- **Default**: ? - - **description**::
- String value that describes the detector.
- **Default**: ? + Integer value that defines the length of the data array (always 1D and zero-based) that will be returned by an "Epics" detector. Note that Pixelator requires detectors to additionally return a summary of the data array as a single value per scan point.
+ **Default**: 0 ****::
 Integer value that defines if .
 **Default**: ? ****::
- Integer value that defines if .
+ Integer value that defines
 **Default**: ? - ****::
- Integer value that defines if .
- **Default**: ? \ No newline at end of file