English | 日本語

Header-only C++ wrappers for FreeRTOS sync primitives on ESP32 (Arduino). Designed to teach correct FreeRTOS usage through an Arduino-like API while staying safe for both tasks and ISRs.

• Header-only sync layer for Arduino-ESP32 (FreeRTOS).
• Safe from both tasks and ISRs; FromISR is picked automatically.
• Works with any task source: ESP32AutoTask, ESP32TaskKit, or raw FreeRTOS tasks.

• Type-safe queues, RAII helpers, unified blocking/non-blocking APIs.
• Common log tag: ESP32SyncKit. Add class markers like [Queue] if needed.
• WaitForever constant for “block forever” (forced non-block in ISR).

• Queue: typed queue with ISR auto-detection.
• Notify: task notification wrapper (counter or bit mode per instance).
• BinarySemaphore: one-shot event handoff, ISR give supported.
• Mutex: priority-inheritance mutex (non-recursive), LockGuard included.

• ESP32AutoTask: use weak hooks (LoopCore0_*, LoopCore1_*) and call ESP32SyncKit inside them.
• ESP32TaskKit: create tasks with ESP32TaskKit and use ESP32SyncKit for sync; clear separation between task mgmt and sync.
• Raw FreeRTOS: tasks created with xTaskCreatePinnedToCore can use ESP32SyncKit directly.

• Arduino IDE Library Manager: search “ESP32SyncKit”.
• Manual: download the release ZIP and place under Arduino/libraries.

#include <ESP32SyncKit.h>

ESP32SyncKit::Queue<int> q(4);

void IRAM_ATTR onGpio()
{
  q.trySend(42); // From ISR: non-blocking send
}

void setup() {
  Serial.begin(115200);
}

void loop() {
  int v;
  if (q.receive(v, ESP32SyncKit::WaitForever)) {
    Serial.println(v);
  }
}

• Target: Arduino-ESP32 (FreeRTOS tick = 1 ms). Dual-core aware; ISR-safe where applicable.
• Not intended for ESP8266 or non-FreeRTOS platforms.

• Specification (EN)
• 仕様書 (JA)

• ESP32AutoTask: auto-runs tasks when you define weak-hook functions like LoopCore0_Low or LoopCore1_High. Great for quick sketches and a handful of simple tasks; not intended for running lots of tasks or tuning their parameters.
• ESP32TaskKit: C++ task manager with config objects (priority/core/stack, lifecycle helpers). Use this when you want predictable task setup without writing raw FreeRTOS code—covers most real projects.
• ESP32SyncKit (this library): queue/notify/semaphore/mutex wrappers that stay independent of task creation. Pair with either AutoTask or TaskKit (or raw FreeRTOS) to pass data and notifications safely.

• MIT License (see LICENSE).