Skip to main content

ArmBuilderX

Cross-platform CLI that turns a Keil/MDK Arm Cortex-M project into a CMake project, builds it with the Arm GNU Toolchain, flashes it with pyOCD, and streams the DAPLink/CMSIS-DAP virtual COM port log.

It is built on top of official tooling rather than a custom project parser:

  • CMSIS-Toolbox (csolution / cbuild / cbuild2cmake / cpackget) resolves the CMSIS-Pack device data (CPU, FPU, memory map, startup/linker files) and generates the actual CMakeLists.txt.
  • pyOCD flashes the target over CMSIS-DAP/DAPLink and can also list/open the debug probe's serial port.
  • CMake + Arm GNU Toolchain (arm-none-eabi-gcc) builds the generated CMake project. ninja is used as the CMake generator.

Install

pip install armbuilderx

Usage

# One-time: point ArmBuilderX at the vendor pack(s) that describe your device.
armbuilderx init --pack path/to/Vendor.PackName.x.y.z.pack

# Generate (or refresh) the GCC/CMake project for one example, from its
# existing MDK project.
armbuilderx generate examples/device_support/ns800rt5xxx/examples/gpio/gpio_ex2_output

# Build it (adds arm-none-eabi-gcc/cmake/ninja/git to ~/.armbuilderx/tools
# automatically if they are missing from PATH).
armbuilderx build examples/device_support/ns800rt5xxx/examples/gpio/gpio_ex2_output

# Flash the built ELF over CMSIS-DAP/DAPLink with pyOCD.
# (the build step also emits matching .hex and .bin images alongside the .elf)
armbuilderx flash examples/device_support/ns800rt5xxx/examples/gpio/gpio_ex2_output

# Open the DAPLink virtual COM port and stream log output.
armbuilderx monitor

# All of the above, in one shot.
armbuilderx run examples/device_support/ns800rt5xxx/examples/gpio/gpio_ex2_output

SDK adapters

ArmBuilderX keeps vendor-specific SDK rules behind SDK adapters. The current ns800rt5xxx adapter contains the NS800 project-layout detection, GCC startup file replacement, linker-script selection, and NS800-only compiler defines. The command layer remains independent of those details and can select an adapter explicitly when needed:

armbuilderx generate <example-dir> --sdk ns800rt5xxx

Without --sdk, ArmBuilderX detects the adapter from the example layout. To add another SDK such as GR551x, implement a new adapter under src/armbuilderx/sdk/ and register it in sdk/registry.py; do not add its directory rules to the NS800 adapter or the generic generator.

GR551x

The gr551x adapter supports Goodix GR551x projects that ship a GCC/ CMSIS-Toolbox project. It verifies the Goodix::GR5xxx_DFP@1.0.0 pack and Goodix::GR551x device, preserves the SDK's source groups and BLE library, and resolves the selected GCC toolchain's Cortex-M4 softfp runtime libraries.

armbuilderx init --pack ../GR551x_SDK_V2.1.1/Goodix.GR5xxx_DFP.1.0.0.pack
armbuilderx build ../GR551x_SDK_V2.1.1/projects/peripheral/gpio/app_gpio --sdk gr551x --clean

Each project keeps its generated CMake project under a GCC/ folder next to the existing MDK//IAR/ folders, matching the SDK's own convention.

Metadata

Release files for armbuilderx 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for armbuilderx 0.1.1
File Size Uploaded
armbuilderx-0.1.1.tar.gz 25.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for armbuilderx 0.1.1
File Interpreter ABI Platform
armbuilderx-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 54.6 kB

Release files / armbuilderx-0.1.1.tar.gz

Download URL armbuilderx-0.1.1.tar.gz
Size 25.9 kB
Tags Source
SHA-256 checksum
How to use checksums
c130b11b7989260b58ace0ae62a224fbb696dcc753c4d1272dc8058b770386d4
BLAKE2b-256 checksum
How to use checksums
c1876c83b50549a16f50373bf8708d2971af6c4b14bac9d8c45dcf6159c0f33b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.

Transparency log

Release files / armbuilderx-0.1.1-py3-none-any.whl

Download URL armbuilderx-0.1.1-py3-none-any.whl
Size 28.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2fc7cd3638f50d6e65a0121840c2463bec3039e5da3c22b5405d3ef69ed2753d
BLAKE2b-256 checksum
How to use checksums
20204faeec2779f1802df7fb0f7e2b568b023350da41b54f3a829661f82a9026
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.

Transparency log

Release history Release notifications | RSS feed

0.1.2

2 release files

This release

0.1.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page