rsmp 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4431d2545043cf60f1988e1bbb269e5727719fb6dd152c58908c5cd62b153ef
-  data.tar.gz: 4cb2c6fe95608ae4093876d2630e5a29547fdea1d6f66cdb697855e7a301470a
+  metadata.gz: c9a318474a865aca223c43e6bfe2bb2bf55a1e0a4584a7d28c80fc87295bc1f9
+  data.tar.gz: 64e892b4fe5b4dbd4aa910542634d82e9120f6c698eb57920c718657be200c1d
 SHA512:
-  metadata.gz: 0dcf33801ca97d92861380ed7ee4a4cb59a343eb0744daf448afbe20fa91e2147a8a59359420cd76dd62b1cbe49026b36e284d6534d8cd71538f68ea378e06c3
-  data.tar.gz: 59e10a8475fa23b0e0d66c257ee5458acb156db1390e88ae464a73b40b63bea3be7372304bd5d331fb0dfaaf19308c731d3aaae158de5d7f16ebe67bb17ddda3
+  metadata.gz: 0c9cada8fb00a82666968a656e6896f35942ef480d0ee0e5a442be38b25cc20b89460c6317e13b3087a2c2e7b70432bd8dd69d33a010cca13685f100fc4c0aed
+  data.tar.gz: 305d823c21f5de5f32fc143fdc5d7ad0e2c7947940fd4b261e6dd94b222c58657173cacf14c7a4aae59b263eebb1d5d7060d1b0645a99cd414a76cc8d65d55e0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.6.2)
+    rsmp (0.7.0)
       async (~> 1.29.1)
       async-io (~> 1.32.1)
       colorize (~> 0.8.1)
@@ -96,7 +96,7 @@ GEM
       thread_safe
     rake (13.0.3)
     regexp_parser (2.1.1)
-    rsmp_schemer (0.3.1)
+    rsmp_schemer (0.3.2)
       json_schemer (~> 0.2.18)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)

data/README.md

@@ -125,7 +125,7 @@ This will output messages form both the site and the supervisor, ordered chronol
 ```console
 RN+SU0001                              Starting supervisor RN+SU0001 on port 12111
 RN+SI0001                              Starting site RN+SI0001
-RN+SI0001                              Connecting to superviser at 127.0.0.1:12111
+RN+SI0001                              Connecting to supervisor at 127.0.0.1:12111
 RN+SI0001                   <--  f8c7  Sent Version
 RN+SU0001                              Site connected from 127.0.0.1:53500
 RN+SU0001     RN+SI0001     -->  f8c7  Received Version message for sites [RN+SI0001] using RSMP 3.1.4
@@ -156,7 +156,7 @@ The ```site``` command will start an RSMP site, which will try to connect to one
 ```console
 % rsmp site
 2019-11-11 12:22:00 UTC                            Starting site RN+SI0001
-2019-11-11 12:22:00 UTC                            Connecting to superviser at 127.0.0.1:12111
+2019-11-11 12:22:00 UTC                            Connecting to supervisor at 127.0.0.1:12111
 2019-11-11 12:22:00 UTC                 <--  792f  Sent Version
 2019-11-11 12:22:00 UTC  RN+SU0001      -->  e70e  Received Version message, using RSMP 3.1.4
 2019-11-11 12:22:00 UTC  RN+SU0001                 Connection to supervisor established

data/config/supervisor.yaml

@@ -8,18 +8,10 @@ guest:
     watchdog: 0.2
     acknowledgement: 0.2
 log:
-  active: true
-  color: true
-  timestamp: true
-  component: true
-  ip: false
   port: true
   site_id: 9
-  component_id: 3
-  text: true
+  component: 2
   direction: false
   level: false
   debug: true
   json: true
-  acknowledgements: false
-  watchdogs: false

data/config/tlc.yaml

@@ -10,15 +10,27 @@ components:
       cycle_time: 6
   signal_group:
     A1:
-      plan: '11NBBB'
     A2:
-      plan: '1NBBBB'
     B1:
-      plan: 'BBB11N'
     B2:
-      plan: 'BBB1NB'
   detector_logic:
     DL1:
