SplayApi

S-Play HTTP API description

This HTTP API allows for control over the ENTTEC S-Play (SKU: 70092), playback engine. To use this API to its full extent first record cues and make playlists using the S-Plays inbuilt web interface.

ENTTEC recommend that the S-Plays IP is set to be static before communicating using this API.

To ensure this API functions as intended, ensure you are running a software version of at least v2.2.

HTTP POST Commands for S-Play's playback.

Enum COMMAND below presents the list of available playback commands. They can be sent using HTTP POST requests to the device IP on path /api.

e.g. URL: http://192.168.1.13/api

Request can be tested using:

• curl

curl --header "Content-Type: application/json" -d "{\"command\":88}" http://192.168.0.10/api --output -

• wget

wget -q -O- --post-data='{"command":88}' --header='Content-Type:application/json' http://192.168.0.10/api

• Insomnia with provided config (Insomnia_SplayAPI_1.7.json) with several examples of requests

Development

After clone run the command inside repo's dir to automatically execute flatc compilation (v1.12.0) to cpp & js for all *.fbs files: git config --local core.hooksPath .githooks/

Description

SplayEngine Commands

All control commands supported by the device are listed in fbs/Command.fbs. These ids can be used to fully control S-Play device

enum COMMAND {
  PLAY = 0, // Play playlist on the device
  PAUSE = 1, // Pause the playing playlist
  STOP = 2, // Stop the playlist is in PAUSE or PLAY status.
  GET_PLAYLIST = 3, // Get full information about playlist with Tracks, Triggers & Events
  UPDATE_PLAYLISTS_ORDER = 4, // Update playlists by ids with given orders
  PLAY_ALL_PLAYLISTS = 5, // Play all playlists on the device
  PAUSE_ALL_PLAYLISTS = 6, // Pause all playing playlists
  STOP_ALL_PLAYLISTS = 7, // Stop all playlists is in PAUSE or PLAY status.
  GET_ALL_PLAYLISTS = 8, // Get status of all currently playing playlists
  SET_PLAYLIST_INTENSITY = 9, // Output intensity (Master Fader) of the given playlist, persists until power cycle
  GET_PLAYLIST_INTENSITY = 10, // Return the current Intensity
  SET_TRACK_INTENSITY = 11, // Output intensity of particular track in the given playlist (not implemented)
  GET_TRACK_INTENSITY = 12, // Return the current Intensity (not implemented)

  CAPTURE_DMX_FRAME = 13, // Static frame recording
  RECORD_DMX_FRAME = 14, // Dynamic frame recording
  STOP_RECORD = 15, // Stop any recording
  SAVE_CUE = 16, // Save cue state
  DELETE_CUE = 17, // Delete Cue by id

  UPDATE_PLAYLIST = 18, // Update/Create Playlist with json struct as gets from GET_PLAYLIST
  DELETE_PLAYLIST = 19, // Delete Playlist by id

  UPDATE_SETTING = 20, // Update Setting by id
  GET_SETTING = 21, // Get Setting by id

  SET_PLAYLIST_TIME_POSITION = 22, // Set playback position of a playlist
  SET_WEBSOCKET_INPUT = 23, // Sets universe to monitor in Cue recording, use Universe number or WEBSOCKET_OUTPUT:NOTHING/ALL
  SET_PLAYLIST_ID = 24, // Update playlist id to the new id

  PLAY_CUE = 25, // Play cue with given id
  PAUSE_CUE = 26, // Pause cue with given id
  STOP_CUE = 27, // Stop playback of playing cue by given id
  GET_CUE = 28, // Get full info on cue by given id
  GET_ALL_CUES = 29, // Get list of all cues
  EXIT_CUE_EDIT = 30, // Frontend notifies on Cue editing finished
  DUPLICATE_CUE = 31, // Duplicate cue by given id
  SET_CUE_ID = 32, // Update id of existing cue
  SET_DMX_CUE = 33, // Generate DMX universes states based on params, implements Static Cue "SET DMX" logic

  UPDATE_STORAGE_PATH = 34, // Update storage path using internal DB check for BASE_PATH setting

  GET_EVENT = 36, // Get Event by id
  GET_ALL_EVENTS = 37, // Get all existing Events
  UPDATE_EVENT = 38, // Update/Create Event
  DELETE_EVENT = 39, // Delete Event by id
  GET_TRIGGER = 40, // Get Trigger by id
  GET_ALL_TRIGGERS = 41, // Get all existing Triggers
  UPDATE_TRIGGER = 42, // Update/Create Trigger
  DELETE_TRIGGER = 43, // Delete Trigger by id
  SEND_EVENT = 44, // Send given event
  WAIT_TRIGGER = 45, // Add trigger to check
  CHECK_TRIGGER = 46, // Check if added trigger happen

  UDP_MESSAGE = 50, // Accepts messages to interpret as UDP input
  OSC_MESSAGE = 51, // Accepts messages to interpret as OSC input

  GET_MASTER_INTENSITY = 55, // Get / Set overall S-Play output intensity (Master Fader), persists until power cycle
  SET_MASTER_INTENSITY = 56,

  GET_SCHEDULES = 60, // Get all existing Schedules
  UPDATE_SCHEDULE = 61, // Update Schedule to file already exist.
  DELETE_SCHEDULE = 62, // Delete Schedule. it will be removed from database and storage.
  ENABLE_SCHEDULE = 63, // Change the Schedule state enable ACTIVE = 1 / PAUSED = 2

  GET_INTERFACE = 70, // Get Interface page by id or URL
  GET_ALL_INTERFACES = 71, // Get all created Interfaces
  UPDATE_INTERFACE = 72, // Update/Create Interface page
  DELETE_INTERFACE = 73, // Delete Interface by id

