rsmp 0.41.0 → 0.42.1

data/lib/rsmp/proxy/site/modules/status.rb

@@ -3,13 +3,17 @@ module RSMP
     module Modules
       # Handles status requests, responses, subscriptions and updates
       module Status
-        def request_status(component, status_list, options = {})
+        # Build and send a StatusRequest. Returns { sent: message }.
+        def request_status(status_list, component: nil, m_id: nil, validate: true)
           validate_ready 'request status'
-          m_id = options[:m_id] || RSMP::Message.make_m_id
+          component ||= main.c_id
+          m_id ||= RSMP::Message.make_m_id
+
+          list = RSMP::StatusList.new(status_list)
 
           # additional items can be used when verifying the response,
           # but must be removed from the request
-          request_list = status_list.map { |item| item.slice('sCI', 'n') }
+          request_list = list.map { |item| item.slice('sCI', 'n') }
 
           message = RSMP::StatusRequest.new({
                                               'cId' => component,
@@ -17,13 +21,31 @@ module RSMP
                                               'mId' => m_id
                                             })
           apply_nts_message_attributes message
-          send_and_optionally_collect message, options do |collect_options|
-            StatusCollector.new(
-              self,
-              status_list,
-              collect_options.merge(task: @task, m_id: m_id)
-            )
-          end
+          send_message message, validate: validate
+          { sent: message }
+        end
+
+        # Build, send a StatusRequest and collect the StatusResponse. Returns the collector.
+        # Call .ok! on the result to raise on NotAck or timeout.
+        def request_status_and_collect(status_list, within:, component: nil, m_id: nil, validate: true)
+          validate_ready 'request status'
+          component ||= main.c_id
+          m_id ||= RSMP::Message.make_m_id
+
+          list = RSMP::StatusList.new(status_list)
+
+          # additional items can be used when verifying the response,
+          # but must be removed from the request
+          request_list = list.map { |item| item.slice('sCI', 'n') }
+
+          message = RSMP::StatusRequest.new({
+                                              'cId' => component,
+                                              'sS' => request_list,
+                                              'mId' => m_id
+                                            })
+          apply_nts_message_attributes message
+          collector = StatusCollector.new(self, list.to_a, timeout: within, m_id: m_id)
+          send_message_and_collect(message, collector, validate: validate)[:collector]
         end
 
         def process_status_response(message)
@@ -49,28 +71,49 @@ module RSMP
           end
         end
 
-        def subscribe_to_status(component_id, status_list, options = {})
+        # Build and send a StatusSubscribe. Returns { sent: message }.
+        def subscribe_to_status(status_list, component: nil, m_id: nil, validate: true)
           validate_ready 'subscribe to status'
-          m_id = options[:m_id] || RSMP::Message.make_m_id
-          subscribe_list = status_list.map { |item| item.slice('sCI', 'n', 'uRt', 'sOc') }
+          component ||= main.c_id
+          m_id ||= RSMP::Message.make_m_id
 
-          update_subscription(component_id, subscribe_list)
-          find_component component_id
+          list = RSMP::StatusList.new(status_list)
+          subscribe_list = list.map { |item| item.slice('sCI', 'n', 'uRt', 'sOc') }
+
+          update_subscription(component, subscribe_list)
+          find_component component
 
           message = RSMP::StatusSubscribe.new({
-                                                'cId' => component_id,
+                                                'cId' => component,
                                                 'sS' => subscribe_list,
                                                 'mId' => m_id
                                               })
           apply_nts_message_attributes message
+          send_message message, validate: validate
+          { sent: message }
+        end
 
-          send_and_optionally_collect message, options do |collect_options|
-            StatusCollector.new(
-              self,
-              status_list,
-              collect_options.merge(task: @task, m_id: m_id)
-            )
-          end
+        # Build, send a StatusSubscribe and collect the first matching status update. Returns the collector.
+        # Call .ok! on the result to raise on NotAck or timeout.
+        def subscribe_to_status_and_collect(status_list, within:, component: nil, m_id: nil, validate: true)
+          validate_ready 'subscribe to status'
+          component ||= main.c_id
+          m_id ||= RSMP::Message.make_m_id
+
+          list = RSMP::StatusList.new(status_list)
+          subscribe_list = list.map { |item| item.slice('sCI', 'n', 'uRt', 'sOc') }
+
+          update_subscription(component, subscribe_list)
+          find_component component
+
+          message = RSMP::StatusSubscribe.new({
+                                                'cId' => component,
+                                                'sS' => subscribe_list,
+                                                'mId' => m_id
+                                              })
+          apply_nts_message_attributes message
+          collector = StatusCollector.new(self, list.to_a, timeout: within, m_id: m_id)
+          send_message_and_collect(message, collector, validate: validate)[:collector]
         end
 
         def remove_subscription_item(component_id, code, name)
