rsmp 0.8.3 → 0.9.0

data/lib/rsmp/tlc/traffic_controller.rb

@@ -5,9 +5,12 @@ module RSMP
     # and keeps track of signal plans, detector logics, inputs, etc. which do
     # not have dedicated components.
     class TrafficController < Component
-      attr_reader :pos, :cycle_time, :plan
+      attr_reader :pos, :cycle_time, :plan, :cycle_counter,
+        :yellow_flash, :dark_mode,
+        :startup_sequence_active, :startup_sequence, :startup_sequence_pos
 
-      def initialize node:, id:, cycle_time: 10, signal_plans:
+      def initialize node:, id:, cycle_time: 10, signal_plans:,
+          startup_sequence:, live_output:nil
         super node: node, id: id, grouped: true
         @signal_groups = []
         @detector_logics = []
@@ -15,31 +18,44 @@ module RSMP
         @cycle_time = cycle_time
         @num_traffic_situations = 1
         @num_inputs = 8
+        @startup_sequence = startup_sequence
+        @live_output = live_output
         reset
       end
 
-      def reset
-        @pos = 0
-        @plan = 0
-        @dark_mode = false
+      def reset_modes
+        @dark_mode = true
         @yellow_flash = false
         @booting = false
-        @control_mode = 'control'
-        @police_key = 0
-        @intersection = 0
         @is_starting = false
-        @emergency_route = false
-        @emergency_route_number = 0
-        @traffic_situation = 0
+        @control_mode = 'control'
         @manual_control = false
         @fixed_time_control = false
         @isolated_control = false
         @yellow_flash = false
         @all_red = false
+        @police_key = 0
+      end
+
+      def reset
+        reset_modes
+
+        @cycle_counter = 0
+        @plan = 1
+        @intersection = 0
+        @emergency_route = false
+        @emergency_route_number = 0
+        @traffic_situation = 0
 
         @inputs = '0'*@num_inputs
         @input_activations = '0'*@num_inputs
         @input_results = '0'*@num_inputs
+
+        @day_time_table = {}
+        @startup_sequence_active = false
+        @startup_sequence_initiated_at = nil
+        @startup_sequence_pos = 0
+        @time_int = nil
       end
 
       def clock
@@ -64,46 +80,100 @@ module RSMP
       end
 
       def timer now
-        # TODO
-        # We should use a monotone timer, to avoid jumps
-        # in case the user sets the system time
-        pos = Time.now.to_i % @cycle_time
-        if pos != @pos
-          @pos = pos
-          move pos
-        end
+        # TODO use monotone timer, to avoid jumps in case the user sets the system time
+        time = Time.now.to_i
+        return if time == @time_int
+        @time_int = time
+        move_cycle_counter
+        move_startup_sequence if @startup_sequence_active
+
+        @signal_groups.each { |group| group.timer }
+
+        output_states
+      end
+
+      def move_cycle_counter
+        counter = Time.now.to_i % @cycle_time
+        @cycle_counter = counter
       end
 
-      def move pos
-        @signal_groups.each do |group|
-          group.move pos
+      def startup_state
+        return unless @startup_sequence_active
+        return unless @startup_sequence_pos
+        @startup_sequence[ @startup_sequence_pos ]
+      end
+
+      def initiate_startup_sequence
+        log "Initiating startup sequence", level: :info
+        reset_modes
+        @dark_mode = false
+        @startup_sequence_active = true
+        @startup_sequence_initiated_at = nil
+        @startup_sequence_pos = nil
+      end
+
+      def end_startup_sequence
+        @startup_sequence_active = false
+        @startup_sequence_initiated_at = nil
+        @startup_sequence_pos = nil
+        @yellow_flash = false
+        @dark_mode = false
+      end
+
+      def move_startup_sequence
+        was = @startup_sequence_pos
+        if @startup_sequence_initiated_at == nil
+          @startup_sequence_initiated_at = Time.now.to_i + 1
+          @startup_sequence_pos = 0
+        else
+          @startup_sequence_pos = Time.now.to_i - @startup_sequence_initiated_at
+        end
+        if @startup_sequence_pos >= @startup_sequence.size
+          end_startup_sequence
         end
