diff --git a/README.adoc b/README.adoc index 36a1153451dfac763c4f2e6302ebbdad05ffde01..74193f2e6305f0874cdd790d525fb2e1090aa67c 100644 --- a/README.adoc +++ b/README.adoc @@ -15,7 +15,7 @@ To deploy on the RCM, move into dir and execute install_rcm.sh. -= Basic usages += Command Line Interface: Basic usages == Classic: stop, config, start @@ -33,73 +33,56 @@ This do not start the FOFB, only the communication. WARNING: PSC will receive frames upon start. Better stop the FOFB beforehand. The CLI won't let you do that. - - -[%collapsible%open] -==== [source,console] ---- -$ FofbTool --stop --config --start -INFO : Stopping CCN on ANS/DG/FOFB-CELLNODE-C01 -INFO : Stopping ComBpm on ANS/DG/FOFB-CELLNODE-C01 -INFO : Stopping CCN on ANS/DG/FOFB-CELLNODE-C06 -INFO : Stopping ComBpm on ANS/DG/FOFB-CELLNODE-C06 -INFO : Stopping CCN on ANS/DG/FOFB-CELLNODE-C09 -INFO : Stopping ComBpm on ANS/DG/FOFB-CELLNODE-C09 -INFO : Stopping CCN on ANS/DG/FOFB-CELLNODE-C14 -INFO : Stopping ComBpm on ANS/DG/FOFB-CELLNODE-C14 -INFO : Stopping CCN on ANS/DG/FOFB-CENTRALNODE -INFO : Configuration of ComBpm done on ANS/DG/FOFB-CELLNODE-C01. -INFO : Configuration of ComCorr done on ANS/DG/FOFB-CELLNODE-C01. -INFO : Configuration of CCN done on ANS/DG/FOFB-CELLNODE-C01. -INFO : Configuration of ComBpm done on ANS/DG/FOFB-CELLNODE-C06. -INFO : Configuration of ComCorr done on ANS/DG/FOFB-CELLNODE-C06. -INFO : Configuration of CCN done on ANS/DG/FOFB-CELLNODE-C06. -INFO : Configuration of ComBpm done on ANS/DG/FOFB-CELLNODE-C09. -INFO : Configuration of ComCorr done on ANS/DG/FOFB-CELLNODE-C09. -INFO : Configuration of CCN done on ANS/DG/FOFB-CELLNODE-C09. -INFO : Configuration of ComBpm done on ANS/DG/FOFB-CELLNODE-C14. -INFO : Configuration of ComCorr done on ANS/DG/FOFB-CELLNODE-C14. -INFO : Configuration of CCN done on ANS/DG/FOFB-CELLNODE-C14. -INFO : Configuration of CCN done on ANS/DG/FOFB-CENTRALNODE. -INFO : Configuration of Corr done on ANS/DG/FOFB-CENTRALNODE. -INFO : Starting CCN on ANS/DG/FOFB-CELLNODE-C01 -INFO : Starting ComBpm on ANS/DG/FOFB-CELLNODE-C01 -INFO : Ack CCN error on ANS/DG/FOFB-CELLNODE-C01 -INFO : Starting CCN on ANS/DG/FOFB-CELLNODE-C06 -INFO : Starting ComBpm on ANS/DG/FOFB-CELLNODE-C06 -INFO : Ack CCN error on ANS/DG/FOFB-CELLNODE-C06 -INFO : Starting CCN on ANS/DG/FOFB-CELLNODE-C09 -INFO : Starting ComBpm on ANS/DG/FOFB-CELLNODE-C09 -INFO : Ack CCN error on ANS/DG/FOFB-CELLNODE-C09 -INFO : Starting CCN on ANS/DG/FOFB-CELLNODE-C14 -INFO : Starting ComBpm on ANS/DG/FOFB-CELLNODE-C14 -INFO : Ack CCN error on ANS/DG/FOFB-CELLNODE-C14 -INFO : Starting CCN on ANS/DG/FOFB-CENTRALNODE +$ FofbTool --stop --config every --start ---- -==== == Configure OPCUAProxy DS Upon restart of OPCUAProxy Tango DS, to reapply attribute configuration (units, alarm level, descriptions...) -[%collapsible%open] -==== [source,console] ---- -$ FofbTool --confDS -INFO : Apply attribute configuration on device ANS/DG/FOFB-CELLNODE-C09 -INFO : Apply attribute configuration on device ANS/DG/FOFB-CELLNODE-C14 -INFO : Apply attribute configuration on device ANS/DG/FOFB-CENTRALNODE -INFO : Apply attribute configuration on device ANS/DG/FOFB-CELLNODE-C06 -INFO : Apply attribute configuration on device ANS/DG/FOFB-CELLNODE-C01 ----- +$ FofbTool --DS-conf -==== +---- +== More help +[source,console] +---- +usage: FofbTool [-h] [--log LOG] [--conf-file CONF_FILE] [--DS-init-opcua] + [--DS-init-watcher] [--DS-conf] [--stop] [--stop-combpm] + [--stop-ccn] + [--configure {combpm,ccn,comcorr,corr,all,every} [{combpm,ccn,comcorr,corr,all,every} ...]] + [--start] [--start-combpm] [--start-ccn] + +optional arguments: + -h, --help show this help message and exit + --log LOG Log level (error, warning, info, debug) + --conf-file CONF_FILE + Path to config file to apply. + --DS-init-opcua Run init on opcua devices. + --DS-init-watcher Run init on the Fofb-Watcher device, and then the + Fofb-Command. + --DS-conf Applying attribute configuration on Tango Device + Servers. This is required after restart of devices. + --stop Stop command for the CCN and ComBPM applications + blocks. + --stop-combpm Stop command for the ComBPM applications blocks. + --stop-ccn Stop command for the ComBPM applications blocks. + --configure {combpm,ccn,comcorr,corr,all,every} [{combpm,ccn,comcorr,corr,all,every} ...] + Configuration commands for the Fofb applications + blocs. 'all' is for all com, not configuring + corrector. 'every' configure everything. + --start Start command for the CCN and ComBPM applications + blocks. + --start-combpm Start command for the ComBPM applications blocks. + --start-ccn Start command for the ComBPM applications blocks. +----