From 605abee565634a8d6aef2137c112b6b0af356129 Mon Sep 17 00:00:00 2001 From: watts Date: Mon, 24 Oct 2022 14:33:19 +0200 Subject: [PATCH] Update Config_Positioner --- Config_Positioner.md | 53 ++++++++++++++++++++++++++++++-------------- 1 file changed, 36 insertions(+), 17 deletions(-) diff --git a/Config_Positioner.md b/Config_Positioner.md index 58c74f9..77c0705 100644 --- a/Config_Positioner.md +++ b/Config_Positioner.md @@ -13,7 +13,7 @@ See source:trunk/PixelatorController/config/positioner.json for an example. The remaining entries are positioner names with their settings. The settings depend on the positioner type. -### base settings +## base settings The following settings are available for all types of positioners: **type**::
@@ -25,25 +25,31 @@ The following settings are available for all types of positioners:  Integer value that defines if the positioner should be used (value of 1) or ignored (value of 0).
 **Default**: 0 - **nexus_name**::
- String value defines the positioners name in the hdf5 file.
- **Default**: positioner name - **axisName**::
 String value defines the name of the axis moved by this positioner.
 Example: Coarse and Fine X both belong to SampleX.
 **Default**: positioner name + **nexus_name**::
+ String value defines the positioners name in the hdf5 file.
+ **Default**: positioner name + + **readOnly**::
+ Boolean value true when the positioner can only be used to read its position (i.e. cannot request a move).
+ **Default**: false + **description**::
- String value describes the positioner. - That value is written to the hdf5 file (NXcollection) and - it is sent to PixelatorGUI.
+ String value describes the function of the positioner. That value is written to the hdf5 file (NXcollection) and it is sent to PixelatorGUI.
 **Default**: "" (empty string) **unit**::
 String value defines the unit of the positioner values (on the GUI and in the hdf5 file).
 **Default**: "" (empty string) + **hardwareUnitFactor**::
+ Double value defines the conversion factor used to convert hardware positioner values to **unit***.
+ **Default**: 1.0 + **distributionMode**::
 String value defines the discribution of points to an interval.
 Example: 5 points from 0 to 10: @@ -52,10 +58,6 @@ The following settings are available for all types of positioners:  **Default**: "n" - **hardwareUnitFactor**::
- Double value defines the conversion factor used to convert hardware positioner values to **unit***.
- **Default**: 1.0 - **positionOffset**::
 Double value defines shift of coordinates between those communicated with the hardware controller and the user.
 **Default**: 0.0 @@ -80,10 +82,6 @@ The following settings are available for all types of positioners:  Double value defines maximum rate of movement.
 **Default**: 0.0 - **readOnly**::
- Boolean value true when the positioner can only be used to read its position (i.e. cannot request a move).
- **Default**: false - **autoOff**::
 Positioners can be set to an unpowered state after 1 of 3 events: 1. positioner move due to direct request @@ -106,6 +104,10 @@ The following settings are available for all types of positioners: | "Manual" | ON | ON | ON | OFF | +**linkedOffsetPositionerName**::
+ String value that defines the name of a positioner whose movements are to be coordinated. Typically stated in a zoneplate Z-axis positioner configuration with a value corresponding to the fine positioner of the sample Z-axis.
+ **Default**: empty string + **beamlineControlPosition**::
 Integer value defines inclusion of (value greater than zero), and position of a positioner control in the "Beamline Control" and "Microscope Status" sections of the GUI. The "Beamline Control" section will only list positioners with a **beamlineControlPosition** value greater than zero, with each positioner listed in ascending **beamlineControlPosition** order. The "Microscope Status" GUI section will list any positioner with a **beamlineControlPosition** value of zero (except it will always ignore a positioner with the name "BeamShutter"). Negative values can be used to exclude a positioner from both sections of the GUI.
 **Default**: 0 @@ -134,6 +136,23 @@ The following settings are available for all types of positioners: * a name of a position value (positionUserToStringHardware) * the position of a named position (stringHardwareToPositionUser) + +## Epics +## Tango +## NewPort +## NexLine +## SmarAct +## SmarActUsb +## SmarActTcp +## Interferometer +## BeamShutter +## AnalogOut +## Transform +## Galil +## Zaber +## ZmiEpics + + ## Orchestra Detector An Orchestra detector is a special type of **readOnly** positioner that uses Orchestra to sample the most recent value of an "Epics" or "Tango" data channel with no waiting. An Orchestra detector being configured as a type of positioner is an historical artefact that may be corrected in future. This can be used, for example, to monitor the synchrotrons storage ring current that is provided via an EPICS channel on a pixel-by-pixel basis with minimal overhead. @@ -148,4 +167,4 @@ An Orchestra detector is a special type of **readOnly** positioner that uses Orc **orchestraDetectorMonitor**::
 Boolean value defines if the positioner values should be recorded in the scan file as a monitor.
- **Default**: false + **Default**: false \ No newline at end of file