  GET_VERSION = 80, // Get Engine version
  GET_NETWORK = 81, // Get network settings
  SET_NETWORK = 82, // Set network settings
  GET_TIME = 83, // Get system time, timezone and custom NTP server if used
  SET_TIME = 84, // Set system time, timezone and custom NTP server
  GET_STORAGES = 85, // Get available storages (internal, sd, etc.)
  SET_STORAGE = 86, // Set current storage from available
  FACTORY_RESET = 87, // Execute factory reset logic
  GET_INFO = 88, // System and software info (versions, serial, etc.)

  GET_SSH_TUNNEL_STATUS = 90, // Check if ssh tunnel is enabled and active
  GET_SSH_TUNNEL_CONFIG = 91, // Get current ssh tunnel settings
  SET_SSH_TUNNEL_CONFIG = 92, // Set ssh tunnel settings

  LOGIN = 95, // Provide auth token based on login & pass
  CHANGE_PASSWORD = 96, // Change login or password
  SET_LICENSE = 97, // License S-Play

  GET_BACKUP = 100, // Check if backup file exists, link to it and its date
  MAKE_BACKUP = 101, // Generate backup for selected storage
  COPY_STORAGE = 102, // Copy from one storage to another available
  APPLY_RESTORE = 103, // Internal usage, needs local path for restore archive

  DISCOVER_DEVICES = 110, // Discover devices on the network

  SHUTDOWN = 222, // Gracefully shutdown S-Play
  REFRESH_SETTING = 254,
}

Good to know: Be careful with JSON values' types, some fields support only integers or floats.

In case of error the Response will return "result": false with "error" field describing the error.

For example if unsupported command is sent it Response:

{
  "result": false,
  "error": "Unsupported command id: 100"
}

Playlists Control Description and JSON Requests/Responses Examples

Supported Playlists Statuses returned in "status" field

enum PLAYLIST_STATUS {
  PLAYLIST_STATUS_IDLE = 0,
  PLAYLIST_STATUS_PLAYING = 1,
  PLAYLIST_STATUS_PAUSED = 2,
  PLAYLIST_STATUS_STOPPED = 3,
  PLAYLIST_STATUS_STOPPING = 4,
  PLAYLIST_STATUS_ERROR = 5
};

PLAY: Play playlist by id

Request:

{
 "command": 0,
 "playlist_id" : 1
}

Response:

{ "result": true }

PAUSE: Pause the playing playlist by id

Request:

{
 "command": 1,
 "playlist_id" : 1
}

Response:

{ "result": true }

STOP: Stop the playlist if in PAUSE or PLAY status

This will perform STOP action, if Playlist's has Fade Out time not 0 the status become PLAYLIST_STATUS_STOPPING and with the repeated STOP command Playlist will stop immediately, else it will stop. Request:

{
 "command": 2,
 "playlist_id" : 1
}

Response:

{ "result": true }

GET_PLAYLIST: Get full information about playlist with Tracks, Triggers & Events

Request:

{
 "command": 3,
 "playlist_id" : 1
}

Response:

{
  "playlist": {
    "current_time": 0,
    "duration": 5000,
    "fade_in": 0,
    "fade_out": 2038,
    "group": 1,
    "hide_from_home": false,
    "intensity": 100,
    "loop": 1,
    "name": "One",
    "order": 1,
    "playlist_id": 1,
    "priority": 100,
    "start_trigger": {
      "active": true,"name": "","start": 0,"trigger_id": -1,"type": 0,"value": null
    },
    "status": 3,
    "stop_trigger": {
      "active": true,"name": "","start": 0,"trigger_id": -1,"type": 0,"value": null
    },
    "timeline": {
      "event": {
        "events": [
          {
            "active": true, "event_id": 1, "name": "Fist Udp", "start": 500, "type": 7, "value": {
              "ip": "127.0.0.1",        "port": 33333,        "value": "yoyo"
            }
          }
        ]
      },"track1": {
        "cues": [
          {
            "ch_start": 0,
            "ch_stop": 511,
            "cue_id": 1,
            "duration": 5000,
            "name": "Fst",
            "start": 0,
            "type": 0,
            "fade": {
              "in": 0,
              "out": 0
            }
          }
        ],  "intensity": 100
      },"track2": {
        "cues": [],  "intensity": 100
      },"track3": {
        "cues": [],  "intensity": 100
      },"track4": {
        "cues": [],  "intensity": 100
      },"trigger": {
        "triggers": [
          {
            "active": true,
            "name": "YOOsc",
            "start": 11500,
            "trigger_id": 2,
            "type": 1,
            "value": {
              "address": "/yo", "data_type": "string", "ip": "127.0.0.255", "net_type": "broadcast"
            }
          }
        ]
      }
    },
    "waiting_triggers": false
  }
}

UPDATE_PLAYLISTS_ORDER: Update playlists by ids with given orders

Request:

{
  "command":4,
  "orders":[
    {"playlist_id":2,"order":1},
    {"playlist_id":1,"order":2}
  ]
}

Response:

{ "result": true }

PLAY_ALL_PLAYLISTS: Play all playlists on the device

Request:

{"command": 5}

Response:

{ "result": true }

PAUSE_ALL_PLAYLISTS: Pause all playing playlists

Request:

{"command": 6}

Response:

{ "result": true }

STOP_ALL_PLAYLISTS: Stop all playlists is in PAUSE or PLAY status.

Request:

{"command": 7}

Response:

{ "result": true }

GET_ALL_PLAYLISTS: Get status of all currently playing playlists

This will return all the playlist IDs and its status and playing time. Playlist with id 1 is stopped and is hidden from home page. Playlist with id 2 is playing on 6th second with overall duration of 12 seconds/ Both have intensity 100%.

