Skip to Content
Last modified by Alexander Mott on 2025/10/30 17:08
Hide last authors
Alexander Mott 5.1 1 ShowRunnerCLC™ has a robust and powerful command line interface accessible using commands starting with ##sr## or ##sradmin## (early versions of ShowRunnerCLC™ used ##lightingmgr## instead of ##sr## and did not have any ##sradmin## commands)
Mark Kohlmann 1.1 2
Alexander Mott 5.1 3 Type ##sr ?## or ##sradmin ?## to get a list of all available commands. You can also add a "?" to get command-specific help; e.g. ##sr deb log ?## will provide logic debugging specific information
4
5 Commands can be shortened by typing the minimum number of characters required to uniquely identify a command; e.g. ##sr sh ar## is the same as ##sr show areas##, whereas ##sr sh a## would not as the command is ambiguous between showing actions and showing areas
6
7 Some commands require additional variables, indicated by ##(X):**T**## where (X) denotes the order in which variables should appear and T denotes the type. Variable types include:
8
9 * B - Binary (true/false or on/off, depending on the command)
10 * D - Double (number with a decimal point)
11 * I - Integer (whole number)
12 * S - String (text)
13 ** Strings containing spaces must be enclosed in double quotes "
14
15 The commands below are an example, and available commands may vary depending on the version of ShowRunnerCLC™ installed on the processor
16
Alexander Mott 3.1 17 {{{RMC4>sr ver
Alexander Mott 5.1 18 ShowRunner Version: 3.77.9371.28731
Alexander Mott 3.1 19
20 RMC4>sr ?
Mark Kohlmann 1.1 21 Help for SR
Alexander Mott 3.1 22 +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
23 | Command | Help |
24 |-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
25 | SR activate (X:I) | Activates an object by Global Id |
26 | - | (X):I:Global ID |
Alexander Mott 5.1 27 | SR add ip device (X:S) (Y:S) (Z:S) | Add an ethernet device |
28 | (A:S) | |
29 | - | (X):S:IP-ID in hex (Y):S:Model (Z):S:Name (A):S:Serial Number |
Alexander Mott 3.1 30 | SR api enable (X:B) | Enables/Disables the WebSocket API, a program restart will happen. |
31 | - | (X):B:Enabled true|false |
Alexander Mott 5.1 32 | SR area (X:S) add direct controller | Adds a direct load controller to an area |
33 | (Y:I) | |
34 | - | (X):S:Area Id(s) (Y):I:Controller GlobalId |
35 | SR area (X:S) clear all load scenes | Clears all load scenes on the specified area. Does not remove the scene defaults or names for the area. |
36 | - | (X):S:Area Id(s) |
37 | SR area (X:S) clear load scene (Y:I) | Clears load scene on the specified area. Does not remove the scene defaults or names for the area. |
38 | - | (X):S:Area Id(s) (Y):I:Scene Id |
39 | SR area (X:S) remove direct controllers | Removes direct load controllers from an area |
40 | - | (X):S:Area Id(s) |
41 | SR area (X:S) scene (Y:I) copy (Z:I) | Copies source scene to destination scene for the specified area ID |
42 | - | (X):S:Area Id(s) (Y):I:Source Scene Id (Z):I:Destination Scene Id |
43 | SR area (X:S) scene (Y:I) move (Z:I) | Moves source scene to destination scene for the specified area ID |
44 | - | (X):S:Area Id(s) (Y):I:Source Scene Id (Z):I:Destination Scene Id |
45 | SR area (X:S) scene loads (Y:I) cop | Copies source scene to destination scene, loads only, for the specified area ID |
46 | y (Z:I) | |
47 | - | (X):S:Area Id(s) (Y):I:Source Scene Id (Z):I:Destination Scene Id |
48 | SR area create (X:S) | Create an area |
49 | - | (X):S:Name |
50 | SR area create (X:S) (Y:I) (Z:I) | Create a remote area |
51 | - | (X):S:Name (Y):I:Remote System ID (Z):I:GlobalID |
Alexander Mott 3.1 52 | SR areas scenes editable | Makes all scenes on all areas user editable |
53 | SR bacnet area features (X:S) | Set the BACNET features for all areas and defaults |
54 | - | (X):S:BACNET Features |
55 | SR bacnet default area features (X:S) | Set the BACNET area features default for new areas |
56 | - | (X):S:BACNET Features |
57 | SR bacnet enable (X:B) | Enables/Disables Bacnet, a program restart will happen. |
58 | - | (X):B:Enabled true|false |
59 | SR bacnet features | Get the BACNET features |
60 | SR bacnet features (X:S) | Set the BACNET features |
61 | - | (X):S:BACNET Features |
62 | SR cct demo start | Start CCT Demo |
63 | SR cct demo stop | Stop CCT Demo |
64 | SR config active move (X:S) | Moves the current config to a new location |
65 | - | (X):S:ConfigAltName |
66 | SR config backup (X:S) | Backs up an alternate config |
67 | - | (X):S:ConfigAltName |
68 | SR config current backup | Backs up the current config |
69 | SR config default backup | Backs up the default config |
70 | SR config move (X:S) (Y:S) | Sets the a config to an alternate |
71 | - | (X):S:ExistingConfigAltName (Y):S:NewConfigAltName |
72 | SR config select clear | Clears the config select to load defaults |
73 | SR config select list | Lists the available config select options |
74 | SR config select set (X:S) | Sets the config to an alternate |
75 | - | (X):S:ConfigAltName |
76 | SR config select show | Shows the config alternate selection |
Alexander Mott 5.1 77 | SR controller create (X:S) (Y:S) (Z | Create a remote load controller |
78 | :I) (A:I) | |
79 | - | (X):S:Name (Y):S:Model (Z):I:Remote System ID (A):I:Remote Device ID |
80 | SR controller create (X:S) (Y:S) (Z | Create a load controller |
81 | :S) (A:I) (B:S) | |
82 | - | (X):S:Name (Y):S:Model (Z):S:IP-ID (A):I:Branch (B):S:Cresnet ID |
83 | SR controllers create occupancy (X: | Creates occupancy sensors that don't exist but have readings |
84 | B) (Y:B) | |
85 | - | (X):B:Skip Direct (Y):B:Dry Run |
Alexander Mott 3.1 86 | SR cresnet auto query | Automatic Cresnet Query Status |
87 | SR cresnet auto query (X:B) | Automatic Cresnet Query Setting |
88 | - | (X):B:Enable/Disable |
89 | SR cresnet discover | Discover Cresnet. |
90 | SR cresnet query | Query Cresnet. |
91 | SR dali (X:I) dump | Dumps known data regarding ballasts/drivers |
92 | - | (X):I:Controller Global ID |
93 | SR dali (X:I) query | Forces a query of the settings in the DIN-DALI-2 |
94 | - | (X):I:Controller Global ID |
95 | SR dali (X:I) read ballastConfig (Y | Forces a reading of all ballast settings into the DIN-DALI-2 |
96 | :I) (Z:S) | |
97 | - | (X):I:Controller Global ID (Y):I:Loop (Z):S:Address (0-63 or All) |
98 | SR dali (X:I) status | Reports the status of the DIN-DALI-2 |
99 | - | (X):I:Controller Global ID |
100 | SR dali (X:S) set (Y:I) (Z:S) (A:I) | Sets the dimming curve on all, bllast, group, or unaddressed |
101 | dimmingcurve (B:S) (C:S) | |
102 | - | (X):S:Controller Global IDs (Y):I:Loop (Z):S:Type: All|Group|Ballast|Unaddressed (A):I:Address (B):S:Type Flourescent|Emergency|HID|LowVo |
103 | | ltageHalogen|Phase|Dali1To10V|LED|Switching|ColorControl|Sequencer (C):S:Dimming Curve Logarithmic|Linear |
104 | SR dali (X:S) set (Y:I) (Z:S) (A:I) | Sets the fade time on all, bllast, group, or unaddressed |
105 | fadetime (B:I) | |
106 | - | (X):S:Controller Global IDs (Y):I:Loop (Z):S:Type: All|Group|Ballast|Unaddressed (A):I:Address (B):I:Fade Time Index |
107 | SR deactivate (X:I) | Deactivates an object by Global Id |
108 | - | (X):I:Global ID |
109 | SR debug controller (X:I) (Y:B) | Set debug status |
110 | - | (X):I:Controller ID (Y):B:Set Debug To |
111 | SR debug FadeEngine (X:B) | Enable fade engine debug |
112 | - | (X):B:Enable/Disable |
113 | SR debug hardware (X:B) | Set debug status |
114 | - | (X):B:Set Debug To |
115 | SR debug logic | Show Debug Status |
116 | SR debug logic Actions | Toggle debug status |
117 | SR debug logic API | Toggle debug status |
118 | SR debug logic Area | Toggle debug status |
119 | SR debug logic Bacnet | Toggle debug status |
120 | SR debug logic CCT | Toggle debug status |
Alexander Mott 5.1 121 | SR debug logic Discovery | Toggle debug status |
122 | SR debug logic HVAC | Toggle debug status |
Alexander Mott 3.1 123 | SR debug logic Joins | Toggle debug status |
124 | SR debug logic Loads | Toggle debug status |
125 | SR debug logic off | Turn off debug |
126 | SR debug logic Schedule | Toggle debug status |
127 | SR debug logic Sensors | Toggle debug status |
128 | SR debug logic Shades | Toggle debug status |
Alexander Mott 5.1 129 | SR debug logic UI | Toggle debug status |
Alexander Mott 3.1 130 | SR debug uis (X:B) | Set UI debug status |
131 | - | (X):B:Set Debug To |
132 | SR debug zum (X:B) | Enables/disables Zum Floor Hub Debug. |
133 | - | (X):B:Enable/Disable Debug |
134 | SR debug zum crestron (X:S) | Debug Crestron Zum libraries |
135 | - | (X):S:State: Off|Normal|Developer|Verbose |
Alexander Mott 5.1 136 | SR delete object (X:I) | Delete object at provided Global ID |
137 | - | (X):I:Global ID |
138 | SR devmgr cresnet bridge device fee | null |
139 | dback reset (X:S) | null |
140 | - | (X):S:IP-ID |
Alexander Mott 3.1 141 | SR devmgr cresnet bridge show branc | Prints out all branches with status |
142 | hes (X:S) (Y:S) | |
143 | - | (X):S:IP-ID (Y):S:Type |
144 | SR devmgr ethernet clear ipentry (X | Clears specified ip table entry (assumes master) |
145 | :S) (Y:S) (Z:S) | |
146 | - | (X):S:IP Address or Hostname (Y):S:IPT entry IP-ID as Hex (Z):S:IPT entry target address |
147 | SR devmgr ethernet clear ipentry (X | Clears specified ip table entry |
148 | :S) (Y:S) (Z:S) (A:B) | |
149 | - | (X):S:IP Address or Hostname (Y):S:IPT entry IP-ID as Hex (Z):S:IPT entry target address (A):B:true=Master|false=Slave |
150 | SR devmgr ethernet clear iptable (X:S) | Clears all ip table entries |
151 | - | (X):S:IP Address or Hostname |
152 | SR devmgr ethernet get iptable (X:S) | Obtains all ip table entries from the device |
153 | - | (X):S:IP Address or Hostname |
154 | SR devmgr ethernet query | Initiates an autodiscovery query |
155 | SR devmgr ethernet set iptable (X:S | Sets the IP Table Entry |
156 | ) (Y:S) | |
157 | - | (X):S:IP Address or Hostname (Y):S:IP-ID in hex |
158 | SR devmgr ethernet show devices | Prints the discovered devices |
159 | SR devmgr onlinetracker enable (X:B) | Enable/Disable the Online Tracker, persistent |
160 | - | (X):B:Enable|Disable |
161 | SR devmgr onlinetracker ignore add | Add a device to the ignore list |
162 | (X:S) | |
163 | - | (X):S:Connection Path for Device to Ignore |
164 | SR devmgr onlinetracker ignore remo | Add a device to the ignore list |
165 | ve (X:S) | |
166 | - | (X):S:Connection Path for Device to Ignore |
167 | SR devmgr onlinetracker show all | Show All Devices |
168 | SR devmgr onlinetracker show ignore | Show Ignored Devices |
169 | SR devmgr onlinetracker show offline | Show Offline Devices |
170 | SR devmgr rf (X:S) devices | Shows the devices on an RF gateway |
171 | - | (X):S:IP-ID of RF Gateway |
172 | SR devmgr rf (X:S) query | Queries the devices on an RF gateway |
173 | - | (X):S:IP-ID of RF Gateway |
174 | SR devmgr rf rcon disable | Disables current RCON |
175 | SR devmgr rf rcon enable (X:S) | Enables RCON to the specified RF Gateway |
176 | - | (X):S:IP-ID of RF Gateway |
177 | SR devmgr rf rcon send (X:S) | Sends RCON Command |
178 | - | (X):S:Command |
179 | SR devmgr show diagnostics | Show Diagnostic Devices |
180 | SR devmgr show diagnostics errors | Show Diagnostic Devices, Errors Only |
181 | SR devmgr zumnet bridge show device | Prints out all devices with status |
182 | s (X:S) | |
183 | - | (X):S:IP-ID |
184 | SR dhcp server bindings | Shows the dhcp server bindings |
185 | SR dhcp server disable | Disables the internal DHCP Server |
186 | SR dhcp server enable | Enables the internal DHCP Server with default values and a range of 1/2 the subnet |
187 | SR discover (X:I) | Initiate Discovery |
188 | - | (X):I:Global ID |
Alexander Mott 5.1 189 | SR discover clear filter | Remove Discovery Filter |
190 | SR discover filter | Show Discovery Filter |
191 | SR discover filter (X:S) | Set Discovery Filter |
192 | - | (X):S:Filter String |
Alexander Mott 3.1 193 | SR discover scenes (X:I) | Discover scenes on a device |
194 | - | (X):I:Device Global ID |
195 | SR discover zummesh (X:B) | Initiate Zum Wireless Discovery |
196 | - | (X):B:Claim RF Gateways |
197 | SR discover zumnet (X:B) (Y:B) | Initiate Zum Wired Discovery |
198 | - | (X):B:Claim JBOXs (Y):B:Enumerate Devices |
199 | SR dr (X:B) | Activates/Deactivates Demand Response. |
200 | - | (X):B:Active true|false |
201 | SR dr status | Shows demand response status. |
202 | SR eisc add | Creates a new EISC |
203 | SR eisc delete (X:S) | Deletes an EISC at the specified EISC |
204 | - | (X):S:IP-ID |
205 | SR enroll hardware property (X:S) ( | Set a property for an underlying hardware device at global ID and store the setting in the config |
206 | Y:S) (Z:S) | |
207 | - | (X):S:Global ID(s) Comma and Dash Separated permitted (Y):S:Path (Z):S:New Value |
208 | SR ethernet device claim (X:S) | Claims an ethernet device discovered by Ethernet Autodiscovery |
209 | - | (X):S:IP Address or Hostname |
210 | SR ethernet device claim (X:S) (Y:S) | Claims an ethernet device discovered by Ethernet Autodiscovery at the specified IP-ID |
211 | - | (X):S:IP Address or Hostname (Y):S:IP-ID to use [In Hex] |
Alexander Mott 5.1 212 | SR ethernet device replace (X:S) (Y:S) | Replaces the serial number in an ethernet record with one from a newly discovered device with a matching SN. |
213 | - | (X):S:Old Serial Number (Y):S:New Serial Number |
Alexander Mott 3.1 214 | SR eventlog (X:B) | Activates/Deactivates the Event Log. |
215 | - | (X):B:Active true|false |
216 | SR eventlog console (X:B) | Activates/Deactivates the Event Log to console. |
217 | - | (X):B:Active true|false |
218 | SR eventlog file (X:B) | Activates/Deactivates the Event Log to File. |
219 | - | (X):B:Active true|false |
220 | SR eventlog heartbeat interval (X:I) | Set the eventlog heartbeat interval |
221 | - | (X):I:seconds |
222 | SR eventlog level (X:S) | Event log level to permit |
223 | - | (X):S:Event Log Level |
224 | SR eventlog rsyslog (X:B) | Activates/Deactivates the Event Log to Rsyslog. |
225 | - | (X):B:Active true|false |
226 | SR eventlog statistics (X:B) | Activates/Deactivates the Event Log System Statistics Function. |
227 | - | (X):B:Active true|false |
228 | SR eventlog statistics interval (X:I) | Set the eventlog statistics interval |
229 | - | (X):I:10 to 65535 seconds |
230 | SR eventlog status | Status for Event Log |
231 | SR eventlog thread (X:B) | Activates/Deactivates the Event Log Thread Function. |
232 | - | (X):B:Active true|false |
233 | SR eventlog trace (X:B) | Activates/Deactivates the Event Log Trace Function. |
234 | - | (X):B:Active true|false |
235 | SR execute action (X:S) | Execute the specified action syntax |
236 | - | (X):S:Action |
237 | SR execute event (X:S) | Execute the specified event |
238 | - | (X):S:Global ID |
239 | SR execute global action (X:I) | Execute specified global action |
240 | - | (X):I:Global Action ID |
241 | SR export (X:S) (Y:I) | exports the JSON for an object to be used as a remote device |
242 | - | (X):S:Types as a comma/dash separated list (Y):I:System ID |
243 | SR exportByType (X:S) (Y:I) | exports the JSON for objects to be used as a remote device |
244 | - | (X):S:Device Type(s) to Export as comma separated list (Y):I:System ID |
245 | SR fusion enable (X:B) | Enables/Disables Fusion, a program restart will happen. |
246 | - | (X):B:Enabled true|false |
247 | SR get hardware properties (X:I) | Gets the properties for an underlying hardware device at global ID |
248 | - | (X):I:Global ID |
249 | SR get properties (X:I) | Gets the properties for a global ID |
250 | - | (X):I:Global ID |
Alexander Mott 5.1 251 | SR keypad create (X:S) (Y:S) (Z:I) | Create a remote keypad |
252 | (A:I) | |
253 | - | (X):S:Name (Y):S:Model (Z):I:Remote System ID (A):I:GlobalId |
254 | SR keypad create (X:S) (Y:S) (Z:S) | Create a keypad |
255 | (A:I) (B:S) | |
256 | - | (X):S:Name (Y):S:Model (Z):S:IP-ID (A):I:Branch (B):S:Cresnet ID |
Alexander Mott 3.1 257 | SR load (X:I) cct (Y:I) | Set the CCT for a load |
258 | - | (X):I:Load Global ID (Y):I:CCT in Kelvin |
259 | SR load (X:I) cct copy from (Y:I) | Copy CCT Settings from one load to another |
260 | - | (X):I:Target Load Global ID (Y):I:Source Load ID |
261 | SR load (X:I) cct map add (Y:I) (Z: | Map warm and cool points |
262 | I) (A:I) | |
263 | - | (X):I:Load Global ID (Y):I:cct (Z):I:warm (A):I:cool |
264 | SR load (X:I) cct map current (Y:I) | Set WarmCoolMapPoints |
265 | - | (X):I:Load Global ID (Y):I:cct |
266 | SR load (X:I) cct map remove (Y:I) | Remove a WarmCoolMapPoint |
267 | - | (X):I:Load Global ID (Y):I:cct |
268 | SR load (X:I) cct map show | Show CCT Map Points |
269 | - | (X):I:Load Global ID |
270 | SR load (X:I) cct map use (Y:B) | Use WarmCoolMapPoints |
271 | - | (X):I:Load Global ID (Y):B:true or false |
272 | SR load (X:I) cct max (Y:I) | Set cct max for given light |
273 | - | (X):I:Load Global ID (Y):I:Cct Kelvin |
274 | SR load (X:I) cct min (Y:I) | Set cct min for given light |
275 | - | (X):I:Load Global ID (Y):I:Cct Kelvin |
276 | SR load (X:I) cct OutsideRangeOff (Y:B) | Turn off load if CCT out of range |
277 | - | (X):I:Load Global ID (Y):B:true or false |
278 | SR load (X:I) cct set (Y:I) | Set CCT for given light |
279 | - | (X):I:Load Global ID (Y):I:CCT in K |
280 | SR load (X:I) cct set cool (Y:I) | Set cool for given light |
281 | - | (X):I:Load Global ID (Y):I:0-100% |
282 | SR load (X:I) cct set warm (Y:I) | Set warm for given light |
283 | - | (X):I:Load Global ID (Y):I:0-100% |
284 | SR load (X:I) intensity (Y:I) | Set intensity for given load |
285 | - | (X):I:Load Global ID (Y):I:0-100% |
286 | SR load (X:S) scene (Y:I) (Z:I) | Set intensity for given loads |
287 | - | (X):S:Load Global ID (Y):I:Scene ID (Z):I:0-100% |
288 | SR load (X:S) scene (Y:I) (Z:I) (A:D) | Set intensity and fade time for given loads |
289 | - | (X):S:Load Global ID (Y):I:Scene ID (Z):I:0-100% (A):D:Fade Time |
Alexander Mott 5.1 290 | SR load create (X:I) (Y:S) (Z:I) (A:I) | Create a load |
291 | - | (X):I:Controller GlobalId (Y):S:Name (Z):I:Bus Index (A):I:Load Index |
292 | SR load create (X:I) (Y:S) (Z:I) (A | Create a remote load |
293 | :I) (B:I) | |
294 | - | (X):I:Controller GlobalId (Y):S:Name (Z):I:Bus Index (A):I:Load Index (B):I:Remote Device ID |
Alexander Mott 3.1 295 | SR load move (X:I) (Y:I) (Z:I) (A:I | Move within a single controller |
296 | ) (B:I) | |
297 | - | (X):I:Controller GlobalId (Y):I:Old Bus Index (Z):I:Old Load Index (A):I:New Bus Index (B):I:New Load Index, -999 to auto-assign |
298 | SR load move (X:I) (Y:I) (Z:I) (A:I | Move a load from one controller to another |
299 | ) (B:I) (C:I) | |
300 | - | (X):I:Old Controller GlobalId (Y):I:Old Bus Index (Z):I:Old Load Index (A):I:New Controller GlobalId (B):I:New Bus Index (C):I:New Load I |
301 | | ndex, -999 to auto-assign |
302 | SR lwapi client (X:I) start | Start a LWAPI Client to a remote system |
303 | - | (X):I:Remote System Id |
304 | SR lwapi client (X:I) stop | Stop a LWAPI Client to a remote system |
305 | - | (X):I:Remote System Id |
306 | SR lwapi client debug (X:B) | Enable/Disable LWAPI Client Debug |
307 | - | (X):B:Enable/Disable |
308 | SR lwapi client queue size | Get the number of messages allowed in the LWAPI client queue |
309 | SR lwapi client queue size (X:I) | Set the number of messages allowed in the LWAPI client queue |
310 | - | (X):I:Number of Messages allowed in queue |
311 | SR lwapi enable (X:B) | Enables/Disables the LWAPI, a program restart will happen. |
312 | - | (X):B:Enabled true|false |
313 | SR lwapi server queue size | Get the number of messages allowed in the LWAPI server queue |
314 | SR lwapi server queue size (X:I) | Set the number of messages allowed in the LWAPI server queue |
315 | - | (X):I:Number of Messages allowed in queue |
316 | SR master override (X:B) | Activates/Deactivates Master Override. |
317 | - | (X):B:Active true|false |
318 | SR master override status | Shows master override status. |
Alexander Mott 5.1 319 | SR occupancy create (X:S) (Y:S) (Z: | Create a remote occupancy sensor |
320 | I) (A:I) | |
321 | - | (X):S:Name (Y):S:Model (Z):I:Remote System Id (A):I:GlobalId |
322 | SR occupancy create (X:S) (Y:S) (Z: | Create an occupancy sensor |
323 | S) (A:I) (B:S) (C:I) | |
324 | - | (X):S:Name (Y):S:Model (Z):S:IP-ID (A):I:Branch (B):S:Cresnet ID (C):I:Host Port |
Alexander Mott 3.1 325 | SR rcon disable | Disables RCON to a specified object |
326 | SR rcon enable (X:I) | Enables RCON to a specified object |
327 | - | (X):I:Global ID |
328 | SR rcon send (X:S) | Sends RCON Command |
329 | - | (X):S:Command |
330 | SR recall scene (X:I) (Y:I) | Recall a Scene for a Area |
331 | - | (X):I:Area ID (Y):I:Scene ID |
332 | SR register (X:I) | Registers an object by Global Id |
333 | - | (X):I:Global ID |
334 | SR remote system auth (X:I) (Y:S) (Z:S) | Enables authentication for a remote system w/o CWS User |
335 | - | (X):I:ID (Y):S:API Key (Z):S:API Secret |
336 | SR remote system auth (X:I) (Y:S) ( | Enables authentication for a remote system w/ a CWS User |
337 | Z:S) (A:S) (B:S) | |
338 | - | (X):I:ID (Y):S:API Key (Z):S:API Secret (A):S:CWS Username (B):S:CWS Password |
339 | SR rf device claim (X:S) | Claims rf devices attached to a gateway |
340 | - | (X):S:Gateway IP-ID |
341 | SR save config | Saves the config |
342 | SR set fadetime scene (X:I) (Y:I) (Z:D) | Set the fade time for the scene in a Area |
343 | - | (X):I:Area ID (Y):I:Scene ID (Z):D:Fade Time |
344 | SR set hardware property (X:S) (Y:S | Temporarily set a property for the underlying hardware directly on the device |
345 | ) (Z:S) | |
346 | - | (X):S:Global ID(s) Comma and Dash Separated permitted (Y):S:Path (Z):S:New Value |
347 | SR set occupancy timeout (X:I) | Set the timeout for all configurable occ sensors |
348 | - | (X):I:Timeout in Seconds |
349 | SR set property (X:S) (Y:S) (Z:S) | Set a property for a global ID |
350 | - | (X):S:Global ID(s) Comma and Dash Separated permitted (Y):S:Path (Z):S:New Value |
351 | SR shade (X:I) close | Triggers close on a shade |
352 | - | (X):I:Shade Global ID |
353 | SR shade (X:I) open | Triggers open on a shade |
354 | - | (X):I:Shade Global ID |
355 | SR shade (X:I) stop | Triggers stop on a shade |
356 | - | (X):I:Shade Global ID |
357 | SR show actions | List available actions by type |
358 | SR show actions (X:S) | List available actions for a specific global ID |
359 | - | (X):S:Global ID or UniqueId |
360 | SR show api clients | List API clients |
361 | SR show api clients brief | List API clients w/o devices |
362 | SR show area (X:I) loads | List loads for a specific area |
363 | - | (X):I:Area ID |
364 | SR show area (X:I) presentation loads | List loads for a specific area as presented to user |
365 | - | (X):I:Area ID |
366 | SR show area (X:I) presentation shades | List shades for a specific area as presented to user |
367 | - | (X):I:Area ID |
368 | SR show area (X:I) scene array | Show the scene a |
369 | - | (X):I:Area ID |
Alexander Mott 5.1 370 | SR show area ethernet | List areas with their IP-IDs |
371 | SR show area hardware | List areas with hardware |
372 | SR show area hardware (X:I) | List area with hardware |
373 | - | (X):I:Area Global Id |
374 | SR show area hardware ids (X:S) | List area with hardware |
375 | - | (X):S:AreaID(s) |
376 | SR show area hardware name (X:S) | List area with hardware |
377 | - | (X):S:Area Name |
Alexander Mott 3.1 378 | SR show area links | List areas links |
379 | SR show area loads | List areas with status |
380 | SR show area power | List areas with power |
381 | SR show areas | List areas with status |
Alexander Mott 5.1 382 | SR show areas occupancy | List areas with occupancy details |
Alexander Mott 3.1 383 | SR show assembly versions | List software assembly versions |
384 | SR show astronomical clock | List astronomical clock details |
385 | SR show astronomical clock (X:S) | List astronomical clock details for a date |
386 | - | (X):S:Date |
387 | SR show calendars | Show Calendars |
388 | SR show cct schedule | Show the CCT schedule |
389 | SR show cct status | Show the CCT schedule |
390 | SR show cresnet devices | List Cresnet Devices |
391 | SR show details | List config details |
392 | SR show devices | show devices by serial number |
393 | SR show diag (X:I) | List diagnostics for a specific device |
394 | - | (X):I:Global ID |
395 | SR show edmx receiver buffer (X:I) | Output the receiver buffer for an E-DMX Receiver |
396 | - | (X):I:Receiver Global ID |
397 | SR show edmx receivers | List edmx receivers with status |
398 | SR show eiscs | List eisc with status |
399 | SR show ethernet devices | List Ethernet Devices |
400 | SR show extensions | Show loaded extensions |
401 | SR show FadeEngine status | Outputs the status of the fade engine |
402 | SR show global actions | List global actions |
403 | SR show global ids | List all devices by Global ID |
404 | SR show global timed events | List global timed events |
405 | SR show hvac | List HVAC |
406 | SR show hvac detailed | List HVAC |
407 | SR show keypad actions | List keypads with actions |
408 | SR show keypad templates | List keypad templatess with actions |
409 | SR show keypads | List keypads with status |
410 | SR show keyswitches | List keyswitches with status |
411 | SR show license | Show license information |
412 | SR show load (X:I) priority array | Show the priority array |
413 | - | (X):I:Load Global ID |
414 | SR show load groups | List load groups |
415 | SR show load groups (X:S) | List load groups by area IDs |
416 | - | (X):S:Area IDs |
417 | SR show load scenes | List load scenes |
418 | SR show loads | List loads |
419 | SR show loads extended | List loads w/ extended hardware info |
420 | SR show loads power | List loads with power |
421 | SR show lwapi client token actions | List LWAPI clients token actions |
422 | SR show lwapi clients | List LWAPI clients |
423 | SR show lwapi clients brief | List LWAPI clients w/o device details |
Alexander Mott 5.1 424 | SR show networks | List attached networks |
Alexander Mott 3.1 425 | SR show object counts | List object counts |
426 | SR show occupancy sensors | List occupancy sensors with status |
427 | SR show outputs | List outputs with status |
428 | SR show partition sensors | List partition sensors with status |
429 | SR show paths | List paths for active config |
430 | SR show photocells sensors | List photocell sensors with status |
431 | SR show remote systems | List remote systems |
432 | SR show rf devices | List RF Devices |
433 | SR show schedule groups | Show schedule groups |
434 | SR show schedules | Show schedule |
435 | SR show shade groups | List shade groups |
436 | SR show shade groups (X:S) | List load groups by area IDs |
437 | - | (X):S:Area IDs |
438 | SR show shades | List shades |
439 | SR show tags | Show tags |
440 | SR show uis | Show user interfaces |
441 | SR show users | Show users |
442 | SR show zum floor hubs | Shows all Zum Floor Hubs defined. |
443 | SR show zum rooms | Shows all Zum rooms with status. |
444 | SR simulate keypad (X:I) (Y:I) (Z:S) | Simulate a keypad |
445 | - | (X):I:Keypad ID (Y):I:Button (Z):S:State: Unknown|Press|Release|Tap|DoubleTap|Hold |
446 | SR simulate keyswitch (X:I) (Y:B) | Simulate a keyswitch |
447 | - | (X):I:Keyswitch ID (Y):B:State |
448 | SR simulate loadcontroller occupanc | Simulate occupancy on a load controller (if supported) |
449 | y (X:S) (Y:B) | |
450 | - | (X):S:Load Controller GlobalId or UniqueId (Y):B:State |
451 | SR simulate occupancy (X:I) (Y:B) | Simulate an occupancy sensor |
452 | - | (X):I:Occupancy ID (Y):B:State |
453 | SR simulate partition (X:I) (Y:B) | Simulate a partiton sensor |
454 | - | (X):I:Partiton Sensor Global ID (Y):B:State (true=Combined, false=Divided) |
455 | SR simulate photocell (X:I) (Y:I) | Simulate a photocell |
456 | - | (X):I:Photocell ID (Y):I:State |
457 | SR simulate serial (X:I) (Y:S) | Simulate serial input |
458 | - | (X):I:Serial Interface ID (Y):S:Cmd |
459 | SR tcp disable | Disable TCP Listener |
460 | SR tcp enable (X:I) (Y:I) | Enable TCP Listener |
461 | - | (X):I:Listen Port (Y):I:Max Connections |
462 | SR udp debug (X:B) | Set/Clear UDP Debug |
463 | - | (X):B:Enable/Disable Debug |
464 | SR udp disable | Disable UDP Listener |
465 | SR udp enable (X:I) | Enable UDP Listener |
466 | - | (X):I:Listen Port |
467 | SR unregister (X:I) | Unregisters an object by Global Id |
468 | - | (X):I:Global ID |
469 | SR version | Returns the current version of ShowRunner |
Alexander Mott 5.1 470 | SR zum add scene 16 (X:B) | Adds scene 16 to all areas using Zum as load controllers. |
471 | - | (X):B:Dry Run |
Alexander Mott 3.1 472 | SR zum enable (X:B) | Enables/Disables Zum, a program restart will happen. |
473 | - | (X):B:Enabled true|false |
474 | SR zummesh dr level (X:I) | Sets the demand response level for all ZUMMESH-NETBRIDGE controllers. |
475 | - | (X):I:DR Level (0-100) |
476 | SR zummesh keypad custom buttons (X | Enables custom buttons on a ZUMMESH-KEYPAD, NETBRIDGE must be defined as load controller. |
477 | :S) (Y:S) (Z:S) (A:I) (B:S) | |
478 | - | (X):S:Gateway IP-ID (Y):S:Netbridge RF-ID (Z):S:Keypad Device Address (A):I:Keypad Id (B):S:Buttons to customize |
479 | SR zummesh show devices (X:S) (Y:S) | Returns the devices attached to a NETBRIDGE |
480 | - | (X):S:Gateway IP-ID (Y):S:Netbridge RF-ID |
Alexander Mott 5.1 481 | SR zumnet show occupancy | Shows occupancy status for wired ZUM DIN/JBOX inputs |
482 | SR zumnet show photocell | Shows photocell status for wired ZUM DIN/JBOX inputs |
Alexander Mott 3.1 483 | SR watchdog petting enabled (X:B) | Enable/disable watchdog petting |
484 | - | (X):B:Enable|Disable |
485 | SR watchdog petting enabled default | Set watchdog petting to the default (only enabled on 3-series) |
486 | SR watchdog petting interval (X:I) | Set the petting interval in seconds |
487 | - | (X):I:Interval in seconds (between 1 and 60) |
488 | SR watchdog petting interval default | Set the petting interval to the default of 10000ms |
489 | SR watchdog petting status | Get the dog petting status |
490 |-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
Alexander Mott 5.1 491 Count: 433
Mark Kohlmann 1.1 492 Variables represented by brackets with a letter '{X}' can be specified in the following formats:
493 B:Binary - true or false
Alexander Mott 3.1 494 D:Double - A floating point number. Examples: 3.205 or 3
Mark Kohlmann 1.1 495 I:Integer - A whole number. Examples: 10 or -50
496 S:String - A collection of characters. Encapsulate in quotes if there is a space. Example: "Hello World"
Alexander Mott 5.1 497
498 RMC4>sradmin ?
499 Help for SRADMIN
500 +--------------------------------------------+-----------------------------------------------------------------------------------------------------------+
501 | Command | Help |
502 |--------------------------------------------|-----------------------------------------------------------------------------------------------------------|
503 | SRADMIN add api user (X:S) (Y:S) | Add an API User |
504 | - | (X):S:Name (Y):S:Group |
505 | SRADMIN add remote user (X:S) (Y:S) (Z:S) | Adds a user for remote connections |
506 | - | (X):S:Name (Y):S:Username (Z):S:Password |
507 | SRADMIN add user (X:S) (Y:S) (Z:S) (A:S) | Add a User |
508 | - | (X):S:Username (Y):S:Name (Z):S:Group (A):S:Password |
509 | SRADMIN assign remote user API (X:I) (Y:S) | Assign a remote user to a remote system for API purposes |
510 | - | (X):I:SystemId (Y):S:UserId |
511 | SRADMIN assign remote user CWS (X:I) (Y:S) | Assign a remote user to a remote system for CWS purposes |
512 | - | (X):I:SystemId (Y):S:UserId |
513 | SRADMIN clear remote user API (X:I) | Assign a remote user to a remote system for API purposes |
514 | - | (X):I:SystemId |
515 | SRADMIN clear remote user CWS (X:I) | Clear remote user from a remote system for CWS purposes |
516 | - | (X):I:SystemId |
517 | SRADMIN create cws user | Creates the cws user used by ShowRunner clients |
518 | SRADMIN create sradmin user (X:S) (Y:S) | Creates the SR Admin user used by ShowRunner |
519 | - | (X):S:Processor Admin Username (Y):S:Processor Admin Password |
520 | SRADMIN delete api user (X:S) | Deletes an API User |
521 | - | (X):S:User Id |
522 | SRADMIN delete config (X:B) | Deletes the configuration and restarts the program. This cannot be undone. |
523 | - | (X):B:YES |
524 | SRADMIN delete cws user | Deletes the cws user used by ShowRunner clients |
525 | SRADMIN delete sradmin user | Deletes the sradmin user used by ShowRunner |
526 | SRADMIN delete user (X:S) | Deletes a User |
527 | - | (X):S:User Id |
528 | SRADMIN delete web session (X:S) | Deletes a web session |
529 | - | (X):S:SessionID |
530 | SRADMIN import jwk (X:S) | Import JWK from a separate showrunner system |
531 | - | (X):S:Host |
532 | SRADMIN reset api user secret (X:S) (Y:S) | Resets an api users secret to the new one provided |
533 | - | (X):S:Username (Y):S:Secret |
534 | SRADMIN reset cws user | Resets the cws user used by ShowRunner clients |
535 | SRADMIN reset user password (X:S) (Y:S) | Resets a users password to the new one provided |
536 | - | (X):S:Username (Y):S:Password |
537 | SRADMIN restart | Restart the program |
538 | SRADMIN set temp password (X:S) | Resets a users password to a randomly generated password and requires them to change it on the next login |
539 | - | (X):S:Username |
540 | SRADMIN show api users | Show api users |
541 | SRADMIN show user groups | Show user groups |
542 | SRADMIN show user groups detailed | Show user groups |
543 | SRADMIN show users | Show users |
544 | SRADMIN show web server routes | Shows the web server routes. |
545 | SRADMIN show web sessions | Shows the web sessions. |
546 | SRADMIN test api user auth (X:S) (Y:S) | Tests api user authentication |
547 | - | (X):S:ApiKey (Y):S:ApiSecret |
548 | SRADMIN test user auth (X:S) (Y:S) | Tests user authentication |
549 | - | (X):S:Username (Y):S:Password |
550 |--------------------------------------------|-----------------------------------------------------------------------------------------------------------|
551 Count: 47
552 Variables represented by brackets with a letter '{X}' can be specified in the following formats:
553 B:Binary - true or false
554 D:Double - A floating point number. Examples: 3.205 or 3
555 I:Integer - A whole number. Examples: 10 or -50
556 S:String - A collection of characters. Encapsulate in quotes if there is a space. Example: "Hello World"
Mark Kohlmann 1.1 557 }}}