Описание способов интеграции

Платформа SEMNEXT предоставляет несколько вариантов взаимодействия с внешними системами:

  1. REST API - набор сервисов, которые поддерживают практически все операции с системой. REST API удобно использовать для разработки web и мобильных приложений;
  2. JMS очереди с данными по измерениям и нотификациям. Доступ к JMS очередям осуществляется с помощью программных компонент внешних систем. Этот способ интеграции используется при встраивании платформы во внешнюю программную инфраструктуру, либо взаимодействии внешних серверных компонент. В частности, модули интеграции от SEMNEXT используют именно этот способ получения данных для передачи их внешним системам.
  3. MQTT топики по протоколу IoT (выход протокола oneM2M в 4Q18).
  4. внешние программные модули, устанавливаемые на контроллер. Платформа позволяет любым внешним программам, которые поддерживают информационный протокол на уровне контроллера, осуществлять двухсторонний обмен с платформой.

Полное описание REST API представлено на портале SWAGGERHUB. На портале наберите в поиске INSPARK Или SEM-NEXT, вы найдете описание RESTAPI Inspark IoT Platform .
Ниже дано дано краткое руководство по основным группам сервисов и порядок их применения.

Название группы сервисов Пояснения
Сервисы авторизации и аутентификации
(Authentification)
Группа сервисов, которая определяет методы взода/выходы и восстановления пароля. С сервиса /auth/login начинается работа со всеми основными сервисами. При успешном входе учетная запись определяет права пользователя на проведение операций в системе, а также видимость объектов
ObjRubricFacadeREST
ObjectFacadeREST
Сервисы, позволяющие управлять рубриками и объектами: функции создания, чтения, изменения, удаления
ControllerFacadeRest Сервисы, позволяющие управлять контроллерами. Контроллеры имеют связь с объектами, поэтому если учетной записи пользователя доступны объекты, будут доступны и контроллеры объекта
ContrDeviceParamFacadeREST
ContrCalcParamFacadeREST
Сервисы, позволяющие получать измеряемые и вычисляемые параметры. Сервисы предоставляют все параметры по объекту и по контроллеру
SetValueLogFacadeREST Сервисы для установки значений параметров
ObjectRuleActionREST
ObjectScheduleActionFacadeREST
Сервисы для управления расписаниями и правилами объекта
TypicalConfigFasadeRest
ScheduleFacadeREST
RuleFacadeREST
Сервисы для управления типовой конфигурации
DeviceFacadeREST
ChannelFacadeREST
Сервисы для управления устройствами
ControlProcedureFacadeREST Сервисы для управления процедурами контроля
IconSet
Icon
Сервисы для управления наборами иконок и иконками для виджетов
Wg*FacadeREST
WidGet
DashboardFacadeREST
Сервисы для работы с виджетами и дашбордами

Если необходимо выполнить интеграцию с внешними системами (например, СКУД, системы видеонаблюдения, и т.д.), с высокими требованиями по скорости обработки и масштабирования, платформа SEMNEXT предоставляет возможность обмена данными по шине JMS.

На рисунке представлена общая схема, форматы данных в очередях описаны в таблицах ниже.

Формат данных очереди EventExport

Тип MapMessage
Описание сообщения о событиях, которые могут быть переданы внешним системам
Передаваемые
параметры
EventTime - время наступления события
EventId - идентификатор типа события
ControllerId – идентификатор контроллера
DeviceParamId – идентификатор измеряемого параметра
CalcParamId – идентификатор вычисляемого параметра
Value – значение параметра (может отсутствовать)


Формат данных очереди ParamChange

Тип MapMessage
Описание сообщения об изменении значений измеряемых и вычисляемых параметров
Передаваемые
параметры
ControllerId – идентификатор контроллера
DeviceParamId – идентификатор измеряемого параметра
CalcParamId – идентификатор вычисляемого параметра
Value – значение параметра
ValueDate - время изменения значения параметра


Формат данных очереди EventImport

Тип MapMessage
Описание очередь внешних событий (сообщения о событиях, поступившие из внешних систем)
Передаваемые
параметры
MsgTime - время поступления сообщения
ControllerId – идентификатор контроллера
EventId - идентификатор типа события
Msg - текст сообщения

Интеграция на уровне контроллера предполагает установку на контроллер пакета ПО контроллера SEMNEXT. Для подключения к платформе аппаратно-программных контроллеров на открытых ОС необходимо соблюсти следующие условия/требования: