Skip to Content

Changes for page UDP Input

Last modified by Alexander Mott on 2025/10/01 17:30
From version 4.1
edited by Scott Kohlmann
on 2023/04/20 21:37
Change comment: There is no comment for this version
To version 11.1
edited by Alexander Mott
on 2025/10/01 17:11
Change comment: There is no comment for this version

Summary

Details

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