+signal_plans:
+  1:
+    dynamic_bands:
+      1: 0
+      2: 5
+    states:
+      A1: '11NBBB'
+      A2: '1NBBBB'
+      B1: 'BBB11N'
+      B2: 'BBB1NB'
+  2:
+    states:
+      A1: '111NBB'
+      A2: '11NBBB'
+      B1: 'BBB11N'
+      B2: 'BBB1NB'
 intervals:
   timer: 0.1
   watchdog: 0.1
@@ -30,17 +42,9 @@ security_codes:
   1: '1111'
   2: '2222'
 log:
-  active: true
-  color: true
-  timestamp: true
-  component_id: true
   ip: false
   site_id: 9
-  component: 3
+  component: 2
   level: false
   debug: true
-  text: true
-  direction: false
   json: true
-  acknowledgements: false
-  watchdogs: false

data/lib/rsmp/archive.rb

@@ -21,7 +21,7 @@ module RSMP
     def self.prepare_item item
       raise ArgumentError unless item.is_a? Hash
     
-      cleaned = item.select { |k,v| [:author,:level,:ip,:port,:site_id,:component,:str,:message,:exception].include? k }
+      cleaned = item.select { |k,v| [:author,:level,:ip,:port,:site_id,:component,:text,:message,:exception].include? k }
       cleaned[:timestamp] = Clock.now
       if item[:message]
         cleaned[:direction] = item[:message].direction 

data/lib/rsmp/cli.rb

@@ -51,7 +51,7 @@ module RSMP
       if options[:type]
         case options[:type]
           when 'tlc'
-            site_class = RSMP::Tlc
+            site_class = RSMP::TLC::TrafficControllerSite
           else
             site_class = RSMP::Site
         end

data/lib/rsmp/component.rb

@@ -65,7 +65,8 @@ module RSMP
     end
 
     def log str, options
-      @node.log str, options
+      default = { component: c_id}
+      @node.log str, default.merge(options)
     end
 
     def handle_command command_code, arg
@@ -78,16 +79,17 @@ module RSMP
 
     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}")
+      previous = @alarms[code]
+      if previous
+        unless message.differ?(previous)
+          raise RepeatedAlarmError.new("no changes from previous alarm #{previous.m_id_short}")
+        end
+        if Time.parse(message.attribute('aTs')) < Time.parse(previous.attribute('aTs'))
+          raise RepeatedAlarmError.new("timestamp is earlier than previous alarm #{previous.m_id_short}")
         end
-      else
-        @alarms[code] = message
       end
+    ensure
+      @alarms[code] = message
     end
 
     # Handle an incoming status respone, by storing the values
@@ -118,7 +120,6 @@ module RSMP
         @statuses[sCI][n] ||= {}
         @statuses[sCI][n][:initial] = true
       end
-      #pp @subscribes
     end
 
     # Our proxy unsubscribed to status updates.

data/lib/rsmp/components.rb

@@ -52,7 +52,8 @@ module RSMP
         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
+        class_name << " compoent" unless class_name == 'Component'
+        log "Inferred #{class_name} #{component_id}", level: :debug
         component
       else
         raise UnknownComponent.new("Component #{component_id} not found") unless component

data/lib/rsmp/error.rb

@@ -64,4 +64,7 @@ module RSMP
 
 	class RepeatedStatusError < Error
 	end
+
+	class TimestampError < Error
+	end
 end

data/lib/rsmp/logger.rb

@@ -5,7 +5,7 @@ module RSMP
     
     def initialize settings={}
       defaults = {
-        'active'=>false,
+        'active'=>true,
         'path'=>nil,
         'stream'=>nil,
         'color'=>true,
@@ -13,6 +13,8 @@ module RSMP
         'statistics'=>false,
         'hide_ip_and_port' => false,
         'acknowledgements' => false,
+        'watchdogs' => false,
+        'alarms' => true,
         'json'=>false,
         'tabs'=>'-',
 
@@ -27,7 +29,7 @@ module RSMP
         'direction'=>false,
         'level'=>false,
         'id'=>true,
-        'str'=>true,
+        'text'=>true,
       }
 
       default_lengths = {
@@ -38,11 +40,20 @@ module RSMP
         'port'=>5,
         'site_id'=>19,
         'component'=>19,
-        'direction'=>4,
+        'direction'=>3,
         'level'=>7,
         'id'=>4,
       }
 
