Перейти к содержанию

Xiot-plc-message-system-development-plan: различия между версиями

Материал из XIOT Wiki
Оставлены только таблицы сообщений; уточнена отправка в мессенджеры
Разделены пользовательские и интеграторские типы сообщений
Строка 5: Строка 5:


{| class="wikitable sortable"
{| class="wikitable sortable"
! Тип сообщения !! Записывается в журнал !! Отправляется в мессенджеры
! Тип сообщения !! Раздел в редакторе !! Записывается в журнал !! Отправляется пользователю в мессенджеры
|-
|-
| Отладка || Нет || Нет
| Отладка || Интегратор || Нет || Нет
|-
|-
| События || Да || Нет
| События || Диагностика || Да || Нет
|-
|-
| Сводки || Да || Нет
| Сводки || Сводки || Да || Нет
|-
|-
| Информация || Да || Да
| Информация || Пользователь || Да || Да
|-
|-
| Предупреждения || Да || Да
| Предупреждения || Пользователь || Да || Да
|-
|-
| Тревоги || Да || Да
| Тревоги || Пользователь || Да || Да
|-
|-
| Ошибки в работе || Да || Нет
| Ошибки в работе || Интегратор || Да || Нет
|-
|-
| Критические ошибки || Да || Нет
| Критические ошибки || Интегратор || Да || Нет
|}
|}


Строка 29: Строка 29:
! № !! Раздел !! Добавить или уточнить сообщения !! Типы сообщений !! Приоритет
! № !! Раздел !! Добавить или уточнить сообщения !! Типы сообщений !! Приоритет
|-
|-
| 1 || Контроллер || Запущен; запущен частично; запрошен перезапуск; остановлен; предыдущая работа завершилась аварийно; работа восстановлена || Информация; События; Предупреждения || Критический
| 1 || Контроллер || Запущен; запущен частично; не запущен; запрошен перезапуск; остановлен; предыдущая работа завершилась аварийно; повторные аварийные перезапуски; работа восстановлена || События; Ошибки в работе; Критические ошибки || Критический
|-
|-
| 2 || Конфигурация проекта || Загрузка начата; конфигурация принята; применена; не изменилась; загрузка прервана; отклонена; не применена || События; Информация; Предупреждения; Ошибки в работе; Критические ошибки || Критический
| 2 || Конфигурация проекта || Загрузка начата; конфигурация принята; применена; не изменилась; загрузка прервана; отклонена; новая конфигурация не применена; рабочая конфигурация отсутствует || События; Ошибки в работе; Критические ошибки || Критический
|-
|-
| 3 || Устройства в конфигурации || Устройство добавлено; изменено; удалено; изменение не выполнено || Информация; События; Ошибки в работе || Критический
| 3 || Устройства в конфигурации || Устройство добавлено; изменено; удалено; изменение не выполнено || События; Ошибки в работе || Критический
|-
|-
| 4 || Сценарии в конфигурации || Сценарий добавлен; изменён; удалён; изменение не выполнено || Информация; События; Ошибки в работе || Критический
| 4 || Сценарии в конфигурации || Сценарий добавлен; изменён; удалён; изменение не выполнено || События; Ошибки в работе || Критический
|-
|-
| 5 || Облако контроллера || Контроллер подключён; связь потеряна; связь восстановлена; подключение выключено; подключение отклонено || События; Предупреждения; Информация; Ошибки в работе || Критический
| 5 || Облако контроллера || Контроллер подключён; связь потеряна; связь восстановлена; подключение выключено; подключение отклонено || События; Ошибки в работе || Критический
|-
|-
| 6 || Авторизация облака || Авторизация утрачена; восстановлена; сброшена; отклонена || Предупреждения; Информация; События; Ошибки в работе || Критический
| 6 || Авторизация облака || Авторизация утрачена; восстановлена; сброшена; отклонена || События; Ошибки в работе || Критический
|-
|-
| 7 || Панели || Новая панель; панель подключена; отключена; восстановлена; перенесена; удалена; приложение панели обновлено || Информация; События; Предупреждения || Критический
| 7 || Панели || Новая панель; панель подключена; отключена; восстановлена; перенесена; удалена; приложение панели обновлено || События; Ошибки в работе || Критический
|-
|-
| 8 || Каналы связи панели || Локальная связь потеряна и восстановлена; облачная связь потеряна и восстановлена || Предупреждения; Информация || Высокий
| 8 || Каналы связи панели || Локальная связь потеряна и восстановлена; облачная связь потеряна и восстановлена || События; Ошибки в работе || Высокий
|-
|-
| 9 || Все драйверы || Запущен; выключен; подключён; недоступен; восстановлен; ошибка настройки || События; Предупреждения; Информация; Ошибки в работе || Критический
| 9 || Все драйверы || Запущен; выключен; подключён; недоступен; восстановлен; ошибка настройки || События; Ошибки в работе; Критические ошибки для обязательной защиты || Критический
|-
|-
| 10 || Физические устройства || Обнаружено; подключено; недоступно; восстановлено; удалено || Информация; Предупреждения || Критический
| 10 || Физические устройства || Обнаружено; подключено; недоступно; восстановлено; удалено || События; Ошибки в работе || Критический
|-
|-
| 11 || Каналы устройств || Канал не работает; канал восстановлен || Ошибки в работе; Информация || Высокий
| 11 || Каналы устройств || Канал не работает; канал восстановлен || Ошибки в работе; События || Высокий
|-
|-
| 12 || Команды устройств || Команда отправлена; подтверждена; не подтверждена; аварийная команда не подтверждена || События; Ошибки в работе; Критические ошибки || Критический
| 12 || Команды устройств || Команда отправлена; подтверждена; не подтверждена; аварийная команда не подтверждена || События; Ошибки в работе; Критические ошибки || Критический
|-
|-
| 13 || Сценарии || Запущен; завершён; пропущен; остановлен; завершён с ошибкой || События; Информация; Предупреждения; Ошибки в работе || Критический
| 13 || Сценарии || Запущен; завершён; пропущен; остановлен; завершён с ошибкой || События; Ошибки в работе || Критический
|-
|-
| 14 || Инциденты || Открыт; усилен до тревоги; закрыт; повторился || Предупреждения; Тревоги; Информация; События || Критический
| 14 || Пользовательские состояния || Понятное предупреждение о недоступной функции; сообщение об опасности; сообщение о восстановлении || Предупреждения; Тревоги; Информация || Критический
|}
 
