rsmp 0.3.3 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b124af129ad5b07b815b08abfa6b0642f5b2e3cc57b54face6c9c7eb907d7691
-  data.tar.gz: 269c32fd8db76ea7960e92c652369de4f6de35d198848051ee6db742f4d64a30
+  metadata.gz: 63163e8e010e001deffd0bba691e343c028ae5edbf3a5c9022529d319c36035e
+  data.tar.gz: 07225c7538b514c3b74dbc307a432f32eb1fe839faaeef4483208206b29e103a
 SHA512:
-  metadata.gz: af7adc670cb134befa1d6f0b05674dd2ff9f06f85690a907b55f510bf7b22d970251d8b971a64cc89c7fdd047208077521e32f7552437130b3ff3818b1458e4b
-  data.tar.gz: 3cdf1087034a80e6b5539e398664ef5dba9308d94c1628339d7ec249563e6bd8211e15cc506b37ac31f4616ebb4d632d412b6c7fb785c2ba4e3b0a7082fa02d5
+  metadata.gz: 6eed25d057be1a6766b94d1127b41f498b4e3532bf5650d7c888321dfe48bafaf2af69ff2d871cc437fc44ae9286d898da2387bc2e267d451aca332d3695159f
+  data.tar.gz: 011f89ceb76bbfdc521ca0730c2d7f1c48663e4faf35576e4e72bee83831813745bc0ce0c45aab4201c1874f1ee21a5c1f6235dbab0c16feab1e3970acc56d3b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.3.3)
+    rsmp (0.3.7)
       async (~> 1.29.1)
       async-io (~> 1.32.1)
       colorize (~> 0.8.1)

data/lib/rsmp/component.rb

@@ -13,7 +13,7 @@ module RSMP
                                :rest,
                                :not_connected ]
 
-    def initialize node:, id:, grouped:
+    def initialize node:, id:, grouped: false
       @c_id = id
       @node = node
       @grouped = grouped
@@ -57,9 +57,6 @@ module RSMP
     def aggregated_status_changed options={}
       @node.aggregated_status_changed self, options
     end
- 
-    def alarm code:, status:
-    end
 
     def log str, options
       @node.log str, options
@@ -73,5 +70,18 @@ module RSMP
       raise UnknownStatus.new "Status #{status_code}/#{status_name} not implemented by #{self.class}"
     end
 
+    def handle_alarm message
+      code = message.attribute('aCId')
+      alarm = @alarms[code]
+      if alarm
+        if alarm.differ? message
+          @alarms[code] = alarm
+        else
+          raise RepeatedAlarmError.new("no changes from previous alarm #{alarm.m_id_short}")
+        end
+      else
+        @alarms[code] = message
+      end
+    end
   end
 end

data/lib/rsmp/components.rb

@@ -38,10 +38,23 @@ module RSMP
       Component.new id:id, node: self, grouped: type=='main'
     end
 
-    def find_component component_id
+    def infer_component_type component_id
+      Component
+    end
+
+    def find_component component_id, build: true
       component = @components[component_id]
-      raise UnknownComponent.new("Component #{component_id} not found") unless component
-      component
+      return component if component
+      if build
+        inferred = infer_component_type component_id
+        component = inferred.new node: self, id: component_id
+        @components[ component_id] = component
+        class_name = component.class.name.split('::').last
+        log "Inferred #{class_name} component #{component_id}", level: :info
+        component
+      else
+        raise UnknownComponent.new("Component #{component_id} not found") unless component
+      end
     end
 
   end

data/lib/rsmp/error.rb

@@ -52,4 +52,7 @@ module RSMP
 
 	class ConfigurationError < Error
 	end
+
+	class RepeatedAlarmError < Error
+	end
 end

data/lib/rsmp/message.rb

@@ -36,7 +36,7 @@ module RSMP
       when "Watchdog"
         message = Watchdog.new attributes
       when "Alarm"
-        message = Alarm.new attributes
+        message = self.build_alarm attributes
       when "CommandRequest"
         message = CommandRequest.new attributes
       when "CommandResponse"
@@ -59,6 +59,23 @@ module RSMP
       message
     end
 
