Installation

This page walks through installing the ALP SDK and its dependencies on your development machine.

Prerequisites

Requirement	Minimum Version	Notes
Arm GNU Toolchain	12.2	arm-none-eabi-gcc
CMake	3.22
Python	3.9	For build scripts and flashing utilities
Git	2.30

Install the Toolchain

Linux (apt)

sudo apt update
sudo apt install -y gcc-arm-none-eabi cmake python3 python3-pip git

macOS (Homebrew)

brew install --cask gcc-arm-embedded
brew install cmake python3 git

Windows

note

For Windows, install the ARM GNU Toolchain via the official installer and add it to your PATH.

Download and install CMake and Python 3 using their official Windows installers.

Clone the SDK

git clone https://github.com/alplab/alp-sdk.git
cd alp-sdk
git submodule update --init --recursive

Install Python Dependencies

pip3 install -r requirements.txt

Verify the Installation

Run the SDK's built-in check to confirm all tools are found:

python3 scripts/check_env.py

Expected output:

[OK] arm-none-eabi-gcc 12.2.1
[OK] cmake 3.22.1
[OK] python 3.9.7
All checks passed.

SDK Directory Structure

alp-sdk/
  cmake/           -- CMake toolchain files and helpers
  drivers/         -- CMSIS-Driver implementations per peripheral
  bsp/             -- Board support packages for each E1M module
  rtos/            -- FreeRTOS port and configuration
  examples/        -- Sample projects
  scripts/         -- Build and flash utilities
  requirements.txt -- Python dependencies

Next Steps

• Quick Start guide -- build and flash your first project