User guide
Use these guides after building your first app. Choose a task below. For exact flags, signatures and manifest fields, use the API reference.
Build and run
Section titled “Build and run”- App model: how an application owns its sources and dependencies.
- App layout: which files to edit, commit or regenerate.
- Build, flash and view: configure firmware, program the board and capture output.
- Troubleshooting: diagnose environment, dependency, build and probe failures.
Manage modules
Section titled “Manage modules”- Using modules: find, add, inspect and remove capabilities.
- Lock and sync: pin dependencies and reproduce an application’s source set.
- Custom modules: develop a module or register your own source.
- Module catalog: search the packaged modules and their declared compatibility.
Configure hardware and toolchains
Section titled “Configure hardware and toolchains”- Boards and targets: select a board or add targets to an app.
- Board matrix: look up packaged board descriptors and toolchains.
- Toolchains: select GCC, ACFE or ATfE and check their validation status.
- SDK foundation and overrides: understand HAL/BSP integration and use an alternate SDK source.
Configure firmware
Section titled “Configure firmware”- System initialization: initialize the runtime and enable debug output.
- Memory placement: place code and data and manage caches.
- Startup and linker: inspect or override the board’s startup and memory layout.
Explore examples
Section titled “Explore examples”The examples cover basic board bring-up, individual capabilities and integrations. Each page includes build instructions and declared target status. Start with an example close to your application, then inspect its manifest.
Automate your workflow
Section titled “Automate your workflow”- Python API guide: call NSX operations and handle typed results and errors.
- Automation and agents: use structured output and respect generated files.
Understand the architecture
Section titled “Understand the architecture”Architecture concepts explain app generation, dependency resolution, module contracts, metadata and portability across targets. These are background explanations; the task guides above provide the working steps.
Extend NSX
Section titled “Extend NSX”- Add a board: implement and validate board support.
- Contribute a module: prepare a reusable module for the registry.