Программное управление РИТМ
|
Чтобы работать с функциями программного управления КПМ «РИТМ» в Engee, установите подсистему Engee.Интеграции: |
На этой странице представлены все доступные функции программного управления КПМ «РИТМ» в Engee.
Методы RITM
#
EngeeDeviceManager.Targets.RITM.Ritm — Type
#
EngeeDeviceManager.Targets.RITM.compile_model — Method
ritm.compile_model(model, is_ext_mode)Собирает модель на РИТМе.
Аргументы
-
model::Model: объект типа Model. -
is_ext_mode::Bool: флаг, указывающий режим выполнения модели.true— модель выполняется в интерактивном режиме.false— модель выполняется в независимом режиме.
Примеры
model = engee.gcm()
ritm.upload_model(model)
ritm.generate_executable_code(model, false)
ritm.compile_model(model, false)#
EngeeDeviceManager.Targets.RITM.fetch_log_ritmpipe — Method
#
EngeeDeviceManager.Targets.RITM.generate_executable_code — Method
ritm.generate_executable_code(model, is_ext_mode)Генерирует Си-обвязку на РИТМе.
Аргументы
-
model::Model: объект типа Model. -
is_ext_mode::Bool: флаг, указывающий режим выполнения модели.true— модель выполняется в интерактивном режиме.false— модель выполняется в независимом режиме.
Примеры
model = engee.gcm()
ritm.upload_model(model)
ritm.generate_executable_code(model, false)#
EngeeDeviceManager.Targets.RITM.get_access_token — Method
#
EngeeDeviceManager.Targets.RITM.get_file — Method
#
EngeeDeviceManager.Targets.RITM.get_files_list — Method
#
EngeeDeviceManager.Targets.RITM.get_profiling_data — Function
#
EngeeDeviceManager.Targets.RITM.get_ritm_screenshot — Function
#
EngeeDeviceManager.Targets.RITM.get_running_model — Method
#
EngeeDeviceManager.Targets.RITM.is_connected — Method
#
EngeeDeviceManager.Targets.RITM.is_running — Method
#
EngeeDeviceManager.Targets.RITM.model_mem_info — Function
#
EngeeDeviceManager.Targets.RITM.read_file — Method
#
EngeeDeviceManager.Targets.RITM.remove_file — Method
#
EngeeDeviceManager.Targets.RITM.set_url — Method
ritm.set_url(url)Устанавливает адрес машины РИТМ.
Аргументы
url::String: адрес машины РИТМ.
Примеры
ritm = Targets.RITM.Ritm()
ritm.set_url("http://192.168.56.3:8000/")#
EngeeDeviceManager.Targets.RITM.start_model — Function
ritm.start_model(model)Запускает модель на РИТМе.
Аргументы
model::Model: объект типа Model.
Примеры
ritm.start_model(model)#
EngeeDeviceManager.Targets.RITM.start_stream — Method
#
EngeeDeviceManager.Targets.RITM.stop_model — Method
ritm.stop_model()Останавливает модель на РИТМе.
Аргументы
Отсутствуют (метод вызывается от объекта РИТМ).
Примеры
ritm.stop_model()#
EngeeDeviceManager.Targets.RITM.upload_file — Method
#
EngeeDeviceManager.Targets.RITM.upload_model — Method
ritm.upload_model(model)Загружает модель на РИТМ.
Аргументы
model::Model: объект типа Model.
Примеры
model = engee.gcm()
ritm.upload_model(model)#
EngeeDeviceManager.Targets.RITM_API.getData — Function
RITM_API.getData(ritm::Any, model_name::String, file_path::String, in_file::Bool = false)Возвращает результат профилирования модели на РИТМе. В зависимости от значения in_file, результат может быть возвращен как строка либо сохранен в файл по указанному пути.
Аргументы
-
ritm::Any: объект целевой платформы РИТМ. Задается с помощью последовательных командritm = Targets.RITM.Ritm()иTargets.RITM.set_url(ritm, "http://192.168.56.3:8000/"). -
model_name::String: имя модели, для которой запрашиваются данные профилирования. -
file_path::String: путь, по которому сохранить результат (еслиin_file = true). Еслиin_file = false, значение игнорируется. -
in_file::Bool = false: указывает, как вернуть результат. Еслиtrue, данные сохраняются в файл поfile_path. Еслиfalse, возвращается строка с результатом.
Примеры
# Получает данные профилирования как строку
result = RITM_API.getData(ritm, "newmodel_1", "", false)
# Сохраняет данные в файл на РИТМе
RITM_API.getData(ritm, "newmodel_1", "/user/profile.txt", true)#
EngeeDeviceManager.Targets.RITM_API.getFile — Method
RITM_API.getFile(ritm::Any, file_name::String; from=/mydir::String, to=::String)Получает указанный файл file_name из директории /home/ritm/build/model_name/build/, где model_name — имя модели в Engee.
Аргументы
-
ritm::Any: объект целевой платформы РИТМ. Задается с помощью последовательных командritm = Targets.RITM.Ritm()иTargets.RITM.set_url(ritm, "http://192.168.56.3:8000/"). -
file_name::String: имя интересующего файла. -
from=/mydir::String: путь до директории с интересующим файлом (по умолчанию/home/ritm/build/model_name/build/). -
to=::String: путь до директории в Engee для сохранения файла (по умолчанию в текущей).
Примеры
RITM_API.getFile(ritm, "install_manifest.txt"; from="/home/ritm/build/newmodel_1/build/", to="")#
EngeeDeviceManager.Targets.RITM_API.getLog — Method
RITM_API.getLog(ritm::Any, num::Int64)Возвращает указанное число строк логов выполнения модели на РИТМе.
Аргументы
-
ritm::Any: объект целевой платформы РИТМ. Задается с помощью последовательных командritm = Targets.RITM.Ritm()иTargets.RITM.set_url(ritm, "http://192.168.56.3:8000/"). -
num::Int64: число выводимых строк из логов.
Примеры
RITM_API.getLog(ritm, 10)#
EngeeDeviceManager.Targets.RITM_API.getScreenshot — Method
RITM_API.getScreenshot(ritm::Any, filename::String = "screenshot.png")Создает скриншот на целевой платформе РИТМ и возвращает путь к сохранённому изображению. Снимок экрана сохраняется во временной директории на машине РИТМ. Имя выходного файла можно указать явно; по умолчанию используется "screenshot.png".
Аргументы
-
ritm::Any: объект целевой платформы РИТМ. Задается с помощью последовательных командritm = Targets.RITM.Ritm()иTargets.RITM.set_url(ritm, "http://192.168.56.3:8000/"). -
filename::String = "screenshot.png": имя файла, в который будет сохранен скриншот (на стороне РИТМа).
Примеры
# Создает скриншот и получает путь к нему
path = RITM_API.getScreenshot(ritm, "example.png")#
EngeeDeviceManager.Targets.RITM_API.isConnected — Method
RITM_API.isConnected(ritm::Any)Проверяет доступность РИТМа.
Аргументы
ritm::Any: объект целевой платформы РИТМ. Задается с помощью последовательных команд ritm = Targets.RITM.Ritm() и Targets.RITM.set_url(ritm, "http://192.168.56.3:8000/").
Примеры
RITM_API.isConnected(ritm)#
EngeeDeviceManager.Targets.RITM_API.isRunning — Method
RITM_API.isRunning(ritm::Any, model_name::String)Проверяет, выполняется ли указанная модель на целевой платформе РИТМ. Возвращает true, если модель с заданным именем в данный момент в процессе выполнения на машине РИТМ, и false если не выполняется.
Аргументы
-
ritm::Any: объект целевой платформы РИТМ. Задается с помощью последовательных командritm = Targets.RITM.Ritm()иTargets.RITM.set_url(ritm, "http://192.168.56.3:8000/"). -
model_name::String: имя модели, состояние которой необходимо проверить.
Примеры
# Проверяет, запущена ли модель "newmodel_1"
is_active = RITM_API.isRunning(ritm, "newmodel_1")#
EngeeDeviceManager.Targets.RITM_API.listFiles — Method
RITM_API.listFiles(ritm::Any, path::String)Выводит список файлов в указанной директории.
Аргументы
-
ritm::Any: объект целевой платформы РИТМ. Задается с помощью последовательных командritm = Targets.RITM.Ritm()иTargets.RITM.set_url(ritm, "http://192.168.56.3:8000/"). -
path::String: путь до интересующей директории.
Примеры
RITM_API.listFiles(ritm, "/home/ritm/")#
EngeeDeviceManager.Targets.RITM_API.memInfo — Function
RITM_API.memInfo(ritm::Any, model::String)Выводит информацию о потребляемой моделью памяти.
Аргументы
-
ritm::Any: объект целевой платформы РИТМ. Задается с помощью последовательных командritm = Targets.RITM.Ritm()иTargets.RITM.set_url(ritm, "http://192.168.56.3:8000/"). -
model::String: имя модели. Если оставить пустым"", то вернет результат профилирования системы в виде[total, used, free]. Если указать имя модели, то вернет количество байт памяти, потребляемой моделью.
Примеры
RITM_API.memInfo(ritm, "newmodel_1")#
EngeeDeviceManager.Targets.RITM_API.readFile — Method
RITM_API.readFile(ritm::Any, file_name::String; path=/mydir::String)Выводит содержимое указанного файла file_name из директории /home/ritm/build/model_name/build/, где model_name — имя модели в Engee.
Аргументы
-
ritm::Any: объект целевой платформы РИТМ. Задается с помощью последовательных командritm = Targets.RITM.Ritm()иTargets.RITM.set_url(ritm, "http://192.168.56.3:8000/"). -
file_name::String: имя интересующего файла. -
path=/mydir::String: путь до директории с интересующим файлом (по умолчанию/home/ritm/build/model_name/build/).
Примеры
RITM_API.readFile(ritm, "install_manifest.txt"; path="/home/ritm/build/newmodel_1/build/")