Build a firmware

Write your own effect for the GP-5 in plain C, try it on the computer, and flash it.

Write your own effect in plain C: your sound, your screen, your controls. Try it on your computer first, then flash it over USB.

Learn

  1. Set up your computer: the compilers, a first build, a first flash.
  2. How a firmware works: the two processors, the platform, settings and storage.
  3. Your first effect: a tremolo, step by step.
  4. Your own repository: start from the template, built and tested by GitHub.

Guides

The simulatorthe whole firmware on the computer: sound, screen, scripted controls
Parameters and presetssettings declared once, saved, and editable from a computer
The UI kita settings page, a menu, value text, messages
Text and fontsthe built-in pixel font, smooth text, your own font
Storagekeeping settings and files on the pedal
The audio linksound on both processors
Performancebudgets, measuring, what’s fast where
Debuggingthe log, the load report, symptoms and causes
Releasing your firmwareversions, release notes, getting listed

Reference

API referenceeverything a firmware can use
ProtocolsUSB-MIDI, the firmware update, the image format, the processor link
Hardwarememory, pins and clocks of both processors
Known limitswhat it can’t do yet
FAQcommon questions

Set up your computer

Install the compilers and tools, build a firmware, flash it.

How a firmware works

The two processors, the platform, settings, storage, and what happens at power-on.

Your first effect

Build a tremolo step by step: settings, sound, screen and controls.

Your own repository

Start a firmware from the template: its own repository, built and tested on every push.

The simulator

Run a whole firmware on the computer: sound, screen and scripted controls.

Parameters and presets

Declare settings once; the platform saves them, keeps presets and gives a computer an editor.

The UI kit

A settings page, a menu, value text, messages and knob pickup.

Text and fonts

The built-in pixel font, smooth text in any font, and making your own.

Storage

Keeping settings and files on the pedal.

The audio link

Sound on both processors.

Performance

Budgets, measuring, and what’s fast on each processor.

Debugging

The log, the load report, symptoms and their causes.

Releasing your firmware

Versions, release notes, and getting listed in Launchpad and the web flasher.

API reference

Everything a firmware can use: manifest, callbacks, platform calls, log, load.

Protocols

USB-MIDI, the firmware update, the image format, and the link between the processors.

Hardware

Memory, pins and clocks of both processors.

Known limits

What OpenGP5 can’t do (yet).

Questions

Common questions about using OpenGP5 and writing firmware.