rsmp 0.43.2 → 0.45.0

data/lib/rsmp/tlc/{traffic_controller_proxy.rb → supervisor_interface.rb}

@@ -1,11 +1,8 @@
-# Proxy for handling communication with a remote Traffic Light Controller (TLC).
-# Provides high-level methods for interacting with TLC functionality.
-# Acts as a mirror of the remote TLC by automatically subscribing to status updates.
-
 module RSMP
+  # Traffic Light Controller SXL support.
   module TLC
-    # Proxy for handling communication with a remote traffic light controller.
-    class TrafficControllerProxy < SiteProxy
+    # Supervisor-side TLC SXL interface.
+    class SupervisorInterface < RSMP::SXL::SupervisorInterface
       include Proxy::Control
       include Proxy::IO
       include Proxy::Plans
@@ -16,16 +13,7 @@ module RSMP
       attr_reader :timeplan_source, :timeplan, :timeouts,
                   :functional_position, :yellow_flash, :traffic_situation
 
-      # Backwards-compatible accessors expected by tests and callers
-      def current_plan
-        @timeplan
-      end
-
-      def plan_source
-        @timeplan_source
-      end
-
-      def initialize(options)
+      def initialize(...)
         super
         @timeplan_source = nil
         @timeplan = nil
@@ -35,6 +23,14 @@ module RSMP
         @timeouts = node.supervisor_settings.dig('default', 'timeouts') || {}
       end
 
+      def current_plan
+        @timeplan
+      end
+
+      def plan_source
+        @timeplan_source
+      end
+
       def subscribe_to_timeplan
         validate_ready 'subscribe to timeplan'
 
@@ -49,32 +45,23 @@ module RSMP
         subscribe_to_status status_list, component: main.c_id
       end
 
-      # Override status update processing to automatically store cached status values.
       def process_status_update(message)
-        super
-
         status_values = message.attribute('sS')
         return unless status_values
 
         status_values.each { |item| cache_status_item(item) }
       end
 
-      # Get all timeplan attributes stored in the main ComponentProxy.
-      def timeplan_attributes
-        main&.statuses&.dig('S0014') || {}
+      def process_message(message)
+        process_status_update message if message.is_a?(RSMP::StatusUpdate)
       end
 
-      # Returns true if sOc (send on change) should be used.
-      # sOc is supported in RSMP core version 3.1.5 and later.
-      def use_soc?
-        return false unless core_version
-
-        RSMP::Proxy.version_meets_requirement?(core_version, '>=3.1.5')
+      def timeplan_attributes
+        main&.statuses&.dig('S0014') || {}
       end
 
       private
 
-      # Automatically subscribe to key TLC statuses to keep proxy in sync.
       def auto_subscribe_to_statuses
         return unless main
 
@@ -82,17 +69,14 @@ module RSMP
         subscribe_to_key_statuses
       end
 
-      # Look up security code for a given level from site settings.
-      # Expects @site_settings['security_codes'] = { 1 => 'code1', 2 => 'code2' }
       def security_code_for(level)
-        codes = @site_settings&.dig('security_codes') || {}
+        codes = proxy.site_settings&.dig('security_codes') || {}
         code = codes[level] || codes[level.to_s]
         raise ArgumentError, "Security code for level #{level} is not configured" unless code
 
         code
       end
 
-      # Process a single status item and update the corresponding cached value.
       def cache_status_item(item)
         case item['sCI']
         when 'S0007' then @functional_position = item['s'] if item['n'] == 'status'
@@ -102,7 +86,6 @@ module RSMP
         end
       end
 
-      # Update cached values for S0014 (timeplan) status attributes.
       def cache_s0014_attribute(item)
         case item['n']
         when 'status' then @timeplan = item['s'].to_i
@@ -110,5 +93,7 @@ module RSMP
         end
       end
     end
+
+    RSMP::SXL::Registry.register_interface SupervisorInterface
   end
 end

data/lib/rsmp/tlc/traffic_controller.rb

@@ -20,8 +20,16 @@ module RSMP
       attr_reader :pos, :cycle_time, :plan, :cycle_counter,
                   :functional_position, :startup_sequence
 
-      def initialize(node:, id:, ntsoid: nil, xnid: nil, **options)
-        super(node: node, id: id, ntsoid: ntsoid, xnid: xnid, grouped: true)
+      def initialize(node:, id:, **options)
+        super(
+          node: node,
+          id: id,
+          type: options[:type],
+          name: options[:name],
+          ntsoid: options[:ntsoid],
+          xnid: options[:xnid],
+          grouped: true
+        )
         @signal_groups = []
         @detector_logics = []
         @plans = options[:signal_plans]

data/lib/rsmp/tlc/traffic_controller_site.rb

@@ -63,6 +63,8 @@ module RSMP
         when 'main'
           TrafficController.new node: self,
                                 id: id,
+                                type: type,
+                                name: settings['name'],
                                 ntsoid: settings['ntsOId'],
                                 xnid: settings['xNId'],
                                 startup_sequence: @startup_sequence,
@@ -70,11 +72,11 @@ module RSMP
                                 live_output: @site_settings['live_output'],
                                 inputs: @site_settings['inputs']
         when 'signal_group'
-          group = SignalGroup.new node: self, id: id
+          group = SignalGroup.new node: self, id: id, type: type, name: settings['name']
           main.add_signal_group group
           group
         when 'detector_logic'
-          logic = DetectorLogic.new node: self, id: id
+          logic = DetectorLogic.new node: self, id: id, type: type, name: settings['name']
           main.add_detector_logic logic
           logic
         end

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.0'.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" ]
+    }
+  ]
+}