Upgrading Xiid Software

This guide walks you through the process of upgrading your Xiid software products. The upgrade process is consistent across all Xiid products: Connector, Commander, and STLink.

WARNING

The upgrade may briefly disrupt connectivity; perform upgrades during maintenance windows as needed.

Prerequisites

• Administrator/root access to the target system
• Active internet connection
• Access to the Commander Portal

Upgrade Steps

1. Access the Commander Portal

• Open your web browser and log into the Commander Portal.

2. Locate and Download the Binary

• Navigate to the Downloads tab in the left-hand menu.
• Identify the download link that matches the operating system and CPU architecture of the product you would like to upgrade.
• Click to download the file to your local system.

3. Prepare for Installation

• If the target system you intend to upgrade is not your local host, copy the binary file to the machine you would like to upgrade.
• Open an administrator command prompt (Windows) or terminal (Linux/macOS).
• Change to the directory containing the downloaded binary file.

Product-Specific Commands

Xiid Connector

Set File Permissions (Linux/macOS):

Linux

chmod +x connector_4.0.*

Installation Commands:

Windows

connector_4.0.*.exe

Linux

sudo ./connector_4.0.*

Xiid Commander

Set File Permissions (Linux/macOS):

Linux

chmod +x commander_4.0.*

Installation Commands:

Windows

commander_4.0.*.exe

Linux

sudo ./commander_4.0.*

STLink

Set File Permissions (Linux/macOS):

Linux

chmod +x stlink_4.0.*

macOS

chmod +x stlink_4.0.*

Installation Commands:

Windows

stlink_4.0.*.exe

Linux

sudo ./stlink_4.0.*

macOS

sudo ./stlink_4.0.*

Verification

After installation, verify the upgrade was successful:

Connector

Sign into your Connector Portal and verify the new version of the Connector in the Dashboard view. You can also run the executable with the version command line argument. The executable can be found under Program Files on Windows and /opt/Xiid/ on Linux.

Commander

Sign into your Commander Portal and verify the new version of the Commander in the Dashboard view. You can also run the executable with the version command line argument. The executable can be found under Program Files on Windows and /opt/Xiid/ on Linux.

STLink

Sign into the STLink Portal and verify the version of the STLink in the Dashboard view. You can also run the executable with the version command line argument. The h2stlink executable can be found under Program Files on Windows, /opt/Xiid/ on Linux, and /Library/Application Support/Xiid/XIID-H2stlink/bin/ on macOS.

Troubleshooting

If you encounter issues during the upgrade process:

1. Permission Denied: Ensure you're running the commands as administrator (Windows) or with sudo (Linux/macOS)
2. File Not Found: Verify the binary file is in the current directory and the filename matches exactly
3. Service Issues: Restart the service after installation if the product doesn't start automatically
4. Exec Fork: Verify the CPU architecture of the binary and the target installation machine match