@@ -81,29 +124,31 @@ module RSMP
           @status_subscriptions.delete(component_id) if @status_subscriptions[component_id].empty?
         end
 
-        def unsubscribe_to_status(component_id, status_list, options = {})
+        def unsubscribe_to_status(status_list, component: nil, validate: nil)
           validate_ready 'unsubscribe to status'
+          component ||= main.c_id
 
           status_list.each do |item|
-            remove_subscription_item(component_id, item['sCI'], item['n'])
+            remove_subscription_item(component, item['sCI'], item['n'])
           end
 
           message = RSMP::StatusUnsubscribe.new({
-                                                  'cId' => component_id,
+                                                  'cId' => component,
                                                   'sS' => status_list
                                                 })
           apply_nts_message_attributes message
-          send_message message, validate: options[:validate]
+          send_message message, validate: validate
           message
         end
 
         # unsubscribes to all statuses (with all attributes) defined in the used SXL
-        def unsubscribe_from_all(component_id)
+        def unsubscribe_from_all(component: nil)
+          component ||= main.c_id
           catalogue = RSMP::Schema.status_catalogue(@sxl, sxl_version)
           status_list = catalogue.flat_map do |status_code_id, names|
             names.map { |name| { 'sCI' => status_code_id.to_s, 'n' => name.to_s } }
           end
-          unsubscribe_to_status component_id, status_list
+          unsubscribe_to_status status_list, component: component
         end
 
         def process_status_update(message)

data/lib/rsmp/proxy/supervisor/modules/aggregated_status.rb

@@ -10,8 +10,8 @@ module RSMP
         end
 
         # Send aggregated status for a component
-        def send_aggregated_status(component, options = {})
-          m_id = options[:m_id] || RSMP::Message.make_m_id
+        def send_aggregated_status(component, m_id: nil)
+          m_id ||= RSMP::Message.make_m_id
 
           se = if Proxy.version_meets_requirement?(core_version, '<=3.1.2')
                  component.aggregated_status_bools.map { |bool| bool ? 'true' : 'false' }
@@ -29,9 +29,7 @@ module RSMP
                                                })
 
           apply_nts_message_attributes message
-          send_and_optionally_collect message, options do |collect_options|
-            Collector.new self, collect_options.merge(task: @task, type: 'MessageAck')
-          end
+          send_message message
         end
 
         def process_aggregated_status_request(message)

data/lib/rsmp/proxy/supervisor/modules/alarms.rb

@@ -3,12 +3,6 @@ module RSMP
     module Modules
       # Alarm handling
       module Alarms
-        def send_alarm(_component, alarm, options = {})
-          send_and_optionally_collect alarm, options do |collect_options|
-            Collector.new self, collect_options.merge(task: @task, type: 'MessageAck')
-          end
-        end
-
         def send_active_alarms
           @site.components.each_pair do |_c_id, component|
             component.alarms.each_pair do |_alarm_code, alarm_state|

data/lib/rsmp/status_list.rb

@@ -0,0 +1,44 @@
+module RSMP
+  # Represents an RSMP status list and converts between the two common formats:
+  #
+  # Compact Hash (symbol or string keys):
+  #   { S0014: [:status, :source] }
+  #   { 'S0014' => ['status', 'source'] }
+  #
+  # Raw wire Array (used in RSMP messages):
+  #   [{ 'sCI' => 'S0014', 'n' => 'status' }, { 'sCI' => 'S0014', 'n' => 'source' }]
+  class StatusList
+    include Enumerable
+
+    def initialize(input)
+      @list = case input
+              when StatusList
+                input.to_a
+              when Array
+                input
+              when Hash
+                input.flat_map do |code, names|
+                  names.map { |name| { 'sCI' => code.to_s, 'n' => name.to_s } }
+                end
+              else
+                raise ArgumentError, "StatusList requires an Array, Hash, or StatusList, got #{input.class}"
+              end
+    end
+
+    def each(&)
+      @list.each(&)
+    end
+
+    def to_a
+      @list
+    end
+
+    def to_h
+      @list.each_with_object({}) do |item, hash|
+        code = item['sCI']
+        name = item['n']
+        (hash[code] ||= []) << name
+      end
+    end
+  end
+end

