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. Support is provided through support packages for specific hardware (for example, VISA, Arduino, RITM, etc.), including 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 starting work, you must run the Engee client program.Integration on the computer to which the hardware is connected. 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.

Connecting to the hardware

Based on Engee.Integration Various hardware support packages are being created. First, install the basic Engee support package.Integration, universal for any hardware, and connect to the client program.

To get started with the Engee subsystem.Integration, install the basic support package by running the command engee.package.install in command line img 41 1 2 :

engee.package.install("Engee-Device-Manager")

If the main support package is distributed as a zip archive, then the path to it must be specified as a named argument. zip_path. For example, if the archive is called edmv2.4.zip and it is located in the folder distr then use the command:

engee.package.install("Engee-Device-Manager", zip_path="/distr/edmv2.4.zip")

After successful installation, a message will be displayed in the command prompt:

engee working hardware 2

This message will provide a URL for connecting via the Engee client program.Integration. You will also be offered links to download archives with these client programs. Select the desired archive depending on your operating system (Windows/Linux):

engee working hardware 3

Download the archive to your computer, unzip it and run the Engee client program.Integration.

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 purple 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 opens with a field for entering the URL from the message:

engee host access en

Next, copy the URL from the message in the command line (the text after the Connection link:), insert it into the Engee client program.Integration and click Connect. The connection status should change to «Connected»:

engee host access 1 en

After successful activation, you can download sample models that will help you understand how to work with the equipment. To do this, use the command line Engee run the command:

engee.package.getdemos("Engee-Device-Manager")

Excellent — the Engee subsystem.Integration Installed and ready to work!

After restarting the client Engee there is no need to reinstall the Engee subsystem.Integration — it is enough to re-run its server program using the command:

engee.package.start("Engee-Device-Manager")

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.
The settings window.
The minimize tray button (only in the Windows version).

When you click 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:
The field for entering the connection link and the connect button.
Connection status.
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.

Cause of occurrence: 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: A sync error occurred. Please, ensure that the latest version of the Engee.Integrations host client and server program is installed.

Description: A mismatch between the server and client software versions causes a synchronization error.

Cause of occurrence: if you run on the command line first engee.package.start("Engee-Device-Manager") and then engee.package.install("Engee-Device-Manager"), then the version of the server program may remain old.

Solution: before installing the server program, run on the command line engee.clear_all(). To avoid synchronization errors, you should perform engee.package.install("Engee-Device-Manager") immediately after launch Engee then the latest version of the server program will be installed.
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.

Cause of occurrence: 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.

Cause of occurrence: 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 modeling 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.
Software management of T-FLEX DOCs — working with calculation objects in T-FLEX DOCs.
Software management of Analog Discovery — work with Digilent Analog Discovery series laboratory devices.
Programmatic target management — work with Arduino-compatible boards and STM32 boards.
Software control of RITM — loading/launching models, working with files, logs and statuses on the target RITM platform.
Support package for managing the RITM SDR USRP hardware platform — management of the RITM SDR USRP hardware platform.