statusGet command

Command

statusGet

Shortcut

sg

Arguments

none

Availability

always

Purpose

get the current state of the system

Response

Something like this: statusIs running "Your Project Here"

In this section

Usage Example

Response

Possible Error Messages

See also

help Command

login command

keepAlive command

quietModeEnable command

quietModeDisable command

controlGet command

controlSet command

controlPositionSet command

controlList Command

changeGroupControlAdd command

changeGroupControlRemove Command

changeGroupGet Command

changeGroupClear Command

changeGroupSchedule Command

Usage Example

The client issues:

statusGet\r

or

sg\r

Response

statusIs running "Level 1 Ballrooms"\r\n

If no project is running, you will not be able to connect, so there is no alternative response here (no "stopped or not running" status).

Note: The file name is enclosed in quotes to support spaces in the file name.  In future versions, we plan to add other states for the second part of the response for other situations.

Possible Error Messages

\aOverflow\r\n