Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/katysaintin/phoebus
Browse files Browse the repository at this point in the history
Add doc for the converter
  • Loading branch information
lr279911 authored and lr279911 committed Jul 11, 2024
1 parent 0aa9748 commit 6b8326d
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs/source/convertor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
=================
AdvancedConvertor
=================

OPI to BOB convertor
--------------------


Table:

+ Description
+ Command Line

Description
------------

AdvancedConverter is a tool to convert massively and recursively CSS OPI to Phoebus BOB files. It will automatically convert the widgets and their properties from the legacy file format.

The converter takes folder or files and convert any OPI files into a BOB files (without delete previous OPI files).
The programm keep the hierarchy, subfolders, scrypt and files inside.

Command Line
------------
To use this AdvancedConvertor, you can do it via this command line invocation:

Usage: Usage: -main org.csstudio.display.builder.model.AdvancedConverter [-help] [-output /path/to/folder] </path/to/opi/folder>

Converts BOY "*".opi files to Display Builder "*".bob format

**-output** /path/to/folder - Folder into which converted files are written

<files> - One or more files to convert

Exemples :
*Convert and copy in another folder*

**-main org.csstudio.display.builder.model.AdvancedConverter** *-output* **output/path/to/folder input/path/to/folder**

*Convert and stay in the folder*

**-main org.csstudio.display.builder.model.AdvancedConverter input/path/to/folder**




0 comments on commit 6b8326d

Please sign in to comment.