Skip to Content

Changes for page UDP Input

Last modified by Alexander Mott on 2025/10/01 17:30
From version 10.1
edited by Alexander Mott
on 2025/10/01 17:10
Change comment: There is no comment for this version
To version 3.3
edited by Mark Kohlmann
on 2021/12/08 21:05
Change comment: Update document after refactoring.

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
1 +XWiki.mark\.kohlmann@chiefintegrations\.com
Content
... ... @@ -1,52 +1,37 @@
1 -ShowRunnerCLC™ can accept commands via UDP.  Feedback is not provided.
1 +ShowRunner can accept commands via UDP.  Feedback is not provided.
2 2  
3 -Enable the TCP listener by specifying a port and the max connections via the console:
4 -##sr udp enable (ListenPort)##
5 -Example:
6 -##sr udp enable 45794 20##
7 -The UDP Listener may also be enabled by adding a snippet to the root of the config:
8 -(% class="box" %)
9 -(((
10 -##"UdpListener":
3 +Enable the UDP listener by specifying a port in the config:
4 +
5 +## "UdpListener":
11 11   {
12 12   "ListenPort": 45794
13 13   },##
14 -)))
15 15  
16 -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.
10 +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. 
17 17  Format: ##GlobalId.ActionName[.ActionPropertyValue]\x0D##
18 18  
19 19  To obtain a list of GlobalIds for objects use console command ##sr show global ids##.  Global Actions use a GlobalId of 0.
20 20  
21 -To obtain a list of Actions available by object type use console command ##sr show actions##. The table below includes all of the available Actions available as of ShowRunnerCLC™ version 3.019, but it is possible additional actions have been added since and it is always best to run this command on the installed processor to get version-specific actions.
22 -\\An example of a UDP command follows the actions table.
15 +To obtain a list of Actions available by object type use console command ##sr show actions##.
23 23  
24 -{{display reference="SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome" section="HShowRunnerCLC2122ActionsTable"/}}
17 +Example Recall Scene 1 on Area 51:
25 25  
26 -
27 -(% class="box" %)
28 -(((
29 -Example to Recall Scene 1 on Area with Global Id 51:
30 -
31 -
32 32  From "sr show global ids":
20 +
33 33  ##+~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
34 34  ~| ID | Type | Name |
35 35  +~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
36 36  ~| 51 | Area | Boardroom A |##
37 37  ##+~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+##
26 +
38 38  From "sr show actions":
28 +
39 39  ##+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
40 40  ~| Type | Action | Description | Reference Property | Ref Req | Triggers | Supported Properties |
41 41  +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
42 -~| Area | RecallScene | Recalls the specified scene on this load | SceneId | False | Digital, Analog | 'SceneId'{{{:}}}(Integer)'Scene Number to recall' |
32 +~| Area | RecallScene | Recalls the specified scene on this load | SceneId | False | Digital, Analog | 'SceneId':(Integer)'Scene Number to recall' |
43 43  +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+##
44 44  
45 -
46 46  UDP Command to send:
47 -##51.RecallScene.1\x0D##
48 -)))
49 49  
50 -
51 -
52 -
37 +51.RecallScene.1\x0D