rsmp 0.40.0 → 0.41.0

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

@@ -0,0 +1,58 @@
+module RSMP
+  module TLC
+    module Proxy
+      # Command methods for operational control of a remote TLC.
+      # Covers functional position, emergency routes, I/O modes, signal group orders, and system settings.
+      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: {})
+          validate_ready 'force detector logic'
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0008',
+            'cO' => 'setForceDetectorLogic',
+            'n' => 'status',
+            'v' => status.to_s
+          }, {
+            'cCI' => 'M0008',
+            'cO' => 'setForceDetectorLogic',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }, {
+            'cCI' => 'M0008',
+            'cO' => 'setForceDetectorLogic',
+            'n' => 'mode',
+            'v' => mode.to_s
+          }]
+
+          send_command_with_confirm component_id, command_list, options, "force detector logic #{component_id}", nil
+        end
+
+        # M0021 — Set the trigger level for traffic counting.
+        def set_trigger_level(status, options: {})
+          validate_ready 'set trigger level'
+          raise 'TLC main component not found' unless main
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0021',
+            'cO' => 'setLevel',
+            'n' => 'status',
+            'v' => status.to_s
+          }, {
+            'cCI' => 'M0021',
+            'cO' => 'setLevel',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }]
+
+          send_command_with_confirm main.c_id, command_list, options, "trigger level #{status}", nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+module RSMP
+  module TLC
+    module Proxy
+      # Command methods for I/O control of a remote TLC.
+      # 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: {})
+          validate_ready 'set input'
+          raise 'TLC main component not found' unless main
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0006',
+            'cO' => 'setInput',
+            'n' => 'status',
+            'v' => status.to_s
+          }, {
+            'cCI' => 'M0006',
+            'cO' => 'setInput',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }, {
+            'cCI' => 'M0006',
+            'cO' => 'setInput',
+            'n' => 'input',
+            'v' => input.to_s
+          }]
+
+          send_command_with_confirm main.c_id, command_list, options, "input #{input} set to #{status}", nil
+        end
+
+        # M0013 — Set all inputs via a bit-pattern string.
+        def set_inputs(status, options: {})
+          validate_ready 'set inputs'
+          raise 'TLC main component not found' unless main
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0013',
+            'cO' => 'setInputs',
+            'n' => 'status',
+            'v' => status.to_s
+          }, {
+            'cCI' => 'M0013',
+            'cO' => 'setInputs',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }]
+
+          send_command_with_confirm main.c_id, command_list, options, "inputs #{status}", nil
+        end
+
+        # M0019 — Force an input to a given value.
+        def force_input(input:, status:, value:, options: {})
+          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
+        end
+
+        # M0020 — Force an output to a given value.
+        def force_output(output:, status:, value:, options: {})
+          validate_ready 'force output'
+          raise 'TLC main component not found' unless main
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0020',
+            'cO' => 'setOutput',
+            'n' => 'status',
+            'v' => status.to_s
+          }, {
+            'cCI' => 'M0020',
+            'cO' => 'setOutput',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }, {
+            'cCI' => 'M0020',
+            'cO' => 'setOutput',
+            'n' => 'output',
+            'v' => output.to_s
+          }, {
+            'cCI' => 'M0020',
+            'cO' => 'setOutput',
+            'n' => 'outputValue',
+            'v' => value.to_s
+          }]
+
+          send_command_with_confirm main.c_id, command_list, options, "force output #{output}", nil
+        end
+
+        private
+
+        def force_input_command_list(input, status, value)
+          security_code = security_code_for(2)
+          [
+            { 'cCI' => 'M0019', 'cO' => 'setInput', 'n' => 'status', 'v' => status.to_s },
+            { 'cCI' => 'M0019', 'cO' => 'setInput', 'n' => 'securityCode', 'v' => security_code.to_s },
+            { 'cCI' => 'M0019', 'cO' => 'setInput', 'n' => 'input', 'v' => input.to_s },
+            { 'cCI' => 'M0019', 'cO' => 'setInput', 'n' => 'inputValue', 'v' => value.to_s }
+          ]
+        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'}/ }
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,226 @@
+module RSMP
+  module TLC
+    module Proxy
+      # Command methods for signal plans.
+      # 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: {})
+          validate_ready 'set dynamic bands'
+          raise 'TLC main component not found' unless main
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0014',
+            'cO' => 'setCommands',
+            'n' => 'status',
+            'v' => status.to_s
+          }, {
+            'cCI' => 'M0014',
+            'cO' => 'setCommands',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }, {
+            'cCI' => 'M0014',
+            'cO' => 'setCommands',
+            'n' => 'plan',
+            'v' => plan.to_s
+          }]
+
+          send_command_with_confirm main.c_id, command_list, options, "dynamic bands plan #{plan}", nil
+        end
+
+        # M0023 — Set timeout for dynamic bands.
+        def set_dynamic_bands_timeout(status, options: {})
+          validate_ready 'set dynamic bands timeout'
+          raise 'TLC main component not found' unless main
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0023',
+            'cO' => 'setTimeout',
+            'n' => 'status',
+            'v' => status.to_s
+          }, {
+            'cCI' => 'M0023',
+            'cO' => 'setTimeout',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }]
+
+          send_command_with_confirm main.c_id, command_list, options, "dynamic bands timeout #{status}", nil
+        end
+
+        # M0015 — Set offset for a signal plan.
+        def set_offset(plan:, offset:, options: {})
+          validate_ready 'set offset'
+          raise 'TLC main component not found' unless main
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0015',
+            'cO' => 'setOffset',
+            'n' => 'status',
+            'v' => offset.to_s
+          }, {
+            'cCI' => 'M0015',
+            'cO' => 'setOffset',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }, {
+            'cCI' => 'M0015',
+            'cO' => 'setOffset',
+            'n' => 'plan',
+            'v' => plan.to_s
+          }]
+
+          send_command_with_confirm main.c_id, command_list, options, "offset plan #{plan} to #{offset}", nil
+        end
+
+        # Set the timeplan (signal plan) on the remote TLC.
+        def set_timeplan(plan_nr, options: {})
+          validate_ready 'set timeplan'
+          raise 'TLC main component not found' unless main
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0002',
+            'cO' => 'setPlan',
+            'n' => 'status',
+            'v' => 'True'
+          }, {
+            'cCI' => 'M0002',
+            'cO' => 'setPlan',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }, {
+            'cCI' => 'M0002',
+            'cO' => 'setPlan',
+            '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
+        end
+
+        # M0016 — Set week table (mapping week days to traffic situations).
+        def set_week_table(status, options: {})
+          validate_ready 'set week table'
+          raise 'TLC main component not found' unless main
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0016',
+            'cO' => 'setWeekTable',
+            'n' => 'status',
+            'v' => status.to_s
+          }, {
+            'cCI' => 'M0016',
+            'cO' => 'setWeekTable',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }]
+
+          send_command_with_confirm main.c_id, command_list, options, 'week table', nil
+        end
+
+        # M0017 — Set day table (mapping time periods to signal plans).
+        def set_day_table(status, options: {})
+          validate_ready 'set day table'
+          raise 'TLC main component not found' unless main
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0017',
+            'cO' => 'setDayTable',
+            'n' => 'status',
+            'v' => status.to_s
+          }, {
+            'cCI' => 'M0017',
+            'cO' => 'setDayTable',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }]
+
+          send_command_with_confirm main.c_id, command_list, options, 'day table', nil
+        end
+
+        # M0018 — Set cycle time for a signal plan.
+        def set_cycle_time(plan:, cycle_time:, options: {})
+          validate_ready 'set cycle time'
+          raise 'TLC main component not found' unless main
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0018',
+            'cO' => 'setCycleTime',
+            'n' => 'status',
+            'v' => cycle_time.to_s
+          }, {
+            'cCI' => 'M0018',
+            'cO' => 'setCycleTime',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }, {
+            'cCI' => 'M0018',
+            'cO' => 'setCycleTime',
+            'n' => 'plan',
+            'v' => plan.to_s
+          }]
+
+          send_command_with_confirm main.c_id, command_list, options, "cycle time plan #{plan} to #{cycle_time}", nil
+        end
+
+        # M0010 — Order signal start for a signal group component.
+        def order_signal_start(component_id, options: {})
+          validate_ready 'order signal start'
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0010',
+            'cO' => 'setStart',
+            'n' => 'status',
+            'v' => 'True'
+          }, {
+            'cCI' => 'M0010',
+            'cO' => 'setStart',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }]
+
+          send_command_with_confirm component_id, command_list, options, "signal start #{component_id}", nil
+        end
+
+        # M0011 — Order signal stop for a signal group component.
+        def order_signal_stop(component_id, options: {})
+          validate_ready 'order signal stop'
+
+          security_code = security_code_for(2)
+
+          command_list = [{
+            'cCI' => 'M0011',
+            'cO' => 'setStop',
+            'n' => 'status',
+            'v' => 'True'
+          }, {
+            'cCI' => 'M0011',
+            'cO' => 'setStop',
+            'n' => 'securityCode',
+            'v' => security_code.to_s
+          }]
+
+          send_command_with_confirm component_id, command_list, options, "signal stop #{component_id}", nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+module RSMP
+  module TLC
+    module Proxy
+      # Status reading and waiting methods for a remote TLC.
+      # Covers status subscriptions, group waits, and plan/band reading.
+      module Status
+        # Fetch the current signal plan from the remote TLC.
+        def fetch_signal_plan(options: {})
+          validate_ready 'fetch signal plan'
+
+          status_list = [{
+            'sCI' => 'S0014',
+            'n' => 'status'
+          }, {
+            'sCI' => 'S0014',
+            'n' => 'source'
+          }]
+
+          request_status main.c_id, status_list, @timeouts.merge(options)
+        end
+
+        # Subscribe to one or more statuses and wait until they match the expected values.
+        # Raises RSMP::TimeoutError if the values don't match within the timeout.
+        #
+        # status_list items: { 'sCI' => ..., 'n' => ..., 's' => <expected value or Regexp> }
+        # component_id defaults to the main TLC component.
+        # timeout defaults to @timeouts['command'].
+        def wait_for_status(description, status_list, update_rate: 0, timeout: nil, component_id: nil)
+          validate_ready 'wait for status'
+          component_id ||= main.c_id
+          timeout ||= @timeouts['command']
+
+          subscribe_list = status_list.map do |item|
+            entry = item.merge('uRt' => update_rate.to_s)
+            entry = entry.merge('sOc' => true) if use_soc?
+            entry
+          end
+
+          log "Wait for #{description}", level: :debug
+
+          begin
+            subscribe_to_status component_id, subscribe_list, collect!: { timeout: timeout }
+          ensure
+            unsubscribe_list = status_list.map { |item| item.slice('sCI', 'n') }
+            unsubscribe_to_status component_id, unsubscribe_list
+          end
+        end
+
+        # Wait for all signal groups to match state (as regex string, e.g. 'c' for yellow flash).
+        def wait_for_groups(state, timeout:)
+          regex = /^#{state}+$/
+          wait_for_status(
+            "all groups to reach state #{state}",
+            [{ 'sCI' => 'S0001', 'n' => 'signalgroupstatus', 's' => regex }],
+            timeout: timeout
+          )
+        end
+
+        # Wait for the TLC to return to normal control mode (functional position NormalControl,
+        # yellow flash off, startup mode off).
+        def wait_for_normal_control(timeout: nil)
+          wait_for_status(
+            'normal control on, yellow flash off, startup mode off',
+            [
+              { 'sCI' => 'S0007', 'n' => 'status', 's' => /^True(,True)*$/ },
+              { 'sCI' => 'S0011', 'n' => 'status', 's' => /^False(,False)*$/ },
+              { 'sCI' => 'S0005', 'n' => 'status', 's' => 'False' }
+            ],
+            timeout: timeout
+          )
+        end
+
+        # Read cycle times for all plans via S0028.
+        # Returns a hash of plan_nr (Integer) => cycle_time (Integer, seconds).
+        def read_cycle_times(options: {})
+          validate_ready 'read cycle times'
+          timeout = options[:timeout] || @timeouts['status_response']
+          result = request_status main.c_id,
+                                  [{ 'sCI' => 'S0028', 'n' => 'status' }],
+                                  collect!: { timeout: timeout }
+          result[:collector].messages.first.attributes['sS'].first['s'].split(',').to_h do |item|
+            item.split('-').map(&:to_i)
+          end
+        end
+
+        # Read the current signal plan number via S0014.
+        # Returns the plan number as an Integer.
+        def read_current_plan(options: {})
+          validate_ready 'read current plan'
+          timeout = options[:timeout] || @timeouts['status_response']
+          result = request_status main.c_id,
+                                  [{ 'sCI' => 'S0014', 'n' => 'status' }],
+                                  collect!: { timeout: timeout }
+          result[:collector].messages.first.attributes['sS'].first['s'].to_i
+        end
+
+        # Read the value of a single dynamic band for a given plan and band index via S0023.
+        # Returns the band value as an Integer, or nil if not found.
+        def read_dynamic_band(plan:, band:, options: {})
+          validate_ready 'read dynamic band'
+          timeout = options[:timeout] || @timeouts['status_response']
+          result = request_status main.c_id,
+                                  [{ 'sCI' => 'S0023', 'n' => 'status' }],
+                                  collect!: { timeout: timeout }
+          extract_band_value(result, plan, band)
+        end
+
+        private
+
+        def extract_band_value(result, plan, band)
+          result[:collector].messages.first.attributes['sS'].first['s'].split(',').each do |item|
+            some_plan, some_band, value = item.split('-')
+            return value.to_i if some_plan.to_i == plan.to_i && some_band.to_i == band.to_i
+          end
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+module RSMP
+  module TLC
+    module Proxy
+      # Command methods for operational control of a remote TLC.
+      # Covers functional position, emergency routes, I/O modes, signal group orders, and system settings.
+      module System
+        # M0103 — Change security code for a given level.
+        # Does not use security_code_for since the codes are passed explicitly.
+        def set_security_code(level:, old_code:, new_code:, options: {})
+          validate_ready 'set security code'
+          raise 'TLC main component not found' unless main
+
+          command_list = [{
+            'cCI' => 'M0103',
+            'cO' => 'setSecurityCode',
+            'n' => 'status',
+            'v' => level.to_s
+          }, {
+            'cCI' => 'M0103',
+            'cO' => 'setSecurityCode',
+            'n' => 'oldSecurityCode',
+            'v' => old_code.to_s
+          }, {
+            'cCI' => 'M0103',
+            'cO' => 'setSecurityCode',
+            'n' => 'newSecurityCode',
+            'v' => new_code.to_s
+          }]
+
+          send_command_with_confirm main.c_id, command_list, options, "security code level #{level}", nil
+        end
+
+        # M0104 — Set the clock on the remote TLC. clock must respond to year/month/day/hour/min/sec.
+        def set_clock(clock, options: {})
+          validate_ready 'set clock'
+          raise 'TLC main component not found' unless main
+
+          send_command_with_confirm main.c_id, clock_command_list(clock), options, 'clock', nil
+        end
+
+        private
+
+        def clock_command_list(clock)
+          security_code = security_code_for(1)
+          [
+            { 'cCI' => 'M0104', 'cO' => 'setDate', 'n' => 'securityCode', 'v' => security_code.to_s },
+            { 'cCI' => 'M0104', 'cO' => 'setDate', 'n' => 'year', 'v' => clock.year.to_s },
+            { 'cCI' => 'M0104', 'cO' => 'setDate', 'n' => 'month', 'v' => clock.month.to_s },
+            { 'cCI' => 'M0104', 'cO' => 'setDate', 'n' => 'day', 'v' => clock.day.to_s },
+            { 'cCI' => 'M0104', 'cO' => 'setDate', 'n' => 'hour', 'v' => clock.hour.to_s },
+            { 'cCI' => 'M0104', 'cO' => 'setDate', 'n' => 'minute', 'v' => clock.min.to_s },
+            { 'cCI' => 'M0104', 'cO' => 'setDate', 'n' => 'second', 'v' => clock.sec.to_s }
+          ]
+        end
+      end
+    end
+  end
+end