Skip to content

xmos/xcore_iot

Repository files navigation

XCORE:registered: IOT Repository

Version Issues Contributors PRs Welcome

XCORE-IOT is a collection of C/C++ software libraries designed to simplify and accelerate application development on xcore processors. It is composed of the following components:

  • Peripheral IO libraries including; UART, I2C, I2S, SPI, QSPI, PDM microphones, and USB. These libraries support bare-metal and RTOS application development.
  • Libraries core to DSP applications, including vectorized math. These libraries support bare-metal and RTOS application development.
  • Voice processing libraries including; adaptive echo cancellation, adaptive gain control, noise suppression, interference cancellation (IC), and voice activity detection. These libraries support bare-metal and RTOS application development.
  • Libraries that enable multi-core FreeRTOS development on xcore including a wide array of RTOS drivers and middleware.
  • Code Examples - Examples showing a variety of xcore features based on bare-metal and FreeRTOS programming.

XCORE-IOT is designed to be used in conjunction with the xcore.ai Explorer board evaluation kit. The example applications compile targeting this board. Further information about the Explorer board and xcore.ai devices is available to on www.xmos.ai.

Build Status

Build Type Status
CI (Linux) CI
Docs CI

Cloning

Some dependent components are included as git submodules. These can be obtained by cloning this repository with the following command:

git clone --recurse-submodules [email protected]:xmos/xcore_iot.git

The submodules require SSH to be correctly configured, please refer to https://docs.github.com/en/authentication/connecting-to-github-with-ssh for more details.

Documentation

See the official documentation for more information including:

  • Instructions for modifying the software
  • Programming tutorials
  • API references

License

This Software is subject to the terms of the XMOS Public Licence: Version 1. Copyrights and licenses for third party components can be found in Copyrights and Licenses.