rsmp 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e45799eb31adc34f3c6d80fbf0b5e24c41a07cf5561231d085d2a931119417dc
-  data.tar.gz: a9ceb38c14787707b493ade46c861d4ee336b0b394890f3a62c56c079c978a60
+  metadata.gz: d2c272fba5c28e4b5746aa03efac286b646d635cb23ae8c68d3c6cb08ba657ae
+  data.tar.gz: 1051548b65417edbbf31550f4a6a02ae4df7c98aba190682e5c4a5faed3af116
 SHA512:
-  metadata.gz: ba448443412590959523070ac30bad578ff4402ba55b9dacb9ddc4fefd48f596cdd0f34cb839e104b5ebbdb0ade447e51ab1c5e48caa9eabb96b9fc418932811
-  data.tar.gz: ab21f83999dfbce048bfb86f56d9b07a542828422f6e706ce92ab3ded1e5e75c1e4d202ab8d24de14681b8f295701f9d51569e8047e15e5e12d72d8948a474f9
+  metadata.gz: 33b1fb0ad681f71b58571e31a3ef59415ad45ee7ec4a5b947eb494f0474e9a46b85e25e25f977d88da28e4d91011f92b35dc2c1b49c6630d3c7eb5b14ec170a3
+  data.tar.gz: b0614210f4db03d2aba012f07f7df76aefaae0b96db5779558f46c5ca5433c1b0df1ae3f41e828936f45593fdd7e69723df84895510ba798e64964213c0c4cee

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.1.12)
+    rsmp (0.1.13)
       async (~> 1.23.0)
       async-io (~> 1.27.1)
       colorize (~> 0.8.1)
@@ -29,7 +29,7 @@ GEM
     childprocess (2.0.0)
       rake (< 13.0)
     colorize (0.8.1)
-    console (1.6.0)
+    console (1.7.0)
     contracts (0.16.0)
     cucumber (3.1.2)
       builder (>= 2.1.2)

data/config/tlc.yaml

@@ -0,0 +1,47 @@
+site_id: RN+SI0001
+supervisors:
+  - ip: 127.0.0.1
+    port: 12111
+
+sxl: traffic_light_controller
+
+rsmp_versions:
+  - 3.1.1
+  - 3.1.2
+  - 3.1.3
+  - 3.1.4
+
+components:
+  TC:
+    type: main
+    cycle_time: 6
+  A1:
+    type: signal_group
+    plan: 'GGyrrr'
+  B1:
+    type: signal_group
+    plan: 'rrrGGy'
+
+watchdog_interval: 1
+watchdog_timeout: 2
+acknowledgement_timeout: 1
+command_response_timeout: 1
+status_response_timeout: 1
+status_update_timeout: 1
+reconnect_interval: 0.1
+
+log:
+  active: true
+  color: true
+  timestamp: true
+  id: true
+  component: true
+  ip: false
+  site_id: true
+  level: false
+  text: true
+  direction: true
+  json: true
+  acknowledgements: false
+  watchdogs: false
+

data/lib/rsmp/cli.rb

@@ -10,6 +10,7 @@ module RSMP
 		method_option :supervisors, :type => :string, :aliases => "-s", banner: 'ip:port,... list of supervisor to connect to'			
 		method_option :log, :type => :string, :aliases => "-l", banner: 'Path to log file'
 		method_option :json, :type => :boolean, :aliases => "-j", banner: 'Show JSON messages in log'
+		method_option :type, :type => :string, :aliases => "-t", banner: 'Type of site: [tlc]'
 		def site
 			settings = {}
 			log_settings = { 'active' => true }
@@ -46,7 +47,16 @@ module RSMP
 				log_settings['json'] = options[:json]
 			end
 
-			RSMP::Site.new(site_settings:settings, log_settings: log_settings).start
+			site_class = RSMP::Site
+			if options[:type]
+				case options[:type]
+					when 'tlc'
+						site_class = RSMP::Tlc
+					else
+						site_class = RSMP::Site
+				end
+			end
+			site_class.new(site_settings:settings, log_settings: log_settings).start
 		end
 
 		desc "supervisor", "Run RSMP supervisor"

data/lib/rsmp/component.rb

@@ -61,5 +61,8 @@ module RSMP
     def status code:, value:
     end
 
+    def log str, options
+      @node.log str, options
+    end
   end
 end

data/lib/rsmp/error.rb

@@ -43,4 +43,13 @@ module RSMP
 
 	class UnknownComponent < Error
 	end
+
+	class UnknownCommand < Error
+	end
+
+	class UnknownStatus < Error
+	end
+
+	class ConfigurationError < Error
+	end
 end

