From 02d4769f6a25a0ecd0345a2ed700a9c6186d5143 Mon Sep 17 00:00:00 2001 From: Dhanya Thattil Date: Wed, 9 Sep 2020 16:39:48 +0200 Subject: [PATCH] WIP --- python/slsdet/detector.py | 29 ++++++++++++++++++++++++++ slsDetectorSoftware/include/Detector.h | 17 ++++++++------- 2 files changed, 38 insertions(+), 8 deletions(-) diff --git a/python/slsdet/detector.py b/python/slsdet/detector.py index 2fd78f6a6..0a5e60aaf 100755 --- a/python/slsdet/detector.py +++ b/python/slsdet/detector.py @@ -1487,6 +1487,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 @@ -1496,6 +1503,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 @@ -1507,6 +1522,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 @@ -1859,6 +1882,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 diff --git a/slsDetectorSoftware/include/Detector.h b/slsDetectorSoftware/include/Detector.h index c85a0d683..244d30260 100644 --- a/slsDetectorSoftware/include/Detector.h +++ b/slsDetectorSoftware/include/Detector.h @@ -963,23 +963,24 @@ class Detector { /** * [Jungfrau]Set threshold temperature * If temperature crosses threshold temperature - * and temperature control is enabled, - * power to chip will be switched off and - * temperature event will be set - * val is value in degrees + * and temperature control is enabled (default is disabled), power to chip + * will be switched off and temperature event will be set. \n To power on + * chip again, temperature has to be less than threshold temperature and + * temperature event has to be cleared. val is value in degrees */ void setThresholdTemperature(int temp, Positions pos = {}); /** [Jungfrau] */ Result getTemperatureControl(Positions pos = {}) const; - /** [Jungfrau] */ + /** [Jungfrau] refer to setThresholdTemperature + * Default is disabled */ void setTemperatureControl(bool enable, Positions pos = {}); - /** [Jungfrau] */ + /** [Jungfrau] refer to setThresdholdTemperature */ Result getTemperatureEvent(Positions pos = {}) const; - /** [Jungfrau] */ + /** [Jungfrau] refer to setThresdholdTemperature */ void resetTemperatureEvent(Positions pos = {}); /** [Jungfrau] */ @@ -1201,7 +1202,7 @@ class Detector { /** [CTB][Moench] */ void setRUNClock(int value_in_MHz, Positions pos = {}); - /** [CTB][Moench] */ + /** [CTB][Moench] in MHZ */ Result getSYNCClock(Positions pos = {}) const; /** [CTB][Moench] */