OpenSprinklerPro API and platform addendum

This addendum documents firmware endpoints and platform details that were added after the original 2.2.1 manual pages.

The OpenSprinklerShop firmware, including OpenSprinklerPro, uses its own firmware version numbering independent of upstream OpenSprinkler releases. Current OpenSprinklerShop firmware version: 2.4.0(199).

Platform corrections

Endpoint Supported platforms Notes
/uc, /uu, /us, /ub ESP32, ESP8266 Firmware online update and full backup endpoints. Not available on OSPi/Linux builds.
/sx ESP32, ESP8266, OSPi Sensor-only configuration backup/import. Distinct from /ub.
/jw ESP32, ESP8266, OSPi Monthly water-usage data.
/tg, /tl, /ta, /tc, /tx ESP32 HTTPS certificate and ACME/Let's Encrypt management.
/rk, /rp, /ru ESP32 with ENABLE_RAINMAKER ESP RainMaker status, provisioning and unlink/reset flows.
/jm, /mm ESP32 with ENABLE_MATTER Matter pairing information and commissioning window.
/bd, /bs, /bc ESP32 with OS_ENABLE_BLE BLE scan and discovered-device management.
/ir, /iw, /zj, /zs, /zg, /zd, /zo, /zc ESP32-C5 with Zigbee/IEEE 802.15.4 support Radio mode and Zigbee gateway/client endpoints.

Online update and backup

Endpoint Purpose
GET /uc?pw=... Check update manifest and report whether a newer firmware is available.
GET /uu?pw=... Start firmware update. Advanced parameters can override URLs and hashes: zu, mu, fu, zs, ms; vt selects zigbee or matter.
GET /us?pw=... Read update status and progress.
GET /ub?pw=... Export full controller configuration for app-side backup before update.

HTTPS certificates and ACME

Endpoint Purpose
GET /tg?pw=... Read active certificate type, subject, issuer and validity.
POST /tl?pw=... Upload custom PEM certificate and key. Reboot afterwards.
GET /ta?pw=... Read ACME configuration and status.
POST /tc?pw=... Save ACME settings and optionally request a certificate.
GET /tx?pw=... Delete ACME data and return to the internal certificate.

RainMaker and Matter

Endpoint Purpose
GET /rk?pw=... Read RainMaker status. Optional reset_mapping=1 or factory_reset=1 perform maintenance actions.
GET /rp?pw=...&uid=...&key=... Start RainMaker provisioning.
GET /ru?pw=... Unlink RainMaker account and trigger reset/reboot behavior.
GET /jm?pw=... Read Matter commissioning state, QR-code URL and manual pairing code.
GET /mm?pw=...&t=300 Open Matter commissioning window; t is optional timeout in seconds, max 900.

Water usage and sensors

Endpoint Purpose
GET /jw?pw=... Read monthly water usage: pulse rate, current month and stored records.
GET /sf?pw=... List supported sensor types for the current build.
GET /sx?pw=... Export/import sensor configuration only.
GET /mc, /ml, /mt Configure, list and discover monitor types.

For the complete legacy API reference, see Firmware 2.2.1 API Reference.