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