Installation

Use the following procedures to install the Crestron XiO Cloud Gateway package onto the Linux platform. If migrating to Crestron XiO Cloud Gateway software from Crestron Virtual Control, refer also to Appendix C: Migrate from Crestron Virtual Control.

NOTE: These procedures assume that the Red Hat Enterprise Linux server platforms have already been installed and meet or exceed the specifications described in Prerequisites. The subscription manager for the Red Hat server platform must also be configured prior to installation.

Install the Crestron XiO Cloud Gateway Package

To install the Crestron XiO Cloud Gateway package onto the Linux platform:

  1. Download the Crestron XiO Cloud Gateway file package from the Software & Firmware resource page at www.crestron.com/Support.
  2. Log into an account with sudo privileges on the Linux platform where the Crestron XiO Cloud Gateway package will be installed.
  3. Copy the package ZIP file to a location on the Linux platform.
  4. Open a new terminal window.
  5. Change directories to the location of the ZIP file, and then issue the following command to unzip the package, where <version> is the version number of the package file:

    6. Copy 
    sudo unzip xiocloudgateway_<version>.zip

  6. Change directories to the location of the unzipped package file (xiocloudgateway).
  7. Issue the following command to update the perl-libs package prior to installing Crestron XiO Cloud Gateway. The installation will fail if the perl-libs package is not updated.

    8. Copy 
    sudo yum install -y perl-libs

  8. Issue the following command to start the installation. The script installs any RPM file dependencies prior to running the Crestron XiO Cloud Gateway RPM file.

    9. Copy 
    sudo ./installXiocloudgateway.sh

  9. Enter y when prompted to confirm the installation.
  10. When prompted, set the directory where Crestron XiO Cloud Gateway applications will be installed. Press Enter to use the default directory (/opt/crestron).

    11. NOTE: Crestron XiO Cloud Gateway cannot be installed in the /home directory.

  11. When prompted, set the Redis port number. Redis is used as a database for Crestron XiO Cloud Gateway processes. Press Enter to use the default Redis port value.
  12. Enter the root account password when prompted to have the Crestron XiO Cloud Gateway installer check whether the MariaDB® database server is installed. The MariaDB database server is installed automatically if it is not already. If the root account password is not set, you will be prompted to create and confirm a password.

    13. NOTE: MariaDB is a scalable database server used by the Crestron XiO Cloud Gateway server to turn data into structured information.

  13. Enter a name to use for the Crestron XiO Cloud Gateway database. Press Enter to use the default database name (VirtualControl).
  14. Enter a username to use for the Crestron XiO Cloud Gateway account. Press Enter to use the default username (virtualcontrol).
  15. Enter a password for the Crestron XiO Cloud Gateway account. Press Enter to use the default password (random string).
  16. Restart the Red Hat server.

After restarting, the Crestron XiO Cloud Gateway service starts automatically within 2 to 3 minutes.

Increase the Memory Mapping Limit

To ensure the Crestron XiO Cloud Gateway server performs optimally when running a large number of connected devices, the memory mapping limit must be increased for the server.

To increase the memory mapping limit for the Crestron XiO Cloud Gateway server:

  1. Navigate to /etc/ and open the sysctl.conf file in a text editing program.
  2. Add the following line to the end of the file:

    3. Copy 
    vm.max_map_count=262144

  3. Save and exit the file.
  4. Issue the following command to apply the changes without a restart:

    5. Copy 
    sudo sysctl -p

Access the Web Interface

To access the Crestron XiO Cloud Gateway web user interface after installation, enter "http://[ServerURL]/VirtualControl/config/settings/" into a supported web browser, where [ServerURL] is the IP address or host name of the Linux platform.

The Crestron XiO Cloud Gateway user interface supports the following browsers:

  • Chrome® browser
  • Firefox® browser
  • Microsoft Edge® browser (chromium-based)
  • Safari® browser

The Status > Device Info page displays by default.

Crestron XiO Cloud Gateway Web User Interface

Crestron XiO Cloud Gateway User Interface

The following commands may be issued while the Crestron XiO Cloud Gateway service is running:

  • To check the status of the Crestron XiO Cloud Gateway service while it is running, issue sudo systemctl status xiocloudgateway.
  • To restart the Crestron XiO Cloud Gateway service, issue sudo systemctl restart xiocloudgateway.

    • NOTE: After a restart, wait 2 to 3 minutes for the service to initialize before attempting to access the web configuration interface.

  • To stop the Crestron XiO Cloud Gateway service, issue sudo systemctl stop xiocloudgateway.

Update the Crestron XiO Cloud Gateway Service

When a new version of the Crestron XiO Cloud Gateway service is available, a notification is displayed on the top of the web user interface.

Web User Interface - Update Notification

Web User Interface - Update Notification

To update the Crestron XiO Cloud Gateway service from the Linux platform:

  1. Download the Crestron XiO Cloud Gateway file package from the Software & Firmware resource page at www.crestron.com/Support.
  2. Log into an account with sudo privileges on the Linux platform where the Crestron XiO Cloud Gateway package will be installed.
  3. Copy the package ZIP file to a location on the Linux platform.
  4. Open a new terminal window.
  5. Change directories to the location of the ZIP file, and then issue the following command to unzip the package, where <version> is the version number of the package file:

    6. Copy 
    sudo unzip xiocloudgateway_<version>.zip

  6. Change directories to the location of the unzipped package file (xiocloudgateway).
  7. Issue the following command to start the installation. The script installs any RPM files that are dependencies for the installation prior to running the Crestron XiO Cloud Gateway RPM file.

    8. Copy 
    sudo ./installXiocloudgateway.sh

  8. Enter y when prompted to confirm the update.

The update may take up to 15 minutes to complete. Once the update has completed, the Crestron XiO Cloud Gateway service starts automatically within 2 to 3 minutes.

Update the Crestron Driver Framework

When a new version of the Crestron Driver Framework is available, a notification is displayed on the top of the web user interface.

Note: The ability to upgrade the Crestron Driver Framework independent of the XiO Cloud Gateway software is available in software version 4.0002.x and later.

To update the Crestron Driver Framework from the Linux platform:

  1. Navigate to the scripts folder of the XiO Cloud Gateway installation. If the folder is in the default location, this can be done by issuing the following command:

    2. Copy 
    # cd /opt/crestron/virtualcontrol/scripts/

  2. Issue the following command to execute the script and download the new Crestron Driver Framework: 

    Copy 
    # sudo ./downloadCrestronDriversRPM.sh

  3. If a new version of the Crestron Driver Framework is available, the script will download that version and ask to install it:

    # Do you want to install crestron_drivers_sdk? (Y/N) :

    Enter Y to install the new Crestron Driver Framework or N to cancel.

The update may take up to 15 minutes to complete. Once the update has completed, the Crestron XiO Cloud Gateway service starts automatically within 2 to 3 minutes.