Skip to content

PX API v2.0.0

Latest
Latest

Choose a tag to compare

View all tags
@mam-pascal mam-pascal released this 10 Jul 15:35
v2.0.0
0674cb3

🖥️ Emulator downloads: the PX emulator binaries for this API version (Linux / Windows / macOS) are attached to the PX Emulator 2026.28.0 release.

Changelog

For detailed API status and roadmap, see docs/README.md

v2.0.0 (juli 2026)

Release of PX JSON-RPC API (JAPI) for third-party integration.

API Status

API Status & Roadmap

📋 Version History

v2.0.0 (June 2026) - Firmware 2026.24.0 — Breaking

  • metrics_update notification paths dropped the /metrics prefix. Metric blocks are now published at topic-relative paths — /vu, /clip, /gain_reduction, /temperatures, /fan, /system, /impedance, /current_rms — matching the status_update convention (/state, /audio, /firmware, /network/lan1, /network/lan2, /gpio), which was never prefixed. Earlier firmware emitted /metrics/vu, /metrics/temperatures, … (a known defect). Clients that subscribe to the whole metrics topic (no path filter) and dispatch on params.path must update their path checks; clients that pass a path filter to metrics_subscribe must use the block-relative path (/vu, not /metrics/vu). See metrics_subscribe in 01-api-reference.md.
  • device_find_me is now a latched on/off toggle: it takes identifying (boolean) instead of timeout (number), and its response returns identifying instead of timeout/status. Identification stays on until turned off (or until reboot / factory reset / restore) — there is no longer a timed countdown.
  • find_me_timeout_seconds removed from the device status (/state). Use find_me_active to read the latched identify state.

v1.4.0 (May 2026) - Firmware 2026.22.0

  • storage.user_data in setup_get_all / setup_update now carries last_modified (RFC 3339 timestamp, or null if never written) instead of sha256. The sha256 field is still returned by storage_get for integrity checking.

v1.3.0 (May 2026) - Firmware 2026.22.0 (first shipped together with v1.4.0)

  • last_power_state removed from the /power read response and setup_set patch — the field was device-internal bookkeeping excluded from schemas and documentation

v1.2.0 (January 2026) - Firmware 2026.4.0

  • HTTPS support - Secure WebSocket (WSS) connections with automatic fallback to HTTP
  • metrics_get / metrics_get_all - Poll metrics without subscription
  • Display configuration (dimming) in setup API
  • TPM object locking support
  • SoM bootloader version in firmware info
  • Screenshot commands moved to diagnostics group

v1.1.0 (December 2025) - Firmware 2025.50.1

  • device_get_time - RTC time endpoint
  • Screenshot capture and download endpoints
  • Per-path frequency throttling for metrics subscriptions
  • DanteStatus moved from /network/dante to /dante
  • device_standby removed (merged into device_power_off)
  • setup_subscribe parameter renamed: paths → path
  • set-x-eq split into set-x-eq and set-x-eq-band

v1.0.0 (November 2025) - Firmware 2025.48.1

  • Initial release
  • Setup API (3-layer audio processing)
  • Device API (power, reboot, time sync)
  • Preset API (with vendor locking)
  • Metrics API (real-time VU, clipping, gain reduction)
  • Status API (device state, network, firmware versions)

Package Contents

Documentation:

  • 6 comprehensive markdown files
  • Complete API reference with examples
  • Configuration path reference
  • Best practices guide

Tooling:

  • Virtual device emulators (3 platforms, via GitHub Releases)
  • Python CLI tool (japi_cli)
  • TypeScript/Python client libraries
  • JSON schemas for every method, notification and wire type

Audio Features:

  • 3-layer processing (User → Array → Preset)
  • 10-band parametric EQ per channel
  • FIR filters, crossovers, limiters
  • Channel preset save/recall
  • Real-time metrics and notifications
Assets 2
Loading