Nexus Embedded Platform

Note

Language / 语言: Use the language switcher in the sidebar to change language.

New to Nexus? Start with Quick Start or see Documentation Guide for navigation help.

Welcome to the Nexus Embedded Platform documentation. Nexus is a world-class embedded software development platform designed for building reliable, secure, and portable embedded applications.

Documentation

Getting Started

User Guide

Tutorials

Platform Guides

API Reference

Reference

Development

Key Features

🔧 Hardware Abstraction Layer (HAL)

Unified API for GPIO, UART, SPI, I2C, Timer, ADC with factory pattern and lifecycle management.

Learn more →

⚙️ OS Abstraction Layer (OSAL)

Portable RTOS interface supporting FreeRTOS, RT-Thread, Zephyr, and bare-metal.

Learn more →

📝 Log Framework

Flexible logging with multiple backends, async mode, module filtering, and color output.

Learn more →

🖥️ Shell Framework

Interactive command-line interface with command registration, history, and auto-completion.

Learn more →

⚙️ Configuration System

Powerful Kconfig-based configuration with validation, migration, and runtime access.

Learn more →

🏗️ Build System

CMake-based build system with cross-platform support, toolchain management, and testing.

Learn more →

🔒 Security & Safety

  • Secure boot and firmware updates

  • TLS 1.3 and crypto engine

  • MISRA C compliance

  • MPU protection and runtime checks

☁️ Cloud Integration

Ready-to-use integrations for AWS IoT, Azure IoT, and Alibaba Cloud IoT.

🤖 AI/ML Support

TensorFlow Lite Micro and CMSIS-NN for edge AI applications.

Quick Start

Get started in 5 minutes:

# Clone repository
git clone https://github.com/X-Gen-Lab/nexus.git
cd nexus

# Build for native platform
python scripts/building/build.py

# Run example
./build/applications/blinky/blinky

Full quick start guide →

Supported Platforms

  • Native - Windows, Linux, macOS (simulation)

  • STM32 - F4, H7 series

  • GD32 - GD32F4, GD32F3 series

  • ESP32 - ESP32, ESP32-S3 (coming soon)

  • nRF52 - nRF52832, nRF52840 (coming soon)

Platform guides →

Learning Path

New Users (Week 1)

  1. Quick Start - Build first example

  2. First Application - Create your app

  3. GPIO Control Tutorial - First tutorial

Application Developers (Week 2-4)

  1. Hardware Abstraction Layer (HAL) - Hardware peripherals

  2. OS Abstraction Layer (OSAL) - Task management

  3. Tutorials - Complete tutorials

Advanced Users (Week 5+)

  1. Kconfig Configuration System - Advanced configuration

  2. Porting Guide - Port to new hardware

  3. Contributing - Contribute code

Community & Support

Indices and Tables