TCP Client

The TCP Client app allows you to communicate with TCP-compatible devices (TCP clients). Among them are devices like beamers, TVs and many more. Additionally, you can use a gateway (TCP to serial port) to send commands to different devices with a serial port.

The TCP Client app is located under “all apps” – “TCP Client”.

Create

To create a new TCP Client, navigate to the app and choose 'add TCP client'.

On every TCP Client, there is a symbol which shows you if there ist a working connection to the desired device. As you have to configure every new TCP Client first, the symbol will display a red X.

Before the TCP Client can communicate, you have to enter a valid IP address in the settings. To do so, open the Parameter panel of your newly created TCP Clients and enter the IP address and the port of the desired device.

If the IP address and port are correct and a successful connection could be established, you will see a green checkmark in the display of the TCP Client after some seconds.

Operation

The Operator Panel of the TCP Client displays the current status of the client, allows you to send preconfigured commands and shows you a list of recently received data.

State
The current status of the TCP Client will be shown here.In case there are any problems with the connection to the desired device or you haven't entered a correct IP address yet, a red X will be displayed.

Events
Every TCP Client allows you to create 3 events, which are triggered when the conditions meets. You can then link to those events in created scenes (inside the Scene app) and use them as triggers. Configured events will be displayed in this list.

Commands
All commands you have created are listed here. You can trigger or delete each one.

Last received data
This list will display recently received data. You can switch between a 'text' or 'hex' view.

Configuration

The settings of the TCP Client allow you to configure new commands and events, which can be linked in scenes.

IP configuration
The IP address and port of the device for which you want your TCP Client to establish a connection to should be entered here. This settings should be the first configuration you make after creating a new TCP Client. The Operator Panel will then tell you if your connection is working.

Commands
If you want to create a new command, you can do this here by using the 'new command' button. Choose a name and the data which should be send. You can decide between simple text or hex values. Additionally, you can also decide whether you expect a specific answer and choose between text or hex values.

Test command
If you just want to test a command, you can do this here. The result will then be displayed beneath the 'test command' button.

Events
There are some devices, which may frequently send data, without the need for a explicit request (e.g. via a command). For such use cases, every TCP Client has 3 events. For each event, you can set what data you are expecting and their type (text or hex). If an expected event occurs this event will be triggered and can be linked to when creating a Scene.