rsmp 0.8.5 → 0.9.2

data/lib/rsmp/tlc/traffic_controller.rb

@@ -6,7 +6,7 @@ module RSMP
     # not have dedicated components.
     class TrafficController < Component
       attr_reader :pos, :cycle_time, :plan, :cycle_counter,
-        :yellow_flash, :dark_mode,
+        :functional_position,
         :startup_sequence_active, :startup_sequence, :startup_sequence_pos
 
       def initialize node:, id:, cycle_time: 10, signal_plans:,
@@ -23,27 +23,35 @@ module RSMP
         reset
       end
 
-      def reset
-        @cycle_counter = 0
-        @plan = 1
-        @dark_mode = true
-        @yellow_flash = false
+      def reset_modes
+        @function_position = 'NormalControl'
+        @previous_functional_position = nil
+        @functional_position_timeout = nil
+
         @booting = false
+        @is_starting = false
         @control_mode = 'control'
+        @manual_control = false
+        @fixed_time_control = false
+        @isolated_control = false
+        @all_red = false
         @police_key = 0
+      end
+
+      def reset
+        reset_modes
+
+        @cycle_counter = 0
+        @plan = 1
         @intersection = 0
-        @is_starting = false
         @emergency_route = false
         @emergency_route_number = 0
         @traffic_situation = 0
-        @manual_control = false
-        @fixed_time_control = false
-        @isolated_control = false
-        @yellow_flash = false
-        @all_red = false
 
         @inputs = '0'*@num_inputs
         @input_activations = '0'*@num_inputs
+        @input_forced = '0'*@num_inputs
+        @input_forced_values = '0'*@num_inputs
         @input_results = '0'*@num_inputs
 
         @day_time_table = {}
@@ -53,6 +61,18 @@ module RSMP
         @time_int = nil
       end
 
+      def dark?
+        @function_position == 'Dark'
+      end
+
+      def yellow_flash?
+        @function_position == 'YellowFlash'
+      end
+
+      def normal_control?
+        @function_position == 'NormalControl'
+      end
+
       def clock
         node.clock
       end
@@ -76,12 +96,15 @@ module RSMP
 
       def timer now
         # TODO use monotone timer, to avoid jumps in case the user sets the system time
-        @signal_groups.each { |group| group.timer }
         time = Time.now.to_i
         return if time == @time_int
         @time_int = time
         move_cycle_counter
+        check_functional_position_timeout
         move_startup_sequence if @startup_sequence_active
+
+        @signal_groups.each { |group| group.timer }
+
         output_states
       end
 
@@ -90,6 +113,15 @@ module RSMP
         @cycle_counter = counter
       end
 
+      def check_functional_position_timeout
+        return unless @functional_position_timeout
+        if clock.now >= @functional_position_timeout
+          switch_functional_position @previous_functional_position, reverting: true
+          @functional_position_timeout = nil
+          @previous_functional_position = nil
+        end
+      end
+
       def startup_state
         return unless @startup_sequence_active
         return unless @startup_sequence_pos
@@ -98,6 +130,7 @@ module RSMP
 
       def initiate_startup_sequence
         log "Initiating startup sequence", level: :info
+        reset_modes
         @startup_sequence_active = true
         @startup_sequence_initiated_at = nil
         @startup_sequence_pos = nil
@@ -107,9 +140,6 @@ module RSMP
         @startup_sequence_active = false
         @startup_sequence_initiated_at = nil
         @startup_sequence_pos = nil
-
-        @yellow_flash = false
-        @dark_mode = false
       end
 
       def move_startup_sequence
@@ -127,26 +157,45 @@ module RSMP
 
       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 =~ /^[ae]$/
-            s.colorize(:black)
-          elsif group.state =~ /^[f]$/
+          elsif state =~ /^[ae]$/
+            s.colorize(:light_black)
+          elsif state =~ /^[f]$/
             s.colorize(:yellow)
-          elsif group.state =~ /^[g]$/
+          elsif state =~ /^[g]$/
             s.colorize(:red)
           else
             s.colorize(:red)
           end
         end.join ' '
