Skip to Content

Changes for page TCP Interface

Last modified by Mark Kohlmann on 2024/02/27 22:00
From version 5.1
edited by Mark Kohlmann
on 2024/02/27 21:58
Change comment: There is no comment for this version
To version 1.1
edited by Mark Kohlmann
on 2021/08/26 18:40
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -SHOWRUNNER™ Integrations Guide.Integration Options.WebHome
1 +SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Appendix.Integration Options.WebHome
Content
... ... @@ -1,16 +1,33 @@
1 -Coeus can accept commands via TCP.  Feedback is provided if subscribed.
1 +ShowRunner can accept commands via TCP.  Feedback is provided if subscribed.
2 2  
3 +==== System Configuration ====
4 +
5 +Enable the TCP listener by specifying a port and the max connections via the console:
6 +##sr tcp enable (ListenPort) (MaxConnections)##
7 +Example:
8 +##sr tcp enable 45794 20##
9 +
10 +The TCP Listener may also be enabled by adding a snippet to the root of the config:
11 +
12 +## "TcpListener":
13 + {
14 + "ListenPort": 45794,
15 + "MaxConnections": 20
16 + },##
17 +
3 3  ==== Command Format ====
4 4  
5 5  Commands are sent to objects by GlobalId followed by the Action and then any relevant Properties (Properties are interpreted in the order shown).  They are dot delimited and terminated with a carriage return. 
6 6  Format: ##GlobalId.ActionName[.ActionPropertyValue]\x0D##
7 7  
8 -The Global ID may be found on the UI using the “i” button.  Global Actions use a GlobalId of 0.
23 +To obtain a list of GlobalIds for objects use console command sr show global ids.  Global Actions use a GlobalId of 0.
9 9  
10 -[[image:image.jpeg]]
25 +To obtain a list of Actions available by object type use console command ##sr show actions.##
11 11  
12 12  Example Recall Scene 1 on Area 51:
13 13  
29 +From "##sr show global ids##":
30 +
14 14  ##+~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
15 15  ~| ID | Type | Name |
16 16  +~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
... ... @@ -17,7 +17,7 @@
17 17  ~| 51 | Area | Boardroom A |
18 18  +~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+##
19 19  
20 -Actions:
37 +From "##sr show actions##":
21 21  
22 22  ##+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
23 23  ~| Type | Action | Description | Reference Property | Ref Req | Triggers | Supported Properties |
... ... @@ -31,7 +31,7 @@
31 31  
32 32  ==== Subscriptions ====
33 33  
34 -Subscriptions may be enabled for each action.  When a subscription is requested the current state will be returned.  Any future changes to the actions state will return the value until the subscription is canceled.   A subscription request does not require parameters and does not execute the action.  "+" is used to subscribe, "-" is used to unsubscribe.  Subscriptions are tracked by connection.  If a connection is lost a re-subscribe should take place on a new connection.
51 +Subscriptions may be enabled for each action.  When a subscription is requested the current state will be returned.  Any future changes to the actions state will return the value until the subscription is canceled.   A subscription request does not require parameters and does not execute the action.  "+" is used to subscribe, "-" is used to unsubscribe.
35 35  
36 36  Subscribe:
37 37  ##+[GlobalId].[ActionName]\x0D##
image.jpeg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.mark\.kohlmann@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -235.3 KB
Content