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

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


api

Различия

Показаны различия между двумя версиями страницы.

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
api [2021/09/25 03:42]
65.21.180.7 старая версия восстановлена (2021/07/24 12:00)
api [2022/05/02 10:00] (текущий)
Sanch-KK
Строка 3: Строка 3:
 Сервис предоставляется по протоколу http на статическом или динамическом IP адресе контроллера при определении опции компиляции OTA (в builds_flags_* для соответствующей HW архитектуры добавляется строка) Сервис предоставляется по протоколу http на статическом или динамическом IP адресе контроллера при определении опции компиляции OTA (в builds_flags_* для соответствующей HW архитектуры добавляется строка)
  
-`-DOTA`+<code>-DOTA</code>
 По умолчанию, добавлено для архитектур DUE/Lighthub, ESP*, Mega2560Slim*  По умолчанию, добавлено для архитектур DUE/Lighthub, ESP*, Mega2560Slim* 
  
Строка 9: Строка 9:
 (Если конфигурация еще не загружена - lighthub.local) (Если конфигурация еще не загружена - lighthub.local)
 Анонсирование включается при использовании опции компиляции MDNS. Пример: Анонсирование включается при использовании опции компиляции MDNS. Пример:
-`-DMDNS`+<code>-DMDNS</code>
  
-TCP port для доступа к API: 65280 (можно переопределить при компиляции при помощи директивы OTA_PORT)+TCP port для доступа к API: 80 (можно переопределить при компиляции при помощи директивы OTA_PORT)
  
 Поддерживаемые endpoint - ы и методы: Поддерживаемые endpoint - ы и методы:
Строка 17: Строка 17:
 ^endpoint|Methods|Description| ^endpoint|Methods|Description|
 |/sketch|POST,OPTIONS|Загрузка прошивки контроллера| |/sketch|POST,OPTIONS|Загрузка прошивки контроллера|
-|/config|POST,GET,OPTIONS|Загрузить или прочитать JSON конфиг в/из NVRAM контроллера| +|/config.json|POST,GET,OPTIONS|Загрузить или прочитать JSON конфиг в/из NVRAM контроллера| 
-|/binconfig|POST,GET,OPTIONS|Загрузить или прочитать системный конфиг в/из NVRAM контроллера (содержит MAC,IP параметры и прочие системные настройки)| +|/ram/[itemname]|POST,GET,OPTIONS|Загрузить или прочитать JSON конфиг (по указанному item, если он указан, или все дерево )в/из RAM контроллера - используется непосредственно слепок конфига в оперативной памяти| 
-|/command/<command_name>|POST,OPTIONS|выполнить консольную команду контроллера (reboot|save|get|load|mac|ip etc). Параметры передаются в теле POST запроса)| +|/config.bin|POST,GET,OPTIONS|Загрузить или прочитать системный конфиг в/из NVRAM контроллера (содержит MAC,IP параметры и прочие системные настройки)
 +|/<произвольное имя>.<bin/json/gif/jpg/html>|POST,GET,OPTIONS|Загрузить или прочитать произвольный файл с/на флэш контроллера
 +|/command/<command_name>|POST,OPTIONS|выполнить консольную команду контроллера (rebootsavegetloadmacip etc). Параметры передаются в теле POST запроса)| 
 |/item/<item_name>[/subitem][/suffix]|POST,GET,OPTIONS|выполнить команду либо прочитать статус соответствующего item. Смысл subitem и suffix а также, синтаксис команды (передается в теле POST запроса) абсолютно идентичны MQTT API| |/item/<item_name>[/subitem][/suffix]|POST,GET,OPTIONS|выполнить команду либо прочитать статус соответствующего item. Смысл subitem и suffix а также, синтаксис команды (передается в теле POST запроса) абсолютно идентичны MQTT API|
 |/|GET,OPTIONS|переадресация на страницу PWA приложения (по умолчанию http://lazyhome.ru/pwa) с передачей параметров mac и ip| |/|GET,OPTIONS|переадресация на страницу PWA приложения (по умолчанию http://lazyhome.ru/pwa) с передачей параметров mac и ip|
api.1632530526.txt.gz · Последнее изменение: 2021/09/25 03:42 — 65.21.180.7