События и уведомления
Справочник событий
Формат событий платформы определяется 4-мя цифрами и имеет следующую структуру:
TNNN
где
T - код типа события; NNN - код события.
Перечень возможных типов событий приведен в следующей таблице:
Код | Тип события | Инициатор |
---|---|---|
1 | Системные события, инициируемые контроллером | Контроллер |
2 | Системные события, инициируемые сервером | Серверы |
3 | Результаты выполнения команд, выданных контроллеру | Контроллер |
4 | События, связанные с изменением значений некоторых параметров | Контроллер |
5 | События, связанные с изменением состояния контролируемого объекта. Эти события пользователи могут формировать самостоятельно | Контроллер Серверы |
События с типом 1-4 записываются в административные журналы. События с типом 5XXX записываются в журнал событий.
В платформе SEM NEXT пользователь использует события с 5XXX кодом для:
1. Определение событий, которые должны сформироваться как результат работы Контрольной процедуры. Эти события инициируются серверными компонентами платформы
2. Определение событий, которые должны сформироваться в результате отработки Правил. Эти события формируются контроллером.
В разделе Таблица справочника событий приведены все события с кодом 1-4. Для формирования пользовательских событий справочник доступен в меню в разделе Система→Справочник событий.
Ниже описаны атрибуты формы создания/редактирования события:
Имя параметра | Описание |
---|---|
ID | Код события, формируется автоматически платформой. Код не доступен для изменения пользователем |
Имя | Имя события(произвольный текст) |
Тип доп.инфо | Значение от 0 до 3. Описание типов доп. информации приведено ниже |
Признак уведомления | True - сообщение доступно для уведомлений, False - уведомления не создаются |
Экспорт | True - событие будет записываться в специальную экспортную очередь, для использования внешними программами. Этот признак используется для интеграций событий платформы с внешними программами |
Время жизни уведомления (мин) | Время в минутах, отведенное для успешной попытки отправки уведомлений. Платформа будет пытаться отправить уведомление подписчику в течении установленного времени жизни |
Описание | Формат события. В формате используются теги подстановки, описание тегов приведено ниже |
Срочно | Срочность формирования события. Поле не доступно для изменения пользователем, значение всегда равно 0 |
Статус | Статус события, выбирается из списка статусов |
Журнал | Название журнала события. Поле не доступно для изменения пользователем |
Обычно, при описании событий 5XXX используется значение 3.Возможные типы дополнительной информации приведены в следующей таблице:
Тип | Описание | Формат |
---|---|---|
0 | Нет дополнительной информации или она игнорируется. В теле события будет пусто | |
1 | Произвольное значение или текст | Текстовая строка события, без изменений |
2 | Формат идентификатора параметра | В сообщении используется формат <IdParameter>;<TypeParameter>, либо <IdParameter> |
3 | Формат идентификатор и значение параметра | В сообщении используется формат <IdParameter>=<ValueParameter>;<TypeParameter>, либо <IdParameter>=<ValueParameter> |
Шаблон сообщения о событии может содержать теги подстановок, которые при обработке должны быть заменены на реальные значения. Каждый тег в шаблоне записывается в виде %<имя тега>%. Перечень разрешенных тегов и порядок их обработки приведены в разделе Таблица тегов подстановки.
Уведомления
В текущей версии платформа SEM NEXT предоставляет возможность пользователям подписаться на получение событий по E-mail и по каналу Telegram.
Платформа соблюдает следующие правила работы уведомлений:
- Событие, предназначенное для отправки отправляется по всем каналам пользователя.
- Не доставленное событие по какому-либо каналу доставки, платформа будет отправлять несколько раз, пока не истекет времени жизни события.
- Выбранные события будут формироваться по результатам работы Контрольных процедур и Правил.
- Пользователь получает события по всем объектам, которые ему доступны. В текущей версии нельзя выбрать для уведомлений конкретный объект или параметр.
Настройка каналов уведомления
Для того, чтобы оформить подписку, создайте канал уведомлений. Для этого, в настройках пользователя выберите соответствующий пункт в меню.
Определите параметры канала:
Пользователь может зарегистрировать несколько e-mail адресов, но только один канал подписки в Telegram.
Для регистрации канала e-mail введите свой e-mail адрес.
Для регистрации канала Telegram порядок действий следующий:
- в Telegram найдите и кликните бот InsparkSemNext;
- Кликните на приглашение /start, в окне бота появится приветствие :
Вас приветствует служба уведомлений Semona! Для подтверждения учетной записи, отправьте в сообщении проверочный код, полученный вами в ЛК. Welcome to Semona notification service! Please send verification code in next message to confirm the account.
- Зайдите в ваш профиль, в поле верификации будет записан код верификации от Telegram;
- Введите данный код в поле сообщений бота InsparkSemNext;
- Бот должен ответить вам сообщением о подключении вас к каналу
Ваша учетная запись подтверждена. Теперь вы сможете получать уведомления, согласно ваших настроек ЛК. Account verified. Now you will receive notifications according your settings.
Подписка на события
Для выбора событий, по которым пользователю будут приходить события, пользователь должен в Настройках учетной записи выбрать соответствующий пункт меню (events, см. рисунок в предыдущей главе). Отметить нужные типы события и сохранить выбор.
Таблица справочника событий
Собственно справочник административных событий представлен в следующей таблице. В нем для каждого события приведены следующие данные:
- идентификатор события (Ид);
- уровень критичности события (К);
- обозначение события (Обозначение);
- описание события (Описание);
- характер дополнительной информации о событии (Доп. инф.).
Для уровней критичности событий используются следующие символы:
«I» - информационное сообщение,
«W» - предупреждение,
«X» - исключительная ситуация (ошибка),
«А» - авария.
Ид | К | Обозначение | Описание | Доп. инф. |
---|---|---|---|---|
1000 | I | Confirm the operability of the controller | Подтверждение работоспособности контроллера | |
1001 | I | Initialization of the Controller completed successfully | Начальная инициализация контроллера выполнена успешно | |
1002 | A | Error initialization of the Controller | Ошибка начальной инициализации контроллера | Событие остается в журнале контроллера |
1003 | A | Fatal error. Controller stopped | Фатальная ошибка ПО контроллера. Контроллер остановлен | Подробное описание ошибки |
1004 | A | Error connecting to MQTT | Ошибка подключения MQTT | Событие остается в журнале контроллера |
1005 | I | Configuration loaded successfully. Normal mode | Загружена основная конфигурация контроллера. Нормальный режим функционирования | Хэш-сумма файла конфигурации контроллера |
1006 | W | Backup configuration loaded successfully. Normal mode | Загружена резервная конфигурация контроллера. Нормальный режим функционирования | |
1007 | X | Configuration is not valid. Standby mode | Контроллер не имеет валидной конфигурации. | Режим ожидания |
1008 | X | No configuration. Standby mode | Отсутствует конфигурационный файл контроллера. | Режим ожидания |
1009 | W | Channel errors | Канал устройства работает со сбоями (ошибками) | Id параметра |
1010 | A | Channel failure | Канал устройства неисправен | Id параметра |
1102 | A | Error initialization of the Scheduler | Ошибка инициализации планировщика | Событие остается в журнале контроллера |
1103 | A | Fatal error. Scheduler stopped | Фатальная ошибка планировщика | Подробное описание ошибки |
1105 | I | Schedule loaded successfully | Расписание загружено | Хэш-сумма файла расписания |
1106 | W | Backup Schedule loaded successfully. | Загружена предыдущая версия расписания из резервной копии | |
1107 | X | Schedule is not valid | Расписание невалидно | |
1108 | X | No Schedule | Расписание отсутствует | |
2000 | W | The controller is moved to the inoperable state | Контроллер перешел в неработоспособное состояние | |
2001 | W | Error Measure format | Ошибка формата сообщения со значением измеряемого параметра | Id параметра |
2002 | W | Error Signal format | Ошибка формата сообщения со значением сигнального параметра | Id параметра |
2003 | W | Error Event format | Ошибка формата сообщения о событии | Id события |
2004 | A | Error InitRequest format | Ошибка формата сообщения с запросом подключения | SN контроллера |
2005 | I | Controller Init Request | ||
2006 | X | Controller parameter is absent | Отсутствует (не определен) параметр контроллера | Id параметра |
2007 | X | Event type is absent | Отсутствует событие с заданным идентификатором | Id события |
2008 | X | Controller is absent | Отсутствует контроллер с заданным идентификатором | Id контроллера |
2009 | W | Invalid command | Неверная команда | Код команды |
2010 | W | The parameter change is prohibited due to the failure of the sensor | Изменение параметра запрещено из-за отказа датчика | Код команды |
2011 | W | Manual parameter change is prohibited | Ручное изменение параметра запрещено | Код команды |
2012 | W | Parameter is locked | Параметр заблокирован | Код команды |
2013 | W | Invalid parameter value | ||
2014 | W | No controller with the specified serial number | Отсутствует контроллер с заданным серийным номером | Серийный номер |
3010 | I | The command completed successfully | Выданная контроллеру команда выполнена успешно | |
3011 | X | The command is not passed to the controller | Команда не передана контроллеру | Id команды |
3012 | X | Error command format | Ошибка формата команды Id команды | |
3013 | X | Can’t restart controller | Ошибка при выполнении команды рестарта контроллера | Id команды |
3020 | I | The value of the parameter has been set | Значение для параметра установлено | Id команды |
3021 | X | The value of the parameter is not passed to the controller | Значение параметра не передано контроллеру | Id команды |
3022 | X | The parameter is not found | Параметр не найден | Id команды |
4001 | I | Changed parameter value | Изменилось значение параметра | Id параметра Значение параметра |
4002 | I | Changed TCP/IP GPRS | Обновление системного параметра (адрес TCP/IP GPRS) | IP GPRS адрес |
4003 | I | Changed TCP/IP Ethernet | Обновление системного параметра (адрес TCP/IP Ethernet) | IP ETHERNET адрес |
4004 | I | Changed TCP/IP WiFi | Обновление системного параметра (адрес TCP/IP WiFi) | IP WIFI адрес |
4005 | I | The Schedule changed parameter | Изменено значение параметра по расписанию | Id параметра |
4006 | I | The Schedule changed parameter by Rule | Изменено значение параметра в связи с применением правила | Id параметра Id правила |
4101…4999 | I | События нотификации, назначенные на отдельные параметры | Значение параметра |
Таблица тегов подстановки
Тег | Описание | Типы доп. инфо | Использование в Журнале событий |
---|---|---|---|
CAT_NAME | Категория параметра (ед. измерения) | 2-3 | - |
CHANNEL_NAME | Наименование канала датчика для измерения параметра | 2-3 | - |
CHANNEL_STATE | Состояние канала устройства, связанного с параметром | 2-3 | - |
CONFIG_STATE | Статус файла конфигурации контроллера | 0-3 | - |
CONTR_SERIALNUM | Серийный номер контроллера | 0-3 | + |
CONTR_STATE | Статус контроллера | 0-3 | - |
CONTR_HEALTH_TIME | Время последнего подтверждения работоспособности контроллера | 0-3 | - |
DEVICE_NAME | Наименование датчика для измерения параметра | 2-3 | - |
DEVICE_PORT | Порт подключения датчика для измерения параметра | 2-3 | - |
EVENT_TIME | Время наступления события | 0-3 | + |
EVENT_NAME | Наименование события | 0-3 | + |
EXT_INFO | Дополнительная информация (отформатированное сообщение) | 1 | + |
OBJECT_NAME | Краткое наименование объекта | 0-3 | + |
OBJECT_FULL_NAME | Полное наименование объекта | 0-3 | + |
OBJECT_ADDRESS | Полное наименование объекта | 2-3 | + |
OBJECT_STATE | Статус объекта | 0-3 | - |
PARAM_NAME | Наименование измеряемого параметра | 2-3 | + |
PARAM_TYPE | Тип значения параметра | 2-3 | - |
PARAM_STATE | Состояние параметра | 2-3 | - |
PARAM_VALUE | Текущее значение параметра | 3 | + |
PARAM_HUMAN_ VALUE | Отображаемое значение параметра | 2-3 | + |
PARAM_TIME | Время последнего изменения параметра | 2-3 | - |
SCHED_LOCK | Признак блокировки выполнения расписания на контроллере | 0-3 | - |
SCHED_STATE | Статус файла расписания | 0-3 | - |
SCHED_NAME | Наименование расписания, установленного на контроллере | 0-3 | - |
ZONE | Зона параметра | 2-3 | + |