Nexus Embedded Platform

Note

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

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.

Getting Started

• Introduction
  • What is Nexus?
  • Key Features
  • Why Nexus?
  • Architecture Overview
  • Supported Platforms
  • Project Structure
  • License
  • Getting Started
• Installation
  • Prerequisites
  • Installing Prerequisites
  • Getting Nexus
  • Building
  • Running Tests
  • Building Documentation
  • Next Steps
• Quick Start
  • Prerequisites
  • Create a New Project
  • Build for Native (Testing)
  • Build for STM32F4
  • Understanding the Code
  • Adding UART Output
  • Next Steps

User Guide

• Architecture
  • Design Principles
  • Layer Architecture
  • Data Flow
  • Dependency Rules
  • Memory Management
  • Error Handling
  • Build System
  • Next Steps
• Hardware Abstraction Layer (HAL)
  • Overview
  • Architecture
  • Supported Peripherals
  • Getting Started
  • GPIO Module
  • UART Module
  • SPI Module
  • I2C Module
  • Error Handling
  • Lifecycle Management
  • Power Management
  • API Reference
• OS Abstraction Layer (OSAL)
  • Overview
  • Supported Backends
  • Getting Started
  • Task Management
  • Mutex
  • Semaphore
  • Message Queue
  • Software Timer
  • Critical Sections
  • Memory Management
  • Time Functions
  • Error Handling
  • Bare-metal Considerations
  • API Reference
• Log Framework
  • Overview
  • Features
  • Quick Start
  • Log Levels
  • Configuration
  • Format Tokens
  • Backends
  • Module Filtering
  • Asynchronous Mode
  • Backend-Level Filtering
  • Runtime Reconfiguration
  • Compile-Time Configuration
  • Custom Backend
  • Thread Safety
  • Dependencies
  • API Reference
• Shell Framework
  • Overview
  • Features
  • Quick Start
  • Configuration
  • Command Definition
  • Built-in Commands
  • Line Editing Keys
  • Backends
  • Output Functions
  • Error Handling
  • Compile-Time Configuration
  • Dependencies
  • API Reference
• Config Manager
  • Overview
  • Features
  • Quick Start
  • Configuration
  • Data Types
  • Type Operations
  • Namespaces
  • Default Values
  • Change Notifications
  • Storage Backends
  • Import/Export
  • Encryption
  • Query Operations
  • Error Handling
  • Compile-Time Configuration
  • Dependencies
  • API Reference
• Porting Guide
  • Overview
  • Prerequisites
  • Porting Steps
  • HAL Implementation Checklist
  • Testing Your Port
  • Reference Implementation
  • Common Issues
  • Getting Help

API Reference

• HAL API Reference
  • Overview
  • Core Functions
  • Status Codes
  • GPIO API
  • UART API
  • SPI API
  • I2C API
  • Timer API
  • ADC API
  • Device Enumeration
  • Base Interfaces
• OSAL API Reference
  • OSAL Definitions
  • Task API
  • Mutex API
  • Semaphore API
  • Queue API
• Log Framework API Reference
  • Log Definitions
  • Log Macros
  • Log Backend
• Shell Framework API Reference
  • Shell Core
  • Definitions & Constants
  • Command Management
  • Line Editor
  • History
  • Autocomplete
  • Parser
  • Backend Interface
• Config Manager API Reference
  • Config Core
  • Config Definitions
  • Backend Interface

Development

• Contributing
  • Development Environment
  • Contribution Workflow
  • Code Style
  • Commit Messages
  • Pre-Submit Checklist
  • Review Process
  • CI/CD
  • Questions?
• Coding Standards
  • C Standard
  • Code Formatting
  • Naming Conventions
  • Documentation
  • MISRA C
• Testing
  • Test Framework
  • Building Tests
  • Running Tests
  • Writing Tests
  • Code Coverage
  • Static Analysis
  • Best Practices
  • CI Integration

Features

• Hardware Abstraction Layer (HAL): Unified API for GPIO, UART, SPI, I2C, Timer, ADC

• OS Abstraction Layer (OSAL): Portable RTOS interface supporting FreeRTOS and bare-metal

• Log Framework: Flexible logging with multiple backends, async mode, and module filtering

• Multi-Platform Support: STM32F4, STM32H7, ESP32, nRF52, and more

• Security: Secure boot, TLS 1.3, crypto engine, key management

• Functional Safety: MISRA C compliance, MPU protection, runtime checks

• Cloud Integration: AWS IoT, Azure IoT, Alibaba Cloud IoT

• AI/ML Support: TensorFlow Lite Micro, CMSIS-NN

Quick Links

• Introduction - Learn about Nexus

• Installation - Set up your environment

• Quick Start - Build your first app

Community

• GitHub

• Issues

• Discussions

• Changelog

Indices and tables

• Index

• Module Index

• Search Page