CTB frequency rounding, CTB frequency measurement, CTB frequency units (#1423)

* round CTB clocks to next closest possible value, added freq measurement

* added time for firmware to measrue actual value after frequency change

* add check for backwards compatibility

* change CTB and XCTB clock values to MHz, TODO: units and validation errors

* changed runclk command to use units and float, TODO: dbit, adcclk, why is everything called StringTo ?

* do the same for dbit and adcclk

* added tolerance to exptime, fixed test

* update default values in server defs

* added virtual check in Altera_PLL, update testcases

* change python and pyctbgui to accept and return floating point MHz

* update help and comments

* Dev/ctb clocks fix (#1434)

* introduced new type Hz, typetraits, String conversions, command generation (not yet generated)

* incorrect unit typo

* cmd generation and compiles

* default to MHz, removed space between units for consistency with timers, min and max checks for clks

* in python, but need to change the default to Hz again for clean code and intuition

* allow ints, doubles, implicit conversions

* dont allow raw ints, doubles and implicit conversions

* fixed tests

* added operators for Hz in python

* fix test for min clk for xilinx ctb

* fix test

* fix python tests

* fixed xilinx period and default clks

* test fix

* removed the 3 clock cycle check for ctb and implemented properly the max adc clk frq for altera ctb

* removing 3 clock cycle code from xilinx as well

* formatting

* loadpattern before 3 clk cycles code

* actualtime and measurement time to be implemented in 100ns already in fw

* fix tests

* pyzmq dependency forthe tests

* fixed pyctbgui for freq

* insert tolerance check again

* also added tolerance check for patwaittime

* formatting

* minor: rounding test

* removed Rep redundant in ToString for freq

* intro frequency unit enums, removed unnecessary template behavior for ToString with freq unit, switching from parsing string unit argument to the enum argument for ToString, adding parsing string to unit at CLI boundary

* minor, and binaries

* minor, default clk vals are 0 but set up at detector setup

* get frequency only for that unit

* tolerance process

* missed in previous commit

* some more changes to exptime and validations

* ctb is probably done

* periodleft and delayleft

* fixed xilinx freq conv as well

* fixed m3 bug, binaries

* xilinx: setup also done in stop server so that the clk is not 0

* missed a test marker

* binaries in

* review fixes, simpler validation of timers in ctb and xilinx ctb

* typo fix

* format

* fix tests

---------

Co-authored-by: Martin Mueller <martin.mueller@psi.ch>
Co-authored-by: Dhanya Thattil <dhanya.thattil@psi.ch>

slsSupportLib/include/sls/ToString.h

@@ -108,6 +108,12 @@ ToString(From t) {
     }
 }
 
+/** Convert frequency with specified output unit */
+std::string ToString(defs::Hz f, defs::FrequencyUnit unit);
+
+/** Convert frequency automatically selecting the unit */
+std::string ToString(defs::Hz f);
+
 /** Conversion of floating point values, removes trailing zeros*/
 template <typename T>
 typename std::enable_if<std::is_floating_point<T>::value, std::string>::type
@@ -279,7 +285,23 @@ ToString(const T &container, const std::string &unit) {
     return os.str();
 }
 
+/** Container and specified unit, call ToString(value, FrequencyUnit) */
 template <typename T>
+typename std::enable_if<is_container<T>::value, std::string>::type
+ToString(const T &container, defs::FrequencyUnit unit) {
+    std::ostringstream os;
+    os << '[';
+    if (!container.empty()) {
+        auto it = container.cbegin();
+        os << ToString(*it++, unit);
+        while (it != container.cend())
+            os << ", " << ToString(*it++, unit);
+    }
+    os << ']';
+    return os.str();
+}
+
+template <typename T, std::enable_if_t<sls::is_duration<T>::value, int> = 0>
 T StringTo(const std::string &t, const std::string &unit) {
     double tval{0};
     try {
@@ -304,6 +326,33 @@ T StringTo(const std::string &t, const std::string &unit) {
     }
 }
 
+template <typename T, std::enable_if_t<sls::is_frequency<T>::value, int> = 0>
+T StringTo(const std::string &f, const std::string &unit) {
+    double fval{0};
+    try {
+        fval = std::stod(f);
+    } catch (const std::invalid_argument &e) {
+        throw RuntimeError("Could not convert string to frequency");
+    }
+    auto unitLower = [&] {
+        std::string result = unit;
+        std::transform(result.begin(), result.end(), result.begin(),
+                       [](unsigned char c) { return std::tolower(c); });
+        return result;
+    }();
+
+    if (unitLower == "mhz") {
+        return T(static_cast<int>(fval * 1e6));
+    } else if (unitLower == "khz") {
+        return T(static_cast<int>(fval * 1e3));
+    } else if (unitLower.empty() || unitLower == "hz") {
+        return T(static_cast<int>(fval));
+    } else {
+        throw RuntimeError(
+            "Invalid unit in conversion from string to frequency");
+    }
+}
+
 template <typename T> T StringTo(const std::string &t) {
     std::string tmp{t};
     auto unit = RemoveUnit(tmp);

slsSupportLib/include/sls/TypeTraits.h

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: LGPL-3.0-or-other
 // Copyright (C) 2021 Contributors to the SLS Detector Package
 #pragma once
+#include "sls/sls_detector_defs.h"
+
 #include <type_traits>
 #include <vector>
 
@@ -120,4 +122,9 @@ struct has_bool_isValid : std::false_type {};
 template <typename T>
 struct has_bool_isValid<T, std::void_t<decltype(std::declval<T>().isValid)>>
     : std::is_same<decltype(std::declval<T>().isValid), bool> {};
+
+template <typename T> struct is_frequency : std::false_type {};
+
+template <> struct is_frequency<defs::Hz> : std::true_type {};
+
 } // namespace sls

slsSupportLib/include/sls/sls_detector_defs.h

@@ -221,6 +221,16 @@ class slsDetectorDefs {
         std::map<std::string, std::string> addJsonHeader;
     };
 
+    struct Hz {
+        int value{0};
+        explicit Hz(int v) : value(v){};
+        constexpr bool operator==(const Hz &other) const {
+            return (value == other.value);
+        }
+    };
+
+    enum class FrequencyUnit { Hz, kHz, MHz };
+
 #endif
     enum frameDiscardPolicy {
         NO_DISCARD,
@@ -854,7 +864,6 @@ typedef struct {
 #endif
 
 #ifdef __cplusplus
-
 // TODO! discuss this
 #include <vector> //hmm... but currently no way around
 namespace sls {

slsSupportLib/include/sls/versionAPI.h

@@ -3,11 +3,11 @@
 /** API versions */
 #define APILIB        "0.0.0 0x250909"
 #define APIRECEIVER   "0.0.0 0x250822"
-#define APICTB        "0.0.0 0x260427"
+#define APICTB        "0.0.0 0x260506"
 #define APIGOTTHARD2  "0.0.0 0x260427"
 #define APIMOENCH     "0.0.0 0x260424"
 #define APIEIGER      "0.0.0 0x260424"
-#define APIXILINXCTB  "0.0.0 0x260427"
+#define APIXILINXCTB  "0.0.0 0x260506"
 #define APIJUNGFRAU   "0.0.0 0x260424"
-#define APIMYTHEN3    "0.0.0 0x260427"
-#define APIMATTERHORN "0.0.0 0x260212"
+#define APIMYTHEN3    "0.0.0 0x260506"
+#define APIMATTERHORN "0.0.0 0x260212"