System Status [ss]

This request returns a System Status data structure for the CueServer. This structure contains detailed information about the current status of the device.

URL:

/get.cgi?req=ss

Response:

The following data structure will be returned by this request.

typedef struct SystemStatus { // (256 bytes)
    uint16_t            signature;              // Signature = 'CS'
    int16_t             version;                // Version = 0x0002 (or negative error code)

    uint8_t             pcbIndicators[8];       // PCB Indicator Data
    uint8_t             functionButtons[24];    // Function Button Indicator Data (8xRGB)
    char                lcdData[80];            // LCD Display Buffer
    uint32_t            licenseData;            // License Data

    uint8_t             universeActive[16];     // Universe active bits

    uint16_t            logMessages;            // Number of new CueServer log messages (rolling count)
    uint16_t            importantLogMessages;   // Number of unread "important" CueServer log messages (cleared by "log clear")

    uint32_t            processRunning;         // Bitmask of running processes
    uint8_t             debugFlags;             // Bitmask of debug logging flags
    uint8_t             reserved1[11];          // -

    uint8_t             resChangeSeed[32];      // Array of resSeed values (indexed by RES_SEED_XXX constants)

    uint16_t            boardID;                // The board ID of the device [+v1.4.1]

    uint8_t             dmxInputDisabled;       // Is the DMX Input disabled? [+v1.5.0]
    uint8_t             lcdBacklight;           // LCD backlight level [+v2.0.0]

    uint8_t             reserved2[64];          // -
} SystemStatus;

 
Errors:

If an error occurs during the processing of the request, only the first four bytes of the above structure will be returned by this URL. The first two bytes will have the “CS” signature and the next two bytes will contain an error value as described by the following table: