HTTP REST API

Материал из www.noo.by
Перейти к навигации Перейти к поиску

Общее описание

Данный API позволяет управлять устройствами и получать информацию о их состоянии посредством HTTP запросов. Вы можете управлять устройствами nooLite из любой системы "Умный дом" (MajorDoMo, openHAB, ...).

Запросы должны интерпретироваться в независимости от закрывающего слеша «/». При интерпретации все URI запросов приводятся к нижнему регистру ( «/ID_device», «/id_device/» = «/id_device» ).


запрос: 
/device
ответ:
//получаем все устройства
{"device": [
  {"id": "0x00001256", "type": "suf-1-300", "firmware": 1.00, "state": "on", "power": 33},
  {"id": "0x00001855", "type": "srf-1-3000-m", "firmware": 1.00, "state": "on", "power": 100},
  {"id": "0x00001225", "type": "srf-1-3000-t", "firmware": 1.02, "state": "off", "power": 0},
  {"id": "0x00000807", "type": "srf-10-1000", "firmware": 1.05, "state": "off", "power": 0}
 ]
} 
ST MODE CTR RES CH CMD FMT D0 D1 D2 D3 CRC SP
0xAB 0x02 0x00 0x00 0x00 0x80 0x00 0x00 0x00 0x00 0x00 0x2D 0xAC



id = 0x0000A289
запрос:
/device/id
ответ:
//получаем информацию об одном устройстве
{
 "id": "0x00001256",
 "type": "suf-1-300",
 "firmware": 1.00,
 "state": "on",
 "power": 33
}
ST MODE CTR RES CH CMD FMT D0 D1 D2 D3 CRC SP
0xAB 0x02 0x09 0x00 0x00 0x80 0x00 0x00 0x00 0xA2 0x89 0x61 0xAC




запрос:
/settings/id 
ответ:
//получаем настройки одного устройства
{ 
 "remember_state": "on"
 "dimmer": "on" 
}




запрос:
/cmd/id/on
ответ:             //получаем информацию об одном устройстве
{
 "id": "0x00001256",
 "type": "suf-1-300",
 "firmware": 1.00,
 "state": "on",
 "power": 33
}
ST MODE CTR RES CH CMD FMT D0 D1 D2 D3 CRC SP
0xAB 0x02 0x09 0x00 0x00 0x02 0x00 0x00 0x00 0xA2 0x89 0xE3 0xAC





/cmd/id/level/100
/cmd/id/level_hex/0x000000255
/cmd/id/color/0x000000255


/cmd/id/clear


/cmd_n/chn/off



запрос:

/bind 




/unbind/id


/bind_n/rx/chn
/bind_n/tx/chn
/recive_n/chn
//получаем все устройства
{"recive_n": [
  {"chn": "1", "type": "PT-111", "temp": "25", "humi": 50},
  {"chn": "2", "type": "PM-111", "temp": "25", "humi": 50}
 ]
}


/mtrf/set_baudrate/9600
/mtrf/clear_mem


Коды состояния HTTP:

200 - запрос успешно выполнен;
400 - переданы неверные параметры запроса;
500 - внутренняя ошибка контроллера при выполнении запроса.


Добавление и удаление устройств (Привязка/отвязка)

Сценарии

Список команд