+    def self.build_alarm attributes
+      case attributes["aSp"]
+      when 'Issue'
+        AlarmIssue.new attributes
+      when 'Request'
+        AlarmRequest.new attributes
+      when 'Acknowledge'
+        AlarmAcknowledged.new attributes
+      when 'Suspend'
+        AlarmSuspend.new attributes
+      when 'Resume'
+        AlarmResume.new attributes
+      else
+        Alarm.new attributes
+      end
+    end
+
     def type
       @attributes["type"]
     end
@@ -191,26 +208,64 @@ module RSMP
     def initialize attributes = {}
       super({
         "type" => "Alarm",
+        "ntsOId" => '',
+        "xNId" => '',
+        "xACId" => '',
+        "xNACId" => ''
       }.merge attributes)
     end
+
+    def differ? from
+      %w{aSp aCId ack aS sS aTs cat pri}.each do |key|
+        return true if attribute(key).downcase != from.attribute(key).downcase
+      end
+      return true if attribute('rvs') != from.attribute('rvs')
+      false
+    end
   end
 
-  class AlarmRequest < Message
+  class AlarmIssue < Alarm
     def initialize attributes = {}
       super({
-        "type" => "Alarm",
+        "aSp" => "Issue",
       }.merge attributes)
     end
   end
 
-  class AlarmAcknowledged < Message
+  class AlarmRequest < Alarm
     def initialize attributes = {}
       super({
-        "type" => "Alarm",
+        "aSp" => "Request",
+      }.merge attributes)
+    end
+  end
+
+  class AlarmAcknowledged < Alarm
+    def initialize attributes = {}
+      super({
+        "aSp" => "Acknowledge",
       }.merge attributes)
     end
   end
 
