Command Line Interface (Text Console)
Version 1.3 by Mark Kohlmann on 2022/09/19 18:28
SHOWRUNNER™ 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.
RMC3>sr ?
Help for SR
+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| Command | Help |
|----------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
| SR api enable (X:B) | Enables/Disables the WebSocket API, a program restart will happen. |
| - | (X):B:Enabled true|false |
| SR bacnet enable (X:B) | Enables/Disables Bacnet, a program restart will happen. |
| - | (X):B:Enabled true|false |
| SR cct demo start | Start CCT Demo |
| SR cct demo stop | Stop CCT Demo |
| SR cresnet discover | Discover Cresnet. |
| SR cresnet query | Query Cresnet. |
| SR dali (X:I) dump | Dumps known data regarding ballasts/drivers |
| - | (X):I:Controller Global ID |
| SR dali (X:I) query | Forces a query of the settings in the DIN-DALI-2 |
| - | (X):I:Controller Global ID |
| SR dali (X:I) read ballastConfig (Y:I) (Z:S) | Forces a reading of all ballast settings into the DIN-DALI-2 |
| - | (X):I:Controller Global ID (Y):I:Loop (Z):S:Address (0-63 or All) |
| SR dali (X:I) set (Y:I) (Z:S) (A:I) fadetime (B:I) | Sets the fade time on all, ballast, group, or unaddressed |
| - | (X):I:Controller Global ID (Y):I:Loop (Z):S:Type: All|Group|Ballast|Unaddressed (A):I:Address (B):I:Fade Time Index |
| SR dali (X:I) status | Reports the status of the DIN-DALI-2 |
| - | (X):I:Controller Global ID |
| SR debug api server | Show the current debug status |
| SR debug api server (X:B) | Set the current debug state |
| - | (X):B:Debug |
| SR debug controller (X:I) (Y:B) | Set debug status |
| - | (X):I:Controller ID (Y):B:Set Debug To |
| SR debug FadeEngine (X:B) | Enable fade engine debug |
| - | (X):B:Enable/Disable |
| SR debug hardware (X:B) | Set debug status |
| - | (X):B:Set Debug To |
| SR debug logic | Show Debug Status |
| SR debug logic Actions | Toggle debug status |
| SR debug logic API | Toggle debug status |
| SR debug logic Area | Toggle debug status |
| SR debug logic Bacnet | Toggle debug status |
| SR debug logic CCT | Toggle debug status |
| SR debug logic Joins | Toggle debug status |
| SR debug logic Loads | Toggle debug status |
| SR debug logic off | Turn off debug |
| SR debug logic Schedule | Toggle debug status |
| SR debug logic Sensors | Toggle debug status |
| SR debug uis (X:B) | Set UI debug status |
| - | (X):B:Set Debug To |
| SR debug zum (X:B) | Enables/disables Zum Floor Hub Debug. |
| - | (X):B:Enable/Disable Debug |
| SR debug zum crestron (X:S) | null |
| - | (X):S:State: Off|Normal|Developer|Verbose |
| SR devmgr ethernet clear iptable (X:S) | Clears all ip table entries |
| - | (X):S:IP Address or Hostname |
| SR devmgr ethernet query | Initiates an autodiscovery query |
| SR devmgr ethernet set iptable (X:S) (Y:S) | Sets the IP Table Entry |
| - | (X):S:IP Address or Hostname (Y):S:IP-ID in hex |
| SR devmgr ethernet show devices | Prints the discovered devices |
| SR devmgr rf (X:S) devices | Shows the devices on an RF gateway |
| - | (X):S:IP-ID of RF Gateway |
| SR devmgr rf (X:S) query | Queries the devices on an RF gateway |
| - | (X):S:IP-ID of RF Gateway |
| SR devmgr rf rcon disable | Disables current RCON |
| SR devmgr rf rcon enable (X:S) | Enables RCON to the specified RF Gateway |
| - | (X):S:IP-ID of RF Gateway |
| SR devmgr rf rcon send (X:S) | Sends RCON Command |
| - | (X):S:Command |
| SR discover (X:I) | Initiate Discovery |
| - | (X):I:Global ID |
| SR dr (X:B) | Activates/Deactivates Demand Response. |
| - | (X):B:Active true|false |
| SR dr status | Shows demand response status. |
| SR eisc add | Creates a new EISC |
| SR eisc delete (X:S) | Deletes an EISC at the specified EISC |
| - | (X):S:IP-ID |
| SR ethernet device claim (X:S) | Claims an ethernet device discovered by Ethernet Autodiscovery |
| - | (X):S:IP Address or Hostname |
| SR ethernet device claim (X:S) (Y:S) | Claims an ethernet device discovered by Ethernet Autodiscovery at the specified IP-ID |
| - | (X):S:IP Address or Hostname (Y):S:IP-ID to use [In Hex] |
| SR eventlog (X:B) | Activates/Deactivates the Event Log. |
| - | (X):B:Active true|false |
| SR eventlog console (X:B) | Activates/Deactivates the Event Log to console. |
| - | (X):B:Active true|false |
| SR eventlog file (X:B) | Activates/Deactivates the Event Log to File. |
| - | (X):B:Active true|false |
| SR eventlog path (X:S) | Path for event log. |
| - | (X):S:Log File Path |
| SR eventlog status | Status for Event Log |
| SR execute global action (X:I) | Execute specified global action |
| - | (X):I:Global Action ID |
| SR export (X:S) (Y:I) | exports the JSON for an object to be used as a remote device |
| - | (X):S:Types as a comma/dash separated list (Y):I:System ID |
| SR exportByType (X:S) (Y:I) | exports the JSON for objects to be used as a remote device |
| - | (X):S:Device Type(s) to Export as comma separated list (Y):I:System ID |
| SR fusion enable (X:B) | Enables/Disables Fusion, a program restart will happen. |
| - | (X):B:Enabled true|false |
| SR get properties (X:I) | Gets the properties for a global ID |
| - | (X):I:Global ID |
| SR load (X:I) cct (Y:I) | Set the CCT for a load |
| - | (X):I:Load Global ID (Y):I:CCT in Kelvin |
| SR load (X:I) cct copy from (Y:I) | Copy CCT Settings from one load to another |
| - | (X):I:Target Load Global ID (Y):I:Source Load ID |
| SR load (X:I) cct map add (Y:I) (Z:I) (A:I) | Map warm and cool points |
| - | (X):I:Load Global ID (Y):I:cct (Z):I:warm (A):I:cool |
| SR load (X:I) cct map current (Y:I) | Set WarmCoolMapPoints |
| - | (X):I:Load Global ID (Y):I:cct |
| SR load (X:I) cct map remove (Y:I) | Remove a WarmCoolMapPoint |
| - | (X):I:Load Global ID (Y):I:cct |
| SR load (X:I) cct map show | Show CCT Map Points |
| - | (X):I:Load Global ID |
| SR load (X:I) cct map use (Y:B) | Use WarmCoolMapPoints |
| - | (X):I:Load Global ID (Y):B:true or false |
| SR load (X:I) cct max (Y:I) | Set cct max for given light |
| - | (X):I:Load Global ID (Y):I:Cct Kelvin |
| SR load (X:I) cct min (Y:I) | Set cct min for given light |
| - | (X):I:Load Global ID (Y):I:Cct Kelvin |
| SR load (X:I) cct OutsideRangeOff (Y:B) | Turn off load if CCT out of range |
| - | (X):I:Load Global ID (Y):B:true or false |
| SR load (X:I) cct set (Y:I) | Set CCT for given light |
| - | (X):I:Load Global ID (Y):I:CCT in K |
| SR load (X:I) cct set cool (Y:I) | Set cool for given light |
| - | (X):I:Load Global ID (Y):I:0-100% |
| SR load (X:I) cct set warm (Y:I) | Set warm for given light |
| - | (X):I:Load Global ID (Y):I:0-100% |
| SR load (X:I) intensity (Y:I) | Set intensity for given load |
| - | (X):I:Load Global ID (Y):I:0-100% |
| SR load (X:S) scene (Y:I) (Z:I) | Set intensity for given loads |
| - | (X):S:Load Global ID (Y):I:Scene ID (Z):I:0-100% |
| SR load (X:S) scene (Y:I) (Z:I) (A:D) | Set intensity and fade time for given loads |
| - | (X):S:Load Global ID (Y):I:Scene ID (Z):I:0-100% (A):D:Fade Time |
| SR rcon disable | Disables RCON to a specified object |
| SR rcon enable (X:I) | Enables RCON to a specified object |
| - | (X):I:Global ID |
| SR rcon send (X:S) | Sends RCON Command |
| - | (X):S:Command |
| SR recall scene (X:I) (Y:I) | Recall a Scene for a Area |
| - | (X):I:Area ID (Y):I:Scene ID |
| SR remote system set (X:I) (Y:S) (Z:S) | Adds or updates a remote system |
| - | (X):I:ID (Y):S:IP Address or Hostname (Z):S:Label |
| SR save config | Saves the config |
| SR set fadetime scene (X:I) (Y:I) (Z:D) | Set the fade time for the scene in a Area |
| - | (X):I:Area ID (Y):I:Scene ID (Z):D:Fade Time |
| SR set occupancy timeout (X:I) | Set the timeout for all configurable occ sensors |
| - | (X):I:Timeout in Seconds |
| SR set property (X:I) (Y:S) (Z:S) | Set a property for a global ID |
| - | (X):I:Global ID (Y):S:Path (Z):S:New Value |
| SR show actions | List available actions by type |
| SR show api clients | List API clients |
| SR show api clients brief | List API clients w/o devices |
| SR show api server clients | Shows all clients connected to the api web socket server |
| SR show area (X:I) loads | List loads for a specific area |
| - | (X):I:Area ID |
| SR show area (X:I) presentation loads | List loads for a specific area as presented to user |
| - | (X):I:Area ID |
| SR show area (X:I) presentation shades | List shades for a specific area as presented to user |
| - | (X):I:Area ID |
| SR show area loads | List areas with status |
| SR show areas | List areas with status |
| SR show assembly versions | List software assembly versions |
| SR show astronomical clock | List astronomical clock details |
| SR show astronomical clock (X:S) | List astronomical clock details for a date |
| - | (X):S:Date |
| SR show calendars | Show Calendars |
| SR show cct schedule | Show the CCT schedule |
| SR show cct status | Show the CCT schedule |
| SR show cresnet devices | List Cresnet Devices |
| SR show details | List config details |
| SR show diag (X:I) | List diagnostics for a specific device |
| - | (X):I:Global ID |
| SR show eiscs | List eisc with status |
| SR show ethernet devices | List Ethernet Devices |
| SR show FadeEngine status | Outputs the status of the fade engine |
| SR show global actions | List global actions |
| SR show global ids | List all devices by Global ID |
| SR show keypad actions | List keypads with actions |
| SR show keypad templates | List keypad templatess with actions |
| SR show keypads | List keypads with status |
| SR show keyswitches | List keyswitches with status |
| SR show license | Show license information |
| SR show load scenes | List load scenes |
| SR show loads | List loads |
| SR show loads extended | List loads w/ extended hardware info |
| SR show object counts | List object counts |
| SR show occupancy sensors | List occupancy sensors with status |
| SR show partition sensors | List partition sensors with status |
| SR show photocells sensors | List photocell sensors with status |
| SR show rf devices | List RF Devices |
| SR show schedules | Show schedule |
| SR show shades | List shades |
| SR show uis | Show user interfaces |
| SR show users | Show users |
| SR show zum floor hubs | Shows all Zum Floor Hubs defined. |
| SR show zum rooms | Shows all Zum rooms with status. |
| SR simulate keypad (X:I) (Y:I) (Z:S) | null |
| - | (X):I:Keypad ID (Y):I:Button (Z):S:State: Unknown|Press|Release|Tap|DoubleTap|Hold |
| SR simulate keyswitch (X:I) (Y:B) | null |
| - | (X):I:Keyswitch ID (Y):B:State |
| SR simulate occupancy (X:I) (Y:B) | null |
| - | (X):I:Occupancy ID (Y):B:State |
| SR simulate partition (X:I) (Y:B) | null |
| - | (X):I:Partiton Sensor Global ID (Y):B:State (true=Combined, false=Divided) |
| SR simulate photocell (X:I) (Y:I) | null |
| - | (X):I:Photocell ID (Y):I:State |
| SR simulate serial (X:I) (Y:S) | null |
| - | (X):I:Serial Interface ID (Y):S:Cmd |
| SR version | Returns the current version of ShowRunner |
| SR zum enable (X:B) | Enables/Disables Zum, a program restart will happen. |
| - | (X):B:Enabled true|false |
+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
Variables represented by brackets with a letter '{X}' can be specified in the following formats:
B:Binary - true or false
D:Double - A floating point number. Examples: 3.205 or 3.0
I:Integer - A whole number. Examples: 10 or -50
S:String - A collection of characters. Encapsulate in quotes if there is a space. Example: "Hello World"