Adendo de API e Plataformas OpenSprinklerPro

Este documento contém a descrição técnica de endpoints HTTP adicionais adicionados após as especificações básicas de hardware.

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

Correções de Plataforma

Endpoint	Plataformas Suportadas	Notas
/uc, /uu, /us, /ub	ESP32, ESP8266	Endpoints de atualizações online (FOTA) e backups completos de configuração. Não disponíveis em builds OSPi/Linux.
/sx	ESP32, ESP8266, OSPi	Backups de configurações de sensores.
/jw	ESP32, ESP8266, OSPi	Relatórios mensais de consumo e fluxo de água.
/tg, /tl, /ta, /tc, /tx	ESP32	Gerenciamento de certificados HTTPS e ACME/Let's Encrypt.
/rk, /rp, /ru	ESP32 com ENABLE_RAINMAKER	Status e provisionamento na nuvem ESP RainMaker.
/jm, /mm	ESP32 com ENABLE_MATTER	Emparelhamento do protocolo Matter.
/bd, /bs, /bc	ESP32 com OS_ENABLE_BLE	Controles de scanners Bluetooth Low Energy (BLE).
/ir, /iw, /zj, /zs, /zg, /zd, /zo, /zc	ESP32-C5 com suporte Zigbee/IEEE 802.15.4	Chaveamento de rádio e comunicação do gateway/cliente Zigbee.

Atualização Online e Backup

Endpoint	Objetivo
GET /uc?pw=...	Verifica o manifesto de atualização e relata se um firmware mais recente está disponível.
GET /uu?pw=...	Inicia o processo de atualização do firmware. Parâmetros avançados permitem substituir URLs e hashes: zu, mu, fu, zs, ms; vt seleciona zigbee ou matter.
GET /us?pw=...	Lê o status da atualização e o progresso.
GET /ub?pw=...	Exporta a configuração completa do controlador para backup antes da atualização.

Certificados HTTPS e ACME

Endpoint	Objetivo
GET /tg?pw=...	Lê o tipo de certificado ativo, assunto, emissor e validade.
POST /tl?pw=...	Envia um certificado personalizado PEM e chave privada. Reinicia em seguida.
GET /ta?pw=...	Lê a configuração e o status do ACME (Let's Encrypt).
POST /tc?pw=...	Salva as configurações do ACME e solicita um certificado opcionalmente.
GET /tx?pw=...	Exclui dados do ACME e retorna para o certificado interno padrão.

RainMaker e Matter

Endpoint	Objetivo
GET /rk?pw=...	Lê o status do ESP RainMaker. Parâmetros opcionais reset_mapping=1 ou factory_reset=1 realizam ações de manutenção.
GET /rp?pw=...&uid=...&key=...	Inicia o provisionamento do RainMaker.
GET /ru?pw=...	Desvincula a conta RainMaker e aciona comportamentos de redefinição / reinicialização.
GET /jm?pw=...	Lê o estado de comissionamento do Matter, URL do QR Code e código manual de pareamento.
GET /mm?pw=...&t=300	Abre a janela de pareamento do Matter; t é o tempo limite opcional em segundos, máximo 900.

Uso de Água e Sensores

Endpoint	Objetivo
GET /jw?pw=...	Lê o uso mensal de água: taxa de pulso, mês atual e registros salvos.
GET /sf?pw=...	Lista os tipos de sensores suportados pela build atual.
GET /sx?pw=...	Exporta ou importa apenas a configuração de sensores.
GET /mc, /ml, /mt	Configura, lista e descobre tipos de monitoramento.

A referência legacy completa da API pode ser encontrada em Referência da API do Firmware 2.2.1.