=Текущие сообщения, требующие смены типа=
 
{| class="wikitable sortable" style="width:100%"
! Текущее сообщение !! Сейчас !! Должно быть !! Получатель
|-
| Служба приложения не запущена: адрес уже используется || Предупреждения || Ошибки в работе || Интегратор
|-
| Веб-интерфейс не запущен: адрес уже используется || Предупреждения || Ошибки в работе || Интегратор
|-
| Служба управления не запущена: адрес уже используется || Предупреждения || Ошибки в работе || Интегратор
|-
| Служба управления недоступна || Предупреждения || Ошибки в работе || Интегратор
|-
| Служба авторизации не запущена: адрес уже используется || Предупреждения || Ошибки в работе || Интегратор
|}
|}


Строка 61: Строка 77:


{| class="wikitable sortable" style="width:100%"
{| class="wikitable sortable" style="width:100%"
! № !! Драйвер или интеграция !! Добавить или уточнить сообщения !! Приоритет
! № !! Драйвер или интеграция !! Добавить или уточнить сообщения !! Типы сообщений !! Приоритет
|-
|-
| 15 || Wiren Board || Линия подключена; линия недоступна; линия восстановлена; устройство недоступно; устройство восстановлено; ошибка канала устранена || Высокий
| 15 || Wiren Board || Линия подключена; линия недоступна; линия восстановлена; устройство недоступно; устройство восстановлено; ошибка канала устранена || События; Ошибки в работе || Высокий
|-
|-
| 16 || Modbus || Порт подключён; порт недоступен; порт занят; нет доступа; устройство недоступно; устройство восстановлено; ошибка настройки канала || Высокий
| 16 || Modbus || Порт подключён; порт недоступен; порт занят; нет доступа; устройство недоступно; устройство восстановлено; ошибка настройки канала || События; Ошибки в работе || Высокий
|-
|-
| 17 || Zigbee2MQTT || Мост подключён; мост недоступен; добавление разрешено; устройство обнаружено; подключено; удалено; недоступно; восстановлено || Высокий
| 17 || Zigbee2MQTT || Мост подключён; мост недоступен; добавление разрешено; устройство обнаружено; подключено; удалено; недоступно; восстановлено || События; Ошибки в работе || Высокий
|-
|-
| 18 || Внешние MQTT-подключения || Подключено; авторизация отклонена; связь потеряна; восстановлена; команда не доставлена; доставка восстановлена || Высокий
| 18 || Внешние MQTT-подключения || Подключено; авторизация отклонена; связь потеряна; восстановлена; команда не доставлена; доставка восстановлена || События; Ошибки в работе || Высокий
|-
|-
| 19 || Пользовательский MQTT-брокер || Служба запущена; недоступна; клиент подключён; клиент отключён; клиент восстановил связь || Высокий
| 19 || Пользовательский MQTT-брокер || Служба запущена; недоступна; клиент подключён; клиент отключён; клиент восстановил связь || События; Ошибки в работе || Высокий
|-
|-
| 20 || REST и TCP || Подключено; связь потеряна; восстановлена; неверная настройка; команда не выполнена; выполнение восстановлено || Высокий
| 20 || REST и TCP || Подключено; связь потеряна; восстановлена; неверная настройка; команда не выполнена; выполнение восстановлено || События; Ошибки в работе || Высокий
|-
|-
| 21 || DMX || Выход подключён; выход недоступен; передача восстановлена || Средний
| 21 || DMX || Выход подключён; выход недоступен; передача восстановлена || События; Ошибки в работе || Средний
|-
|-
| 22 || HomeKit || Мост запущен; остановлен; запуск не выполнен; сопряжение добавлено; сопряжение сброшено; конфигурация обновлена || Средний
| 22 || HomeKit || Мост запущен; остановлен; запуск не выполнен; сопряжение добавлено; сопряжение сброшено; конфигурация обновлена || События; Ошибки в работе || Средний
|-
|-
| 23 || Яндекс Алиса || Авторизация утрачена; восстановлена; доставка задержана; восстановлена; событие отклонено || Средний
| 23 || Яндекс Алиса || Авторизация утрачена; восстановлена; доставка задержана; восстановлена; событие отклонено || События; Ошибки в работе || Средний
|-
|-
| 24 || Russound || Подключено; связь потеряна; восстановлена; ошибка обмена || Средний
| 24 || Russound || Подключено; связь потеряна; восстановлена; ошибка обмена || События; Ошибки в работе || Средний
|-
|-
| 25 || 1-Wire || Датчик добавлен; удалён; недоступен; восстановлен || Средний
| 25 || 1-Wire || Датчик добавлен; удалён; недоступен; восстановлен || События; Ошибки в работе || Средний
|-
|-
| 26 || Global Caché || Подключено; связь потеряна; восстановлена; команда не доставлена || Средний
| 26 || Global Caché || Подключено; связь потеряна; восстановлена; команда не доставлена || События; Ошибки в работе || Средний
|-
|-
| 27 || Погода и интернет-медиа || Данные устарели; источник недоступен; получение данных восстановлено || Средний
| 27 || Погода и интернет-медиа || Данные устарели; источник недоступен; получение данных восстановлено || События; Ошибки в работе || Средний
|-
|-
| 28 || Основной и резервный интернет || Основной канал потерян; резервный канал включён; основной канал восстановлен || Высокий
| 28 || Основной и резервный интернет || Основной канал потерян; резервный канал включён; основной канал восстановлен || События; Ошибки в работе || Высокий
|}
|}