data/lib/rsmp/proxy.rb

@@ -115,15 +115,19 @@ module RSMP
       interval = @settings["timer_interval"] || 1
       log "Starting #{name} with interval #{interval} seconds", level: :debug
       @latest_watchdog_received = RSMP.now_object
+
       @timer = @task.async do |task|
         task.annotate "timer"
+        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
-          task.sleep interval
+          next_time += interval
+          duration = next_time - Time.now.to_f
+          task.sleep duration
         end
       end
     end

data/lib/rsmp/site.rb

@@ -27,6 +27,7 @@ module RSMP
           { 'ip' => '127.0.0.1', 'port' => 12111 }
         ],
         'rsmp_versions' => ['3.1.1','3.1.2','3.1.3','3.1.4'],
+        'sxl' => 'traffic_light_controller',
         'sxl_version' => '1.0.7',
         'timer_interval' => 0.1,
         'watchdog_interval' => 1,
@@ -39,6 +40,9 @@ module RSMP
         'site_ready_timeout' => 1,
         'reconnect_interval' => 0.1,
         'send_after_connect' => true,
+        'components' => {
+          'C1' => {}
+        }
       }
       if options[:site_settings]
         converted = options[:site_settings].map { |k,v| [k.to_s,v] }.to_h   #convert symbol keys to string keys
@@ -66,7 +70,7 @@ module RSMP
       end
     end
 
-    def build_connector settings
+    def build_proxy settings
       SupervisorProxy.new settings
     end
 
@@ -77,7 +81,7 @@ module RSMP
     end
 
     def connect_to_supervisor task, supervisor_settings
