TCP Listener

TCP Listener allows Hippo to interface with network based TCP commands. Frequently used by controllers such as Crestron or AMX systems, TCP can be used to trigger events in Hippo or to query the status of a system.

TCP uses a Text mapping.

• Allow Learn Input: If enabled, the input can be used to automatically assign to a mapping with the learn button. It is advisable to disable allow learn input on sources that are constantly sending data as it will interfere with other sources associating.
• Create Enable Pin: Creates a new pin (Bool) to allow the controller to be turned on or off.
• Use Custom Pin Name: Allows user to name enable Pin.
• Network Interface: Choose which adaptor to use for receiving TCP data
• * Listen Port*: Choose network port number to receive data on: must match sender’s settings.
• Allow Value Queries: TCP can be used to get the values of pins to determine the status of a system. For example, getting the value of the performance/FPS pin can be a good way to see how the engine is running. When this is enabled queries are allowed.

Commands for the TCP listener are formatted as the Identifier followed by the command. The Identifier is set in the pin mapping:

For single pins, the identifier is in the text mapping:

For auto mappings the identifier looks different:

TCP command syntax

Commands take the basic form as the identifier followed by a comma, the value and then a carriage return.

To set a value:

[Identifier],[Value]\r
E.g.
DmxEnable,1\r
Returns (if successful):
[Identifier],[Value]:OK\r
E.g.
DmxEnable,1:OK\r

To Trigger a Command:

[Identifier]\r
E.g.
TestPattern\r
Returns (if successful):
[Identifier]:OK\r
E.g.
TestPattern:OK\r

To Query a Value:

[Identifier],?\r
E.g.
Fps,?\r
Returns (if successful):
[Identifier]_[ValueType]=[Value]\r
E.g.
Fps_(float)=60.\r

ValueType can be:

• bool (on/off values),
• int (whole numbers),
• float (fractional numbers)
• string (text).

Errors

One of the following may be returned if there is an error:

[Identifier]:NOK_SYN\r – Command syntax is incorrect
[Identifier]:NOK_VAL\r – Failed to set value (can happen when sending the wrong value type, e.g. text to a number value)
[Identifier]:NOK_STR\r – Identifier was not found.