rsmp 0.1.10 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6e7b6922c4aad939b08a2235e05a79ef5662534ec401d204255671c2511ede1
-  data.tar.gz: e81f0a7c38fb98317e18ebfb3879f43bd878a947de41b5d49e14953d5ed7f86e
+  metadata.gz: bfbb10fc77baf015a50f7ce94b2ee3b0830a09f8c083b9f0dfbb86fcd4285893
+  data.tar.gz: 8756ab6010d199fdc2e22973ab960156b66f000c7a8feacad201f5be5bb0ff08
 SHA512:
-  metadata.gz: a8dc63658a0082778509d2da33b44e0e80573f1b0aef8fe76c05d816d34e9dd10084de81f38c37df20d6351a9b47b2a33836bbb4405a7143da028f82ef4e2558
-  data.tar.gz: 005bd7b55911a289cd33f521a3850c00ade3622cdce377a1f79e57958925cbc86216b266ffaa6a58a58fdcf66822c5eb34ea48240ff8d29d581f8f2469aa0551
+  metadata.gz: af59d9680e6717f8d0e89cae43e1a95aa17ad322c54024c4dae91bb8e58216d7fc57c727c3e1d56ac9c6770131f2197f6708cceba890b0b83867a493b410111e
+  data.tar.gz: 20597a90bc6c9abaf196ffba19d233fa76716c2febee7af2c0c057337953d40d77ac965a671716ed5e645fb93734265231def5104efc7a39a6e92fade86a5ce7

data/.gitignore

@@ -12,5 +12,6 @@ log
 /spec/reports/
 /tmp/
 /lib/rsmp_schema/
+/config/private/
 
 

data/Gemfile.lock

@@ -1,35 +1,35 @@
 PATH
   remote: .
   specs:
-    rsmp (0.1.10)
+    rsmp (0.1.19)
       async (~> 1.23.0)
-      async-io (~> 1.27.1)
+      async-io (~> 1.27.4)
       colorize (~> 0.8.1)
