Scripts

After installation of the pyawe_awb package the following scripts are available:

awb-file

usage: awb-file [-h] [-v] [--show-coreids] [--show-pininfo] [--show-cmdindex]
                [-p POSITION] [-f] [--cmdindex CMDINDEX] [--as_string]
                [--coreid COREID | --offset OFFSET] [-o OUTPUT]
                awb_file

AWB file parser and modifier.
Version: 1.0.2

positional arguments:
  awb_file              path to the AWB file

options:
  -h, --help            show this help message and exit
  -v, --verbose         Enables more verbosity. Use -vv to get even more.
  -p POSITION, --position POSITION
                        Show the AWB command at a specific (word) position
  -f, --flatten         In case this AWB contains BundlePackets, the commands in the bundles will be extracted. Only works with un-encrypted data.
  --cmdindex CMDINDEX   Show the AWB command at a specific command index
  --as_string           When using --cmdindex, the command member 'payload.values' is printed as ASCII string. This only applies to UINT32 packed strings, typically found in SetValue* commands
  --coreid COREID       Change all coreID values to a new value.
  --offset OFFSET       If this parameter is used instead of --coreid, it will offset all coreID values by the given value.
  -o OUTPUT, --output OUTPUT
                        Specifies the output file when AWB content is going to be changed.

Print specific information:
  --show-coreids        Display the coreID (instance ID) values used in the AWB file
  --show-pininfo        Show layout information instead of printing whole content
  --show-cmdindex       Also display command index when printing file. Index can be used with '--cmdindex' then

awb-trace

usage: awb-trace [-h] [-v] [--ignore IGNORE] [-m matlab_command.log]
                 packet.log

Parse packet and matlab_command log.
Version: 1.0.2

positional arguments:
  packet.log            Path to a packet.log file

options:
  -h, --help            show this help message and exit
  -v, --verbose         Enables more verbosity. Use -vv to get even more.
  --ignore IGNORE       Regex expr of command modules to ignore /filter out
  -m matlab_command.log, --matlab matlab_command.log
                        Optional: if given this is a matlab communication log. It will be interleaved with packet log output.

awb-diff

usage: awb-diff [-h] [-v] [-o OUTPUT] awb_file awb_file

Diffs 2 AWB files.
The result are the commands which are available in the secondfile but not in the first.

Usually this is used to derive 'tuning' commands.Version: 1.0.2

positional arguments:
  awb_file              Paths to two AWB files.

options:
  -h, --help            show this help message and exit
  -v, --verbose         Enables more verbosity. Use -vv to get even more.
  -o OUTPUT, --output OUTPUT
                        Specifies an output file to store the delta AWB.

awb-docs

usage: awb-docs [-h]

Shows the link for the HTML documentation.

options:
  -h, --help  show this help message and exit