Command Line Interface (Text Console)
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.
RMC4>sr ver ShowRunner Version: 3.52.8851.36446 RMC4>sr ? Help for SR +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | Command | Help | |-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| | SR activate (X:I) | Activates an object by Global Id | | - | (X):I:Global ID | | SR api enable (X:B) | Enables/Disables the WebSocket API, a program restart will happen. | | - | (X):B:Enabled true|false | | SR areas scenes editable | Makes all scenes on all areas user editable | | SR bacnet area features (X:S) | Set the BACNET features for all areas and defaults | | - | (X):S:BACNET Features | | SR bacnet default area features (X:S) | Set the BACNET area features default for new areas | | - | (X):S:BACNET Features | | SR bacnet enable (X:B) | Enables/Disables Bacnet, a program restart will happen. | | - | (X):B:Enabled true|false | | SR bacnet features | Get the BACNET features | | SR bacnet features (X:S) | Set the BACNET features | | - | (X):S:BACNET Features | | SR cct demo start | Start CCT Demo | | SR cct demo stop | Stop CCT Demo | | SR config active move (X:S) | Moves the current config to a new location | | - | (X):S:ConfigAltName | | SR config backup (X:S) | Backs up an alternate config | | - | (X):S:ConfigAltName | | SR config current backup | Backs up the current config | | SR config default backup | Backs up the default config | | SR config move (X:S) (Y:S) | Sets the a config to an alternate | | - | (X):S:ExistingConfigAltName (Y):S:NewConfigAltName | | SR config select clear | Clears the config select to load defaults | | SR config select list | Lists the available config select options | | SR config select set (X:S) | Sets the config to an alternate | | - | (X):S:ConfigAltName | | SR config select show | Shows the config alternate selection | | SR cresnet auto query | Automatic Cresnet Query Status | | SR cresnet auto query (X:B) | Automatic Cresnet Query Setting | | - | (X):B:Enable/Disable | | 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 | Forces a reading of all ballast settings into the DIN-DALI-2 | | :I) (Z:S) | | | - | (X):I:Controller Global ID (Y):I:Loop (Z):S:Address (0-63 or All) | | SR dali (X:I) status | Reports the status of the DIN-DALI-2 | | - | (X):I:Controller Global ID | | SR dali (X:S) set (Y:I) (Z:S) (A:I) | Sets the dimming curve on all, bllast, group, or unaddressed | | dimmingcurve (B:S) (C:S) | | | - | (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 | | | ltageHalogen|Phase|Dali1To10V|LED|Switching|ColorControl|Sequencer (C):S:Dimming Curve Logarithmic|Linear | | SR dali (X:S) set (Y:I) (Z:S) (A:I) | Sets the fade time on all, bllast, group, or unaddressed | | fadetime (B:I) | | | - | (X):S:Controller Global IDs (Y):I:Loop (Z):S:Type: All|Group|Ballast|Unaddressed (A):I:Address (B):I:Fade Time Index | | SR deactivate (X:I) | Deactivates an object by Global Id | | - | (X):I:Global ID | | 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 logic Shades | 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) | Debug Crestron Zum libraries | | - | (X):S:State: Off|Normal|Developer|Verbose | | SR devmgr cresnet bridge show branc | Prints out all branches with status | | hes (X:S) (Y:S) | | | - | (X):S:IP-ID (Y):S:Type | | SR devmgr ethernet clear ipentry (X | Clears specified ip table entry (assumes master) | | :S) (Y:S) (Z:S) | | | - | (X):S:IP Address or Hostname (Y):S:IPT entry IP-ID as Hex (Z):S:IPT entry target address | | SR devmgr ethernet clear ipentry (X | Clears specified ip table entry | | :S) (Y:S) (Z:S) (A:B) | | | - | (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 | | SR devmgr ethernet clear iptable (X:S) | Clears all ip table entries | | - | (X):S:IP Address or Hostname | | SR devmgr ethernet get iptable (X:S) | Obtains all ip table entries from the device | | - | (X):S:IP Address or Hostname | | SR devmgr ethernet query | Initiates an autodiscovery query | | SR devmgr ethernet set iptable (X:S | Sets the IP Table Entry | | ) (Y:S) | | | - | (X):S:IP Address or Hostname (Y):S:IP-ID in hex | | SR devmgr ethernet show devices | Prints the discovered devices | | SR devmgr onlinetracker enable (X:B) | Enable/Disable the Online Tracker, persistent | | - | (X):B:Enable|Disable | | SR devmgr onlinetracker ignore add | Add a device to the ignore list | | (X:S) | | | - | (X):S:Connection Path for Device to Ignore | | SR devmgr onlinetracker ignore remo | Add a device to the ignore list | | ve (X:S) | | | - | (X):S:Connection Path for Device to Ignore | | SR devmgr onlinetracker show all | Show All Devices | | SR devmgr onlinetracker show ignore | Show Ignored Devices | | SR devmgr onlinetracker show offline | Show Offline 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 devmgr show diagnostics | Show Diagnostic Devices | | SR devmgr show diagnostics errors | Show Diagnostic Devices, Errors Only | | SR devmgr zumnet bridge show device | Prints out all devices with status | | s (X:S) | | | - | (X):S:IP-ID | | SR dhcp server bindings | Shows the dhcp server bindings | | SR dhcp server disable | Disables the internal DHCP Server | | SR dhcp server enable | Enables the internal DHCP Server with default values and a range of 1/2 the subnet | | SR discover (X:I) | Initiate Discovery | | - | (X):I:Global ID | | SR discover scenes (X:I) | Discover scenes on a device | | - | (X):I:Device Global ID | | SR discover zummesh (X:B) | Initiate Zum Wireless Discovery | | - | (X):B:Claim RF Gateways | | SR discover zumnet (X:B) (Y:B) | Initiate Zum Wired Discovery | | - | (X):B:Claim JBOXs (Y):B:Enumerate Devices | | 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 enroll hardware property (X:S) ( | Set a property for an underlying hardware device at global ID and store the setting in the config | | Y:S) (Z:S) | | | - | (X):S:Global ID(s) Comma and Dash Separated permitted (Y):S:Path (Z):S:New Value | | 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 heartbeat interval (X:I) | Set the eventlog heartbeat interval | | - | (X):I:seconds | | SR eventlog level (X:S) | Event log level to permit | | - | (X):S:Event Log Level | | SR eventlog rsyslog (X:B) | Activates/Deactivates the Event Log to Rsyslog. | | - | (X):B:Active true|false | | SR eventlog statistics (X:B) | Activates/Deactivates the Event Log System Statistics Function. | | - | (X):B:Active true|false | | SR eventlog statistics interval (X:I) | Set the eventlog statistics interval | | - | (X):I:10 to 65535 seconds | | SR eventlog status | Status for Event Log | | SR eventlog thread (X:B) | Activates/Deactivates the Event Log Thread Function. | | - | (X):B:Active true|false | | SR eventlog trace (X:B) | Activates/Deactivates the Event Log Trace Function. | | - | (X):B:Active true|false | | SR execute action (X:S) | Execute the specified action syntax | | - | (X):S:Action | | SR execute event (X:S) | Execute the specified event | | - | (X):S:Global ID | | 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 hardware properties (X:I) | Gets the properties for an underlying hardware device at global ID | | - | (X):I:Global ID | | 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: | Map warm and cool points | | I) (A:I) | | | - | (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 load move (X:I) (Y:I) (Z:I) (A:I | Move within a single controller | | ) (B:I) | | | - | (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 | | SR load move (X:I) (Y:I) (Z:I) (A:I | Move a load from one controller to another | | ) (B:I) (C:I) | | | - | (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 | | | ndex, -999 to auto-assign | | SR lwapi client (X:I) start | Start a LWAPI Client to a remote system | | - | (X):I:Remote System Id | | SR lwapi client (X:I) stop | Stop a LWAPI Client to a remote system | | - | (X):I:Remote System Id | | SR lwapi client debug (X:B) | Enable/Disable LWAPI Client Debug | | - | (X):B:Enable/Disable | | SR lwapi client queue size | Get the number of messages allowed in the LWAPI client queue | | SR lwapi client queue size (X:I) | Set the number of messages allowed in the LWAPI client queue | | - | (X):I:Number of Messages allowed in queue | | SR lwapi enable (X:B) | Enables/Disables the LWAPI, a program restart will happen. | | - | (X):B:Enabled true|false | | SR lwapi server queue size | Get the number of messages allowed in the LWAPI server queue | | SR lwapi server queue size (X:I) | Set the number of messages allowed in the LWAPI server queue | | - | (X):I:Number of Messages allowed in queue | | SR master override (X:B) | Activates/Deactivates Master Override. | | - | (X):B:Active true|false | | SR master override status | Shows master override status. | | 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 register (X:I) | Registers an object by Global Id | | - | (X):I:Global ID | | SR remote system auth (X:I) (Y:S) (Z:S) | Enables authentication for a remote system w/o CWS User | | - | (X):I:ID (Y):S:API Key (Z):S:API Secret | | SR remote system auth (X:I) (Y:S) ( | Enables authentication for a remote system w/ a CWS User | | Z:S) (A:S) (B:S) | | | - | (X):I:ID (Y):S:API Key (Z):S:API Secret (A):S:CWS Username (B):S:CWS Password | | SR rf device claim (X:S) | Claims rf devices attached to a gateway | | - | (X):S:Gateway IP-ID | | 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 hardware property (X:S) (Y:S | Temporarily set a property for the underlying hardware directly on the device | | ) (Z:S) | | | - | (X):S:Global ID(s) Comma and Dash Separated permitted (Y):S:Path (Z):S:New Value | | SR set occupancy timeout (X:I) | Set the timeout for all configurable occ sensors | | - | (X):I:Timeout in Seconds | | SR set property (X:S) (Y:S) (Z:S) | Set a property for a global ID | | - | (X):S:Global ID(s) Comma and Dash Separated permitted (Y):S:Path (Z):S:New Value | | SR shade (X:I) close | Triggers close on a shade | | - | (X):I:Shade Global ID | | SR shade (X:I) open | Triggers open on a shade | | - | (X):I:Shade Global ID | | SR shade (X:I) stop | Triggers stop on a shade | | - | (X):I:Shade Global ID | | SR show actions | List available actions by type | | SR show actions (X:S) | List available actions for a specific global ID | | - | (X):S:Global ID or UniqueId | | SR show api clients | List API clients | | SR show api clients brief | List API clients w/o devices | | 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 (X:I) scene array | Show the scene a | | - | (X):I:Area ID | | SR show area links | List areas links | | SR show area loads | List areas with status | | SR show area power | List areas with power | | 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 devices | show devices by serial number | | SR show diag (X:I) | List diagnostics for a specific device | | - | (X):I:Global ID | | SR show edmx receiver buffer (X:I) | Output the receiver buffer for an E-DMX Receiver | | - | (X):I:Receiver Global ID | | SR show edmx receivers | List edmx receivers with status | | SR show eiscs | List eisc with status | | SR show ethernet devices | List Ethernet Devices | | SR show extensions | Show loaded extensions | | 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 global timed events | List global timed events | | SR show hvac | List HVAC | | SR show hvac detailed | List HVAC | | 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 (X:I) priority array | Show the priority array | | - | (X):I:Load Global ID | | SR show load groups | List load groups | | SR show load groups (X:S) | List load groups by area IDs | | - | (X):S:Area IDs | | SR show load scenes | List load scenes | | SR show loads | List loads | | SR show loads extended | List loads w/ extended hardware info | | SR show loads power | List loads with power | | SR show lwapi client token actions | List LWAPI clients token actions | | SR show lwapi clients | List LWAPI clients | | SR show lwapi clients brief | List LWAPI clients w/o device details | | SR show object counts | List object counts | | SR show occupancy sensors | List occupancy sensors with status | | SR show outputs | List outputs with status | | SR show partition sensors | List partition sensors with status | | SR show paths | List paths for active config | | SR show photocells sensors | List photocell sensors with status | | SR show remote systems | List remote systems | | SR show rf devices | List RF Devices | | SR show schedule groups | Show schedule groups | | SR show schedules | Show schedule | | SR show shade groups | List shade groups | | SR show shade groups (X:S) | List load groups by area IDs | | - | (X):S:Area IDs | | SR show shades | List shades | | SR show tags | Show tags | | 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) | Simulate a keypad | | - | (X):I:Keypad ID (Y):I:Button (Z):S:State: Unknown|Press|Release|Tap|DoubleTap|Hold | | SR simulate keyswitch (X:I) (Y:B) | Simulate a keyswitch | | - | (X):I:Keyswitch ID (Y):B:State | | SR simulate loadcontroller occupanc | Simulate occupancy on a load controller (if supported) | | y (X:S) (Y:B) | | | - | (X):S:Load Controller GlobalId or UniqueId (Y):B:State | | SR simulate occupancy (X:I) (Y:B) | Simulate an occupancy sensor | | - | (X):I:Occupancy ID (Y):B:State | | SR simulate partition (X:I) (Y:B) | Simulate a partiton sensor | | - | (X):I:Partiton Sensor Global ID (Y):B:State (true=Combined, false=Divided) | | SR simulate photocell (X:I) (Y:I) | Simulate a photocell | | - | (X):I:Photocell ID (Y):I:State | | SR simulate serial (X:I) (Y:S) | Simulate serial input | | - | (X):I:Serial Interface ID (Y):S:Cmd | | SR tcp disable | Disable TCP Listener | | SR tcp enable (X:I) (Y:I) | Enable TCP Listener | | - | (X):I:Listen Port (Y):I:Max Connections | | SR udp debug (X:B) | Set/Clear UDP Debug | | - | (X):B:Enable/Disable Debug | | SR udp disable | Disable UDP Listener | | SR udp enable (X:I) | Enable UDP Listener | | - | (X):I:Listen Port | | SR unregister (X:I) | Unregisters an object by Global Id | | - | (X):I:Global ID | | 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 | | SR zummesh dr level (X:I) | Sets the demand response level for all ZUMMESH-NETBRIDGE controllers. | | - | (X):I:DR Level (0-100) | | SR zummesh keypad custom buttons (X | Enables custom buttons on a ZUMMESH-KEYPAD, NETBRIDGE must be defined as load controller. | | :S) (Y:S) (Z:S) (A:I) (B:S) | | | - | (X):S:Gateway IP-ID (Y):S:Netbridge RF-ID (Z):S:Keypad Device Address (A):I:Keypad Id (B):S:Buttons to customize | | SR zummesh show devices (X:S) (Y:S) | Returns the devices attached to a NETBRIDGE | | - | (X):S:Gateway IP-ID (Y):S:Netbridge RF-ID | | SR watchdog petting enabled (X:B) | Enable/disable watchdog petting | | - | (X):B:Enable|Disable | | SR watchdog petting enabled default | Set watchdog petting to the default (only enabled on 3-series) | | SR watchdog petting interval (X:I) | Set the petting interval in seconds | | - | (X):I:Interval in seconds (between 1 and 60) | | SR watchdog petting interval default | Set the petting interval to the default of 10000ms | | SR watchdog petting status | Get the dog petting status | |-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| Count: 368 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 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"