Строка 97: Строка 113:
! № !! Раздел !! Добавить или уточнить сообщения !! Типы сообщений !! Приоритет
! № !! Раздел !! Добавить или уточнить сообщения !! Типы сообщений !! Приоритет
|-
|-
| 29 || Обновление XIOT || Обновление начато; пакет проверен; обновление установлено; применено; не выполнено || Информация; Отладка; Ошибки в работе || Высокий
| 29 || Обновление XIOT || Обновление начато; пакет проверен; обновление установлено; применено; не выполнено || События; Отладка; Ошибки в работе || Высокий
|-
|-
| 30 || Приложение проекта || Обновление начато; приложение обновлено; обновление отменено; приложение не обновлено || Информация; События; Ошибки в работе || Высокий
| 30 || Приложение проекта || Обновление начато; приложение обновлено; обновление отменено; приложение не обновлено || События; Ошибки в работе || Высокий
|-
|-
| 31 || Журнал || Хранилище почти заполнено; место освобождено; запись недоступна; запись восстановлена || Предупреждения; Информация; Ошибки в работе || Высокий
| 31 || Журнал || Хранилище почти заполнено; место освобождено; запись недоступна; запись восстановлена || События; Ошибки в работе; Критические ошибки || Высокий
|-
|-
| 32 || История измерений || История недоступна; история восстановлена || Ошибки в работе; Информация || Высокий
| 32 || История измерений || История недоступна; история восстановлена || Ошибки в работе; События || Высокий
|-
|-
| 33 || Системное время || Часовой пояс изменён; изменение отклонено; системное время существенно скорректировано || События; Ошибки в работе; Предупреждения || Средний
| 33 || Системное время || Часовой пояс изменён; системное время скорректировано; изменение часового пояса отклонено; синхронизация времени недоступна || События; Ошибки в работе || Средний
|-
|-
| 34 || Сетевое подключение || Основное подключение изменено; интернет недоступен; интернет восстановлен || События; Предупреждения; Информация || Высокий
| 34 || Сетевое подключение || Основное подключение изменено; интернет недоступен; интернет восстановлен || События; Ошибки в работе || Высокий
|-
|-
| 35 || Суточная сводка || Доступность облака, панелей, драйверов и устройств; число тревог и незавершённых инцидентов || Сводки || Средний
| 35 || Суточная сводка || Доступность облака, панелей, драйверов и устройств; число тревог и незавершённых инцидентов || Сводки || Средний
Строка 135: Строка 151:
| 44 || Не включать секретные данные и содержимое конфигурации в текст || Сообщения остаются безопасными для журнала и мессенджеров || Критический
| 44 || Не включать секретные данные и содержимое конфигурации в текст || Сообщения остаются безопасными для журнала и мессенджеров || Критический
|-
|-
| 45 || Отправлять в мессенджеры только «Информация», «Предупреждения» и «Тревоги» || «События», «Сводки», «Ошибки в работе», «Критические ошибки» и «Отладка» остаются только локальными || Критический
| 45 || Отправлять пользователю в мессенджеры только «Информация», «Предупреждения» и «Тревоги» || «События» остаются в диагностике, «Ошибки в работе» и «Критические ошибки» — в канале интегратора || Критический
|-
|-
| 46 || Исключить «Сводки» из отправки в мессенджеры || Периодические итоги не создают лишние уведомления || Критический
| 46 || Исключить «Сводки» из отправки в мессенджеры || Периодические итоги не создают лишние уведомления || Критический
|-
| 47 || Не использовать «Предупреждения» для технических ошибок контроллера || Технические ошибки попадают в раздел «Интегратор» и не отправляются пользователю || Критический
|-
| 48 || При влиянии технической ошибки на пользователя создавать отдельное пользовательское сообщение || Пользователь получает понятное последствие без адресов, кодов и технических причин; интегратор получает «Ошибки в работе» или «Критические ошибки» || Критический
|-
| 49 || Не преобразовывать «Ошибки в работе» и «Критические ошибки» в «Тревоги» || Технические ошибки остаются в разделе интегратора и не появляются у пользователя как опасность объекта || Критический
|}
|}



