Reference
Reference
Use these pages when you need the exact API, state, or helper names. This section is the precise counterpoint to the guides: the guides explain how to build, the reference pages document exactly what to call.
Pages
- App API Reference - app entry points, helpers, and shared patterns
- PocketMage Library - the shared firmware modules under
lib/PocketMage/ - System State Reference - globals, settings, and runtime state
- Command Manual - keyboard mappings and built-in app commands
- Scripting - Wrench examples and command reference
When to use this section
Start here if you are writing an OTA app, touching shared app state, or looking for the current function names used by the firmware.
- Writing an app - read App API for the entry points, then PocketMage Library for the modules you can call.
- Adding an app - read System State to see the
AppStateenum and dispatch switch. - Automating - read Scripting for the Wrench bindings.
- Using the device - read the Command Manual.