XRT Installation Guide Version 1.1.1 Table of Contents Copyright and Trademarks iii Disclaimer iii About This Manual iv Audience iv Copy and Paste from PDF iv Conventions used in this Manual iv IOTech Support v XRT Installation 1 Apache Paho MQTT Client Library Installation 2 Thrift C RPC Library Installation 2 XRT-dependent Libraries Installation 3 XRT Builds 3 Install on Debian-based Systems 4 Install on RPM-based Systems 5 Install on Alpine Linux-based Systems 10 Install on ClearLinux-based Systems 11 Install for Zephyr RTOS 12 Install for Azure Sphere 13 XRT License 14 Test an Installation 15 TABLE of CONTENTS ii Copyright and Trademarks Copyright and Trademarks This document contains proprietary information belonging to IOTech Systems. All trademarks acknowledged. Disclaimer This manual applies to Version 1.1.1 of the XRT package and to all subsequent versions and modifications of documentation unless otherwise indicated in new editions. It is the policy of IOTech Systems to improve products as technology, components, software and firmware become available. IOTech therefore reserves the right to change specifications without prior notice. Note that although this publication contains the latest information available, it may be subject to modification and may contain technical inaccuracies or typographical errors. This document contains examples of data, screens and reports used in normal operations. To illustrate them as completely as possible, the examples may include the names of individuals or companies. Apart from some genuine names, used only with permission, these names are fictitious and any similarity to the names and addresses of any individuals or companies is coincidental. To provide improved information in later editions of this manual, IOTech welcomes your views. Please address your comments to the address given below. © 2021 IOTech Systems The Catalyst, Science Square, Newcastle Helix, Newcastle upon Tyne, United Kingdom NE4 5TG Email: [email protected] All Rights Reserved Disclaimer iii About This Manual About This Manual This manual describes the following: l Installing XRT on the following systems: o Debian-based systems o RPM-based systems o Alpine Linux systems o ClearLinux systems o Zephyr RTOS development hosts o Azure Sphere development hosts l Obtaining and applying a license l Testing an installation Audience This manual is designed for individuals who want to install XRT on a variety of native and cross- development systems. Copy and Paste from PDF You can copy and paste the commands from this PDF for use in your project. There is a known issue in some PDF readers, such as the Document Viewer in Ubuntu, where extra spaces are added on pasting content. This particularly occurs following a forward slash (/) character. If you have issues after copying and pasting commands or examples from this document, please check for extra spaces that may have been added. Conventions used in this Manual Throughout this manual, the following conventions are used: Convention Used for Example Monospace font Command examples xrtd & Code examples Code extracts Audience iv About This Manual Convention Used for Example Italic monospace font Variables <services> enclosed in less than (<) and greater than (>) brackets Italics File names /opt/iotech/xrt Paths Bold Menu options Select the Add button Button text Field name Notes Emphasize important Note: You must have a information, or providing license file. extra information or tips Cautions Warn of possible Caution: Ensure the damage to yourself or hardware is disconnected your system before starting to avoid electric shocks. Blue font with heading and Internal cross-reference "XRT Installation" on page 1 page reference Blue bold underlined font Internal links IOTech Support Indigo bold italic External links, which Contact Form underlined font open in a new browser window IOTech Support If you require further support from IOTech, visit the IOTech Support and Knowledge Base, or use the Contact Form. IOTech Support v XRT Installation XRT Installation The method used to install XRT differs depending on the system that you are using. Where possible, XRT is delivered using the standard packaging system for a distribution; if this is not possible, standard compressed TAR or ZIP files are used. Note: IOTech recommends that all installations are done as root. The installation instructions in this document, with the exception of the Debian-based installation instructions, provide the commands for installations done as root. The following table shows which systems and architectures support XRT, and provides a direct link to the appropriate installation instructions: 64 Bit 32 Bit 64 Bit System Installation Instructions Intel X86 ARM ARM Debian 10 Y Y Y "Install on Debian-based Systems" on page 4 Debian 9 Y Y Y "Install on Debian-based Systems" on page 4 Ubuntu 20.04 Y Y Y "Install on Debian-based Systems" on page 4 Ubuntu 18.04 Y Y Y "Install on Debian-based Systems" on page 4 CentOS 8 Y N Y "Install on CentOS 8" on page 5 Fedora 33 Y N Y "Install on Fedora 33" on page 5 openSUSE Y Y Y "Install on OpenSUSE Leap 15.2" 15.2 on page 6 Photon 3.0 Y N Y "Install on Photon 3.0" on page 7 Clear Linux Y N N "Install on ClearLinux-based Systems" on page 11 1 XRT Installation 64 Bit 32 Bit 64 Bit System Installation Instructions Intel X86 ARM ARM Alpine Linux Y Y Y "Install on Alpine Linux-based 3.12 Systems" on page 10 Alpine Linux Y Y Y "Install on Alpine Linux-based 3.13 Systems" on page 10 Zephyr 2.3 Y Y Y "Install for Zephyr RTOS" on page 12 Zephyr 1.14 Y Y Y "Install for Zephyr RTOS" on page 12 Azure Sphere N Y N "Install for Azure Sphere" on page 13 The core XRT framework requires support for the standard C library and Portable Operating System Interface (POSIX) API. This means that it can be ported to any real-time operating system (RTOS) that supports these features. Note: Some individual XRT components may have more restrictive API requirements and, therefore, not all XRT component modules are supported on all platforms. Apache Paho MQTT Client Library Installation The XRT MQTT plug-ins use the Apache Paho MQTT client library. Where possible, IOTech includes binary packages in the package repositories; however, not all systems support a binary package. When this is the case, the Paho MQTT library must be built and installed manually. The relevant installation instructions include the steps for manual installation. Thrift C RPC Library Installation Some XRT plug-ins use the Thrift C RPC library, which requires the mdedtls package for secure communication. Where possible, IOTech includes binary packages in the package repositories; however, not all systems support a binary package. When this is the case, the mdedtls package must be built and installed manually. The relevant installation instructions include the steps for the manual installation. Apache Paho MQTT Client Library Installation 2 XRT Installation XRT-dependent Libraries Installation IOTech provides dependent libraries as packages on all supported platforms. The dependencies are managed by the package manager, when possible. If this behavior is not supported, instructions for installing the dependencies manually are included in the relevant section of this document. XRT Builds The following XRT builds are available: Build Package Description Release iotech-xrt Use when developing connected IoT edge applications with XRT deployment-ready components Contains the following: l Component libraries l XRT and XRT CLI application l Examples Development iotech-xrt- Use when developing XRT-based components dev Contains the following: l Component libraries l XRT and XRT CLI application l Examples l Headers required for development using XRT components Cross iotech-xrt- Use when installing Azure Sphere on development Development azsphere7 hosts XRT-dependent Libraries Installation 3 XRT Installation Install on Debian-based Systems This method uses .deb packages to install XRT. It is used for all systems that are based on the Debian packaging mechanism, such as Debian and Ubuntu. To install XRT using .deb packages, complete the following steps: 1. Install the packages, using the following command: sudo apt-get install lsb-release apt-transport-https curl gnupg2 2. Add the key for the IOTech repository, using the following command: curl -fsSL https://iotech.jfrog.io/artifactory/api/gpg/key/public | sudo apt-key add - 3. Register the IOTech repository, using the following command: echo "deb https://iotech.jfrog.io/iotech/debian-release $(lsb_release -cs) main" | sudo tee -a /etc/apt/sources.list.d/iotech.list 4. Update the repositories, using the following command: sudo apt-get update 5. Install XRT using the following command: sudo apt-get install iotech-xrt Install on Debian-based Systems 4 XRT Installation Install on RPM-based Systems RPM-based systems, such as Fedora, SUSE and CentOS, do not all use the same package management system or support the same packages. This means that the installation instructions for RPM-based systems are specific to the system. You can install XRT on the following RPM-based systems: l CentOS 8. For installation instructions, see "Install on CentOS 8" below l Fedora 33. For installation instructions, see "Install on Fedora 33" below l OpenSUSE Leap 15. For installation instructions, see "Install on OpenSUSE Leap 15.2" on the next page l Photon 3.0. For installation instructions, see "Install on Photon 3.0" on page 7 Install on CentOS 8 To install XRT on CentOS 8 as root, complete the following steps: 1. Download and install the iotech.repo repository access file from the IOTech support portal, using the following command: cp iotech.repo /etc/yum.repos.d/ 2. Add EPEL and PowerTools repository support, if not already enabled, using the following commands: dnf install -y 'dnf-command(config-manager)' dnf config-manager --set-enabled PowerTools dnf install -y epel-release 3.