rsmp 0.43.2 → 0.45.0

data/schemas/core/3.3.0/definitions.json

@@ -0,0 +1,133 @@
+{
+  "rsmp_string": {
+    "type" : "string",
+    "not" : {
+      "$comment" : "A unicode string, excluding ASCII control characters and Unicode line/paragraph separators",
+      "type" : "string",
+      "pattern" : "[\\u0000-\\u001F\\u007F\\u2028\\u2029]"
+    }
+  },
+  "message_id": {
+    "description" : "Message Id",
+    "$comment" : "Example: 1.2.3 or 1.2",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$" }
+    ]
+  },
+  "timestamp" : {
+    "description" : "Timestamp",
+    "$comment" : "Example: 2015-06-08T11:49:03.293Z",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}Z$" }
+    ]
+  },
+  "integer" : {
+    "description" : "Integer as string",
+    "$comment" : "Example: 123 or -123",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern": "^\\-?[0-9]+$" }
+    ]
+  },
+  "version": {
+    "description" : "Version",
+    "$comment" : "Example: 1.2.3 or 1.2",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern" : "^[0-9]{1,2}\\.[0-9]{1,2}(\\.[0-9]{1,2})?" }
+    ]
+  },
+  "command_code": {
+    "description" : "Command code id",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern" : "^M" }
+    ]
+  },
+  "status_code": {
+    "description" : "Status code id",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern" : "^S" }
+    ]
+  },
+  "alarm_code": {
+    "description" : "Alarm code id",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern" : "^A" }
+    ]
+  },
+  "component_id": {
+    "description" : "Compoment id",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" }
+    ]
+  },
+  "component_type": {
+    "description" : "Component type",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern" : "^[A-Za-z0-9_-]+(?:/[A-Za-z0-9_-]+)*$" }
+    ]
+  },
+  "component_name": {
+    "description" : "Component name",
+    "minLength" : 1,
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" }
+    ]
+  },
+  "sxl_name": {
+    "description" : "SXL name",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern" : "^[A-Za-z0-9_-]+(?:/[A-Za-z0-9_-]+)*$" }
+    ]
+  },
+  "sxl_prefix": {
+    "description" : "SXL prefix",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern" : "^[A-Za-z0-9_-]+/$" }
+    ]
+  },
+  "boolean": {
+    "description" : "Boolean as string",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "enum" : [ "True", "False" ] }
+    ]
+  },
+  "integer_list": {
+    "description" : "Comma-separated list of integers as strings",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern" : "^(\\-?\\d+)(?:,(\\-?\\d+))*$" }
+    ]
+  },
+  "number_list": {
+    "description" : "Comma-separated list of numbers as strings",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern" : "^(\\-?\\d+(\\.\\d+)?)(?:,(\\-?\\d+(\\.\\d+)?))*$" }
+    ]
+  },
+  "boolean_list": {
+    "description" : "Comma-separated list of booleans as strings",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern" : "^(True|False)(?:,(True|False))*$" }
+    ]
+  },
+  "string_list": {
+    "description" : "Comma-separated list of strings",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" }
+    ]
+  }
+}
+
+

data/schemas/core/3.3.0/message_ack.json

@@ -0,0 +1,11 @@
+{
+  "title" :  "MessageAck",
+  "description" :  "Message acknowledged",
+  "properties" : {
+    "oMId" : {
+      "$ref": "definitions.json#/message_id",
+      "description" : "Old message id"
+    }
+  },
+  "required" : [ "oMId" ]
+}

data/schemas/core/3.3.0/message_not_ack.json

@@ -0,0 +1,15 @@
+{
+  "title" :  "MessageNotAck",
+  "description" :  "Message not acknowledgeded",
+  "properties" : {
+    "oMId" : {
+      "$ref": "definitions.json#/message_id",
+      "description" : "Old message id"
+    },
+    "rea" : {
+      "description" : "Reason / Error message",
+      "type" : "string"
+    }
+  },
+  "required" : [ "oMId" ]
+}

data/schemas/core/3.3.0/rsmp.json

