Skip to content
PLANOVI Docs

Developer Onboarding & Workstation Setup

This guide outlines the environment configuration required to build, test, and contribute to the Aslandi Edge Converter firmware.

1. Workstation Prerequisites

To compile firmware for the Raspberry Pi RP2350 microcontroller, your development system requires:

  • ARM Cross-Compiler: arm-none-eabi-gcc (v13.2+ or v12.3+).
  • Build System: CMake (v3.20+) and Ninja or GNU Make.
  • Hardware SDK: Raspberry Pi Pico SDK (v2.2.0+ with RP2350 support).
  • RTOS Kernel: FreeRTOS Kernel (v11.1.0+ with ARM Cortex-M33 port).
  • Python: Python 3.10+ (for signing scripts, test generators, and factory tools).
  • Node.js: Node.js v18+ or v20+ (for running the Astro Starlight documentation portal).

2. Environment Configuration

Define the required toolchain environment variables in your shell profile (~/.bashrc, ~/.zshrc, or Windows Environment Variables):

Terminal window
# Linux / macOS
export PICO_SDK_PATH="/opt/pico-sdk"
export FREERTOS_KERNEL_PATH="/opt/FreeRTOS-Kernel"


# Windows (PowerShell)
$env:PICO_SDK_PATH = "C:\pico\pico-sdk"
$env:FREERTOS_KERNEL_PATH = "C:\pico\FreeRTOS-Kernel"

3. Cloning Repository & Initializing Submodules

Terminal window
# Clone the repository
git clone https://github.com/PA-IDEAS/planovi-converter.git
cd planovi-converter


# Verify toolchain availability
arm-none-eabi-gcc --version
cmake --version

4. Running the Documentation Portal Locally

The project documentation is built with Astro Starlight and deployed via Cloudflare Pages:

Terminal window
# Navigate to docs directory
cd docs


# Install documentation dependencies
npm install


# Launch local preview server with hot-reload
npm run dev

Open your browser to http://localhost:4321 to view the interactive documentation with the left-aligned collapsible sidebar and Mermaid diagram rendering.