Написать нам

КВС-АйТи: Автоматизированный программный комплекс сбора и учета ресурсов

Описание

1. ОБЩИЕ СВЕДЕНИЯ
1.1. Обозначение и наименование программы
Наименование программного комплекса: «КВС-АйТи: Автоматизированный программный комплекс сбора и учета ресурсов» (АПКСУР) со счетчиков воды и тепла представляет собой комплексное решение, предназначенное для мониторинга и управления потреблением ресурсов в жилых и коммерческих зданиях.

1.2. Термины иопределения
Терминыи определения приведены в таблице ниже.

Термин

Определение

АПКСУР

Автоматизированный программный комплекс сбора и учета ресурсов

БД

Базаданных

ЦС

Центральный сервер

БС

Базовая станция

ПО

Программноеобеспечение


1.3. Языки программирования, на которых написана программа
Программный код написан на следующих языках программирования:
  • Javascript;
  • Python;

2. Решения поструктуре
Программный комплекс АПКСУР состоит из следующих модулей:
  • МодульПО:«Центральный сервер».
  • МодульПО:«Сервер Событий».
  • МодульПО:«Оповещения».

3. Роли пользователей
При эксплуатации программного комплекса следующие роли пользователей:
  • Пользователи (сотрудник управляющий копании или пр.);
  • Администраторсистемы;

4. Функциональное назначение
Представляет собой комплексное решение, предназначенное для мониторинга и управления потреблением ресурсов в жилых и коммерческих зданиях. Основные компоненты и функции этой системы включают:
  • мониторинг потребления: система предоставляет реальные данные о потреблении воды и тепла;
  • анализ данных: программное обеспечение анализирует данные для выявления трендов потребления и возможных утечек;
  • удаленное управление: позволяет администраторам настраивать параметры счетчиков и отслеживать их работу дистанционно;
  • отчетность: автоматическая генерация отчетов для пользователей;
  • оповещения: система может отправлять предупреждения об отсутствии показаний, необычных показаниях или потреблении;

4.1. Функции модуля «Центральный сервер»
Модуль ПО: «Центральный сервер» предназначен для:
  • управления устройствами.;
  • хранения показаний устройств.;
Модуль обеспечивает отказоустойчивое хранение данных и предоставляет интерфейсы для интеграции с дополнительными системами.

4.2. Функции модуля «Сервер Событий»
Модуль ПО: «Сервер Событий» предназначен для сбора, предварительной обработки
и отправки данных (показаний приборов и пр.) в БД.

Модуль состоит из:
  • Сетевой шлюз - используется для получения сообщений от БС;
  • Брокер сообщений - используется для трансляции данных между модулями;

4.3. Функции модуля «Оповещения»
Модуль ПО: «Оповещения» отвечает за отправку сообщений пользователям по настраиваемым триггерам, таким как (повышенный расход, протечка, прорыв, отсутствие показаний и пр.). Отправка осуществляется посредством эл. почты, мессенджеров (Telegram, Whatsapp) или иных средств.
Так же возможна отправка статистических данных, таких как – средний расход и пр.

5. Входные данные
Входной информацией для ПО являются показания приборов, запросы пользователей, данные БД., настройки компонентов программного комплекса.

6. Выходные данные
Выходными данными являются отчеты и аналитические данные, формируемые системой о потреблении.

7. Вызов и загрузка
Запуск программного комплекса осуществляется путем установки и запуска приложения в соответствии с инструкцией по разворачиванию системы.
Руководство по установке и эксплуатации программного обеспечения АПКСУР

1. Информация об установке
Внедрение, установка и эксплуатация программного обеспечения АПКСУР на объектах заказчика осуществляется силами Исполнителя. Для каждого объекта разрабатывается собственный технический проект. Самостоятельная установка и настройка ПО заказчиком не предусматривается.
Далее приводится информация, необходимая для эксплуатации программного комплекса АПКСУР с точки зрения заказчика (пользователя).
При эксплуатации ПО выделяются пользователи со следующими ролями:
  • Администратор системы
  • Пользователь
Приведенная ниже информация о функциональности отдельных модулей является достаточной для демонстрации основных возможностей АПКСУР.

