rsmp 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 250eabe3e6427dd2032d46756055c93175383c5a32c5ca13d56a9b237bd9d033
-  data.tar.gz: 34d1ce845bbb2029b1bb00165d66c4e1181c8479ab99953b4d1687d51180d50c
+  metadata.gz: 4008335a554fe48c0d8b0fa808480add7107c083bfa3a5ef22fea6817dae2fe6
+  data.tar.gz: 3ea6c89c329fe4cff1a0f05466139a5da5e46609dfccb64a8b428a1d3039bb2a
 SHA512:
-  metadata.gz: a12e73c1c5a98c557cb733ce2ed1251ece7ade05763fb3f657846d12120413b020aa3a716b48d3c76aa4a913898732b0f87add636a790052390777d54308ed14
-  data.tar.gz: 449d24617bc74cafab1f314fba2297fcb17fcfba74743c69a2720ba9ca9297e3d61798be49d4303c0294b5215262382b8eb570d91f04e1318e570094739b7455
+  metadata.gz: 29f9a064d6bbc6589d113a7d31351fdfc65d0ea50b585769c2bbcb86a9920e0187d0e9afc589c250d7a83dada5b65aeaff9740f38377b268b9c3736773cdff76
+  data.tar.gz: 0e419993a2db66a8b815f896a0e121bc26fe25272263e34ee33bf716426f432ca2cbb5bde4e09a4705162e8be3d4ee3eaabf83729d67cfc0b5dc839281cb7dd8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.1.0)
+    rsmp (0.1.1)
       async (~> 1.23.0)
       async-io (~> 1.27.0)
       colorize (~> 0.8.1)

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/rsmp_schema/schema/core/aggregated_status.json

@@ -0,0 +1,25 @@
+{
+  "title" :  "Aggregated Status",
+  "description" :  "Aggregated status message",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "aSTS" : { "$ref": "definitions.json#/timestamp" },
+    "fP" : {
+      "description" : "Functional position",
+      "type" : "string, null"
+    },
+    "fS" : {
+      "description" : "Functional position",
+      "type" : "string, null"
+    },
+    "se" : {
+      "type" : "array",
+      "minItems": 8,
+      "maxItems": 8,
+      "items" : {
+        "type" : "boolean"
+      }
+    }
+  },
+  "required" : [ "mId", "aSTS", "fP", "fS", "se" ]
+}

data/lib/rsmp_schema/schema/core/alarm.json

@@ -0,0 +1,55 @@
+{
+  "title" :  "Alarm",
+  "description" :  "Alarm messsage",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "aCId" : { "$ref": "definitions.json#/alarm_code" },
+    "xACId" : { "description" : "External alarm code id", "type" : "string" },
+    "aSp" : {
+      "description" : "Alarm message variant",
+      "type" : "string",
+      "enum" : [ "Issue", "Acknowledge", "Suspend", "Resume" ]  
+    },
+    "ack" : {
+      "description" : "Acknowledgement",
+      "type" : "string",
+      "enum" : [ "Acknowledged", "notAcknowledged" ]  
+    },
+    "aS" : {
+      "description" : "Status",
+      "type" : "string",
+      "enum" : [ "inActive", "Active" ]  
+    },
+    "sS" : {
+      "description" : "Suspended",
+      "type" : "string",
+      "enum" : [ "suspended", "notSuspended" ]  
+    },
+    "aTs" : { "$ref": "definitions.json#/timestamp" },
+    "cat" : {
+      "description" : "Category",
+      "type" : "string",
+      "enum" : [ "T", "D" ]  
+    },
+    "pri" : {
+      "description" : "Priority",
+      "type" : "string",
+      "enum" : [ "1", "2", "3" ]  
+    },
+    "rvs" : {
+      "description" : "Return values",
+      "type" : "array",
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "v" : { "description" : "Value", "type" : "string" }
+        },
+        "required" : [ "n", "v" ],
+        "additionProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "aCId", "xACId", "aSp", "ack", "aS", "aTs", "sS", "cat", "pri", "rvs" ]
+}

data/lib/rsmp_schema/schema/core/command_request.json

@@ -0,0 +1,24 @@
+{
+  "title" :  "CommandRequest",
+  "description" :  "Command request",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "arg" : {
+      "description" : "Command arguments",
+      "type" : "array",
+      "minItems": 1,
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "cCI" : { "$ref": "definitions.json#/command_code" },
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "cO" : { "description" : "Command", "type" : "string" },
+          "v" : { "description" : "Value" }
+        },
+        "required" : [ "cCI", "n", "cO", "v" ]
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "arg"]
+}

data/lib/rsmp_schema/schema/core/command_response.json

@@ -0,0 +1,34 @@
+{
+  "title" :  "CommandRequest",
+  "description" :  "Command request",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "cTS" : { "$ref": "definitions.json#/timestamp" },
+    "rvs" : {
+      "description" : "Command arguments",
+      "type" : "array",
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "cCI" : { "$ref": "definitions.json#/command_code" },
+          "n" : {
+            "description" : "Unique reference of the value",
+            "type" : "string"
+          },
+          "v" : {
+            "description" : "Value"
+          },
+          "age" : {
+            "description" : "Age of the value",
+            "type" : "string",
+            "enum" : [ "recent", "old", "undefined", "unknown" ]
+          }
+        },
+        "required" : [ "cCI", "n", "v", "age" ],
+        "additionProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "cTS", "rvs" ]
+}

data/lib/rsmp_schema/schema/core/core.json

