Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

API предоставления данных

Модуль предоставляет различную информацию о конфигурации сервера:

  • идентификаторы сигналов
  • полные и короткие имена сигналов
  • значения свойств сигналов
  • идентификаторы родительских объектов, а также все ссылки на узел

Данный функционал реализован в виде API сервера, включающий набор функций. Вызов функций осуществляется посредством запросов в формате JSON. Возможность вызова функций предоставляет модуль OPC DA Server при помощи OPC DA-клиента, подключенного к серверу.

Набор функций API сервера

API сервера включает следующий набор функций для получения информации о конфигурации сервера:

Название функции Параметры запроса Назначение функции
Сигнальная модель
GetIdByTagName (uint4) tagname (string) Получение ID по имени сигнала
GetTagNameById (string) nodeid (uint4) Получение полного имени сигнала по ID
GetShortNameById (string) nodeid (uint4) Получение короткого имени сигнала по ID
ReadProperty (variant)

nodeid (uint4)

propid (uint4)

Чтение значения свойства сигнала по ID свойства
ReadProperty (variant)

nodeid (uint4)

propname (string)

Чтение значения свойства сигнала по имени свойства
Объектная модель
GetParentObjectId (uint4) nodeid (uint4) Получение ID родительского объекта по ID объекта
FindAllReferences (uint4) nodeid (uint4) Найти все ссылки (ID) на узел по ID узла

Формат запросов JSON

Формат запроса JSON имеет вид:

{
  "transaction":"Идентификатор_вызова",
  "request":{
    "target":"Имя_узла",
    "method":"Функция_узла",
    "input":{
      "Имя_параметра":"Значение_параметра"
    }
  }
}
Значение Описание
Идентификатор_вызова Пользовательский идентификатор, задаётся пользователем и может иметь любое значение
Имя_узла Узел, представляющий API сервера
Функция_узла Имя вызываемой функции API сервера
Имя_параметра Параметр, по которому производится запрос (параметров может быть несколько)
Значение_параметра Значение параметра, по которому производится запрос. Может быть задано в виде массива, если необходимо получить информацию по нескольким параметрам

Формат ответа на запрос JSON имеет вид:

{
  "transaction":"Идентификатор_вызова",
  "result":{
    "return":"Результат",
    "output":"Выходные параметры"
  }
}
Значение Описание
Идентификатор_вызова Пользовательский идентификатор, заданный пользователем при запросе
Результат Возвращаемые значения вызванной функцией
Выходные параметры Выходные параметры каждого вызова функции

Запрос:

{
  "transaction":"19Cnd23",
  "request":{
    "target":"Service.ServerApi",
    "method":"GetIdByTagName",
    "input":{
      "tagname":"NPS.MNS1.PT001_1.Value"
    }
  }
}

Ответ:

{
  "transaction": "19Cnd23",
  "result":{
    "return":457
  }
}

Вызов функций API сервера

Вызов функций API сервера осуществляется Модулем вычислений, а модуль OPC DA Server предоставляет возможность вызова функций посредством подключенного OPC DA-клиента. Модуль вычислений динамически создаёт узел Service.ServerApi, представляющий API сервера, а модуль OPC DA Server создаёт динамический сигнал Service.InvokeFromJSON типа string.

Для получения необходимой информации о конфигурации сервера необходимо подключиться к серверу с помощью OPC DA клиента и в значение сигнала Service.InvokeFromJSON записать запрос в формате JSON, который вызывает соответствующую функцию Service.ServerApi.

Запрос в формате JSON прописывается в значение сигнала в одну строку, например:

{"transaction":"19Cnd23","request":{"target":"Service.ServerApi","method":"GetIdByTagName", "input":{"tagname":"Signals.Object.int8"}}}

При записи запроса в сигнал Service.InvokeFromJSON происходит вызов соответствующей функции, после выполнения которой ответ в формате JSON записывается в тот же сигнал.

Примеры запросов

