rsmp 0.1.17 → 0.1.30

data/lib/rsmp/tlc.rb

@@ -4,13 +4,20 @@ module RSMP
 
   class TrafficController < Component
     attr_reader :pos, :cycle_time
+
     def initialize node:, id:, cycle_time:
       super node: node, id: id, grouped: true
       @signal_groups = []
       @detector_logics = []
       @plans = []
-      @pos = 0
       @cycle_time = cycle_time
+      @num_traffic_situations = 1
+      @num_inputs = 8
+      reset
+    end
+
+    def reset
+      @pos = 0
       @plan = 0
       @dark_mode = false
       @yellow_flash = false
@@ -22,19 +29,22 @@ module RSMP
       @emergency_route = false
       @emergency_route_number = 0
       @traffic_situation = 0
-      @num_traffic_situations = 1
       @manual_control = false
       @fixed_time_control = false
       @isolated_control = false
       @yellow_flash = false
       @all_red = false
 
-      @num_inputs = 8
       @inputs = '0'*@num_inputs
       @input_activations = '0'*@num_inputs
       @input_results = '0'*@num_inputs
     end
 
+    def clock
+      node.clock
+    end
+
+
     def add_signal_group group
       @signal_groups << group
     end
@@ -42,8 +52,12 @@ module RSMP
     def add_detector_logic logic
       @detector_logics << logic
     end
+
     def timer now
-      pos = now.to_i % @cycle_time
+      # 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
@@ -74,37 +88,33 @@ module RSMP
     end
 
     def format_signal_group_status
-      @signal_groups.map { |group| group.state }.join
+      if @yellow_flash
+        'c' * @signal_groups.size
+      else
+        @signal_groups.map { |group| group.state }.join
+      end
     end
 
     def handle_command command_code, arg
       case command_code
-      when 'M0001'
-        handle_m0001 arg
-      when 'M0002'
-        handle_m0002 arg
-      when 'M0003'
-        handle_m0003 arg
-      when 'M0004'
-        handle_m0004 arg
-      when 'M0005'
-        handle_m0005 arg
-      when 'M0006'
-        handle_m0006 arg
-      when 'M0007'
-        handle_m0007 arg
+      when 'M0001', 'M0002', 'M0003', 'M0004', 'M0005', 'M0006', 'M0007',
+           'M0012', 'M0013', 'M0014', 'M0015', 'M0016', 'M0017', 'M0018',
+           'M0019', 'M0020', 'M0021', 'M0022',
+           'M0103', 'M0104'
+
+        return send("handle_#{command_code.downcase}", arg)
       else
         raise UnknownCommand.new "Unknown command #{command_code}"
       end
     end
 
     def handle_m0001 arg
-      @node.verify_security_code arg['securityCode']
+      @node.verify_security_code 2, arg['securityCode']
       switch_mode arg['status']
     end
 
     def handle_m0002 arg
-      @node.verify_security_code arg['securityCode']
+      @node.verify_security_code 2, arg['securityCode']
       if RSMP::Tlc.from_rsmp_bool(arg['status'])
         switch_plan arg['timeplan']
       else
@@ -113,32 +123,108 @@ module RSMP
     end
 
     def handle_m0003 arg
-      @node.verify_security_code arg['securityCode']
+      @node.verify_security_code 2, arg['securityCode']
       @traffic_situation = arg['traficsituation'].to_i
     end
 
     def handle_m0004 arg
-      @node.verify_security_code arg['securityCode']
-      # restarting the node means we will disconnect and reconnect.
-      # note that this will happen immediately, and no
-      # command response will therefore be sent
-      log "Restarting TLC", level: :info
-      @node.restart
+      @node.verify_security_code 2, arg['securityCode']
+      # don't restart immeediately, since we need to first send command response
+      # instead, defer an action, which will be handled by the TLC site
+      log "Sheduling restart of TLC", level: :info
+      @node.defer :restart
     end
 
     def handle_m0005 arg
