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

Installs the specified support package into the current Engee directory.

Support packages are required to connect equipment (e.g. "Engee-Device-Manager") and function blocks, such as KPM "RITM" ("RITM-Engee-Blocks"), and to use the associated software control functions.

Arguments

package::String: name of the support package to be installed.

Examples

# Установка пакета поддержки для блоков РИТМ
engee.package.install("RITM-Engee-Blocks")

# Установка пакета поддержки для работы с оборудованием
engee.package.install("Engee-Device-Manager")
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 no updates are available, returns nothing.

Arguments

package::String: the name of the installed support package for which updates are checked.

Examples

# Проверка обновлений для пакета поддержки блоков РИТМ
engee.package.checkupdates("RITM-Engee-Blocks")

# Проверка обновлений для пакета поддержки оборудования
engee.package.checkupdates("Engee-Device-Manager")
engee.package.isinstalled(package::String)::Bool

Checks if the specified support package is installed in Engee. Returns true if the package is installed and false if it is not.

Arguments

package::String: name of the support package to check for.

Examples

# Проверка установки пакета поддержки блоков РИТМ
engee.package.isinstalled("RITM-Engee-Blocks")

# Проверка установки пакета для работы с оборудованием
engee.package.isinstalled("Engee-Device-Manager")
engee.package.update(package::String)::Nothing

Updates the specified support package to the latest available version.

If an upgrade is available, the old version of the package will be removed and replaced with the new version. Use this command to maintain compatibility with the current version of components.

Arguments

package::String: name of the installed support package to be upgraded.

Examples

# Обновление пакета поддержки блоков РИТМ
engee.package.update("RITM-Engee-Blocks")

# Обновление пакета управления устройствами
engee.package.update("Engee-Device-Manager")