AnyMath 文档

欧拉的软件管理

本页显示了欧拉的所有可用软件控制功能 AnyMath .

使用欧拉软件控制功能 AnyMath ，按照指定的方式安装硬件支持包 文章. 安装后，运行:

using Main.EngeeDeviceManager.EULER_API

接下来，您需要创建一个会话对象:

session = EULER_API.createSession()

所有方法都采用第一个参数 会议 -会话对象。

状态代码不会发送出去：如果发生错误，该方法将抛出异常及其描述。

 
EULER_API.closeProject(session) -> Nothing

关闭当前打开的项目。释放项目资源，但会话仍保持活动状态。

如果发生错误，将抛出异常。

EULER_API.closeSession(session) -> Nothing

Terminates the session with EILER. Frees all resources and closes the solver. After calling this function, the object session is no longer valid.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

EULER_API.createSession(euler_path::String="") -> session

Creates a session for working with the EULER solver. Initialises the solver core.

Returns session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession}-- the session object, which is passed to all other methods.euler_path::String: the path to the EYLER executable. By default, euler_path="" — auto-detection.

EULER_API.getCurrentTime(session) -> Float64

Returns the current model time in seconds.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

EULER_API.getLastProject(session) -> String

Returns the full path to the .elr file of the latest EULER project. Useful for restoring the state after a restart.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

EULER_API.getRigidBodyCount(session) -> Int

Returns the number of solid bodies in the current project.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

EULER_API.getRigidBodyPos(session, index=0) -> Vector{Float64}

Returns an array of 12 elements: the centre-of-mass coordinates (X, Y, Z) and a 3×3 orientation matrix (9 elements, column-oriented).

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

  • index::Int64: solid body index; indexing starts from 0. By default, 0.

EULER_API.getSensorUnits(session, name) -> String

Returns a string containing the sensor’s units of measurement in the SI system based on its name, for example, "Н", "м", "м/с".

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

  • name::String : sensor name.

EULER_API.getSensorValue(session, name) -> Float64

Returns the current value of the sensor by name in SI units. The value corresponds to the most recent calculated data point.

An exception is thrown if an error occurs.

Arguments

  • : session object.

  • name::String: sensor name (e.g., "fx_sensor", "X", "Y").

EULER_API.getUserCommands(session) -> String

返回包含可用用户命令名称的字符串。命令以";" 分隔。在打开项目后的任何 模式下 均可使用。

参数

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : 会话对象。

@binding: Main.EngeeDeviceManager.EULER_API.createSession @typesig: Tuple{String}

EULER_API.getVersion(session) -> String

返回 EILER 求解器的版本号，格式为字符串（例如，"13.05.43" ）。

参数

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} ：会话对象。

EULER_API.journalLoadPoint(session, index) -> Nothing

Loads the log point by index into the current context. After loading, getSensorValue will return the sensor values for this point, rather than for the last calculated one.

An exception is thrown on error.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

  • index::Int64: point index (indexes are numbered starting from 0).

EULER_API.journalSensorValues(session, name) -> Vector{Float64}

Returns an array of sensor values at all points in the calculation log in chronological order.

An exception is thrown if an error occurs.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

  • name::String : sensor name.

EULER_API.journalSize(session) -> Int

Returns the number of points stored in the calculation log. The value 0 corresponds to an empty log.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

EULER_API.journalTime(session, index) -> Float64

Returns the model time in seconds for the log point at the specified index.

Arguments

session object.

  • index::Int64: point index (indexes start at 0).

EULER_API.openProject(session, path) -> String

打开 EILER 项目（.elr 文件）。打开后，命令、传感器和参数均可使用。返回 已加载项目的路径（字符串形式）；若发生错误，则抛出异常。

参数

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : 会话对象。

  • path::String ：.elr 文件的完整路径。

EULER_API.runAnyCommand(session, command, step=1) -> Nothing

Runs a user-defined command without a time limit. The calculation runs until the command naturally completes. Available in exploration mode only.

An exception is thrown if an error occurs.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

  • command::String : command name.

  • step::Int64: output step. By default, 1.

EULER_API.runCommand(session, command, calc_time=10.0, step=1.0) -> Nothing

Runs a user command with a time limit. The calculation will stop when calc_time seconds of model time have elapsed or when the command completes — whichever comes first. Available only in exploration mode (setCalcRegime).

An exception is thrown if an error occurs.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

  • command::String: command name (from the list getUserCommands).

  • calc_time::Float64: maximum calculation duration in seconds of model time. By default: 10.0.

  • step::Float64: output step for this command. By default, 1.0 (every integrator step).

EULER_API.saveProject(session) -> Nothing

保存当前项目。更改将写入原始 .elr 文件。

发生错误时将抛出异常。

参数

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : 会话对象。

EULER_API.saveResults(session, path) -> Nothing

Saves the calculation results to an .epp (Euler Project Package) file.

An exception is thrown if an error occurs.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

  • path::String : path to save the .epp file.

EULER_API.setCalcRegime(session) -> Nothing

Переводит проект в режим исследования (расчета). В этом режиме доступен запуск команд (runCommand, runAnyCommand) и чтение датчиков. Изменение скаляров недоступно.

При ошибке выбрасывается исключение.

Аргументы

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession}: объект сеанса.

EULER_API.setEditRegime(session) -> Nothing

将项目切换至编辑模式。在此模式下，可通过setScalar 修改参数（标量）。无法启动 计算。

发生错误时将抛出异常。

参数

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} ：会话对象。

EULER_API.setOutputParam(session, step_out=1, time_out=0.0, before_event=false, after_event=false) -> Nothing

Configures the parameters for outputting results to the calculation log.

