Add a Readme

README.adoc

+FofbTool script
+---------------
+
+This expert script helps to configure, stop and start the communication between the FofbNodes.
+
+
+Basic usages
+------------
+
+Classic: stop, config, start
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This stops the communication on all the nodes.
+Also stops Bpm to CellNode communication blocks.
+
+Then apply the default configuration on FPGA blocks:
+
+* ComCellNode (Expected packets, correct MAC size...)
+* ComBPM (BPM ID filter Filter for each CellNode...)
+* ComCorr (Default PSCID on output...)
+* Corr (Default correction filter...)
+
+IMPORTANT: This do not configure Orbit Reference or Inv Response Matrix.
+This do not start the FOFB, only the communication.
+
+WARNING: PSC will receive frames upon start. Better stop the FOFB beforehand.
+
+
+[%collapsible]
+====
+[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
+----
+
+====
+
+Configure OPCUAProxy DS
+~~~~~~~~~~~~~~~~~~~~~
+
+Upon restart of OPCUAProxy Tango DS, to reapply attribute configuration (units, alarm level, descriptions...)
+
+[%collapsible]
+====
+[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
+----
+
+====
+
+
+
+
+