Merge branch 'developer' into gui

integrationTests/test-integrationDectector.cpp

@@ -313,14 +313,14 @@ TEST_CASE(
     CHECK(m.getRateCorrection() == ratecorr);
 
     // ratecorr fail with dr 4 or 8
-    CHECK_THROWS_AS(m.setDynamicRange(8), sls::NonCriticalError);
+    CHECK_THROWS_AS(m.setDynamicRange(8), sls::RuntimeError);
     CHECK(m.getRateCorrection() == 0);
     m.setDynamicRange(16);
     m.setDynamicRange(16);
     m.setRateCorrection(ratecorr);
     m.setDynamicRange(16);
     m.setRateCorrection(ratecorr);
-    CHECK_THROWS_AS(m.setDynamicRange(4), sls::NonCriticalError);
+    CHECK_THROWS_AS(m.setDynamicRange(4), sls::RuntimeError);
     CHECK(m.getRateCorrection() == 0);
 }
 
@@ -360,11 +360,11 @@ TEST_CASE("Chiptestboard Loading Patterns", "[.ctbintegration]") {
     m.setPatternWord(addr, word);
     CHECK(m.setPatternWord(addr, -1) == word);
     addr = MAX_ADDR;
-    CHECK_THROWS_AS(m.setPatternWord(addr, word), sls::NonCriticalError);
+    CHECK_THROWS_AS(m.setPatternWord(addr, word), sls::RuntimeError);
     CHECK_THROWS_WITH(m.setPatternWord(addr, word),
                       Catch::Matchers::Contains("be between 0 and"));
     addr = -1;
-    CHECK_THROWS_AS(m.setPatternWord(addr, word), sls::NonCriticalError);
+    CHECK_THROWS_AS(m.setPatternWord(addr, word), sls::RuntimeError);
     CHECK_THROWS_WITH(m.setPatternWord(addr, word),
                       Catch::Matchers::Contains("be between 0 and"));
 

python/sls_detector/detector.py

@@ -1021,6 +1021,11 @@ class Detector:
         self._api.setNetworkParameter('rx_zmqip', ip, -1)
 
 
+
+    @property
+    def syncclk(self):
+        return self._api.getSyncClkSpeed(-1)
+
     @property
     def detectormac(self):
         """

python/src/Detector.h

@@ -214,6 +214,10 @@ class Detector {
         det.setSpeed(slsDetectorDefs::CLOCK_DIVIDER, speed);
     }
 
+    int getSyncClkSpeed(int det_id=-1){
+        return det.setSpeed(slsDetectorDefs::SYNC_CLOCK, -1, 0, det_id);
+    }
+
     void setDbitPipeline(const int value) {
         det.setSpeed(slsDetectorDefs::DBIT_PIPELINE, value);
     }

python/src/main.cpp

@@ -93,6 +93,7 @@ PYBIND11_MODULE(_sls_detector, m) {
         .def("checkOnline", &Detector::checkOnline)
         .def("setReadoutClockSpeed", &Detector::setReadoutClockSpeed)
         .def("getReadoutClockSpeed", &Detector::getReadoutClockSpeed)
+        .def("getSyncClkSpeed", &Detector::getSyncClkSpeed)
         .def("getHostname", &Detector::getHostname)
         .def("setHostname", &Detector::setHostname)
 

slsDetectorSoftware/include/multiSlsDetectorClient.h

@@ -5,10 +5,10 @@
 #include "CmdLineParser.h"
 #include "CmdProxy.h"
 #include "container_utils.h"
-#include "string_utils.h"
 #include "multiSlsDetector.h"
 #include "slsDetectorCommand.h"
 #include "sls_detector_exceptions.h"
+#include "string_utils.h"
 
 #include <cstdlib>
 #include <memory>
@@ -27,14 +27,17 @@ class multiSlsDetectorClient {
                            std::ostream &output = std::cout)
         : action_(action), detPtr(myDetector), os(output) {
         parser.Parse(argc, argv);
+        if (parser.isHelp())
+            action_ = slsDetectorDefs::HELP_ACTION;
         runCommand();
-
     }
     multiSlsDetectorClient(const std::string &args, int action,
                            multiSlsDetector *myDetector = nullptr,
                            std::ostream &output = std::cout)
         : action_(action), detPtr(myDetector), os(output) {
         parser.Parse(args);
+        if (parser.isHelp())
+            action_ = slsDetectorDefs::HELP_ACTION;
         runCommand();
     }
 
@@ -108,7 +111,7 @@ class multiSlsDetectorClient {
         if (action_ != slsDetectorDefs::READOUT_ACTION) {
             sls::CmdProxy<multiSlsDetector> proxy(detPtr);
             auto cmd = proxy.Call(parser.command(), parser.arguments(),
-                                  parser.detector_id());
+                                  parser.detector_id(), action_);
             if (cmd.empty()) {
                 return;
             } else {

slsDetectorSoftware/src/slsDetector.cpp

@@ -3188,7 +3188,7 @@ void slsDetector::updateRateCorrection() {
             break;
         default:
             setRateCorrection(0);
-            throw sls::NonCriticalError(
+            throw sls::RuntimeError(
                 "Rate correction Deactivated, must be in 32 or 16 bit mode");
         }
     }

slsSupportLib/include/CmdLineParser.h

@@ -14,6 +14,7 @@ class CmdLineParser {
     int detector_id() const { return detector_id_; };
     int n_arguments() const { return arguments_.size(); }
     const std::string &command() const { return command_; }
+    bool isHelp() const{return help_;}
     void setCommand(std::string cmd){command_ = cmd;}
     const std::string &executable() const { return executable_; }
     const std::vector<std::string> &arguments() const { return arguments_; };
@@ -23,6 +24,7 @@ class CmdLineParser {
     void DecodeIdAndPosition(const char *c);
     int multi_id_ = 0;
     int detector_id_ = -1;
+    bool help_{false};
     std::string command_;
     std::string executable_;
     std::vector<std::string> arguments_;

slsSupportLib/include/CmdProxy.h

@@ -10,6 +10,7 @@
 #include "logger.h"
 #include "slsDetectorCommand.h"
 #include "sls_detector_exceptions.h"
+#include "sls_detector_defs.h"
 #include "string_utils.h"
 
 namespace sls {
@@ -20,7 +21,8 @@ template <typename T> class CmdProxy {
 
     std::string Call(const std::string &command,
                      const std::vector<std::string> &arguments,
-                     int detector_id) {
+                     int detector_id,
+                     int action=-1) {
         cmd = command;
         args = arguments;
         det_id = detector_id;
@@ -29,7 +31,7 @@ template <typename T> class CmdProxy {
 
         auto it = functions.find(cmd);
         if (it != functions.end()) {
-            std::cout << ((*this).*(it->second))();
+            std::cout << ((*this).*(it->second))(action);
             return {};
         } else {
             return cmd;
@@ -57,7 +59,7 @@ template <typename T> class CmdProxy {
     std::vector<std::string> args;
     int det_id{-1};
 
-    using FunctionMap = std::map<std::string, std::string (CmdProxy::*)()>;
+    using FunctionMap = std::map<std::string, std::string (CmdProxy::*)(int)>;
     using StringMap = std::map<std::string, std::string>;
 
     // Initialize maps for translating name and function
@@ -91,7 +93,10 @@ template <typename T> class CmdProxy {
 
     // Mapped functions
 
-    std::string ListCommands() {
+    std::string ListCommands(int action) {
+        if (action==slsDetectorDefs::HELP_ACTION)
+            return "list - lists all available commands, list deprecated - list deprecated commands\n";
+
         if (args.size() == 0) {
             auto commands = slsDetectorCommand(nullptr).getAllCommands();
             for (const auto &it : functions)

slsSupportLib/include/sls_detector_exceptions.h

@@ -27,49 +27,39 @@ public:
 	}
 };
 
-struct CriticalError : public RuntimeError {
+struct SharedMemoryError : public RuntimeError {
 public:
-    CriticalError(std::string msg):RuntimeError(msg) {}
+    SharedMemoryError(std::string msg):RuntimeError(msg) {}
 };
 
-struct SharedMemoryError : public CriticalError {
+struct SocketError : public RuntimeError {
 public:
-    SharedMemoryError(std::string msg):CriticalError(msg) {}
+	SocketError(std::string msg):RuntimeError(msg) {}
 };
 
-struct SocketError : public CriticalError {
+struct ZmqSocketError : public RuntimeError {
 public:
-	SocketError(std::string msg):CriticalError(msg) {}
+	ZmqSocketError(std::string msg):RuntimeError(msg) {}
 };
 
-struct ZmqSocketError : public CriticalError {
+struct NotImplementedError : public RuntimeError {
 public:
-	ZmqSocketError(std::string msg):CriticalError(msg) {}
+	NotImplementedError(std::string msg):RuntimeError(msg) {}
 };
 
-struct NonCriticalError : public RuntimeError {
+struct DetectorError : public RuntimeError {
 public:
-    NonCriticalError(std::string msg):RuntimeError(msg) {}
+	DetectorError(std::string msg):RuntimeError(msg) {}
 };
 
-struct NotImplementedError : public NonCriticalError {
+struct ReceiverError : public RuntimeError {
 public:
-	NotImplementedError(std::string msg):NonCriticalError(msg) {}
+	ReceiverError(std::string msg):RuntimeError(msg) {}
 };
 
-struct DetectorError : public NonCriticalError {
+struct GuiError : public RuntimeError {
 public:
-	DetectorError(std::string msg):NonCriticalError(msg) {}
+	GuiError(std::string msg):RuntimeError(msg) {}
-};
-
-struct ReceiverError : public NonCriticalError {
-public:
-	ReceiverError(std::string msg):NonCriticalError(msg) {}
-};
-
-struct GuiError : public NonCriticalError {
-public:
-	GuiError(std::string msg):NonCriticalError(msg) {}
 };
 
 }

slsSupportLib/src/CmdLineParser.cpp

@@ -1,5 +1,6 @@
 
 #include "CmdLineParser.h"
+#include "sls_detector_defs.h"
 #include <cstdio>
 #include <cstring>
 #include <iostream>
@@ -20,22 +21,37 @@ void CmdLineParser::Print() {
     std::cout << "\n\n";
 };
 
-void CmdLineParser::Parse(int argc, const char * const argv[]) {
+void CmdLineParser::Parse(int argc, const char *const argv[]) {
-    executable_ = argv[0]; //first arg is calling binary
+    executable_ = argv[0]; // first arg is calling binary
     if (argc > 1) {
-        DecodeIdAndPosition(argv[1]);
+        std::string s = argv[1];
         for (int i = 2; i < argc; ++i) {
-            arguments_.emplace_back(argv[i]);
+            s += " ";
+            s += argv[i];
         }
+        Parse(s);
     }
 }
 
 void CmdLineParser::Parse(const std::string &s) {
     std::istringstream iss(s);
     auto it = std::istream_iterator<std::string>(iss);
-    command_ = *it++;
     arguments_ =
         std::vector<std::string>(it, std::istream_iterator<std::string>());
+    auto old_size = arguments_.size();
+    arguments_.erase(std::remove_if(begin(arguments_), end(arguments_),
+                                     [](const std::string &item) {
+                                         if (item == "-h" || item == "--help")
+                                             return true;
+                                         return false;
+                                     }),
+                      end(arguments_));
+    if (old_size - arguments_.size() > 0)
+        help_ = true;
+    if(!arguments_.empty()){
+        command_ = arguments_[0];
+        arguments_.erase(begin(arguments_));
+    }
     DecodeIdAndPosition(command_.c_str());
 }
 
@@ -47,7 +63,7 @@ void CmdLineParser::DecodeIdAndPosition(const char *c) {
     if (contains_id && contains_pos) {
         int r = sscanf(c, "%d-%d:%s", &multi_id_, &detector_id_, tmp);
         if (r != 3) {
-            throw(std::invalid_argument(
+            throw(sls::RuntimeError(
                 "Cannot decode client or detector id from: \"" +
                 std::string(c) + "\"\n"));
         }
@@ -55,15 +71,15 @@ void CmdLineParser::DecodeIdAndPosition(const char *c) {
     } else if (contains_id && !contains_pos) {
         int r = sscanf(c, "%d-%s", &multi_id_, tmp);
         if (r != 2) {
-            throw(std::invalid_argument("Cannot decode client id from: \"" +
+            throw(sls::RuntimeError("Cannot decode client id from: \"" +
-                                        std::string(c) + "\"\n"));
+                                    std::string(c) + "\"\n"));
         }
         command_ = tmp;
     } else if (!contains_id && contains_pos) {
         int r = sscanf(c, "%d:%s", &detector_id_, tmp);
         if (r != 2) {
-            throw(std::invalid_argument("Cannot decode detector id from: \"" +
+            throw(sls::RuntimeError("Cannot decode detector id from: \"" +
-                                        std::string(c) + "\"\n"));
+                                    std::string(c) + "\"\n"));
         }
         command_ = tmp;
     } else {

slsSupportLib/tests/test-CmdLineParser.cpp

@@ -116,12 +116,51 @@ SCENARIO("Parsing a string with the command line parser", "[support]") {
     }
 }
 
+SCENARIO("Parsing strings with -h or --help", "[support]") {
+    GIVEN("A parser") {
+        CmdLineParser p;
+        WHEN("Parsing a string with a command and help ") {
+            std::string s = "-h list";
+
+            THEN("the command is correct and isHelp is set") {
+                p.Parse(s);
+                REQUIRE(p.detector_id() == -1);
+                REQUIRE(p.multi_id() == 0);
+                REQUIRE(p.command() == "list");
+                REQUIRE(p.isHelp());
+                REQUIRE(p.arguments().empty());
+                REQUIRE(p.argv().size() == 1);
+            }
+        }
+        WHEN("Parsing a string with -h at a different position"){
+            std::string s = "list -h something";
+            THEN("its also done right"){
+                p.Parse(s);
+                REQUIRE(p.isHelp());
+                REQUIRE(p.command() == "list");
+                REQUIRE(p.arguments().size() == 1);
+                REQUIRE(p.arguments().front() == "something");
+            }
+        }
+        WHEN("Parsing a string with -help at a different position"){
+            std::string s = "list --help something";
+            THEN("its also done right"){
+                p.Parse(s);
+                REQUIRE(p.isHelp());
+                REQUIRE(p.command() == "list");
+                REQUIRE(p.arguments().size() == 1);
+                REQUIRE(p.arguments().front() == "something");
+            }
+        }
+    }
+}
+
 TEST_CASE("Parse with no arguments results in no command and default id",
           "[support]") {
     // build up argc and argv
     // first argument is the command used to call the binary
     int argc = 1;
-    const char* const argv[]{"call"};
+    const char *const argv[]{"call"};
     CmdLineParser p;
     p.Parse(argc, argv);
 
@@ -135,7 +174,7 @@ TEST_CASE(
     "Parse a command without client id and detector id results in default",
     "[support]") {
     int argc = 2;
-    const char*const argv[]{"caller", "vrf"};
+    const char *const argv[]{"caller", "vrf"};
     CmdLineParser p;
     p.Parse(argc, argv);
 
@@ -148,7 +187,7 @@ TEST_CASE(
 TEST_CASE("Parse a command with value but without client or detector id",
           "[support]") {
     int argc = 3;
-    const char* const argv[]{"caller", "vrf", "3000"};
+    const char *const argv[]{"caller", "vrf", "3000"};
     CmdLineParser p;
     p.Parse(argc, argv);
 
@@ -161,7 +200,7 @@ TEST_CASE("Parse a command with value but without client or detector id",
 
 TEST_CASE("Decodes position") {
     int argc = 2;
-    const char*const argv[]{"caller", "7:vrf"};
+    const char *const argv[]{"caller", "7:vrf"};
 
     CmdLineParser p;
     p.Parse(argc, argv);
@@ -174,7 +213,7 @@ TEST_CASE("Decodes position") {
 
 TEST_CASE("Decodes double digit position", "[support]") {
     int argc = 2;
-    const char* const argv[]{"caller", "73:vcmp"};
+    const char *const argv[]{"caller", "73:vcmp"};
     CmdLineParser p;
     p.Parse(argc, argv);
 
@@ -186,7 +225,7 @@ TEST_CASE("Decodes double digit position", "[support]") {
 
 TEST_CASE("Decodes position and id", "[support]") {
     int argc = 2;
-    const char* const argv[]{"caller", "5-8:vrf"};
+    const char *const argv[]{"caller", "5-8:vrf"};
     CmdLineParser p;
     p.Parse(argc, argv);