-      json_schemer (~> 0.2.8)
-      thor (~> 0.20.3)
+      json_schemer (~> 0.2.11)
+      thor (~> 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    aruba (0.14.11)
-      childprocess (>= 0.6.3, < 3.0.0)
-      contracts (~> 0.9)
-      cucumber (>= 1.3.19)
+    aruba (1.0.0)
+      childprocess (~> 3.0)
+      contracts (~> 0.16.0)
+      cucumber (>= 2.4, < 4.0)
       ffi (~> 1.9)
-      rspec-expectations (>= 2.99)
-      thor (~> 0.19)
+      rspec-expectations (~> 3.4)
+      thor (~> 1.0)
     async (1.23.0)
       console (~> 1.0)
       nio4r (~> 2.3)
       timers (~> 4.1)
-    async-io (1.27.1)
+    async-io (1.27.7)
       async (~> 1.14)
-    backports (3.15.0)
-    builder (3.2.3)
-    childprocess (2.0.0)
-      rake (< 13.0)
+    backports (3.17.0)
+    builder (3.2.4)
+    childprocess (3.0.0)
     colorize (0.8.1)
-    console (1.6.0)
+    console (1.10.1)
+      fiber-local
     contracts (0.16.0)
     cucumber (3.1.2)
       builder (>= 2.1.2)
@@ -48,54 +48,52 @@ GEM
     cucumber-tag_expressions (1.1.1)
     cucumber-wire (0.0.1)
     diff-lcs (1.3)
-    ecma-re-validator (0.2.0)
-      regexp_parser (~> 1.2)
-    ffi (1.11.1)
+    ecma-re-validator (0.3.0)
+      regexp_parser (~> 2.0)
+    ffi (1.12.2)
+    fiber-local (1.0.0)
     gherkin (5.1.0)
-    hana (1.3.5)
-    json_schemer (0.2.8)
-      ecma-re-validator (~> 0.2)
+    hana (1.3.7)
+    json_schemer (0.2.17)
+      ecma-re-validator (~> 0.3)
       hana (~> 1.3)
-      regexp_parser (~> 1.5)
+      regexp_parser (~> 2.0)
       uri_template (~> 0.7)
-    multi_json (1.13.1)
+    multi_json (1.14.1)
     multi_test (0.1.2)
-    nio4r (2.5.2)
-    rake (10.5.0)
-    regexp_parser (1.6.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    nio4r (2.5.4)
+    rake (13.0.1)
+    regexp_parser (2.0.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rspec-with_params (0.2.0)
-      rspec (~> 3.0)
-    thor (0.20.3)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thor (1.0.1)
     timecop (0.9.1)
-    timers (4.3.0)
+    timers (4.3.2)
     uri_template (0.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba (~> 0.14.11)
-  bundler (~> 2.0)
+  aruba (~> 1.0.0)
+  bundler (~> 2.1.4)
   cucumber (~> 3.1.2)
-  rake (~> 10.0)
+  rake (~> 13.0.1)
   rsmp!
-  rspec (~> 3.0)
-  rspec-expectations (~> 3.8.3)
-  rspec-with_params (~> 0.2.0)
+  rspec (~> 3.9.0)
+  rspec-expectations (~> 3.9.1)
   timecop (~> 0.9.1)
 
 BUNDLED WITH
-   2.1.0.pre.2
+   2.1.4

data/README.md

@@ -163,6 +163,12 @@ The ```site``` command will start an RSMP site, which will try to connect to one
 2019-11-11 12:22:00 UTC  RN+SU0001  C1  <--  8280  Sent AggregatedStatus
 ```
 
+
+Use the the --type switch to select a specific type of site. Messages will be validated against the corresponding SXL JSON schema. Without any type specified, messages will be validated against the core RSMP schema only.
+
+Use the ```tlc``` site type to run an emulation of a traffic light controller. This type of site implements enough of functionality to pass all the rsmp_validator tests. You can setup signal group components, in the config file.
+
+
 ### CLI help and options.
 Use ```--help <command>``` to get a list of available options.
 
@@ -172,7 +178,7 @@ Use ```--config <path>``` to point to a .yaml config file, controlling things li
 ### RSpec
 RSpec tests are located in spec/. The tests will start supervisor and sites to test communication, but will do so on port 13111, rather than the usual port 12111, to avoid inferference with other RMSP processes running locally.
 
-Note that these tests are NOT intented for testing external equipment or systems. The tests are for validating the code in this repository. To test external equipment or systems.
+Note that these tests are NOT intented for testing external equipment or systems. The tests are for validating the code in this repository. To test external equipment or systems use the rsmp_validator tool.
 
 ```console
 $ rspec

data/config/site.yaml

@@ -12,13 +12,12 @@ rsmp_versions:
   - 3.1.4
 
 components:
-  A1:
-    type: main
+  main:
+    C1:
 
 watchdog_interval: 1
 watchdog_timeout: 2
-acknowledgement_timeout: 2
-store_messages: false
+acknowledgement_timeout: 1
 command_response_timeout: 1
 status_response_timeout: 1
 status_update_timeout: 1

data/config/supervisor.yaml

@@ -13,9 +13,6 @@ command_response_timeout: 1
 status_response_timeout: 1
 status_update_timeout: 1
 
-sites:
-  any:
-
 log:
   active: true
   color: true
@@ -28,6 +25,6 @@ log:
   direction: true
   level: false
   json: true
-  acknowledgements: true
-  watchdogs: true
+  acknowledgements: false
+  watchdogs: false
 

data/config/tlc.yaml

@@ -0,0 +1,44 @@
+site_id: RN+SI0001
+supervisors:
+  - ip: 127.0.0.1
+    port: 12111
+
+components:
+  main:
+    TC:
+      cycle_time: 6
+  signal_group:
+    A1:
+      plan: '11NBBB'
+    A2:
+      plan: '1NBBBB'
+    B1:
+      plan: 'BBB11N'
+    B2:
+      plan: 'BBB1NB'
+  detector_logic:
+    DL1:
+watchdog_interval: 0.1
+watchdog_timeout: 0.2
+acknowledgement_timeout: 0.2
+reconnect_interval: 0.1
+
+security_codes:
+  1: '1111'
+  2: '2222'
+
+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/documentation/classes.md

@@ -0,0 +1,62 @@
+# Classes
+
+## Class tree:
+```
+
+		   .------ Base -------.
+		  /                     \
+	     /                       \
+	    / 	  SiteBase module     \
+	Node 	  /	 	        \ 	   Proxy
+	/   \    /	 	         \    /    \
+Super    Site             SiteProxy	    SupervisorProxy
+
+```
+
+
+## Base
+The Base class handle logging.
+
+Node and Site inherit from Base.
+
+## Node
+A Node has an async task. A node can be started and stopped.
+
+Node has two child classes: Site and Supervisor.
+
+## Site
+A Site represents an RSMP site, typically a traffic light, variable message sign, or other type of field equipment. An RSMP site can connect to one or more supervisors.
+
+A Site has one or more SupervisorProxies (connections to supervisor).
+
+A site has one of more components.
+
+## Supervisor 
+A Supervisor represents an RSMP supervisor, typically a central supervisor system. An RSMP supervisor can handle connections one or more sites.
+
+A Supervisor has one or more SiteProxies (connections to sites).
+
+## Proxy
+A Proxy represents a connection to a remove Site or Supervisor and handles the RSMP interface.
+
+A proxy has an async task listening for messages on an TCP/IP socket. Incoming RSMP messages are parsing and appropriate handles are called.
+
+A proxy also has a repaating async timer task for handling watchdog and acknowledgement timeouts.
+
+Proxy has to child classes: SiteProxy and SupervisorProxy.
+
+## SiteProxy
+A connection to a remote Site.
+
+Handles RSMP messaging specific to a supervisor, including methods for requesting status, sending commands, etc.
+
+A SiteProxy has one or more components, representing the components in the remote site.
+
+## Supervisor Proxy
+A connection to a remote Site. Handles RSMP messaging specific to a site, including sending aggregated status, handling status requests, status subscription and command requests.
+
+Status and command requests are delegated to the appropriate components.
+
+## SiteBase
+Things shared between Site and SiteProxy, mainly handling components.
+

data/lib/rsmp.rb

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

data/lib/rsmp/archive.rb

@@ -6,6 +6,8 @@ module RSMP
     attr_reader :items
     attr_accessor :probes
 
+    @@index = 0
+
     def initialize
       @items = []
       @probes = ProbeCollection.new
@@ -27,6 +29,14 @@ module RSMP
       cleaned
     end
 
+    def self.increase_index
+      @@index += 1
+    end
+
+    def self.current_index
+      @@index
+    end
+
     def by_level levels
       items.select { |item| levels.include? item[:level] }
     end
@@ -35,12 +45,8 @@ module RSMP
       items.map { |item| item[:str] }
     end
 
-    def current_index
-      @items.size
-    end
-
     def add item
-      item[:index] = @items.size
+      item[:index] = RSMP::Archive.increase_index
       @items << item
       probe item
     end

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 }
@@ -17,7 +18,7 @@ module RSMP
 			if options[:config]
 				if File.exist? options[:config]
 					settings = YAML.load_file options[:config]
-					log_settings = settings.delete 'log'
+					log_settings = settings.delete('log') || {}
 				else
 					puts "Error: Config #{options[:config]} not found"
 					exit
@@ -28,9 +29,9 @@ module RSMP
 				settings['site_id'] = options[:id]
 			end
 
-		if options[:supervisors]
-			options[:supervisors].split(',').each do |supervisor|
-				settings[:supervisors] ||= []
+			if options[:supervisors]
+				options[:supervisors].split(',').each do |supervisor|
+					settings[:supervisors] ||= []
 					ip, port = supervisor.split ':'
 					ip = '127.0.0.1' if ip.empty?
 					port = '12111' if port.empty?
@@ -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

@@ -1,6 +1,6 @@
 module RSMP
   class Component
-    attr_reader :c_id, :alarms, :statuses, :aggregated_status, :aggregated_status_bools, :grouped
+    attr_reader :c_id, :node, :alarms, :statuses, :aggregated_status, :aggregated_status_bools, :grouped
 
     AGGREGATED_STATUS_KEYS = [ :local_control,
                                :communication_distruption,
@@ -23,6 +23,7 @@ module RSMP
     def clear_aggregated_status
       @aggregated_status = []
       @aggregated_status_bools = Array.new(8,false)
+      @aggregated_status_bools[5] = true
     end
 
     def set_aggregated_status status
@@ -58,7 +59,16 @@ module RSMP
     def alarm code:, status:
     end
 
-    def status code:, value:
+    def log str, options
+      @node.log str, options
+    end
+
+    def handle_command command_code, arg
+      raise UnknownCommand.new "Command #{command_code} not implemented by #{self.class}"
+    end
+
+    def get_status status_code, status_name=nil
+      raise UnknownStatus.new "Status #{status_code}/#{status_name} not implemented by #{self.class}"
     end
 
   end