Skip to Content

UDP Input

Version 8.1 by Alexander Mott on 2025/08/28 18:41
Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

ShowRunnerCLC™ can accept commands via UDP.  Feedback is not provided.

Enable the UDP listener by specifying a port in the config:

"UdpListener":
  {
    "ListenPort": 45794
  },

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.
Format: GlobalId.ActionName[.ActionPropertyValue]\x0D

To obtain a list of GlobalIds for objects use console command sr show global ids.  Global Actions use a GlobalId of 0.

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.

An example of a UDP command follows the actions table.

Failed to execute the [display] macro. Cause: [Cannot find section [HX-TypeActionsTable] in document [xwiki:SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome]]. Click on this message for details.

Example to Recall Scene 1 on Area with Global Id 51:

From "sr show global ids":
+-----+-----------------+----------------------------------+
| ID  | Type            | Name                             |
+-----+-----------------+----------------------------------+
| 51  | Area            | Boardroom A                      |
+-----+-----------------+----------------------------------+
From "sr show actions":
+-----------------+-------------------------------+----------------------------------------------------------+--------------------+---------+-----------------+--------------------------------------------------------------------------------+
| Type            | Action                        | Description                                              | Reference Property | Ref Req | Triggers        | Supported Properties                                                           |
+-----------------+-------------------------------+----------------------------------------------------------+--------------------+---------+-----------------+--------------------------------------------------------------------------------+
| Area            | RecallScene                   | Recalls the specified scene on this load                 | SceneId            | False   | Digital, Analog | 'SceneId':(Integer)'Scene Number to recall'                                    |
+-----------------+-------------------------------+----------------------------------------------------------+--------------------+---------+-----------------+--------------------------------------------------------------------------------+

UDP Command to send:
51.RecallScene.1\x0D