-      @node.verify_security_code arg['securityCode']
-      @emergency_route = arg['status'] == 'True'
+      @node.verify_security_code 2, arg['securityCode']
+      @emergency_route = (arg['status'] == 'True')
       @emergency_route_number = arg['emergencyroute'].to_i
+
+      if @emergency_route
+        log "Switching to emergency route #{@emergency_route_number}", level: :info
+      else
+        log "Switching off emergency route", level: :info
+      end
     end
 
     def handle_m0006 arg
-      @node.verify_security_code arg['securityCode']
+      @node.verify_security_code 2, arg['securityCode']
       input = arg['input'].to_i
-      return unless input>=0 && input<@num_inputs
-      @input_activations[input] = (arg['status']=='True' ? '1' : '0')
-      result = @input_activations[input]=='1' || @inputs[input]=='1'
-      @input_results[input] = (result ? '1' : '0')
+      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')
+      if @input_activations[idx]
+        log "Activate input #{idx}", level: :info
+      else
+        log "Deactivate input #{idx}", level: :info
+      end
+    end
+
+    def handle_m0007 arg
+      @node.verify_security_code 2, arg['securityCode']
+      set_fixed_time_control arg['status']
+    end
+
+    def handle_m0012 arg
+      @node.verify_security_code 2, arg['securityCode']
+    end
+
+    def handle_m0013 arg
+      @node.verify_security_code 2, arg['securityCode']
+    end
+
+    def handle_m0014 arg
+      @node.verify_security_code 2, arg['securityCode']
+    end
+
+    def handle_m0015 arg
+      @node.verify_security_code 2, arg['securityCode']
+    end
+
+    def handle_m0016 arg
+      @node.verify_security_code 2, arg['securityCode']
+    end
+
+    def handle_m0017 arg
+      @node.verify_security_code 2, arg['securityCode']
+    end
+
+    def handle_m0018 arg
+      @node.verify_security_code 2, arg['securityCode']
+    end
+
+    def handle_m0019 arg
+      @node.verify_security_code 2, arg['securityCode']
+    end
+
+    def handle_m0020 arg
+      @node.verify_security_code 2, arg['securityCode']
+    end
+
+    def handle_m0021 arg
+      @node.verify_security_code 2, arg['securityCode']
+    end
+
+    def handle_m0103 arg
+      level = {'Level1'=>1,'Level2'=>2}[arg['status']]
+      @node.change_security_code level, arg['oldSecurityCode'], arg['newSecurityCode']
+    end
+
+    def handle_m0104 arg
+      @node.verify_security_code 1, arg['securityCode']
+      time = Time.new(
+        arg['year'],
+        arg['month'],
+        arg['day'],
+        arg['hour'],
+        arg['minute'],
+        arg['second'],
+        'UTC'
+      )
+      @node.clock.set time
+      log "Clock set to #{time}, (adjustment is #{@node.clock.adjustment}s)", level: :info
     end
 
     def set_input i, value
@@ -146,18 +232,18 @@ module RSMP
       @inputs[i] = (arg['value'] ? '1' : '0')
     end
     
-    def handle_m0007 arg
-      @node.verify_security_code arg['securityCode']
-      set_fixed_time_control arg['status']
-    end
-
     def set_fixed_time_control status
       @fixed_time_control = status
     end
 
     def switch_plan plan
-      log "Switching to plan #{plan}", level: :info
-      @plan = plan.to_i
+      plan_nr = plan.to_i
+      if plan_nr == 0
+        log "Switching to plan selection by time table", level: :info
+      else
+        log "Switching to plan #{plan_nr}", level: :info
+      end
+      @plan = plan_nr
     end
 
     def switch_mode mode
@@ -182,8 +268,8 @@ module RSMP
            'S0008', 'S0009', 'S0010', 'S0011', 'S0012', 'S0013', 'S0014',
            'S0015', 'S0016', 'S0017', 'S0018', 'S0019', 'S0020', 'S0021',
            'S0022', 'S0023', 'S0024', 'S0026', 'S0027', 'S0028',
