Skip to Content

Changes for page UDP Input

Last modified by Alexander Mott on 2025/08/28 18:51
From version 8.1
edited by Alexander Mott
on 2025/08/28 18:41
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,49 +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 3  Enable the UDP listener by specifying a port in the config:
4 4  
5 -(% class="box" %)
6 -(((
7 -##"UdpListener":
5 +## "UdpListener":
8 8   {
9 9   "ListenPort": 45794
10 10   },##
11 -)))
12 12  
13 -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. 
14 14  Format: ##GlobalId.ActionName[.ActionPropertyValue]\x0D##
15 15  
16 16  To obtain a list of GlobalIds for objects use console command ##sr show global ids##.  Global Actions use a GlobalId of 0.
17 17  
18 -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.
19 -\\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##.
20 20  
21 -{{display section="HX-TypeActionsTable" reference="SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome"/}}
17 +Example Recall Scene 1 on Area 51:
22 22  
23 -
24 -(% class="box" %)
25 -(((
26 -Example to Recall Scene 1 on Area with Global Id 51:
27 -
28 -
29 29  From "sr show global ids":
20 +
30 30  ##+~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
31 31  ~| ID | Type | Name |
32 32  +~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
33 33  ~| 51 | Area | Boardroom A |##
34 34  ##+~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+##
26 +
35 35  From "sr show actions":
28 +
36 36  ##+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
37 37  ~| Type | Action | Description | Reference Property | Ref Req | Triggers | Supported Properties |
38 38  +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
39 -~| 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' |
40 40  +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+##
41 41  
42 -
43 43  UDP Command to send:
44 -##51.RecallScene.1\x0D##
45 -)))
46 46  
47 -
48 -
49 -
37 +51.RecallScene.1\x0D