Документация Engee

Engee.Интеграции

Интеграция Engee с оборудованием обеспечивается подсистемой Engee.Интеграции, которая подключает Engee к внешним устройствам, интерфейсам, протоколам и программным средам. Реализация опирается на пакеты поддержки конкретного оборудования (например, VISA, Arduino, РИТМ и т.д.); они охватывают как модули ввода-вывода, подключенные к компьютеру, так и встраиваемые системы. Внешнее оборудование и протоколы физически работают на компьютере пользователя, но становятся доступны напрямую в Engee именно через подсистему Engee.Интеграции.


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

engee hardware ru

На схеме показано, что Engee обменивается данными с клиентской программой Engee.Интеграции, установленной на компьютере пользователя; эта программа работает с физическими интерфейсами системы (COM-портами, USB и т.д.) и передает команды/данные подключенному оборудованию. При этом для организации сетевого взаимодействия между Engee и клиентской программой используется сервер на стороне Engee.

Перед началом работы на компьютере с подключенным оборудованием нужно установить клиентскую программу Engee.Интеграции и подключить ее к Engee. Браузер с Engee можно открыть как на этом же компьютере, так и на любом другом устройстве в сети. Это позволяет создавать «виртуальные лаборатории» и дает возможность нескольким пользователям подключаться к одному и тому же компьютеру, работая с оборудованием напрямую через Engee.

Установка Engee.Интеграции

Скачайте и распакуйте архив для своей ОС, затем запустите Engee.Интеграции:

Антивирус может заблокировать установку или запуск клиентской программы Engee.Интеграции. Если при установке или запуске появляются предупреждения системы безопасности, то временно отключите защиту в реальном времени и добавьте исполняемый файл клиента в исключения.

Например, для отключения антивируса «Безопасность Windows» и добавления исключений следуйте инструкции:

Пошаговая инструкция
  1. Откройте поиск windows search и введите «Безопасность Windows».

    disable defender step1

  2. Выберите Защита от вирусов и угроз.

    disable defender step2

  3. Нажмите Управление настройками в разделе «Параметры защиты от вирусов и других угроз».

    disable defender step3

  4. Переключите тумблер Защита в реальном времени в положение «Выкл.» (при появлении запроса контроля учетных записей нажмите Да).

    disable defender step4

  5. В этом же окне пролистайте до блока «Исключения» и нажмите Добавление или удаление исключений.

    defender exceptions 2

  6. Нажмите Добавить исключение и выберите Файл (по умолчанию с именем engee-device-manager.exe):

    defender exceptions 3

  7. При появлении окна SmartScreen («Система Windows защитила ваш компьютер») нажмите Выполнить в любом случае:

    defender exceptions 4

    Фиолетовое окно SmartScreen появляется даже в случае добавления файла в исключения и не зависит от положения тумблера «Защита в реальном времени» — это отдельная репутационная проверка.
  8. Запустите клиентскую программу Engee.Интеграции и проверьте соединение в окне клиента (Статус: Подключен).

  9. После установки и первого запуска клиентской программы переключите тумблер Защита в реальном времени обратно в положение «Вкл.».

В корпоративных средах политика безопасности может запрещать добавление исключений пользователем. В этом случае обратитесь к администратору ИБ.

После запуска клиентской программы Engee.Интеграции откроется окно:

interface 1 ru

Для подключения клиентской программы Engee.Интеграции к Engee необходимо создать токен личного доступа (Personal Access Token, PAT) в личном кабинете Engee. Подключение по адресу сервера (например, engee.com) не работает без токена. Токен хранится только на персональном компьютере и передается на выбранный сервер. Его статус виден в шапке приложения справа, рядом с кнопкой «i» i button: «Не задан» / «Активен».

Подключение по токену личного доступа

Создание токена личного доступа в Engee

  1. Откройте личный кабинет Engee и перейдите в раздел Связь и безопасность.

    01 cabinet menu ru

  2. Выберите Токены личного доступа.

    02 security page ru

  3. Разверните блок Токены личного доступа и нажмите Добавить новый токен.

    pat 1 ru

  4. Заполните форму: имя токена, срок действия, разрешение «Доступ к API Engee», затем нажмите Добавить токен личного доступа.

    04 token form ru

  5. Скопируйте созданный токен — он показывается один раз и понадобится для подключения в клиентской программе.

    05 token created ru

    Для копирования используйте кнопку pat copy, для просмотра — pat see.

    Сохраните токен сразу после создания. Повторно просмотреть его в интерфейсе невозможно.