data/lib/rsmp/tlc/modules/modes.rb

@@ -196,8 +196,8 @@ module RSMP
 
         # S0006 - Emergency route status (deprecated, use S0035)
         def handle_s0006(_status_code, status_name = nil, options = {})
-          if Proxy.version_meets_requirement? options[:sxl_version],
-                                              '>=1.2.0'
+          if RSMP::Proxy.version_meets_requirement? options[:sxl_version],
+                                                    '>=1.2.0'
             log 'S0006 is depreciated, use S0035 instead.',
                 level: :warning
           end

data/lib/rsmp/tlc/modules/system.rb

@@ -63,22 +63,36 @@ module RSMP
         end
 
         # S0091 - Operator logged in/out OP-panel
-        def handle_s0091(_status_code, status_name = nil, _options = {})
-          case status_name
-          when 'user'
-            TrafficControllerSite.make_status 0
-          when 'username'
-            TrafficControllerSite.make_status ''
+        def handle_s0091(_status_code, status_name = nil, options = {})
+          if RSMP::Proxy.version_meets_requirement?(options[:sxl_version], '>=1.1')
+            case status_name
+            when 'user'
+              TrafficControllerSite.make_status 0
+            end
+          else
+            case status_name
+            when 'user'
+              TrafficControllerSite.make_status 'nobody'
+            when 'status'
+              TrafficControllerSite.make_status 'logout'
+            end
           end
         end
 
         # S0092 - Operator logged in/out web-interface
-        def handle_s0092(_status_code, status_name = nil, _options = {})
-          case status_name
-          when 'user'
-            TrafficControllerSite.make_status 0
-          when 'username'
-            TrafficControllerSite.make_status ''
+        def handle_s0092(_status_code, status_name = nil, options = {})
+          if RSMP::Proxy.version_meets_requirement?(options[:sxl_version], '>=1.1')
+            case status_name
+            when 'user'
+              TrafficControllerSite.make_status 0
+            end
+          else
+            case status_name
+            when 'user'
+              TrafficControllerSite.make_status 'nobody'
+            when 'status'
+              TrafficControllerSite.make_status 'logout'
+            end
           end
         end
 

data/lib/rsmp/tlc/proxy/control.rb

@@ -5,17 +5,20 @@ module RSMP
       # Covers functional position, emergency routes, I/O modes, signal group orders, and system settings.
       module Control
         # M0001 — Set functional position (NormalControl, YellowFlash, Dark).
-        def set_functional_position(status, timeout_minutes: 0, options: {})
+        def set_functional_position(status, within:, timeout_minutes: 0)
           validate_ready 'set functional position'
           raise 'TLC main component not found' unless main
 
           command_list = functional_position_command_list(status, timeout_minutes)
           confirm_status = functional_position_confirm_status(status)
-          send_command_with_confirm main.c_id, command_list, options, "functional position #{status}", confirm_status
+          collector = send_command_and_collect(command_list, within: within)
+          collector.ok!
+          wait_for_status "functional position #{status}", confirm_status, timeout: within unless confirm_status.empty?
+          { collector: collector }
         end
 
         # M0005 — Set or clear an emergency route.
-        def set_emergency_route(route:, active:, options: {})
+        def set_emergency_route(route:, active:, within:)
           validate_ready 'set emergency route'
           raise 'TLC main component not found' unless main
 
@@ -39,13 +42,11 @@ module RSMP
             'v' => route.to_s
           }]
 
-          confirm_status = [{ 'sCI' => 'S0006', 'n' => 'status', 's' => active_str }]
-          send_command_with_confirm main.c_id, command_list, options,
-                                    "emergency route #{route} #{active ? 'active' : 'inactive'}", confirm_status
+          send_command_and_collect(command_list, within: within).ok!
         end
 
         # M0007 — Enable or disable fixed-time control.
-        def set_fixed_time(status, options: {})
+        def set_fixed_time(status, within:)
           validate_ready 'set fixed time'
           raise 'TLC main component not found' unless main
 
@@ -65,11 +66,12 @@ module RSMP
 
           confirm_status = [{ 'sCI' => 'S0009', 'n' => 'status',
                               's' => /^#{Regexp.escape(status.to_s)}(,#{Regexp.escape(status.to_s)})*$/ }]
-          send_command_with_confirm main.c_id, command_list, options, "fixed time #{status}", confirm_status
+          send_command_and_collect(command_list, within: within).ok!
+          wait_for_status "fixed time #{status}", confirm_status, timeout: within
         end
 
         # M0003 — Set traffic situation (activate a specific situation number).
-        def set_traffic_situation(situation, options: {})
+        def set_traffic_situation(situation, within:)
           validate_ready 'set traffic situation'
           raise 'TLC main component not found' unless main
 
@@ -93,11 +95,12 @@ module RSMP
           }]
 
           confirm_status = [{ 'sCI' => 'S0015', 'n' => 'status', 's' => situation.to_s }]
-          send_command_with_confirm main.c_id, command_list, options, "traffic situation #{situation}", confirm_status
+          send_command_and_collect(command_list, within: within).ok!
+          wait_for_status "traffic situation #{situation}", confirm_status, timeout: within
         end
 
         # M0003 — Clear the active traffic situation.
-        def unset_traffic_situation(options: {})
+        def unset_traffic_situation(within:)
           validate_ready 'unset traffic situation'
           raise 'TLC main component not found' unless main
 
@@ -121,7 +124,8 @@ module RSMP
           }]
 
           confirm_status = [{ 'sCI' => 'S0015', 'n' => 'status', 's' => '1' }]
-          send_command_with_confirm main.c_id, command_list, options, 'traffic situation unset', confirm_status
+          send_command_and_collect(command_list, within: within).ok!
+          wait_for_status 'traffic situation unset', confirm_status, timeout: within
         end
 
         private

data/lib/rsmp/tlc/proxy/detectors.rb

@@ -6,7 +6,7 @@ module RSMP
       module Detectors
         # M0008 — Force detector logic to a given mode and status.
         # component_id must refer to the detector logic component, not main.
-        def force_detector_logic(component_id, status:, mode:, options: {})
+        def force_detector_logic(component_id, status:, mode:, within:)
           validate_ready 'force detector logic'
 
           security_code = security_code_for(2)
@@ -27,12 +27,11 @@ module RSMP
             'n' => 'mode',
             'v' => mode.to_s
           }]
-
-          send_command_with_confirm component_id, command_list, options, "force detector logic #{component_id}", nil
+          send_command_and_collect(command_list, component: component_id, within: within).ok!
         end
 
         # M0021 — Set the trigger level for traffic counting.
-        def set_trigger_level(status, options: {})
+        def set_trigger_level(status, within:)
           validate_ready 'set trigger level'
           raise 'TLC main component not found' unless main
 
@@ -49,8 +48,7 @@ module RSMP
             'n' => 'securityCode',
             'v' => security_code.to_s
           }]
-
-          send_command_with_confirm main.c_id, command_list, options, "trigger level #{status}", nil
+          send_command_and_collect(command_list, within: within).ok!
         end
       end
     end

data/lib/rsmp/tlc/proxy/io.rb

@@ -5,7 +5,7 @@ module RSMP
       # Covers detector logic, input/output forcing and setting.
       module IO
         # M0006 — Set a single input to a given status.
-        def set_input(input:, status:, options: {})
+        def set_input(input:, status:, within:)
           validate_ready 'set input'
           raise 'TLC main component not found' unless main
 
@@ -27,12 +27,11 @@ module RSMP
             'n' => 'input',
             'v' => input.to_s
           }]
-
-          send_command_with_confirm main.c_id, command_list, options, "input #{input} set to #{status}", nil
+          send_command_and_collect(command_list, within: within).ok!
         end
 
         # M0013 — Set all inputs via a bit-pattern string.
