Wiki source code of UDP Input
Version 5.1 by Alexander Mott on 2024/06/14 19:07
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | ShowRunnerCLC™ can accept commands via UDP. Feedback is not provided. | ||
| 2 | |||
| 3 | Enable the UDP listener by specifying a port in the config: | ||
| 4 | |||
| 5 | (% class="box" %) | ||
| 6 | ((( | ||
| 7 | ##"UdpListener": | ||
| 8 | { | ||
| 9 | "ListenPort": 45794 | ||
| 10 | },## | ||
| 11 | ))) | ||
| 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. | ||
| 14 | Format: ##GlobalId.ActionName[.ActionPropertyValue]\x0D## | ||
| 15 | |||
| 16 | To obtain a list of GlobalIds for objects use console command ##sr show global ids##. Global Actions use a GlobalId of 0. | ||
| 17 | |||
| 18 | To obtain a list of Actions available by object type use console command ##sr show actions##. | ||
| 19 | |||
| 20 | Example Recall Scene 1 on Area 51: | ||
| 21 | |||
| 22 | From "sr show global ids": | ||
| 23 | |||
| 24 | ##+~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+ | ||
| 25 | ~| ID | Type | Name | | ||
| 26 | +~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+ | ||
| 27 | ~| 51 | Area | Boardroom A |## | ||
| 28 | ##+~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+## | ||
| 29 | |||
| 30 | From "sr show actions": | ||
| 31 | |||
| 32 | ##+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+ | ||
| 33 | ~| Type | Action | Description | Reference Property | Ref Req | Triggers | Supported Properties | | ||
| 34 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+ | ||
| 35 | ~| Area | RecallScene | Recalls the specified scene on this load | SceneId | False | Digital, Analog | 'SceneId':(Integer)'Scene Number to recall' | | ||
| 36 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+## | ||
| 37 | |||
| 38 | UDP Command to send: | ||
| 39 | |||
| 40 | 51.RecallScene.1\x0D |