Engee documentation

Getting Started

Preparation

To fully start working with the RITM CPM blocks in Engee, install the support package for the blocks by running 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 blocks RITM, you can use other engee.package commands, namely:

  • engee.packages.checkupdates() - checks for available updates to 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") - uninstalls the specified support package.

For a detailed description of the functions, see feature/engee-package-functions.adoc#engee.package.install.

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

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

    ritm add machine 2 -> ritm add machine

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

    ritm package update

  • After updating the firmware, install the Engee support package on the RITM by again clicking ritm updater and using Support package update -> Support package update -> Local update or Online Update:

    ritm updater 1

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

Example of a simple model

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

  • Create a new model, add standard blocks Sine Wave, Integrator and Out1 to the model and connect them. Switch on signal recording signal logging 1 for output of block Integrator:

    ritm getstarted model

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

    ritm manager choosing

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

    ritm getstarted run

  • A real-time application is created from the model and loaded and run on the selected RITM machine:

    ritm getstarted running

  • You can stop the execution of the model on the RITM 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

  • During runtime, you can observe the recorded signals using graph window graphs icon 1. You can also change the adjustable parameters of the model on the fly during runtime and see the changes. For example, you can change the sine wave amplitude (block Sine Wave) from 1 to 2 and see the changes in Graphs:

    ritm getstarted sine

    ritm getstarted plots

  1. Introduction

  2. Modes of model execution

  3. RITM.Manager