Request:

{"command": 8}

Response:

{
  "playlists": [
    {
      "current_time": 0,
      "duration": 5000,
      "hide_from_home": true,
      "intensity": 100,
      "name": "One",
      "order": 2,
      "playlist_id": 1,
      "status": 3,
      "waiting_triggers": false
    },
    {
      "current_time": 6000,
      "duration": 12000,
      "hide_from_home": false,
      "intensity": 100,
      "name": "Two ",
      "order": 1,
      "playlist_id": 2,
      "status": 1,
      "waiting_triggers": false
    }
  ]
}

SET_PLAYLIST_INTENSITY: Output intensity (Master Fader) of the given playlist, persists until power cycle

Request - Set playlist intensity to 50%

{
  "command": 9, 
  "playlist_id": 2, 
  "intensity": 50}

Response:

{ "result": true }

UPDATE_PLAYLIST: Update/Create Playlist with json struct as received from GET_PLAYLIST

Update the properties of a playlist. To create new playlist "playlist_id": 0 or no "playlist_id" key must be passsed

Create new Playlist with

• duration 312000ms
• has Fade In 3 sec and Fade Out 2 sec
• Static Cue on Track 1 at 5 min (300000ms) with duration 12 seconds
• Dynamic Cue on Track 2 at start with duration 5 minutes and 570 ms
• One Event on 30 sec named "BIM 1" id = 3, relay 1 to NO position
• Will wait for trigger on the second minute (120000ms)
• Start and Stop Triggers are unset

Request:

{
  "command": 18,  
  "playlist": 
  {
    "duration": 312000,
    "timeline": {
      "track1": {
        "intensity": 100,
        "cues": [
          {
            "start": 300000,
            "name": "Green Scene",
            "cue_id": 1,
            "duration": 12000,
            "type": 0,
            "fade": {
              "in": 2000,
              "out": 1500
            }
          }
        ]
      },
      "track2": {
        "intensity": 100,
        "cues": [
          {
            "start": 0,
            "name": "Bar Lighting Loop",
            "cue_id": 12,
            "duration": 300570,
            "type": 1,
            "fade": {
              "in": 0,
              "out": 1503
            }
          }
        ]
      },
      "track3": {
        "intensity": 100,
        "cues": []
      },
      "track4": {
        "intensity": 100,
        "cues": []
      },
      "event": {
        "events": [
          {
            "start": 30000,
            "name": "BIM 1",
            "event_id": 3,
            "type": 2,
            "value": {
              "output": 1,
              "value": 0
            }
          }
        ]
      },
      "trigger": {
        "triggers": [
          {
            "start": 120000,
            "name": "Button Trigger 1",
            "trigger_id": 6,
            "type": 3,
            "value": {
              "data": 1,
              "port": 0
            }
          }
        ]
      }
    },
    "order": 3,
    "intensity": 100,
    "loop": 0,
    "priority": 100,
    "group": 0,
    "start_trigger": {
      "trigger_id": -1
    },
    "stop_trigger": {
      "trigger_id": -1
    },
    "fade_in": 3000,
    "fade_out": 2000,
    "name": "Favorite"
  }
}

Response: It should return true.

{ "result": true }

DELETE_PLAYLIST

Remove the playlist from active list (e.g. from PlayAll). Request:

{
    "command": 19,
    "playlist_id": 3
}

Response:

{ "result": true }

SET_PLAYLIST_TIME_POSITION: Set playback position of given playlist and continue to play, if playlist was STOPPED it becomes PAUSED

Send request with needed timeline position for playlist playing currently, the position is set with current_time as float which represents seconds (ms after dot) and playlist_id Request:

  {
      "command": 22,"playlist_id": 25,"position": 10.550
  }

Response:

{ "result": true }

SET_PLAYLIST_ID: Update playlist_id with the new_id

Request:

  {
      "command": 24,"playlist_id": 25,"new_id": 42
  }

Response:

{ "result": true }

---

Cue Control Description and JSON Requests/Responses Examples

enum UNIVERSE_TYPE:uint8 {
  DMX_TYPE = 0,
  ARTNET_TYPE = 1,
  SACN_TYPE = 2,
  NONE_TYPE = 3,
}

enum CUE_TYPE:uint8 {
  CUE_TYPE_STATIC = 0,
  CUE_TYPE_DYNAMIC = 1,
  CUE_TYPE_EFFECT = 2,
}

GET_ALL_CUES: Get list of all available cues

Request:

{ "command": 29 }

Response:

{ 
  "result": true,
  "cues":
  [
    {
      "config": {
        "ch_start": 0,  "ch_stop": 511, "source": 1,  "universes": [
          0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31
        ]
      },"cue_id": 2,"duration": 0,"frames": [],"name": "Down dark centre 988","path": "","type": 0
    },
    {
      "config": {
        "ch_start": 0,  "ch_stop": 511, "source": 2,  "universes": [
          1, 2, 3,-1, 5, 6, 7, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1
        ]
      },"cue_id": 20,"duration": 132281,"frames": [],"name": "Boot up","path": "/mnt/internal/cues","type": 1
    },
    {
      "config": {
        "ch_start": 0,  "ch_stop": 511, "source": 2,  "universes": [
          0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 110, 120, 130, 140, 150, 160, 170, 180, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1
        ]
      },"cue_id": 21,"duration": 132628,"frames": [],"name": "Boot Down","path": "/mnt/internal/cues","type": 1
    }
  ]
}

"universes" - array of 32 inputs with universe selected: No input: -1; DMX: 1 - 2; ArtNet: 0 - 32767; sACN: 1 - 65535.

"frames" - returns empty because of the size: 32 arrays * 512 bytes, to get "frames" for the particular Static cue use GET_CUE

