Useful External Documentation

PlatformIO General Documentation

FujiNet uses the PlatformIO cross-platform development environment to ease firmware development. PlatformIO is currently built on libraries, tools, and extensions to Microsoft Visual Studio Code.

PlatformIO General Documentation

ESP-IDF Documentation

FujiNet is built on Espressif's "IoT Development Framework", or ESP-IDF for brevity. Note that the documentation web site defaults to the latest available version of the framework, and this is sometimes a pre-release version not yet available to PlatformIO users. Make sure you choose the "latest stable" version from the menu hidden at the bottom-left of the page. The "latest prerelease" version is usually chosen by default.

ESP-IDF Documentation

PlatformIO ESP-IDF Guidelines

PlatformIO provides specific documentation and notes on each of the platforms it targets, including ESP-IDF. These notes are useful in understanding the features and tools specific to ESP-IDF development on PlatformIO:

PlatformIO ESP-IDF Framework Notes

FreeRTOS Reference

ESP-IDF currently uses a build (or "port") of the FreeRTOS 8.2.0 multitasking RTOS for its base operating system. Here's a link to a PDF of that version's reference documentation:

FreeRTOS 8.2.0 Reference Manual

ESP-IDF Changes to FreeRTOS

"Various features specific to ESP-IDF FreeRTOS have been added. The features are as follows:"

FreeRTOS Additions

"The ESP-IDF FreeRTOS is a modified version of vanilla FreeRTOS which supports symmetric multiprocessing (SMP). ESP-IDF FreeRTOS is based on the Xtensa port of FreeRTOS v8.2.0. This guide outlines the major differences between vanilla FreeRTOS and ESP-IDF FreeRTOS."

ESP-IDF FreeRTOS SMP Changes

GNU Compiler Collection 8.2.0

ESP-IDF currently uses a GCC 8.2-based toolchain to build ESP32 binaries. This version of GCC supports the "C11" version of the C language and "C++14".

GCC 8.2.0 Documentation