# nsx-freertos

<!-- nsx:facts -->
Optional FreeRTOS kernel middleware. Vendors a pinned upstream FreeRTOS-Kernel and builds the SoC-selected CMSIS port. Kernel/heap policy and FreeRTOSConfig.h are owned by the application.

- Type: Backend specific
- Version: 5.2.26
- Project: nsx-ambiq-sdk
- Revision: v5.2.26
- Source: https://github.com/AmbiqAI/nsx-ambiq-sdk/tree/v5.2.26
- Capabilities: rtos, freertos, scheduler, sdk_component
<!-- /nsx:facts -->

## Add it to an app

```bash
nsx module add nsx-freertos
```

## Capabilities

- rtos
- freertos
- scheduler
- sdk_component

## Use cases

- run application tasks under a preemptive FreeRTOS scheduler
- provide kernel objects (tasks, queues, semaphores, timers) to higher-level modules
- opt-in RTOS scheduling without baking kernel or heap policy into the core SDK

## Requires

- [`nsx-core`](https://ambiqai.github.io/neuralspotx/modules/nsx-core/)

## Compatibility

:::note[How compatibility is declared]
The boards, SoCs and toolchains listed here are the ones the module manifest declares.
That is the module author's statement of intent, not evidence from hardware. Confirm on your
own target before you depend on it.
:::

| Kind | Declared |
| --- | --- |
| Boards | * |
| SoCs | apollo3p, apollo4p, apollo510, apollo510b, apollo330P, apollo510L |
| Toolchains | arm-none-eabi-gcc |

## Agent keywords

`freertos`, `rtos`, `scheduler`, `task`, `kernel`

## Source

| Field | Value |
| --- | --- |
| Type | Backend specific |
| Version | 5.2.26 |
| Project | nsx-ambiq-sdk |
| Revision | `v5.2.26` |
| Manifest | `modules/nsx-freertos/nsx-module.yaml` |
| Repository | [nsx-ambiq-sdk](https://github.com/AmbiqAI/nsx-ambiq-sdk/tree/v5.2.26) |

Back to the [module catalog](https://ambiqai.github.io/neuralspotx/modules/catalog/).