+
+        modes = '.'*9
+        modes[0] = 'N' if @function_position == 'NormalControl'
+        modes[1] = 'Y' if @function_position == 'YellowFlash'
+        modes[2] = 'D' if @function_position == 'Dark'
+        modes[3] = 'B' if @booting
+        modes[4] = 'S' if @startup_sequence_active
+        modes[5] = 'M' if @manual_control
+        modes[6] = 'F' if @fixed_time_control
+        modes[7] = 'R' if @all_red
+        modes[8] = 'I' if @isolated_control
+        modes[9] = 'P' if @police_key != 0
+
         plan = "P#{@plan}"
 
+        # create folders if needed
+        FileUtils.mkdir_p File.dirname(@live_output)
+
+        # append a line with the current state to the file
         File.open @live_output, 'w' do |file|
-          file.puts "#{plan.rjust(4)} #{pos.to_s.rjust(4)} #{str}\r"
+          file.puts "#{modes}  #{plan.rjust(2)}  #{@cycle_counter.to_s.rjust(3)}  #{str}\r"
         end
       end
 
@@ -169,7 +218,7 @@ module RSMP
 
       def handle_m0001 arg
         @node.verify_security_code 2, arg['securityCode']
-        switch_mode arg['status']
+        switch_functional_position arg['status'], timeout: arg['timeout'].to_i*60
       end
 
       def handle_m0002 arg
@@ -206,18 +255,27 @@ module RSMP
         end
       end
 
+      def recompute_input idx
+        if @input_forced[idx] == '1'
+          @input_results[idx] = @input_forced_values[idx]
+        elsif @input_activations[idx]=='1'
+          @input_results[idx] = '1'
+        else
+          @input_results[idx] = bool_to_digit( @inputs[idx]=='1' )
+        end
+      end
+
       def handle_m0006 arg
         @node.verify_security_code 2, arg['securityCode']
         input = arg['input'].to_i
         idx = input - 1
         return unless idx>=0 && input<@num_inputs # TODO should NotAck
-        @input_activations[idx] = (arg['status']=='True' ? '1' : '0')
-        result = @input_activations[idx]=='1' || @inputs[idx]=='1'
-        @input_results[idx] = (result ? '1' : '0')
+        @input_activations[idx] = bool_string_to_digit arg['status']
+        recompute_input idx
         if @input_activations[idx]
-          log "Activate input #{idx}", level: :info
+          log "Activating input #{idx+1}", level: :info
         else
-          log "Deactivate input #{idx}", level: :info
+          log "Deactivating input #{idx+1}", level: :info
         end
       end
 
@@ -280,8 +338,39 @@ module RSMP
         @node.verify_security_code 2, arg['securityCode']
       end
 
+      def bool_string_to_digit bool
+        case bool
+          when 'True'
+            '1'
+          when 'False'
+            '0'
+          else
+            raise RSMP::MessageRejected.new "Invalid boolean '#{bool}', must be 'True' or 'False'"
+        end
+      end
+
+      def bool_to_digit bool
+        bool ?  '1' : '0'
+      end
+
       def handle_m0019 arg
         @node.verify_security_code 2, arg['securityCode']
+        input = arg['input'].to_i
+        idx = input - 1
+        unless idx>=0 && input<@num_inputs # TODO should NotAck
+          log "Can't force input #{idx+1}, only have #{@num_inputs} inputs", level: :warning
+          return
+        end
+        @input_forced[idx] = bool_string_to_digit arg['status']
+        if @input_forced[idx]
+          @input_forced_values[idx] = bool_string_to_digit arg['inputValue']
+        end
+        recompute_input idx
+        if @input_forced[idx]
+          log "Forcing input #{idx+1} to #{@input_forced_values[idx]}, #{@input_results}", level: :info
+        else
+          log "Releasing input #{idx+1}", level: :info
+        end
       end
 
       def handle_m0020 arg
@@ -308,15 +397,15 @@ module RSMP
           arg['second'],
           'UTC'
         )
-        @node.clock.set time
-        log "Clock set to #{time}, (adjustment is #{@node.clock.adjustment}s)", level: :info
+        clock.set time
+        log "Clock set to #{time}, (adjustment is #{clock.adjustment}s)", level: :info
       end
 
       def set_input i, value
         return unless i>=0 && i<@num_inputs
