Developer documentation & API reference
Plugins
Build your own OXRecorder plugins
Mobile app
Download the OXRecorder app to set up your OX Device
PSSP
PSSP connects the OXRecorder system
Self-host
Run OXRecorder on your own server
Firmware
Upload firmware to your recorder
Hardware
Hardware blueprint
API reference
Classes
Build with OXRecorder: explore plugins, firmware APIs, mobile setup, and PSSP streaming. All guides are public and available without signing in.
Want to reuse this code in your own project? The SDK & download page shows how to download the managers as a ready-to-use PlatformIO SDK and wire it up.
Use AI Builder or write your own code to work with OX devices, recordings, transcripts, sensors, and automations. Read the complete plugin guide in English or Chinese without a portal account.
Build with AI · Development kit & downloads · Programming API · Hello world example
Set up your OX Device over Bluetooth, configure Wi-Fi, and manage your devices, recordings, teams, and enabled plugins from one app.
Connect nearby recorders, manage device settings, browse and play recordings, work with teams, and open interactive plugins on Android.
Requires Android 7.0 or later. This download is a debug build. Interactive plugins require an up-to-date Android System WebView.
OXRecorder-1.0-build-6-debug.apk · 16,502,550 bytes
SHA-256: 51e10cae19e26797625d7767b96411f98ea9c88fe78525a65e3ec52ffb0e3123
Use OXRecorder on iPhone to connect and configure recorders, browse and play recordings, manage teams, and use enabled plugins.
Requires iOS 16.0 or later. Check TestFlight for the build currently available to your account.
Open the invitation, install Apple's TestFlight app if prompted, then accept the invitation and install OXRecorder.
Get the iOS app via TestFlightAndroid installation: Open the downloaded APK on your Android device. If prompted, allow your browser or file manager to install apps from this source, then complete the installation.
PSSP provides communication between end devices and servers throughout the OXRecorder system. Learn how to install the broker, connect and authenticate clients, exchange application data and handle delivery and reconnection.
Download the PSSP service and client · developer guide →
Set up the broker · Test with the desktop client · Connect an end device and server · Protocol reference
A self-hosted instance runs on your own Mac or Ubuntu server and keeps your recordings private: they stay on your server, never reach the OX cloud, and only the accounts you create can open them. You keep managing devices from the cloud portal.
Firmware v1.0 · Build 30 · October 23, 2026 (UTC) · 1,029.0 KiB
Download OXRecorder firmware (.oxfw) · SHA-256 checksums
Build 30 update: Checks the configured self-host service every two minutes while using cloud fallback. On authenticated recovery, closes the current clip, preserves pending audio, and restarts into self-host. Resumes recording once with its original stop time and keeps upload progress and schedules separate for each destination. The package compiled successfully and passed uploader package validation. Physical-device verification is pending.
Build 27 update: Raises the preferred SD-card SPI data clock to 40 MHz for faster local-recording replay, with automatic fallbacks through 26.67, 20, 16, 12, 8, 4, 2 and 1 MHz for cards or wiring that cannot sustain the higher rate. SD initialization remains at 400 kHz. The package compiled successfully and passed uploader package validation.
Build 23 update: Separates server commands from device reports while retaining one encrypted PSSP TCP connection. Device reports now use a dedicated report topic, and command subscriptions request broker-enforced noLocal delivery suppression to prevent replayed self-published control messages from disconnecting the device. This build requires PSSP broker 1.0.7 and the matching web-service report-topic deployment. The package compiled successfully and passed uploader package validation.
Build 5 update: Battery voltage measurement now uses a 100 kΩ top resistor and a 24 kΩ resistor to ground. Before installing, wire battery positive → 100 kΩ → GPIO7 → 24 kΩ → GND. This keeps the full-charge ADC input in range; the firmware maps approximately 4.20 V to 100%.
Download the USB firmware uploader for Windows x64, macOS Apple Silicon or Linux x64, then open an .oxfw package to update your recorder. Python and the upload tools are included.
Firmware uploader downloads & step-by-step instructions →
Developer guide: build, export, validate and upload your own firmware
Current downloads are development previews for the ESP32-S3 Super Mini N4R2. See the guide for platform requirements and validation status.
The OXRecorder hardware is an ESP32-S3 Super Mini with three peripherals: an INMP441 microphone (I2S), a microSD adapter (SPI), and a WS2812 status LED, powered by a 3.7 V LiPo battery through a TP4056, plus a battery-sense divider on GPIO7 and a reset button on GPIO8. The full pin map is below — anyone with this page can build the board. Each peripheral's detailed wiring is on its How It Works page (mic, SD, LED, battery sense).
OXRecorder hardware blueprint — power: Battery → TP4056 (5 V) → ESP32-S3, microSD & INMP441 on the ESP32's 3V3 output; GPIO7 senses the raw battery VCC/GND terminals through a 1k/1k divider, not the TP4056 output rail; 10uF across microSD VCC/GND; 330 Ω and a level shifter on the WS2812 data line if the LED runs at 5 V.
| Peripheral | Peripheral pin | ESP32-S3 Super Mini | Managed by |
|---|---|---|---|
| INMP441 mic (I2S) | SCK | GPIO3 | OXAudioManager |
WS | GPIO5 | ||
SD | GPIO4 | ||
L/R | GND | ||
| microSD (SPI) | CS | GPIO13 | OXFileManager |
SCK | GPIO12 | ||
MISO | GPIO10 | ||
MOSI | GPIO11 | ||
VCC | 3V3 with 10uF to GND at adapter | ||
GND | GND | ||
| Battery sense divider | top resistor 1k | raw battery VCC / cell +, before TP4056 output | OXBatteryManager |
| midpoint | GPIO7 (ADC) | ||
bottom resistor 1k | raw battery GND / cell − | ||
| WS2812 LED | DIN | GPIO9 via 330 Ω; level shift if LED VDD is 5 V | OXLEDManager |
| Reset button | terminal A | GPIO8 | OXConfigManager — hold 10 s to reset |
| terminal B | GND |
Signal pins are the firmware defaults and can be overridden in each
manager's begin(). Internal flash storage (LittleFS) needs no
wiring.
The 3.7 V LiPo feeds a TP4056 module, which charges the cell and boosts its output to 5 V. That 5 V rail powers the ESP32-S3 Super Mini (5V pin). The INMP441 and a 3.3 V-compatible microSD adapter run from the ESP32-S3's regulated 3V3 output, not the 5 V rail.
| From | To | Rail | Notes |
|---|---|---|---|
| Battery 3.7 V (+/−) | TP4056 B+ / B− | 3.7 V | Charge + protect the cell. |
| TP4056 OUT 5 V | ESP32-S3 Super Mini 5V | 5 V | Boosted output powers the MCU board. |
ESP32-S3 3V3 out | microSD VCC | 3.3 V | Use an adapter with 3.3 V MISO; place 10uF from VCC to GND near the adapter. |
| TP4056 OUT 5 V | WS2812 5V | 5 V | Use a 3.3 V-to-5 V level shifter between GPIO9 and DIN. |
| Battery cell + / − | GPIO7 through 1k/1k divider | ADC sense | Top resistor goes to raw battery VCC; bottom resistor goes to raw battery GND. Do not connect this divider to TP4056 OUT 5 V. |
ESP32-S3 3V3 out | INMP441 VDD | 3.3 V | Mic runs on the MCU's regulated 3.3 V only. |
Common GND | all devices | — | TP4056, MCU, mic, SD, and LED share ground. |
The ESP32-S3 GPIOs are not 5 V tolerant. Keep the SD bus at 3.3 V, and
add a 3.3 V-to-5 V level shifter after the 330 Ω series resistor when the
WS2812 runs at 5 V. The SD adapter should have a local 10uF capacitor from
VCC to GND to absorb card current spikes. The
INMP441 is kept on 3.3 V because it is a 1.8–3.6 V part.
OXRecorder::OXLog
Centralized, level-based logging facility. Wraps the serial transport so all firmware output flows through one extensible API.
OXRecorder::OXFileManager
Unified read/write access to internal flash (LittleFS, quota-bounded) and the external SD card (SdFat/exFAT), with streaming writes.
OXRecorder::OXSecurity
Instance-based AES-256-CBC encrypt/decrypt for strings and binary data, with per-instance key and IV for local vs. server use.
OXRecorder::OXAudioManager
INMP441 microphone capture — start/stop/pause recording and receive continuous 16-bit PCM via callback or read(), for further processing.
OXRecorder::OXLEDManager
WS2812 status LED — distinct color + animation per application state (pairing, Wi-Fi, recording, faults), so the light shows what the device is doing.
OXRecorder::OXBatteryManager
ADC battery / power-rail sensing on GPIO7 — reads a resistor divider, reconstructs the source voltage, and maps it to a percentage with a configurable drop curve.
OXRecorder::OXSwitchManager
GPIO switch monitoring — debounced on/off state and configurable long-press detection (5 s, 10 s, …) with per-pin callbacks.
OXRecorder::OXConfigManager
Central config store plus the hardware reset feature — a long press on GPIO8 triggers a reset callback, built on OXSwitchManager.
OXRecorder::OXWirelessManager
The transport layer: the Wi-Fi and Bluetooth (NimBLE) chips, their connection state, raw data exchange, and per-radio byte statistics — behind injectable transports. Protocol logic lives in OXAPIManager.
OXRecorder::OXAPIManager
The protocol layer on top of OXWirelessManager: inbound REST routing and Bluetooth command dispatch, plus an outbound REST client with chunked streaming uploads — behind an injectable HTTP client.
No classes match your search.