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 FreeRTOS is a FreeRTOS implementation based on Vanilla FreeRTOS v10.5.1, but contains significant modifications to support SMP. ESP-IDF FreeRTOS only supports two cores at most (i.e., dual core SMP), but is more optimized for this scenario by design.” - ESP-IDF FreeRTOS Overview

Here's a PDF of the FreeRTOS 10.0.0 reference manual: FreeRTOS 10.0.0 Reference Manual

The following is a link to FreeRTOS documentation. The majority of it is applicable to the FreeRTOS used in ESP-IDF: FreeRTOS Documentation

Mastering the FreeRTOS Kernel - A Hands On Tutorial Guide (for FreeRTOS v10.6.2): Mastering the FreeRTOS Real Time Kernel

ESP-IDF Changes to FreeRTOS

"This document provides information regarding the dual-core SMP implementation of FreeRTOS inside ESP-IDF.” - FreeRTOS (IDF)

"ESP-IDF provides multiple features to supplement the features offered by FreeRTOS. These supplemental features are available on all FreeRTOS implementations supported by ESP-IDF (i.e., ESP-IDF FreeRTOS and Amazon SMP FreeRTOS).” - FreeRTOS (Supplemental Features)

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