questions about plugin doc

[PhilLAL]

Hi, reading the plugin doc, I have several questions:

• in https://lima-doc.readthedocs.io/en/latest/plugin_getting_started/index.html#generic-interface Label "figure 1" is not attached to the image into the PDF
• in the same part, asterisk should be explained for items Extended, Specific
• if Interface and HwInterface have the same content, command list miss several commands : reset(), getNbHwAquiredFramed(), getCamera(), and some commands should be renamed: prepare() => prepareAcq(), start() => startAcq(), stop() => stopAcq() But it seems one is free to implement HwInterface as we want, am I right?
• in https://lima-doc.readthedocs.io/en/latest/plugin_getting_started/index.html#hardware-interface-hwinterface the doc is not clear if getStatus() returns a type with several fields (AcqStatus, DetStatus, DetStatusMask) or an union (I understand from hardware/include/lima/HwInterface.h it contains those 3 fields)
• in https://lima-doc.readthedocs.io/en/latest/plugin_getting_started/index.html#detector-information it is not clear for me when getMaxImageSize () and getDetectorImageSize() are different?
• in https://lima-doc.readthedocs.io/en/latest/plugin_getting_started/index.html#detector-information in getCurrImageSize() : is it current maximum image size or current image size ?
• in https://lima-doc.readthedocs.io/en/latest/plugin_getting_started/index.html#source-code it is written "DetectorNameBufferCtrlObj.cpp : capabilities to control the image memory buffer allocation (mandatory)" but Andor camera and Simulator have not this class
• in https://lima-doc.readthedocs.io/en/latest/plugin_getting_started/index.html#source-code it is written "DetectorNameCamera.cpp : interface class with the detector librairies (mandatory)" but PerkinElmer camera has not this class

It would help me if you could give me some details. Thank you.

[sdebionne]

Hi Phil, I'll try to address the issues or required clarifications with a doc update, hopefully by the end of week.

[sdebionne]

FYI, here is the WIP improved doc.

• Interface must implement all the pure virtual menber functions of HwInterface so prepareAcq(), start() => startAcq(), stop() => stopAcq(), etc...
• getStatus() return a tuple (a struct) with AcqStatus, DetStatus det, DetStatus det_mask