Description

NMEA Generator is a drawing tool for generating GPS logs in NMEA format. Being a web application consisting of a single HTML file, it can be opened in a web browser and used directly without the need for any installation or configuration work.

This project contains the script (written in Python 3) used to build the NMEA Generator. An example of a publicly available instance of this tool can be found on nmeagen.org.

License

All files from this project are licensed under the GPLv3 except for those belonging to the following projects:

• jQuery: licensed under the MIT license.
• Leaflet: licensed under the 2-clause BSD license.
• Leaflet.PolylineDecorator: licensed under the MIT license.
• Leaflet Search: licensed under the MIT license.
• nmea-0183: licensed under the MIT license.

See the LICENSE file for more information.

Required modules

All Python modules needed to build the NMEA Generator are listed in the requirements.txt file. You can install them with the following command:

pip3 install -r requirements.txt

Usage instructions

To build the NMEA Generator, simply run the following command:

./build

This will compile the NMEA Generator application as an HTML file named index.html on the current working directory. If you wish to specify another name or location for the output HTML file, use the -o option:

./build -o /path/to/nmeagen.html

Running the functional tests

The NMEA Generator contains a set of functional tests which can be executed in a web browser or in a terminal.

To execute the tests in a web browser, load the NMEA Generator and then invoke the runTests() function in the browser's console.

To execute the tests in a terminal, run:

npm install puppeteer
./run-tests /path/to/nmeagen.html

Contributors & contact information

Diego Assencio / [email protected]