-        def set_inputs(status, options: {})
+        def set_inputs(status, within:)
           validate_ready 'set inputs'
           raise 'TLC main component not found' unless main
 
@@ -40,31 +39,31 @@ module RSMP
 
           command_list = [{
             'cCI' => 'M0013',
-            'cO' => 'setInputs',
+            'cO' => 'setInput',
             'n' => 'status',
             'v' => status.to_s
           }, {
             'cCI' => 'M0013',
-            'cO' => 'setInputs',
+            'cO' => 'setInput',
             'n' => 'securityCode',
             'v' => security_code.to_s
           }]
-
-          send_command_with_confirm main.c_id, command_list, options, "inputs #{status}", nil
+          send_command_and_collect(command_list, within: within).ok!
         end
 
         # M0019 — Force an input to a given value.
-        def force_input(input:, status:, value:, options: {})
+        def force_input(input:, status:, value:, within:)
           validate_ready 'force input'
           raise 'TLC main component not found' unless main
 
           command_list = force_input_command_list(input, status, value)
           confirm_status = force_input_confirm_status(input, status, value)
-          send_command_with_confirm main.c_id, command_list, options, "force input #{input}", confirm_status
+          send_command_and_collect(command_list, within: within).ok!
+          wait_for_status "force input #{input}", confirm_status, timeout: within
         end
 
         # M0020 — Force an output to a given value.
-        def force_output(output:, status:, value:, options: {})
+        def force_output(output:, status:, value:, within:)
           validate_ready 'force output'
           raise 'TLC main component not found' unless main
 
@@ -91,8 +90,7 @@ module RSMP
             'n' => 'outputValue',
             'v' => value.to_s
           }]
-
-          send_command_with_confirm main.c_id, command_list, options, "force output #{output}", nil
+          send_command_and_collect(command_list, within: within).ok!
         end
 
         private
@@ -108,10 +106,14 @@ module RSMP
         end
 
         def force_input_confirm_status(input, status, value)
-          [
-            { 'sCI' => 'S0029', 'n' => 'status', 's' => /^.{#{input.to_i - 1}}#{status == 'True' ? '1' : '0'}/ },
-            { 'sCI' => 'S0003', 'n' => 'inputstatus', 's' => /^.{#{input.to_i - 1}}#{value == 'True' ? '1' : '0'}/ }
+          result = [
+            { 'sCI' => 'S0029', 'n' => 'status', 's' => /^.{#{input.to_i - 1}}#{status == 'True' ? '1' : '0'}/ }
           ]
+          if status == 'True'
+            result << { 'sCI' => 'S0003', 'n' => 'inputstatus',
+                        's' => /^.{#{input.to_i - 1}}#{value == 'True' ? '1' : '0'}/ }
+          end
+          result
         end
       end
     end

data/lib/rsmp/tlc/proxy/plans.rb

@@ -5,7 +5,7 @@ module RSMP
       # Covers time plans, week/day tables, bands, offsets, and cycle times.
       module Plans
         # M0014 — Set dynamic bands for a signal plan.
-        def set_dynamic_bands(plan:, status:, options: {})
+        def set_dynamic_bands(plan:, status:, within:)
           validate_ready 'set dynamic bands'
           raise 'TLC main component not found' unless main
 
@@ -27,12 +27,11 @@ module RSMP
             'n' => 'plan',
             'v' => plan.to_s
           }]
-
-          send_command_with_confirm main.c_id, command_list, options, "dynamic bands plan #{plan}", nil
+          send_command_and_collect(command_list, within: within).ok!
         end
 
         # M0023 — Set timeout for dynamic bands.
-        def set_dynamic_bands_timeout(status, options: {})
+        def set_dynamic_bands_timeout(status, within:)
           validate_ready 'set dynamic bands timeout'
           raise 'TLC main component not found' unless main
 
@@ -49,12 +48,11 @@ module RSMP
             'n' => 'securityCode',
             'v' => security_code.to_s
           }]
-
-          send_command_with_confirm main.c_id, command_list, options, "dynamic bands timeout #{status}", nil
+          send_command_and_collect(command_list, within: within).ok!
         end
 
         # M0015 — Set offset for a signal plan.
-        def set_offset(plan:, offset:, options: {})
+        def set_offset(plan:, offset:, within:)
           validate_ready 'set offset'
           raise 'TLC main component not found' unless main
 
@@ -76,12 +74,11 @@ module RSMP
             'n' => 'plan',
             'v' => plan.to_s
           }]
-
-          send_command_with_confirm main.c_id, command_list, options, "offset plan #{plan} to #{offset}", nil
+          send_command_and_collect(command_list, within: within).ok!
         end
 
         # Set the timeplan (signal plan) on the remote TLC.
-        def set_timeplan(plan_nr, options: {})
+        def set_timeplan(plan_nr, within:)
           validate_ready 'set timeplan'
           raise 'TLC main component not found' unless main
 
@@ -103,13 +100,13 @@ module RSMP
             'n' => 'timeplan',
             'v' => plan_nr.to_s
           }]
-
           confirm_status = [{ 'sCI' => 'S0014', 'n' => 'status', 's' => plan_nr.to_s }]
-          send_command_with_confirm main.c_id, command_list, options, "timeplan #{plan_nr}", confirm_status
+          send_command_and_collect(command_list, within: within).ok!
+          wait_for_status("timeplan #{plan_nr}", confirm_status, timeout: within)
         end
 
         # M0016 — Set week table (mapping week days to traffic situations).
-        def set_week_table(status, options: {})
+        def set_week_table(status, within:)
           validate_ready 'set week table'
           raise 'TLC main component not found' unless main
 
@@ -126,12 +123,11 @@ module RSMP
             'n' => 'securityCode',
             'v' => security_code.to_s
           }]