-      proxy = build_connector({
+      proxy = build_proxy({
         site: self,
         task: @task,
         settings: @site_settings, 
@@ -137,5 +141,14 @@ module RSMP
         proxy.stop
       end
     end
+
+    def handle_command command_code, arg
+      raise UnknownCommand.new "Command #{command_code} not implemented"
+    end
+
+    def get_status status_code, status_name=nil
+      raise UnknownStatus.new "Status #{status_code}/#{status_name} not implemented"
+    end
+
   end
 end

data/lib/rsmp/site_proxy.rb

@@ -54,7 +54,7 @@ module RSMP
       log "Received Version message for site #{@site_id} using RSMP #{@rsmp_version}", message: message, level: :log
       start_timer
       acknowledge message
-      send_version @site_id, @rsmp_version
+      send_version @site_id, @settings['rsmp_versions']
       @version_determined = true
 
       if @settings['sites']
@@ -165,7 +165,7 @@ module RSMP
           "sS" => status_list
       })
       send_message message
-      return message, wait_for_status_update(component: component, timeout: timeout)
+      return message, wait_for_status_update(component: component, timeout: timeout)[:message]
     end
 
     def unsubscribe_to_status component, status_list
@@ -187,21 +187,24 @@ module RSMP
 
     def wait_for_status_update options={}
       raise ArgumentError unless options[:component]
+      matching_status = nil
       item = @archive.capture(@task,options.merge(type: "StatusUpdate", with_message: true, num: 1)) do |item|
         # TODO check components
-        found = false
+        matching_status = nil
         sS = item[:message].attributes['sS']
         sS.each do |status|
           next if options[:sCI] && options[:sCI] != status['sCI']
           next if options[:n] && options[:n] != status['n']
           next if options[:q] && options[:q] != status['q']
           next if options[:s] && options[:s] != status['s']
-          found = true
+          matching_status = status
           break
         end
-        found
+        matching_status != nil
+      end
+      if item
+        { message: item[:message], status: matching_status }
       end
-      item[:message] if item
     end
 
     def send_command component, args

data/lib/rsmp/supervisor.rb

@@ -98,7 +98,7 @@ module RSMP
       true
     end
 
-    def build_connector settings
+    def build_proxy settings
       SiteProxy.new settings
     end
 
@@ -117,7 +117,7 @@ module RSMP
           level: :info,
           timestamp: RSMP.now_object
 
-      proxy = build_connector({
+      proxy = build_proxy({
         supervisor: self,
         task: @task,
         settings: @supervisor_settings[:sites],

data/lib/rsmp/supervisor_proxy.rb

@@ -72,6 +72,12 @@ module RSMP
         else
           super message
       end
+    rescue UnknownComponent => e
+      dont_acknowledge message, '', e.to_s
+    rescue UnknownCommand => e
+      dont_acknowledge message, '', e.to_s
+    rescue UnknownStatus => e
+      dont_acknowledge message, '', e.to_s
     end
 
     def acknowledged_first_ingoing message
@@ -135,20 +141,31 @@ module RSMP
       acknowledge message
     end
 
+    # reorganize rmsp command request arg attribute:
+    # [{"cCI":"M0002","cO":"setPlan","n":"status","v":"True"},{"cCI":"M0002","cO":"setPlan","n":"securityCode","v":"5678"},{"cCI":"M0002","cO":"setPlan","n":"timeplan","v":"3"}]
+    # into the simpler, but equivalent:
+    # {"M0002"=>{"status"=>"True", "securityCode"=>"5678", "timeplan"=>"3"}}
+    def simplify_command_requests arg
+      sorted = {}
+      arg.each do |item|
+        sorted[item['cCI']] ||= {}
+        sorted[item['cCI']][item['n']] = item['v']
+      end
+      sorted
+    end
+
     def process_command_request message
-      log "Received #{message.type}", message: message, level: :log
-      rvs = []
-      message.attributes["arg"].each do |arg|
-        unless arg['cCI'] && arg['n'] && arg['v']
-          dont_acknowledge message, '', 'bad arguments'
-          return
-        end 
-        rvs << { "cCI" => arg["cCI"],
-                 "n" => arg["n"],
-                 "v" => arg["v"],
-                 "age" => "recent" }
+      log "Received #{message.type}", message: message, level: :log 
+      commands = simplify_command_requests message.attributes["arg"]
+      commands.each_pair do |command_code,arg|
+        @site.handle_command(command_code,arg).merge('cCI'=>command_code)
       end
 
+      rvs = message.attributes["arg"].map do |item|
+        item = item.dup.merge('age'=>'recent')
+        item.delete 'cO'
+        item
+      end
       response = CommandResponse.new({
         "cId"=>message.attributes["cId"],
         "cTS"=>RSMP.now_string,
@@ -161,12 +178,10 @@ module RSMP
     def process_status_request message
       component_id = message.attributes["cId"]
       component = @site.find_component component_id
-
       log "Received #{message.type}", message: message, level: :log
-      sS = message.attributes["sS"].clone.map do |request|
-        request["s"] = rand(100).to_s
-        request["q"] = "recent"
-        request
+      sS = message.attributes["sS"].map do |arg|
+        value, quality =  @site.get_status arg['sCI'], arg['n']
+        { "s" => value, "q" => quality }.merge arg
       end
       response = StatusResponse.new({
         "cId"=>component_id,
@@ -175,8 +190,6 @@ module RSMP
       })
       acknowledge message
       send_message response
-    rescue UnknownComponent => e
-      dont_acknowledge message, '', e.to_s
     end
 
     def process_status_subcribe message
@@ -273,11 +286,12 @@ module RSMP
       update_list.each_pair do |component,by_code|
         sS = []
         by_code.each_pair do |code,names|
-          names.each do |name|
+          names.map do |status_name|
+            value,quality = @site.get_status code, status_name
             sS << { "sCI" => code,
-                     "n" => name,
-                     "s" => rand(100).to_s,
-                     "q" => "recent" }
+                     "n" => status_name,
+                     "s" => value.to_s,
+                     "q" => quality }
           end
         end
         update = StatusUpdate.new({

data/lib/rsmp/tlc.rb

@@ -0,0 +1,236 @@
+# Simulates a Traffic Light Controller
+
+module RSMP
+
+  class TrafficController < Component
+    attr_reader :pos, :cycle_time
+    def initialize node:, id:, cycle_time:
+      super node: node, id: id, grouped: true
+      @pos = 0
+      @cycle_time = cycle_time
+      @signal_groups = []
+      @plan = 0
+      @dark_mode = 'False'
+      @yellow_flash = 'False'
+      @booting = 'False'
+      @police_key = 0
+    end
+
+    def add_signal_group group
+      @signal_groups << group
+    end
+
+    def timer now
+      pos = now.to_i % @cycle_time
+      if pos != @pos
+        @pos = pos
+        move pos
+      end
+    end
+
+    def move pos
+      @signal_groups.each do |group|
+        group.move pos
+      end
+      output_states
+
+      if pos == 0
+        aggrated_status_changed
+      end
+    end
+
+    def output_states
+      #print "\t#{pos.to_s.ljust(3)} #{format_signal_group_status}\r"
+    end
+
+    def format_signal_group_status
+      @signal_groups.map { |group|group.state }.join
+    end
+
+    def handle_command command_code, arg
+      case command_code
+      when 'M0001'
+        handle_m0001 arg
+      when 'M0002'
+        handle_m0002 arg
+      when 'M0007'
+        handle_m0007 arg
+      else
+        raise UnknownCommand.new "Unknown command #{command_code}"
+      end
+    end
+
+    def handle_m0001 arg
+      verify_security_code arg['securityCode']
+      switch_mode arg['status']
+      arg
+    end
+
+    def handle_m0002 arg
+      verify_security_code arg['securityCode']
+      if arg['status'] = 'True'
+        switch_plan arg['timeplan']
+      else
+        switch_plan 0   # TODO use clock/calender
+      end
+      arg
+    end
+
+    def handle_m0007 arg
+      verify_security_code arg['securityCode']
+      set_fixed_time_control arg['status']
+      arg
+    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
+    end
+
+   def switch_mode mode
+      log "Switching to mode #{mode}", level: :info
+      case mode
+      when 'NormalControl'
+        @yellow_flash = 'False'
+        @dark_mode = 'False'
+      when 'YellowFlash'
+        @yellow_flash = 'True'
+        @dark_mode = 'False'
+      when 'Dark'
+        @yellow_flash = 'False'
+        @dark_mode = 'True'
+      end
+      mode
+    end
+
+    def get_status status_code, status_name=nil
+      case status_code
+      when 'S0001'
+        return format_signal_group_status, "recent"
+      when 'S0005'
+        return @booting, "recent"
+      when 'S0007'
+        if @dark_mode == 'True'
+          return 'False', "recent"
+        else
+          return 'True', "recent"
+        end
+      when 'S0009'
+        return @fixed_time_control.to_s, "recent"
+      when 'S0013'
+        return @police_key.to_s, "recent"
+      when 'S0014'
+        return @plan.to_s, "recent"
+      when 'S0011'
+        return @yellow_flash, "recent"
+      else
+        raise InvalidMessage.new "unknown status code #{status_code}"
+      end
+    end
+
+    def verify_security_code code
+    end
+
+  end
+
+  class SignalGroup < Component
+    attr_reader :plan, :state
+
+    def initialize node:, id:, plan:
+      super node: node, id: id, grouped: false
+      @plan = plan
+      move 0
+    end
+
+    def get_state pos
+      if pos > @plan.length
+        '.'
+      else
+        @plan[pos]
+      end
+    end
+
+    def move pos
+      @state = get_state pos
+    end
+  end
+
+  class Tlc < Site
+    def initialize options={}
+      super options
+
+      @sxl = 'traffic_light_controller'
+
+      unless @main
+        raise ConfigurationError.new "TLC must have a main component"
+      end
+    end
+
+    def build_component id, settings={}
+      component = case settings['type']
+      when 'main'
+        @main = TrafficController.new node: self, id: id, cycle_time: settings['cycle_time']
+      when 'signal_group'
+        group = SignalGroup.new node: self, id: id, plan: settings['plan']
+        @main.add_signal_group group
+        group
+      end
+    end
+
+    def start_action
+      super
+      start_timer
+    end
+
+    def start_timer
+      name = "tlc timer"
+      interval = 1 #@settings["timer_interval"] || 1
+      log "Starting #{name} with interval #{interval} seconds", level: :debug
+
+      @timer = @task.async do |task|
+        task.annotate "timer"
+        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
+        end
+      end
+    end
+
+    def timer now
+      return unless @main
+      @main.timer now
+    end
+
+    def handle_command command_code, arg
+      return unless @main
+      @main.handle_command command_code, arg
+    end
+
+    def get_status status_code, status_name=nil
+      return unless @main
+      @main.get_status status_code, status_name
+    end
+
+  end
+end

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.1.12"
+  VERSION = "0.1.13"
 end

data/lib/rsmp.rb

@@ -27,3 +27,4 @@ require 'rsmp/probe_collection'
 require 'rsmp/message'
 require 'rsmp/logger'
 require 'rsmp/archive'
+require 'rsmp/tlc'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Emil Tin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-18 00:00:00.000000000 Z
+date: 2020-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -213,6 +213,7 @@ files:
 - bin/setup
 - config/site.yaml
 - config/supervisor.yaml
+- config/tlc.yaml
 - exe/rsmp
 - lib/rsmp.rb
 - lib/rsmp/alarm.rb
@@ -234,6 +235,7 @@ files:
 - lib/rsmp/supervisor.rb
 - lib/rsmp/supervisor_base.rb
 - lib/rsmp/supervisor_proxy.rb
+- lib/rsmp/tlc.rb
 - lib/rsmp/version.rb
 - lib/rsmp/wait.rb
 - lib/rsmp_schema/schema/core/aggregated_status.json
@@ -357,7 +359,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: RoadSide Message Protocol (RSMP) library.