ESP RainMaker Common modules

This component consists of some common modules used by ESP RainMaker and ESP RainMaker Diagnostics repos. Currently, it consists of

• MQTT glue layer
• Factory NVS helpers
• Command-Response
• Console
• Memory allocation helpers (esp_rmaker_mem_alloc.h, using SPIRAM etc.)
• System control (Reboot, Wi-Fi/factory reset etc.)
• Timing APIs (SNTP helpers, timezone, etc.)
• Work Queue

Pre-commit Checks

File checks are achieved with pre-commit hooks here:

• Using insert-license for license headers
• Using end-of-file-fixer to ensure end-of-file newline compliance

Setup

In your Python environment, run

pip install pre-commit

Usage

To install the hooks to run before every commit is finalized:

pre-commit install

To run on all files (not just staged), at any point of time:

pre-commit run --all-files