"duration" - Dynamic cue recording length in milliseconds

"ch_start" & "ch_stop" defines universe channels range to output during playback, beyond the range '0' will be send

GET_CUE: Get full info on cue by given id

Returns extended info about Cue with "frames": universes state in Static Cue and 1st frame of Dynamic Cue. Effect Cue API is in progress.

Below Dynamic Cue ("type" == CUE_TYPE_DYNAMIC) with only first 8 frames states of universes are shown, other 24 are zeroed arrays as the last here

Request:

{
  "command": 28,
  "cue_id": 32
}

Response:

{ 
  "result": true,
  "cue": 
  {
    "config": {
      "ch_start": 0,
      "ch_stop": 511,
      "source": 2,
      "universes": [
        1,2,3,-1,5,6,7,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
      ]
    },
    "cue_id": 32,
    "duration": 5908,
    "frames": [
      [
        0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,204,0,15,0,207,0,16,0,209,0,16,0,211,0,16,0,214,0,16,0,216,0,16,0,219,0,16,0,221,0,17,0,223,0,17,0,226,0,17,0,228,0,17,0,231,0,17,0,233,0,17,0,235,0,18,0,238,0,18,0,240,0,18,0,243,0,18,0,245,0,18,0,247,0,19,0,250,0,19,0,252,0,19,0,255,0,19,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      ],[
        0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2,0,0,0,4,0,0,0,7,0,1,0,9,0,1,0,12,0,1,0,14,0,1,0,17,0,1,0,19,0,1,0,21,0,2,0,24,0,2,0,26,0,2,0,29,0,2,0,31,0,2,0,33,0,3,0,36,0,3,0,38,0,3,0,41,0,3,0,43,0,3,0,45,0,3,0,48,0,4,0,50,0,4,0,53,0,4,0,55,0,4,0,57,0,4,0,60,0,4,0,62,0,5,0,65,0,5,0,67,0,5,0,69,0,5,0,72,0,5,0,74,0,6,0,77,0,6,0,79,0,6,0,81,0,6,0,84,0,6,0,86,0,6,0,89,0,7,0,91,0,7,0,93,0,7,0,96,0,7,0,98,0,7,0,101,0,8,0,103,0,8,0,106,0,8,0,108,0,8,0,110,0,8,0,113,0,8,0,115,0,9,0,118,0,9,0,120,0,9,0,122,0,9,0,125,0,9,0,127,0,10,0,130,0,10,0,132,0,10,0,134,0,10,0,137,0,10,0,139,0,10,0,142,0,11,0,144,0,11,0,146,0,11,0,149,0,11,0,151,0,11,0,154,0,12,0,156,0,12,0,158,0,12,0,161,0,12,0,163,0,12,0,0,0,0,0
      ],[
        166,0,12,0,168,0,13,0,170,0,13,0,173,0,13,0,175,0,13,0,178,0,13,0,180,0,14,0,182,0,14,0,185,0,14,0,187,0,14,0,190,0,14,0,192,0,14,0,195,0,15,0,197,0,15,0,199,0,15,0,202,0,15,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      ],[
        0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      ],[
        0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,205,0,15,0,208,0,16,0,210,0,16,0,213,0,16,0,215,0,16,0,217,0,16,0,220,0,17,0,222,0,17,0,225,0,17,0,227,0,17,0,229,0,17,0,232,0,17,0,234,0,18,0,237,0,18,0,239,0,18,0,241,0,18,0,244,0,18,0,246,0,18,0,249,0,19,0,251,0,19,0,253,0,19,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      ],[
        0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,3,0,0,0,6,0,0,0,8,0,1,0,10,0,1,0,13,0,1,0,15,0,1,0,18,0,1,0,20,0,2,0,23,0,2,0,25,0,2,0,27,0,2,0,30,0,2,0,32,0,2,0,35,0,3,0,37,0,3,0,39,0,3,0,42,0,3,0,44,0,3,0,47,0,3,0,49,0,4,0,51,0,4,0,54,0,4,0,56,0,4,0,59,0,4,0,61,0,5,0,63,0,5,0,66,0,5,0,68,0,5,0,71,0,5,0,73,0,5,0,75,0,6,0,78,0,6,0,80,0,6,0,83,0,6,0,85,0,6,0,87,0,7,0,90,0,7,0,92,0,7,0,95,0,7,0,97,0,7,0,99,0,7,0,102,0,8,0,104,0,8,0,107,0,8,0,109,0,8,0,112,0,8,0,114,0,9,0,116,0,9,0,119,0,9,0,121,0,9,0,124,0,9,0,126,0,9,0,128,0,10,0,131,0,10,0,133,0,10,0,136,0,10,0,138,0,10,0,140,0,11,0,143,0,11,0,145,0,11,0,148,0,11,0,150,0,11,0,152,0,11,0,155,0,12,0,157,0,12,0,160,0,12,0,162,0,12,0,164,0,12,0,167,0,13,0,169,0,13,0,172,0,13,0,174,0,13,0,176,0,13,0,179,0,13,0,181,0,14,0,184,0,14,0,186,0,14,0,189,0,14,0,191,0,14,0,193,0,15,0,196,0,15,0,198,0,15,0,201,0,15,0,203,0,15,0
      ],[
        0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,205,0,15,0,208,0,16,0,210,0,16,0,213,0,16,0,215,0,16,0,217,0,16,0,220,0,17,0,222,0,17,0,225,0,17,0,227,0,17,0,229,0,17,0,232,0,17,0,234,0,18,0,237,0,18,0,239,0,18,0,241,0,18,0,244,0,18,0,246,0,18,0,249,0,19,0,251,0,19,0,253,0,19,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      ],[
        0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      ]
    ],
    "name": "Pink Meteors Fast",
    "type": 1
  }
}