Выбор сервера в Engee.Интеграции

В клиентской программе выберите сервер из списка (по умолчанию engee.com) или добавьте свой сервер. Для этого нажмите Добавить новый…​ в конце списка адресов.

06 server add new ru

Добавление токена

Нажмите на кнопку с карандашом add pat button, вставьте токен личного доступа и сохраните, после чего статус токена изменится на «Активен».

07 license and connect ru

Подключение

Запустите сессию Engee — активная лицензия появится в адресе сервера автоматически. Когда она появится, нажмите Подключиться. Клиентская программа сама дождется готовности, установит или обновит серверную программу и подключится; прогресс отображается в окне диагностики.

08 bootstrap progress ru

  • Кнопка с корзиной del button рядом с выбором сервера для engee.com (по умолчанию) удаляет только токен (сервер остается в списке); для добавленного сервера удаляет и токен, и адрес сервера.

  • Если статус токена не меняется на «Активен», проверьте срок действия токена и разрешение «Доступ к API Engee»; при необходимости создайте новый токен — старый или потерянный восстановить нельзя.

Обновление Engee.Интеграции

При каждом открытии клиентской программы Engee.Интеграции выполняется проверка наличия новой версии. Если обновление доступно, достаточно подтвердить его установку.

edm upd 1 ru

Серверная часть обновляется автоматически. Сообщения об этом выводятся в окно диагностики.

edm upd 2

Интерфейс клиентской программы

Интерфейс клиентской программы Engee.Интеграции имеет следующий вид:

edm interface ru

  1. Название и версия клиентской программы.

  2. Кнопка окна статусов оборудования.

    При нажатии на нее открывается окно, которое содержит вкладки со статусами оборудования:

    edm status window ru

    В этом окне представлена вся информация о подключенном оборудовании и интеграциях.

    На вкладке «Расширения» можно загрузить (или удалить) пользовательский пакет поддержки в клиентскую программу.

    edm status extension ru

  3. Кнопка окна настроек.

  4. Кнопка сворачивания в трей (только в версии для Windows).

    При нажатии на нее приложение помещается в системный трей, а статус подключения подсвечивается в иконке:

    • Если клиентская программа подключена:

      edm status on

    • Если клиентская программа отключена:

      edm status off

  5. Поле для выбора сервера, кнопки добавления add pat button и удаления токена del button, статус токена и кнопка подключения.

  6. Статус подключения к Engee.

  7. Кнопка очистки логов.

  8. Окно диагностики.

Сообщения об ошибках

В разделе приведены сообщения об ошибках, которые выводятся в окне диагностики клиентской программы или в командной строке Engee.

  1. Текст сообщения: ERROR: An existing client program is already running. Please close it manually or call function Main.EngeeDeviceManager.UTILS_API.stopClientProgram() in Engee to terminate the previous program instance.

    Описание: существует запущенный экземпляр клиентской программы, использование второго экземпляра клиентской программы невозможно.

    Причина: один экземпляр клиентской программы уже запущен, и пользователь запустил второй.

    Решение: закройте первый экземпляр вручную или выполните в командной строке Main.EngeeDeviceManager.UTILS_API.stopClientProgram().

  2. Текст сообщения: ERROR: Request failed: there is no such host client object for corresponding object Socket! Please, verify the host client is connected and recreate object by calling: socket = SOCKET.Socket()

    Текст сообщения приведен для объекта Socket. Для других объектов наименование в сообщении будет соответствующим.

    Описание: обращение к ранее созданному объекту после перезапуска клиентской программы вызывает ошибку.

    Причина: перезапуск клиентской программы во время работы с ранее созданным объектом в командной строке или в редакторе скриптов Engee.

    Решение: после перезапуска клиентской программы создайте объект заново (например, через socket = SOCKET.Socket()) и используйте только его — ранее созданный объект восстановлению не подлежит.

  3. Текст сообщения: ERROR: Operation cannot be completed: there is no available route to host client program. Please verify that the host client is connected.

    Описание: создание объекта без активного подключения к клиентской программе вызывает ошибку.

    Причина: попытка создать объект в командной строке или в редакторе скриптов Engee, когда клиентская программа не подключена.

    Решение: предварительно подключите клиентскую программу, убедитесь в наличии соединения и только после этого создавайте объекты и работайте с ними.

Программное управление

Функции программного управления пакетами поддержки доступны только при установленной и запущенной подсистеме Engee.Интеграции.

Помимо программного управления моделированием в Engee доступно программное управление пакетами поддержки: