x2745 DPP-ZLE 2025012707
CUP documentation
Introduction

CAEN S.p.A.

Via Vetraia, 11 - 55049 - Viareggio (LU) - ITALY
Tel +39 0594 388 398
Fax +39 0584 388 959
info@caen.it
www.caen.it

Copyright notice

Copyright © 2020-2023 CAEN SpA

Credits

The CAEN FE Library is made possible by other third part open source software.

This manual uses a custom CSS theme for doxygen html-documentation:

  • Source: Doxygen Awesome
  • License: MIT license
  • Copyright: Copyright © 2021 jothepro
  • Author: jothepro

Disclaimer

No part of this manual may be reproduced in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of CAEN SpA.

The information contained herein has been carefully checked and is believed to be accurate; however, no responsibility is assumed for inaccuracies. CAEN SpA reserves the right to modify its products specifications without giving any notice; for up to date information please visit www.caen.it.

We remark that all our boards have been designed and assembled in Italy. In a challenging environment where a competitive edge is often obtained at the cost of lower wages and declining working conditions, we proudly acknowledge that all those who participated in the production and distribution process of our devices were reasonably paid and worked in a safe environment (this is true for the boards marked "MADE IN ITALY", while we cannot guarantee for third-party manufactures).

Technical Support

CAEN makes available the technical support of its specialists for requests concerning the software, hardware, and eventually board repair. To access the support platform, please follow the steps below:

  1. Login at www.caen.it or register a new account
  2. On the MyCAEN+ area, from the "Dashboard" section (www.caen.it/mycaen/dashboard), register your boards
  3. From the "Support" section (www.caen.it/mycaen/support) open a ticket request for the issue you have found.
  4. In case of product repair, a CAEN operator will enable the RMA (Return Merchandise Authorization) form directly from the support ticket.

Note: only MyCAEN+ accounts can request technical support. If you have a basic account, please insert your institutional email: if the domain is in our whitelist, the account is automatically updated to MyCAEN+, otherwise an operator will take care of the validation within 48 hours.

Description

The CAEN Waveform digitizers x27xx represent a significant advancement in accessing firmware parameters compared to the previous generation models V17xx, DT57xx, and N67xx. In the earlier x17xx models, the approach involved directly exposing individual firmware registers. However, the new generation digitizers introduce a more user-friendly abstraction of the registers in the form of library parameters.

This novel approach aims to simplify the lives of users who are tasked with constructing their own DAQ (Data Acquisition) system and software, as it provides a much easier-to-understand and use interface. By utilizing library parameters, users can effortlessly access the digitizer firmware parameters, streamlining the process of building their custom DAQ systems and software.

The CAEN website offers downloadable libraries that encompass the necessary SDK and demo codes within their respective installation folders. These resources serve as a starting point for users to initiate their custom software development. To obtain the parameters specific to the utilized board and firmware, they can be acquired through the Digitizer Web Interface and subsequently downloaded. The provided manual outlines the CAEN FELib parameters relevant to the Digitizers 2.0, organized in the following structure.

Commands

Commands must be used as arguments of the CAEN_FELib_SendCommand() function with the path /cmd/<CommandName>.

Commands are described as follows:

CommandName
Description Description text
Level Specifies the required path for sending the command
Set in Run Specifies whether the command should be transmitted while the board is in the running state or not

Endpoints

Endpoints are entities to be used in the CAEN_FELib_SetReadDataFormat() and CAEN_FELib_ReadData() functions.

They are described as follow:

Decoded Endpoint
Path Indicates the path to the decoded enpoint (to be called in the CAEN_FELib_GetHandle())
Supported Fields Indicates which fields are supported, their native type, dimension and description
Default Data Format Shows the default format

Parameters

Parameters refer to entities that serve as arguments for the CAEN_FELib_SetValue() and CAEN_FELib_GetValue() functions.

The parameters are organized based on functionalities, with each chapter detailing a particular aspect of the digitizer and the corresponding parameters necessary for its implementation. These parameters are described using the following structure:

Parameter Name
Description Description text
Level Indicates the path needed to set/get the parameter value. The table of the allowed levels and their corresponding paths is shown below
Type Indicates the parameter type: could be LIST, RANGE. N.B. Type doesn't correspond to any C-type, all CAEN FELib parameters are float or string type
Access Type Indicates if the parameter has specific access type (e.g. Read Only or Write Only). If not specified the parameter is Read/Write
UoM Indicates the Unit of Measurement of the parameter (if any)
Min Indicates the allowed minimum value (if any)
Max Indicates the allowed maximum value (if any)
Increment Indicates the allowed increment value (if any)
Allowed Values List-Type parameters allow only the indicated values as options

Level allowed values:

Level Path
DIG /par/<ParameterName>
GROUP /group/<idx>/par/<ParameterName>
CH /ch/<idx>/par/<ParameterName>
LVDS /lvds/<idx>/par/<ParameterName>
VGA /vga/<index>/par/<ParameterName>