agentleFS
wedsamuel1230wedsamuel1230/embedded-engineering-skills/skills/freertos-patterns/SKILL.md

freertos-patterns

Skill28 starsChanged 29 days agoMITView on GitHub

Use when users need ESP32 FreeRTOS or RP2040 multicore patterns for task creation, queues, synchronization, memory checks, task notifications, or cross-core coordination.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

10 rules. About 0 are common, 9 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈9

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill for real concurrency problems on ESP32 or RP2040.

    line 9
  2. Distinctive:

    Use this skill when the request includes:

    line 27
  3. Distinctive:

    Do not use this skill when:

    line 36
  4. Distinctive:

    Keep board-specific details explicit.

    line 62
  5. Distinctive:

    Prefer the smallest concurrency primitive that solves the problem.

    line 67
  6. Very specific:

    Use vTaskDelay() or event-driven blocking on ESP32, never delay() inside a task.

    line 69
  7. Distinctive:

    Check queue depth, notification flow, or mutex coverage against the concrete data path.

    line 77
  8. Distinctive:

    Verify the sketch can keep making progress without deadlock or busy waiting.

    line 81
  9. Distinctive:

    If an ISR is involved, verify the synchronization primitive is ISR-safe for that platform.

    line 82
  10. Distinctive:

    Use the shared Arduino skill contract: state assumptions, required tools and versions, implementation steps, tests/evidence by proof stage, …

    line 104

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

FreeRTOS Patterns for ESP32 and RP2040

Use this skill for real concurrency problems on ESP32 or RP2040. Keep the main flow focused and load the detailed reference that matches the user's exact problem.

Resources

  • references/patterns-task-creation.md - task lifecycle, priorities, stack sizing, and task startup
  • references/patterns-queues.md - inter-task communication with queues
  • references/patterns-synchronization.md - mutexes, semaphores, critical sections, and ISR coordination
  • references/patterns-memory.md - stack sizing, heap checks, and monitoring
  • references/patterns-advanced.md - watchdogs, notifications, event groups, timers, and affinity
  • assets/workflow.mmd - architecture overview

When to Use

Use this skill when the request includes:

  • multiple concurrent jobs on ESP32
  • task priorities or preemption
  • queue, semaphore, mutex, or notification design
  • RP2040 setup1 and loop1 multicore coordination
  • watchdog-safe long-running behavior
  • debugging race conditions, stack overflows, or deadlocks

Do not use this skill when:

  • the target is UNO or another single-core board
  • a simple millis() scheduler solves the problem
  • the request is only about one blocking loop with no concurrency requirement

Workflow

For a control system's task/resource ownership, action timing or deadline budget, start with realtime-control-design. Return here for the actual RTOS primitive. Native ESP-IDF uses its own port's stack units, affinity and critical section rules; do not copy an Arduino/RP2040 example into another framework without checking the selected SDK.

  1. Confirm the target platform first:
    • ESP32 -> FreeRTOS task model
    • RP2040 -> dual-core coordination model
  2. Identify the dominant problem:
    • task startup -> open patterns-task-creation.md
    • communication -> open patterns-queues.md
    • shared data or ISR signaling -> open patterns-synchronization.md
    • stack or heap risk -> open patterns-memory.md
    • watchdogs, notifications, timers, or affinity -> open patterns-advanced.md
  3. Solve one synchronization boundary at a time. Avoid mixing queue, mutex, and notification advice unless the design truly needs all of them.
  4. Keep board-specific details explicit. ESP32 FreeRTOS guidance and RP2040 multicore guidance are not interchangeable.

Core Rules

  • Prefer the smallest concurrency primitive that solves the problem.
  • Protect shared state explicitly. "Probably safe" is not safe.
  • Use vTaskDelay() or event-driven blocking on ESP32, never delay() inside a task.
  • Budget stack size deliberately and verify it with runtime evidence.
  • For RP2040, define core ownership clearly before sharing data.

Verification

  • Confirm each task or core has a single clear responsibility.
  • Check queue depth, notification flow, or mutex coverage against the concrete data path.
  • For ESP32, inspect stack headroom with uxTaskGetStackHighWaterMark() where the task size is uncertain.
  • Verify the sketch can keep making progress without deadlock or busy waiting.
  • If an ISR is involved, verify the synchronization primitive is ISR-safe for that platform.

Common Failure Modes

  • undersized task stack
  • delay() used inside a FreeRTOS task
  • unprotected shared data
  • deadlock from inconsistent lock order
  • RP2040 core startup assumptions without mutex or ownership discipline

Integration

  • Combine with arduino-code-generator when the user needs a full sketch rather than design guidance.
  • Combine with circuit-debugger only after the concurrency design looks sound and a hardware timing issue still remains.
  • Combine with mermaid-diagram-generator when the concurrency design needs a task, queue, or event-flow diagram.

Shared Output Contract

Use the shared Arduino skill contract: state assumptions, required tools and versions, implementation steps, tests/evidence by proof stage, known limitations, and recovery/security notes.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.