-        #output_states
       end
 
       def output_states
+        return unless @live_output
+
         str = @signal_groups.map do |group|
-          s = "#{group.c_id}:#{group.state}"
-          if group.state =~ /^[1-9]$/
+          state = group.state
+          s = "#{group.c_id}:#{state}"
+          if state =~ /^[1-9]$/
               s.colorize(:green)
-          elsif group.state =~ /^[NOP]$/
+          elsif state =~ /^[NOP]$/
             s.colorize(:yellow)
-          elsif group.state =~ /^[a]$/
-            s.colorize(color: :black)
+          elsif state =~ /^[ae]$/
+            s.colorize(:light_black)
+          elsif state =~ /^[f]$/
+            s.colorize(:yellow)
+          elsif state =~ /^[g]$/
+            s.colorize(:red)
           else
             s.colorize(:red)
           end
         end.join ' '
+
+        modes = '.'*9
+        modes[0] = 'B' if @booting
+        modes[1] = 'S' if @startup_sequence_active
+        modes[2] = 'D' if @dark_mode
+        modes[3] = 'Y' if @yellow_flash
+        modes[4] = 'M' if @manual_control
+        modes[5] = 'F' if @fixed_time_control
+        modes[6] = 'R' if @all_red
+        modes[7] = 'I' if @isolated_control
+        modes[8] = 'P' if @police_key != 0
+
         plan = "P#{@plan}"
-        print "#{plan.rjust(4)} #{pos.to_s.rjust(4)} #{str}\r"
+
+        File.open @live_output, 'w' do |file|
+          file.puts "#{modes}  #{plan.rjust(2)}  #{@cycle_counter.to_s.rjust(3)}  #{str}\r"
+        end
       end
 
       def format_signal_group_status
-        if @yellow_flash
-          'c' * @signal_groups.size
-        else
-          @signal_groups.map { |group| group.state }.join
-        end
+        @signal_groups.map { |group| group.state }.join
       end
 
       def handle_command command_code, arg
@@ -214,6 +284,18 @@ module RSMP
 
       def handle_m0017 arg
         @node.verify_security_code 2, arg['securityCode']
+        arg['status'].split(',').each do |item|
+          elems = item.split('-')
+          nr = elems[0].to_i
+          plan = elems[1].to_i
+          hour = elems[2].to_i
+          min = elems[3].to_i
+          if nr<0 || nr>12
+            raise InvalidMessage.new "time table id must be between 0 and 12, got #{nr}"
+          end
+          #p "nr: #{nr}, plan #{plan} at #{hour}:#{min}"
+          @day_time_table[nr] = {plan: plan, hour: hour, min:min}
+        end
       end
 
       def handle_m0018 arg
@@ -256,7 +338,7 @@ module RSMP
         return unless i>=0 && i<@num_inputs
         @inputs[i] = (arg['value'] ? '1' : '0')
       end
-      
+
       def set_fixed_time_control status
         @fixed_time_control = status
       end
@@ -276,6 +358,7 @@ module RSMP
         log "Switching to mode #{mode}", level: :info
         case mode
         when 'NormalControl'
+          initiate_startup_sequence if @yellow_flash || @dark_mode
           @yellow_flash = false
           @dark_mode = false
         when 'YellowFlash'
@@ -308,9 +391,9 @@ module RSMP
         when 'signalgroupstatus'
           TrafficControllerSite.make_status format_signal_group_status
         when 'cyclecounter'
-          TrafficControllerSite.make_status @pos.to_s
+          TrafficControllerSite.make_status @cycle_counter.to_s
         when 'basecyclecounter'
-          TrafficControllerSite.make_status @pos.to_s
+          TrafficControllerSite.make_status @cycle_counter.to_s
         when 'stage'
           TrafficControllerSite.make_status 0.to_s
         end
@@ -511,7 +594,10 @@ module RSMP
       def handle_s0027 status_code, status_name=nil
         case status_name
         when 'status'
-          TrafficControllerSite.make_status '00-00-00-00'
+          status = @day_time_table.map do |i,item|
+            "#{i}-#{item[:plan]}-#{item[:hour]}-#{item[:min]}"
+          end.join(',')
+          TrafficControllerSite.make_status status
         end
       end
 

