channel.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/OpenLightingProject/open-fixture-library/master/schemas/channel.json",

  "$comment": "This file is used by another schema file and should not be used directly as a JSON schema.",

  "type": "object",
  "properties": {
    "name": {
      "description": "if not set: use channel key",
      "$ref": "definitions.json#/nonEmptyString"
    },
    "fineChannelAliases": {
      "type": "array",
      "minItems": 1,
      "uniqueItems": true,
      "items": {
        "oneOf": [
          { "$ref": "definitions.json#/noVariablesString" },
          {
            "$ref": "definitions.json#/variablePixelKeyString",
            "$comment": "only in template channels"
          }
        ]
      }
    },
    "dmxValueResolution": { "enum": ["8bit", "16bit", "24bit"] },
    "defaultValue": { "oneOf": [
      { "$ref": "definitions.json#/units/dmxValue" },
      { "$ref": "definitions.json#/units/dmxValuePercent" }
    ] },
    "highlightValue": { "oneOf": [
      { "$ref": "definitions.json#/units/dmxValue" },
      { "$ref": "definitions.json#/units/dmxValuePercent" }
    ] },
    "constant": { "type": "boolean" },
    "precedence": { "enum": ["LTP", "HTP"] },
    "capability": {
      "allOf": [{ "$ref": "capability.json#" }],
      "not": {
        "anyOf": [
          { "required": ["dmxRange"] },
          { "required": ["switchChannels"] }
        ]
      }
    },
    "capabilities": {
      "type": "array",
      "minItems": 2,
      "uniqueItems": true,
      "items": {
        "allOf": [{ "$ref": "capability.json#" }],
        "required": ["dmxRange"]
      }
    }
  },
  "dependencies": {
    "dmxValueResolution": ["fineChannelAliases"]
  },
  "oneOf": [
    { "required": ["capability"] },
    { "required": ["capabilities"] }
  ],
  "allOf": [
    {
      "if": {
        "$comment": "one capability sets switchChannels",
        "properties": {
          "capabilities": {
            "contains": {
              "required": ["switchChannels"]
            }
          }
        },
        "required": ["capabilities"]
      },
      "then": {
        "$comment": "defaultValue must be set and all capabilities have to set switchChannels",
        "required": ["defaultValue"],
        "properties": {
          "capabilities": {
            "items": {
              "required": ["switchChannels"]
            }
          }
        }
      }
    },
    {
      "if": {
        "$comment": "channel contains only one NoFunction capability",
        "properties": {
          "capability": {
            "properties": {
              "type": { "const": "NoFunction" }
            }
          }
        },
        "required": ["capability"]
      },
      "then": {
        "$comment": "fineChannelAliases must not be set",
        "not": {
          "required": ["fineChannelAliases"]
        }
      }
    }
  ],
  "additionalProperties": false
}