2.2.0
ST Edge AI Core - Modular installer


ST Edge AI Core

ST Edge AI Core - Modular installer


ST Edge AI Core Technology 2.2.0



r1.1

Overview

The 'stedgeai-<osname>-onlineinstaller' application is a console utility and graphical user interface to install the different components of ST Edge AI Core. It offers the possibility to install the components needed for the selected targets. This tool allows also to create offline installers with the selected components for future usage on a machine not connected to the internet.

A 'maintenancetool' is automatically generated in the installation to add, update or remove components. The tool is based on QT Installer framework. If the installation directory is not owned by an administrator account, the installation can be done without administrative rights. If you want to install in a common system place, then administrative rights are required for the installation.

Supported '<osname>' name: windows, linux, mac or macarm

Available components

The modular installer comes with one component per target and dependencies on hidden components

Component Description Dependencies Supported Operating Systems
stedgeai0105.base common components for all targets (hidden) Windows, Linux, Mac, MacArm
stedgeai0105.core common components for STM32, STELLAR and ISPU targets (hidden) stedgeai0105.base Windows, Linux, Mac, MacArm
stedgeai0105.stm32mcu STM32Cube.AI component targeting all STM32 MCUs stedgeai0105.core stedgeai0105.stm32mculib Windows, Linux, Mac, MacArm
stedgeai0105.stm32mculib STM32Cube.AI inference libraries for the STM32 MCUs (hidden) OS independent
stedgeai0105.stneuralart STNeural-Art component targeting STM32N6 with Neural Art stedgeai0105.stm32mcu Windows, Linux, Mac, MacArm
stedgeai0105.stm32mpu STM32AI-MPU component targeting STM32 MPUs stedgeai0105.core Linux
stedgeai0105.stellarmcu StellarStudio.AI component targeting STELLAR MCUs stedgeai0105.core stedgeai0105.stellarmculib Windows
stedgeai0105.stellarmculib StellarStudio.AI inference libraries for the STELLAR MCUs (hidden) OS independent
stedgeai0105.ispu ISPU.AI component targeting sensors with an ISPU core stedgeai0105.core Windows, Linux, Mac, MacArm
stedgeai0105.mlc MLC.AI component targeting sensors with an embedded machine learning core stedgeai0105.base Windows, Linux, Mac, MacArm

Graphical User Interface installation

For graphical user interface based installation just double click on the stedgeai-osname-onlineinstaller command, select the installation directory, select the components to install, accept the license terms, optionally select the start menu shortcut and launch the installation.

Command line installation

Synopsis

Only the significant subset of options is displayed below, please refer to the QT Installer framework documentation for the full set of options

Usage: stedgeai-<osname>-onlineinstaller [options] command <args> <key=value>


Commands:
  in, install        - install default or selected packages and aliases - <pkg|alias ...>
  ch, check-updates  - show available updates information on maintenance tool
  up, update         - update all or selected packages - <pkg ...>
  rm, remove         - uninstall packages and their child components - <pkg ...>
  li, list           - list currently installed packages - <regexp for pkg>
  se, search         - search available aliases or packages - <regexp for pkg|alias>
    Note: The --filter-packages option can be used to specify additional filters for the search operation
    Note: The --type option can be used to specify the content type to search
  co, create-offline - create offline installer from selected packages - <pkg ...>
  cc, clear-cache    - clear contents of the local metadata cache
  pr, purge          - uninstall all packages and remove entire program directory

Options:
  -?, -h, --help                                 Displays help on commandline options.
  --help-all                                     Displays help, including generic Qt options.
  -v, --version                                  Displays version information.
  -d, --verbose                                  Verbose mode. Prints out more
                                                 information. Adding -d or
                                                 --verbose more than once
                                                 increases verbosity.
  --sp, --system-proxy                           Use system proxy on Windows
                                                 and Linux. This option has no
                                                 effect on macOS. (Default)
  --np, --no-proxy                               Do not use system proxy.
  --su, --start-updater                          Start application in updater
                                                 mode. This will override the
                                                 internal marker that is used to
                                                 distinguish which kind of
                                                 binary is currently running.
  -t, --root <directory>                         [CLI] Set installation root
                                                 directory.
  --oi, --offline-installer-name <filename>      [CLI] Set custom filename for
                                                 the generated offline
                                                 installer. Without this the
                                                 original filename is used with
                                                 an added "_offline-yyyy-MM-dd"
                                                 suffix.
  --ns, --no-size-checking                       Disable checking of free space
                                                 for installation target.
  --fp, --filter-packages <element=regex,...>    [CLI] Comma separated list of
                                                 additional key-value pair
                                                 filters used to query packages
                                                 with the search command. The
                                                 keys can be any of the possible
                                                 package information elements,
                                                 like "DisplayName" and
                                                 "Description".
  --cp, --cache-path <path>                      Sets the path used for local
                                                 metadata cache. The path must
                                                 be writable by the current
                                                 user.
  --type <package|alias>                         [CLI] Sets the type of the
                                                 given arguments for commands
                                                 supporting multiple argument
                                                 types, like "search". By
                                                 default aliases are searched
                                                 first, and if no matching
                                                 aliases are found, then
                                                 packages are searched with the
                                                 same search pattern.
  --am, --accept-messages                        [CLI] Accepts all message
                                                 queries without user input.
  --rm, --reject-messages                        [CLI] Rejects all message
                                                 queries without user input.
  --da, --default-answer                         [CLI] Automatically answers to
                                                 message queries with their
                                                 default values.
  --al, --accept-licenses                        [CLI] Accepts all licenses
                                                 without user input.
  -c, --confirm-command                          [CLI] Confirms starting of
                                                 installation, update or removal
                                                 of components without user
                                                 input.
  --mco, --max-concurrent-operations <threads>   Specifies the maximum number
                                                 of threads used to perform
                                                 concurrent operations in the
                                                 unpacking phase of components.
                                                 Set to a positive number, or 0
                                                 (default) to let the
                                                 application determine the ideal
                                                 thread count from the amount of
                                                 logical processor cores in the
                                                 system.

Arguments:
  Command                                        Command to be run by
                                                 installer. Note that this
                                                 feature may be disabled by
                                                 vendor.
  Args                                           Extra arguments for command,
                                                 each separated by space.
  InstallerValue                                 Key-value pair to be set
                                                 internally by the framework.

Creating an offline installer

From the provided online installer tool, you can create an offline installer tool using the following command. The offline creation tool will automatically download the selected components and the associated components dependencies.

The offline installer tool can be used can be used graphically or by command line. In command line mode the same arguments as described above can be used.

stedgeai-<osname>-onlineinstaller create-offline [packages]

for example 

 ./stedgeai-windows-onlineinstaller --root C:/tmp/stedgeai --offline-installer-name  stedgeai-windows-offline create-offline stedgeai.stm32mcu

Installation maintenance

After installation, at the root of the installation directory, a 'maintancetool' is created

The maintancetool can be used graphically or by command line with the same arguments as the installation tool

With the maintenance tool you can

When a component is installed using the offline installer the maintenance tool can only be used for uninstallation of the package.

For the online version, it will query the online repository for the available versions and propose an upgrade of the installed components.