+-----------------+-----------------+-----------------+-----------------+ | |european-xfel- | .. rubric:: DAQ | | | | logo-497x497| | and Control | | | | | Systems | | | | | :name: daq-a | | | | | nd-control-syst | | | | | ems | | | +-----------------+-----------------+-----------------+-----------------+ | .. rubric:: | .. rubric:: EQU | | | | :name: secti | IPMENT | | | | on | Requirement | | | | | Document | | | | | :name: equip | | | | | ment-requiremen | | | | | t-document | | | +-----------------+-----------------+-----------------+-----------------+ | .. rubric:: | This form must | | | | :name: secti | be used to | | | | on-1 | define all | | | | | requirements | | | | | relevant for | | | | | DAQ & CTRL. | | | +-----------------+-----------------+-----------------+-----------------+ | .. rubric:: Sum | | | | | mary | | | | | :name: summa | | | | | ry | | | | | | | | | | Hint: Fill all | | | | | fields as much | | | | | as possible | | | | +-----------------+-----------------+-----------------+-----------------+ | Equipment | ANDOR-MARANA | Equipment | ANDOR-MARANA | | (short) [4]_ | | (long):sup:`a` | | +-----------------+-----------------+-----------------+-----------------+ | Equipment Group | Commercial | Equipment Group | cMOS Cameras | | :sup:`b`/ | Cameras | (long) | | | XIM-Group if | | :sup:`c`/ | | | available | | XIM-Group if | | | | | available | | +-----------------+-----------------+-----------------+-----------------+ | Controller/Inte | MARANA | Vendor | Princeton | | rface | | XIM-vendor if | Instruments | | Model | | available | | +-----------------+-----------------+-----------------+-----------------+ | Controller | Integrated-in-e | Equipment | - ANDOR Marana | | (Vendor Part | quipment [5]_ | (Vendor Part | | | Number)/ | | Number)/ | - IPC (GG | | XIM-item type | | XIM-item type | please add | | if available | | if available | details if you | | :sup:`d` | | | know them) | +-----------------+-----------------+-----------------+-----------------+ | ePlan ID | *Filled in by | Redmine ID [6]_ | | | | DAQ and CTRL | | | | | experts* | | | +-----------------+-----------------+-----------------+-----------------+ | Creation date | 08.01.2021 | First Requester | SCS | | | | WP | | +-----------------+-----------------+-----------------+-----------------+ | Short | | | | | description | | | | +-----------------+-----------------+-----------------+-----------------+ | Requestor | G. Mercurio ( | Email and phone | | | contacts | | if non-XFEL | | | | SCS | | | | | | | | | | ) | | | +-----------------+-----------------+-----------------+-----------------+ | Expert contacts | G. Giovanetti | | | | (EEE/CAS/ITDM) | (CTRL) | | | +-----------------+-----------------+-----------------+-----------------+ | | | | | +-----------------+-----------------+-----------------+-----------------+ | Expected first | | | | | usage time(?) | | | | +-----------------+-----------------+-----------------+-----------------+ | Installation | SCS | XIM-Location | | | location(s) | | (if available) | | | XIM-Location if | | | | | available | | | | +-----------------+-----------------+-----------------+-----------------+ | | | | | +-----------------+-----------------+-----------------+-----------------+ .. _section-2: +-----------------------+------------+--------+------------------+ | .. rubric:: Revisions | | | | | :name: revisions | | | | +-----------------------+------------+--------+------------------+ | Version | Date | Author | Comment | +-----------------------+------------+--------+------------------+ | 0.1 | 08.01.2021 | | Document Created | +-----------------------+------------+--------+------------------+ | | | | | +-----------------------+------------+--------+------------------+ ** ** Table of Content ================ Contents ======== `DAQ and Control Systems 1 <#daq-and-control-systems>`__ `EQUIPMENT Requirement Document 1 <#equipment-requirement-document>`__ `Summary 1 <#summary>`__ `Revisions 2 <#revisions>`__ `Table of Content 3 <#table-of-content>`__ `How this document works 4 <#how-this-document-works>`__ `Preliminary classification checklist 5 <#preliminary-classification-checklist>`__ `Board of stake holders and deadline statement 5 <#board-of-stake-holders-and-deadline-statement>`__ `Integration interface checklist 6 <#integration-interface-checklist>`__ `Special comments from experts for integration 8 <#special-comments-from-experts-for-integration>`__ `Equipment description 9 <#equipment-description>`__ `Equipment connectors (overview) 10 <#_Toc55380585>`__ `Controller connectors (overview) 11 <#controller-connectors-overview>`__ `Connection overview (also mechanical) 12 <#connection-overview-also-mechanical>`__ `Electrical connection 13 <#electrical-connection>`__ `PLC Hardware Interface 15 <#_Toc55380589>`__ `PLC SD Name 15 <#_Toc55380590>`__ `PLC Signal Details 15 <#_Toc55380591>`__ `PDO and CoE parameters to be exposed 16 <#_Toc55380592>`__ `karabo Signal Details (properties or commands) 16 <#karabo-details-properties-or-commands>`__ `Device features and possible use diagram 17 <#section-5>`__ `Links 21 <#links>`__ `Notes 21 <#notes>`__ How this document works ----------------------- **Aim:** For a piece of equipment to be integrated into the EuXFEL control environment the equipment’s interfaces to the service groups involved need to be specified. Only once the **Equipment Requirement Document (in the following ERD)** is approved and integration work started, is the related equipment regarded as “under integration”. Since only supported equipment can be part of the CRD (Component Requirement Document), the approval of the ERD is a prerequisite and, if not present, will delay CRD approval. All new equipment requires an ERD. **Workflow:** The Equipment Requirement Document (ERD) records interfacing decisions made whilst passing through the following steps: - The requester initiates the ERD request by emailing erd-request@xfel.eu whereupon the requester will be contacted by email. Which ERD contact depends on the information specified in the email request template. The process of filling in the form is performed by the requester with help from the contact and may require the requester to provide additional information (manuals, operation requirements, etc.) to clarify whether the equipment has to be controlled and/or monitored by PLC, FPGA or directly by Karabo, whether interlock IO is required, and whether interfaces need to be clarified for the other service groups. - If no requirement is seen for the other service groups, then the ERD can be completed by EEE and/or CTRL quickly. Should requirements exist then the services concerned must review the equipment interface. - When completed, the ERD will be sent to DATA department groups as well as to SRP and TS (electrical safety) for approval. This step is important as a backstop for those groups who were initially not considered to have interface requirements. - Before the actual integration work can start and the equipment is seen as “under integration”., it has to be evaluated, if the estimated effort for all involved groups exceeds the threshold for which a formal MB project request and approval is required. **Interface tracking:** The ERD contains preliminary classification and interface integration checklists (checkbox panels) which are used to record interfacing decisions. Additional service group interface clarification text can be added in the special comments from experts for integration space. **Roles:** Requester – makes the initial request and provides additional information and implementation details during the ERD process. Service groups – service group members responsible for evaluating the interface requirements **Lifetime:** Ideally there should be a 1:1 relationship between a piece of equipment and an ERD as the functionality defined in the interface definitions should not change. In order to reduce the risk of significant changes requested later, a board of stake holders will be formed during the ERD writing process to collect possible further requirements, to reach a potentially complete integration. However, this does not imply, that all features have to be implemented from the very beginning. If at any time the supported functionalities should be modified, a modified ERD should be submitted and re-evaluated. Preliminary classification checklist ------------------------------------ +-----------------------------------------------------------------------+ | | +-----------------------------------------------------------------------+ | **Direct integration through: ☐ PLC ☒ Karabo ☐ MicroTCA ☐ | | ToBeClarified** | | | | **Communication channels present: | | ☐ IO-signals ☐ RS232/RS485 ☐ EtherCAT ☐ Ethernet (GigE) ☐ Ethernet | | (10G)** | | | | **☐ USB-2 ☒ USB-3☐ PCIe ☐ Modbus ☐ IEEE-488 ☐ CAN** | +-----------------------------------------------------------------------+ Board of stake holders and deadline statement --------------------------------------------- To be filled by Data Department +--------------------------+------------+-----------------------+----------+ | Role / Expertise | Group | Person | Initials | +==========================+============+=======================+==========+ | Author&Coord ERD process | EEE | Nicola Coppola | | +--------------------------+------------+-----------------------+----------+ | PLC FW developer&tester | EEE | NN | | +--------------------------+------------+-----------------------+----------+ | EET Coordinator | EEE | Joern Reifschlaeger | | +--------------------------+------------+-----------------------+----------+ | FPGA Expert/Coordinator | EEE | Bruno Fernandes | | +--------------------------+------------+-----------------------+----------+ | EDS Coordinator | EEE | Janna Eilers | | +--------------------------+------------+-----------------------+----------+ | CTRL Expert/Coordinator | CTRL | G. Giovanetti/ S.Hauf | | +--------------------------+------------+-----------------------+----------+ | ITDM Expert/Coordinator | ITDM | Janusz Szuba | | +--------------------------+------------+-----------------------+----------+ | External Requester | *ChooseWP* | | | +--------------------------+------------+-----------------------+----------+ | Internal Requester | *ChooseWP* | | | +--------------------------+------------+-----------------------+----------+ | | *ChooseWP* | | | +--------------------------+------------+-----------------------+----------+ .. _section-3: **Deadline for the integration is: YYYY/MM/DD ** Integration interface checklist -------------------------------- To be filled by Data Department +-----------------------------------+-----------------------------------+ | **PLC control (write) channels:** | **EEE-PLC | | | & | | **☐ IO ☐ Serial ☐ EtherCAT ☐ | CTRL** | | Ethernet ☐ Modbus ☐ CAN** | | | | | | **PLC monitor (read) channels:** | | | | | | **☐ IO ☐ Serial ☐ EtherCAT ☐ | | | Ethernet ☐ Modbus ☐ CAN** | | | | | | **Non-PLC control (write) | | | channels:** | | | | | | **☐ IO ☐ Serial ☐ EtherCAT ☐ | | | Ethernet ☐ IEEE-488** | | | | | | **Non-PLC monitor (read) | | | channels:** | | | | | | **☐ IO ☐ Serial ☐ EtherCAT ☐ | | | Ethernet ☐ IEEE-488** | | | | | | **Configuration by:** | | | | | | **☐ PLC ☐ Non-PLC ☒ | | | Display/Console ☐ Vendor tool** | | | | | | **Interlock requirements:** | | | | | | **☐ PLC interlock source | | | (Condition) ☐ PLC interlock | | | target (action)** | | | | | | **FW, SW and Karabo interface | | | requirements: | | | ☒ use exisiting f/w and s/w: | | | Astrotech integration (to be | | | verified) | | | ☐ develop new f/w and s/w: | | | \_______________\_ ☐ EEE + CTRL | | | pairing set up** | | | | | | **☐ new Gui widgets** | | | | | | **Equipment requires:** | | | | | | **☒ System library/Specific | | | Operating System: Astrotech | | | integration** | | | | | | **☐ Licenses | | | \______________________, to be | | | acquired by \________________\_** | | +-----------------------------------+-----------------------------------+ | **Equipment requires:** | **EEE-PLC** | | | | | **☐ System library/Specific | | | Operating System: | | | \__________________\_** | | | | | | **PLC f/w requirements:** | | | | | | **if ☐ new f/w block is required, | | | indicate which in SW/FW | | | requirements | | | ☐ PLC Library: | | | \_________________\_** | | +-----------------------------------+-----------------------------------+ | **Trigger interface: ☒ETA train ☐ | **EEE-FPGA** | | MTCA train ☐ ETA pulse ☐ MTCA | | | pulse** | | | | | | **MTCA digitizer interfaces: | | | ☐FastADC ☐ ADQ14 ☐ Other:** | | | | | | **MTCA interfaces: ☐10G ☐ Other: | | | \________________________________ | | | _____________\_** | | | | | | **FPGA requirements: ☐new f/w | | | development** | | +-----------------------------------+-----------------------------------+ | **☐ Single function macro needed | **EEE-EET** | | ☐ Function macro needed** | | | | | | **☐ Typical needed** | | +-----------------------------------+-----------------------------------+ | **DA requirements: ☐extra s/w | **DA** | | development** | | +-----------------------------------+-----------------------------------+ | **IT server s/w: ☐non-standard | **ITDM** | | control server ☐ external | | | libraries ☐ special kernel ☐ /dev | | | driver** | | | | | | **IT special hardware: ☐PCIe ☐ | | | PoE switch ☐ unmanaged switch ☒ | | | Other: USB –> fibre range | | | exenders** | | | | | | **DAQ requirements: ☐high storage | | | ☐ 10GE☐Other:** | | +-----------------------------------+-----------------------------------+ | **A test system is required ☒** | **All** | | | | | **A test system is available ☐** | | | | | | A demo test system can be | | | organized **☒ by SCS** | | | | | | A test system/demo test system is | | | needed for long period **☐** | | +-----------------------------------+-----------------------------------+ | **TS requirements: ☐Chiller | **TS** | | ☐Power ☐ Other:** | | +-----------------------------------+-----------------------------------+ | **SRP safety issues present: ☐ | **SRP** | | :** | | +-----------------------------------+-----------------------------------+ | **Ticked OFF when resp. group | **All** | | processed checklist:** | | | | | | **☐ PLC ☐ EET ☐ EDS ☐ FPGA ☐ | | | Synch ☐ CTRL ☐ DAQ ☐ IT ☐ DA ☐ | | | TS** | | | | | | **☐ SRP** | | +-----------------------------------+-----------------------------------+ Special comments from experts for integration --------------------------------------------- Integration is preferred to happen by Astrotech, as for other Andor products. Possibly this works out of the box with the the integration we have from them, but would need to be tested. If additional development is needed, SCS is to contact Astrotech for integration, and CTRL will follow up. Equipment description --------------------- Marana is Andor’s high performance sCMOS camera platform for Astronomy and Physical Sciences, featuring \ **95% Quantum Efficiency (QE)** and **market-leading vacuum cooling** **to -45 °C**. The platform offers solutions for large field of view and high-speed imaging/spectroscopy. .. _section-4: |image1| --------- Controller connectors (overview) -------------------------------- +-------------+-------------+-------------+-------------+-------------+ | # | Connector | Connector | Quantity | Possible | | | Name | Type | | group which | | | | | | uses it | +-------------+-------------+-------------+-------------+-------------+ | 1 | POWER | | 1 | EEE-EETF | +-------------+-------------+-------------+-------------+-------------+ | 2 | TTL | Sub D, | 1 | EEE-FE | | | | adapter to | | | | | | BNC exists | | | +-------------+-------------+-------------+-------------+-------------+ | 3 | USB 3.0 | | 1 | CTRL-ICI | +-------------+-------------+-------------+-------------+-------------+ | 4 | Cooling | | 1 | TS | | | water | | | | +-------------+-------------+-------------+-------------+-------------+ | 5 | | | | | +-------------+-------------+-------------+-------------+-------------+ Connection overview (also mechanical) ------------------------------------- |image2| Electrical connection --------------------- Please add from the manual Karabo Details (properties or commands) --------------------------------------- These are listed and explicitly explained in the respective implementation documentation which can be found under `implementation document `__ and in the link section. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. _section-5: Device features and possible use diagram ---------------------------------------- - As a user I would like to be able to power the camera - As a user I would like to be able to acquire images from the camera into the DAQ - As a user I would like to be able to configure the integration time - As a user I would like to be able to configure the image binning - As a user I would like to be able to configure the image size - As a user I would like to be able to configure the trigger timing - … **Resource estimation for integration work** +---------+---------+---------+---------+---------+---------+---------+ | Task | Service | Sequenc | TaskNr | FTE | Investm | Other | | | | eNr | | days | ents | groups | | | | | | | | involve | | | | | | | | d | +=========+=========+=========+=========+=========+=========+=========+ | Provide | SCS | 1 | 1 | | | ITDM, | | test | | | | | | CTRL | | setup | | | | | | | +---------+---------+---------+---------+---------+---------+---------+ | Astrote | Externa | 2 | 1 | | | CTR; | | ch | l | | | | | | | impleme | | | | | | | | nt | | | | | | | | Camera | | | | | | | | interfa | | | | | | | | ce | | | | | | | +---------+---------+---------+---------+---------+---------+---------+ | Impleme | CTRL | 3 | 1 | | | | | nt | | | | | | | | Karabo | | | | | | | | device | | | | | | | +---------+---------+---------+---------+---------+---------+---------+ | Setup | EEE-FE | 3 | 2 | | | SCS? | | trigger | | | | | | | | s | | | | | | | +---------+---------+---------+---------+---------+---------+---------+ | Test | CTRL | 4 | 1 | | | SCS, | | system | | | | | | ITDM | | operati | | | | | | | | on | | | | | | | +---------+---------+---------+---------+---------+---------+---------+ | | | | | | | | +---------+---------+---------+---------+---------+---------+---------+ | | | | | | | | +---------+---------+---------+---------+---------+---------+---------+ | | | | | | | | +---------+---------+---------+---------+---------+---------+---------+ Overall FTE requirements estimated: 0 FTEs Overall investments estimated: 0 k€ Links ----- Notes ------ .. [1] :sup:`, a,b,c,d` To be validated by ERD-pickup person .. [2] Other example: PT G25 400. .. [3] In the best of cases, there should be only 1 task ID .. [4] :sup:`, a,b,c,d` To be validated by ERD-pickup person .. [5] Other example: PT G25 400. .. [6] In the best of cases, there should be only 1 task ID .. |european-xfel-logo-497x497| image:: ./img/media/image1.png :width: 0.86111in :height: 0.86111in .. |image1| image:: ./img/media/image2.png :width: 6.375in :height: 5.5in .. |image2| image:: ./img/media/image3.png :width: 6.86736in :height: 4.02292in