Utility scripts

The package ships with some command-line utility scripts. Every script (including parser_test.py) accepts -v, -vv and -vvv as a way to increase logging level.

  • bb2csv - Blackbox log to CSV converter utility

  • bbsplit - Split logging sessions into separate files

  • bb2gpx - Convert blackbox log with GPS data to GPX

bb2csv

Blackbox log to CSV converter utility.

Examples:

  • Export the 2nd session to a file called btfl_all.2.csv:

$ bb2csv btfl_all.bbl -i 2 -o btfl_all.2.csv

  • Print CSV to stdout with debug info enabled:

$ bb2csv -vvv btfl_all.2.bbl

Help

usage: bb2csv [-h] [-o PATH] [-i LOG_INDEX] [-v] path

positional arguments:
  path                  Path to a blackbox log file

optional arguments:
  -h, --help            show this help message and exit
  -o PATH, --output PATH
                        Optional path to an output file (otherwise use standard output) (default: None)
  -i LOG_INDEX, --index LOG_INDEX
                        Log index number (In case of merged input) (default: 1)
  -a, --allow-invalid-header
                        Allow skipping of badly formatted headers (default: False)
  -v                    Control verbosity (can be used multiple times) (default: 0)

bbsplit

Split logging sessions into separate files. When using the -n or --dry-run option it will only output the number of sessions in the file and some additional info.

Output filenames are generated as follows:

${ORIG_NAME}.${INDEX}.${ORIG_EXT}

Examples:

  • Split btfl_all.bbl into files

$ bbsplit btfl_all.bbl

This will create the following files in the current directory:

btfl_all.1.bbl
btfl_all.2.bbl
...
btfl_all.[\d]+.bbl

  • Do the same but save the output to a directory named exported

$ bbsplit -o /path/to/exported btfl_all.bll

Help

usage: bbsplit [-h] [-o DIR] [-v] [-n] path

positional arguments:
  path                  Path to a blackbox log file

optional arguments:
  -h, --help            show this help message and exit
  -o DIR, --output DIR  Optional path to output directory, defaults to parent directory of the original log file (default: None)
  -a, --allow-invalid-header
                        Allow skipping of badly formatted headers (default: False)
  -v                    Control verbosity (can be used multiple times) (default: 0)
  -n, --dry-run         Do not write anything (default: False)

bb2gpx

Convert blackbox log with GPS data to GPX. GPX is a standard XML-based data format for sharing GPS data. Such files can be opened by Google Earth and many other software.

Help

usage: bb2gpx [-h] [-o PATH] [-n NAME] [-i LOG_INDEX] [-v] path

positional arguments:
  path                  Path to a blackbox log file

options:
  -h, --help            show this help message and exit
  -o PATH, --output PATH
                        Optional path to an output file (otherwise use standard output) (default: None)
  -n NAME, --name NAME  Name for the GPX document (default: Blackbox Log)
  -i LOG_INDEX, --index LOG_INDEX
                        Log index number or all if not specified (default) (default: 0)
  -a, --allow-invalid-header
                        Allow skipping of badly formatted headers (default: False)
  -v                    Control verbosity (can be used multiple times) (default: 0)