2. Модуль «Центральный сервер»
Модуль ПО: «Центральный сервер» предназначен для администрирования базы данных, отображения показаний приборов, формирования отчетов пользователем и администратором системы. Модуль имеет веб-интерфейс для взаимодействия пользователем. Для начала взаимодействия с системой в браузере необходимо ввести URL-адрес системы (устанавливается при установке). Следующим шагом необходимо ввести имя и учетные данные.
Рисунок 1. Страница входа
2.1. Пользовательский интерфейс
Пользовательский интерфейс состоит из нескольких компонентов:
  • Раздел «Меню»
  • Раздел «Показания»
  • Раздел «Отчеты»
  • Раздел «Новый Отчет»
  • Раздел «Подробно»
Раздел «Меню» предназначен для навигации пользователя по проектам, очередям и объектам (корпусам). При выборе проекта открывается контекстное меню для выбора очереди и корпуса. При выборе корпуса данные потреблений, статистики и отчетов отображаются в правой части экрана.
Рисунок 2. Меню
Раздел «Показания» предназначен для отображения списка помещений, показаний, статистических данных и отчетов.
Раздел разделен на несколько блоков:
  • Фильтры
  • Статистика
  • Показания
  • Отчеты
  • Новый отчет
Рисунок 3. Показания
  • Блок «Фильтры» предназначен для фильтрации отображаемых показаний. При необходимости установите необходимые фильтры. Выгрузка данных происходит с учетом фильтров.
  • Блок «Статистика» предназначен для отображения статистических данных, таких как количество устройств с ошибками, приборы без показаний и пр.
  • Блок «Показания» отображает список помещений, устройств и последние показания. Имя помещения представлено в виде ссылки на страницу помещения. Также реализован поиск по помещениям. Для выгрузки Устройств не вышедших на связь, нажмите на ссылку «Не вышли на связь».
  • Блок «Отчеты» предназначен для отображения ранее сформированных отчетов. Для выгрузки отчета в формате CSV нажмите на «Скачать».
  • Блок «Новый отчет» предназначен для формирования отчета по потреблению тепловой энергии при использовании «Распределителей тепла» для сбора данных потребления в заданный период. Установите начальную и конечную дату, показания ОДПУ и нажмите «Сформировать».
Рисунок 4. Новый Отчет
Раздел «Подробно» предназначен для отображения исторических данных и индивидуальных отчетов по конкретному помещению. Для перехода в раздел выберите помещение в блоке «Показания».
Рисунок 5. Подробно
При выборе устройства в списке открывается график показаний и аварий для прибора.
Рисунок 6. Показания прибора
В блоке «Отчеты» отображаются ранее сформированные отчеты тепловой энергии.

Выгрузка показаний
  1. Перейдите в раздел Выгрузка показаний.
  2. Выбирете здание, так же при ниобходимости выбирете помещение .
  3. Установите селекторы для необходимых типов показаний.
  4. Нажмите кнопку Выгрузить.
Рисунок 7. Расчет отопления.
Расчет отопления
1. Перейдите в раздел Расчет отопления.
2. Выбирете формулу в выпадающем списке.
3. Выбирете здание, по которому необходимо произвести расчет.
4. Введите показания ОДПУ и нажмите кнопку ВЫГРУЗИТЬ.
Рисунок 7. Расчет отопления.
2.2. Интерфейс Администратора
Интерфейс Администратора предназначен для управления всеми аспектами программного комплекса АПКСУР. Администратор имеет доступ к настройкам системы, управлению пользователями, проектами, устройствами, отчетами и прочими функциями.
Для начала работы администратору необходимо выполнить вход в систему через веб-интерфейс, используя свои учетные данные. После успешного входа администратор попадает на главную страницу административной панели.

Основные разделы интерфейса Администратора включают:
  1. Главная панель (Dashboard)
  2. Проекты
  3. Помещения
  4. Устройства
  5. Метрики
  6. Отчеты по дому
  7. Отчеты по помещениям
  8. Пользователи

Главная панель (Dashboard)
Главная панель предоставляет обзор текущего состояния системы, отображая ключевые показатели и уведомления. Здесь администратор может быстро оценить общее состояние системы и перейти к важным задачам.