-
-          send_command_with_confirm main.c_id, command_list, options, 'week table', nil
+          send_command_and_collect(command_list, within:).ok!
         end
 
         # M0017 — Set day table (mapping time periods to signal plans).
-        def set_day_table(status, options: {})
+        def set_day_table(status, within:)
           validate_ready 'set day table'
           raise 'TLC main component not found' unless main
 
@@ -139,21 +135,20 @@ module RSMP
 
           command_list = [{
             'cCI' => 'M0017',
-            'cO' => 'setDayTable',
+            'cO' => 'setTimeTable',
             'n' => 'status',
             'v' => status.to_s
           }, {
             'cCI' => 'M0017',
-            'cO' => 'setDayTable',
+            'cO' => 'setTimeTable',
             'n' => 'securityCode',
             'v' => security_code.to_s
           }]
-
-          send_command_with_confirm main.c_id, command_list, options, 'day table', nil
+          send_command_and_collect(command_list, within:).ok!
         end
 
         # M0018 — Set cycle time for a signal plan.
-        def set_cycle_time(plan:, cycle_time:, options: {})
+        def set_cycle_time(plan:, cycle_time:, within:)
           validate_ready 'set cycle time'
           raise 'TLC main component not found' unless main
 
@@ -175,12 +170,11 @@ module RSMP
             'n' => 'plan',
             'v' => plan.to_s
           }]
-
-          send_command_with_confirm main.c_id, command_list, options, "cycle time plan #{plan} to #{cycle_time}", nil
+          send_command_and_collect(command_list, within:).ok!
         end
 
         # M0010 — Order signal start for a signal group component.
-        def order_signal_start(component_id, options: {})
+        def order_signal_start(component_id, within:)
           validate_ready 'order signal start'
 
           security_code = security_code_for(2)
@@ -196,12 +190,11 @@ module RSMP
             'n' => 'securityCode',
             'v' => security_code.to_s
           }]
-
-          send_command_with_confirm component_id, command_list, options, "signal start #{component_id}", nil
+          send_command_and_collect(command_list, component: component_id, within:).ok!
         end
 
         # M0011 — Order signal stop for a signal group component.
-        def order_signal_stop(component_id, options: {})
+        def order_signal_stop(component_id, within:)
           validate_ready 'order signal stop'
 
           security_code = security_code_for(2)
@@ -217,8 +210,7 @@ module RSMP
             'n' => 'securityCode',
             'v' => security_code.to_s
           }]
-
-          send_command_with_confirm component_id, command_list, options, "signal stop #{component_id}", nil
+          send_command_and_collect(command_list, component: component_id, within:).ok!
         end
       end
     end