Описание WEB-API UniServer AUTO. Плагин LED панели LEDPANEL

Включение/отключение отображения данных на LED панели

Формат запроса к опубликованным методам плагина

Наименование метода: LedPanel1_Enable

В запросе используется один дополнительный параметр, который может принимать значения true для включения обмена и false для отключения обмена.

Пример запроса:
http://uniserver.vesysoft.ru:8123/core/SendMsg?Name=LedPanel1_Enable&Value=true&auth_user=user&auth_password=user

Успешное выполнение команды подтверждается статусом ответа 200 OK

Получение всех параметров от плагина (текущая масса, состояние и т.п.)

Формат запроса к опубликованным методам плагина

Наименование метода: LedPanel1_GetParameters

Пример запроса:
http://uniserver.vesysoft.ru:8123/core/SendMsg?Name=LedPanel1_GetParameters&auth_user=user&auth_password=user
Формат ответа

Система формирует ответ на данный запрос в формате JSON
Пример ответа системы:

{
	"PluginName":"LedPanel1",
	"Enabled":false,
	"StState":"Порт ОТКРЫТ:COM3,9600,8,1,None,None,0,0",
	"SerialPort_StState ":"Порт ОТКРЫТ:COM3,9600,8,1,None,None,0,0"
}

Перечень полей, содержащихся в ответе

Наименование поля	Тип принимаемого значения	Описание
PluginName	Строка	Наименование плагина
Enable	Логическое (true/false)	Флаг состояния активности плагина (включен/выключен)
StState	Строка	Строка состояния используемого плагином COM порта
SerialPort_StState	Строка	Состояние используемого плагина COM порта

Вывод графического примитива круг на LED панель

Наименование метода: LedPanel1_OutCircle

Данный запрос содержит входной параметр Value - JSON с параметрами выводимой строки:

adr - Адрес RS-485 контроллера LED панели (по умолчанию «0»);
xxx - Координата начальной точки вывода информации по оси X от левого нижнего угла LED панели;
yyy - Координата начальной точки вывода информации по оси Y от левого нижнего угла LED панели;
size - Радиус круга;
color - Цвет выводимой информации (расшифровка значений цветов представлена ниже).

Пример запроса:
http://uniserver.vesysoft.ru:8123/core/SendMsg?Name=LedPanel1_OutCircle={"adr":0,"xxx":9,"yyy":9,"size":5,"color":3}&auth_user=user&auth_password=user

Данный запрос отобразит в левом нижнем углу LED панели с адресом «0» круг желтым цветом.

Успешное выполнение команды подтверждается статусом ответа 200 OK

Расшифровка цветов

Значение поля	Цвет
0	Чёрный
1	Красный
2	Зелёный
3	Желтый

Вывод текстовой информации на LED панель

Формат запроса к опубликованным методам плагина

Наименование метода: LedPanel1_OutText

Данный запрос содержит входной параметр Value - JSON с параметрами выводимой строки:

adr - Адрес RS-485 контроллера LED панели (по умолчанию «0»);
xxx - Координата начальной точки вывода информации по оси X от левого нижнего угла LED панели;
yyy - Координата начальной точки вывода информации по оси Y от левого нижнего угла LED панели;
size - Размер шрифта текста выводимой информации (расшифровка значений размеров шрифтов представлена ниже);
color - Цвет выводимой информации (расшифровка значений цветов представлена ниже);
text - Текст выводимой информации.

Пример запроса:
http://uniserver.vesysoft.ru:8123/core/SendMsg?Name=LedPanel1_OutText&Value={"adr":0,"xxx":0,"yyy":0,"size":2,"color":3,"text":"ПРОВЕРКА"}&auth_user=user&auth_password=user

Данный запрос отобразит в левом нижнем углу LED панели с адресом «0» строку «ПРОВЕРКА» малым шрифтом, желтым цветом.

Успешное выполнение команды подтверждается статусом ответа 200 OK

Расшифровка цветов

Значение поля	Цвет
0	Чёрный
1	Красный
2	Зелёный
3	Желтый
4	Синий
5	Фиолетовый
6	Бирюзовый
7	Белый

Расшифровка размеров шрифтов

Значение поля	Цвет
0	Большой обычный
1	Большой полужирный
2	Средний обычный
3	Средний полужирный
4	Малый обычный
5	Малый полужирный

Изменение текстовой информации по имени метки в OSD шаблоне

Плагин LEDPANEL имеет возможность вывода текстовой информации с помощью шаблона OSD. Шаблон OSD состоит из областей вывода информации, каждая область имеет свою метку Name. Такой способ вывода информации на LED панель удобен, когда требуется изменять какие-либо значения на табло без изменения других.

Формат запроса к опубликованным методам плагина

Наименование метода: LedPanel1_SetOSD

Данный запрос содержит входной параметр Value - JSON с параметрами выводимой строки:

Name - наименование метки OSD;
text - текстовая информация, которую необходимо отобразить в области Name;

Пример запроса:
http://uniserver.vesysoft.ru:8123/core/SendMsg?Name=LedPanel1_SetOSD&Value={"Name":"Area","text":"12345"}&auth_user=user&auth_password=user

Успешное выполнение команды подтверждается статусом ответа 200 OK

Очистка LED панели

Формат запроса к опубликованным методам плагина

Наименование метода: LedPanel1_Clear

Пример запроса:
http://uniserver.vesysoft.ru:8123/core/SendMsg?Name=LedPanel1_Clear&auth_user=user&auth_password=user

Успешное выполнение команды подтверждается статусом ответа 200 OK