Версия от 18:13, 1 августа 2026

Правило отправки в мессенджеры

Тип сообщения Раздел в редакторе Записывается в журнал Отправляется пользователю в мессенджеры
Отладка Интегратор Нет Нет
События Диагностика Да Нет
Сводки Сводки Да Нет
Информация Пользователь Да Да
Предупреждения Пользователь Да Да
Тревоги Пользователь Да Да
Ошибки в работе Интегратор Да Нет
Критические ошибки Интегратор Да Нет

Первая очередь

№ Раздел Добавить или уточнить сообщения Типы сообщений Приоритет
1 Контроллер Запущен; запущен частично; не запущен; запрошен перезапуск; остановлен; предыдущая работа завершилась аварийно; повторные аварийные перезапуски; работа восстановлена События; Ошибки в работе; Критические ошибки Критический
2 Конфигурация проекта Загрузка начата; конфигурация принята; применена; не изменилась; загрузка прервана; отклонена; новая конфигурация не применена; рабочая конфигурация отсутствует События; Ошибки в работе; Критические ошибки Критический
3 Устройства в конфигурации Устройство добавлено; изменено; удалено; изменение не выполнено События; Ошибки в работе Критический
4 Сценарии в конфигурации Сценарий добавлен; изменён; удалён; изменение не выполнено События; Ошибки в работе Критический
5 Облако контроллера Контроллер подключён; связь потеряна; связь восстановлена; подключение выключено; подключение отклонено События; Ошибки в работе Критический
6 Авторизация облака Авторизация утрачена; восстановлена; сброшена; отклонена События; Ошибки в работе Критический
7 Панели Новая панель; панель подключена; отключена; восстановлена; перенесена; удалена; приложение панели обновлено События; Ошибки в работе Критический
8 Каналы связи панели Локальная связь потеряна и восстановлена; облачная связь потеряна и восстановлена События; Ошибки в работе Высокий
9 Все драйверы Запущен; выключен; подключён; недоступен; восстановлен; ошибка настройки События; Ошибки в работе; Критические ошибки для обязательной защиты Критический
10 Физические устройства Обнаружено; подключено; недоступно; восстановлено; удалено События; Ошибки в работе Критический
11 Каналы устройств Канал не работает; канал восстановлен Ошибки в работе; События Высокий
12 Команды устройств Команда отправлена; подтверждена; не подтверждена; аварийная команда не подтверждена События; Ошибки в работе; Критические ошибки Критический
13 Сценарии Запущен; завершён; пропущен; остановлен; завершён с ошибкой События; Ошибки в работе Критический
14 Пользовательские состояния Понятное предупреждение о недоступной функции; сообщение об опасности; сообщение о восстановлении Предупреждения; Тревоги; Информация Критический

