rsmp 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53db2e5d294329ddcaed57088f8b1ef6a3b3bae1327d7a41727b5b242df5e9d7
-  data.tar.gz: fa5926fe27b1f24be2998d7860ba8ceaddb1d51a23bedc3554d31e48b0293ec6
+  metadata.gz: 15537491c95e5c0fc89514111d9947409bd4222b566d69df7376f545b96629a0
+  data.tar.gz: 70399d65fd90a7f0db1bdc75003a3cac47d57052190b55cc6a9a39d119451c6d
 SHA512:
-  metadata.gz: 2f3448a60f9bd4edda200b165a612217f57086b0342b04f11d6a03087c77500093fd61c21c85946d4cf91b1b228404634d6d884fc0ffc7de7f62f8b552fa373e
-  data.tar.gz: 87ce720b9a3e2c7b9ed7db64c07a18ac84058b38007172fabe1c8847513c93fd1002ac9c8e6f3ba6635d24c9bf36c9f3b36324d6edc0b135887bcc3039d3dc61
+  metadata.gz: a44a9c93dbfb105de6620a9c42e97ad90b5a32f284f0fc38e25e47c4dff177dc60d3b5fad83812cba585fe4c1b7504afee2fa658ab24f7159dbcef99f897b8f4
+  data.tar.gz: cc77592ac84a15959438786227a602d6f81c82e4b401c48310f50440f53d72270b77f44a439b3ba2fb08ce22087375a486db8ddb71e8639b73360e3a005021e8

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    rsmp (0.15.0)
+    rsmp (0.16.0)
       async (~> 1.30.3)
       async-io (~> 1.33.0)
       colorize (~> 0.8.1)
-      rsmp_schema (~> 0.2.3)
+      rsmp_schema (~> 0.3.1)
       thor (~> 1.2.1)
 
 GEM
@@ -80,7 +80,7 @@ GEM
     nio4r (2.5.8)
     rake (13.0.6)
     regexp_parser (2.5.0)
-    rsmp_schema (0.2.3)
+    rsmp_schema (0.3.1)
       json_schemer (~> 0.2.21)
       thor (~> 1.2.1)
     rspec (3.10.0)
@@ -100,7 +100,7 @@ GEM
       ffi (~> 1.1)
     thor (1.2.1)
     timecop (0.9.5)
-    timers (4.3.3)
+    timers (4.3.4)
     uri_template (0.7.0)
 
 PLATFORMS

data/config/tlc.yaml

@@ -2,6 +2,7 @@ site_id: RN+SI0001
 supervisors:
   - ip: 127.0.0.1
     port: 12111
+rsmp_versions: '3.2'
 sxl: tlc
 sxl_version: '1.1'
 components:

data/lib/rsmp/collect/ack_collector.rb

@@ -0,0 +1,16 @@
+module RSMP
+  # Class for waiting for a message acknowledgement
+  class AckCollector < Collector
+    def initialize proxy, options={}
+      raise ArgumentError.new("m_id must be provided") unless options[:m_id]
+      required = { type: 'MessageAck', num: 1, title: 'message acknowledgement' }
+      super proxy, options.merge(required)
+    end
+
+    # Check if we the MessageAck related to initiating request, identified by @m_id.
+    def type_match? message
+      return false if super(message) == false
+      return message.attribute('oMId') == @options[:m_id]
+    end
+  end
+end

data/lib/rsmp/components.rb

@@ -17,8 +17,8 @@ module RSMP
       check_main_component settings
       settings.each_pair do |type,components_by_type|
         if components_by_type
-          components_by_type.each_pair do |id,settings|
-            @components[id] = build_component(id:id, type:type, settings:settings)
+          components_by_type.each_pair do |id,component_settings|
+            @components[id] = build_component(id:id, type:type, settings:component_settings)
             @main = @components[id] if type=='main'
           end
         end

data/lib/rsmp/proxy.rb

@@ -13,7 +13,7 @@ module RSMP
     include Inspect
     include Task
 
-    attr_reader :state, :archive, :connection_info, :sxl, :collector, :ip, :port, :node
+    attr_reader :state, :archive, :connection_info, :sxl, :collector, :ip, :port, :node, :rsmp_version
 
     def initialize options
       @node = options[:node]
@@ -28,6 +28,7 @@ module RSMP
     def disconnect
     end
 
+
     # wait for the reader task to complete,
     # which is not expected to happen before the connection is closed
     def wait_for_reader
@@ -314,12 +315,9 @@ module RSMP
     end
 
     def get_schemas
-      # normally we have an sxl, but during connection, it hasn't been established yet
-      # at these times we only validate against the core schema
-      # TODO
-      # what schema should we use to validate the initial Version and MessageAck messages?
       schemas = { core: RSMP::Schema.latest_core_version } # use latest core
