rsmp 0.40.0 → 0.41.0

data/lib/rsmp/tlc/traffic_controller_proxy.rb

@@ -0,0 +1,143 @@
+# 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
+  module TLC
+    # Proxy for handling communication with a remote traffic light controller.
+    class TrafficControllerProxy < SiteProxy
+      include Proxy::Control
+      include Proxy::IO
+      include Proxy::Plans
+      include Proxy::Status
+      include Proxy::Detectors
+      include Proxy::System
+
+      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)
+        super
+        @timeplan_source = nil
+        @timeplan = nil
+        @functional_position = nil
+        @yellow_flash = nil
+        @traffic_situation = nil
+        @timeouts = node.supervisor_settings.dig('default', 'timeouts') || {}
+      end
+
+      def subscribe_to_timeplan(options: {})
+        validate_ready 'subscribe to timeplan'
+
+        status_list = [
+          { 'sCI' => 'S0014', 'n' => 'status', 'uRt' => '0' },
+          { 'sCI' => 'S0014', 'n' => 'source', 'uRt' => '0' }
+        ]
+        status_list.each { |item| item['sOc'] = true } if use_soc?
+
+        merged_options = @timeouts.merge(options)
+
+        raise 'TLC main component not found' unless main
+
+        subscribe_to_status main.c_id, status_list, merged_options
+      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') || {}
+      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')
+      end
+
+      private
+
+      # Automatically subscribe to key TLC statuses to keep proxy in sync.
+      def auto_subscribe_to_statuses
+        return unless main
+
+        subscribe_to_timeplan
+        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') || {}
+        code = codes[level] || codes[level.to_s]
+        raise ArgumentError, "Security code for level #{level} is not configured" unless code
+
+        code
+      end
+
+      # Send a command and, if confirm: or confirm!: is present in options, wait for
+      # confirming status updates afterwards.
+      #
+      # confirm_description - human-readable label used in log output
+      # confirm_status_list  - status items to wait for (passed to wait_for_status)
+      # component_id         - component to wait on (defaults to main)
+      #
+      # If options[:confirm] is set, timeout errors are silently swallowed.
+      # If options[:confirm!] is set, timeout errors are raised.
+      def send_command_with_confirm(component_id, command_list, options, confirm_description, confirm_status_list)
+        result = send_command component_id, command_list, @timeouts.merge(options.except(:confirm, :confirm!))
+
+        confirm_opts = options[:confirm] || options[:confirm!]
+        return result unless confirm_opts
+        return result if confirm_status_list.nil? || confirm_status_list.empty?
+
+        timeout = confirm_opts.is_a?(Hash) ? confirm_opts[:timeout] : nil
+        wait_kwargs = { timeout: timeout }.compact
+        begin
+          wait_for_status confirm_description, confirm_status_list, **wait_kwargs
+        rescue RSMP::TimeoutError
+          raise if options[:confirm!]
+        end
+
+        result
+      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'
+        when 'S0011' then @yellow_flash = item['s'] if item['n'] == 'status'
+        when 'S0014' then cache_s0014_attribute(item)
+        when 'S0015' then @traffic_situation = item['s'] if item['n'] == 'status'
+        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
+        when 'source' then @timeplan_source = item['s']
+        end
+      end
+    end
+  end
+end

data/lib/rsmp/tlc/traffic_controller_site.rb

@@ -12,7 +12,7 @@ module RSMP
         # setup options before calling super initializer,
         # since build of components depend on options
         @sxl = 'traffic_light_controller'
-        @security_codes = options[:site_settings]['security_codes']
+        @security_codes = normalize_security_codes(options.dig(:site_settings, 'security_codes'))
         @interval = options[:site_settings].dig('intervals', 'timer') || 1
         @startup_sequence = options[:site_settings]['startup_sequence'] || 'efg'
         build_plans options[:site_settings]['signal_plans']
@@ -131,6 +131,15 @@ module RSMP
         raise MessageRejected, "Wrong security code for level #{level}"
       end
 
+      def normalize_security_codes(codes)
+        return {} unless codes.is_a?(Hash)
+
+        codes.each_with_object({}) do |(key, value), memo|
+          int_key = key.is_a?(String) && key.match?(/^\d+$/) ? key.to_i : key
+          memo[int_key] = value
+        end
+      end
+
       def change_security_code(level, old_code, new_code)
         verify_security_code level, old_code
         @security_codes[level] = new_code

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = '0.40.0'.freeze
+  VERSION = '0.41.0'.freeze
 end

data/lib/rsmp.rb

@@ -88,6 +88,13 @@ require_relative 'rsmp/tlc/modules/display'
 require_relative 'rsmp/tlc/modules/helpers'
 require_relative 'rsmp/tlc/startup_sequence'
 require_relative 'rsmp/tlc/traffic_controller_site'
+require_relative 'rsmp/tlc/proxy/control'
+require_relative 'rsmp/tlc/proxy/detectors'
+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/traffic_controller'
 require_relative 'rsmp/tlc/detector_logic'
 require_relative 'rsmp/tlc/signal_group'
@@ -95,5 +102,4 @@ require_relative 'rsmp/tlc/signal_plan'
 require_relative 'rsmp/tlc/input_states'
 require_relative 'rsmp/tlc/signal_priority'
 require_relative 'rsmp/convert/import/yaml'
-require_relative 'rsmp/convert/export/json_schema'
 require_relative 'rsmp/version'

data/rsmp.gemspec

@@ -37,5 +37,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'io-stream', '~> 0.10'
   spec.add_dependency 'logger', '~> 1.6'
   spec.add_dependency 'ostruct', '~> 0.6'
-  spec.add_dependency 'rsmp_schema', '~> 0.8'
+  spec.add_dependency 'rsmp_schema', '~> 0.10'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.41.0
 platform: ruby
 authors:
 - Emil Tin
@@ -99,14 +99,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.10'
 description: Easy RSMP site and supervisor communication.
 email:
 - zf0f@kk.dk
@@ -167,7 +167,6 @@ files:
 - lib/rsmp/component/component_base.rb
 - lib/rsmp/component/component_proxy.rb
 - lib/rsmp/component/components.rb
-- lib/rsmp/convert/export/json_schema.rb
 - lib/rsmp/convert/import/yaml.rb
 - lib/rsmp/helpers/clock.rb
 - lib/rsmp/helpers/deep_merge.rb
@@ -190,6 +189,7 @@ files:
 - lib/rsmp/options/options.rb
 - lib/rsmp/options/schemas/site.json
 - lib/rsmp/options/schemas/supervisor.json
+- lib/rsmp/options/schemas/supervisor_site.json
 - lib/rsmp/options/schemas/traffic_controller_site.json
 - lib/rsmp/options/site_options.rb
 - lib/rsmp/options/supervisor_options.rb
@@ -225,11 +225,18 @@ files:
 - lib/rsmp/tlc/modules/startup_sequence.rb
 - lib/rsmp/tlc/modules/system.rb
 - lib/rsmp/tlc/modules/traffic_data.rb
+- lib/rsmp/tlc/proxy/control.rb
+- lib/rsmp/tlc/proxy/detectors.rb
+- lib/rsmp/tlc/proxy/io.rb
+- lib/rsmp/tlc/proxy/plans.rb
+- lib/rsmp/tlc/proxy/status.rb
+- lib/rsmp/tlc/proxy/system.rb
 - lib/rsmp/tlc/signal_group.rb
 - lib/rsmp/tlc/signal_plan.rb
 - lib/rsmp/tlc/signal_priority.rb
 - lib/rsmp/tlc/startup_sequence.rb
 - lib/rsmp/tlc/traffic_controller.rb
+- lib/rsmp/tlc/traffic_controller_proxy.rb
 - lib/rsmp/tlc/traffic_controller_site.rb
 - lib/rsmp/version.rb
 - rsmp.gemspec

data/lib/rsmp/convert/export/json_schema.rb

@@ -1,214 +0,0 @@
-# Import SXL from YAML format
-
-require 'yaml'
-require 'json'
-require 'fileutils'
-
-module RSMP
-  module Convert
-    module Export
-      # Converts SXL (YAML) structures into JSON Schema files.
-      # Converts SXL (YAML) structures into JSON Schema files.
-      module JSONSchema
-        JSON_OPTIONS = {
-          array_nl: "\n",
-          object_nl: "\n",
-          indent: '  ',
-          space_before: ' ',
-          space: ' '
-        }.freeze
-
-        def self.output_json(item)
-          JSON.generate(item, JSON_OPTIONS)
-        end
-
-        def self.build_value(item)
-          out = {}
-          out['description'] = item['description'] if item['description']
-
-          if item['list']
-            build_list_value(out, item)
-          else
-            build_single_value(out, item)
-          end
-
-          out
-        end
-
-        def self.build_list_value(out, item)
-          case item['type']
-          when 'boolean'
-            out['$ref'] = '../../../core/3.1.1/definitions.json#/boolean_list'
-          when 'integer', 'ordinal', 'unit', 'scale', 'long'
-            out['$ref'] = '../../../core/3.1.1/definitions.json#/integer_list'
-          else
-            raise "Error: List of #{item['type']} is not supported: #{item.inspect}"
-          end
-
-          if item['values']
-            value_list = item['values'].keys.join('|')
-            out['pattern'] = /(?-mix:^(#{value_list})(?:,(#{value_list}))*$)/
-          end
-
-          puts "Warning: Pattern not support for lists: #{item.inspect}" if item['pattern']
-        end
-
-        def self.build_single_value(out, item)
-          case item['type']
-          when 'boolean'
-            out['$ref'] = '../../../core/3.1.1/definitions.json#/boolean'
-          when 'timestamp'
-            out['$ref'] = '../../../core/3.1.1/definitions.json#/timestamp'
-          when 'integer', 'ordinal', 'unit', 'scale', 'long'
-            out['$ref'] = '../../../core/3.1.1/definitions.json#/integer'
-          else # includes 'string', 'base64' and any other types
-            out['type'] = 'string'
-          end
-
-          out['enum'] = item['values'].keys.sort if item['values']
-          out['pattern'] = item['pattern'] if item['pattern']
-        end
-
-        def self.build_item(item, property_key: 'v')
-          json = { 'allOf' => [{ 'description' => item['description'] }] }
-          if item['arguments']
-            json['allOf'].first['properties'] = { 'n' => { 'enum' => item['arguments'].keys.sort } }
-            item['arguments'].each_pair do |key, argument|
-              json['allOf'] << {
-                'if' => { 'required' => ['n'], 'properties' => { 'n' => { 'const' => key } } },
-                'then' => { 'properties' => { property_key => build_value(argument) } }
-              }
-            end
-          end
-          json
-        end
-
-        def self.output_alarms(out, items)
-          list = items.keys.sort.map do |key|
-            {
-              'if' => { 'required' => ['aCId'], 'properties' => { 'aCId' => { 'const' => key } } },
-              'then' => { '$ref' => "#{key}.json" }
-            }
-          end
-          json = {
-            'properties' => {
-              'aCId' => { 'enum' => items.keys.sort },
-              'rvs' => { 'items' => { 'allOf' => list } }
-            }
-          }
-          out['alarms/alarms.json'] = output_json json
-          items.each_pair { |key, item| output_alarm out, key, item }
-        end
-
-        def self.output_alarm(out, key, item)
-          json = build_item item
-          out["alarms/#{key}.json"] = output_json json
-        end
-
-        def self.output_statuses(out, items)
-          list = [{ 'properties' => { 'sCI' => { 'enum' => items.keys.sort } } }]
-          items.keys.sort.each do |key|
-            list << {
-              'if' => { 'required' => ['sCI'], 'properties' => { 'sCI' => { 'const' => key } } },
-              'then' => { '$ref' => "#{key}.json" }
-            }
-          end
-          json = { 'properties' => { 'sS' => { 'items' => { 'allOf' => list } } } }
-          out['statuses/statuses.json'] = output_json json
-          items.each_pair { |key, item| output_status out, key, item }
-        end
-
-        def self.output_status(out, key, item)
-          json = build_item item, property_key: 's'
-          out["statuses/#{key}.json"] = output_json json
-        end
-
-        def self.output_commands(out, items)
-          list = [{ 'properties' => { 'cCI' => { 'enum' => items.keys.sort } } }]
-          items.keys.sort.each do |key|
-            list << {
-              'if' => { 'required' => ['cCI'], 'properties' => { 'cCI' => { 'const' => key } } },
-              'then' => { '$ref' => "#{key}.json" }
-            }
-          end
-          json = { 'items' => { 'allOf' => list } }
-          out['commands/commands.json'] = output_json json
-
-          json = { 'properties' => { 'arg' => { '$ref' => 'commands.json' } } }
-          out['commands/command_requests.json'] = output_json json
-
-          json = { 'properties' => { 'rvs' => { '$ref' => 'commands.json' } } }
-          out['commands/command_responses.json'] = output_json json
-
-          items.each_pair { |key, item| output_command out, key, item }
-        end
-
-        def self.output_command(out, key, item)
-          json = build_item item
-          json['allOf'].first['properties']['cO'] = { 'const' => item['command'] }
-          out["commands/#{key}.json"] = output_json json
-        end
-
-        def self.build_root_schema(meta)
-          {
-            'name' => meta['name'],
-            'description' => meta['description'],
-            'version' => meta['version'],
-            'allOf' => build_root_refs
-          }
-        end
-
-        def self.build_root_refs
-          [
-            {
-              'if' => { 'required' => ['type'], 'properties' => { 'type' => { 'const' => 'CommandRequest' } } },
-              'then' => { '$ref' => 'commands/command_requests.json' }
-            },
-            {
-              'if' => { 'required' => ['type'], 'properties' => { 'type' => { 'const' => 'CommandResponse' } } },
-              'then' => { '$ref' => 'commands/command_responses.json' }
-            },
-            {
-              'if' => { 'required' => ['type'],
-                        'properties' => {
-                          'type' => {
-                            'enum' => %w[StatusRequest StatusResponse StatusSubscribe
-                                         StatusUnsubscribe StatusUpdate]
-                          }
-                        } },
-              'then' => { '$ref' => 'statuses/statuses.json' }
-            },
-            {
-              'if' => { 'required' => ['type'], 'properties' => { 'type' => { 'const' => 'Alarm' } } },
-              'then' => { '$ref' => 'alarms/alarms.json' }
-            }
-          ]
-        end
-
-        def self.output_root(out, meta)
-          json = build_root_schema(meta)
-          out['sxl.json'] = output_json json
-        end
-
-        def self.generate(sxl)
-          out = {}
-          output_root out, sxl[:meta]
-          output_alarms out, sxl[:alarms]
-          output_statuses out, sxl[:statuses]
-          output_commands out, sxl[:commands]
-          out
-        end
-
-        def self.write(sxl, folder)
-          out = generate sxl
-          out.each_pair do |relative_path, str|
-            path = File.join(folder, relative_path)
-            FileUtils.mkdir_p File.dirname(path) # create folders if needed
-            file = File.open(path, 'w+') # w+ means truncate or create new file
-            file.puts str
-          end
-        end
-      end
-    end
-  end
-end