Overview

Introduction

The Nuclei Software Development Kit (SDK) is an open-source software platform to speed up the software development of SoCs based on Nuclei Processor Cores.

This Nuclei SDK is built based on the NMSIS, user can access all the APIs provided by NMSIS and also the APIs that provided by Nuclei SDK which mainly for on-board peripherals access such as GPIO, UART, SPI and I2C, etc.

Nuclei SDK provides a good start base for embedded developers which will help them simplify software development and improve time-to-market through well-designed software framework.

Design and Architecture

The Nuclei SDK general design and architecture are shown in the block diagram as below.

Nuclei SDK Design and Architecture Diagram

Nuclei SDK Design and Architecture Diagram

As Nuclei SDK Design and Architecture Diagram shown, The Nuclei SDK provides the following features:

  • Nuclei Core API service is built on top of NMSIS, so silicon vendors of Nuclei processors can easily port their SoCs to Nuclei SDK, and quickly evaluate software on their SoC.

  • NMSIS-NN and NMSIS-DSP library can be also used in Nuclei SDK, and the prebuilt libraries are included in NMSIS/Library folder of Nuclei SDK.

  • Mainly support two Nuclei Processor based SoCs, HummingBird SoC and GD32VF103 SoC

  • Provided realtime operation system service via FreeRTOS, UCOSII and RT-Thread

  • Provided bare-metal service for embedded system software beginners and resource-limited use-cases.

  • Currently Nuclei SDK didn’t define any common device APIs to access GPIO/I2C/SPI/UART devices, it still relied on the device/peripheral APIs from firmware libraries from various silicon vendors, such as current supported GD32VF103 SoC.

  • Applications are logically seperated into three parts:

    • General applications for all Nuclei Processors: In the Nuclei SDK software code, the applications provided are all general applications which can run on all Nuclei Processors, with basic UART service to provide printf function.

    • HummingBird SoC applications: These applications are not included in the Nuclei SDK software code, it is maintained seperately, it will use resource from HummingBird SoC and its evaluation boards to develop applications, which will not be compatiable with different boards.

    • GD32VF103 SoC applications: These applications are not included in the Nuclei SDK software code, it is maintained seperately, it will use resource from GD32VF103 SoC and its evaluation boards to develop applications, which will not be compatiable with different boards.

Get Started

Please refer to Quick Startup to get started to take a try with Nuclei SDK.

Contributing

Contributing to Nuclei SDK is welcomed, if you have any issue or pull request want to open, you can take a look at Contributing section.

License

Nuclei SDK is an opensource project licensed by Apache License 2.0.