detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-06-20 08:38:00 +02:00
Code Issues Actions Packages Releases Activity

wip, doc

Browse Source
This commit is contained in:
maliakal_d
2020-09-22 18:39:46 +02:00
parent ca0192e27e
commit bb575c6017
4 changed files with 106 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
slsDetectorSoftware/src/CmdProxy.cpp
View File

@ -1418,7 +1418,7 @@ std::string CmdProxy::PulsePixel(int action) {
os << cmd << ' ';
if (action == defs::HELP_ACTION) {
os << "[n_times] [x] [y]\n\t[Eiger] Pulse pixel n number of times at "
"coordinates (x, y)."
"coordinates (x, y). Advanced User!"
<< '\n';
} else if (action == defs::GET_ACTION) {
throw sls::RuntimeError("cannot get");
@ -1443,7 +1443,7 @@ std::string CmdProxy::PulsePixelAndMove(int action) {
os << cmd << ' ';
if (action == defs::HELP_ACTION) {
os << "[n_times] [x] [y]\n\t[Eiger] Pulse pixel n number of times and "
"moves relatively by (x, y)."
"moves relatively by (x, y). Advanced User!"
<< '\n';
} else if (action == defs::GET_ACTION) {
throw sls::RuntimeError("cannot get");
@ -1469,7 +1469,7 @@ std::string CmdProxy::PulseChip(int action) {
if (action == defs::HELP_ACTION) {
os << "[n_times] \n\t[Eiger] Pulse chip n times. If n is -1, resets to "
"normal mode (reset chip completely at start of acquisition, "
"where partialreset = 0)."
"where partialreset = 0). Advanced User!"
<< '\n';
} else if (action == defs::GET_ACTION) {
throw sls::RuntimeError("cannot get");
@ -1489,8 +1489,8 @@ std::string CmdProxy::Quad(int action) {
std::ostringstream os;
os << cmd << ' ';
if (action == defs::HELP_ACTION) {
os << "[0, 1]\n\t[Eiger] 0 is default. 1 sets detector size to a quad "
"(Specific hardware required)."
os << "[0, 1]\n\t[Eiger] Sets detector size to a quad. 0 (disabled) is "
"default. (Specific hardware required)."
<< '\n';
} else if (action == defs::GET_ACTION) {
if (!args.empty()) {
@ -1554,9 +1554,10 @@ std::string CmdProxy::ROI(int action) {
std::ostringstream os;
os << cmd << ' ';
if (action == defs::HELP_ACTION) {
os << "[xmin] [xmax] \n\t[Gotthard] Region of interest in detector. "
"Either all channels or a single adc or 2 chips (256 channels). "
"Default is all channels enabled (-1 -1). "
os << "[xmin] [xmax] \n\t[Gotthard] Region of interest in detector.\n\t"
"Options: Only a single ROI per module. \n\tEither all channels "
"or a single adc or 2 chips (256 channels). Default is all "
"channels enabled (-1 -1). "
<< '\n';
} else if (action == defs::GET_ACTION) {
if (!args.empty()) {
@ -2431,8 +2432,10 @@ std::string CmdProxy::ProgramFpga(int action) {
os << cmd << ' ';
if (action == defs::HELP_ACTION) {
os << "[fname.pof | fname.rbf]\n\t[Jungfrau][Ctb][Moench] Programs "
"FPGA from pof file."
<< "\n\t[Mythen3][Gotthard2] Programs FPGA from rbf file." << '\n';
"FPGA from pof file. Rebooting controller is recommended. "
"\n\t[Mythen3][Gotthard2] Programs FPGA from rbf file. Power "
"cycling the detector is recommended. "
<< '\n';
} else if (action == defs::GET_ACTION) {
throw sls::RuntimeError("Cannot get");
} else if (action == defs::PUT_ACTION) {
@ -2503,8 +2506,9 @@ std::string CmdProxy::Register(int action) {
os << cmd << ' ';
if (action == defs::HELP_ACTION) {
os << "[address] [32 bit value]\n\tReads/writes to a 32 bit register "
"in hex. Advanced Function!\n\t[Eiger] +0x100 for only left, "
"+0x200 for only right."
"in hex. Advanced Function!\n\tGoes to stop server. Hence, can "
"be called while calling blocking acquire(). \n\t[Eiger] +0x100 "
"for only left, +0x200 for only right."
<< '\n';
} else if (action == defs::GET_ACTION) {
if (args.size() != 1) {

29
slsDetectorSoftware/src/CmdProxy.h
View File

@ -1257,7 +1257,7 @@ class CmdProxy {
"\n\t[Gotthard2] only in continuous mode.");
TIME_GET_COMMAND(periodl, getPeriodLeft,
"\n\t[Gotthard][Jungfrau][Mythen3][Gotthard2][CTB][Moench]"
"\n\t[Gotthard][Jungfrau][CTB][Moench][Mythen3][Gotthard2]"
" Period left for current frame."
"\n\t[Gotthard2] only in continuous mode.");
@ -1294,14 +1294,11 @@ class CmdProxy {
INTEGER_COMMAND_VEC_ID(
powerchip, getPowerChip, setPowerChip, StringTo<int>,
"[0, 1]\n\t[Jungfrau][Mythen3][Gotthard2][Moench] Power "
"the chip. Default 0."
"\n\t[Jungfrau] Get will return power status."
"Can be off if temperature event occured (temperature over "
"temp_threshold with temp_control enabled."
"\n\t[Mythen3] If module not connected or wrong module, 1 "
"will fail. By default, not powered on"
"\n\t[Gotthard2] If module not connected or wrong module, "
"1 will fail. By default, powered on at server start up.");
"the chip. \n\t[Moench] Default is 0. \n\t[Jungfrau] Default is 0. Get "
"will return power status. Can be off if temperature event occured "
"(temperature over temp_threshold with temp_control "
"enabled.\n\t[Mythen3][Gotthard2] Default is 1. If module not "
"connected or wrong module, powerchip will fail.");
INTEGER_COMMAND_VEC_ID(
imagetest, getImageTestMode, setImageTestMode, StringTo<int>,
@ -1930,8 +1927,9 @@ class CmdProxy {
INTEGER_COMMAND_VEC_ID(
rx_framesperfile, getFramesPerFile, setFramesPerFile, StringTo<int>,
"[n_frames]\n\tNumber of frames per file in receiver. 0 is "
"infinite or all frames in single file.");
"[n_frames]\n\tNumber of frames per file in receiver in an "
"acquisition. Default depends on detector type. 0 is infinite or all "
"frames in single file.");
/* ZMQ Streaming Parameters (Receiver<->Client) */
@ -2022,8 +2020,8 @@ class CmdProxy {
INTEGER_COMMAND_VEC_ID(
readnlines, getPartialReadout, setPartialReadout, StringTo<int>,
"[1 - 256]\n\t[Eiger] Number of rows to readout per half module "
"starting from the centre. 256 is default. The permissible values "
"depend on dynamic range and 10Gbe enabled.");
"starting from the centre. Options: 0 - 256. 256 is default. The "
"permissible values depend on dynamic range and 10Gbe enabled.");
INTEGER_COMMAND_VEC_ID(
interruptsubframe, getInterruptSubframe, setInterruptSubframe,
@ -2314,7 +2312,7 @@ class CmdProxy {
EXECUTE_SET_COMMAND(rebootcontroller, rebootController,
"\n\t[Jungfrau][Ctb][Moench][Gotthard][Mythen3]["
"Gotthard2] Reboot controler (blackfin) of detector.");
"Gotthard2] Reboot controller of detector.");
EXECUTE_SET_COMMAND(
firmwaretest, executeFirmwareTest,
@ -2337,7 +2335,8 @@ class CmdProxy {
INTEGER_COMMAND_VEC_ID(
port, getControlPort, setControlPort, StringTo<int>,
"[n]\n\tPort number of the control server on detector for "
"detector-client tcp interface. Default is 1952. Normally unchanged.");
"detector-client tcp interface. Default is 1952. Normally unchanged. "
"Set different ports for virtual servers on same pc.");
INTEGER_COMMAND_VEC_ID(
stopport, getStopPort, setStopPort, StringTo<int>,