PLAY_CUE: Play cue with given id

Request:

{
  "command": 25,
  "cue": {
    "cue_id": 21
  }
}

Response:

{ "result": true }

Also customized cue can be passed e.g. to preview before save.

Here Static cue with universe 1 & 2 enabled and corresponding frames is passed:

{
  "command": 25,
  "cue": {
    "cue_id": 0,
    "type": 0,
    "config": {
      "ch_start": 0,
      "ch_stop": 511,
      "source": 2,
      "universes": [
        1,2,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
      ]
    },
    "duration": 5908,
    "frames": [
      [
        0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,204,0,15,0,207,0,16,0,209,0,16,0,211,0,16,0,214,0,16,0,216,0,16,0,219,0,16,0,221,0,17,0,223,0,17,0,226,0,17,0,228,0,17,0,231,0,17,0,233,0,17,0,235,0,18,0,238,0,18,0,240,0,18,0,243,0,18,0,245,0,18,0,247,0,19,0,250,0,19,0,252,0,19,0,255,0,19,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      ],[
        0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2,0,0,0,4,0,0,0,7,0,1,0,9,0,1,0,12,0,1,0,14,0,1,0,17,0,1,0,19,0,1,0,21,0,2,0,24,0,2,0,26,0,2,0,29,0,2,0,31,0,2,0,33,0,3,0,36,0,3,0,38,0,3,0,41,0,3,0,43,0,3,0,45,0,3,0,48,0,4,0,50,0,4,0,53,0,4,0,55,0,4,0,57,0,4,0,60,0,4,0,62,0,5,0,65,0,5,0,67,0,5,0,69,0,5,0,72,0,5,0,74,0,6,0,77,0,6,0,79,0,6,0,81,0,6,0,84,0,6,0,86,0,6,0,89,0,7,0,91,0,7,0,93,0,7,0,96,0,7,0,98,0,7,0,101,0,8,0,103,0,8,0,106,0,8,0,108,0,8,0,110,0,8,0,113,0,8,0,115,0,9,0,118,0,9,0,120,0,9,0,122,0,9,0,125,0,9,0,127,0,10,0,130,0,10,0,132,0,10,0,134,0,10,0,137,0,10,0,139,0,10,0,142,0,11,0,144,0,11,0,146,0,11,0,149,0,11,0,151,0,11,0,154,0,12,0,156,0,12,0,158,0,12,0,161,0,12,0,163,0,12,0,0,0,0,0
      ],
      [],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[]
    ]
  }
}

Response:

{ "result": true }

For Effect Cue color filtering parameters can be passed to modify Cue output in realtime:

{
  "command": 25,
  "cue": {
    "cue_id": 1,
    "config": {
      "effect_type": "gradient",
      "filter": { "r": 255, "g": 179, "b": 28, "w": 150 }
    }
  }
}

Response if Cue exists and is Effect:

{ "result": true }

PAUSE_CUE: Pause cue with given id (not implemented)

Request:

{
  "command": 26,
  "cue_id": 2
}

Response:

{ "result": true }

STOP_CUE: Stop playback of playing cue by given id

Request:

{
  "command": 27,
  "cue_id": 21
}

Response:

{ "result": true }

CAPTURE_DMX_FRAME: Start Static frame recording

Capture Static cue with id 2 from ArtNet

• "universe_type" = 2 (ARTNET_TYPE)
• "universes" - all universes from 0 to 31 will be listened

All recorded ArtNet data will be streamed via Websockets.

Request:

{
  "command":  13,
  "cue_id": 2,
  "universe_type": 1,
  "universes": [
    0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31
  ]
}

Response:

{ "result": true }

RECORD_DMX_FRAME: Start Dynamic frame recording

Start recording of Dynamic cue with id 21, with params:

• "live_preview" enabled - send recorded data to output during recording
• "loop" disabled - don't check for the first 5 frames repeat to create perfect loop
• "universe_type" = 2 (SACN_TYPE) record from sACN
• "universes" - array of sACN universes to record, -1 : disabled
• "trigger" - recording will start when Digital Input 3 become on Make and stop on Break

All recorded sACN data will be streamed via Websockets.

Request:

{
  "command":  14,
  "cue_id": 21,
  "live_preview": true,
  "loop": false,
  "trigger": {
    "value": {
      "port": 2,"data": 1
    },
    "type": 3
  },
  "universe_type": 2,
  "universes": [
    1,2,3,-1,5,6,7,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
  ]
}

Response:

{ "result": true }

STOP_RECORD: Stop any recording

This command will stop the DMX/ArtNet/sACN frame recording if any Request:

{"command": 15}

Response:

{ "result": true }

SAVE_CUE: Save cue state

Saves Cue config and for Static saves "frames" state / for Dynamic persists temporary recorded file. If "cue_id" = 0 , engine will create new Cue from given data

Static cue id=2 is updated, with 20 active universes but only one universe with data (the first array at "frames" has value, the second and others are zero frames), so universes from 1 till 19 will be getting zero frames, nothing will be sent to outputs from 21 till 32. Request:

