Engee documentation

Programme management functions for engee.package packages

This page contains all available engee.package package management functions in Engee.

package methods

engee.package.install(package::String)::Nothing
engee.package.install(package::String, zip_path::String)::Nothing

Installs 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 zip archive name 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(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(package::String)::Bool

Checks 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(package::String)::Nothing

Updates 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")

# Updating the Device Management Package
engee.package.update("Engee-Device-Manager")