1.0.2 • Published 6 years ago

pangrango-cli v1.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
6 years ago

Pangrango CLI - pgo

pgo is a command line interface which enables easy access to compiling and flashing a Pangrango project. It wraps the makefile and JS build pipelines, and provides a hookable system for custom drivers.

The pgo pipeline is broken down into 4 distinct stages.

  1. Validate - Check the validity of the driver and pangrango.json manifests.
  2. Prepare (app / kernel) - Pre-process the kernel, application and drivers.
  3. Build (app / kernel) - Build the kernel executable, and create the SPIFFS image which stores the app.
  4. Flash (app / kernel) - Upload the kernel and app to the device.

pgo will output a brief help overview when executed without any parameters. The commands are described in more detail below:

pgo init

pgo init [name] [path]

Initialises a new Pangrango project with GIT called name into path. This tracks the master branch.

pgo make

pgo make {all/app/kernel/clean}

Runs the build pipeline for both the kernel and application. pgo make app will build the app, pgo make kernel builds the kernel, and pgo make all does both.

If you need to, clean the build with pgo make clean.

pgo flash

pgo make {all/app/kernel/list/use}

Flash either the app, kernel or both with pgo flash app, pgo flash kernel or pgo flash all.

You can set the serial port for the programmer with pgo flash use <serial port>, and view available ports with pgo flash list.

pgo driver

pgo make {enable/disable/list}

Enable drivers with pgo driver enable <driver name>, and disable with pgo driver disable <driver name>.

You can view all available drivers with pgo driver list.