@@ -0,0 +1,35 @@
+{
+  "$schema" : "http://json-schema.org/draft-07/schema#",
+  "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",
+            "Watchdog",
+            "Alarm",
+            "CommandRequest",
+            "CommandResponse",
+            "StatusRequest",
+            "StatusResponse",
+            "StatusSubscribe",
+            "StatusUnsubscribe",
+            "StatusUpdate"
+          ]
+        }
+      },
+      "required" : [ "mType", "type" ]
+    }
+  ]
+}

data/lib/rsmp_schema/schema/core/definitions.json

@@ -0,0 +1,47 @@
+{
+  "message_id": {
+    "description" : "Message Id",
+    "type": "string",
+    "$comment" : "Example: 1.2.3 or 1.2",
+    "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",
+    "type": "string",
+    "$comment" : "Example: 2015-06-08T11:49:03.293Z",
+  	"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",
+    "type": "string",
+    "$comment" : "Example: 123",
+    "pattern": "^[0-9]+$"
+  },
+  "version": {
+    "description" : "Version",
+    "type": "string",
+    "$comment" : "Example: 1.2.3 or 1.2",
+    "pattern" : "^[0-9]{1,2}\\.[0-9]{1,2}(\\.[0-9]{1,2})?$"
+  },
+  "command_code": {
+    "description" : "Command code id",
+    "type" : "string",
+    "pattern" : "^M"
+  },
+  "status_code": {
+    "description" : "Status code id",
+    "type" : "string",
+    "pattern" : "^S"
+  },
+  "alarm_code": {
+    "description" : "Alarm code id",
+    "type" : "string",
+    "pattern" : "^A"
+  },  "component_id": {
+    "description" : "Compoment id",
+    "type" : "string"
+  }
+}
+
+
+

data/lib/rsmp_schema/schema/core/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/lib/rsmp_schema/schema/core/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/lib/rsmp_schema/schema/core/rsmp.json

@@ -0,0 +1,124 @@
+{
+  "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": "AggregatedStatus" } }
+      },
+      "then": {
+        "$ref": "aggregated_status.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/lib/rsmp_schema/schema/core/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/lib/rsmp_schema/schema/core/status_request.json

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

data/lib/rsmp_schema/schema/core/status_response.json

@@ -0,0 +1,30 @@
+{
+  "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", "type" : "string" },
+          "q" : {
+            "description" : "Value",
+            "type" : "string",
+            "enum" : [ "recent", "old", "undefined", "unknown" ]
+        }
+        },
+        "required" : [ "sCI", "n", "s", "q" ],
+        "additionProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "sTs", "sS" ]
+}

data/lib/rsmp_schema/schema/core/status_subscribe.json

@@ -0,0 +1,27 @@
+{
+  "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"
+          }
+        },
+        "required" : [ "sCI", "n", "uRt" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "sS"]
+}

data/lib/rsmp_schema/schema/core/status_unsubscribe.json

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

data/lib/rsmp_schema/schema/core/status_update.json

@@ -0,0 +1,30 @@
+{
+  "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", "type" : "string" },
+          "q" : {
+            "description" : "Value",
+            "type" : "string",
+            "enum" : [ "recent", "old", "undefined", "unknown" ]
+        }
+        },
+        "required" : [ "sCI", "n", "s", "q" ],
+        "additionProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "sTs", "sS" ]
+}

data/lib/rsmp_schema/schema/core/version.json

@@ -0,0 +1,47 @@
+{
+  "title" :  "Version",
+  "description" :  "Version message",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "RSMP" : {
+      "description" : "Supported RSMP versions",
+      "type" : "array",
+      "items" : {
+        "type" : "object",
+        "properties" : {
+          "vers" : {
+            "$ref": "definitions.json#/version",
+            "description" : "RSMP version"
+          }
+        },
+        "required" : ["vers"],
+        "additionalProperties" : false
+      },
+      "minItems" : 1,
+      "uniqueItems" : true
+    },
+    "SXL" : {
+      "$ref": "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", "RSMP", "SXL", "siteId" ]
+}

data/lib/rsmp_schema/schema/core/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/lib/rsmp_schema/schema/tlc/alarms/A0001.json

@@ -0,0 +1,7 @@
+{
+  "allOf" : [
+    {
+      "description": "Serious hardware error",
+    }
+  ]
+}

data/lib/rsmp_schema/schema/tlc/alarms/A0002.json

@@ -0,0 +1,7 @@
+{
+  "allOf" : [
+    {
+      "description": "Less serious hardware error",
+    }
+  ]
+}

data/lib/rsmp_schema/schema/tlc/alarms/A0003.json

@@ -0,0 +1,7 @@
+{
+  "allOf" : [
+    {
+      "description": "Serious configuration error",
+    }
+  ]
+}

data/lib/rsmp_schema/schema/tlc/alarms/A0004.json

@@ -0,0 +1,7 @@
+{
+  "allOf" : [
+    {
+      "description": "Less serious configuration error",
+    }
+  ]
+}

data/lib/rsmp_schema/schema/tlc/alarms/A0005.json

@@ -0,0 +1,7 @@
+{
+  "allOf" : [
+    {
+      "description": "Communication error between traffic controllers / synchronisation error",
+    }
+  ]
+}

data/lib/rsmp_schema/schema/tlc/alarms/A0006.json

@@ -0,0 +1,7 @@
+{
+  "allOf" : [
+    {
+      "description": "Safety error",
+    }
+  ]
+}

data/lib/rsmp_schema/schema/tlc/alarms/A0007.json

@@ -0,0 +1,7 @@
+{
+  "allOf" : [
+    {
+      "description": "Communication error between one or multiple traffic controllers and central control system",
+    }
+  ]
+}