installation - autolog/TouchPortal GitHub Wiki

It's important to understand the structure of how the Touch Portal Plugin works with the Touch Portal ecosystem. There are six elements required.

  1. Touch Portal Desktop (or TPD) - This is software that is installed on a desktop/laptop machine.

  2. Touch Portal Mobile (or TPM) - This is software that is installed on an iOS or Android device.

  3. Touch Portal Pro Upgrade - In order to use the Indigo plugin system, a Touch Portal Pro licence is required.

  4. Touch Portal Plugin for Indigo - this is the plugin available from the Indigo Plugin Store.

  5. Indigo Plugin for Touch Portal - There is a plugin for TPD that is required for communication and control. This plugin is created automatically.

  6. Touch Portal Desktop Device - this is the main device within Indigo that provides communication between Indigo and the Touch Portal software. At least one TPD Device is required.

Note: the Touch Portal Plugin requires Indigo version 7.x.

Installation

In order to use the Touch Portal Plugin for Indigo, you need to take a couple of extra steps in order for the plugin to function properly.

Download and Install the Touch Portal Plugin for Indigo

You can download the Touch Portal Plugin for Indigo via the Indigo Plugin Store or directly from GitHub. See also Upgrading below.

Download and Install the Touch Portal Desktop Software

You can download Touch Portal here.

You must install the Touch Portal Desktop software on the same machine running your Indigo server. This is necessary in order for the plugin to function properly. The Indigo plugin creates the Touch Portal Desktop plugin automatically.

Download and Install the Touch Portal Mobile Client Software

You can download the Touch Portal client from either the Apple or Android app stores.

Purchase the Touch Portal Pro Upgrade

This is required by Touch Portal in order to use custom plugins. You must purchase the Pro upgrade through the appropriate app store. Note that these purchases are platform-specific. For example, if you purchase the upgrade on the Apple app store, you cannot transfer that purchase to Android.

Touch Portal Desktop Indigo Plugin

The Indigo plugin for TPD is created and installed automatically when the Touch Portal Plugin for Indigo is installed. See also Upgrading below.

In order to complete the installation process, you must restart the Touch Portal Desktop software (after you have completed all the other steps). This ensures that TPD has loaded the most recent version of the Indigo plugin.

Upgrading

When installing an update to the Touch Portal Plugin for Indigo (or installing it for the first time), you need to take a few additional steps than you may be accustomed to. When upgrading, it's best to do these steps in this order:

  1. Download the newest version of the Touch Portal Plugin for Indigo from the Indigo Plugin Store.
  2. Install the update in Indigo as normal. You may need direct access to the server machine.
  3. Optional: stop the plugin in Touch Portal Desktop Settings --> Plug-ins --> Indigo Domotics Plugin --> Stop.
  4. Exit and relaunch the TPD software. This is required in order to load the newest version of the Touch Portal Plugin for Indigo. If you stopped the plugin before restarting TPD, you may be asked again if you would like to trust the plugin.

Simply stopping and restarting the Indigo Plugin in Touch Portal will not load the latest update. You must exit and relaunch Touch Portal for the changes to take effect.

To see if you have all elements of the system updated, you can check the version column for your TPD device. If the Indigo and Touch Portal Plugins are out of sync, the version value will look like this: ##-## -- which shows that the Indigo plugin and Touch Portal plugin are not the same version -- and if the two versions are aligned, it will look like this: ##. There are also helpful messages printed to the Indigo Events log to alert you when the versions are out of sync.