{ 
  "command": 16,
  "cue": 
  {
    "config": {
      "ch_start": 0,
      "ch_stop": 511,
      "source": 1,
      "universes": [
        0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
      ],
      "trigger": {
        "type": 0
      }
    },
    "cue_id": 2,
    "duration": 0,
    "frames": [
      [
        0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255,254,254,254,249,249,249,244,244,244,238,238,238,234,234,234,228,228,228,223,223,223,218,218,218,213,213,213,208,208,208,202,202,202,198,198,198,192,192,192,188,188,188,182,182,182,177,177,177,172,172,172,166,166,166,162,162,162,156,156,156,152,152,152,146,146,146,141,141,141,136,136,136,131,131,131,127,127,127,121,121,121,117,117,117,111,111,111,106,106,106,101,101,101,96,96,96,91,91,91,85,85,85,81,81,81,75,75,75,70,70,70,65,65,65,60,60,60,55,55,55,49,49,49,45,45,45,39,39,39,34,34,34,29,29,29,24,24,24,19,19,19,13,13,13,9,9,9,3,3,3,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      ],
      [
        0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
      ],
      [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], []
    ],
    "name": "Static Lighting 2",
    "type": 0
  }
}

Response:

{ "result": true }

Create Dynamic cue with outputs to all 32 universes using the last recorded file, with active channels from 30 till 455 in all universes. Request:

{
  "config": {
    "ch_start": 30,
    "ch_stop": 455,
    "source": 1,
    "universes": [
      0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31
    ],
    "trigger": {
      "type": 0
    }
  },
  "cue_id": 0,
  "duration": 693214,
  "frames": [
    [],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[]
  ],
  "name": "Lighting Loop 2",
  "type": 1
}

Response:

{ "result": true }

DELETE_CUE: Delete Cue by id

Request:

{ 
  "command": 17,
  "cue_id": 2
}

Response - returns true if Cue with id 2 existed and was removed else false

{ "result": true }

EXIT_CUE_EDIT: Frontend notifies on Cue editing finished, remove not persisted recorded files

Request:

{"command": 30}

Response:

{ "result": true }

SET_CUE_ID: Update id of existing cue

Request to update Cue with id=1 to id=2:

{ "command": 32, "cue_id": 1, "new_id": 2 }

Response if new_id is unique and update is successful:

{ "result": true }

SET_DMX_CUE: Generate DMX universes states based on params, implements Static Cue "SET DMX" logic

Request to set Static Cue to orange RGB in all 32 universes:

{
  "command": 33,
  "cue_id": 6,
  "universes": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31],
  "ch_start": 0,
  "ch_stop": 511,
  "pixel_order": "RGB",
  "color": { "r": 255, "g": 125, "b": 0, "w": 0 }
}

Response:

{ "result": true }

To store Cue's changes SAVE_CUE without frames param needs to be sent.

---

SET_MASTER_INTENSITY

Set overall S-Play output intensity (Master Fader) with 50% brightness, doesn't persist after power cycle Request:

{
  "command": 56,
  "intensity": 50
}

Response:

{ "result": true }

GET_MASTER_INTENSITY

Get overall S-Play output intensity (Master Fader) returns 50% brightness, doesn't persist after power cycle Request:

{"command": 55}

Response:

{
  "result": true,
  "intensity": 50
}

UDP_MESSAGE: Accepts messages to interpret as UDP input

Send message to Playback to trigger existing UDP trigger with command "hello"

{
  "command": 50,
  "message": "hello"
}

Response:

{ "result": true }

OSC_MESSAGE: Accepts messages to interpret as OSC input

Send message to Playback to trigger existing OSC trigger with address "/test" Request:

{
  "command": 51,
  "address": "/test"
}

Response:

{ "result": true }

---

Settings Control Description and JSON Requests/Responses Examples

Be very careful while editing settings improper config can break S-Play logic. On reboot each setting is verified, if verification fails - setting sets to default. First get the setting parameter then keeping the syntax and fields names the same modify values

List of setting ids:

enum SETTING {
  IS_SPARE = 0,
  SYSTEM_NAME = 1,
  PLAYBACK_CONFIG = 2,
  PASSWORD = 3,
  HELP_HINTS = 4,
  SERIALNO = 5,
  ENABLE_PASSWORD = 6,
  SMTP = 7,
  EMAIL = 8,
  INPUT = 9,
  OUTPUT = 10,
  DMX = 11,
  ARTNET = 12,
  SACN = 13,
  LOCATION = 14,
  NTP = 15,
  BASE_PATH = 16,
  CUE_PATH = 17,
  HOME_INTERFACE = 18,
  UDP = 19,
  TCP = 20,
  RS232C = 21,
  OSC = 22,
  IEEE1588_CONFIG = 23,
  IEEE1588_ACTIVE = 24,
  LOCK_STATUS = 25,
  DB_VERSION = 26,
}

GET_SETTING: Get Setting by id

Get output settings Request:

{
  "command": 21,
  "setting_id": 10
}

Response:

{
  "result": true,
  "setting": {
    "outputs":[
      "dmx1","dmx2","artnet1","artnet2","artnet3","artnet4","artnet5","artnet6","artnet7","artnet8","sacn1","sacn2","sacn3","sacn4","sacn5","sacn6","sacn7","sacn8","none","none","none","none","none","none","none","none","none","none","none","none","none","none"
    ]}
}

Here first two outputs are assigned to DMX 1 and 2 ports Next 8 outputs goes to ArtNet 1 to 8 Next 8 outputs goes to sACN 1 to 8 Other 14 are not assigned to any output

UPDATE_SETTING: Update Setting by id

Update playback configuration, set: "Send black frame on playlist stop" to false "Restrict to one active playlist per Group" to true

Request:

{
  "command": 20,
  "setting": {
    "setting_id": 2,
    "value": {
      "send_blackout":false,"one_playlist_group_play":true
    }
  }
}

Response:

{ "result": true }

Additional requests for S-Play configuration

GET_NETWORK - Get network settings

Request:

{ "command": 81 }

Response:

{
  "result": true,
  "network": {
    "dhcp": false,
    "ip": "192.168.2.7",
    "gateway": "192.168.2.1",
    "mask": "255.255.255.0",
    "mac": "02:15:05:C1:50:55"
  }
}