@@ -0,0 +1,142 @@
+{
+  "allOf": [
+    {
+      "$ref": "core.json"
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "MessageAck" } }
+      },
+      "then": {
+        "$ref": "message_ack.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "MessageNotAck" } }
+      },
+      "then": {
+        "$ref": "message_not_ack.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Version" } }
+      },
+      "then": {
+        "$ref": "version.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "ComponentList" } }
+      },
+      "then": {
+        "$ref": "component_list.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "AggregatedStatus" } }
+      },
+      "then": {
+        "$ref": "aggregated_status.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "AggregatedStatusRequest" } }
+      },
+      "then": {
+        "$ref": "aggregated_status_request.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Watchdog" } }
+      },
+      "then": {
+        "$ref": "watchdog.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Alarm" } }
+      },
+      "then": {
+        "$ref": "alarm.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "CommandRequest" } }
+      },
+      "then": {
+        "$ref": "command_request.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "CommandResponse" } }
+      },
+      "then": {
+        "$ref": "command_response.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusRequest" } }
+      },
+      "then": {
+        "$ref": "status_request.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusResponse" } }
+      },
+      "then": {
+        "$ref": "status_response.json"
+      }
+    },
+    {
+      "if": {
+         "required" : ["type"],
+       "properties": { "type": { "const": "StatusSubscribe" } }
+      },
+      "then": {
+        "$ref": "status_subscribe.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusUnsubscribe" } }
+      },
+      "then": {
+        "$ref": "status_unsubscribe.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusUpdate" } }
+      },
+      "then": {
+        "$ref": "status_update.json"
+      }
+    }
+  ]
+}

data/schemas/core/3.3.0/status.json

@@ -0,0 +1,21 @@
+{
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "sS" : {
+      "description" : "Status request arguments",
+      "type" : "array",
+      "minItems": 1,
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "sCI" : { "$ref": "definitions.json#/status_code" },
+          "n" : { "description" : "Unique reference of the value", "type" : "string" }
+        },
+        "required" : [ "sCI", "n" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "sS"]
+}

data/schemas/core/3.3.0/status_request.json

@@ -0,0 +1,5 @@
+{
+  "title" :  "StatusRequest",
+  "description" :  "Status request",
+  "$ref": "status.json"
+}

data/schemas/core/3.3.0/status_response.json

@@ -0,0 +1,41 @@
+{
+  "title" :  "StatusResponse",
+  "description" :  "Status response",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "sTs" : { "$ref": "definitions.json#/timestamp" },
+    "sS" : {
+      "description" : "Status response arguments",
+      "type" : "array",
+      "minItems": 1,
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "sCI" : { "$ref": "definitions.json#/status_code" },
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "s" : { "description" : "Value"},
+          "q" : { "description" : "Quality", "type" : "string", "enum" : [ "recent", "old", "undefined", "unknown"] }
+        },
+        "if": {
+          "properties": {
+            "q" : { "enum" : ["unknown","undefined"] }
+          }
+        },
+        "then": {
+          "properties": {
+            "s" : { "type" : "null" }
+          }
+        },
+        "else": {
+          "properties": {
+            "s" : { "type" : ["string","array"] }
+          }
+        },
+        "required" : [ "sCI", "n", "s", "q" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "sTs", "sS" ]
+}

data/schemas/core/3.3.0/status_subscribe.json

@@ -0,0 +1,31 @@
+{
+  "title" :  "StatusSubscribe",
+  "description" :  "Status subscribe",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "sS" : {
+      "description" : "Status request arguments",
+      "type" : "array",
+      "minItems": 1,
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "sCI" : { "$ref": "definitions.json#/status_code" },
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "uRt" : {
+            "$ref": "definitions.json#/integer",
+            "description" : "Update interval in seconds, 0 means send when value changes"
+          },
+          "sOc" : {
+            "type": "boolean",
+            "description" : "Whether to send an update as soon as the value changes"
+          }
+        },
+        "required" : [ "sCI", "n", "uRt", "sOc" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "sS"]
+}

data/schemas/core/3.3.0/status_unsubscribe.json

@@ -0,0 +1,5 @@
+{
+  "title" :  "StatusUnsubscribe",
+  "description" :  "Status unsubscribe",
+  "$ref": "status.json"
+}

data/schemas/core/3.3.0/status_update.json

@@ -0,0 +1,41 @@
+ {
+  "title" :  "StatusUpdate",
+  "description" :  "Status update",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "sTs" : { "$ref": "definitions.json#/timestamp" },
+    "sS" : {
+      "description" : "Status update arguments",
+      "type" : "array",
+      "minItems": 1,
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "sCI" : { "$ref": "definitions.json#/status_code" },
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "s" : { "description" : "Value"},
+          "q" : { "description" : "Quality", "type" : "string", "enum" : [ "recent", "old", "undefined", "unknown"] }
+        },
+        "if": {
+          "properties": {
+            "q" : { "enum" : ["unknown","undefined"] }
+          }
+        },
+        "then": {
+          "properties": {
+            "s" : { "type" : "null" }
+          }
+        },
+        "else": {
+          "properties": {
+            "s" : { "type" : ["string","array"] }
+          }
+        },
+        "required" : [ "sCI", "n", "s", "q" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "sTs", "sS" ]
+}

data/schemas/core/3.3.0/version.json

@@ -0,0 +1,144 @@
+{
+  "title" :  "Version",
+  "description" :  "Version message",
+  "oneOf" : [
+    {
+      "description" : "Version request",
+      "properties" : {
+        "mId" : { "$ref": "definitions.json#/message_id" },
+        "step" : {
+          "type" : "string",
+          "const" : "Request"
+        },
+        "RSMP" : {
+          "$ref" : "#/$defs/rsmp_versions",
+          "description" : "Supported RSMP versions"
+        },
+        "SXL" : {
+          "$ref": "definitions.json#/version",
+          "description" : "Primary SXL version, for backward compatibility"
+        },
+        "SXLS" : {
+          "description" : "Supported SXLs",
+          "type" : "array",
+          "items" : { "$ref" : "#/$defs/sxl_request" },
+          "minItems" : 0,
+          "uniqueItems" : true
+        },
+        "siteId" : {
+          "description" : "Site ids",
+          "type" : "array",
+          "items" : { "$ref" : "#/$defs/site_id" },
+          "minItems" : 1,
+          "maxItems" : 1,
+          "uniqueItems" : true
+        }
+      },
+      "required" : [ "mId", "RSMP", "SXLS", "siteId" ]
+    },
+    {
+      "description" : "Version response",
+      "properties" : {
+        "mId" : { "$ref": "definitions.json#/message_id" },
+        "step" : {
+          "type" : "string",
+          "const" : "Response"
+        },
+        "RSMP" : {
+          "description" : "Selected RSMP version",
+          "allOf" : [
+            { "$ref" : "#/$defs/rsmp_versions" },
+            {
+              "minItems" : 1,
+              "maxItems" : 1
+            }
+          ]
+        },
+        "supervisorId" : {
+          "description" : "Supervisor id",
+          "type" : "string",
+          "minLength" : 1
+        },
+        "SXLS" : {
+          "description" : "SXLs to use, or not use",
+          "type" : "array",
+          "items" : { "$ref" : "#/$defs/sxl_response" },
+          "minItems" : 0,
+          "uniqueItems" : true
+        },
+        "receiveAlarms" : {
+          "description" : "Whether the supervisor wants to receive alarms",
+          "type" : "boolean"
+        }
+      },
+      "required" : [ "mId", "step", "RSMP", "supervisorId", "SXLS" ]
+    }
+  ],
+  "$defs" : {
+    "rsmp_versions" : {
+      "type" : "array",
+      "items" : {
+        "type" : "object",
+        "properties" : {
+          "vers" : {
+            "$ref": "definitions.json#/version",
+            "description" : "RSMP version"
+          }
+        },
+        "required" : [ "vers" ],
+        "additionalProperties" : false
+      },
+      "minItems" : 1,
+      "uniqueItems" : true
+    },
+    "site_id" : {
+      "type" : "object",
+      "properties" : {
+        "sId" : {
+          "type" : "string",
+          "minLength": 1
+        }
+      },
+      "required" : [ "sId" ],
+      "additionalProperties" : false
+    },
+    "sxl_request" : {
+      "type" : "object",
+      "properties" : {
+        "name" : { "$ref" : "definitions.json#/sxl_name" },
+        "version" : { "$ref" : "definitions.json#/version" },
+        "prefix" : { "$ref" : "definitions.json#/sxl_prefix" }
+      },
+      "required" : [ "name", "version" ],
+      "additionalProperties" : false
+    },
+    "sxl_response" : {
+      "type" : "object",
+      "oneOf" : [
+        {
+          "properties" : {
+            "name" : { "$ref" : "definitions.json#/sxl_name" },
+            "version" : { "$ref" : "definitions.json#/version" }
+          },
+          "required" : [ "name", "version" ],
+          "additionalProperties" : false
+        },
+        {
+          "properties" : {
+            "name" : { "$ref" : "definitions.json#/sxl_name" },
+            "version" : { "$ref" : "definitions.json#/version" },
+            "rejected" : {
+              "type" : "integer",
+              "enum" : [ 1, 2, 3 ]
+            },
+            "reason" : {
+              "type" : "string"
+            }
+          },
+          "required" : [ "name", "rejected" ],
+          "additionalProperties" : false
+        }
+      ]
+    }
+  }
+}