Проекты
Раздел Проекты предназначен для управления проектами. Здесь администратор может создавать новые проекты, редактировать существующие и удалять ненужные. Для создания нового проекта необходимо указать название и другие параметры.

Основные элементы:
  • Список проектов: отображает все проекты в системе.
  • Кнопка добавления: позволяет создать новый проект.
Рисунок 8. Список проектов
Помещения
Раздел Помещения позволяет администратору управлять помещениями внутри проектов. Администратор может добавлять новые помещения, редактировать информацию о существующих и удалять их.

Основные элементы:
  • Список помещений: отображает все помещения в системе.
  • Кнопка добавления: позволяет добавить новое помещение.
  • Фильтры: для поиска и сортировки помещений.
Рисунок 9. Список помещений
Устройства
Раздел Устройства предназначен для управления устройствами, установленными в помещениях. Администратор может добавлять новые устройства, редактировать их параметры и удалять.

Основные элементы:
  • Список устройств: отображает все устройства в системе.
  • Кнопка добавления: позволяет добавить новое устройство.
  • Фильтры: для поиска и сортировки устройств.

Метрики
Раздел Метрики используется для отображения и управления данными, собранными с устройств. Администратор может просматривать метрики, фильтровать данные по различным параметрам и экспортировать их для дальнейшего анализа.

Основные элементы:
  • Список метрик: отображает все метрики, собранные системой.
  • Фильтры: для поиска и сортировки метрик.
  • Кнопка экспорта: позволяет выгрузить данные в формате CSV.
Рисунок 10. Список метрик
Отчеты по дому
Раздел Отчеты по дому позволяет администратору создавать и управлять отчетами, связанными с потреблением тепловой энергии для всего дома. Администратор может задавать периоды отчетности и формировать новые отчеты.

Основные элементы:
  • Список отчетов: отображает все отчеты по дому.
  • Кнопка создания: позволяет создать новый отчет.
  • Фильтры: для поиска и сортировки отчетов.

Отчеты по помещениям
Раздел Отчеты по помещениям позволяет создавать и управлять отчетами для отдельных помещений. Администратор может формировать отчеты по заданным периодам и параметрам.

Основные элементы:
  • Список отчетов: отображает все отчеты по помещениям.
  • Кнопка создания: позволяет создать новый отчет.
  • Фильтры: для поиска и сортировки отчетов.

Пользователи
Раздел Пользователи предназначен для управления учетными записями пользователей системы. Администратор может добавлять новых пользователей, назначать им роли, редактировать их данные и удалять учетные записи.

Основные элементы:
  • Список пользователей: отображает всех пользователей системы.
  • Кнопка добавления: позволяет создать нового пользователя.
  • Фильтры: для поиска и сортировки пользователей.
Рисунок 11. Список пользователей
В каждом разделе администратор может использовать различные фильтры и инструменты для оптимизации управления системой и обеспечения её эффективной работы.

  1. Примеры использования административных функций Добавление нового проектаПерейдите в раздел Проекты.
  2. Нажмите кнопку Добавить проект.
  3. Заполните необходимые поля: название проекта.
  4. Нажмите кнопку Сохранить.
Рисунок 12. Добавление нового проекта
Управление устройствами
  1. Перейдите в раздел Устройства.
  2. Для добавления нового устройства нажмите кнопку Добавить устройство.
  3. Заполните поля: название устройства, тип, производитель и прочее.
  4. Нажмите кнопку Сохранить.
Рисунок 12. Добавление нового устройства
3. Общие рекомендации по эксплуатации системы
  1. Регулярное обновление данных: Убедитесь, что данные, собираемые устройствами, регулярно обновляются и синхронизируются с системой для обеспечения точности отчетов.
  2. Безопасность данных: Обеспечьте защиту данных путем использования надежных паролей и регулярного их обновления.
  3. Регулярная проверка состояния устройств: Проводите регулярные проверки состояния устройств для выявления и устранения возможных неисправностей.
Следуя данным рекомендациям, вы сможете обеспечить стабильную и эффективную работу программного комплекса АПКСУР.