rsmp 0.1.21 → 0.1.32

data/lib/rsmp/supervisor.rb

@@ -17,47 +17,57 @@ module RSMP
       @supervisor_settings['site_id']
     end
 
-    def handle_supervisor_settings options
-      @supervisor_settings = {
+    def handle_supervisor_settings options={}
+      defaults = {
         'port' => 12111,
-        'rsmp_versions' => ['3.1.1','3.1.2','3.1.3','3.1.4'],
-        'timer_interval' => 0.1,
-        'watchdog_interval' => 1,
-        'watchdog_timeout' => 2,
-        'acknowledgement_timeout' => 2,
-        'command_response_timeout' => 1,
-        'status_response_timeout' => 1,
-        'status_update_timeout' => 1,
-        'site_connect_timeout' => 2,
-        'site_ready_timeout' => 1,
-        'stop_after_first_session' => false,
-        'sites' => {
-          :any => {}
+        'ips' => 'all',
+        'guest' => {
+          'rsmp_versions' => 'all',
+          'sxl' => 'tlc',
+          'intervals' => {
+            'timer' => 1,
+            'watchdog' => 1
+          },
+          'timeouts' => {
+            'watchdog' => 2,
+            'acknowledgement' => 2
+          }
         }
       }
-      
-      if options[:supervisor_settings]
-        converted = options[:supervisor_settings].map { |k,v| [k.to_s,v] }.to_h   #convert symbol keys to string keys
-        converted.compact!
-        @supervisor_settings.merge! converted
-      end
-
-      required = [:port, :rsmp_versions, :watchdog_interval, :watchdog_timeout,
-                  :acknowledgement_timeout, :command_response_timeout]
-      check_required_settings @supervisor_settings, required
 
+      # merge options into defaults
+      @supervisor_settings = defaults.deep_merge(options[:supervisor_settings] || {})
       @rsmp_versions = @supervisor_settings["rsmp_versions"]
+      check_site_sxl_types
+    end
+
+    def check_site_sxl_types
+      sites = @supervisor_settings['sites'].clone || {}
+      sites['guest'] = @supervisor_settings['guest']
+      sites.each do |site_id,settings|
+        unless settings
+          raise RSMP::ConfigurationError.new("Configuration for site '#{site_id}' is empty")
+        end
+        sxl = settings['sxl']
+        sxl = 'tlc' unless sxl    # temporary fix until configs are updated
+        unless sxl
+          raise RSMP::ConfigurationError.new("Configuration error for site '#{site_id}': No SXL specified")
+        end
+        RSMP::Schemer.find_schemas! sxl if sxl
+      rescue RSMP::Schemer::UnknownSchemaError => e
+        raise RSMP::ConfigurationError.new("Configuration error for site '#{site_id}': #{e}")
+      end
     end
 
     def start_action
       @endpoint = Async::IO::Endpoint.tcp('0.0.0.0', @supervisor_settings["port"])
-      @endpoint.accept do |socket|
+      @endpoint.accept do |socket|  # creates async tasks
         handle_connection(socket)
+      rescue StandardError => e
+        notify_error e, level: :internal
       end
-    rescue SystemCallError => e # all ERRNO errors
-      log "Exception: #{e.to_s}", level: :error
     rescue StandardError => e
-      log ["Exception: #{e.inspect}",e.backtrace].flatten.join("\n"), level: :error
+      notify_error e, level: :internal
     end
 
     def stop
@@ -74,16 +84,18 @@ module RSMP
       remote_hostname = socket.remote_address.ip_address
       remote_ip = socket.remote_address.ip_address
 
-      info = {ip:remote_ip, port:remote_port, hostname:remote_hostname, now:RSMP.now_string()}
+      info = {ip:remote_ip, port:remote_port, hostname:remote_hostname, now:Clock.now}
       if accept? socket, info
         connect socket, info
       else
         reject socket, info
       end
-    rescue SystemCallError => e # all ERRNO errors
-      log "Exception: #{e.to_s}", level: :error
+    rescue ConnectionError => e
+      log "Rejected connection from #{remote_ip}:#{remote_port}, #{e.to_s}", level: :warning
+      notify_error e
     rescue StandardError => e
-      log "Exception: #{e}", exception: e, level: :error
+      log "Connection: #{e.to_s}", exception: e, level: :error
+      notify_error e, level: :internal
     ensure
       close socket, info
     end
@@ -91,7 +103,7 @@ module RSMP
     def starting
       log "Starting supervisor on port #{@supervisor_settings["port"]}", 
           level: :info,
-          timestamp: RSMP.now_object
+          timestamp: @clock.now
     end
 
     def accept? socket, info
@@ -110,18 +122,37 @@ module RSMP
       end
     end
 
+    def authorize_ip ip
+      return if @supervisor_settings['ips'] == 'all'
+      return if @supervisor_settings['ips'].include? ip
+      raise ConnectionError.new('guest ip not allowed')
+    end
+
+    def check_max_sites
+      max = @supervisor_settings['max_sites']
+      if max
+        if @proxies.size >= max
+          raise ConnectionError.new("maximum of #{max} sites already connected")
+        end
+      end
+    end
+
     def connect socket, info
       log "Site connected from #{format_ip_and_port(info)}",
           ip: info[:ip],
           port: info[:port],
           level: :info,
-          timestamp: RSMP.now_object
+          timestamp: Clock.now
+
+      authorize_ip info[:ip]
+      check_max_sites
 
-      settings = @supervisor_settings['sites'][info[:ip]] || @supervisor_settings['sites'][:any]
       proxy = build_proxy({
         supervisor: self,
+        ip: info[:ip],
+        port: info[:port],
         task: @task,
-        settings: settings,
+        settings: {'collect'=>@supervisor_settings['collect']},
         socket: socket,
         info: info,
         logger: @logger,
@@ -133,7 +164,7 @@ module RSMP
       @proxies.delete proxy
       site_ids_changed
 
-      stop if @supervisor_settings['stop_after_first_session']
+      stop if @supervisor_settings['one_shot']
     end
 
     def site_ids_changed
@@ -146,9 +177,9 @@ module RSMP
 
     def close socket, info
       if info
-        log "Connection to #{format_ip_and_port(info)} closed", ip: info[:ip], level: :info, timestamp: RSMP.now_object
+        log "Connection to #{format_ip_and_port(info)} closed", ip: info[:ip], level: :info, timestamp: Clock.now
       else
-        log "Connection closed", level: :info, timestamp: RSMP.now_object
+        log "Connection closed", level: :info, timestamp: Clock.now
       end
 
       socket.close
@@ -170,32 +201,36 @@ module RSMP
       return site if site
       wait_for(@site_id_condition,timeout) { find_site site_id }
     rescue Async::TimeoutError
-      nil
+      raise RSMP::TimeoutError.new "Site '#{site_id}' did not connect within #{timeout}s"
     end
 
     def wait_for_site_disconnect site_id, timeout
       wait_for(@site_id_condition,timeout) { true unless find_site site_id }
     rescue Async::TimeoutError
-      false
+      raise RSMP::TimeoutError.new "Site '#{site_id}' did not disconnect within #{timeout}s"
     end
 
     def check_site_id site_id
       check_site_already_connected site_id
-      return find_allowed_site_setting site_id
+      return site_id_to_site_setting site_id
     end
 
     def check_site_already_connected site_id
-      raise FatalError.new "Site #{site_id} already connected" if find_site(site_id)
+      raise FatalError.new "Site '#{site_id}' already connected" if find_site(site_id)
     end
 
-    def find_allowed_site_setting site_id
+    def site_id_to_site_setting site_id
       return {} unless @supervisor_settings['sites']
       @supervisor_settings['sites'].each_pair do |id,settings|
-        if id == :any || id == site_id
+        if id == 'guest' || id == site_id
           return settings
         end
       end
-      raise FatalError.new "site id #{site_id} rejected"
+      raise FatalError.new "site id #{site_id} unknown"
+    end
+
+    def ip_to_site_settings ip
+      @supervisor_settings['sites'][ip] || @supervisor_settings['sites']['guest']
     end
 
     def aggregated_status_changed site_proxy, component

data/lib/rsmp/supervisor_proxy.rb

@@ -32,8 +32,8 @@ module RSMP
       send_version @site_settings['site_id'], @site_settings["rsmp_versions"]
     rescue Errno::ECONNREFUSED
       log "No connection to supervisor at #{@ip}:#{@port}", level: :error
-      unless @site.site_settings["reconnect_interval"] == :no
-        log "Will try to reconnect again every #{@site.site_settings["reconnect_interval"]} seconds..", level: :info
+      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
       end
     end
@@ -49,12 +49,12 @@ module RSMP
       @endpoint = Async::IO::Endpoint.tcp(@ip, @port)
       @socket = @endpoint.connect
       @stream = Async::IO::Stream.new(@socket)
-      @protocol = Async::IO::Protocol::Line.new(@stream,RSMP::WRAPPING_DELIMITER) # rsmp messages are json terminated with a form-feed
+      @protocol = Async::IO::Protocol::Line.new(@stream,WRAPPING_DELIMITER) # rsmp messages are json terminated with a form-feed
     end
 
     def connection_complete
       super
-      log "Connection to supervisor established", level: :info
+      log "Connection to supervisor established, using core #{@rsmp_version}, #{sxl} #{sxl_version}", level: :info
       start_watchdog
     end
 
@@ -65,6 +65,8 @@ module RSMP
         when StatusUpdate
         when AggregatedStatus
           will_not_handle message
+        when AggregatedStatusRequest
+          process_aggregated_status_request message
         when CommandRequest
           process_command_request message
         when CommandResponse
@@ -108,7 +110,7 @@ module RSMP
     end
 
     def reconnect_delay
-      interval = @site_settings["reconnect_interval"]
+      interval = @site_settings['intervals']['reconnect']
       log "Waiting #{interval} seconds before trying to reconnect", level: :info
       @task.sleep interval
     end
@@ -123,7 +125,7 @@ module RSMP
 
     def send_aggregated_status component
       message = AggregatedStatus.new({
-        "aSTS" => RSMP.now_string,
+        "aSTS" => clock.to_s,
         "cId" =>  component.c_id,
         "fP" => 'NormalControl',
         "fS" => nil,
@@ -161,6 +163,14 @@ module RSMP
       sorted
     end
 
+    def process_aggregated_status_request message
+      log "Received #{message.type}", message: message, level: :log
+      component_id = message.attributes["cId"]
+      component = @site.find_component component_id
+      acknowledge message
+      send_aggregated_status component
+    end
+
     def process_command_request message
       log "Received #{message.type}", message: message, level: :log
       component_id = message.attributes["cId"]
@@ -177,7 +187,7 @@ module RSMP
       end
       response = CommandResponse.new({
         "cId"=>component_id,
-        "cTS"=>RSMP.now_string,
+        "cTS"=>clock.to_s,
         "rvs"=>rvs
       })
       acknowledge message
@@ -194,7 +204,7 @@ module RSMP
       end
       response = StatusResponse.new({
         "cId"=>component_id,
-        "sTs"=>RSMP.now_string,
+        "sTs"=>clock.to_s,
         "sS"=>sS,
         "mId" => options[:m_id]
       })
@@ -221,7 +231,7 @@ module RSMP
       update_list[component] ||= {} 
 
       subs = @status_subscriptions[component]
-      now = RSMP::now_object
+      now = Time.now  # internal timestamp
 
       message.attributes["sS"].each do |arg|
         sCI = arg["sCI"]
@@ -310,12 +320,10 @@ module RSMP
         end
       end
       send_status_updates update_list
-    rescue StandardError => e
-      log ["Status update exception: #{e}",e.backtrace].flatten.join("\n"), level: :error
     end
 
     def send_status_updates update_list
-      now = RSMP.now_string
+      now = clock.to_s
       update_list.each_pair do |component_id,by_code|
         component = @site.find_component component_id
         sS = []
@@ -343,7 +351,7 @@ module RSMP
 
     def send_alarm
       message = Alarm.new({
-        "aSTS"=>RSMP.now_string,
+        "aSTS"=>clock.to_s,
         "fP"=>nil,
         "fS"=>nil,
         "se"=>@site.aggregated_status_bools

data/lib/rsmp/tlc.rb

@@ -13,7 +13,6 @@ module RSMP
       @cycle_time = cycle_time
       @num_traffic_situations = 1
       @num_inputs = 8
-
       reset
     end
 
@@ -41,6 +40,11 @@ module RSMP
       @input_results = '0'*@num_inputs
     end
 
+    def clock
+      node.clock
+    end
+
+
     def add_signal_group group
       @signal_groups << group
     end
@@ -48,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
@@ -80,7 +88,11 @@ 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
@@ -202,6 +214,17 @@ module RSMP
 
     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
@@ -518,35 +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 'version'
-        RSMP::Tlc.make_status '1'
-      when 'hash'
+      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
@@ -555,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
@@ -564,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
@@ -573,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'
@@ -653,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
@@ -695,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
@@ -704,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
@@ -713,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
@@ -722,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'
@@ -767,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
+      @interval = options[:site_settings]['intervals']['timer'] || 1
       unless @main
         raise ConfigurationError.new "TLC must have a main component"
       end
@@ -806,22 +833,21 @@ module RSMP
         next_time = Time.now.to_f
         loop do
           begin
-            now = RSMP.now_object
-            timer(now)
+            timer(@clock.now)
           rescue EOFError => e
-            log "TLC timer: Connection closed: #{e}", level: :warning
+            log "Connection closed: #{e}", level: :warning
           rescue IOError => e
-            log "TLC timer: IOError", level: :warning
+            log "IOError", level: :warning
           rescue Errno::ECONNRESET
-            log "TLC timer: Connection reset by peer", level: :warning
+            log "Connection reset by peer", level: :warning
           rescue Errno::EPIPE => e
-            log "TLC timer: Broken pipe", level: :warning
+            log "Broken pipe", level: :warning
           rescue StandardError => e
-            log "TLC timer: #{e}", level: :debug
+            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 si changed,
+            # 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