-           'S0029',
-           'S0091', 'S0092', 'S0095', 'S0096',
+           'S0029', 'S0030', 'S0031',
+           'S0091', 'S0092', 'S0095', 'S0096', 'S0097',
            'S0205', 'S0206', 'S0207', 'S0208'
         return send("handle_#{code.downcase}", code, name)
       else
@@ -194,7 +280,7 @@ module RSMP
     def handle_s0001 status_code, status_name=nil
       case status_name
       when 'signalgroupstatus'
-        return RSMP::Tlc.make_status format_signal_group_status
+        RSMP::Tlc.make_status format_signal_group_status
       when 'cyclecounter'
         RSMP::Tlc.make_status @pos.to_s
       when 'basecyclecounter'
@@ -415,6 +501,20 @@ module RSMP
       end
     end
 
+    def handle_s0030 status_code, status_name=nil
+      case status_name
+      when 'status'
+        RSMP::Tlc.make_status ''
+      end
+    end
+
+    def handle_s0031 status_code, status_name=nil
+      case status_name
+      when 'status'
+        RSMP::Tlc.make_status ''
+      end
+    end
+
     def handle_s0091 status_code, status_name=nil
       case status_name
       when 'user'
@@ -441,26 +541,37 @@ module RSMP
     end
 
     def handle_s0096 status_code, status_name=nil
+      now = clock.now
       case status_name
       when 'year'
-        RSMP::Tlc.make_status RSMP.now_object.year.to_s.rjust(4, "0")
+        RSMP::Tlc.make_status now.year.to_s.rjust(4, "0")
       when 'month'
-        RSMP::Tlc.make_status RSMP.now_object.month.to_s.rjust(2, "0")
+        RSMP::Tlc.make_status now.month.to_s.rjust(2, "0")
       when 'day'
-        RSMP::Tlc.make_status RSMP.now_object.day.to_s.rjust(2, "0")
+        RSMP::Tlc.make_status now.day.to_s.rjust(2, "0")
       when 'hour'
-        RSMP::Tlc.make_status RSMP.now_object.hour.to_s.rjust(2, "0")
+        RSMP::Tlc.make_status now.hour.to_s.rjust(2, "0")
       when 'minute'
-        RSMP::Tlc.make_status RSMP.now_object.min.to_s.rjust(2, "0")
+        RSMP::Tlc.make_status now.min.to_s.rjust(2, "0")
       when 'second'
-        RSMP::Tlc.make_status RSMP.now_object.sec.to_s.rjust(2, "0")
+        RSMP::Tlc.make_status now.sec.to_s.rjust(2, "0")
+      end
+    end
+
+    def handle_s0097 status_code, status_name=nil
+      case status_name
+      when 'checksum'
+        RSMP::Tlc.make_status '1'
+      when 'timestamp'
+        now = @node.clock.to_s
+        RSMP::Tlc.make_status now
       end
     end
 
     def handle_s0205 status_code, status_name=nil
       case status_name
       when 'start'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status clock.to_s
       when 'vehicles'
         RSMP::Tlc.make_status 0
       end
@@ -469,7 +580,7 @@ module RSMP
     def handle_s0206 status_code, status_name=nil
       case status_name
       when 'start'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status clock.to_s
       when 'speed'
         RSMP::Tlc.make_status 0
       end
@@ -478,7 +589,7 @@ module RSMP
     def handle_s0207 status_code, status_name=nil
       case status_name
       when 'start'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status clock.to_s
       when 'occupancy'
         RSMP::Tlc.make_status 0
       end
@@ -487,7 +598,7 @@ module RSMP
     def handle_s0208 status_code, status_name=nil
       case status_name
       when 'start'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status clock.to_s
       when 'P'
         RSMP::Tlc.make_status 0
       when 'PS'
@@ -532,6 +643,31 @@ module RSMP
       @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 RSMP::Tlc.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 RSMP::Tlc.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'