Текущие сообщения, требующие смены типа

Текущее сообщение Сейчас Должно быть Получатель
Служба приложения не запущена: адрес уже используется Предупреждения Ошибки в работе Интегратор
Веб-интерфейс не запущен: адрес уже используется Предупреждения Ошибки в работе Интегратор
Служба управления не запущена: адрес уже используется Предупреждения Ошибки в работе Интегратор
Служба управления недоступна Предупреждения Ошибки в работе Интегратор
Служба авторизации не запущена: адрес уже используется Предупреждения Ошибки в работе Интегратор

Драйверы и интеграции

№ Драйвер или интеграция Добавить или уточнить сообщения Типы сообщений Приоритет
15 Wiren Board Линия подключена; линия недоступна; линия восстановлена; устройство недоступно; устройство восстановлено; ошибка канала устранена События; Ошибки в работе Высокий
16 Modbus Порт подключён; порт недоступен; порт занят; нет доступа; устройство недоступно; устройство восстановлено; ошибка настройки канала События; Ошибки в работе Высокий
17 Zigbee2MQTT Мост подключён; мост недоступен; добавление разрешено; устройство обнаружено; подключено; удалено; недоступно; восстановлено События; Ошибки в работе Высокий
18 Внешние MQTT-подключения Подключено; авторизация отклонена; связь потеряна; восстановлена; команда не доставлена; доставка восстановлена События; Ошибки в работе Высокий
19 Пользовательский MQTT-брокер Служба запущена; недоступна; клиент подключён; клиент отключён; клиент восстановил связь События; Ошибки в работе Высокий
20 REST и TCP Подключено; связь потеряна; восстановлена; неверная настройка; команда не выполнена; выполнение восстановлено События; Ошибки в работе Высокий
21 DMX Выход подключён; выход недоступен; передача восстановлена События; Ошибки в работе Средний
22 HomeKit Мост запущен; остановлен; запуск не выполнен; сопряжение добавлено; сопряжение сброшено; конфигурация обновлена События; Ошибки в работе Средний
23 Яндекс Алиса Авторизация утрачена; восстановлена; доставка задержана; восстановлена; событие отклонено События; Ошибки в работе Средний
24 Russound Подключено; связь потеряна; восстановлена; ошибка обмена События; Ошибки в работе Средний
25 1-Wire Датчик добавлен; удалён; недоступен; восстановлен События; Ошибки в работе Средний
26 Global Caché Подключено; связь потеряна; восстановлена; команда не доставлена События; Ошибки в работе Средний
27 Погода и интернет-медиа Данные устарели; источник недоступен; получение данных восстановлено События; Ошибки в работе Средний
28 Основной и резервный интернет Основной канал потерян; резервный канал включён; основной канал восстановлен События; Ошибки в работе Высокий

