Skip to content

Install Artek Utilities

Installation takes four steps: download the build for your Ignition line, remove the older module if it is installed, install the new file in the gateway, then accept the license and certificate.

1. Download and check the file

Download the build that matches your gateway from artekis.io/artek-utilities.html:

  • Ignition 8.1: Artek-Utilities-ign81.modl (requires Ignition 8.1.0 or later)
  • Ignition 8.3: Artek-Utilities-ign83.modl (requires Ignition 8.3.0 or later)

The download page lists the SHA-256 checksum of each file. Check the file before you install it, for example on Linux or macOS:

sha256sum Artek-Utilities-ign83.modl

On Windows, run Get-FileHash Artek-Utilities-ign83.modl -Algorithm SHA256 in PowerShell. The result must match the checksum on the download page. The checksums for 1.0.0 are also listed in the release notes.

2. Remove the older Artek-Utilities module, if present

An earlier Artek-Utilities module was published under the module ID io.artekis.Artek-Utilities. Version 1.0.0 replaces it under a new ID, com.artek.utilities. If the older module is in your gateway's module list, uninstall it before you install 1.0.0.

3. Install the module in the gateway

  1. Open the gateway's web page and sign in as an administrator.
  2. Open the module list:
    • on Ignition 8.1: Config, then System, then Modules;
    • on Ignition 8.3: Platform, then System, then Modules.
  3. Choose Install or Upgrade and upload the .modl file you downloaded.

4. Accept the license and certificate

  1. Read and accept the license (Apache License 2.0).
  2. The first time you install an Artek module, the gateway asks you to trust the Artek, LLC certificate. Check that its SHA-1 fingerprint is 99e472815b3417abab93e1c744c76699c73375d2, then accept it.

The functions are then available to every script on the gateway.

Verify the install

  1. In the module list, find Artek-Utilities. Its version starts with 1.0.0 and its state is running.
  2. If a Designer was open during the install, close it and open it again so it loads the new functions. Relaunch any open Vision Clients for the same reason.

  3. In the Designer, open the Script Console and run:

    import jarray
print system.artek.imagehelper.getByteArraySize(jarray.zeros(2048, 'b'))

    It prints 2, the size in kilobytes of a 2,048-byte array. If you get an AttributeError instead, the module is not loaded in this Designer: check the module list, then reopen the Designer.

Upgrade

To install a newer build of Artek Utilities over 1.0.0, open the same module page, choose Install or Upgrade and upload the new file. Read the release notes first.