Skip to content
Snippets Groups Projects
Commit badc54d3 authored by BRONES Romain's avatar BRONES Romain
Browse files

Clean the Readme

parent e29f363e
Branches
Tags
No related merge requests found
......@@ -7,13 +7,10 @@ The module is packaged in sections
* FofbTool.Configuration: For application configuration
* FofbTool.Operation: Function to perform operation (start, stop...)
* FofbTool.DeviceAttributeConfiguration: contains functions to apply tango attribute configuration
* FofbTool.Utils: Usefull function that relies on ConfigParser files and call the operation/configuration. Used by the command line tool.
There is also a Command Line Interface bin/FofbTool written in python.
To deploy on the RCM, move into dir and execute install_rcm.sh.
= Command Line Interface: Basic usages
......@@ -35,9 +32,22 @@ WARNING: PSC will receive frames upon start. Better stop the FOFB beforehand. Th
[source,console]
----
$ FofbTool --stop --config every --start
$ FofbTool --stop --conf --start
----
== Synchronize BPMs
[source,console]
----
$ FofbTool --sync
----
== Align Electron and LBP FA stream
[source,console]
----
$ FofbTool --align-fa cellnode-c09
----
== Configure OPCUAProxy DS
......@@ -54,16 +64,21 @@ $ FofbTool --DS-conf
[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]
usage: FofbTool [-h] [--log LOG] [--force] [--fileconfig FILECONFIG]
[--DS-init-opcua] [--DS-init-watcher] [--DS-conf] [--stop]
[--stop-combpm] [--stop-ccn] [--stop-comlbp]
[--dump-configuration DUMP_CONFIGURATION]
[--configure [{combpm,ccn,comcorr,corr,all}]]
[--align-fa cellnode-cXX] [--nolbp] [--start] [--start-combpm]
[--start-comlbp] [--start-ccn] [--sync]
version x.x
optional arguments:
-h, --help show this help message and exit
--log LOG Log level (error, warning, info, debug)
--conf-file CONF_FILE
--force Force operation even if FOFB is running.
--fileconfig FILECONFIG
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
......@@ -74,14 +89,27 @@ optional arguments:
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} ...]
--stop-comlbp Stop command for the ComLBP applications blocks.
--dump-configuration DUMP_CONFIGURATION
Dump the current configuration in a file at the giver
path.
--configure [{combpm,ccn,comcorr,corr,all}]
Configuration commands for the Fofb applications
blocs. 'all' is for all com, not configuring
corrector. 'every' configure everything.
blocs. 'all' is for all com and corrector. Default is
'all'
--align-fa cellnode-cXX
Start alignement process for electron and brillance
plus FA sequence. The designation of the cellnode must
be set as argument.
--nolbp Do not start comlbp module when doing start.
--start Start command for the CCN and ComBPM applications
blocks.
--start-combpm Start command for the ComBPM applications blocks.
--start-comlbp Start command for the ComLBP applications blocks.
--start-ccn Start command for the ComBPM applications blocks.
--sync Start synchronization sequence for Libera Electron and
Libera Brillance Plus.
----
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment