rsmp_schema 0.8.9 → 0.9.0

data/schemas/core/3.3.0/core.json

@@ -0,0 +1,39 @@
+{
+  "$schema" : "http://json-schema.org/draft-07/schema#",
+  "name" : "core",
+  "description" : "Core",
+  "version" : "3.3.0",
+  "type" :  "object",
+  "allOf" : [
+    {
+      "properties" : {
+        "mType" : {
+          "description" : "Supported RSMP versions",
+          "type" : "string",
+          "const" : "rSMsg"
+        },
+        "type" : {
+          "description" : "Type of RMSP message",
+          "type" : "string",
+          "enum" : [
+            "MessageAck",
+            "MessageNotAck",
+            "Version",
+            "AggregatedStatus",
+            "AggregatedStatusRequest",
+            "Watchdog",
+            "Alarm",
+            "CommandRequest",
+            "CommandResponse",
+            "StatusRequest",
+            "StatusResponse",
+            "StatusSubscribe",
+            "StatusUnsubscribe",
+            "StatusUpdate"
+          ]
+        }
+      },
+      "required" : [ "mType", "type" ]
+    }
+  ]
+}

data/schemas/core/3.3.0/definitions.json

@@ -0,0 +1,35 @@
+{
+  "number_as_string" : {
+    "description" : "Number as string",
+    "type": "string",
+    "$comment" : "Example: 123, -123, 0.5, -2.4",
+    "pattern": "^-?[0-9]+(\.[0-9]+)?$"
+  },
+  "component_id": {
+    "description" : "Component id - supports both format A (AA+BBCDD=EEEFFGGG) and format B (/component/path)",
+    "anyOf": [
+      {
+        "$comment": "Format A: Traditional component id like KK+AG0503=001DL001",
+        "type": "string",
+        "pattern": "^[A-Za-z0-9]+\\+[A-Za-z0-9]+=.+$"
+      },
+      {
+        "$comment": "Format B: Hierarchical component id like /sg/1 or /dl/radar/1",
+        "type": "string",
+        "pattern": "^(/[^/]+)+$",
+        "not": {
+          "pattern": "/$"
+        }
+      },
+      {
+        "$comment": "Empty string refers to main component",
+        "type": "string",
+        "enum": [""]
+      },
+      {
+        "$comment": "Null refers to main component",
+        "type": "null"
+      }
+    ]
+  }
+}

data/schemas/core/3.3.0/rsmp.json

@@ -0,0 +1,133 @@
+{
+  "allOf": [
+    {
+      "$ref": "core.json"
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "MessageAck" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/message_ack.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "MessageNotAck" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/message_not_ack.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Version" } }
+      },
+      "then": {
+        "$ref": "version.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": "../3.1.2/watchdog.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Alarm" } }
+      },
+      "then": {
+        "$ref": "../3.2.0/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": "../3.2.0/status_response.json"
+      }
+    },
+    {
+      "if": {
+         "required" : ["type"],
+       "properties": { "type": { "const": "StatusSubscribe" } }
+      },
+      "then": {
+        "$ref": "status_subscribe.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusUnsubscribe" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/status_unsubscribe.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusUpdate" } }
+      },
+      "then": {
+        "$ref": "../3.2.0/status_update.json"
+      }
+    }
+  ]
+}

data/schemas/core/3.3.0/status.json

