webapi:uniserver_auto:api_weightindikator [Документация на программное обеспечение для весовых систем]

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

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


webapi:uniserver_auto:api_weightindikator

Описание WEB-API UniServer AUTO. Плагин весового индикатора WEIGHTINDICATOR.

Включение/отключение обмена данными с весовым индикатором

Формат запроса к WEB интерфейсу плагина

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

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

Пример запроса к плагину WeightIndicator1:
http://uniserver.vesysoft.ru:8123/core/plugins/WeightIndicator1/Enable?Enable=true&auth_user=user&auth_password=user

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

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

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

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

Пример запроса к плагину WeightIndicator1:
http://uniserver.vesysoft.ru:8123/core/SendMsg?Name=WeightIndicator1_Enable&Value=true&auth_user=user&auth_password=user

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

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

Формат запроса к WEB интерфейсу плагина

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

Пример запроса к плагину WeightIndicator1:
http://uniserver.vesysoft.ru:8123/core/plugins/WeightIndicator1/Parameters?auth_user=user&auth_password=user
Формат запроса к опубликованным методам плагина

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

Пример запроса к плагину WeightIndicator1:
http://uniserver.vesysoft.ru:8123/core/SendMsg?Name=WeightIndicator1_GetParameters&auth_user=user&auth_password=user
Формат ответа

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

{
  "Enable":true,
  "State":2,
  "StateName":"ReceiveOk",
  "UnitMeas":"kg",
  "Precision":0,
  "Discret":10,
  "NameProtocol":"CAS 22 byte",
  "Massa":13040,
  "Stabil":true,
  "StMassa":"   13040",
  "StState":"Прием данных..Ok",
  "RxPacket":58,
  "RxByte":1270,
  "TxPacket":0,
  "TxByte":0,
  "WeightIndicatorPluginName":"WeightIndicator1",
  "SerialPort":"SerialPort_WI1",
  "SerialPort_StState":"Порт ОТКРЫТ:COM1,19200,8,1,None,None,0,0"
}

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

Наименование поля Тип принимаемого значения Описание
Enable Логическое (true/false) Флаг состояния активности плагина (включен/выключен)
State Число Код состояния связи с весовым индикатором
StateName Строка Имя состояния связи с весовым индикатором (короткое наименование латинскими буквами для анализа)
UnitMeas Строка Единица измерения массы
Precision Число Точность измерения массы
Discret Число Дискретность измерения массы
NameProtocol Строка Наименования протокола обмена с весовым индикатором
Massa Число Значение массы
Stabil Логическое (true/false) Флаг стабильности массы
StMassa Строка Значение массы
StState Строка Описание состояние связи с весовым индикатором (на русском языке для вывода в пользовательский интерфейс)
RxPacket Число Количество пакетов, принимаемых с весового индикатора в секунду
RxByte Число Количество байт, принимаемых с весового индикатора в секунду
TxPacket Число Количество пакетов, отправляемых на весовой индикатор в секунду
TxByte Число Количество байт, отправляемых на весовой индикатор в секунду
WeightIndicatorPluginName Строка Наименование плагина
SerialPort Строка Наименование используемого плагина COM порта
SerialPort_StState Строка Состояние используемого плагина COM порта

Получение значения текущей массы

Формат запроса к WEB интерфейсу плагина

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

Пример запроса к плагину WeightIndicator1:
http://uniserver.vesysoft.ru:8123/core/plugins/WeightIndicator1/Massa?auth_user=user&auth_password=user

Аналогичный запрос к ядру системы через список опубликованных команд

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

Пример запроса к плагину WeightIndicator1:
http://uniserver.vesysoft.ru:8123/core/SendMsg?Name=WeightIndicator1_GetMassa&auth_user=user&auth_password=user

Формат ответа

Система формирует ответ на данный запрос в формате строки text/plain.

Пример ответа системы:

13030

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

Формат запроса к WEB интерфейсу плагина

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

Пример запроса к плагину WeightIndicator1:
http://uniserver.vesysoft.ru:8123/core/plugins/WeightIndicator1/PressZero?auth_user=user&auth_password=user

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

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

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

Пример запроса к плагину WeightIndicator1:
http://uniserver.vesysoft.ru:8123/core/SendMsg?Name=WeightIndicator1_PressZero&auth_user=user&auth_password=user

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

webapi/uniserver_auto/api_weightindikator.txt · Последние изменения: 2020/12/28 09:40 — akkullow