SET_NETWORK - Set network settings

Request to enable DHCP:

{ 
  "command": 82,
  "network": {
    "dhcp": true
  }
}

Response:

{ "result": true }

GET_TIME - Get system time, timezone and custom NTP server if used

Request:

{ "command": 83 }

Response:

{ 
  "result": true,
  "time": {
    "now": "2021-12-25 23:26:35",
    "ntp": false,
    "server": "bg.pool.ntp.org",
    "timezone": "Europe/Sofia"
  }
}

SET_TIME - Set system time, timezone and custom NTP server

Request to set manual time for Christmas eve with default NTP servers for London timezone:

{ 
  "command": 84,
  "time": {
    "now": "2021-12-25 23:59:00",
    "ntp": false,
    "server": "",
    "timezone": "Europe/London"
  }
}

Response:

{ "result": true }

GET_STORAGES - Get available storages (internal, sd, etc.)

Request:

{ "command": 85 }

Response:

{ 
  "result": true,
  "storages": {
    "available": [
      {"free":2795917312,"total":6297583616,"storage":"sd"},
      {"free":5891842048,"total":9184661504,"storage":"internal"}
    ],
    "selected": "sd"
  }
}

SET_STORAGE - Set current storage from available

Request to select "sd" storage:

{ 
  "command": 86,
  "storage": "sd"
}

Response:

{ 
  "result": true 
}

FACTORY_RESET - Execute factory reset logic

Request:

{ "command": 87 }

Response:

{ "result": true }

GET_INFO - Get system info and software info (versions, serial, etc.)

Request:

{ "command": 88 }

Response:

{
  "result": true, 
  "info": {
      "dmx_version": "1.6",
      "engine_version": "20220114.1",
      "hardware_id": "1651661505c15055",
      "os_build_date": "Fri 08 May 2020 09:35:05 AM UTC",
      "serial": "021505c15058",
      "soft_version": "1.7.0",
      "uptime": "4:34",
      "web_version": "20220115.1"
     }
}

---

Event and Trigger Management Description and JSON Requests/Responses Examples

Event Types Names and Ids

Indicate what type of event is sent based on "type" field

enum EVENT_TYPE {
    EVENT_TYPE_NONE = 0,
    EVENT_TYPE_RS232 = 1,
    EVENT_TYPE_IO = 2,
    EVENT_TYPE_ARTNET = 3,
    EVENT_TYPE_DMX = 4,
    EVENT_TYPE_SACN = 5,
    EVENT_TYPE_OSC = 6,
    EVENT_TYPE_UDP = 7
};

GET_EVENT: Get Event by id

Request - Get Event with id = 1

{
  "command": 36,
  "event_id": 1
}

Response - broadcast Art Net event for universe 11 with value 127 on channel 1

{
  "event": {
    "active": true,
    "event_id": 1,
    "name": "Boot Up Go",
    "start": 0,
    "type": 3,
    "value": {
      "channel": 0,
      "ip": "192.168.0.255",
      "net_type": "broadcast",
      "universe": 11,
      "value": 127
    }
  }
}

GET_ALL_EVENTS: Get all existing Events

Request:

{ "command": 37 }

Response:

{
  "events": [
    {
      "active": true,
      "event_id": 129,
      "name": "ArtNet Up Go",
      "start": 0,
      "type": 3,
      "value": {
        "channel": 0,
        "ip": "192.168.0.255",
        "net_type": "broadcast",
        "universe": 12,
        "value": 127
      }
    },
    {
      "active": true,
      "event_id": 130,
      "name": "ArtNet Down Go",
      "start": 0,
      "type": 3,
      "value": {
        "channel": 1,
        "ip": "192.168.0.2",
        "net_type": "unicast",
        "universe": 11,
        "value": 127
      }
    },
    {
      "active": true,
      "event_id": 200,
      "name": "Just White Stop",
      "start": 0,
      "type": 7,
      "value": {
        "ip": "192.168.0.2",
        "port": 5000,
        "value": "25"
      }
    },
    {
      "active": true,
      "event_id": 205,
      "name": "AAAA sACN",
      "start": 0,
      "type": 5,
      "value": {
        "channel": 2,
        "ip": "239.255.0.10",
        "net_type": "multicast",
        "universe": 10,
        "value": 4
      }
    },
    {
      "active": true,
      "event_id": 206,
      "name": "Hellosc",
      "start": 0,
      "type": 6,
      "value": {
        "address": "/hello",
        "data": "yo",
        "data_type": "string",
        "ip": "127.0.0.255",
        "net_type": "broadcast",
        "port": 8000
      }
    },
    {
      "active": true,
      "event_id": 207,
      "name": "RS",
      "start": 0,
      "type": 1,
      "value": {
        "data": "world"
      }
    },
    {
      "active": true,
      "event_id": 208,
      "name": "Dmx-2-1-200",
      "start": 0,
      "type": 4,
      "value": {
        "channel": 0,
        "universe": 1,
        "value": 200
      }
    },
    {
      "active": true,
      "event_id": 209,
      "name": "Relay 1 NC",
      "start": 0,
      "type": 2,
      "value": {
        "output": 1,
        "value": 1
      }
    }
  ]
}

UPDATE_EVENT: Update/Create Event

Request - Create new event ("event_id": 0) with Relay Type (EVENT_TYPE_IO) for Second Relay NC state

{
  "command": 38,
  "event":
  {
    "event_id": 0,
    "type": 2,
    "value": {
      "output": 2,
      "value": 1
    },
    "name": "Relay 2 - NC"
  }
}

Response:

{ "result": true }

DELETE_EVENT: Delete Event by id

Request - Delete Event with id = 1