data/lib/rsmp/tlc/traffic_controller_site.rb

@@ -5,14 +5,31 @@ module RSMP
       attr_accessor :main, :signal_plans
 
       def initialize options={}
+        # setup options before calling super initializer,
+        # since build of components depend on options
         @sxl = 'traffic_light_controller'
         @security_codes = options[: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].dig('signal_plans')
+
         super options
+
         unless @main
           raise ConfigurationError.new "TLC must have a main component"
         end
+
+      end
+
+      def start
+        super
+        start_tlc_timer
+        @main.initiate_startup_sequence
+      end
+
+      def stop_subtasks
+        stop_tlc_timer
+        super
       end
 
       def build_plans signal_plans
@@ -37,7 +54,9 @@ module RSMP
         when 'main'
           @main = TrafficController.new node: self, id: id,
             cycle_time: settings['cycle_time'],
-            signal_plans: @signal_plans
+            startup_sequence: @startup_sequence,
+            signal_plans: @signal_plans,
+            live_output: @site_settings['live_output']
         when 'signal_group'
           group = SignalGroup.new node: self, id: id
           @main.add_signal_group group
@@ -49,48 +68,45 @@ module RSMP
         end
       end
 
-      def start_action
-        super
-        start_timer
-      end
-
-      def start_timer
+      def start_tlc_timer
         task_name = "tlc timer"
         log "Starting #{task_name} with interval #{@interval} seconds", level: :debug
 
         @timer = @task.async do |task|
-          task.annotate task_name
-          next_time = Time.now.to_f
-          loop do
-            begin
-              timer(@clock.now)
-            rescue EOFError => e
-              log "Connection closed: #{e}", level: :warning
-            rescue IOError => e
-              log "IOError", level: :warning
-            rescue Errno::ECONNRESET
-              log "Connection reset by peer", level: :warning
-            rescue Errno::EPIPE => e
-              log "Broken pipe", level: :warning
-            rescue StandardError => e
-              notify_error e, level: :internal
-            ensure
-              # adjust sleep duration to avoid drift. so wake up always happens on the
-              # same fractional second.
-              # note that Time.now is not monotonic. If the clock is changed,
-              # either manaully or via NTP, the sleep interval might jump.
-              # an alternative is to use ::Process.clock_gettime(::Process::CLOCK_MONOTONIC),
-              # to get the current time. this ensures a constant interval, but
-              # if the clock is changed, the wake up would then happen on a different
-              # fractional second
-              next_time += @interval
-              duration = next_time - Time.now.to_f
-              task.sleep duration
-            end
+        task.annotate task_name
+          run_tlc_timer task
+        end
+      end
+
+      def run_tlc_timer task
+        next_time = Time.now.to_f
+        loop do
+          begin
+            timer(@clock.now)
+          rescue StandardError => e
+            notify_error e, level: :internal
+          ensure
+            # adjust sleep duration to avoid drift. so wake up always happens on the
+            # same fractional second.
+            # note that Time.now is not monotonic. If the clock is changed,
+            # either manaully or via NTP, the sleep interval might jump.
+            # an alternative is to use ::Process.clock_gettime(::Process::CLOCK_MONOTONIC),
+            # to get the current time. this ensures a constant interval, but
+            # if the clock is changed, the wake up would then happen on a different
+            # fractional second
+            next_time += @interval
+            duration = next_time - Time.now.to_f
+            task.sleep duration
           end
         end
       end
 
+      def stop_tlc_timer
+        return unless @timer
+        @timer.stop
+        @timer = nil
+      end
+
       def timer now
         return unless @main
         @main.timer now

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.8.3"
+  VERSION = "0.9.0"
 end

data/lib/rsmp.rb

@@ -10,10 +10,10 @@ require 'json_schemer'
 require 'async/queue'
 
 require 'rsmp/rsmp'
+require 'rsmp/task'
 require 'rsmp/deep_merge'
 require 'rsmp/inspect'
 require 'rsmp/logging'
-require 'rsmp/wait'
 require 'rsmp/node'
 require 'rsmp/supervisor'
 require 'rsmp/components'

