ecatgen

Synapticon EtherCAT Generator

Generate SOMANET Software source code and documentation from EtherCAT Slave Information (ESI).

Installation

$ npm install -g ecatgen

Usage

Usage: ecatgen [options] [command]

CLI to generate SOMANET Software source code and documentation from EtherCAT Slave Information (ESI).

Options:
  -V, --version                      output the version number
  -h, --help                         display help for command

Commands:
  generate [options] <esi-filepath>  generate individual source code and documentation files from ESI file
  zip [options] <esi-filepath>       generate and zip source code and documentation from ESI file
  property-to-xml <esi-filepath>     convert documentation and options from Property to XML
  help [command]                     display help for command

Usage: ecatgen generate [options] <esi-filepath>

generate individual source code and documentation files from ESI file

Arguments:
  esi-filepath           ESI file to load and generate from

Options:
  -d, --device <index>   for which device to generate
  -f, --file <filename>  see the list of supported files
  -h, --help             display help for command

Supported files:
  co_dictionary.c
  enum_dictionary.c
  dictionary_symbols.h
  dictionary_options.h
  documentation.html
  eds

Examples:
  ecatgen generate --device 0 --file co_dictionary.c ./esi/SOMANET_CiA_402.xml
  ecatgen generate --device 0 --file enum_dictionary.c ./esi/SOMANET_CiA_402.xml
  ecatgen generate -d 0 -f co_dictionary.c ./esi/SOMANET_CiA_402.xml
  ecatgen generate -d 1 -f co_dictionary.c ./esi/SOMANET_CiA_402_multi_device.xml
  ecatgen generate --device 0 --file dictionary_symbols.h ./esi/SOMANET_CiA_402.xml
  ecatgen generate --device 0 --file dictionary_options.h ./esi/SOMANET_CiA_402.xml
  ecatgen generate --device 0 --file documentation.html ./esi/SOMANET_CiA_402.xml
  ecatgen generate -d 1 -f documentation.html ./esi/SOMANET_CiA_402_multi_device.xml
  ecatgen generate -d 0 -f eds ./esi/SOMANET_CiA_402.xml

Usage: ecatgen zip [options] <esi-filepath>

generate and zip source code and documentation from ESI file

Arguments:
  esi-filepath                          ESI file to load and generate from

Options:
  -d, --device [index]                  optional device index for which to generate source code
  -o --output <filepath>
  -t, --type <all|all-sii|doc|doc-old>  generate all files or just documentation
  -h, --help                            display help for command

Examples:
  ecatgen zip --type all --output single.zip ./esi/SOMANET_CiA_402.xml
  ecatgen zip --type all --output multi.zip ./esi/SOMANET_CiA_402_multi_device.xml
  ecatgen zip --type all-sii --output multi.zip ./esi/SOMANET_CiA_402_multi_device.xml
  ecatgen zip --device 0 -t all -o device0.zip ./esi/SOMANET_CiA_402_multi_device.xml
  ecatgen zip -d 1 -t all -o device1.zip ./esi/SOMANET_CiA_402_multi_device.xml
  ecatgen zip -t all -o multi.zip ./esi/SOMANET_CiA_402_multi_device.xml
  ecatgen zip --type doc -o multi_documentation.zip ./esi/SOMANET_CiA_402_multi_device.xml
  ecatgen zip --type doc-old -o documentation_old.zip ./esi/SOMANET_CiA_402_device.xml

Usage: ecatgen property-to-xml [options] <esi-filepath>

convert documentation and options from Property to XML

Arguments:
  esi-filepath  ESI file to load and convert

Options:
  -h, --help    display help for command

Examples:
  ecatgen property-to-xml ./esi/SOMANET_CiA_402.xml