-      schemas[sxl] = RSMP::Schema.sanitize_version(sxl_version) if sxl && sxl_version
+      schemas[:core] = rsmp_versions.last if rsmp_versions
+      schemas[sxl] = RSMP::Schema.sanitize_version(sxl_version.to_s) if sxl && sxl_version
       schemas
     end
 
@@ -460,7 +458,7 @@ module RSMP
     def rsmp_versions
       return [RSMP::Schema.latest_core_version] if @site_settings["rsmp_versions"] == 'latest'
       return RSMP::Schema.core_versions if @site_settings["rsmp_versions"] == 'all'
-      @site_settings["rsmp_versions"]
+      [@site_settings["rsmp_versions"]].flatten
     end
 
     def check_rsmp_version message
@@ -560,8 +558,11 @@ module RSMP
         message.original = original
         log_acknowledgement_for_original message, original
 
-        if original.type == "Version"
+        case original.type
+        when "Version"
           version_acknowledged
+        when "StatusSubscribe"
+          status_subscribe_acknowledged original
         end
 
         check_outgoing_acknowledged original
@@ -653,5 +654,14 @@ module RSMP
       Gem::Requirement.new(requirement).satisfied_by?(Gem::Version.new(version))
     end
 
+    def status_subscribe_acknowledged original
+      component = find_component original.attribute('cId')
+      return unless component
+      short = Message.shorten_m_id original.m_id
+      subscribe_list = original.attributes['sS']
+      log "StatusSubscribe #{short} acknowledged, allowing repeated status values for #{subscribe_list}", level: :info
+      component.allow_repeat_updates subscribe_list
+    end
+
   end
 end

data/lib/rsmp/site.rb

@@ -59,7 +59,7 @@ module RSMP
 
     def check_sxl_version
       sxl = @site_settings['sxl']
-      version = @site_settings['sxl_version']
+      version = @site_settings['sxl_version'].to_s
       RSMP::Schema::find_schema! sxl, version, lenient: true
     end
 
@@ -145,7 +145,8 @@ module RSMP
       nil
     end
 
-    def build_component id:, type:, settings:{}
+    def build_component id:, type:, settings:
+      settings ||= {}
       if type == 'main'
         Component.new id:id, node: self, grouped: true,
           ntsOId: settings['ntsOId'], xNId: settings['xNId']

data/lib/rsmp/site_proxy.rb

@@ -48,7 +48,7 @@ module RSMP
     def handshake_complete
       super
       sanitized_sxl_version = RSMP::Schema.sanitize_version(@site_sxl_version)
-      log "Connection to site #{@site_id} established, using core #{@rsmp_version}, #{@sxl} #{sanitized_sxl_version}", level: :log
+      log "Connection to site #{@site_id} established, using core #{@rsmp_version}, #{@sxl} #{sanitized_sxl_version}", level: :info
       start_watchdog
     end
 
@@ -228,7 +228,6 @@ module RSMP
       end
 
       component = find_component component_id
-      component.allow_repeat_updates subscribe_list
 
       message = RSMP::StatusSubscribe.new({
           "cId" => component_id,
@@ -236,6 +235,7 @@ module RSMP
           'mId' => m_id
       })
       set_nts_message_attributes message
+
       send_and_optionally_collect message, options do |collect_options|
         StatusCollector.new(
           self,
@@ -308,11 +308,10 @@ module RSMP
     end
 
     def check_sxl_version message
-
       # check that we have a schema for specified sxl type and version
       # note that the type comes from the site config, while the version
       # comes from the Version message send by the site
-      type = 'tlc'
+      type = @site_settings['sxl']
       version = message.attribute 'SXL'
       RSMP::Schema::find_schema! type, version, lenient: true
 
@@ -332,7 +331,6 @@ module RSMP
     def process_version message
       return extraneous_version message if @version_determined
       check_site_ids message
-      check_rsmp_version message
       check_sxl_version message
       version_accepted message
     end
@@ -341,8 +339,6 @@ module RSMP
       # RSMP support multiple site ids. we don't support this yet. instead we use the first id only
       site_id = message.attribute("siteId").map { |item| item["sId"] }.first
       @supervisor.check_site_id site_id
-      @site_id = site_id
-      setup_site_settings
       site_ids_changed
     end
 

data/lib/rsmp/supervisor.rb

@@ -138,8 +138,7 @@ module RSMP
     def peek_version_message protocol
       json = protocol.peek_line
       attributes = Message.parse_attributes json
-      message = Message.build attributes, json
-      message.attribute('siteId').first['sId']
+       Message.build attributes, json
     end
 
     # accept an incoming connecting by creating and starting a proxy
@@ -169,7 +168,9 @@ module RSMP
         archive: @archive
       }
 