-        @inputs[i] = (arg['value'] ? '1' : '0')
+        @inputs[i] = bool_to_digit arg['value']
       end
-      
+
       def set_fixed_time_control status
         @fixed_time_control = status
       end
@@ -332,20 +421,24 @@ module RSMP
         @plan = plan_nr
       end
 
-      def switch_mode mode
-        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'
-          @yellow_flash = true
-          @dark_mode = false
-        when 'Dark'
-          @yellow_flash = false
-          @dark_mode = true
+      def switch_functional_position mode, timeout: nil, reverting: false
+        unless ['NormalControl','YellowFlash','Dark'].include? mode
+          raise RSMP::MessageRejected.new "Invalid functional position '#{mode}', must be NormalControl, YellowFlash or Dark'"
         end
+        if reverting
+          log "Reverting to functional position #{mode} after timeout", level: :info
+        elsif timeout && timeout > 0
+          log "Switching to functional position #{mode} with timeout #{timeout}min", level: :info
+          @previous_functional_position = @function_position
+          now = clock.now
+          @functional_position_timeout = now + timeout
+        else
+          log "Switching to functional position #{mode}", level: :info
+        end 
+        if mode == 'NormalControl'
+          initiate_startup_sequence if @function_position != 'NormalControl'
+        end
+        @function_position = mode
         mode
       end
 
@@ -380,7 +473,7 @@ module RSMP
       def handle_s0002 status_code, status_name=nil
         case status_name
         when 'detectorlogicstatus'
-          TrafficControllerSite.make_status @detector_logics.map { |dl| dl.value ? '1' : '0' }.join
+          TrafficControllerSite.make_status @detector_logics.map { |dl| bool_to_digit(dl.value) }.join
         end
       end
 
@@ -423,7 +516,7 @@ module RSMP
         when 'intersection'
           TrafficControllerSite.make_status @intersection
         when 'status'
-          TrafficControllerSite.make_status !@dark_mode
+          TrafficControllerSite.make_status @function_position != 'Dark'
         end
       end
 
@@ -459,7 +552,7 @@ module RSMP
         when 'intersection'
           TrafficControllerSite.make_status @intersection
         when 'status'
-          TrafficControllerSite.make_status @yellow_flash
+          TrafficControllerSite.make_status TrafficControllerSite.to_rmsp_bool( @function_position == 'YellowFlash' )
         end
       end
 
@@ -535,7 +628,7 @@ module RSMP
       def handle_s0021 status_code, status_name=nil
         case status_name
         when 'detectorlogics'
-          TrafficControllerSite.make_status @detector_logics.map { |logic| logic.forced=='True' ? '1' : '0'}.join
+          TrafficControllerSite.make_status @detector_logics.map { |logic| bool_to_digit(logic.forced)}.join
         end
       end
 
@@ -589,7 +682,7 @@ module RSMP
       def handle_s0029 status_code, status_name=nil
         case status_name
         when 'status'
-          TrafficControllerSite.make_status ''
+          TrafficControllerSite.make_status @input_forced
         end
       end
 
@@ -655,7 +748,7 @@ module RSMP
         when 'checksum'
           TrafficControllerSite.make_status '1'
         when 'timestamp'
-          now = @node.clock.to_s
+          now = clock.to_s
           TrafficControllerSite.make_status now
         end
       end

data/lib/rsmp/tlc/traffic_controller_site.rb

@@ -18,6 +18,18 @@ module RSMP
         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
@@ -56,49 +68,45 @@ module RSMP
         end
       end
 
-      def start_action
-        super
-        start_timer
-        @main.initiate_startup_sequence
-      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
@@ -142,7 +150,6 @@ module RSMP
         when :restart
           log "Restarting TLC", level: :info
           restart
-          initiate_startup_sequence
         end
       end
     end

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.8.5"
+  VERSION = "0.9.2"
 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.9.2
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -186,6 +186,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yaml"
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
@@ -200,9 +201,11 @@ files:
 - bin/setup
 - config/supervisor.yaml
 - config/tlc.yaml
+- cucumber.yml
 - 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 +237,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

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