FMI.jl Documentation
- FMI.jl Documentation
- What is FMI.jl?
- How can I use FMI.jl?
- What is currently supported in FMI.jl?
- What is under development in FMI.jl?
- What Platforms are supported?
- Interested in Hybrid Modelling in Julia using FMUs?
- FMI.jl Index
- Library functions
- Creation, Destruction FMU
- Platform and Version number
- Initialization, Termination and Destruction
- Get/Set variable values
- FMU state Functions
- Partial Derivatives
- CoSimulation specific Functions
- ModelExchange specific Functions
- Simuation results
- Parsing variable names to ValueReferences
- Opening and closing FMUs
- Simulate FMU
- Examples
What is FMI.jl?
FMI.jl is a free-to-use software library for the Julia programming language, which integrates FMI (fmi-standard.org): load, instantiate, parameterize and simulate FMUs seamlessly inside the Julia programming language!
How can I use FMI.jl?
- open a Julia-Command-Window, activate your prefered environment
- goto package manager using
]
- type
add "https://github.com/ThummeTo/FMI.jl"
What is currently supported in FMI.jl?
- simulation / plotting of CS- and ME-FMUs
- event-handling for discontinuous ME-FMUs
- the full FMI command set (except
getFMUState
andsetFMUState
) - ...
What is under development in FMI.jl?
- Linux support
- documentation
- more examples
- support for
getFMUState
andsetFMUState
- FMI 3.0 and SSP 1.0 support
- ...
What Platforms are supported?
FMI.jl is tested under Julia 1.5.4 on Windows.
Interested in Hybrid Modelling in Julia using FMUs?
See FMIFlux.jl.
FMI.jl Index
FMI.fmi2CancelStep
FMI.fmi2CompletedIntegratorStep!
FMI.fmi2DeSerializeFMUstate
FMI.fmi2DoStep
FMI.fmi2EnterContinuousTimeMode
FMI.fmi2EnterEventMode
FMI.fmi2EnterInitializationMode
FMI.fmi2ExitInitializationMode
FMI.fmi2FreeFMUstate
FMI.fmi2GetBoolean
FMI.fmi2GetBoolean!
FMI.fmi2GetBooleanStatus
FMI.fmi2GetContinuousStates
FMI.fmi2GetDerivatives
FMI.fmi2GetDirectionalDerivative
FMI.fmi2GetDirectionalDerivative!
FMI.fmi2GetEventIndicators
FMI.fmi2GetFMUstate
FMI.fmi2GetInteger
FMI.fmi2GetInteger!
FMI.fmi2GetIntegerStatus
FMI.fmi2GetNominalsOfContinuousStates
FMI.fmi2GetReal
FMI.fmi2GetReal!
FMI.fmi2GetRealOutputDerivatives
FMI.fmi2GetRealStatus
FMI.fmi2GetStatus
FMI.fmi2GetString
FMI.fmi2GetString!
FMI.fmi2GetStringStatus
FMI.fmi2GetTypesPlatform
FMI.fmi2GetVersion
FMI.fmi2Instantiate
FMI.fmi2Load
FMI.fmi2NewDiscreteStates
FMI.fmi2Reset
FMI.fmi2SerializeFMUstate
FMI.fmi2SerializedFMUstateSize
FMI.fmi2SetBoolean
FMI.fmi2SetContinuousStates
FMI.fmi2SetDebugLogging
FMI.fmi2SetFMUstate
FMI.fmi2SetInteger
FMI.fmi2SetReal
FMI.fmi2SetRealInputDerivatives
FMI.fmi2SetString
FMI.fmi2SetTime
FMI.fmi2SetupExperiment
FMI.fmi2Simulate
FMI.fmi2SimulateCS
FMI.fmi2SimulateME
FMI.fmi2SimulationResultGetTime
FMI.fmi2SimulationResultGetValues
FMI.fmi2SimulationResultGetValuesAtIndex
FMI.fmi2String2ValueReference
FMI.fmi2Terminate
FMI.fmi2Unload
FMI.fmi2Unzip
FMI.fmi2ValueReference2String