-      id = peek_version_message protocol
+      version_message = peek_version_message protocol
+      id = version_message.attribute('siteId').first['sId']
+
       proxy = find_site id
       if proxy
         if proxy.connected?
@@ -182,6 +183,11 @@ module RSMP
         proxy = build_proxy settings.merge(site_id:id)    # keep the id learned by peeking above
         @proxies.push proxy
       end
+
+      proxy.setup_site_settings
+      proxy.check_rsmp_version version_message
+      log "Validating using core version #{proxy.rsmp_version}", level: :debug
+
       proxy.start     # will run until the site disconnects
       proxy.wait
     ensure

data/lib/rsmp/supervisor_proxy.rb

@@ -270,13 +270,18 @@ module RSMP
       send_message response
     end
 
+    def rsmpify_value v
+      return v if v.is_a? Array
+      v.to_s
+    end
+
     def process_status_request message, options={}
       component_id = message.attributes["cId"]
       component = @site.find_component component_id
       log "Received #{message.type}", message: message, level: :log
       sS = message.attributes["sS"].map do |arg|
         value, quality =  component.get_status arg['sCI'], arg['n'], {sxl_version: sxl_version}
-        { "s" => value.to_s, "q" => quality.to_s }.merge arg
+        { "s" => rsmpify_value(value), "q" => quality.to_s }.merge arg
       end
       response = StatusResponse.new({
         "cId"=>component_id,
@@ -375,7 +380,7 @@ module RSMP
               # send as soon as the data changes
               if component_object
                 current, age = *(component_object.get_status code, name)
-                current = current.to_s
+                current = rsmpify_value(current)
               end
               last_sent = fetch_last_sent_status component, code, name
               if current != last_sent
@@ -413,7 +418,7 @@ module RSMP
             end
             sS << { "sCI" => code,
                      "n" => status_name,
-                     "s" => value.to_s,
+                     "s" => rsmpify_value(value),
                      "q" => quality }
           end
         end

data/lib/rsmp/tlc/signal_priority.rb

@@ -0,0 +1,28 @@
+class RSMP::TLC::SignalPriority
+  attr_reader :state, :node, :id, :level, :eta, :vehicleType, :age, :updated
+
+  def initialize node:, id:, level:, eta:, vehicleType:
+    @node = node
+    @id = id
+    @level = level
+    @eta = eta
+    @vehicleType = vehicleType
+    set_state 'received'
+  end
+
+  def set_state state
+    @state = state
+    @updated = node.clock.now
+    node.signal_priority_changed self, @state
+  end
+
+  def timer
+    @age = @node.clock.now - @updated
+    case @state
+    when 'received'
+      set_state 'activated' if @age >= 0.5
+    when 'activated'
+      set_state 'completed' if @age >= 0.5
+    end
+  end
+end

data/lib/rsmp/tlc/traffic_controller.rb

@@ -60,6 +60,7 @@ module RSMP
         @startup_sequence_pos = 0
         @time_int = nil
         @inputs.reset
+        @signal_priorities = []
       end
 
       def dark?
@@ -105,8 +106,30 @@ module RSMP
         move_startup_sequence if @startup_sequence_active
 
         @signal_groups.each { |group| group.timer }
+        @signal_priorities.each {|priority| priority.timer }
 
         output_states
+        prune_priorities
+      end
+
+      def signal_priority_changed priority, state
+        #puts "priority #{priority.id} -> #{state}"
+      end
+
+      def prune_priorities
+        # TODO spec states that update must be send one time when it reaches the state 'completed',
+        # and then be removed. so we need to know when it has been sent
+        @signal_priorities.delete_if {|priority| priority.state=='completed' && priority.age >= 1.5 }
+      end
+
+      def get_priority_list
+        @signal_priorities.map do |priority|
+          {
+            "r" => priority.id,
+            "t" => RSMP::Clock.to_s(priority.updated),
+            "s" => priority.state
+          }
+        end
       end
 
       def move_cycle_counter
@@ -398,6 +421,43 @@ module RSMP
         @node.verify_security_code 2, arg['securityCode']
       end
 
+      def handle_m0022 arg, options={}
+        id = arg['requestId']
+        type = arg['type']
+        priority = @signal_priorities.find { |priority| priority.id == id }
+        case type
+        when 'new'
+          if priority
+            raise MessageRejected.new("Priority Request #{id} already exists")
+          else
+            #ref = arg.slice('signalGroupId','inputId','connectionId','approachId','laneInId','laneOutId')
+            if arg['signalGroupId']
+              signal_group = node.find_component arg['signalGroupId']
+            end
+
+            level = arg['level']
+            eta = arg['eta']
+            vehicleType = arg['vehicleType']
+            @signal_priorities << SignalPriority.new(node:self, id:id, level:level, eta:eta, vehicleType:vehicleType)
+            log "Priority request for signal group #{signal_group.c_id} received with id #{id}", level: :info
+          end          
+        when 'update'
+          if priority
+            log "Priority Request #{id} updated", level: :info
+          else
+            raise MessageRejected.new("Cannot update priority request #{id}, not found")
+          end
+        when 'cancel'
+          if priority
+            @signal_priorities.delete priority
+          else
+            raise MessageRejected.new("Cannot cancel priority request #{id}, not found")
+          end    
+        else
+          raise MessageRejected.new("Unknown type #{type}")
+        end
+      end
+
       def handle_m0103 arg, options={}
         level = {'Level1'=>1,'Level2'=>2}[arg['status']]
         @node.change_security_code level, arg['oldSecurityCode'], arg['newSecurityCode']
@@ -465,7 +525,7 @@ module RSMP
              'S0008', 'S0009', 'S0010', 'S0011', 'S0012', 'S0013', 'S0014',
              'S0015', 'S0016', 'S0017', 'S0018', 'S0019', 'S0020', 'S0021',
              'S0022', 'S0023', 'S0024', 'S0026', 'S0027', 'S0028',
-             'S0029', 'S0030', 'S0031',
+             'S0029', 'S0030', 'S0031', 'S0032', 'S0033',
              'S0091', 'S0092', 'S0095', 'S0096', 'S0097',
              'S0205', 'S0206', 'S0207', 'S0208'
           return send("handle_#{code.downcase}", code, name, options)
@@ -717,6 +777,24 @@ module RSMP
         end
       end
 
+      def handle_s0032 status_code, status_name=nil, options={}
+        case status_name
+        when 'intersection'
+          TrafficControllerSite.make_status @intersection
+        when 'status'
+          TrafficControllerSite.make_status 'local'
+        when 'source'
+          TrafficControllerSite.make_status 'startup'
+        end
+      end
+
+      def handle_s0033 status_code, status_name=nil, options={}
+        case status_name
+        when 'status'
+          TrafficControllerSite.make_status get_priority_list
+        end
+      end
+
       def handle_s0091 status_code, status_name=nil, options={}
         if Proxy.version_requirement_met? '>=1.1',options[:sxl_version]
           case status_name

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.15.0"
+  VERSION = "0.16.0"
 end

data/lib/rsmp.rb

@@ -30,6 +30,7 @@ require 'rsmp/collect/status_collector'
 require 'rsmp/collect/command_response_collector'
 require 'rsmp/collect/aggregated_status_collector'
 require 'rsmp/collect/alarm_collector'
+require 'rsmp/collect/ack_collector'
 require 'rsmp/alarm_state'
 require 'rsmp/component_base'
 require 'rsmp/component'
@@ -48,6 +49,7 @@ require 'rsmp/tlc/detector_logic'
 require 'rsmp/tlc/signal_group'
 require 'rsmp/tlc/signal_plan'
 require 'rsmp/tlc/inputs'
+require 'rsmp/tlc/signal_priority'
 
 require 'rsmp/convert/import/yaml'
 require 'rsmp/convert/export/json_schema'

data/rsmp.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "async-io", "~> 1.33.0"
   spec.add_dependency "colorize", "~> 0.8.1"
   spec.add_dependency "thor", "~> 1.2.1"
-  spec.add_dependency "rsmp_schema", "~> 0.2.3"
+  spec.add_dependency "rsmp_schema", "~> 0.3.1"
 
   spec.add_development_dependency "bundler", "~> 2.3.7"
   spec.add_development_dependency "rake", "~> 13.0.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-25 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -211,6 +211,7 @@ files:
 - lib/rsmp/alarm_state.rb
 - lib/rsmp/archive.rb
 - lib/rsmp/cli.rb
+- lib/rsmp/collect/ack_collector.rb
 - lib/rsmp/collect/aggregated_status_collector.rb
 - lib/rsmp/collect/alarm_collector.rb
 - lib/rsmp/collect/alarm_query.rb
@@ -249,6 +250,7 @@ files:
 - lib/rsmp/tlc/inputs.rb
 - lib/rsmp/tlc/signal_group.rb
 - lib/rsmp/tlc/signal_plan.rb
+- lib/rsmp/tlc/signal_priority.rb
 - lib/rsmp/tlc/traffic_controller.rb
 - lib/rsmp/tlc/traffic_controller_site.rb
 - lib/rsmp/version.rb