1. Общие сведения

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

2. Запуск программного обеспечения

Программное обеспечение работает в виде набора программных сервисов, запускаемых на вычислительном оборудовании оптического сортировщика.
Для запуска установленной системы необходимо выполнить из корневого каталога программного обеспечения:
make up
Для проверки состояния программных компонентов используется команда:
make status
После успешного запуска пользовательский интерфейс доступен через веб-браузер по адресу:
http://localhost
Backend API системы доступен по адресу:
http://localhost:3000/api
Указанные команды и адреса предусмотрены штатной production-конфигурацией ПО.

3. Пользователи и уровни доступа

Программное обеспечение предусматривает разграничение прав пользователей.
Используются следующие роли:
Права оператора могут дополнительно настраиваться посредством функциональных флагов в административной панели.
Разграничение ролей соответствует реализованной модели доступа системы.

4. Вход в систему

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

5. Основные функции при эксплуатации

При штатной эксплуатации программное обеспечение используется для:
1)      контроля текущего состояния системы сортировки;
2)      просмотра информации о работе оборудования;
3)      задания и изменения параметров сортировки;
4)      работы с конфигурациями оборудования;
5)      передачи параметров в программно-аппаратные компоненты сортировщика;
6)      получения и отображения результатов работы системы;
7)      контроля технических и эксплуатационных показателей;
8)      администрирования пользователей и параметров системы пользователями с соответствующими правами.

6. Работа с конфигурациями

Программное обеспечение предусматривает хранение и управление конфигурациями оптического сортировщика.
Пользователи с соответствующими правами могут создавать и изменять конфигурации.
Конфигурация определяет параметры, используемые программным обеспечением при взаимодействии с сортировочным оборудованием.
Изменение конфигураций должно выполняться пользователем, имеющим роль PLANT_ENGINEER, SERVICE_ENGINEER или ADMIN, в пределах предоставленных ему полномочий.

7. Взаимодействие с оптическим сортировщиком

Backend программного обеспечения взаимодействует с системой сепаратора через программный API.
В рамках этого взаимодействия предусмотрены:
1)      получение текущего состояния сортировки;
2)      получение действующих параметров;
3)      передача измененных параметров работы оборудования.
В программном обеспечении реализованы соответствующие операции API для получения состояния, чтения параметров и передачи параметров сепаратору.
При штатной промышленной эксплуатации взаимодействие осуществляется с подключенным оборудованием сортировщика.

8. Контроль состояния программного обеспечения

Для проверки состояния программных компонентов используется:
make status
При необходимости просмотра журналов работы используется:
make logs
Для перезапуска программного обеспечения используется:
make restart
Для остановки:
make down
Для последующего запуска:
make up
Указанные операции предусмотрены штатным набором команд управления production-системой.

9. Действия при возникновении неисправности

При возникновении ошибки в работе программного обеспечения рекомендуется:

1. Проверить состояние программных компонентов командой:

make status

1. Просмотреть журналы работы:

make logs

1. При необходимости выполнить перезапуск:

make restart

1. Проверить доступность пользовательского интерфейса.
2. Проверить подключение к оборудованию сортировщика.

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

10. Штатная остановка

Для остановки программного обеспечения необходимо выполнить:
make down
Команда останавливает production-компоненты программного обеспечения.
Перед отключением вычислительного оборудования рекомендуется выполнить штатную остановку программного обеспечения.

11. Администрирование

Пользователь с ролью ADMIN имеет доступ к функциям администрирования системы и пользователей.
Пользователь с ролью SERVICE_ENGINEER имеет полный доступ к конфигурациям оборудования.
Пользователь с ролью PLANT_ENGINEER может создавать и редактировать конфигурации.
Оператор использует основные функции просмотра и управления, доступные ему без административных полномочий.
Такое разделение позволяет ограничивать изменение критичных параметров системы в зависимости от полномочий пользователя. Реализованные роли и их права приведены в документации ПО.

12. Проверка работоспособности без промышленного оборудования

Для проверки программного обеспечения без подключения физического сепаратора предусмотрен программный имитатор Separator Mock.
Он имитирует REST API реального сепаратора и позволяет проверить:
1)      получение состояния сортировки;
2)      получение параметров;
3)      изменение параметров;
4)      взаимодействие Backend с интерфейсом сепаратора.
Для запуска тестовой инфраструктуры используется:
make dev
После запуска программный имитатор сепаратора доступен по адресу:
http://localhost:1337
Механизм программного имитатора и его API входят в состав проекта.

13. Завершение эксплуатации

Для завершения работы программного обеспечения необходимо выполнить штатную остановку:
make down
При последующем использовании система запускается командой:
make up
Удаление программного обеспечения для завершения обычного сеанса эксплуатации не требуется.