docs: Update device list
This commit is contained in:
ci_update_bot
@@ -1,9 +1,21 @@
|
||||
// This file was autogenerated. Do not edit it manually.
|
||||
## Device List
|
||||
### tomcat_bec (gitlab.psi.ch/bec/tomcat_bec)
|
||||
### tomcat_bec
|
||||
| Device | Documentation | Module |
|
||||
| :----- | :------------- | :------ |
|
||||
| GrashopperTOMCAT | <br> Grashopper detector for TOMCAT<br><br> Parent class: PSIDetectorBase<br><br> class attributes:<br> custom_prepare_cls (GrashopperTOMCATSetup) : Custom detector setup class for TOMCAT,<br> inherits from CustomDetectorMixin<br> cam (SLSDetectorCam) : Detector camera<br> image (SLSImagePlugin) : Image plugin for detector<br> | grashopper_tomcat |
|
||||
| SLSDetectorCam | <br> SLS Detector Camera - Grashoppter<br><br> Base class to map EPICS PVs to ophyd signals.<br> | grashopper_tomcat |
|
||||
| SLSImagePlugin | SLS Image Plugin<br><br> Image plugin for SLS detector imitating the behaviour of ImagePlugin from<br> ophyd's areadetector plugins.<br> | grashopper_tomcat |
|
||||
| TomcatAerotechRotation | Special motor class that provides flyer interface and progress bar. | tomcat_rotation_motors |
|
||||
| GrashopperTOMCAT | <br> Grashopper detector for TOMCAT<br><br> Parent class: PSIDetectorBase<br><br> class attributes:<br> custom_prepare_cls (GrashopperTOMCATSetup) : Custom detector setup class for TOMCAT,<br> inherits from CustomDetectorMixin<br> cam (SLSDetectorCam) : Detector camera<br> image (SLSImagePlugin) : Image plugin for detector<br> | [tomcat_bec.devices.grashopper_tomcat](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/grashopper_tomcat.py) |
|
||||
| SLSDetectorCam | <br> SLS Detector Camera - Grashoppter<br><br> Base class to map EPICS PVs to ophyd signals.<br> | [tomcat_bec.devices.grashopper_tomcat](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/grashopper_tomcat.py) |
|
||||
| SLSImagePlugin | SLS Image Plugin<br><br> Image plugin for SLS detector imitating the behaviour of ImagePlugin from<br> ophyd's areadetector plugins.<br> | [tomcat_bec.devices.grashopper_tomcat](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/grashopper_tomcat.py) |
|
||||
| TomcatAerotechRotation | Special motor class that provides flyer interface and progress bar. | [tomcat_bec.devices.tomcat_rotation_motors](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/tomcat_rotation_motors.py) |
|
||||
| EpicsMotorX | Special motor class that provides flyer interface and progress bar. | [tomcat_bec.devices.aerotech.AerotechAutomation1](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/aerotech/AerotechAutomation1.py) |
|
||||
| aa1AxisDriveDataCollection | Axis data collection<br><br> This class provides convenience wrappers around the Aerotech API's axis<br> specific data collection functionality. This module allows to record<br> hardware synchronized signals with up to 200 kHz.<br><br> The default configuration is using a fixed memory mapping allowing up to<br> 1 million recorded data points on an XC4e (this depends on controller).<br><br> Usage:<br> # Configure the DDC with default internal triggers<br> ddc = aa1AxisPsoDistance(AA1_IOC_NAME+":ROTY:DDC:", name="ddc")<br> ddc.wait_for_connection()<br> ddc.configure(d={'npoints': 5000})<br> ddc.kickoff().wait()<br> ...<br> ret = yield from ddc.collect()<br> | [tomcat_bec.devices.aerotech.AerotechAutomation1](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/aerotech/AerotechAutomation1.py) |
|
||||
| aa1AxisIo | Analog / digital Input-Output<br><br> This class provides convenience wrappers around the Aerotech API's axis<br> specific IO functionality. Note that this is a low-speed API, actual work<br> should be done in AeroScript. Only one pin can be writen directly but<br> several can be polled!<br> | [tomcat_bec.devices.aerotech.AerotechAutomation1](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/aerotech/AerotechAutomation1.py) |
|
||||
| aa1AxisPsoBase | Position Sensitive Output - Base class<br><br> This class provides convenience wrappers around the Aerotech IOC's PSO<br> functionality. As a base class, it's just a collection of PVs without<br> significant logic (that should be implemented in the child classes).<br> It uses event-waveform concept to produce signals on the configured<br> output pin: a specified position based event will trigger the generation<br> of a waveform on the oputput that can be either used as exposure enable,<br> as individual trigger or as a series of triggers per each event.<br> As a first approach, the module follows a simple pipeline structure:<br> Genrator --> Event --> Waveform --> Output<br><br> Specific operation modes should be implemented in child classes.<br> | [tomcat_bec.devices.aerotech.AerotechAutomation1](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/aerotech/AerotechAutomation1.py) |
|
||||
| aa1AxisPsoDistance | Position Sensitive Output - Distance mode<br><br> This class provides convenience wrappers around the Aerotech API's PSO<br> functionality in distance mode. It uses event-waveform concept to produce<br> signals on the configured output pin: a specified position based event<br> will trigger the generation af a waveform on the oputput that can be either<br> used as exposure enable, as individual trigger or as a series of triggers<br> per each event.<br> As a first approach, the module follows a simple pipeline structure:<br> Genrator (distance) --> Event --> Waveform --> Output<br><br> The module provides configuration interface to common functionality, such<br> as fixed distance or array based triggering and can serve as a base for<br> future advanced functionality. The relative distances ease the limitations<br> coming from 32 bit PSO positions.<br> For a more detailed description of additional signals and masking plase<br> refer to Automation1's online manual.<br><br> Usage:<br> # Configure the PSO to raise an 'enable' signal for 180 degrees<br> pso = aa1AxisPsoDistance(AA1_IOC_NAME+":ROTY:PSO:", name="pso")<br> pso.wait_for_connection()<br> pso.configure(d={'distance': [180, 0.1], 'wmode': "toggle"})<br> pso.kickoff().wait()<br><br> # Configure the PSO to emmit 5 triggers every 1.8 degrees<br> pso = aa1AxisPsoDistance(AA1_IOC_NAME+":ROTY:PSO:", name="pso")<br> pso.wait_for_connection()<br> pso.configure(d={'distance': 1.8, 'wmode': "pulsed", 'n_pulse': 5})<br> pso.kickoff().wait()<br> | [tomcat_bec.devices.aerotech.AerotechAutomation1](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/aerotech/AerotechAutomation1.py) |
|
||||
| aa1AxisPsoWindow | Position Sensitive Output - Window mode<br><br> This class provides convenience wrappers around the Aerotech API's PSO<br> functionality in window mode. It can either use the event-waveform concept<br> or provide a direct window output signal (in/out) to the output pin. The<br> latter is particularly well-suited for the generation of trigger enable<br> signals, while in event mode it allows the finetuning of trigger lenth.<br> As a first approach, the module follows a simple pipeline structure:<br> Genrator --> Event --> Waveform --> Output pin<br> Genrator --> Window output --> Output pin<br><br> The module provides configuration interface to common functionality, such<br> as repeated trigger enable signal or fixed area scaning. Unfortunately the<br> entered positions are absolute, meaning this mode has an inherent limitation<br> with encoder counters being kept in 32 bit integers.<br> For a more detailed description of additional signals and masking plase<br> refer to Automation1's online manual.<br> | [tomcat_bec.devices.aerotech.AerotechAutomation1](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/aerotech/AerotechAutomation1.py) |
|
||||
| aa1Controller | Ophyd proxy class for the Aerotech Automation 1's core controller functionality | [tomcat_bec.devices.aerotech.AerotechAutomation1](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/aerotech/AerotechAutomation1.py) |
|
||||
| aa1DataAcquisition | Controller Data Acquisition - DONT USE at Tomcat<br><br> This class implements the controller data collection feature of the<br> Automation1 controller. This feature logs various inputs at a<br> **fixed frequency** from 1 kHz up to 200 kHz.<br> Usage:<br> 1. Start a new configuration with "startConfig"<br> 2. Add your signals with "addXxxSignal"<br> 3. Start your data collection<br> 4. Read back the recorded data with "readback"<br> | [tomcat_bec.devices.aerotech.AerotechAutomation1](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/aerotech/AerotechAutomation1.py) |
|
||||
| aa1GlobalVariableBindings | Polled global variables<br><br> This class provides an interface to read/write the first few global variables<br> on the Automation1 controller. These variables are continuously polled<br> and are thus a convenient way to interface scripts with the outside word.<br> | [tomcat_bec.devices.aerotech.AerotechAutomation1](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/aerotech/AerotechAutomation1.py) |
|
||||
| aa1GlobalVariables | Global variables<br><br> This class provides an interface to directly read/write global variables<br> on the Automation1 controller. These variables are accesible from script<br> files and are thus a convenient way to interface with the outside word.<br><br> Read operations take as input the memory address and the size<br> Write operations work with the memory address and value<br><br> Usage:<br> var = aa1Tasks(AA1_IOC_NAME+":VAR:", name="var")<br> var.wait_for_connection()<br> ret = var.readInt(42)<br> var.writeFloat(1000, np.random.random(1024))<br> ret_arr = var.readFloat(1000, 1024)<br><br> | [tomcat_bec.devices.aerotech.AerotechAutomation1](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/aerotech/AerotechAutomation1.py) |
|
||||
| aa1TaskState | Task state monitoring API<br><br> This is the task state monitoring interface for Automation1 tasks. It<br> does not launch execution, but can wait for the execution to complete.<br> | [tomcat_bec.devices.aerotech.AerotechAutomation1](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/aerotech/AerotechAutomation1.py) |
|
||||
| aa1Tasks | Task management API<br><br> The place to manage tasks and AeroScript user files on the controller.<br> You can read/write/compile/execute AeroScript files and also retrieve<br> saved data files from the controller. It will also work around an ophyd<br> bug that swallows failures.<br><br> Execution does not require to store the script in a file, it will compile<br> it and run it directly on a certain thread. But there's no way to<br> retrieve the source code.<br><br> Write a text into a file on the aerotech controller and execute it with kickoff.<br> '''<br> script="var $axis as axis = ROTY\nMoveAbsolute($axis, 42, 90)"<br> tsk = aa1Tasks(AA1_IOC_NAME+":TASK:", name="tsk")<br> tsk.wait_for_connection()<br> tsk.configure({'text': script, 'filename': "foobar.ascript", 'taskIndex': 4})<br> tsk.kickoff().wait()<br> '''<br><br> Just execute an ascript file already on the aerotech controller.<br> '''<br> tsk = aa1Tasks(AA1_IOC_NAME+":TASK:", name="tsk")<br> tsk.wait_for_connection()<br> tsk.configure({'filename': "foobar.ascript", 'taskIndex': 4})<br> tsk.kickoff().wait()<br> '''<br><br> | [tomcat_bec.devices.aerotech.AerotechAutomation1](https://gitlab.psi.ch/bec/tomcat_bec/-/blob/main/tomcat_bec/devices/aerotech/AerotechAutomation1.py) |
|
||||
|
||||
Reference in New Issue
Block a user