Engee documentation

RITM.Manager

For more information about RITM and semi-natural modeling, see Semi-natural modeling.

Application RITM.Manager ritm icon It is designed to solve the following tasks:

  • Connecting and configuring KPM real-time machines «RITM»;

  • Configuring the network interfaces of the RITM machine;

  • Setting up the RITM Monitor interface on the RITM screen;

  • Managing real-time applications generated from models Engee.

RITM.Manager you can launch it from the menu Apps engee apps in the workspace Engee.

Preparation for work

Before you start working with RITM.Manager install and connect Engee.Integration. This is a mandatory first step: without it, operations with the machine are not available — you can only edit the list of machines (for example, save the machine’s IP address). Detailed installation and connection instructions are provided in the article Engee.Integrations.

When opened, the application automatically checks whether the Engee client program is installed.Integration and whether it is connected to Engee. During the check, a window is displayed «Engee training.Integration to work». If the check fails, a window will open. «Warning» with an indication of the reason and the action to be performed:

  • the support package is not installed — run the command engee.package.install("Engee-Device-Manager");

  • the package is installed, but not running — run the command engee.package.start("Engee-Device-Manager");

  • there is no connection to Engee — connect using the link provided by the command engee.package.start("Engee-Device-Manager").

    ritm manager prepare edm ru

After the cause is eliminated, click «Continue» and check the status by clicking on the button Check machine status ritm manager reload in the main menu.

Description

Interface RITM.Manager contains several areas:

ritm manager app en

The main menu consists of the following options:

ritm manager main menu en

  • Reference ritm reference icon — opens the documentation RITM.Manager.

  • Choose machine — allows you to select a car from the list, add a new car, and remove a car from the list. It also displays the current connection status with the machine next to the machine name (connected ritm connected; not connected ritm not connected). The process of adding a car is described in the article RITM Getting Started.

    ritm manager machine list ru

    When adding a car, specify:

    • «Name» — custom car name;

    • «IP address» — the address of the machine in the network;

    • «Machine by default» — The car will be selected automatically the next time you open the app.

    ritm manager add machine ru

  • Update machine ritm edit 1 — allows you to change «Name», «IP address» and the sign «Machine by default» for the selected car.

    ritm manager edit machine en

  • Check machine status ritm manager reload — re-checks the connection to the machine if it has been disrupted. The connection status is also checked automatically.

  • Manage the power ritm manager power — allows you to restart or turn off the machine.

    ritm manager power menu ru

  • Updating the machine ritm updater x — allows you to update the firmware and support package of the device.

    ritm manager update menu ru

    • Firmware update

      Details

      Local update — select the firmware file and checksum file that are available offline (for example, obtained through RITM technical support).

      ritm manager firmware local ru

      Online Update — checks for a new firmware version via the Internet and suggests updating it.

      ritm manager firmware online ru

    • Support package update

      Details

      Local update — select the support package file.

      ritm manager support local ru

      Online update — checks for a new version of the support package via the Internet and suggests updating it.

      ritm manager support online ru

    The update process is accompanied by a progress bar window. After updating the firmware, the application will prompt you to restart the machine. The availability of a new firmware version or support package is also indicated by a warning icon in the Machine Settings panel.

Application Management

In the panel Application Management A list of all real-time applications downloaded to the machine is displayed, and the application currently running is marked. To search for the desired application, use the field Enter the name of the application.

ritm manager apps ru

Applications are controlled using the buttons in the application line.:

  • Run ritm start app — The currently running application stops and the selected application starts.

  • Stop ritm stop app — the currently running application stops.

  • Run at startup ritm auto start — The selected application is placed in the autorun: it will start automatically when the machine is turned on. An application with autorun enabled is marked with a lightning bolt icon in the list.

  • Delete ritm delete app — If the selected application is running, it is stopped and then deleted from the machine.

Applications collected in interactive mode model execution, do not support autorun — there is a button for them Run at startup ritm auto start unavailable.

Machine Settings

In the panel header Machine Settings the firmware version and support package installed on the machine are displayed (or a message «not installed»).

ritm manager machine settings ru

  • Configuring the host-target network interface — allows you to change the IPv4 address on the machine.

    ritm manager network host target en

    The IP address in the connection profile is also automatically changed. If the connection was not restored immediately after the address change, then use the button Check machine status ritm manager reload in the main menu to restore the connection.

  • Configuring Network interfaces — allows you to configure the network interfaces available on the machine.

    ritm manager network interfaces en

    Pressing a button Reset network interface settings resets the settings of all network interfaces except the host-target interface.

  • RITM Monitor Setup — allows you to configure the display of RITM Monitor on the machine screen.

    ritm manager monitor settings ru

    • Display mode:

      • Graphical — the application Log is displayed on the RITM screen on the right in a collapsed form;

      • Text — The application log opens from the bottom in an expanded form: more output text is placed in it.

    • Theme — dark or light.

    • Chart layout — grid, vertical or horizontal.

    • Advanced monitor — enables the output of additional indicators:

      • amount of occupied RAM memory;

      • CPU Usage;

      • the Model TET — Detailed Metrics table with columns:

        Column What shows

        Task

        Task name

        Max TET (us)

        Maximum task completion time, mks

        Average TET (us)

        Average task completion time, mks

        p95 TET (us)

        95th percentile of execution time, mks

        p99 TET (us)

        99th percentile of execution time, mks

        TET / Sample Time

        The ratio of task execution time to sampling step

    example of RITM Monitor settings

    Initially, the dark theme is turned on on the machine screen, and the extended monitor is turned off.:

    ritm manager monitor before settings ru

    After selecting a light theme and turning on the extended monitor, the RITM Monitor interface turned bright, and additional indicators appeared on the screen, such as CPU Usage:

    ritm manager monitor after settings ru

Machine logs

The Machine Logs panel displays the last lines of the RITM Monitor output logs — in fact, this is the output that RITM Monitor shows on the machine screen. Logs are useful for monitoring the execution of the model and troubleshooting the machine.

ritm manager machine logs ru

The panel is updated automatically: the last 15 lines of the RITM Monitor output are displayed.

Service messages

In the panel Service messages service and status messages for the user are displayed.:

ritm manager service messages en

Network Setup

Please note that the IP address of the host (set in your operating system settings) must be on the same subnet as the IP address of the RITM machine.

It is not recommended to use multiple network interfaces with IP addresses belonging to the same network at the same time. This remark also applies to the host-target interface. IP addresses from the same subnet on multiple network interfaces can lead to routing errors and, for example, the inability to connect to a machine via the host-target interface.

In case of such a situation, disconnect the network cables from all ports except the port marked as Host on the RITM, reconnect to the machine and configure the network interfaces.

Connection error to the machine

If the machine is turned on and pings, but a connection error is displayed:

  1. Make sure that the client program is Engee.Integration is installed and connected to Engee (see Preparation for work). If the application showed a window «Warning» — eliminate the reason indicated in it.

  2. Make sure that the host’s IP address is on the same subnet as the machine’s IP address (see Network Setup).

  3. Click Check machine status ritm manager reload in the main menu to restore the connection.

  4. If the connection has not been restored, check the messages in the [service—messages] and Machine logs panels.