NooAPI plugin

NooAPI

Плагин реализует web-API для управления устройствами NooLite. Для работы требуется установленные плагины Listener, NooLite с разрешёнными зависимостями.

В качестве аппаратной части используется передатчик PC11xx, поддерживаемый плагином NooLite, приём информации с датчиков в текущей версии отсутствует.

API

API реализован подобным интерфейсу шлюза PR1132, и поддерживает все команды, доступные в официальной документации. В отличие от шлюза обработчик api-запросов находится по адресу http://ip-of-server/api/noolite.

Командой является GET-запрос вида http://ip-of-server/api/noolite?ch=1&cmd=6&br=100

При успешном выполнении команды возвращается ответ "OK", при неверном формате возвращается ошибка 500, если команда не поддерживается текущим устройством или версией плагина - возвращается "UNSUPPORTED".

Аргументы запроса:

• ch (обязательный) - канал, на который передаётся команда. В зависимости от передатчика значение от 0 до 7-15-31.
• cmd (обязательный) - команда для передачи
• br - значение яркости для команды 6 (Set), должно находиться в пределах (0..100)
• fmt - формат данных для команды 6 (Set), если отсутствует параметр br. Может принимать значения 1 или 3, попытка задать другое значение окончится ошибкой.
• d0 - первый байт данных для команды 6 (Set). Значение в пределах 0..255.
• d1 - второй байт данных для команды 6 (Set). Значение в пределах 0..255.
• d2 - третий байт данных для команды 6 (Set). Значение в пределах 0..255.
• d3 - четвёртый байт данных для команды 6 (Set). В текущей версии игнорируется, должен отсутствовать или быть равен 0.

Список доступных команд

• 0 (Off) – выключить нагрузку
• 1 (RegDown) – запустить плавное понижение яркости
• 2 (On) – включить нагрузку
• 3 (RegUp) – запустить плавное повышение яркости
• 4 (Toggle) – включить или выключить нагрузку
• 5 (RegToggle) – запустить плавное изменение яркости в обратном направлении
• 6 (Set) – установить заданную яркость (см. описание ниже)
• 7 (Preset) – вызвать записанный сценарий
• 8 (PresetRec) – записать сценарий
• 9 (UnBind) – послать запрос стирания адреса передатчика из памяти исполнительного устройства (отвязка)
• 10 (RegStop) – остановить регулировку
• 15 (Bind) – послать запрос на запись адреса передатчика в память исполнительного устройства (привязка)
• 16 (RollColor) - включить плавный перебор цвета, выключается командой 10 (только для SD111)
• 17 (SwitchColor) - переключить цвет (только для SD111)
• 18 (SwitchMode) - переключить режим работы (только для SD111)
• 19 (SwitchSpeed) - переключить скорость эффекта в режиме работы (только для SD111)

Команда 6 (Set) имеет несколько режимов управления, в зависимости от переданных аргументов.

• Присутствует аргумент br. Аргумент интерпретируется как значение яркости в процентах, остальные аргументы игнорируются. В начале и конце интервала яркость не изменяется плавно вследствие конструктивных особенностей исполнительных устройств.
• Присутствует аргумент fmt равный 1 и аргумент d0. Значение d0 интерпретируется как абсолютное значение яркости модуля и передаётся без изменений. Значение, соответствующее максимальной яркости - 155.
• Присутствует аргумент fmt равный 1 и аргументы d0, d1, d2. Значения аргументов интерпретируются как значения яркости каналов контроллера SD111 (d0 - красный, d1 - зелёный, d2 - синий). Значение, соответствующее максимальной яркости - 255.
• В прочих случаях возвращается 500 ошибка.