Changes for page ShowRunnerCLC™ Command Line Interface

Summary

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

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Command Line Interface (Text Console)
	1	+ShowRunnerCLC™ Command Line Interface

Content

...	...	@@ -1,12 +1,23 @@
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.
	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)
2	2
3		-{{{RMC4>sr ver
4		-ShowRunner Version: 3.52.8851.36446
	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
5	5
	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	6
7		-RMC4>sr ?
	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	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 "
9	9
	15	+The commands below are an example, and available commands may vary depending on the version of ShowRunnerCLC™ installed on the processor
	16	+
	17	+{{{RMC4>sr ver
	18	+ShowRunner Version: 3.77.9371.28731
	19	+
	20	+RMC4>sr ?
10	10	Help for SR
11	11	+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
12	12	| Command | Help |
...	...	@@ -13,8 +13,31 @@
13	13	|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
14	14	| SR activate (X:I) | Activates an object by Global Id |
15	15	| - | (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 |
16	16	| SR api enable (X:B) | Enables/Disables the WebSocket API, a program restart will happen. |
17	17	| - | (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 |
18	18	| SR areas scenes editable | Makes all scenes on all areas user editable |
19	19	| SR bacnet area features (X:S) | Set the BACNET features for all areas and defaults |
20	20	| - | (X):S:BACNET Features |
...	...	@@ -40,6 +40,15 @@
40	40	| SR config select set (X:S) | Sets the config to an alternate |
41	41	| - | (X):S:ConfigAltName |
42	42	| 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 |
43	43	| SR cresnet auto query | Automatic Cresnet Query Status |
44	44	| SR cresnet auto query (X:B) | Automatic Cresnet Query Setting |
45	45	| - | (X):B:Enable/Disable |
...	...	@@ -75,6 +75,8 @@
75	75	| SR debug logic Area | Toggle debug status |
76	76	| SR debug logic Bacnet | Toggle debug status |
77	77	| SR debug logic CCT | Toggle debug status |
	121	+| SR debug logic Discovery | Toggle debug status |
	122	+| SR debug logic HVAC | Toggle debug status |
78	78	| SR debug logic Joins | Toggle debug status |
79	79	| SR debug logic Loads | Toggle debug status |
80	80	| SR debug logic off | Turn off debug |
...	...	@@ -81,6 +81,7 @@
81	81	| SR debug logic Schedule | Toggle debug status |
82	82	| SR debug logic Sensors | Toggle debug status |
83	83	| SR debug logic Shades | Toggle debug status |
	129	+| SR debug logic UI | Toggle debug status |
84	84	| SR debug uis (X:B) | Set UI debug status |
85	85	| - | (X):B:Set Debug To |
86	86	| SR debug zum (X:B) | Enables/disables Zum Floor Hub Debug. |
...	...	@@ -87,6 +87,11 @@
87	87	| - | (X):B:Enable/Disable Debug |
88	88	| SR debug zum crestron (X:S) | Debug Crestron Zum libraries |
89	89	| - | (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 |
90	90	| SR devmgr cresnet bridge show branc | Prints out all branches with status |
91	91	| hes (X:S) (Y:S) | |
92	92	| - | (X):S:IP-ID (Y):S:Type |
...	...	@@ -135,6 +135,10 @@
135	135	| SR dhcp server enable | Enables the internal DHCP Server with default values and a range of 1/2 the subnet |
136	136	| SR discover (X:I) | Initiate Discovery |
137	137	| - | (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 |
138	138	| SR discover scenes (X:I) | Discover scenes on a device |
139	139	| - | (X):I:Device Global ID |
140	140	| SR discover zummesh (X:B) | Initiate Zum Wireless Discovery |
...	...	@@ -154,6 +154,8 @@
154	154	| - | (X):S:IP Address or Hostname |
155	155	| SR ethernet device claim (X:S) (Y:S) | Claims an ethernet device discovered by Ethernet Autodiscovery at the specified IP-ID |
156	156	| - | (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 |
157	157	| SR eventlog (X:B) | Activates/Deactivates the Event Log. |
158	158	| - | (X):B:Active true|false |
159	159	| SR eventlog console (X:B) | Activates/Deactivates the Event Log to console. |
...	...	@@ -191,6 +191,12 @@
191	191	| - | (X):I:Global ID |
192	192	| SR get properties (X:I) | Gets the properties for a global ID |
193	193	| - | (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 |
194	194	| SR load (X:I) cct (Y:I) | Set the CCT for a load |
195	195	| - | (X):I:Load Global ID (Y):I:CCT in Kelvin |
196	196	| SR load (X:I) cct copy from (Y:I) | Copy CCT Settings from one load to another |
...	...	@@ -224,6 +224,11 @@
224	224	| - | (X):S:Load Global ID (Y):I:Scene ID (Z):I:0-100% |
225	225	| SR load (X:S) scene (Y:I) (Z:I) (A:D) | Set intensity and fade time for given loads |
226	226	| - | (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 |
227	227	| SR load move (X:I) (Y:I) (Z:I) (A:I | Move within a single controller |
228	228	| ) (B:I) | |
229	229	| - | (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 |
...	...	@@ -248,6 +248,12 @@
248	248	| SR master override (X:B) | Activates/Deactivates Master Override. |
249	249	| - | (X):B:Active true|false |
250	250	| 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 |
251	251	| SR rcon disable | Disables RCON to a specified object |
252	252	| SR rcon enable (X:I) | Enables RCON to a specified object |
253	253	| - | (X):I:Global ID |
...	...	@@ -293,10 +293,19 @@
293	293	| - | (X):I:Area ID |
294	294	| SR show area (X:I) scene array | Show the scene a |
295	295	| - | (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 |
296	296	| SR show area links | List areas links |
297	297	| SR show area loads | List areas with status |
298	298	| SR show area power | List areas with power |
299	299	| SR show areas | List areas with status |
	382	+| SR show areas occupancy | List areas with occupancy details |
300	300	| SR show assembly versions | List software assembly versions |
301	301	| SR show astronomical clock | List astronomical clock details |
302	302	| SR show astronomical clock (X:S) | List astronomical clock details for a date |
...	...	@@ -338,6 +338,7 @@
338	338	| SR show lwapi client token actions | List LWAPI clients token actions |
339	339	| SR show lwapi clients | List LWAPI clients |
340	340	| SR show lwapi clients brief | List LWAPI clients w/o device details |
	424	+| SR show networks | List attached networks |
341	341	| SR show object counts | List object counts |
342	342	| SR show occupancy sensors | List occupancy sensors with status |
343	343	| SR show outputs | List outputs with status |
...	...	@@ -383,6 +383,8 @@
383	383	| SR unregister (X:I) | Unregisters an object by Global Id |
384	384	| - | (X):I:Global ID |
385	385	| 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 |
386	386	| SR zum enable (X:B) | Enables/Disables Zum, a program restart will happen. |
387	387	| - | (X):B:Enabled true|false |
388	388	| SR zummesh dr level (X:I) | Sets the demand response level for all ZUMMESH-NETBRIDGE controllers. |
...	...	@@ -392,6 +392,8 @@
392	392	| - | (X):S:Gateway IP-ID (Y):S:Netbridge RF-ID (Z):S:Keypad Device Address (A):I:Keypad Id (B):S:Buttons to customize |
393	393	| SR zummesh show devices (X:S) (Y:S) | Returns the devices attached to a NETBRIDGE |
394	394	| - | (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 |
395	395	| SR watchdog petting enabled (X:B) | Enable/disable watchdog petting |
396	396	| - | (X):B:Enable|Disable |
397	397	| SR watchdog petting enabled default | Set watchdog petting to the default (only enabled on 3-series) |
...	...	@@ -400,10 +400,70 @@
400	400	| SR watchdog petting interval default | Set the petting interval to the default of 10000ms |
401	401	| SR watchdog petting status | Get the dog petting status |
402	402	|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
403		-Count: 368
	491	+Count: 433
404	404	Variables represented by brackets with a letter '{X}' can be specified in the following formats:
405	405	B:Binary - true or false
406	406	D:Double - A floating point number. Examples: 3.205 or 3
407	407	I:Integer - A whole number. Examples: 10 or -50
408	408	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"
409	409	}}}