+      @ignorable = {
+        'versions' => ['Version'],
+        'statuses' => ['StatusRequest','StatusSubscribe','StatusUnsubscribe','StatusResponse','StatusUpdate'],
+        'commands' => ['CommandRequest','CommandResponse'],
+        'watchdogs' => 'Watchdog',
+        'alarms' => ['Alarm','AlarmRequest'],
+        'aggregated_status' => ['AggregatedStatus','AggregatedStatusRequest']
+      }
+
       if settings
         @settings = defaults.merge settings
       else
@@ -95,10 +106,15 @@ module RSMP
       if item[:message]
         type = item[:message].type
         ack = type == "MessageAck" || type == "MessageNotAck"
-        if @settings["watchdogs"] == false
-          return false if type == "Watchdog"
-          if ack
-            return false if item[:message].original && item[:message].original.type == "Watchdog"
+        @ignorable.each_pair do |key,types|
+          next unless types
+          ignore = [types].flatten
+          if @settings[key] == false
+            #p [type,ignore_type, [ignore_type].flatten.include?(type)]
+            return false if ignore.include?(type)
+            if ack
+              return false if item[:message].original && ignore.include?(item[:message].original.type)
+            end
           end
         end
         return false if ack && @settings["acknowledgements"] == false && 
@@ -190,14 +206,14 @@ module RSMP
       build_part( parts, item, :port )
       build_part( parts, item, :site_id )
       build_part( parts, item, :component )
-      build_part( parts, item, :direction ) { |part| {in:"-->",out:"<--"}[part] }
+      build_part( parts, item, :direction ) { |part| {in:"In",out:"Out"}[part] }
       build_part( parts, item, :level ) { |part| part.capitalize }
       build_part( parts, item, :id ) { Logger.shorten_message_id(item[:message].m_id,4) if item[:message] }
-      build_part( parts, item, :str )
+      build_part( parts, item, :text )
       build_part( parts, item, :json ) { item[:message].json if item[:message] }
       build_part( parts, item, :exception ) { |e| [e.class,e.backtrace].flatten.join("\n") }
 
-      parts.join('  ').chomp(@settings['tabs']).rstrip
+      parts.join('  ').chomp(@settings['tabs'].to_s).rstrip
     end
   end
 end

data/lib/rsmp/logging.rb

@@ -15,7 +15,7 @@ module RSMP
     end
 
     def log str, options={}
-      default = { str:str, level: :log, author: author, ip: @ip, port: @port }
+      default = { text:str, level: :log, author: author, ip: @ip, port: @port }
       prepared = RSMP::Archive.prepare_item default.merge(options)
       @archive.add prepared
       @logger.log prepared

data/lib/rsmp/message.rb

@@ -126,7 +126,7 @@ module RSMP
     end
 
     def initialize attributes = {}
-      @timestamp = Time.now   # this timestamp is for internal use, and does not the clock
+      @timestamp = Time.now   # this timestamp is for internal use, and does not use the clock
                               # in the node, which can be set by an rsmp supervisor
 
       @attributes = { "mType"=> "rSMsg" }.merge attributes

data/lib/rsmp/proxy.rb

@@ -348,20 +348,23 @@ module RSMP
       # cannot send NotAcknowledged for a malformed message since we can't read it, just ignore it
       nil
     rescue SchemaError, RSMP::Schemer::Error => e
-      str = "Received invalid #{message.type}, schema errors: #{e.message}"
+      reason = "schema errors: #{e.message}"
+      str = "Received invalid #{message.type}, #{reason}"
       log str, message: message, level: :warning
       notify_error e.exception(str), message: message
-      dont_acknowledge message, str
+      dont_acknowledge message, str, reason
       message
     rescue InvalidMessage => e
