rsmp 0.43.2 → 0.45.1

data/lib/rsmp/tlc.rb

@@ -0,0 +1,10 @@
+module RSMP
+  # Traffic Light Controller SXL support.
+  module TLC
+    SXL_NAME = 'tlc'.freeze
+
+    def self.sxl_name
+      SXL_NAME
+    end
+  end
+end

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = '0.43.2'.freeze
+  VERSION = '0.45.1'.freeze
 end

data/lib/rsmp.rb

@@ -69,6 +69,10 @@ require_relative 'rsmp/proxy/modules/receive'
 require_relative 'rsmp/proxy/modules/versions'
 require_relative 'rsmp/proxy/modules/tasks'
 require_relative 'rsmp/proxy/proxy'
+require_relative 'rsmp/sxl/interface'
+require_relative 'rsmp/sxl/supervisor_interface'
+require_relative 'rsmp/sxl/site_interface'
+require_relative 'rsmp/sxl/registry'
 require_relative 'rsmp/proxy/supervisor/modules/status'
 require_relative 'rsmp/proxy/supervisor/modules/commands'
 require_relative 'rsmp/proxy/supervisor/modules/alarms'
@@ -78,7 +82,9 @@ require_relative 'rsmp/proxy/site/modules/status'
 require_relative 'rsmp/proxy/site/modules/aggregated_status'
 require_relative 'rsmp/proxy/site/modules/alarms'
 require_relative 'rsmp/proxy/site/modules/commands'
+require_relative 'rsmp/proxy/site/sxl_selection'
 require_relative 'rsmp/proxy/site/site_proxy'
+require_relative 'rsmp/tlc'
 require_relative 'rsmp/tlc/modules/system'
 require_relative 'rsmp/tlc/modules/modes'
 require_relative 'rsmp/tlc/modules/plans'
@@ -98,7 +104,8 @@ require_relative 'rsmp/tlc/proxy/io'
 require_relative 'rsmp/tlc/proxy/plans'
 require_relative 'rsmp/tlc/proxy/status'
 require_relative 'rsmp/tlc/proxy/system'
-require_relative 'rsmp/tlc/traffic_controller_proxy'
+require_relative 'rsmp/tlc/supervisor_interface'
+require_relative 'rsmp/tlc/site_interface'
 require_relative 'rsmp/tlc/traffic_controller'
 require_relative 'rsmp/tlc/detector_logic'
 

data/rsmp.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Easy RSMP site and supervisor communication.'
   spec.homepage      = 'https://github.com/rsmp-nordic/rsmp'
   spec.licenses      = ['MIT']
-  spec.required_ruby_version = '>= 3.4.0'
+  spec.required_ruby_version = '>= 3.4'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/rsmp-nordic/rsmp'
@@ -31,12 +31,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'async', '~> 2.32'
+  spec.add_dependency 'async', '~> 2.39'
   spec.add_dependency 'colorize', '~> 1.1'
-  spec.add_dependency 'io-endpoint', '~> 0.15'
-  spec.add_dependency 'io-stream', '~> 0.10'
+  spec.add_dependency 'io-endpoint', '~> 0.17'
+  spec.add_dependency 'io-stream', '~> 0.13'
   spec.add_dependency 'json_schemer', '~> 2.5'
-  spec.add_dependency 'logger', '~> 1.6'
+  spec.add_dependency 'logger', '~> 1.7'
   spec.add_dependency 'ostruct', '~> 0.6'
   spec.add_dependency 'thor', '~> 1.5'
 end

data/schemas/core/3.3.0/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/schemas/core/3.3.0/aggregated_status_request.json

@@ -0,0 +1,9 @@
+{
+  "title" :  "Aggregated Status Request",
+  "description" :  "Aggregated status request message",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" }
+  },
+  "required" : [ "mId", "cId" ]
+}

data/schemas/core/3.3.0/alarm.json

@@ -0,0 +1,71 @@
+{
+  "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 specialization",
+      "type" : "string",
+      "enum" : [ "Issue", "Acknowledge", "Suspend", "Resume", "Request" ]
+    }
+  },
+  "required" : [ "aSp"],
+  "allOf" : [
+    {
+      "if": {
+        "required" : [ "aSp" ],
+        "properties" : {
+          "aSp" : { "enum" : [ "Issue"] }
+        }
+      },
+      "then": { "$ref": "alarm_issue.json" }
+    },
+    {
+      "if": {
+        "allOf" : [
+          {
+            "required" : [ "aSp" ],
+            "properties" : {
+              "aSp" : { "enum" : [ "Suspend", "Resume"] }
+            }
+          },
+          {
+            "not": { "required" : [ "sS" ] }
+          }
+        ]
+      },
+      "then": { "$ref": "alarm_suspend_resume.json" }
+    },
+    {
+      "if": {
+        "required" : [ "aSp", "sS" ],
+        "properties" : {
+          "aSp" : { "enum" : [ "Suspend", "Resume"] },
+          "sS" : { "enum" : [ "Suspended", "notSuspended"] }
+        }
+      },
+      "then": { "$ref": "alarm_suspended_resumed.json" }
+    },
+    {
+      "if": {
+        "required" : [ "aSp" ],
+        "properties" : {
+          "aSp" : { "enum" : [ "Request"] }
+        }
+      },
+      "then": { "$ref": "alarm_request.json" }
+    },
+    {
+      "if": {
+        "required" : [ "aSp" ],
+        "properties" : {
+          "aSp" : { "enum" : [ "Acknowledge"] }
+        }
+      },
+      "then": { "$ref": "alarm_acknowledge.json" }
+    }
+   ]
+}

data/schemas/core/3.3.0/alarm_acknowledge.json

@@ -0,0 +1,11 @@
+{
+  "properties" : {
+    "ack" : {
+      "description" : "Acknowledgement",
+      "type" : "string",
+      "enum" : [ "Acknowledged", "notAcknowledged" ]
+    },
+    "aTs" : { "$ref": "definitions.json#/timestamp" }
+  },
+  "required" : [ "mId", "cId", "aCId", "xACId", "aSp", "aTs" ]
+}

data/schemas/core/3.3.0/alarm_issue.json

@@ -0,0 +1,44 @@
+{
+  "properties" : {
+    "ack" : {
+      "description" : "Acknowledgement",
+      "type" : "string",
+      "enum" : [ "Acknowledged", "notAcknowledged" ]
+    },
+    "aS" : {
+      "description" : "Active status",
+      "type" : "string",
+      "enum" : [ "inActive", "Active" ]
+    },
+    "sS" : {
+      "description" : "Suspend status",
+      "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" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "aCId", "xACId", "aSp", "ack", "aS", "aTs", "sS", "cat", "pri", "rvs" ]
+}

data/schemas/core/3.3.0/alarm_request.json

@@ -0,0 +1,3 @@
+{
+  "required" : [ "mId", "cId", "aCId", "xACId", "aSp" ]
+}

data/schemas/core/3.3.0/alarm_suspend_resume.json

@@ -0,0 +1,3 @@
+{
+  "required" : [ "mId", "cId", "aCId", "xACId", "aSp" ]
+}

data/schemas/core/3.3.0/alarm_suspended_resumed.json

@@ -0,0 +1,44 @@
+{
+  "properties" : {
+    "ack" : {
+      "description" : "Acknowledgement",
+      "type" : "string",
+      "enum" : [ "Acknowledged", "notAcknowledged" ]
+    },
+    "aS" : {
+      "description" : "Active status",
+      "type" : "string",
+      "enum" : [ "inActive", "Active" ]
+    },
+    "sS" : {
+      "description" : "Suspend status",
+      "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" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "aCId", "xACId", "aSp", "ack", "aS", "aTs", "sS", "cat", "pri", "rvs" ]
+}

data/schemas/core/3.3.0/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/schemas/core/3.3.0/command_response.json

@@ -0,0 +1,35 @@
+{
+  "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",
+      "minItems" : 1,
+      "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" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "cTS", "rvs" ]
+}

data/schemas/core/3.3.0/component_list.json

@@ -0,0 +1,24 @@
+{
+  "title" :  "ComponentList",
+  "description" :  "Component list message",
+  "properties" : {
+    "mId" : { "$ref": "definitions.json#/message_id" },
+    "components" : {
+      "description" : "Components on the site",
+      "type" : "array",
+      "minItems" : 1,
+      "items" : {
+        "type" : "object",
+        "properties" : {
+          "id" : { "$ref": "definitions.json#/component_id" },
+          "type" : { "$ref": "definitions.json#/component_type" },
+          "name" : { "$ref": "definitions.json#/component_name" }
+        },
+        "required" : [ "id", "type", "name" ],
+        "additionalProperties" : false
+      },
+      "uniqueItems" : true
+    }
+  },
+  "required" : [ "mId", "components" ]
+}

data/schemas/core/3.3.0/core.json

@@ -0,0 +1,40 @@
+{
+  "$schema" : "https://json-schema.org/draft/2020-12/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",
+            "ComponentList",
+            "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,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" ]
+}