Merge branch 'developer' of github.com:slsdetectorgroup/slsDetectorPackage into developer

python/slsdet/detector.py

@@ -1492,6 +1492,13 @@ class Detector(CppDetectorApi):
     @property
     @element
     def temp_threshold(self):
+        """
+        [Jungfrau] Threshold temperature in degrees. 
+        Note
+        -----
+        If temperature crosses threshold temperature and temperature control is enabled, power to chip will be switched off and temperature event occurs. \n
+        To power on chip again, temperature has to be less than threshold temperature and temperature event has to be cleared/reset.
+        """
         return self.getThresholdTemperature()
 
     @temp_threshold.setter
@@ -1501,6 +1508,14 @@ class Detector(CppDetectorApi):
     @property
     @element
     def temp_event(self):
+        """
+        [Jungfrau] 1, if a temperature event occured. \n
+        Note
+        ----
+        If temperature crosses threshold temperature and temperature control is enabled, power to chip will be switched off and temperature event occurs. \n
+        To power on chip again, temperature has to be less than threshold temperature and temperature event has to be cleared/reset.
+        :setter: To clear the event, set it to 0.
+        """
         return self.getTemperatureEvent()
 
     @temp_event.setter
@@ -1512,6 +1527,14 @@ class Detector(CppDetectorApi):
     @property
     @element
     def temp_control(self):
+        """
+        [Jungfrau] Temperature control enable. 
+        Note
+        -----
+        Default is 0 (disabled). \n
+        If temperature crosses threshold temperature and temperature control is enabled, power to chip will be switched off and temperature event occurs. \n
+        To power on chip again, temperature has to be less than threshold temperature and temperature event has to be cleared/reset.
+        """
         return self.getTemperatureControl()
 
     @temp_control.setter
@@ -1864,6 +1887,12 @@ class Detector(CppDetectorApi):
 
     @property
     def syncclk(self):
+        """
+        [Ctb][Moench] Sync clock in MHz.
+        Note
+        -----
+        :setter: Not implemented
+        """
         return element_if_equal(self.getSYNCClock())
 
     @property

slsDetectorSoftware/include/Detector.h

@@ -964,23 +964,24 @@ class Detector {
     /**
      * [Jungfrau]Set threshold temperature
      * If temperature crosses threshold temperature
-     * and temperature control is enabled,
+     * and temperature control is enabled (default is disabled), power to chip
-     * power to chip will be switched off and
+     * will be switched off and temperature event will be set. \n To power on
-     * temperature event will be set
+     * chip again, temperature has to be less than threshold temperature and
-     * val is value in degrees
+     * temperature event has to be cleared. val is value in degrees
      */
     void setThresholdTemperature(int temp, Positions pos = {});
 
     /** [Jungfrau] */
     Result<bool> getTemperatureControl(Positions pos = {}) const;
 
-    /** [Jungfrau] */
+    /** [Jungfrau]  refer to setThresholdTemperature
+     * Default is disabled */
     void setTemperatureControl(bool enable, Positions pos = {});
 
-    /** [Jungfrau] */
+    /** [Jungfrau] refer to setThresdholdTemperature */
     Result<int> getTemperatureEvent(Positions pos = {}) const;
 
-    /** [Jungfrau] */
+    /** [Jungfrau] refer to setThresdholdTemperature */
     void resetTemperatureEvent(Positions pos = {});
 
     /** [Jungfrau] */
@@ -1202,7 +1203,7 @@ class Detector {
     /** [CTB][Moench] */
     void setRUNClock(int value_in_MHz, Positions pos = {});
 
-    /** [CTB][Moench] */
+    /** [CTB][Moench]  in MHZ */
     Result<int> getSYNCClock(Positions pos = {}) const;
 
     /** [CTB][Moench] */