README.md

u-blox Messages Parser

Features

As an executable

• Display the current serial port configuration in the YAML format
• Output the ublox messages read on the serial port in the JSON format

As a C library

• Iterate over all ublox messages read on the serial port
• Verbose alternatives to termios
• Extensive documentation

Build

$ make help

This Makefile allows one to build, run and test this ublox parser.

Usage:
  make <target>

General:
  default          When no target is specified, this help is displayed
  help             Display this help.
  raw_help         Display the help without color
  version          Display the project's version
  info             Print the project's name, version, copyright notice and author

Building:
  build            Compile both the library and the executable
  fbuild           Re-build everything from zero
  lib              Compile the (static) library

Run:
  run              Run the executable
  test             Compile and run unit tests

Documentation:
  doc              Generate all the documentation
  pdf              Generate and open the pdf documentation
  html             Generate and open the documentation as a local site on the browser
  man              Generate and open the ublox.h man page

Cleaning:
  clean            Remove intermediate objects
  fclean           Remove all generated files

Getting started

Setup your environment:

./setup.sh

You can now build and run the code, try:

make test

Usage

$ ./ublox_parser.exe --help
Usage: ublox_parser.exe [OPTION...] [PATH]
Prints serial port configuration and ublox messages.

  -p, --passive              Do not change the port configuration, only display
                             it.
  -?, --help                 Give this help list
      --usage                Give a short usage message
  -V, --version              Print program version

Report bugs to <antoine.gagniere@orolia2s.com>.