Merge pull request #199 from sy-c/master

v2.5.2

Author: sy-c

doc/configurationParameters.md

@@ -112,7 +112,7 @@ The parameters related to 3rd-party libraries are described here for convenience
 | equipment-* | saveErrorPagesMax | int | 0 | If set, pages found with data error are saved to disk up to given maximum. | 
 | equipment-* | saveErrorPagesPath | string |  | Path where to save data pages with errors (when feature enabled). | 
 | equipment-* | stopOnError | int | 0 | If 1, readout will stop automatically on equipment error. | 
-| equipment-* | TFperiod | int | 256 | Duration of a timeframe, in number of LHC orbits. | 
+| equipment-* | TFperiod | int | 128 | Duration of a timeframe, in number of LHC orbits. | 
 | equipment-cruemulator-* | cruBlockSize | int | 8192 | Size of a RDH block. | 
 | equipment-cruemulator-* | cruId | int | 0 | CRU Id, used for CRU Id field in RDH. | 
 | equipment-cruemulator-* | dpwId | int | 0 | CRU end-point Id (data path wrapper id), used for DPW Id field in RDH. | 

doc/releaseNotes.md

@@ -376,3 +376,7 @@ This file describes the main feature changes for each readout.exe released versi
 - Updated configuration parameters:
   - added equipment-*.dataPagesLogPath to allow saving to disk summary debug info for all data pages received.
 - Fixed spurious "Non-contiguous timeframe IDs" warning: the check was too strict, having some links 1 TF behind is fine.
+
+## v2.5.2 - 13/09/2021
+- Updated configuration parameters:
+  - equipment.TFperiod is now set to 128 by default, instead of 256 previously. This is the duration of a timeframe, in number of LHC orbits.

src/ReadoutEquipment.cxx

@@ -140,8 +140,8 @@ ReadoutEquipment::ReadoutEquipment(ConfigFile& cfg, std::string cfgEntryPoint, b
   theLog.log(LogInfoDevel_(3002), "RDH settings: rdhCheckEnabled=%d rdhDumpEnabled=%d rdhDumpErrorEnabled=%d rdhDumpWarningEnabled=%d rdhUseFirstInPageEnabled=%d", cfgRdhCheckEnabled, cfgRdhDumpEnabled, cfgRdhDumpErrorEnabled, cfgRdhDumpWarningEnabled, cfgRdhUseFirstInPageEnabled);
 
   if (!cfgDisableTimeframes) {
-    // configuration parameter: | equipment-* | TFperiod | int | 256 | Duration of a timeframe, in number of LHC orbits. |
-    int cfgTFperiod = 256;
+    // configuration parameter: | equipment-* | TFperiod | int | 128 | Duration of a timeframe, in number of LHC orbits. |
+    int cfgTFperiod = 128;
     cfg.getOptionalValue<int>(cfgEntryPoint + ".TFperiod", cfgTFperiod);
     timeframePeriodOrbits = cfgTFperiod;
 

src/ReadoutEquipment.h

@@ -144,7 +144,7 @@ class ReadoutEquipment
 
   //const unsigned int LHCBunches = 3564;    // number of bunches in LHC
   const unsigned int LHCOrbitRate = 11246; // LHC orbit rate, in Hz. 299792458 / 26659
-  uint32_t timeframePeriodOrbits = 256;    // timeframe interval duration in number of LHC orbits
+  uint32_t timeframePeriodOrbits = 128;    // timeframe interval duration in number of LHC orbits
   double timeframeRate = 0;                // timeframe rate, when generated internally
 
   // RDH-related configuration parameters

src/ReadoutVersion.h

@@ -9,5 +9,5 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-#define READOUT_VERSION "2.5.1"
+#define READOUT_VERSION "2.5.2"
 

src/readoutConfigEditor.tcl

@@ -90,7 +90,7 @@ set configurationParametersDescriptor {
 | equipment-* | saveErrorPagesMax | int | 0 | If set, pages found with data error are saved to disk up to given maximum. | 
 | equipment-* | saveErrorPagesPath | string |  | Path where to save data pages with errors (when feature enabled). | 
 | equipment-* | stopOnError | int | 0 | If 1, readout will stop automatically on equipment error. | 
-| equipment-* | TFperiod | int | 256 | Duration of a timeframe, in number of LHC orbits. | 
+| equipment-* | TFperiod | int | 128 | Duration of a timeframe, in number of LHC orbits. | 
 | equipment-cruemulator-* | cruBlockSize | int | 8192 | Size of a RDH block. | 
 | equipment-cruemulator-* | cruId | int | 0 | CRU Id, used for CRU Id field in RDH. | 
 | equipment-cruemulator-* | dpwId | int | 0 | CRU end-point Id (data path wrapper id), used for DPW Id field in RDH. |