module.json

{
  "name": "Ontime",
  "type": "WebSocket Client",
  "path": "Software",

  "version": "0.4.0",
  "description": "Module for interacting with ontime",
  "url": "https://github.com/alex-Arc/Ontime-Chataigne-module",
  "downloadURL": "https://github.com/alex-Arc/Ontime-Chataigne-module/archive/refs/heads/main.zip",

  "hasInput": true,
  "hasOutput": true,

  "hideDefaultCommands": true,

  "defaults": {
    "protocol": "JSON",
    "serverPath": "127.0.0.1:4001/ws",
    "useSecureConnection": false,
    "autoAdd": false
  },

  "parameters": {
    "Increased precision": {
      "type": "Boolean",
      "default": false,
      "description": "If you need higher precision. This includes milliseconds, otherwise it's rounded to the nearest second"
    },
    "Ontime version": {
      "type": "String",
      "readOnly": true
    },
    "Client name": {
      "type": "String",
      "readOnly": true
    }
  },

  "hideDefaultParameters": [
    "autoAdd",
    "protocol",
    "messageStructure",
    "firstValueIsTheName",
    "useSecureConnection",
    "customSeparator"
  ],

  "scripts": ["./Ontime.js"],

  "values": {
    "Clock": { "type": "Float", "ui": "time", "readOnly": true },
    "onAir": { "shortName": "onAir", "type": "Boolean", "readOnly": true },
    "Main Timer": {
      "type": "Container",
      "collapsed": true,
      "Added Time": { "type": "Float", "ui": "time", "readOnly": true },
      "Current": { "type": "Float", "ui": "time", "readOnly": true },
      "Duration": { "type": "Float", "ui": "time", "readOnly": true },
      "Elapsed": { "type": "Float", "ui": "time", "readOnly": true },
      "Expected Finish": { "type": "Float", "ui": "time", "readOnly": true },
      "Started At": { "type": "Float", "ui": "time", "readOnly": true },
      "Finished At": { "type": "Float", "ui": "time", "readOnly": true },
      "Phase": {
        "type": "Enum",
        "options": {
          "-inactive-": "none",
          "Default": "default",
          "Warning": "warning",
          "Danger": "danger",
          "Overtime": "overtime",
          "Pending Roll": "pending"
        },
        "readOnly": true
      },
      "Playback": {
        "type": "Enum",
        "options": {
          "-inactive-": "",
          "Play": "play",
          "Roll": "roll",
          "Pause": "pause",
          "Stop": "stop",
          "Armed": "armed"
        },
        "readOnly": true
      }
    },
    "Message": {
      "type": "Container",
      "Timer": {
        "type": "Container",
        "collapsed": true,
        "Text": { "type": "String", "readOnly": true },
        "Visible": { "type": "Boolean", "readOnly": true },
        "Blink": { "type": "Boolean", "readOnly": true },
        "Blackout": { "type": "Boolean", "readOnly": true },
        "Secondary Source": {
          "type": "Enum",
          "options": {
            "External": "external",
            "Aux": "aux",
            "Off": "off"
          },
          "readOnly": true
        },
        "External": { "type": "String", "readOnly": true }
      }
    },
    "Runtime": {
      "type": "Container",
      "collapsed": true,
      "Current Event Index": { "type": "Integer", "readOnly": true, "description": "All events, excluding skipped" },
      "Num Events": { "type": "Integer", "readOnly": true },
      "Offset": { "type": "Float", "ui": "time", "readOnly": true },
      "Planned Start": { "type": "Float", "ui": "time", "readOnly": true },
      "Planned End": { "type": "Float", "ui": "time", "readOnly": true },
      "Actual Start": { "type": "Float", "ui": "time", "readOnly": true },
      "Expected End": { "type": "Float", "ui": "time", "readOnly": true }
    },
    "Current Block": {
      "type": "Container",
      "collapsed": true,
      "id": { "type": "String", "readOnly": true },
      "Title": { "type": "String", "readOnly": true },
      "Started At": { "type": "Float", "ui": "time", "readOnly": true }
    },
    "Current Event": {
      "type": "Container",
      "collapsed": true,
      "id": { "type": "String", "readOnly": true },
      "Title": { "type": "String", "readOnly": true },
      "Cue": { "type": "String", "readOnly": true },
      "Colour": { "type": "Color", "readOnly": true },
      "Note": { "type": "String", "readOnly": true },
      "Start": { "type": "Float", "ui": "time", "readOnly": true },
      "End": { "type": "Float", "ui": "time", "readOnly": true },
      "Duration": { "type": "Float", "ui": "time", "readOnly": true },
      "Public": { "type": "Boolean", "readOnly": true },
      "Skip": { "type": "Boolean", "readOnly": true },
      "Danger": { "type": "Float", "ui": "time", "readOnly": true },
      "Warning": { "type": "Float", "ui": "time", "readOnly": true },
      "End Action": {
        "type": "Enum",
        "options": {
          " ": "",
          "None": "none",
          "Stop": "stop",
          "Load next": "load-next",
          "Play next": "play-next"
        },
        "readOnly": true
      },
      "Timer Type": {
        "type": "Enum",
        "options": {
          " ": "",
          "Count down": "count-down",
          "Count up": "count-up",
          "Time to end": "time-to-end",
          "Clock": "clock"
        },
        "readOnly": true
      }
    },
    "Next Event": {
      "type": "Container",
      "collapsed": true,
      "id": { "type": "String", "readOnly": true },
      "Title": { "type": "String", "readOnly": true },
      "Cue": { "type": "String", "readOnly": true },
      "Colour": { "type": "Color", "readOnly": true },
      "Note": { "type": "String", "readOnly": true },
      "Start": { "type": "Float", "ui": "time", "readOnly": true },
      "End": { "type": "Float", "ui": "time", "readOnly": true },
      "Duration": { "type": "Float", "ui": "time", "readOnly": true },
      "Public": { "type": "Boolean", "readOnly": true },
      "Skip": { "type": "Boolean", "readOnly": true },
      "Danger": { "type": "Float", "ui": "time", "readOnly": true },
      "Warning": { "type": "Float", "ui": "time", "readOnly": true },
      "End Action": {
        "type": "Enum",
        "options": {
          " ": "",
          "None": "none",
          "Stop": "stop",
          "Load next": "load-next",
          "Play next": "play-next"
        },
        "readOnly": true
      },
      "Timer Type": {
        "type": "Enum",
        "options": {
          " ": "",
          "Count down": "count-down",
          "Count up": "count-up",
          "Time to end": "time-to-end",
          "Clock": "clock"
        },
        "readOnly": true
      }
    },
    "Current Public Event": {
      "type": "Container",
      "collapsed": true,
      "id": { "type": "String", "readOnly": true },
      "Title": { "type": "String", "readOnly": true },
      "Cue": { "type": "String", "readOnly": true },
      "Colour": { "type": "Color", "readOnly": true },
      "Note": { "type": "String", "readOnly": true },
      "Start": { "type": "Float", "ui": "time", "readOnly": true },
      "End": { "type": "Float", "ui": "time", "readOnly": true },
      "Duration": { "type": "Float", "ui": "time", "readOnly": true },
      "Public": { "type": "Boolean", "readOnly": true },
      "Skip": { "type": "Boolean", "readOnly": true },
      "Danger": { "type": "Float", "ui": "time", "readOnly": true },
      "Warning": { "type": "Float", "ui": "time", "readOnly": true },
      "End Action": {
        "type": "Enum",
        "options": {
          " ": "",
          "None": "none",
          "Stop": "stop",
          "Load next": "load-next",
          "Play next": "play-next"
        },
        "readOnly": true
      },
      "Timer Type": {
        "type": "Enum",
        "options": {
          " ": "",
          "Count down": "count-down",
          "Count up": "count-up",
          "Time to end": "time-to-end",
          "Clock": "clock"
        },
        "readOnly": true
      }
    },
    "Next Public Event": {
      "type": "Container",
      "collapsed": true,
      "id": { "type": "String", "readOnly": true },
      "Title": { "type": "String", "readOnly": true },
      "Cue": { "type": "String", "readOnly": true },
      "Colour": { "type": "Color", "readOnly": true },
      "Note": { "type": "String", "readOnly": true },
      "Start": { "type": "Float", "ui": "time", "readOnly": true },
      "End": { "type": "Float", "ui": "time", "readOnly": true },
      "Duration": { "type": "Float", "ui": "time", "readOnly": true },
      "Public": { "type": "Boolean", "readOnly": true },
      "Skip": { "type": "Boolean", "readOnly": true },
      "Danger": { "type": "Float", "ui": "time", "readOnly": true },
      "Warning": { "type": "Float", "ui": "time", "readOnly": true },
      "End Action": {
        "type": "Enum",
        "options": {
          " ": "",
          "None": "none",
          "Stop": "stop",
          "Load next": "load-next",
          "Play next": "play-next"
        },
        "readOnly": true
      },
      "Timer Type": {
        "type": "Enum",
        "options": {
          " ": "",
          "Count down": "count-down",
          "Count up": "count-up",
          "Time to end": "time-to-end",
          "Clock": "clock"
        },
        "readOnly": true
      }
    },
    "Aux Timer 1": {
      "type": "Container",
      "collapsed": true,
      "Duration": { "type": "Float", "ui": "time", "readOnly": true },
      "Current": { "type": "Float", "ui": "time", "readOnly": true },
      "Playback": {
        "type": "Enum",
        "options": {
          "-inactive-": "",
          "Start": "start",
          "Pause": "pause",
          "Stop": "stop"
        },
        "readOnly": true
      },
      "Direction": {
        "type": "Enum",
        "options": {
          "Count down": "count-down",
          "Count up": "count-up"
        },
        "readOnly": true
      }
    }
  },

  "commands": {
    "Event action": {
      "callback": "eventAction",
      "parameters": {
        "Target type": {
          "type": "Enum",
          "options": {
            "Target ID": "id",
            "Target cue name": "cue",
            "Target list index": "index"
          },
          "description": "Unique ID, cue name, list number"
        },
        "Target identifier": {
          "type": "String",
          "description": "Type in target identifier"
        },
        "Target action": {
          "type": "Enum",
          "options": {
            "Start": "start",
            "Load": "load"
          },
          "description": "Select action to preform"
        }
      }
    },
    "General action": {
      "callback": "generalAction",
      "parameters": {
        "General action": {
          "type": "Enum",
          "options": {
            "Start next": "startNext",
            "Start loaded": "start",
            "Start previous": "startPrevious",
            "Load next": "loadNext",
            "Reload current": "reload",
            "Load previous": "loadPrevious",
            "Pause": "pause",
            "Roll": "roll",
            "Stop": "stop",
            "Add/remove": "addtime"
          },
          "description": "Select action to preform"
        },
        "Add/remove": {
          "type": "Float",
          "ui": "time",
          "min": -72000,
          "max": 72000,
          "default": 0,
          "description": "Offset current counter",
          "dependency": {
            "source": "generalAction",
            "value": "addtime",
            "check": "equals",
            "action": "show"
          }
        }
      }
    },
    "Message Action": {
      "callback": "messageAction",
      "parameters": {
        "Event action": {
          "type": "Enum",
          "options": {
            "Set timer message": "setTimerMessage",
            "Show timer message": "showTimerMessage",
            "Blink Timer": "blinkTimer",
            "Blackout Timer": "blackoutTimer",
            "Set external message": "setExternalMessage",
            "Show secondary source": "showSecondarySource"
          },
          "description": "Select action to preform"
        },
        "Timer message": {
          "type": "String",
          "dependency": {
            "source": "eventAction",
            "value": "setTimerMessage",
            "check": "equals",
            "action": "show"
          }
        },
        "Show timer message": {
          "type": "Boolean",
          "dependency": {
            "source": "eventAction",
            "value": "showTimerMessage",
            "check": "equals",
            "action": "show"
          }
        },
        "Blink timer": {
          "type": "Boolean",
          "dependency": {
            "source": "eventAction",
            "value": "blinkTimer",
            "check": "equals",
            "action": "show"
          }
        },
        "Blackout timer": {
          "type": "Boolean",
          "dependency": {
            "source": "eventAction",
            "value": "blackoutTimer",
            "check": "equals",
            "action": "show"
          }
        },
        "External message": {
          "type": "String",
          "dependency": {
            "source": "eventAction",
            "value": "setExternalMessage",
            "check": "equals",
            "action": "show"
          }
        },
        "Show Secondary Source": {
          "type": "Enum",
          "options": {
            "External":"external",
            "Aux Timer":"aux",
            "Off":"off"
          },
          "dependency": {
            "source": "eventAction",
            "value": "showSecondarySource",
            "check": "equals",
            "action": "show"
          }
        }
      }
    },
    "Aux timer": {
      "callback": "auxTimer",
      "parameters": {
        "index": {
          "type": "Integer",
          "default": 1,
          "min": 1,
          "max": 10,
          "readOnly": true
        },
        "Action": {
          "type": "Enum",
          "options": {
            "Set": "set",
            "Start": "start",
            "Pause": "pause",
            "Stop": "stop",
            "Add/remove": "addtime"
          }
        },
        "Timer": {
          "type": "Float",
          "ui": "time",
          "default": 0,
          "min": 0,
          "max": 359999,
          "dependency": {
            "source": "action",
            "value": "set",
            "check": "equals",
            "action": "show"
          }
        },
        "Direction": {
          "type": "Enum",
          "options": {
            "Up": "count-up",
            "Down": "count-down"
          },
          "dependency": {
            "source": "action",
            "value": "set",
            "check": "equals",
            "action": "show"
          }
        },
        "Add/remove": {
          "type": "Float",
          "ui": "time",
          "default": 0,
          "min":-36000,
          "max":36000,
          "dependency": {
            "source": "action",
            "value": "addtime",
            "check": "equals",
            "action": "show"
          }
        }
      }
    },
    "Make change": {
      "callback": "changeEvent",
      "parameters": {
        "Event identifier": {
          "type": "String",
          "description": "Type in target identifier"
        },
        "Target change": {
          "type": "Enum",
          "options": {
            "Title": "title",
            "Note": "note",
            "Cue name": "cue",
            "Start Time": "timeStart",
            "Link start": "linkStart",
            "End Time": "timeEnd",
            "Duration": "duration",
            "Public event": "isPublic",
            "Timer type": "timerType",
            "End action": "endAction",
            "Warning time": "timeWarning",
            "Danger time": "timeDanger",
            "Skip event": "skip",
            "Select cue colour": "selectColour",
            "Pick cue colour": "pickColour",
            "Write cue colour": "writeColour",
            "Custom fields": "custom"
          },
          "description": "Select action to preform"
        },
        "Title": {
          "type": "String",
          "dependency": {
            "source": "targetChange",
            "value": "title",
            "check": "equals",
            "action": "show"
          }
        },
        "Note": {
          "type": "String",
          "dependency": {
            "source": "targetChange",
            "value": "note",
            "check": "equals",
            "action": "show"
          }
        },
        "Cue Name": {
          "type": "String",
          "dependency": {
            "source": "targetChange",
            "value": "cue",
            "check": "equals",
            "action": "show"
          }
        },
        "Start time": {
          "type": "Float",
          "ui": "time",
          "min": 0,
          "max": 86400,
          "default": 0,
          "dependency": {
            "source": "targetChange",
            "value": "timeStart",
            "check": "equals",
            "action": "show"
          }
        },
        "Link start": {
          "type": "Boolean",
          "dependency": {
            "source": "targetChange",
            "value": "linkStart",
            "check": "equals",
            "action": "show"
          },
          "description": "Connect start time to end time of previous event."
        },
        "End time": {
          "type": "Float",
          "ui": "time",
          "min": 0,
          "max": 86400,
          "default": 0,
          "dependency": {
            "source": "targetChange",
            "value": "timeEnd",
            "check": "equals",
            "action": "show"
          }
        },
        "Duration": {
          "type": "Float",
          "ui": "time",
          "min": 0,
          "max": 86400,
          "default": 0,
          "dependency": {
            "source": "targetChange",
            "value": "duration",
            "check": "equals",
            "action": "show"
          }
        },
        "Skip event": {
          "type": "Boolean",
          "dependency": {
            "source": "targetChange",
            "value": "skip",
            "check": "equals",
            "action": "show"
          }
        },
        "Public": {
          "type": "Boolean",
          "dependency": {
            "source": "targetChange",
            "value": "isPublic",
            "check": "equals",
            "action": "show"
          }
        },
        "Timer type": {
          "type": "Enum",
          "options": {
            "Count down": "count-down",
            "Count up": "count-up",
            "Time to end": "time-to-end",
            "Clock": "clock"
          },
          "dependency": {
            "source": "targetChange",
            "value": "timerType",
            "check": "equals",
            "action": "show"
          }
        },
        "End action": {
          "type": "Enum",
          "options": {
            "None": "none",
            "Stop": "stop",
            "Load next": "load-next",
            "Play next": "play-next"
          },
          "dependency": {
            "source": "targetChange",
            "value": "endAction",
            "check": "equals",
            "action": "show"
          }
        },
        "Warning time": {
          "type": "Float",
          "ui": "time",
          "min": 0,
          "max": 86400,
          "default": 120,
          "dependency": {
            "source": "targetChange",
            "value": "timeWarning",
            "check": "equals",
            "action": "show"
          }
        },
        "Danger time": {
          "type": "Float",
          "ui": "time",
          "min": 0,
          "max": 86400,
          "default": 60,
          "dependency": {
            "source": "targetChange",
            "value": "timeDanger",
            "check": "equals",
            "action": "show"
          }
        },
        "Select cue color": {
          "type": "Enum",
          "options": {
            "None": "none",
            "Orange-400": "#ffcc78",
            "Orange-600": "#FFab33",
            "Green-400": "#77c785",
            "Green-600": "#339e4e",
            "Blue-400": "#779be7",
            "Blue-600": "#3e75e8",
            "Red-400": "#ff7878",
            "Red-600": "#ed3333",
            "Violet-400": "#af90f5",
            "Violet-600": "#8064e1",
            "Gray-400": "#9d9d9d",
            "Gray-600": "#ececec"
          },
          "dependency": {
            "source": "targetChange",
            "value": "selectColour",
            "check": "equals",
            "action": "show"
          }
        },
        "Pick cue colour": {
          "type": "Color",
          "description": "# hex color or named css color",
          "dependency": {
            "source": "targetChange",
            "value": "pickColour",
            "check": "equals",
            "action": "show"
          }
        },
        "Set cue colour": {
          "type": "String",
          "description": "# hex color or named css color",
          "dependency": {
            "source": "targetChange",
            "value": "writeColour",
            "check": "equals",
            "action": "show"
          }
        },
        "Custom field id": {
          "type": "String",
          "dependency": {
            "source": "targetChange",
            "value": "custom",
            "check": "equals",
            "action": "show"
          }
        },
        "Custom field text": {
          "type": "String",
          "dependency": {
            "source": "targetChange",
            "value": "custom",
            "check": "equals",
            "action": "show"
          }
        }
      }
    }
  }
}