@@ -542,21 +678,22 @@ module RSMP
     end
 
     def handle_s0025 status_code, status_name=nil
+      now = @node.clock.to_s
       case status_name
       when 'minToGEstimate'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status now
       when 'maxToGEstimate'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status now
       when 'likelyToGEstimate'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status now
       when 'ToGConfidence'
         RSMP::Tlc.make_status 0
       when 'minToREstimate'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status now
       when 'maxToREstimate'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status now
       when 'likelyToREstimate'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status now
       when 'ToRConfidence'
         RSMP::Tlc.make_status 0
       end
@@ -584,7 +721,7 @@ module RSMP
     def handle_s0201 status_code, status_name=nil
       case status_name
       when 'starttime'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status @node.clock.to_s
       when 'vehicles'
         RSMP::Tlc.make_status 0
       end
@@ -593,7 +730,7 @@ module RSMP
     def handle_s0202 status_code, status_name=nil
       case status_name
       when 'starttime'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status @node.clock.to_s
       when 'speed'
         RSMP::Tlc.make_status 0
       end
@@ -602,7 +739,7 @@ module RSMP
     def handle_s0203 status_code, status_name=nil
       case status_name
       when 'starttime'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status @node.clock.to_s
       when 'occupancy'
         RSMP::Tlc.make_status 0
       end
@@ -611,7 +748,7 @@ module RSMP
     def handle_s0204 status_code, status_name=nil
       case status_name
       when 'starttime'
-        RSMP::Tlc.make_status RSMP.now_string
+        RSMP::Tlc.make_status @node.clock.to_s
       when 'P'
         RSMP::Tlc.make_status 0
       when 'PS'
@@ -643,7 +780,7 @@ module RSMP
     end
 
     def handle_m0008 arg
-      @node.verify_security_code arg['securityCode']
+      @node.verify_security_code 2, arg['securityCode']
       force_detector_logic arg['status']=='True', arg['value']='True'
       arg
     end
@@ -656,11 +793,12 @@ module RSMP
   end
 
   class Tlc < Site
+    attr_accessor :main
     def initialize options={}
       super options
-
       @sxl = 'traffic_light_controller'
-
+      @security_codes = options[:site_settings]['security_codes']
+      @interval = options[:site_settings]['interval'] || 1
       unless @main
         raise ConfigurationError.new "TLC must have a main component"
       end
@@ -687,31 +825,38 @@ module RSMP
     end
 
     def start_timer
-      name = "tlc timer"
-      interval = 1 #@settings["timer_interval"] || 1
-      log "Starting #{name} with interval #{interval} seconds", level: :debug
+      task_name = "tlc timer"
+      log "Starting #{task_name} with interval #{@interval} seconds", level: :debug
 
       @timer = @task.async do |task|
-        task.annotate "timer"
+        task.annotate task_name
         next_time = Time.now.to_f
         loop do
-          now = RSMP.now_object
-          break if timer(now) == false
-        rescue StandardError => e
-          log ["#{name} exception: #{e}",e.backtrace].flatten.join("\n"), level: :error
-        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 si 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
+          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
         end
       end
     end
@@ -721,7 +866,16 @@ module RSMP
       @main.timer now
     end
 
-    def verify_security_code code
+    def verify_security_code level, code
+      raise ArgumentError.new("Level must be 1-2, got #{level}") unless (1..2).include?(level)
+      if @security_codes[level] != code
+        raise MessageRejected.new("Wrong security code for level #{level}")
+      end
+    end
+
+    def change_security_code level, old_code, new_code
+      verify_security_code level, old_code
+      @security_codes[level] = new_code
     end
 
     def self.to_rmsp_bool bool
@@ -745,5 +899,13 @@ module RSMP
       end
     end
 
+    def do_deferred item
+      case item
+      when :restart
+        log "Restarting TLC", level: :info
+        restart
+      end
+    end
+
   end
 end