Engee documentation

Working with external equipment via RHYTHM in Engee

See also:
Getting started
RITM.Manager
Model Settings

RHYTHM is a hardware solution for running models in real time. It allows you to integrate work scenarios with physical hardware and manage it directly from Engee.

To start working with the target RHYTHM platform:

  1. Add the RHYTHM machine to Engee through the app RITM.Manager ritm icon.

  2. Install support RHYTHM BLOCKS:

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

  3. Install the External hardware support package:

    engee.package.install("Engee-Device-Manager")
    For more information about the installation process, see Integration of Engee with equipment.

  4. After these steps, modules for working with external equipment become available, providing software management of the target RHYTHM platform. To connect the modules, enter the following commands:

    using Main.EngeeDeviceManager.Targets
using Main.EngeeDeviceManager.Targets.RITM.RITM_API

  5. At the last stage, create an object of the target RHYTHM platform for interacting with devices and specify the IP address of the corresponding device.:

    ritm = Targets.RITM.Ritm()
ritm.set_url("http://192.168.56.3:8000/")

Basic methods of working with RHYTHM

The following methods are available for working with RHYTHM equipment:

  • `ritm.upload_model' — uploads the model to the RHYTHM.

  • `ritm.generate_executable_code' — generates a C-binding on the rhythm.

  • `ritm.compile_model' — builds a model based on the rhythm.

  • `ritm.start_model' — starts the model based on the rhythm.

  • `ritm.stop_model' — stops the model at the rhythm.

  • `RITM_API.isConnected' — checks the availability of the rhythm.

  • RITM_API.isRunning — checks whether the rhythm model is running.

  • RITM_API.listFiles — displays a list of files in the specified directory.

  • `RITM_API.ReadFile' — outputs the contents of the specified file from the specified directory.

  • `RITM_API.GetFile' — gets the specified file from the specified directory.

  • `RITM_API.memInfo' — displays information about the memory consumed by the model.

  • RITM_API.getLog — returns the specified number of lines of model execution logs for the rhythm.

  • RITM_API.getScreenshot — creates a screenshot on the rhythm and returns the path to the image file.

  • `RITM_API.getData' — returns the result of profiling the model based on the rhythm.

A detailed description of each method is provided in the article. Software control of RITM.

Step-by-step example of working with the RHYTHM model

  1. Connect modules — connect namespaces containing definitions of the target RHYTHM platform and its API:

    using Main.EngeeDeviceManager.Targets
using Main.EngeeDeviceManager.Targets.RITM.RITM_API

  2. Create a RITM target platform object and set the URL — create a ritm object representing the target platform and specify the IP address of the RHYTHM machine:

    ritm = Targets.RITM.Ritm()
ritm.set_url("http://192.168.56.3:8000/")

  3. Check the availability of RHYTHM — check whether the connection is established with the RHYTHM device:

    RITM_API.isConnected(ritm)

    If the method returns false, then check the IP address and whether the client program is running on the server.

  4. Assembling an open model in Engee on a rhythm in independent mode:

    model = Engee.engee.gcm()
ritm.upload_model(model)
ritm.generate_executable_code(model, false)
ritm.compile_model(model)

  5. Launch the model — launch the model on the RHYTHM machine:

    ritm.start_model(model)

    After launch, the model will start executing in the previously set mode (in our case, in an independent mode).

  6. Stop the model — stop the execution of all running models on the RHYTHM:

    ritm.stop_model()

  7. Output the contents of the directory to the RHYTHM — get a list of files in the specified directory (/home/ritm/):

    RITM_API.listFiles(ritm, "/home/ritm/")

  8. Reading the contents of the file — output the contents of the file (install_manifest.txt ) on the specified path (/home/ritm/build/newmodel_1/build):

    RITM_API.readFile(ritm, "install_manifest.txt"; path="/home/ritm/build/newmodel_1/build/")

  9. Getting the file to the current directory — get the specified file in Engee:

    RITM_API.getFile(ritm, "install_manifest.txt"; from="/home/ritm/build/newmodel_1/build/", to="")

    If the to parameter is not specified, the file will be saved in the current Engee directory.

  10. Getting information about memory — request data on memory consumption by the model:

    RITM_API.memInfo(ritm, "newmodel_1")

  11. View the last 10 lines of logs — get the last lines of the model execution log:

    RITM_API.getLog(ritm, 10)

    Use them to debug and diagnose the model.

  12. Create a screenshot and get the path to it — Take a screenshot from the machine.:

    RITM_API.getScreenshot(ritm, "example.png")

    The file will be saved in a temporary directory on the RHYTHM and the path to it will be returned as a string.

  13. Check the status of the model — make sure that the model is running on the target platform "RHYTHM":

    RITM_API.isRunning(ritm, "newmodel_1")

    If the function returns true, then the model is in progress.

  14. Get profiling data — Get model profiling data from the RHYTHM as a file or string:

    RITM_API.getData(ritm, "newmodel_1", "/user/", true)

  1. Integration of Engee with equipment

  2. Software control of RITM