Engee documentation

Connecting and configuring KPM RITM

Engee MIND allows the agent to work with machine instances RITM through Engee.Integrations: Check availability, manage models, get results, and perform preset maintenance operations.

To manage machine instances, use the application RITM.Manager.

Preparation

Before starting work, prepare:

  • The exact name of the existing instance of the RITM or IPv4 machine and the port of the target machine.

  • A computer with an Engee client.Integration* and network access to the machine.

  • Model .engee in the session Engee and her absolute path.

  • Execution mode: standalone or external.

  • Calculation step, interface parameters, test conditions and result criteria.

For the direct IP selector, the default port in the skills is — 8000; if the hardware is configured differently, specify the actual port. Do not select a car based on a similar name or an assumption about its address.

Activation procedure

  1. Ask to show the instances of the machines via engee_ritm_machine_card_manage. The list contains names, IP addresses, and ports, but does not confirm network availability.

  2. If there is no necessary record, explicitly specify the creation of an instance with the exact name, IP and port. After the change, refresh the application page. Engee.

  3. Check out Engee.Integration via engee_integration_status; required ready=true.

  4. If you are not ready, connect the client by Engee instructions.Integration, then repeat the check.

  5. Check the selected machine via engee_ritm_machine_system_manage. The verification takes place along the chain: session Engee → EDM → local client → HTTP API RITM.

  6. Read the firmware and support package versions via engee_ritm_machine_update_manage if it is necessary for the task.

Example:

Покажи экземпляры машин РИТМ. Для экземпляра `RITM-Lab-01` проверь Engee.Интеграции и затем доступность HTTP API машины. Прочитай версии прошивки и пакета поддержки. Не изменяй настройки, не запускай модели и не устанавливай обновления.

The name in the example should be replaced with the actual one. When selecting by name, the agent uses an entry from the list; when selecting by IP, it transmits target_ip and if necessary target_port. Both selection methods are not set at the same time.

Interpretation of the accessibility result

Result Interpretation

check_ok=true, connected=true

The HTTP API of the selected machine is available via a verifiable chain

check_ok=true, connected=false

Availability has not been confirmed; this is not proof of power off

check_ok=false, connected=null

The check failed; it needs to be examined error

Ping, the presence of an entry in the list, and the readiness of EDM do not replace this check. A successful API response also does not prove that the model, support package, and connected interfaces are ready for testing.

Build, Deploy, and Launch

Skill engee_ritm_machine_model_manage supports:

Mode Appointment

standalone

Independent execution; used by default if the mode is not set.

external

Interactive execution with data streams Engee; requires the source model and the live context of the current session

Before launching, set the model parameters, the step, the necessary interfaces, and the test impact. Next, the agent builds and deploys the model, runs it, checks the execution status, and receives Application Log.

На экземпляре `RITM-Lab-01` собери и разверни `/user/Controller/Controller.engee` в режиме standalone. Выполни согласованный испытательный сценарий, покажи состояние модели и последние строки Application Log. После испытания останови модель и получи результаты. Прошивку и пакет поддержки не обновляй.

If there is no suitable artifact or its mode is different, the path to the original one is needed for automatic assembly. .engee. If there is an explicit requirement for reassembly, the agent uses rebuild=true; without it, it is possible to launch an existing artifact. The launch accepted by the team does not yet confirm the successful completion of the test.

Firmware and Support package update

Version control does not install updates. If an update is necessary, formulate it as a separate task with the selected machine. For a complete update, the order is as follows:

  1. Update the firmware and wait for the successful completion.

  2. Perform the intended reboot and check the new version.

  3. Re-check the support package for the current computing core Engee.

  4. Update the support package if necessary and check the result.

These operations are not performed in parallel. The request to run the model itself is not a request to update the firmware or reboot the machine. A network update check error does not mean that there are no updates.

Getting artifacts

engee_ritm_machine_artifact_manage copies by default /home/ritm/data and /home/ritm/run from the selected machine to a separate directory inside /user/ritm-artifacts in the session. The relative structure of the files is preserved. Upon explicit request, you can select another valid directory inside /home/ritm.

Получи артефакты последнего испытания с `RITM-Lab-01` в сессию *{docs_engee}*. Покажи каталог назначения, число файлов и ошибки копирования. Затем предоставь выбранный мной файл для скачивания.

Check it out complete=true. With a partial result, the files already copied are saved, and the errors should be listed. To transfer a specific file from the session to the client, use file_download.

Script result

The report should contain the selected machine, communication status, versions (if necessary), model name and mode, actual execution status, logs, artifact paths, and comparison with test criteria. Deleting an instance from the list, deleting an expanded model, and stopping execution are different operations that must be specified explicitly.