+  class AlarmSuspend < Alarm
+    def initialize attributes = {}
+      super({
+        "aSp" => "Suspend",
+      }.merge attributes)
+    end
+  end
+
+  class AlarmResume < Alarm
+    def initialize attributes = {}
+      super({
+        "aSp" => "Resume",
+      }.merge attributes)
+    end
+  end
+
+
+
   class Watchdog < Message
     def initialize attributes = {}
       super({

data/lib/rsmp/proxy.rb

@@ -73,6 +73,11 @@ module RSMP
       @state == :ready
     end
 
+    def connected?
+      @state == :starting || @state == :ready
+    end
+
+
     def start
       set_state :starting
     end
@@ -118,7 +123,6 @@ module RSMP
         task.annotate "reader"
         @stream ||= Async::IO::Stream.new(@socket)
         @protocol ||= Async::IO::Protocol::Line.new(@stream,WRAPPING_DELIMITER) # rsmp messages are json terminated with a form-feed
-
         while json = @protocol.read_line
           beginning = Time.now
           message = process_packet json
@@ -267,12 +271,13 @@ module RSMP
     end
 
     def send_message message, reason=nil, validate: true
+      raise NotReady unless connected?
       raise IOError unless @protocol
       message.direction = :out
       message.generate_json
       message.validate get_schemas unless validate==false
-      expect_acknowledgement message
       @protocol.write_lines message.json
+      expect_acknowledgement message
       notify message
       log_send message, reason
     rescue EOFError, IOError
@@ -303,10 +308,11 @@ module RSMP
     end
 
     def should_validate_ingoing_message? message
-      return false unless @site_settings
+      return true unless @site_settings
       skip = @site_settings.dig('skip_validation')
-      return true unless skip && skip.include?(message.class.to_s)
-      false
+      return true unless skip
+      klass = message.class.name.split('::').last
+      !skip.include?(klass)
     end
 
     def process_packet json

data/lib/rsmp/site.rb

@@ -83,7 +83,7 @@ module RSMP
 
     def aggregated_status_changed component, options={}
       @proxies.each do |proxy|
-        proxy.send_aggregated_status component, options
+        proxy.send_aggregated_status component, options if proxy.ready?
       end
     end
 

data/lib/rsmp/site_proxy.rb

@@ -125,17 +125,11 @@ module RSMP
       se = message.attribute("se")
       validate_aggregated_status(message,se) == false
       c_id = message.attributes["cId"]
-      component = @components[c_id]
-      if component == nil
-        if @site_settings == nil || @site_settings['components'] == nil
-          component = build_component(id:c_id, type:nil)
-          @components[c_id] = component
-          log "Adding component #{c_id} to site #{@site_id}", level: :info
-        else
-          reason = "component #{c_id} not found"
-          dont_acknowledge message, "Ignoring #{message.type}:", reason
-          return
-        end
+      component = find_component c_id
+      unless component
+        reason = "component #{c_id} not found"
+        dont_acknowledge message, "Ignoring #{message.type}:", reason
+        return
       end
 
       component.set_aggregated_status_bools se
@@ -148,11 +142,17 @@ module RSMP
     end
 
     def process_alarm message
+      component = find_component message.attribute("cId")
+      status = ["ack","aS","sS"].map { |key| message.attribute(key) }.join(',')
+      component.handle_alarm message
       alarm_code = message.attribute("aCId")
       asp = message.attribute("aSp")
-      status = ["ack","aS","sS"].map { |key| message.attribute(key) }.join(',')
       log "Received #{message.type}, #{alarm_code} #{asp} [#{status}]", message: message, level: :log
       acknowledge message
+    rescue RSMP::RepeatedAlarmError => e
+      str = "Rejected #{message.type} message, "
+      dont_acknowledge message, str, "#{e}"
+      notify_error e.exception("#{str}#{e.message} #{message.json}")
     end
 
     def version_acknowledged
@@ -241,13 +241,8 @@ module RSMP
 
     def send_alarm_acknowledgement component, alarm_code, options={}
       message = RSMP::AlarmAcknowledged.new({
-          "ntsOId" => '',
-          "xNId" => '',
           "cId" => component,
           "aCId" => alarm_code,
-          "xACId" => '',
-          "xNACId" => '',
-          "aSp" => 'Acknowledge'
       })
       send_message message, validate: options[:validate]
       message

data/lib/rsmp/supervisor_proxy.rb

@@ -363,16 +363,6 @@ module RSMP
       end
     end
 
-    def send_alarm
-      message = Alarm.new({
-        "aSTS"=>clock.to_s,
-        "fP"=>nil,
-        "fS"=>nil,
-        "se"=>@site.aggregated_status_bools
-      })
-      send_message message
-    end
-
     def sxl_version
       @site_settings['sxl_version']
     end

data/lib/rsmp/tlc.rb

@@ -5,7 +5,7 @@ module RSMP
   class TrafficController < Component
     attr_reader :pos, :cycle_time
 
-    def initialize node:, id:, cycle_time:
+    def initialize node:, id:, cycle_time: 10
       super node: node, id: id, grouped: true
       @signal_groups = []
       @detector_logics = []
@@ -625,13 +625,15 @@ module RSMP
   class SignalGroup < Component
     attr_reader :plan, :state
 
-    def initialize node:, id:, plan:
+    # plan is a string, with each character representing a signal phase at a particular second  in the cycle
+    def initialize node:, id:, plan: nil
       super node: node, id: id, grouped: false
       @plan = plan
       move 0
     end
 
     def get_state pos
+      return 'a' unless @plan  # if no plan, use phase a, which means disabled/dark
       if pos > @plan.length
         '.'
       else

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.3.3"
+  VERSION = "0.3.7"
 end

data/lib/rsmp.rb

@@ -18,7 +18,6 @@ require 'rsmp/node'
 require 'rsmp/supervisor'
 require 'rsmp/components'
 require 'rsmp/notifier'
-
 require 'rsmp/listener'
 require 'rsmp/collector'
 require 'rsmp/matcher'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.7
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -203,7 +203,6 @@ files:
 - documentation/message_distribution.md
 - exe/rsmp
 - lib/rsmp.rb
-- lib/rsmp/alarm.rb
 - lib/rsmp/archive.rb
 - lib/rsmp/cli.rb
 - lib/rsmp/collector.rb
@@ -255,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.26
 signing_key:
 specification_version: 4
 summary: RoadSide Message Protocol (RSMP) library.

data/lib/rsmp/alarm.rb

@@ -1,15 +0,0 @@
-# RSMP Alarm. Manages the various states an alarm can be in.
-
-module RSMP
-  class Alarm
-
-    def initialize code: code, blocked: blocked=false, suspended: suspended=false, acknowledged: acknowledged=false
-      @code = code
-      @code = code
-      @blocked = blocked
-      @suspended = suspended
-      @acknowledged = acknowledged
-    end
-
-  end
-end