Обновления и состояние системы

№ Раздел Добавить или уточнить сообщения Типы сообщений Приоритет
29 Обновление XIOT Обновление начато; пакет проверен; обновление установлено; применено; не выполнено События; Отладка; Ошибки в работе Высокий
30 Приложение проекта Обновление начато; приложение обновлено; обновление отменено; приложение не обновлено События; Ошибки в работе Высокий
31 Журнал Хранилище почти заполнено; место освобождено; запись недоступна; запись восстановлена События; Ошибки в работе; Критические ошибки Высокий
32 История измерений История недоступна; история восстановлена Ошибки в работе; События Высокий
33 Системное время Часовой пояс изменён; системное время скорректировано; изменение часового пояса отклонено; синхронизация времени недоступна События; Ошибки в работе Средний
34 Сетевое подключение Основное подключение изменено; интернет недоступен; интернет восстановлен События; Ошибки в работе Высокий
35 Суточная сводка Доступность облака, панелей, драйверов и устройств; число тревог и незавершённых инцидентов Сводки Средний

Единые правила сообщений

№ Доработка Ожидаемый результат Приоритет
36 Для каждого отключения добавить парное восстановление В журнале видны начало, окончание и длительность проблемы Критический
37 Не создавать повтор одного и того же состояния Один период неисправности не превращается в поток одинаковых строк Критический
38 Не считать начальное неизвестное состояние отключением После запуска не появляются ложные предупреждения Критический
39 Краткие разрывы записывать только после подтверждения Журнал не заполняется кратковременными переключениями связи Критический
40 В тексте команды указывать инициатора и причину Понятно, кто и почему изменил состояние устройства Высокий
41 В итоговом сообщении указывать результат команды Видны отправка, подтверждение или отсутствие подтверждения Высокий
42 В сообщении восстановления указывать длительность Можно оценить продолжительность недоступности Высокий
43 При переименовании сохранять понятное имя объекта в старых сообщениях История остаётся однозначной после изменения конфигурации Высокий
44 Не включать секретные данные и содержимое конфигурации в текст Сообщения остаются безопасными для журнала и мессенджеров Критический
45 Отправлять пользователю в мессенджеры только «Информация», «Предупреждения» и «Тревоги» «События» остаются в диагностике, «Ошибки в работе» и «Критические ошибки» — в канале интегратора Критический
46 Исключить «Сводки» из отправки в мессенджеры Периодические итоги не создают лишние уведомления Критический
47 Не использовать «Предупреждения» для технических ошибок контроллера Технические ошибки попадают в раздел «Интегратор» и не отправляются пользователю Критический
48 При влиянии технической ошибки на пользователя создавать отдельное пользовательское сообщение Пользователь получает понятное последствие без адресов, кодов и технических причин; интегратор получает «Ошибки в работе» или «Критические ошибки» Критический
49 Не преобразовывать «Ошибки в работе» и «Критические ошибки» в «Тревоги» Технические ошибки остаются в разделе интегратора и не появляются у пользователя как опасность объекта Критический

Связанные таблицы

Таблица Содержание
Система сообщений XIOT-PLC — полная карта Количество существующих сообщений по устройствам, сценариям и типам
Система сообщений XIOT-PLC — каталог шаблонов Полные тексты существующих сообщений
Системные события в журнале XIOT-PLC Полные тексты предлагаемых системных сообщений