Changes for page ShowRunnerCLC™ Command Line Interface

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,21 +1,7 @@
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)
	1	+ShowRunnerCLC™ has a robust and powerful command line interface.  "SR" (alternate "lightingmgr") is registered with the processor's console service.  Help is context sensitive and can be accessed by typing a ? at the end of the command and pressing enter.  From the processor's console type "sr ?" + Enter (previously "lightingmgr") to bring up the help for all commands.  After "sr" all command segments may be abbreviated if the console handler can determine the exact command being requested.  Some commands require variables.  The presence of a variable will be indicated by (X:T) where X is a letter assigned to the variable and T represents the type.  Valid types are B - Binary, D - Double, I - Integer, and S - String.  Strings may use quotes to keep all text together if the string being typed has a space.  Commands may be added at any time with new versions.
2	2
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		-
17	17	{{{RMC4>sr ver
18		-ShowRunner Version: 3.77.9371.28731
	4	+ShowRunner Version: 3.52.8851.36446
19	19
20	20	RMC4>sr ?
21	21	Help for SR
...	...	@@ -24,31 +24,8 @@
24	24	|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
25	25	| SR activate (X:I) | Activates an object by Global Id |
26	26	| - | (X):I:Global ID |
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 |
30	30	| SR api enable (X:B) | Enables/Disables the WebSocket API, a program restart will happen. |
31	31	| - | (X):B:Enabled true|false |
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 |
52	52	| SR areas scenes editable | Makes all scenes on all areas user editable |
53	53	| SR bacnet area features (X:S) | Set the BACNET features for all areas and defaults |
54	54	| - | (X):S:BACNET Features |
...	...	@@ -74,15 +74,6 @@
74	74	| SR config select set (X:S) | Sets the config to an alternate |
75	75	| - | (X):S:ConfigAltName |
76	76	| SR config select show | Shows the config alternate selection |
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 |
86	86	| SR cresnet auto query | Automatic Cresnet Query Status |
87	87	| SR cresnet auto query (X:B) | Automatic Cresnet Query Setting |
88	88	| - | (X):B:Enable/Disable |
...	...	@@ -118,8 +118,6 @@
118	118	| SR debug logic Area | Toggle debug status |
119	119	| SR debug logic Bacnet | Toggle debug status |
120	120	| SR debug logic CCT | Toggle debug status |
121		-| SR debug logic Discovery | Toggle debug status |
122		-| SR debug logic HVAC | Toggle debug status |
123	123	| SR debug logic Joins | Toggle debug status |
124	124	| SR debug logic Loads | Toggle debug status |
125	125	| SR debug logic off | Turn off debug |
...	...	@@ -126,7 +126,6 @@
126	126	| SR debug logic Schedule | Toggle debug status |
127	127	| SR debug logic Sensors | Toggle debug status |
128	128	| SR debug logic Shades | Toggle debug status |
129		-| SR debug logic UI | Toggle debug status |
130	130	| SR debug uis (X:B) | Set UI debug status |
131	131	| - | (X):B:Set Debug To |
132	132	| SR debug zum (X:B) | Enables/disables Zum Floor Hub Debug. |
...	...	@@ -133,11 +133,6 @@
133	133	| - | (X):B:Enable/Disable Debug |
134	134	| SR debug zum crestron (X:S) | Debug Crestron Zum libraries |
135	135	| - | (X):S:State: Off|Normal|Developer|Verbose |
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 |
141	141	| SR devmgr cresnet bridge show branc | Prints out all branches with status |
142	142	| hes (X:S) (Y:S) | |
143	143	| - | (X):S:IP-ID (Y):S:Type |
...	...	@@ -186,10 +186,6 @@
186	186	| SR dhcp server enable | Enables the internal DHCP Server with default values and a range of 1/2 the subnet |
187	187	| SR discover (X:I) | Initiate Discovery |
188	188	| - | (X):I:Global ID |
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 |
193	193	| SR discover scenes (X:I) | Discover scenes on a device |
194	194	| - | (X):I:Device Global ID |
195	195	| SR discover zummesh (X:B) | Initiate Zum Wireless Discovery |
...	...	@@ -209,8 +209,6 @@
209	209	| - | (X):S:IP Address or Hostname |
210	210	| SR ethernet device claim (X:S) (Y:S) | Claims an ethernet device discovered by Ethernet Autodiscovery at the specified IP-ID |
211	211	| - | (X):S:IP Address or Hostname (Y):S:IP-ID to use [In Hex] |
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 |
214	214	| SR eventlog (X:B) | Activates/Deactivates the Event Log. |
215	215	| - | (X):B:Active true|false |
216	216	| SR eventlog console (X:B) | Activates/Deactivates the Event Log to console. |
...	...	@@ -248,12 +248,6 @@
248	248	| - | (X):I:Global ID |
249	249	| SR get properties (X:I) | Gets the properties for a global ID |
250	250	| - | (X):I:Global ID |
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 |
257	257	| SR load (X:I) cct (Y:I) | Set the CCT for a load |
258	258	| - | (X):I:Load Global ID (Y):I:CCT in Kelvin |
259	259	| SR load (X:I) cct copy from (Y:I) | Copy CCT Settings from one load to another |
...	...	@@ -287,11 +287,6 @@
287	287	| - | (X):S:Load Global ID (Y):I:Scene ID (Z):I:0-100% |
288	288	| SR load (X:S) scene (Y:I) (Z:I) (A:D) | Set intensity and fade time for given loads |
289	289	| - | (X):S:Load Global ID (Y):I:Scene ID (Z):I:0-100% (A):D:Fade Time |
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 |
295	295	| SR load move (X:I) (Y:I) (Z:I) (A:I | Move within a single controller |
296	296	| ) (B:I) | |
297	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 |
...	...	@@ -316,12 +316,6 @@
316	316	| SR master override (X:B) | Activates/Deactivates Master Override. |
317	317	| - | (X):B:Active true|false |
318	318	| SR master override status | Shows master override status. |
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 |
325	325	| SR rcon disable | Disables RCON to a specified object |
326	326	| SR rcon enable (X:I) | Enables RCON to a specified object |
327	327	| - | (X):I:Global ID |
...	...	@@ -367,19 +367,10 @@
367	367	| - | (X):I:Area ID |
368	368	| SR show area (X:I) scene array | Show the scene a |
369	369	| - | (X):I:Area ID |
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 |
378	378	| SR show area links | List areas links |
379	379	| SR show area loads | List areas with status |
380	380	| SR show area power | List areas with power |
381	381	| SR show areas | List areas with status |
382		-| SR show areas occupancy | List areas with occupancy details |
383	383	| SR show assembly versions | List software assembly versions |
384	384	| SR show astronomical clock | List astronomical clock details |
385	385	| SR show astronomical clock (X:S) | List astronomical clock details for a date |
...	...	@@ -421,7 +421,6 @@
421	421	| SR show lwapi client token actions | List LWAPI clients token actions |
422	422	| SR show lwapi clients | List LWAPI clients |
423	423	| SR show lwapi clients brief | List LWAPI clients w/o device details |
424		-| SR show networks | List attached networks |
425	425	| SR show object counts | List object counts |
426	426	| SR show occupancy sensors | List occupancy sensors with status |
427	427	| SR show outputs | List outputs with status |
...	...	@@ -467,8 +467,6 @@
467	467	| SR unregister (X:I) | Unregisters an object by Global Id |
468	468	| - | (X):I:Global ID |
469	469	| SR version | Returns the current version of ShowRunner |
470		-| SR zum add scene 16 (X:B) | Adds scene 16 to all areas using Zum as load controllers. |
471		-| - | (X):B:Dry Run |
472	472	| SR zum enable (X:B) | Enables/Disables Zum, a program restart will happen. |
473	473	| - | (X):B:Enabled true|false |
474	474	| SR zummesh dr level (X:I) | Sets the demand response level for all ZUMMESH-NETBRIDGE controllers. |
...	...	@@ -478,8 +478,6 @@
478	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	479	| SR zummesh show devices (X:S) (Y:S) | Returns the devices attached to a NETBRIDGE |
480	480	| - | (X):S:Gateway IP-ID (Y):S:Netbridge RF-ID |
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 |
483	483	| SR watchdog petting enabled (X:B) | Enable/disable watchdog petting |
484	484	| - | (X):B:Enable|Disable |
485	485	| SR watchdog petting enabled default | Set watchdog petting to the default (only enabled on 3-series) |
...	...	@@ -488,70 +488,10 @@
488	488	| SR watchdog petting interval default | Set the petting interval to the default of 10000ms |
489	489	| SR watchdog petting status | Get the dog petting status |
490	490	|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
491		-Count: 433
	400	+Count: 368
492	492	Variables represented by brackets with a letter '{X}' can be specified in the following formats:
493	493	B:Binary - true or false
494	494	D:Double - A floating point number. Examples: 3.205 or 3
495	495	I:Integer - A whole number. Examples: 10 or -50
496	496	S:String - A collection of characters. Encapsulate in quotes if there is a space. Example: "Hello World"
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"
557	557	}}}