Wiki source code of UDP Input
Last modified by Alexander Mott on 2025/10/01 17:30
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
4.1 | 1 | ShowRunnerCLC™ can accept commands via UDP. Feedback is not provided. |
| |
1.1 | 2 | |
| |
11.1 | 3 | Enable the UDP listener by specifying a port and the max connections via the console: |
| |
10.1 | 4 | ##sr udp enable (ListenPort)## |
| 5 | Example: | ||
| |
12.1 | 6 | ##sr udp enable 45794## |
| |
11.1 | 7 | |
| |
10.1 | 8 | The UDP Listener may also be enabled by adding a snippet to the root of the config: |
| |
11.1 | 9 | |
| |
5.1 | 10 | (% class="box" %) |
| 11 | ((( | ||
| 12 | ##"UdpListener": | ||
| |
1.1 | 13 | { |
| 14 | "ListenPort": 45794 | ||
| 15 | },## | ||
| |
5.1 | 16 | ))) |
| |
1.1 | 17 | |
| |
8.1 | 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. |
| |
3.1 | 19 | Format: ##GlobalId.ActionName[.ActionPropertyValue]\x0D## |
| |
1.1 | 20 | |
| |
3.1 | 21 | To obtain a list of GlobalIds for objects use console command ##sr show global ids##. Global Actions use a GlobalId of 0. |
| |
1.1 | 22 | |
| |
7.1 | 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. |
| |
8.1 | 24 | \\An example of a UDP command follows the actions table. |
| |
1.1 | 25 | |
| |
9.1 | 26 | {{display reference="SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome" section="HShowRunnerCLC2122ActionsTable"/}} |
| |
7.1 | 27 | |
| 28 | |||
| |
6.1 | 29 | (% class="box" %) |
| 30 | ((( | ||
| |
6.2 | 31 | Example to Recall Scene 1 on Area with Global Id 51: |
| 32 | |||
| 33 | |||
| |
1.1 | 34 | From "sr show global ids": |
| 35 | ##+~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+ | ||
| 36 | ~| ID | Type | Name | | ||
| 37 | +~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+ | ||
| 38 | ~| 51 | Area | Boardroom A |## | ||
| 39 | ##+~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+## | ||
| 40 | From "sr show actions": | ||
| 41 | ##+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+ | ||
| 42 | ~| Type | Action | Description | Reference Property | Ref Req | Triggers | Supported Properties | | ||
| 43 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+ | ||
| |
6.1 | 44 | ~| Area | RecallScene | Recalls the specified scene on this load | SceneId | False | Digital, Analog | 'SceneId'{{{:}}}(Integer)'Scene Number to recall' | |
| |
1.1 | 45 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+## |
| 46 | |||
| |
6.2 | 47 | |
| 48 | UDP Command to send: | ||
| 49 | ##51.RecallScene.1\x0D## | ||
| |
6.1 | 50 | ))) |
| |
1.1 | 51 | |
| |
6.1 | 52 | |
| 53 | |||
| 54 |