@@ -0,0 +1,21 @@
+{
+  "properties" : {
+    "mId" : { "$ref": "../3.1.2/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": "../3.1.2/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,23 @@
+{
+  "title" :  "StatusRequest",
+  "description" :  "Status request",
+  "properties" : {
+    "mId" : { "$ref": "../3.1.2/definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "sS" : {
+      "description" : "Status request list",
+      "type" : "array",
+      "minItems": 1,
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "sCI" : { "$ref": "../3.1.2/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_subscribe.json

@@ -0,0 +1,31 @@
+{
+  "title" :  "StatusSubscribe",
+  "description" :  "Status subscribe",
+  "properties" : {
+    "mId" : { "$ref": "../3.1.2/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": "../3.1.2/definitions.json#/status_code" },
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "uRt" : {
+            "$ref": "definitions.json#/number_as_string",
+            "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/version.json

@@ -0,0 +1,57 @@
+{
+  "title" :  "Version",
+  "description" :  "Version message",
+  "properties" : {
+    "mId" : { "$ref": "../3.1.2/definitions.json#/message_id" },
+    "step" : {
+      "description" : "Message step - Request for initial messages from sites, Response for supervisor replies",
+      "type" : "string",
+      "enum" : [ "Request", "Response" ]
+    },
+    "receiveAlarms" : {
+      "description" : "Whether supervisor wants to receive alarms (optional, only in Response messages)",
+      "type" : "boolean"
+    },
+    "RSMP" : {
+      "description" : "Supported RSMP versions",
+      "type" : "array",
+      "items" : {
+        "type" : "object",
+        "properties" : {
+          "vers" : {
+            "$ref": "../3.1.2/definitions.json#/version",
+            "description" : "RSMP version"
+          }
+        },
+        "required" : ["vers"],
+        "additionalProperties" : false
+      },
+      "minItems" : 1,
+      "uniqueItems" : true
+    },
+    "SXL" : {
+      "$ref": "../3.1.2/definitions.json#/version",
+      "description" : "SXL version"
+    },
+    "siteId" : {
+      "description" : "Site ids",
+      "type" : "array",
+      "items" : {
+        "type" : "object",
+        "properties" : {
+          "sId" : {
+            "type" : "string",
+            "minLength": 1
+          }
+        },
+        "required" : [ "sId" ],
+        "additionalProperties" : false
+      },
+      "minItems" : 1,
+      "uniqueItems" : true,
+      "additionalProperties" : false
+    }
+  },
+  "required" : [ "mId", "step", "RSMP", "SXL", "siteId" ],
+  "additionalProperties": true
+}

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

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

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

@@ -1,3 +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.0.10/alarms/A0003.json

@@ -1,3 +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.0.10/alarms/A0004.json

@@ -1,3 +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.0.10/alarms/A0005.json

@@ -1,3 +1,4 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Communication error between traffic light controllers / synchronisation error.\nIs a \"minor fault\" defined according to 3.11 in EN12675."
 }

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

@@ -1,3 +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.0.10/alarms/A0007.json

@@ -1,3 +1,4 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Communication error between one or multiple traffic light controllers and central control system.\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."
 }

data/schemas/tlc/1.0.10/alarms/A0008.json

@@ -1,60 +1,29 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Dead lock error.\nUsed for dead lock errors.\nFor instance; a signal group has requested green but is unable to switch due to a conflicting signal group for an extended period of time. At some point the request times out and the controller goes failure mode. The cause for this error is due to configuration errors or external sources.\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.",
+  "properties" : {
+    "n" : {
+      "enum" : [
+        "timeplan"
+      ]
+    }
+  },
   "allOf" : [
-    {
-      "properties" : {
-        "n" : {
-          "enum" : [
-            "timeplan"
-          ]
-        }
-      }
-    },
     {
       "if" : {
-        "required" : [
-          "q"
-        ],
         "properties" : {
-          "q" : {
-            "enum" : [
-              "undefined",
-              "unknown"
-            ]
+          "n" : {
+            "const" : "timeplan"
           }
         }
       },
       "then" : {
-      },
-      "else" : {
-        "allOf" : [
-          {
-            "if" : {
-              "required" : [
-                "n"
-              ],
-              "properties" : {
-                "n" : {
-                  "const" : "timeplan"
-                }
-              }
-            },
-            "then" : {
-              "properties" : {
-                "v" : {
-                  "allOf" : [
-                    {
-                      "description" : "Current time plan"
-                    },
-                    {
-                      "$ref" : "../../../core/3.1.2/definitions.json#/integer"
-                    }
-                  ]
-                }
-              }
-            }
+        "properties" : {
+          "v" : {
+            "description" : "Current time plan",
+            "$ref" : "../../../core/3.1.2/definitions.json#/integer"
           }
-        ]
+        }
       }
     }
   ]

data/schemas/tlc/1.0.10/alarms/A0009.json

@@ -1,3 +1,4 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Other error.\nUsed for other errors not covered by any other alarm type\nIs a \"minor fault\" defined according to 3.11 in EN12675."
 }

data/schemas/tlc/1.0.10/alarms/A0101.json

@@ -1,3 +1,4 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Pushbutton error.\nUsed for push buttons."
 }

data/schemas/tlc/1.0.10/alarms/A0201.json

@@ -1,59 +1,34 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Serious lamp error.\nUsed for lamp errors.\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.",
+  "properties" : {
+    "n" : {
+      "enum" : [
+        "color"
+      ]
+    }
+  },
   "allOf" : [
-    {
-      "properties" : {
-        "n" : {
-          "enum" : [
-            "color"
-          ]
-        }
-      }
-    },
     {
       "if" : {
-        "required" : [
-          "q"
-        ],
         "properties" : {
-          "q" : {
-            "enum" : [
-              "undefined",
-              "unknown"
-            ]
+          "n" : {
+            "const" : "color"
           }
         }
       },
       "then" : {
-      },
-      "else" : {
-        "allOf" : [
-          {
-            "if" : {
-              "required" : [
-                "n"
-              ],
-              "properties" : {
-                "n" : {
-                  "const" : "color"
-                }
-              }
-            },
-            "then" : {
-              "properties" : {
-                "v" : {
-                  "description" : "Color of lamp",
-                  "type" : "string",
-                  "enum" : [
-                    "green",
-                    "red",
-                    "yellow"
-                  ]
-                }
-              }
-            }
+        "properties" : {
+          "v" : {
+            "description" : "Color of lamp",
+            "type" : "string",
+            "enum" : [
+              "green",
+              "red",
+              "yellow"
+            ]
           }
-        ]
+        }
       }
     }
   ]

data/schemas/tlc/1.0.10/alarms/A0202.json

@@ -1,59 +1,34 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Less serious lamp error.\nUsed for lamp errors.\nIs a \"minor fault\" defined according to 3.11 in EN12675.",
+  "properties" : {
+    "n" : {
+      "enum" : [
+        "color"
+      ]
+    }
+  },
   "allOf" : [
-    {
-      "properties" : {
-        "n" : {
-          "enum" : [
-            "color"
-          ]
-        }
-      }
-    },
     {
       "if" : {
-        "required" : [
-          "q"
-        ],
         "properties" : {
-          "q" : {
-            "enum" : [
-              "undefined",
-              "unknown"
-            ]
+          "n" : {
+            "const" : "color"
           }
         }
       },
       "then" : {
-      },
-      "else" : {
-        "allOf" : [
-          {
-            "if" : {
-              "required" : [
-                "n"
-              ],
-              "properties" : {
-                "n" : {
-                  "const" : "color"
-                }
-              }
-            },
-            "then" : {
-              "properties" : {
-                "v" : {
-                  "description" : "Color of lamp",
-                  "type" : "string",
-                  "enum" : [
-                    "green",
-                    "red",
-                    "yellow"
-                  ]
-                }
-              }
-            }
+        "properties" : {
+          "v" : {
+            "description" : "Color of lamp",
+            "type" : "string",
+            "enum" : [
+              "green",
+              "red",
+              "yellow"
+            ]
           }
-        ]
+        }
       }
     }
   ]