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: /internal_persistent_vol/support_packages/.
Support packages are required to connect hardware (for example, "Engee-Device-Manager") and functional blocks, such as the ‘RITM’ KPM ("RITM-Engee-Blocks"), as well as for the usage of associated software control functions.
Arguments
-
package::String: the name of the support package to be installed. -
zip_path::String: the path to a ZIP archive in the formatназвание_пакета-версия.zip. The argument is specified by name (zip_path="..."). The support package version must be included in the ZIP archive name.
Examples
# Install the support package for RITM blocks
engee.package.install("RITM-Engee-Blocks")
# Installing the support package for working with hardware
engee.package.install("Engee-Device-Manager")
# Installing the support package from the 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 whether any updates are available for the specified support package.
If an update is available, it returns a string containing the new version number. If no updates are available, it returns '` nothing ’.
Arguments
package::String: the name of the installed support package for which the update check is being performed.
Examples
# Check for updates for the RITM block support package
engee.package.checkupdates("RITM-Engee-Blocks")
# Check for updates for the hardware support package
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 it is not.
Arguments
package::String: the name of the support package whose presence is to be checked.
Examples
# Checking the installation of the RITM block support package
engee.package.isinstalled("RITM-Engee-Blocks")
# Checking the installation of the package for working with hardware
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 the new one. Use this command to maintain compatibility with the latest version of the components.
Arguments
-
package::String: the name of the installed support package that needs updating.
Examples
# Updating the RITM block support package
engee.package.update("RITM-Engee-Blocks")
# Updating the hardware support package
engee.package.update("Engee-Device-Manager")#
engee.package.getdemos — Function
engee.package.getdemos(package)::NothingDownloads a directory containing model examples for the selected package.
Arguments
package::String: the name of the installed support package for which you wish to download the directory containing model examples.
Examples
# Download the directory containing example RITM block models
engee.package.getdemos("RITM-Engee-Blocks")
# Download the directory containing example models of equipment blocks
engee.package.getdemos("Engee-Device-Manager")#
engee.package.start — Function
engee.package.start(package::String)::NothingRuns the server programme for the selected package.
Arguments
package::String: the name of the installed support package whose server programme is to be run.
Examples
# Starts the hardware support server programme
engee.package.start("Engee-Device-Manager")
# Starts the RITM server programme
engee.package.start("RITM-Engee-Blocks")