-      str = "Received", "invalid #{message.type}, #{e.message}"
+      reason = "#{e.message}"
+      str = "Received invalid #{message.type},"
       notify_error e.exception("#{str} #{message.json}"), message: message
-      dont_acknowledge message, str
+      dont_acknowledge message, str, reason
       message
     rescue FatalError => e
+      reason = e.message
       str = "Rejected #{message.type},"
       notify_error e.exception(str), message: message
-      dont_acknowledge message, str, "#{e.message}"
+      dont_acknowledge message, str, reason
       stop
       message
     ensure

data/lib/rsmp/supervisor_proxy.rb

@@ -23,15 +23,22 @@ module RSMP
     end
 
     def start
-      log "Connecting to superviser at #{@ip}:#{@port}", level: :info
+      log "Connecting to supervisor at #{@ip}:#{@port}", level: :info
       super
       connect
       @logger.unmute @ip, @port
-      log "Connected to superviser at #{@ip}:#{@port}", level: :info
+      log "Connected to supervisor at #{@ip}:#{@port}", level: :info
       start_reader
       send_version @site_settings['site_id'], @site_settings["rsmp_versions"]
-    rescue Errno::ECONNREFUSED
-      log "No connection to supervisor at #{@ip}:#{@port}", level: :error
+    rescue SystemCallError => e
+      log "Could not connect to supervisor at #{@ip}:#{@port}: Errno #{e.errno} #{e}", level: :error
+      retry_notice
+    rescue StandardError => e
+      log "Error while connecting to supervisor at #{@ip}:#{@port}: #{e}", level: :error
+      retry_notice
+    end
+
+    def retry_notice
       unless @site.site_settings['intervals']['reconnect'] == :no
         log "Will try to reconnect again every #{@site.site_settings['intervals']['reconnect']} seconds..", level: :info
         @logger.mute @ip, @port

data/lib/rsmp/tlc/detector_logic.rb

@@ -0,0 +1,101 @@
+module RSMP
+  module TLC
+    class DetectorLogic < Component
+      attr_reader :forced, :value
+
+      def initialize node:, id:
+        super node: node, id: id, grouped: false
+        @forced = 0
+        @value = 0
+      end
+
+      def get_status code, name=nil
+        case code
+        when 'S0201', 'S0202', 'S0203', 'S0204'
+          return send("handle_#{code.downcase}", code, name)
+        else
+          raise InvalidMessage.new "unknown status code #{code}"
+        end
+      end
+
+      def handle_s0201 status_code, status_name=nil
+        case status_name
+        when 'starttime'
+          TrafficControllerSite.make_status @node.clock.to_s
+        when 'vehicles'
+          TrafficControllerSite.make_status 0
+        end
+      end
+
+      def handle_s0202 status_code, status_name=nil
+        case status_name
+        when 'starttime'
+          TrafficControllerSite.make_status @node.clock.to_s
+        when 'speed'
+          TrafficControllerSite.make_status 0
+        end
+      end
+
+      def handle_s0203 status_code, status_name=nil
+        case status_name
+        when 'starttime'
+          TrafficControllerSite.make_status @node.clock.to_s
+        when 'occupancy'
+          TrafficControllerSite.make_status 0
+        end
+      end
+
+      def handle_s0204 status_code, status_name=nil
+        case status_name
+        when 'starttime'
+          TrafficControllerSite.make_status @node.clock.to_s
+        when 'P'
+          TrafficControllerSite.make_status 0
+        when 'PS'
+          TrafficControllerSite.make_status 0
+        when 'L'
+          TrafficControllerSite.make_status 0
+        when 'LS'
+          TrafficControllerSite.make_status 0
+        when 'B'
+          TrafficControllerSite.make_status 0
+        when 'SP'
+          TrafficControllerSite.make_status 0
+        when 'MC'
+          TrafficControllerSite.make_status 0
+        when 'C'
+          TrafficControllerSite.make_status 0
+        when 'F'
+          TrafficControllerSite.make_status 0
+        end
+      end
+
+      def handle_command command_code, arg
+        case command_code
+        when 'M0008'
+          handle_m0008 arg
+        else
+          raise UnknownCommand.new "Unknown command #{command_code}"
+        end
+      end
+
+      def handle_m0008 arg
+        @node.verify_security_code 2, arg['securityCode']
+        status = arg['status']=='True'
+        mode = arg['mode']=='True'
+        force_detector_logic status, mode
+        arg
+      end
+
+      def force_detector_logic forced, value
+        @forced = forced
+        @value = value
+        if @forced
+          log "Forcing to #{value}", level: :info
+        else
+          log "Releasing", level: :info
+        end
+      end
+    end
+  end
+end

