Просмотр кода страницы Xiot-plc-message-system-development-plan

{{DISPLAYTITLE:План доработки системы сообщений XIOT-PLC}}
__TOC__

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

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

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

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

=Исправленные типы системных сообщений=

{| class="wikitable sortable" style="width:100%"
! Сообщение !! Было !! Стало !! Получатель
|-
| Служба приложения не запущена: адрес уже используется || Предупреждения || Ошибки в работе || Интегратор
|-
| Веб-интерфейс не запущен: адрес уже используется || Предупреждения || Ошибки в работе || Интегратор
|-
| Служба управления не запущена: адрес уже используется || Предупреждения || Ошибки в работе || Интегратор
|-
| Служба управления недоступна || Предупреждения || Ошибки в работе || Интегратор
|-
| Служба авторизации не запущена: адрес уже используется || Предупреждения || Ошибки в работе || Интегратор
|}

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

{| class="wikitable sortable" style="width:100%"
! № !! Драйвер или интеграция !! Добавить или уточнить сообщения !! Типы сообщений !! Приоритет
|-
| 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 || Основной и резервный интернет || Основной канал потерян; резервный канал включён; основной канал восстановлен || События; Ошибки в работе || Высокий
|}

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

{| class="wikitable sortable" style="width:100%"
! № !! Раздел !! Добавить или уточнить сообщения !! Типы сообщений !! Приоритет и состояние
|-
| 29 || Обновление XIOT || Обновление начато; пакет проверен; обновление установлено; применено; не выполнено || События; Отладка; Ошибки в работе || Высокий
|-
| 30 || Приложение проекта || Обновление начато; приложение обновлено; обновление отменено; приложение не обновлено || События; Ошибки в работе || Высокий
|-
| 31 || Журнал || Хранилище почти заполнено; место освобождено; запись недоступна; запись восстановлена || События; Ошибки в работе; Критические ошибки || Высокий
|-
| 32 || История измерений || История недоступна; история восстановлена || Ошибки в работе; События || Высокий
|-
| 33 || Системное время || Часовой пояс изменён; системное время скорректировано; изменение часового пояса отклонено; синхронизация времени недоступна || События; Ошибки в работе || Средний
|-
| 34 || Сетевое подключение || Основное подключение изменено; интернет недоступен; интернет восстановлен || События; Ошибки в работе || Высокий
|-
| 35 || Сводки устройств и сценариев || Комната — средние, минимальные и максимальные показатели; тёплый пол — время нагрева и неисправности; антиобледенение — время работы и ошибок; реле давления воды — давление, работа реле и подтверждения команд; энергоменеджмент — ежедневное или ежемесячное потребление; для «Циркадных ритмов» сводку не формировать || Сводки || Средний; реализовано
|}

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

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

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

{| class="wikitable"
! Таблица !! Содержание
|-
| [[Система сообщений XIOT-PLC — полная карта]] || Количество существующих сообщений по устройствам, сценариям и типам
|-
| [[Система сообщений XIOT-PLC — каталог шаблонов]] || Полные тексты существующих сообщений
|-
| [[Системные события в журнале XIOT-PLC]] || Полные тексты предлагаемых системных сообщений
|}

[[Category:XIOT-PLC]][[Category:Сообщения]][[Category:Планы доработок]]