Engee.Integrations

Integration Engee The equipment is provided by the Engee subsystem.Integration, which connects Engee access to external devices, interfaces, protocols, and software environments. The implementation relies on support packages for specific hardware (for example, VISA, Arduino, RITM, etc.); they cover both I/O modules connected to a computer and embedded systems. External hardware and protocols physically run on the user’s computer, but become available directly in Engee it is through the Engee subsystem.Integration.

Engee It works in a browser and, as a result, does not have direct access to the physical ports of the computer. Restricting browser access to the low-level interfaces of the operating system does not allow you to simply connect the hardware and immediately start working. The following interaction architecture is used to solve this problem:

engee hardware en

The diagram shows that Engee exchanges data with the Engee client program.Integration installed on the user’s computer; this program works with the physical interfaces of the system (COM ports, USB, etc.) and transmits commands/data to the connected hardware. At the same time, to organize network interaction between Engee and the client program uses a server on the side Engee.

Before you start working on a computer with connected hardware, you need to install the Engee client program.Integration and connect it to Engee. Browser with Engee It can be opened on the same computer or on any other device on the network. This allows you to create «virtual laboratories» and it allows multiple users to connect to the same computer, working with the hardware directly via Engee.

Installing Engee.Integrations

Download and unzip the archive for your OS, then run Engee.Integrations:

Host-Device-Manager-Windows.zip — for Windows;
Host-Device-Manager-Linux.zip — for Linux.

Antivirus may block the installation or launch of the Engee client program.Integration. If security warnings appear during installation or startup, temporarily disable real-time protection and add the client executable file to the exceptions.

For example, to disable the antivirus «Windows Security» And follow the instructions to add exceptions.:

_ Step-by-step instructions_

Open the search and enter «Windows Security».
Select Protection against viruses and threats.
Click Manage Settings in the section «Protection options against viruses and other threats».
Switch the toggle switch Real-time protection to «Off.» (when prompted for account control, click Yes.)
In the same window, scroll to the block «Exceptions» and click Add or Remove exceptions.
Click Add Exception and select the File (named by default engee-device-manager.exe):

When the SmartScreen window appears («The Windows system has protected your computer») click Run anyway:

defender exceptions 4

The purple SmartScreen window appears even if a file is added to the exceptions and does not depend on the toggle switch position. «Real-time protection» — this is a separate reputational check.

Launch the Engee client program.Integration and check the connection in the client window (Status: Connected).
After installing and launching the client program for the first time, switch the Real-time Protection toggle switch back to the «On.».

In corporate environments, the security policy may prohibit the addition of exceptions by the user. In this case, contact the information security administrator.

After launching the Engee client program.Integration a window will open:

interface 1 en

To connect the Engee client program.Integration to Engee you must create a Personal Access Token (PAT) in your merchant profile Engee. Connecting to the server address (for example, engee.com) does not work without a token. The token is stored only on a personal computer and transferred to the selected server. Its status is visible in the app header on the right, next to the button «i» : «Not specified» / «Active».

Connecting using a personal access token

Creating a personal access token in Engee

Open personal account Engee and go to the Communications and Security section.
Select Personal Access Tokens.
Expand the Personal Access Tokens block and click Add New Token.
Fill out the form: token name, expiration date, permission «Access to the Engee API» then click Add Personal Access Token.
Copy the created token. It is displayed once and will be needed for activation in the client program.

To copy, use the button , for viewing — .

Save the token immediately after creation. It is not possible to re-view it in the interface.

Choosing a server in Engee.Integrations

In the client program, select the server from the list (by default engee.com) or add your own server. To do this, click Add new… at the end of the address list.

06 server add new en

Adding a token

Click on the pencil button , insert the personal access token and save it, after which the token status will change to «Active».

07 license and connect en

Connection

Start the session Engee — the active license will appear in the server address automatically. When it appears, click Connect. The client program itself will wait until it is ready, install or update the server program and connect; progress is displayed in the diagnostic window.

08 bootstrap progress en

Shopping Cart button next to the server selection for engee.com (by default) deletes only the token (the server remains in the list); for the added server, deletes both the token and the server address.
If the token status does not change to «Active», check the validity period of the token and the permission «Access to the Engee API»; if necessary, create a new token — the old or lost one cannot be restored.

The Engee update.Integrations

Every time you open the Engee client program.Integration checks for the availability of a new version. If an update is available, it is enough to confirm its installation.

edm upd 1 en

The server part is updated automatically. Messages about this are displayed in the diagnostic window.

edm upd 2

Client program interface

The interface of the Engee client program.Integration has the following form:

edm interface en

The name and version of the client program.
The hardware status window button.

Clicking on it opens a window that contains tabs with hardware statuses.:

This window contains all the information about the connected hardware and integrations.

On the tab «Extensions» you can upload (or delete) custom support package to the client program.
The settings window button.
The minimize tray button (only in the Windows version).

When you click on it, the application is placed in the system tray, and the connection status is highlighted in the icon.:
- If the client program is enabled:
- If the client program is disabled:
Server selection field, add buttons and token deletion , the token status and the connect button.
Connection status to Engee.
The clear logs button.
Diagnostic window.

Error messages

The section contains error messages that are displayed in the diagnostic window of the client program or on the command line. Engee.

Text of the message: 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.

Description: there is a running instance of the client program, it is not possible to use a second instance of the client program.

The reason: one instance of the client program is already running, and the user has started the second one.

Solution: close the first instance manually or run on the command line Main.EngeeDeviceManager.UTILS_API.stopClientProgram().
Text of the message: 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()

The text of the message is provided for the object Socket. For other objects, the name in the message will be appropriate.

Description: accessing a previously created object after restarting the client program causes an error.

The reason: restarting the client program while working with a previously created object on the command line or in the script editor Engee.

Solution: after restarting the client program, create the object again (for example, via socket = SOCKET.Socket()) and use only it — the previously created object cannot be restored.
Text of the message: ERROR: Operation cannot be completed: there is no available route to host client program. Please verify that the host client is connected.

Description: creating an object without an active connection to the client program causes an error.

The reason: attempt to create an object on the command line or in the script editor Engee when the client program is not connected.

Solution: Pre-connect the client program, make sure that there is a connection, and only then create objects and work with them.

Software management

The software package management functions are only available when the Engee subsystem is installed and running.Integration.

Besides software simulation management in Engee software support package management is available:

VISA Software Management — work with devices according to the VISA specification.
HTTP Software Management — working with HTTP connections.
MAVLink software management — work with MAVLink devices.
Software control of Ardupilot — work with the ArduPilot autopilot.
EULER software control — working with the EULER solver.
Software management of T-FLEX DOCs — working with calculation objects in T-FLEX DOCs.
CAN software control — work with CAN interfaces.
COM software management — work with COM interfaces.
Software management of Analog Discovery — work with Digilent Analog Discovery series laboratory devices.
Programmatic target management — work with embedded systems.
Software control of RITM — loading/launching models, working with files, logs and statuses on the target RITM platform.
Software management of RITM SDR cards — work with RITM SDR cards.