Software package management functions engee.package
This page contains all the available software package management functions. engee.package in Engee.
Methods package
#
engee.package.install — Function
engee.package.install(package::String)::Nothing
engee.package.install(package::String, zip_path::String)::NothingInstalls the specified support package in the directory along the path /internal_persistent_vol/support_packages/.
Support packages are required to connect hardware (for example, "Engee-Device-Manager") and functional blocks, such as KPM "RITM" ("RITM-Engee-Blocks"), as well as for the use of related software control functions.
Arguments
-
package::String: Name of the support package you want to install. -
zip_path::String: the path to the zip archive in the formatназвание_пакета-версия.zip. The argument is specified by name (zip_path="..."). Specifying the version of the support package in the name of the zip archive is mandatory.
Examples
# Installing a support package for RITM blocks
engee.package.install("RITM-Engee-Blocks")
# Installing a Hardware support package
engee.package.install("Engee-Device-Manager")
# Installing the support package from a zip archive
engee.package.install("Engee-Device-Manager", zip_path="/distr/edmv0.0.zip")#
engee.package.checkupdates — Function
engee.package.checkupdates(package::String)::Union{String, Nothing}Checks for available updates for the specified support package.
If an update is available, it returns a string with the new version number. If there are no updates, it returns nothing.
Arguments
package::String: The name of the installed support package for which the update check is performed.
Examples
# Checking for updates to the RITM block support package
engee.package.checkupdates("RITM-Engee-Blocks")
# Checking for Hardware Support Package updates
engee.package.checkupdates("Engee-Device-Manager")#
engee.package.isinstalled — Function
engee.package.isinstalled(package::String)::BoolChecks whether the specified support package is installed in Engee. Returns true if the package is installed, and false,if missing.
Arguments
package::String: name of the support package to check for.
Examples
# Checking the installation of the RITM block support package
engee.package.isinstalled("RITM-Engee-Blocks")
# Checking the installation of the hardware package
engee.package.isinstalled("Engee-Device-Manager")#
engee.package.update — Function
engee.package.update(package::String)::NothingUpdates the specified support package to the latest available version.
If an update is available, the old version of the package will be removed and replaced with a new one. Use this command to maintain compatibility with the current version of the components.
Arguments
package::String: Name of the installed support package that needs to be updated.
Examples
# Updating the RITM Block support package
engee.package.update("RITM-Engee-Blocks")
# Hardware Support Package Update
engee.package.update("Engee-Device-Manager")#
engee.package.getdemos — Function
engee.package.getdemos(package)::NothingLoads a directory with sample models for the selected package.
Arguments
package::String: name of the installed support package to download the directory with sample models for.
Examples
# Uploading a directory with examples of RITM block models
engee.package.getdemos("RITM-Engee-Blocks")
# Uploading a directory with examples of hardware block models
engee.package.getdemos("Engee-Device-Manager")#
engee.package.start — Function
engee.package.start(package::String)::NothingLaunches the server program of the selected package.
Arguments
package::String: The name of the installed support package whose server program you want to run.
Examples
# Launches a server hardware support program
engee.package.start("Engee-Device-Manager")
# Launches the RITM server program
engee.package.start("RITM-Engee-Blocks")