Engee documentation

Getting started

Preparation

To fully start working with the KPM "RHYTHM" blocks in Engee, install the support package for the blocks by following the following procedure 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 engee.package commands, 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 feature/engee-package-functions.adoc#engee.package.install.

To start working with KPM "RHYTHM", go to the Engee applications engee apps in the workspace and select RITM.Manager:

  • Add the machine to Engee using Main Menu → Choose machine → Add the machine. In the menu that opens, enter the name and IP address of the machine:

    ritm add machine 2 en → ritm add machine en

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

    ritm package update en

  • After updating the firmware, install the Engee support package on RHYTHM by clicking again ritm updater and using Support package update → Support package update → Local 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.

An example of a simple model

This example shows how to create an Engee model from scratch and run it on KPM RITM.

  • 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

  • Set the infinite simulation time (`inf') and press Run the model on hardware:

    ritm getstarted run

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

    ritm getstarted running en

  • You can stop the execution of the RHYTHM model by clicking Stop 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 execution, you can monitor the recorded signals using visualization windows graphs icon 1. Also, during execution, you can change the configurable parameters of the model on the fly and see the changes. For example, you can change the amplitude of the sine wave (block Sine Wave) from 1 to 2 and observe the changes on the charts:

    ritm getstarted sine en

    ritm getstarted plots en

  1. Introduction

  2. Model execution modes

  3. RITM.Manager