Installing Gateway Agent
This section explains how to install the relayr Gateway Agent components by means of the Python installation script.
For a list of minimum platform requirements and supported Linux distributions, see the Requirements section.
Installation Script Requirements
To use the Gateway Agent installation script, the following requirements must be met:
Python - minimum is the python-minimal package or the full python 2.7 or 3.x environment
User and Password to the Gateway Agent package repository. For access credentials, contact the relayr Support Team.
Installation Procedure
To install the relayr Gateway Agent, follow these steps:
- Download the Gateway Agent installation script:
wget https://gwa.relayr.io/public/tools/gwa-installer/gwa-install.py
- Run the installer:
python ./gwa-install.py
- In the main menu, select Install Gateway Agent and press Enter to start the installation.
Once started, the installation script detects the operating system and displays the results, as presented below.
************************************************
* relayr Gateway Agent Installer [2.1]
*
* Copyright (c) 2021 Relayr, Inc.
* All Rights Reserved
************************************************
Detecting operating system...
Distribution: debian
Version: 9.1
Debian Stretch detected.
Access to the relayr Gateway Agent repository is restricted.
Contact relayr Support Team for access credentials.
Enter User Name:
- Provide User and Password to the Gateway Agent package repository. Request your login credentials from the relayr Support Team.
The script validates the provided credentials. In case of an authentication error, it displays the following message:
Enter User Name: wrong
Enter Password:
ERROR
Login credentials do not match! Unable to continue
The script installs all the prerequisites. It may take some time to download and install all the necessary packages. The time needed to install all the prerequisites depends on the Internet connection speed.
Preparing prerequisites...
- Select the Gateway Agent components to be installed. Use the cursor keys to move up and down and press the space bar to select or deselect a component. The selected components are highlighted on the list.
To enable a communication with the Cloud, you need to install either the relayr Cloud Adapter or the Azure Cloud Adapter.
The GWA Analytics component is available for Debian Buster only. If you have any other supported Linux distribution, this component is not displayed on the installer's list.
- Press Enter to start the installation.
The script installs the selected packages and provides the installation summary, which shows which versions of the Gateway Agent components have been installed.
The relayr Gateway Agent components are now successfully installed in the /etc/relayr
directory. For each relayr Gateway Agent component, there is a separate installation package. See section below for a list of packages names.
You now need to configure the installed components. For a description of available configuration options of each component, refer to the component-specific documentation.
Components and Packages Names
The table below presents the mapping between the component names and their corresponding packages.
Component Name | Package Name |
---|---|
relayr Cloud Adapter | gwa-relayr-cloud-v2-adapter-c |
Azure Cloud Adapter | gwa-azure-cloud-adapter-cpp |
Siemens S7 Protocol Adapter | gwa-step7-adapter-c |
Modbus Protocol Adapter | gwa-modbus-adapter-c |
BACnet Protocol Adapter | gwa-bacnet-adapter-c |
OSIsoft Protocol Adapter | gwa-osisoft-adapter-c |
OPC-UA Protocol Adapter | gwa-opc-ua-adapter-c |
CAN bus Protocol Adapter | gwa-canbus-adapter-c |
EtherNet/IP Protocol Adapter | gwa-eip-adapter-cpp |
EtherCAT Protocol Adapter | gwa-ethercat-adapter-cpp |
Pico Agent CoAP Adapter | gwa-pico-agent-coap-adapter-c |
Generic Protocol Adapter | gwa-generic-protocol-adapter-cpp |
Rule Engine | gwa-rule-engine-cpp |
Task Executor | gwa-task-executor-cpp |
Configuration Manager | gwa-config-mgr-cpp |
Storage Service | gwa-storage-service-cpp |
GWA Analytics | gwa-analytics |