{
  "command": 39,
  "event_id": 1
}

Response - returns true if Event with id 1 existed and was removed else false

{ "result": true }

SEND_EVENT: Send given event

Request - send OSC event to 192.168.0.100 port 8000 with address "/hello" and string value "yo"

{
  "command": 44,
  "event": {
    "event_id": 0,
    "name": "Hellosc",
    "type": 6,
    "value": {
      "address": "/hello",
      "data": "yo",
      "data_type": "string",
      "ip": "192.168.0.100",
      "net_type": "broadcast",
      "port": 8000
    }
  }
}

Response:

{ "result": true }

Trigger Types

Indicate what device do you wait to trigger from.

enum TRIGGER_TYPE {
    TRIGGER_TYPE_NONE = 0, // currently in playlist jsons it is -1
    TRIGGER_TYPE_OSC = 1,
    TRIGGER_TYPE_RS232 = 2,
    TRIGGER_TYPE_IO = 3,
    TRIGGER_TYPE_ARTNET = 4,
    TRIGGER_TYPE_DMX = 5,
    TRIGGER_TYPE_SACN = 6,
    TRIGGER_TYPE_UDP = 8,
};

N.B.: "type" can be string with values:

triggerTypeIdToName = { {
{ TRIGGER_TYPE_ARTNET, "artnet" },
{ TRIGGER_TYPE_SACN, "sacn" },
{ TRIGGER_TYPE_IO, "din" },
{ TRIGGER_TYPE_RS232, "rs232" },
{ TRIGGER_TYPE_DMX, "dmx" },
{ TRIGGER_TYPE_OSC, "osc" },
{ TRIGGER_TYPE_UDP, "udp" }
}};

GET_TRIGGER: Get Trigger by id

Request - get Trigger with id = 1

{
  "command": 40,
  "trigger_id": 1
}

Response - trigger for Digital input 1 Activate on Make

{ 
  "trigger": {
    "active": true,
    "name": "Down",
    "start": 0,
    "trigger_id": 1,
    "type": 3,
    "value": {
      "data": 1,
      "port": 0
    }
  }
}

GET_ALL_TRIGGERS: Get all existing Triggers

Request:

{ "command": 41 }

Response:

{
  "triggers": [
    {
      "active": true,
      "name": "Down",
      "start": 0,
      "trigger_id": 1,
      "type": 3,
      "value": {
        "data": 1,
        "port": 0
      }
    },
    {
      "active": true,
      "name": "Up",
      "start": 0,
      "trigger_id": 2,
      "type": 3,
      "value": {
        "data": 0,
        "port": 1
      }
    },
    {
      "active": true,
      "name": "Just White Start",
      "start": 0,
      "trigger_id": 20,
      "type": 8,
      "value": {
        "ip": "192.168.0.",
        "value": "UDP command"
      }
    },
    {
      "active": true,
      "name": "No Trigger",
      "start": 0,
      "trigger_id": 24,
      "type": 2,
      "value": {
        "data": "Please Don't Trigger Me"
      }
    },
    {
      "active": true,
      "name": "Fast Blue Dmx 1-1-100",
      "start": 0,
      "trigger_id": 135,
      "type": 5,
      "value": {
        "channel": 0,
        "universe": 0,
        "value": 100
      }
    },
    {
      "active": true,
      "name": "Fast Yellow Meteors Up Start",
      "start": 0,
      "trigger_id": 136,
      "type": 4,
      "value": {
        "channel": 29,
        "net_type": "broadcast",
        "universe": 10,
        "value": 127
      }
    },
    {
      "active": true,
      "name": "Osc Up Start",
      "start": 0,
      "trigger_id": 138,
      "type": 1,
      "value": {
        "address": "/start",
        "data_type": "string",
        "net_type": "broadcast"
      }
    },
    {
      "active": true,
      "name": "SACN trigger",
      "start": 0,
      "trigger_id": 211,
      "type": 6,
      "value": {
        "channel": 99,
        "net_type": "multicast",
        "universe": 200,
        "value": 150
      }
    }
  ]
}

UPDATE_TRIGGER: Update/Create Trigger

Request - Create new sACN trigger for universe: 200 channel: 100 value: 150

{
  "command": 42,
  "trigger": {
    "trigger_id": 0,
    "name": "SACN trigger",
    "type": 6,
    "value": {
      "channel": 99,
      "value": 150,
      "universe": 200,
      "net_type": "multicast"
    }
  }
}

Response - returns result: true and generated trigger_id: 211

{ 
  "result": true,
  "trigger": {
    "active":true,
    "name":"SACN trigger",
    "start":0,
    "trigger_id":211,
    "type":6,
    "value":{
      "channel":99,
      "net_type":"multicast",
      "universe":200,
      "value":150
    }
  }
}

DELETE_TRIGGER: Delete Trigger by id

Request:

{
  "command": 43,
  "trigger_id":211
}

Response - returns true if Trigger with id 211 existed and was removed else false

{ "result": true }

WAIT_TRIGGER: Add temporary trigger to check with CHECK_TRIGGER

Request - add OSC Trigger with address "/start" and string value "broadcast"

{
  "command": 45,
  "trigger": {
    "name": "",
    "trigger_id": 0,
    "type": "osc",
    "value": {
      "address": "/start",
      "data_type": "string",
      "net_type": "broadcast"
    }
  }
}

Response - successfully added

{ "result": true }

CHECK_TRIGGER: Check if added trigger happen

Request:

{ "command": 46 }

Response - result true if trigger wasn't triggered and S-Play still listening for it, false if trigger happened or no trigger is awaited

{ "result": true }

SHUTDOWN: Gracefully shutdown S-Play

Request:

{ "command": 222 }

Response:

{ "result": true }