Skip to Content

Changes for page UDP Input

Last modified by Alexander Mott on 2025/10/01 17:30
From version 11.1
edited by Alexander Mott
on 2025/10/01 17:11
Change comment: There is no comment for this version
To version 6.1
edited by Alexander Mott
on 2025/08/28 18:27
Change comment: There is no comment for this version

Summary

Details

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