Welcome to genericWatchdog’s documentation!¶
Contents:
genericWatchdog Configuration¶
The steps to update the configuration from Karabo GUI¶
shut down the device,
set Init mode=True, press enter and instantiate the device,
login via putting your git account in “Username” property, wait until the status is INTERLOCK_OK
modify the configuration
press “Push to git”, wait until the status goes to “Pushed to git”,
then shutdown and initialize device in a normal mode, with Init mode=False.
(optionally) check whether the configuration is correct in git, the device should appear in the group:
Update configuration directly from the gitlab¶
The configurations of genericWatchdog devices, which were saved to gitlab, can be found in the group:
https://in.xfel.eu/gitlab/genericwatchdog
Example:
https://in.xfel.eu/gitlab/genericwatchdog/scs_xtd10_watchdog_mdl_yag_imges
The repo contains xml files which correspond to the tables which the user can find in the Confiration Panel of the device:
- importsTable
- inputsTable
- coeffsTable
- coeffsValues
- evaluationsTable
- extrasTable
- watchdogsTable
are tables of genericEstimator, and
- actuatorsTable
- actionsTable
are tables used by genericActuator device, in addition to the tables listed above.
It’s possible to create merge requests, invite people to reviewing, use gitlab search for finding the properties to be updated, and so on. After the change is merged to the master branch, it’s sufficient to restart the device, the changes should be pulled from the gitlab automatically.
genericWatchdog Tables¶
Structure of tables containing genericEstimator configuration¶
Tables which contain genericEstimator configuration (can be found in the Confiration Panel of the device):
Imported modules (key: importsTable)¶
Explanation:
- “From Module” means python module from which an object will be imported (e.g. karabo.middlelayer).
- “Imported Names” means python object that will be imported (e.g. math functions like sin, cos, tan, etc.).
Example:
| From Module | Imported Names |
|---|---|
| psutil | cpu_percent,cpu_count |
| math | sin, cos, tan, asin, acos |
Note
Importing from certain modules is forbidden. The user will receive
‘Importing {item} from {module} is forbidden’
while trying to import:
- any object from karabo.doocsapi:
- “remove” from os
- “rmtree” from shutil