Index

Complete documentation for every App SDK call, split by category. This page is the index; each entry below links straight to the function.

For each function the reference gives:

the full C signature from jpp_sdk_bridge.h,
the MicroPython binding from the jppsdk module, where one exists,
the capability required — if none is listed, the call is ungated,
the return value in both languages, including any output parameters,
notes covering what the signature does not tell you.

Signatures are shown as C / MicroPython tabs, switched per signature.

Errors in MicroPython.

Unless a function's entry says otherwise, a jppsdk binding raises jppsdk.SdkError on any non-OK status, and jppsdk.SdkPermissionError (a subclass) when the capability was not granted. Catch the permission error separately and degrade — a denied capability is a normal outcome, not a crash.

The two SDKs expose the same surface.

Every SDK call has both a C and a MicroPython form, with two deliberate exceptions marked (C only): code modules (module_load/module_run/module_unload), which load a second native ELF binary and have no meaning for a MicroPython app — use import instead — and push_key, a firmware-internal input hook rather than an app-facing call.

Index¶

Core¶

Page	Functions
Types and constants	`jpp_sdk_status_t` · `jpp_sdk_key_event_t` · Python constants · `jpp_broker_result_t`
App control and input	`set_frame` · `request_close` · `log` · `request_cap` · `poll_key` · `wait_key` · `push_key` · `claim_ok`
Canvas and UI helpers	`canvas_write` · `canvas_draw_pixel` · `canvas_clear` · `canvas_fullscreen` · `dialog` · `list` · `input` · `confirm` · `file_pick` · `wrap_text`
Buzzer, LED, device status	`buzzer_play` · `buzzer_tone` · `buzzer_play_sequence` · `buzzer_play_sequence_async` · `buzzer_stop` · `led_set_color` · `led_off` · `wakelock_acquire` · `wakelock_release` · `device_status` · `get_time` · `is_dummy_mode`

Data¶

Page	Functions
Storage and IPC	`file_read` · `file_write` · `file_list` · shared I/O · `kv_get` · `kv_set` · `kv_delete` · `ipc_send` · `ipc_recv`
Full file access ⚠ `files.full`	`file_open` · `handle_read` · `handle_write` · `handle_list` · `handle_close`

Connectivity¶

Page	Functions
HTTP ⚠ `http.request`	`http_request`
HTTPS ⚠ `https.request`	`https_request` · per-origin consent
TCP server ⚠ `network.bind`	`net_bind` · `net_accept` · `net_recv` · `net_send` · `net_close`
TCP client ⚠ `network.connect`	`net_connect` · shares `net_recv`/`net_send`/`net_close`
BLE scan ⚠ `ble.scan`	`ble_scan`
BLE advertise ⚠ `ble.advertise`	`ble_advertise_start` · `ble_advertise_stop` · `ble_set_connectable`
BLE GATT client ⚠ `ble.connect`	`ble_connect` · `ble_read_char` · `ble_write_char` · `ble_disconnect`
BLE GATT server ⚠ `ble.host`	`ble_service_register` · `ble_service_unregister` · `ble_host_set_value` · `ble_host_wait_write` · `ble_host_clear`
ESP-NOW ⚠ `esp_now`	`espnow_send` · `espnow_recv`

Compute and lifecycle¶

Page	Functions
Crypto primitives	`sha256` · `sha1` · `aes256_ige_encrypt`/`_decrypt` · `modexp` · `rsa_encrypt` · `dh_compute`
Background tasks ⚠ `background.register`	`background_register`
Code modules (native only)	`module_load` · `module_run` · `module_unload`
Resource limits	every hard cap in one table

⚠ = capability required. See Capabilities for the tier rules and what each one unlocks.

Which SDK level do I need?¶

The firmware exports a single API level, and an app declares the lowest one it can run on via sdk_min. Most of this reference is available at level 1. A call — or in a few cases just its MicroPython binding, where that arrived after the C form — added at level 2 or level 3 is marked in place with a "Requires SDK level 2/3" note.

The SDK changelog lists every level, what it added, and how to pick a value for sdk_min.