Инструменты пользователя

Инструменты сайта


api

http API

Сервис предоставляется по протоколу http на статическом или динамическом IP адресе контроллера при определении опции компиляции OTA (в builds_flags_* для соответствующей HW архитектуры добавляется строка)

-DOTA

По умолчанию, добавлено для архитектур DUE/Lighthub, ESP*, Mega2560Slim*

Осуществляется анонсирование контроллера через сервис MDNS для простого обнаружения в локальной сети по имени <имя-контроллера-из-конфигурации-mqtt>.local (Если конфигурация еще не загружена - lighthub.local) Анонсирование включается при использовании опции компиляции MDNS. Пример:

-DMDNS

TCP port для доступа к API: 65280 (можно переопределить при компиляции при помощи директивы OTA_PORT)

Поддерживаемые endpoint - ы и методы:

endpointMethodsDescription
/sketchPOST,OPTIONSЗагрузка прошивки контроллера
/config.jsonPOST,GET,OPTIONSЗагрузить или прочитать JSON конфиг в/из NVRAM контроллера
/config.binPOST,GET,OPTIONSЗагрузить или прочитать системный конфиг в/из NVRAM контроллера (содержит MAC,IP параметры и прочие системные настройки)
/<произвольное имя>.<bin/json/gif/jpg/html>POST,GET,OPTIONSЗагрузить или прочитать произвольный файл с/на флэш контроллера
/command/<command_name>POST,OPTIONSвыполнить консольную команду контроллера (reboot, save, get, load, mac, ip etc). Параметры передаются в теле POST запроса)
/item/<item_name>[/subitem][/suffix]POST,GET,OPTIONSвыполнить команду либо прочитать статус соответствующего item. Смысл subitem и suffix а также, синтаксис команды (передается в теле POST запроса) абсолютно идентичны MQTT API
/GET,OPTIONSпереадресация на страницу PWA приложения (по умолчанию http://lazyhome.ru/pwa) с передачей параметров mac и ip
api.txt · Последнее изменение: 2021/10/08 01:56 — Admin