Engee documentation

Getting started

Preparation

To fully start working with the KPM "RHYTHM" blocks and with the software control for KPM "RHYTHM" in Engee Follow these steps:

  1. Install RITM KPM Support Package by doing the following command in script editor interactive script icon or command line img 41 1 2:

    engee.package.install("RITM-Engee-Blocks")

    After installing the support package for the blocks RITM, you can use other commands as well engee.package, namely:

    • engee.packages.checkupdates() — checks the available updates of the installed support package;

    • engee.packages.update("RITM-Engee-Blocks") — updates the specified support package to the latest version;

    • engee.packages.uninstall("RITM-Engee-Blocks") — deletes the specified support package.

    For a detailed description of the functions, see engee.package.install.

  2. Install the subsystem Engee.Integrations:

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

    If the subsystem is Engee.Integration has already been installed, then just run it with the command:

    engee.package.start("Engee-Device-Manager")
  3. Launch the Engee client program.Integration and connect using the provided URL (for more information, see Hardware connection).

  4. Go to the applications Engee engee apps in the workspace and select RITM.Manager:

    • Add the car to Engee using Main MenuChoose machineAdd the machine. In the menu that opens, enter the name and IP address of the machine:

      ritm add machine 2 enritm add machine en

    • Update the firmware by clicking ritm updater and using Firmware updateLocal update or Online Update:

      ritm package update en

    • After updating the firmware, install the support package Engee on the rhythm by pressing again ritm updater and using Support package updateSupport package updateLocal update or Online Update:

      ritm updater 1 en

    • After successfully updating the firmware and support package to the latest version, the icon Update firmware will change the view from ritm updater on ritm updater x.

      After each firmware update ritm updater it is necessary to reinstall the support package on the RHYTHM.

The general architecture of the interaction of the firmware, the support package on the RHYTHM and Engee it looks like this:

ritm packages main en

On the diagram:

  • The RHYTHM Support Package is an extension for the subsystem Engee.Integrations, adding library blocks Engee for working with I/O modules on the KPM "RHYTHM", as well as the following features: software rhythm control from Engee.

  • Firmware is the software framework of KPM "RHYTHM", which includes the RHYTHM operating system.RV, as well as drivers and libraries for working with I/O modules.

  • Support Package Engee — this is an extension of the RHYTHM firmware, adding features launching models Engee at the KPM "RHYTHM".

An example of a simple model

This example shows how to create a model from scratch. Engee and launch it on KPM "RHYTHM".

Create a new model and add standard blocks to the model Sine Wave, Integrator and Out1 and connect them. Turn it on signal recording signal logging 1 to exit the block Integrator:

ritm getstarted model en

Select "RHYTHM" as the target platform from the drop-down menu in the Main Menu of the model:

ritm manager choosing 1

In settings window debug article icon 1 The "RHYTHM" tab will appear. On it, you need to select the target car for this model from the list.:

ritm settings 1 1 en

Set an infinite simulation time (inf) and press the button Run the model on hardware:

ritm getstarted run 1

A real-time application is created from the model, which is downloaded and launched on the selected machine.:

ritm getstarted running 1 en

You can stop the execution of the RHYTHM model by pressing Stop the model stop button in the simulation control menu. The simulation time and status are displayed in the Status bar of the model (lower right corner of the workspace):

ritm getstarted status en

During the operation of the real-time application, you can change the parameters of the model itself on the fly, record the model’s signals and view them in the window. signal visualization or in the data inspector. For example, you can change the amplitude of the sine wave (block Sine Wave) with 1 on 2 and observe the changes on the charts:

ritm getstarted sine en

ritm getstarted plots en

Or you can use Data Inspector. For example, you can compare two runs of a model with different amplitude values.:

ritm getstarted plots 1 en