PocketMage SDK Documentation
PocketMage SDK Documentation
PocketMage apps are ELF files the host firmware loads at runtime and runs in-process. These docs cover how to write an app, every component of the app API, the binary contract, the build tooling, the symbol surface, and packaging.
GuidesAPI reference
App ABI
Build tooling
Symbols
Publishing
Guides
Start here. Walkthroughs of the whole app model.
From pm new to a running ELF: scaffold, build recipe, delivery tar, and the host loader.
Entry points, the host/app export model, APP_INIT, and exiting cleanly.
The two-display model, the buffered E-Ink refresh rhythm, and the scroll loop.
OpenGuide index and cross-links into the deep references.
OpenAPI reference
Every header the SDK publishes, with semantics. Start at the overview.
The umbrella header, the PM_TARGET_HOST/PM_TARGET_APP split, and how to read the per-component pages.
OLED, E-Ink, Font, Layout, UI helpers.
OpenKeyboard, Touch.
OpenSys and globals, SD card, Clock, Buzzer, WiFi, i18n runtime.
OpenThe binary contract
How the framework itself is built and shipped.
The binary shape the loader accepts: format, entry, load strategy, failure modes.
OpenA Makefile including tools/app.mk is the whole build system. Toolchain, targets, icon.
The host-export surface an app’s undefined list resolves against, and how to change it.
OpenThe delivery tar, the 40x40 icon, assets, and what APPLOADER does with them.
OpenCatalogs, the generator, and the merge rules that keep string IDs stable.
OpenMoving a pre-ELF app to the runtime-load flow.
OpenStart here
- Read the guides, then the API overview.
- Read the App ABI contract.
- Set up the build toolchain.
- Check what your app resolves against: Symbols.
- Ship a tar: Publishing.
- Port existing code: Migration.