Сигнальная модель:

  • Запрос на получение значения идентификатора сигнала NPS.MNS1.PT001_1.Value:

    {"transaction":"json_1","request":{"target":"Service.ServerApi","method":"GetIdByTagName","input":{"tagname":"NPS.MNS1.PT001_1.Value"}}}
  • Ответ на запрос содержит значение идентификатор сигнала 457:

    {"transaction":"json_1","result":{"return":457}}
  • Запрос на получение полного имени сигнала по идентификатору 457:

    {"transaction":"json_2","request":{"target":"Service.ServerApi","method":"GetTagNameById","input":{"nodeid":457}}}
  • Ответ на запрос содержит полное имя сигнала NPS.MNS1.PT001_1.Value:

    {"transaction":"json_2","result":{"return":"NPS.MNS1.PT001_1.Value"}}
  • Запрос на получение короткого имени сигнала по идентификатору 457:

    {"transaction":"json_3","request":{"target":"Service.ServerApi","method":"GetShortNameById","input":{"nodeid":457}}}
  • Ответ на запрос содержит короткое имя сигнала Value:

    {"transaction":"json_3","result":{"return":"Value"}}
  • Запрос на получение описания сигнала с идентификатором 457 по идентификатору свойства (101 (Description)):

    {"transaction":"json_4","request":{"target":"Service.ServerApi","method":"ReadProperty","input":{"nodeid":457,"propid":101}}}
  • Ответ на запрос содержит описание сигнала:

    {"transaction":"json_4","result":{"return":"Давление ДТ на приёме МНС (т.1). Текущее значение"}}
  • Запрос на получение массива информации о сигнале с идентификатором 457 по идентификаторам свойств: ведение истории (9001 (Historizing)), описание (101 (Description)), единицы измерения (100 (EUnit)):

    {"transaction":"json_5","request":{"target":"Service.ServerApi","method":"ReadProperty","input":{"nodeid":457,"propname":[9001,101,100]}}}
  • Ответ на запрос содержит значения всех запрошенных свойств:

    {"transaction":"json_5","result":{"return":[true,"Давление ДТ на приёме МНС (т.1). Текущее значение","МПа"]}}
  • Запрос на получение описания сигнала с идентификатором 457 по названию свойства (101 (Description)):

    {"transaction":"json_6","request":{"target":"Service.ServerApi","method":"ReadProperty","input":{"nodeid":457,"propname":"Description"}}}
  • Ответ на запрос содержит описание сигнала:

    {"transaction":"json_6","result":{"return":"Давление ДТ на приёме МНС (т.1). Текущее значение"}}
  • Запрос на получение массива информации о сигнале с идентификатором 457 по именам свойств: ведение истории (9001 (Historizing)), описание (101 (Description)), единицы измерения (100 (EUnit)):

    {"transaction":"json_7","request":{"target":"Service.ServerApi","method":"ReadProperty","input":{"nodeid":457,"propid":[Historizing,Description,EUnit]}}}
  • Ответ на запрос содержит значения всех запрошенных свойств:

    {"transaction":"json_7","result":{"return":[true,"Давление ДТ на приёме МНС (т.1). Текущее значение","МПа"]}}

Объектная модель:

  • Запрос на получение идентификатора родительского объекта для дочернего объекта с идентификатором 103:

    {"transaction":"json_8","request":{"target":"Service.ServerApi","method":"GetParentObjectId","input":{"nodeid":103}}}
  • Ответ на запрос содержит идентификатор родительского объекта:

    {"transaction":"json_8","result":{"return":101}}
  • Запрос на получение идентификаторов всех ссылок на узел с идентификатором 103:

    {"transaction":"json_9","request":{"target":"Service.ServerApi","method":"FindAllReferences","input":{"nodeid":103}}}
  • Ответ на запрос содержит идентификаторы ссылок на узел:

    {"transaction":"json_9","result":{"return":"[57,115,124]"}}