An exception is thrown if an error occurs.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

  • step_out::Int64: output step. Every Nth calculation point is included in the log. By default, 1.

  • time_out::Float64: output frequency in model time, in seconds. By default, 0.0 (disabled; only step_out is used).

  • before_event::Bool: whether to save a point before an event. By default, false — do not save.

  • after_event::Bool: whether to save a point after an event. By default, false — do not save.

EULER_API.setCalcRegime(session) -> Nothing

Puts the project into exploration (calculation) mode. In this mode, it is possible to run commands (runCommand, runAnyCommand) and read sensors. Modifying scalars is not permitted.

An exception is thrown if an error occurs.

@binding: Main.EngeeDeviceManager.EULERAPI.setCalcRegime @typesig: Tuple{Main.EngeeDeviceManager.EULERAPI.EulerSession}

Sets the value of a scalar parameter by name. Only available in edit mode (setEditRegime).

An exception is thrown if an error occurs.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : the session object.

  • name::String: the name of the scalar (e.g., "FX", "mass").

  • value::Float64 : the new value of the scalar.

EULER_API.startCalc(session) -> Nothing

Resets the model time to 0.0 (start position) and initialises the calculation. Called once before the first command runCommand or runAnyCommand.

An exception is thrown if an error occurs.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

EULER_API.stopCalc(session) -> Nothing

Stops the current calculation. Can be called at any time after running runCommand or runAnyCommand. The time of the stop can be obtained via getCurrentTime.

An exception is thrown if an error occurs.

Arguments

  • session::Tuple{Main.EngeeDeviceManager.EULER_API.EulerSession} : session object.

操作模式

打开后，项目处于编辑模式—您可以打开/关闭项目，通过以下方式更改参数（标量 [医]集. 在此模式下无法启动计算。 要运行模型，请切换到研究模式（n.集,集），之后就可以运行命令（n.跑动,跑动, [医][医][医][医]）和在计算过程中读取传感器（getSensorValue,getSensorValue, 期刊价值），但更改标量将被阻止。 模式之间的切换是通过 [医]集 和 n.集,集.

示例：模拟投掷一个重量为1公斤，直径为20厘米的球，并显示轨迹

安装后 硬件支持包完成:

using Main.EngeeDeviceManager
using Main.EngeeDeviceManager.EULER_API
using Main.EngeeDeviceManager.UTILS_API

创建会话:

session = EULER_API.createSession()
ver = EULER_API.getVersion(session)
println("Версия ЭЙЛЕР: $ver")
Версия ЭЙЛЕР: Solver 13.05.43.beta Pro (Windows x64)

上传测试项目:

engee.package.getdemos("Engee-Device-Manager")
"/user/Engee-Device-Manager-demos"

首先，我们将复制测试文件。演示文件夹中的elr文件 AnyMath 至 用户的计算机通过模块 Utils的:

# Создаем объект Utils для файловых операций
utils = UTILS_API.Utils()

# Определяем пути к демонстрационному проект ЭЙЛЕР в Engee и директории, куда будет скопирован проект
euler_local_project_path = "/user/Engee-Device-Manager-demos/example_euler/sample_project.elr"
host_project_dir = raw"C:\Users\Public\Engee"

# Создаем тестовую директорию и загружаем проект на хост
UTILS_API.createFolder(utils, host_project_dir, "")
UTILS_API.uploadFile(utils, euler_local_project_path, host_project_dir)

println("Проект загружен в $host_project_dir")
Проект загружен в C:\Users\Public\Engee

打开项目并启动计算:

# Открываем проект
project_path = joinpath(host_project_dir, "sample_project.elr")
EULER_API.openProject(session, project_path)
println("Проект открыт: $project_path")

# Получаем список доступных команд
cmds = EULER_API.getUserCommands(session)
println("Доступные команды: $cmds")

# Переключаем в режим исследования проекта
EULER_API.setCalcRegime(session)
println("Режим исследования проекта")

# Настраиваем вывод каждого 10-го шага
EULER_API.setOutputParam(session, 10, 0.0)

# Запускаем расчет на 15 секунд
EULER_API.runCommand(session, "RK4_coarse", 15.0)
println("Расчет запущен")
Проект открыт: C:\Users\Public\Engee/sample_project.elr
Доступные команды: RK4_fine;RK4_coarse;
Режим исследования проекта
Расчет запущен

取得成果:

# Получаем все точки из журнала расчета
x_vals = EULER_API.journalSensorValues(session, "X")
y_vals = EULER_API.journalSensorValues(session, "Y")

n_points = length(x_vals)
println("Получено $n_points точек")

# Выводим первые и последние точки
println("Первая точка: X=$(round(x_vals[1], digits=2)) м, Y=$(round(y_vals[1], digits=2)) м")
if n_points > 1
    println("Последняя точка: X=$(round(x_vals[end], digits=2)) м, Y=$(round(y_vals[end], digits=2)) м")
end
Получено 1447 точек
Первая точка: X=0.0 м, Y=0.0 м
Последняя точка: X=1019.72 м, Y=-0.0 м

轨迹的可视化:

using Plots

# Получаем время каждой точки (значения датчик "t")
t_vals = EULER_API.journalSensorValues(session, "t")

# График высоты от времени
plot(t_vals, y_vals,
    xlabel = "Время, с",
    ylabel = "Высота Y, м",
    title = "Траектория броска шара
    D = 20 см
    m = 1 кг",
    legend = false,
    linewidth = 2,
    color = :blue,
    size = (600, 400)
)

hline!([0.0], color = :orange, linewidth = 1, linestyle = :dash, label = "Земля")

euler functions 1

完成工作:

EULER_API.closeSession(session)
println("Сеанс завершен")
会议结束了