data/rsmp.gemspec

@@ -31,16 +31,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "async", "~> 1.29.1"
-  spec.add_dependency "async-io", "~> 1.32.1"
+  spec.add_dependency "async-io", "~> 1.32.2"
   spec.add_dependency "colorize", "~> 0.8.1"
-  spec.add_dependency "thor", "~> 1.0.1"
+  spec.add_dependency "thor", "~> 1.2.1"
   spec.add_dependency "rsmp_schemer"
 
-  spec.add_development_dependency "bundler", "~> 2.2.21"
-  spec.add_development_dependency "rake", "~> 13.0.3"
+  spec.add_development_dependency "bundler", "~> 2.3.6"
+  spec.add_development_dependency "rake", "~> 13.0.6"
   spec.add_development_dependency "rspec", "~> 3.10.0"
-  spec.add_development_dependency "rspec-expectations", "~> 3.10.1"
+  spec.add_development_dependency "rspec-expectations", "~> 3.10.2"
   spec.add_development_dependency "timecop", "~> 0.9.4"
-  spec.add_development_dependency "cucumber", "~> 6.1.0"
-  spec.add_development_dependency "aruba" , "~> 1.1.2"
+  spec.add_development_dependency "cucumber", "~> 7.1.0"
+  spec.add_development_dependency "aruba" , "~> 2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.32.1
+        version: 1.32.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.32.1
+        version: 1.32.2
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: rsmp_schemer
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.21
+        version: 2.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.21
+        version: 2.3.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.1
+        version: 3.10.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.1
+        version: 3.10.2
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -156,28 +156,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 7.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 2.0.0
 description: Easy RSMP site and supervisor communication.
 email:
 - zf0f@kk.dk
@@ -186,6 +186,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yaml"
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
@@ -203,6 +204,7 @@ files:
 - documentation/classes_and_modules.md
 - documentation/collecting_message.md
 - documentation/message_distribution.md
+- documentation/tasks.md
 - exe/rsmp
 - lib/rsmp.rb
 - lib/rsmp/archive.rb
@@ -234,18 +236,16 @@ files:
 - lib/rsmp/rsmp.rb
 - lib/rsmp/site.rb
 - lib/rsmp/site_proxy.rb
-- lib/rsmp/site_proxy_wait.rb
 - lib/rsmp/supervisor.rb
 - lib/rsmp/supervisor_proxy.rb
+- lib/rsmp/task.rb
 - lib/rsmp/tlc/detector_logic.rb
 - lib/rsmp/tlc/signal_group.rb
 - lib/rsmp/tlc/signal_plan.rb
 - lib/rsmp/tlc/traffic_controller.rb
 - lib/rsmp/tlc/traffic_controller_site.rb
 - lib/rsmp/version.rb
-- lib/rsmp/wait.rb
 - rsmp.gemspec
-- test.rb
 homepage: https://github.com/rsmp-nordic/rsmp
 licenses:
 - MIT
@@ -269,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: RoadSide Message Protocol (RSMP) library.

data/lib/rsmp/wait.rb

@@ -1,16 +0,0 @@
-module RSMP
-  module Wait
-    # wait for an async condition to signal, then yield to block
-    # if block returns true we're done. otherwise, wait again
-    def wait_for condition, timeout, &block
-      raise RuntimeError.new("Can't wait for condition because task is not running") unless @task.running?
-      @task.with_timeout(timeout) do
-        while @task.running? do
-          value = condition.wait
-          result = yield value 
-          return result if result   # return result of check, if not nil
-        end
-      end
-    end   
-  end
-end

data/test.rb

@@ -1,27 +0,0 @@
-class A
-	def go &block
-		@block = block			# block will be converted automatically to a Proc
-		indirect
-	end
-
-	def call
-		@block.call
-	end
-
-	def indirect
-		call
-	end
-
-end
-
-a = A.new
-
-a.go do
-	break		# this is ok. break causes the block to exit, and the encasing method to return - go() will exit
-end
-
-# this raises an error. the block we passed to go() will be called again, and it tries to break
-# but we're not inside a method we can exit from
-
-
-a.indirect