Compiling the software¶

Tools¶

I use the following tools in order to build and manage the software:

Visual Studio Code
PlatformIO
Git for Windows
VSCode plugin: Minify (used to minimise the html files)

Code Formatting¶

I use pre-commit and their cpp style checks to validate the code. Plugin defintions are found in .pre-commit-config.yaml

Pre-Commit

Note

There is not yet any automatic checks since this does not work on Windows. It works if running under WSL2 with Ubuntu.

Targets¶

In the platformio config there are 3 targets defined

gravity-debug; Maximum logging for trouble shooting, deep sleep is disabled.
gravity-release; Standard release
gravity32-release: Version for ESP32 mini.
gravity32-c3-release: Version for ESP32 C3 mini.
gravity32-s2-release: Version for ESP32 S2 mini.

Warning

The debug target can be unstable and crash the device under certain circumstanses. Excessive logging to the serial port can cause corruption and crashes. So only enable enough debugging to troubleshoot your changes.

Source structure¶

Directory structure¶
path	content
/bin	Contains compiled binaries
/data	Directory for flashing device filesystem
/doc	Various external documents used as input
/html	Source for html files
/img	Images uses in README.md
/lib	External libraries used when compiling
/script	Scripts used in build process
/src	Source code for software
/src_docs	Source code for documentation
/test	Test data for developing html files

Options¶

This is a list of C++ defines that is used to enable/disable functions in the code.

Defines¶
define	description
ACTIVATE_OTA	Enables the OTA functionallity in the code
SKIP_SLEEPMODE	The device never goes into sleep mode, useful when developing.
xxx_DISABLE_LOGGING	Done include verbose logging in the corresponding class. Excessive logging may crash device.
USE_LITTLEFS	Use the new filesystem in Ardurino
USER_SSID	If defined the device will always use this SSID
USER_SSID_PWD	Password to the SSID
CFG_APPVER	Defines the version of the compiled software