devices - autolog/TouchPortal GitHub Wiki

There is currently only one type of Touch Portal device for Indigo. The Touch Portal Desktop (TPD) device is the conduit between Indigo and the Touch Portal software, so you must create at least one device in order to use the plugin.

device configuration dialog

Host IP

The Host IP value is set by the plugin and is locked to prevent it from being changed. Touch Portal Desktop must be installed on the same machine running the Indigo Server, and 127.0.0.1 ("localhost") is a reference to the machine itself and is a loopback.

Touch Portal Folder Location

This field should contain the full path to the location where the Touch Portal Desktop software saves its files. On Mac, this typically defaults to the Documents folder of the active user.

Auto-Connect

If enabled, the plugin will attempt to automatically connect to the Touch Portal Host.

Time Between Socket Retries

The amount of time (in seconds) that the plugin will wait before trying to re-establish a connection communication with the Touch Portal Host once communication has been lost.

Retries Silent After

The number of times the plugin will notify you of connection attempts in the Indigo log. Once the number has been exceeded, the plugin will continue to attempt to re-establish communication (if configured), but will stop posting attempt messages to the Indigo log.

Log Variable Value Messages

Check to show variable value on receipt of 'Set Variable' message. This option is only selectable if Hide Messages isn't checked.

Add/Update Item

To set up a new item, select "Add New Item" otherwise select an existing item to update it.

Item Name (optional)

Choose a unique name for the new item. Leave it empty to use the Indigo name for the item.

It is highly recommended that you use a custom Item Name in publishing an Indigo object. This makes it much simpler if you decide to change the name of the item later via the Indigo UI.

Indigo Item to Connect

This control allows you to select among Indigo Devices, Actions, or variable. When you select one of the items, additional controls will display in the dialog depending on your choice.

Indigo Action / Indigo Device / Indigo Variable (Create Variable State)

Depending on the selection you chose for Indigo Item to Connect, these are the controls that will display:

  • Indigo Action: This control will display all the Indigo Actions available to the plugin.

  • Indigo Device: This control will display all the Indigo Devices available to the plugin.

  • Indigo Variable (Create Variable State): This control will display all the Indigo Variables available to the plugin. An additional control will display that allows you to create a state and assign it to the variable in TPD. You can assign a boolean state or a text state to the variable.

Published Items

This list displays all of the items you have published to Touch Portal. Items are marked with an [a], [d], or [v] to designate whether it's an Action, Device or Variable. Any new items that you have added within the configuration dialog will also appear here.

You must select 'Save' to publish these new items, otherwise the changes will not be saved permanently.