data/schemas/core/3.3.0/watchdog.json

@@ -0,0 +1,9 @@
+{
+  "title" :  "Watchdog",
+  "description" :  "Watchdog message",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "wTs" : { "$ref": "definitions.json#/timestamp" }
+  },
+  "required" : [ "mId", "wTs" ]
+}

data/schemas/tlc/1.3.0/alarms/A0001.json

@@ -0,0 +1,4 @@
+{
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
+  "description" : "Serious hardware error.\nIs a \"major fault\" defined according to 3.8 in EN12675 which causes the controller to switch to a \"failure mode\" according to 3.6 in EN12675."
+}

data/schemas/tlc/1.3.0/alarms/A0002.json

@@ -0,0 +1,4 @@
+{
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
+  "description" : "Less serious hardware error.\nIs a \"minor fault\" defined according to 3.11 in EN12675."
+}

data/schemas/tlc/1.3.0/alarms/A0003.json

@@ -0,0 +1,4 @@
+{
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
+  "description" : "Serious configuration error.\nIs a \"major fault\" defined according to 3.8 in EN12675 which causes the controller to switch to a \"failure mode\" according to 3.6 in EN12675."
+}

data/schemas/tlc/1.3.0/alarms/A0004.json

@@ -0,0 +1,4 @@
+{
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
+  "description" : "Less serious configuration error.\nIs a \"minor fault\" defined according to 3.11 in EN12675."
+}

data/schemas/tlc/1.3.0/alarms/A0005.json

@@ -0,0 +1,4 @@
+{
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
+  "description" : "Synchronisation error (coordination).\nIs a \"minor fault\" defined according to 3.11 in EN12675."
+}

data/schemas/tlc/1.3.0/alarms/A0006.json

@@ -0,0 +1,4 @@
+{
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
+  "description" : "Safety error\nIs a \"major fault\" defined according to 3.8 in EN12675 which causes the controller to switch to a \"failure mode\" according to 3.6 in EN12675."
+}

data/schemas/tlc/1.3.0/alarms/A0007.json

@@ -0,0 +1,34 @@
+{
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
+  "description" : "Communication error.\nUsed for communication errors with the central system. Includes NTP connection loss if the TLC is configured to use NTP.\nIs a \"minor fault\" defined according to 3.11 in EN12675.",
+  "properties" : {
+    "n" : {
+      "enum" : [
+        "protocol"
+      ]
+    }
+  },
+  "allOf" : [
+    {
+      "if" : {
+        "properties" : {
+          "n" : {
+            "const" : "protocol"
+          }
+        }
+      },
+      "then" : {
+        "properties" : {
+          "v" : {
+            "description" : "Type of communication error, e.g. NTP or RSMP",
+            "type" : "string",
+            "enum" : [
+              "ntp",
+              "rsmp"
+            ]
+          }
+        }
+      }
+    }
+  ]
+}