data/lib/rsmp/tlc/signal_group.rb

@@ -0,0 +1,85 @@
+module RSMP
+  module TLC
+    class SignalGroup < Component
+      attr_reader :plan, :state
+
+      # plan is a string, with each character representing a signal phase at a particular second in the cycle
+      def initialize node:, id:
+        super node: node, id: id, grouped: false
+        move 0
+      end
+
+      def get_state pos
+        default = 'a'   # phase a means disabled/dark
+        plan = node.main.current_plan
+        return default unless plan
+        return default unless plan.states
+        states = plan.states[c_id]
+        return default unless states
+        state =states[pos]
+        return default unless state =~ /[a-hA-G0-9N-P]/  # valid signal group states
+        state
+      end
+
+      def move pos
+        @state = get_state pos
+      end
+
+      def handle_command command_code, arg
+        case command_code
+        when 'M0010', 'M0011'
+          return send("handle_#{command_code.downcase}", arg)
+        else
+          raise UnknownCommand.new "Unknown command #{command_code}"
+        end
+      end
+
+      # Start of signal group. Orders a signal group to green
+      def handle_m0010 arg
+        @node.verify_security_code 2, arg['securityCode']
+        if TrafficControllerSite.from_rsmp_bool arg['status']
+          log "Start signal group #{c_id}, go to green", level: :info
+        end
+      end
+
+      # Stop of signal group. Orders a signal group to red
+      def handle_m0011 arg
+        @node.verify_security_code 2, arg['securityCode']
+        if TrafficControllerSite.from_rsmp_bool arg['status']
+          log "Stop signal group #{c_id}, go to red", level: :info
+        end
+      end
+
+      def get_status code, name=nil
+        case code
+        when 'S0025'
+          return send("handle_#{code.downcase}", code, name)
+        else
+          raise InvalidMessage.new "unknown status code #{code}"
+        end
+      end
+
+      def handle_s0025 status_code, status_name=nil
+        now = @node.clock.to_s
+        case status_name
+        when 'minToGEstimate'
+          TrafficControllerSite.make_status now
+        when 'maxToGEstimate'
+          TrafficControllerSite.make_status now
+        when 'likelyToGEstimate'
+          TrafficControllerSite.make_status now
+        when 'ToGConfidence'
+          TrafficControllerSite.make_status 0
+        when 'minToREstimate'
+          TrafficControllerSite.make_status now
+        when 'maxToREstimate'
+          TrafficControllerSite.make_status now
+        when 'likelyToREstimate'
+          TrafficControllerSite.make_status now
+        when 'ToRConfidence'
+          TrafficControllerSite.make_status 0
+        end
+      end
+    end
+  end
+end

data/lib/rsmp/tlc/signal_plan.rb

@@ -0,0 +1,29 @@
+module RSMP
+  module TLC
+    # A Traffic Light Controller Signal Plan.
+    # A signal plan is a description of how all signal groups should change 
+    # state over time. 
+    class SignalPlan
+      attr_reader :nr, :states, :dynamic_bands
+      def initialize nr:, states:, dynamic_bands:
+        @nr = nr
+        @states = states
+        @dynamic_bands = dynamic_bands || {}
+      end
+
+      def dynamic_bands_string
+        str = @dynamic_bands.map { |band,value| "#{nr}-#{band}-#{value}" }.join(',')
+        return nil if str == ''
+        str
+      end
+
+      def set_band band, value
+        @dynamic_bands[ band.to_i ] = value.to_i
+      end
+
+      def get_band band
+        @dynamic_bands[ band.to_i ]
+      end
+    end
+  end
+end