rsmp 0.38.0 → 0.40.0

data/lib/rsmp/options/supervisor_options.rb

@@ -0,0 +1,28 @@
+module RSMP
+  class Supervisor < Node
+    # Configuration options for supervisors.
+    class Options < RSMP::Options
+      def defaults
+        {
+          'port' => 12_111,
+          'ips' => 'all',
+          'guest' => {
+            'sxl' => 'tlc',
+            'intervals' => {
+              'timer' => 1,
+              'watchdog' => 1
+            },
+            'timeouts' => {
+              'watchdog' => 2,
+              'acknowledgement' => 2
+            }
+          }
+        }
+      end
+
+      def schema_file
+        'supervisor.json'
+      end
+    end
+  end
+end

data/lib/rsmp/options/traffic_controller_site_options.rb

@@ -0,0 +1,12 @@
+module RSMP
+  module TLC
+    class TrafficControllerSite < Site
+      # Configuration options for traffic controller sites.
+      class Options < RSMP::Site::Options
+        def schema_file
+          'traffic_controller_site.json'
+        end
+      end
+    end
+  end
+end

data/lib/rsmp/proxy/proxy.rb

@@ -1,10 +1,8 @@
-# A connection to a remote site or supervisor.
-# Uses the Task module to handle asyncronous work, but adds
-# the concept of a connection that can be connected or disconnected.
-
 require 'rubygems'
 
 module RSMP
+  # Represents a connection to a remote site or supervisor.
+  # Provides common connection lifecycle and message handling.
   class Proxy
     WRAPPING_DELIMITER = "\f".freeze
 

data/lib/rsmp/proxy/site/site_proxy.rb

@@ -1,6 +1,5 @@
-# Handles a supervisor connection to a remote client
-
 module RSMP
+  # Handles a supervisor-side proxy for a connected site.
   class SiteProxy < Proxy
     include Components
     include Modules::Status

data/lib/rsmp/proxy/supervisor/supervisor_proxy.rb

@@ -1,8 +1,7 @@
-# Handles a site connection to a remote supervisor
-
 require 'digest'
 
 module RSMP
+  # Proxy used by sites to connect to a remote supervisor.
   class SupervisorProxy < Proxy
     include Modules::Status
     include Modules::Commands

data/lib/rsmp/tlc/detector_logic.rb

@@ -1,5 +1,6 @@
 module RSMP
   module TLC
+    # Detector logic component for the TLC.
     class DetectorLogic < Component
       attr_reader :forced, :value
 

data/lib/rsmp/tlc/signal_group.rb

@@ -1,5 +1,6 @@
 module RSMP
   module TLC
+    # Signal group representation for the TLC.
     class SignalGroup < Component
       attr_reader :plan, :state
 

data/lib/rsmp/tlc/signal_priority.rb

@@ -1,5 +1,6 @@
 module RSMP
   module TLC
+    # Representation of a priority request for a TLC signal.
     class SignalPriority
       attr_reader :state, :node, :id, :level, :eta, :vehicle_type, :age, :updated
 

data/lib/rsmp/tlc/traffic_controller_site.rb

@@ -4,6 +4,10 @@ module RSMP
     class TrafficControllerSite < Site
       attr_accessor :main, :signal_plans
 
+      def self.options_class
+        RSMP::TLC::TrafficControllerSite::Options
+      end
+
       def initialize(options = {})
         # setup options before calling super initializer,
         # since build of components depend on options

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = '0.38.0'.freeze
+  VERSION = '0.40.0'.freeze
 end

data/lib/rsmp.rb

@@ -53,6 +53,10 @@ require_relative 'rsmp/node/supervisor/modules/configuration'
 require_relative 'rsmp/node/supervisor/modules/connection'
 require_relative 'rsmp/node/supervisor/modules/sites'
 require_relative 'rsmp/node/supervisor/supervisor'
+require_relative 'rsmp/options/options'
+require_relative 'rsmp/options/site_options'
+require_relative 'rsmp/options/supervisor_options'
+require_relative 'rsmp/options/traffic_controller_site_options'
 require_relative 'rsmp/proxy/modules/state'
 require_relative 'rsmp/proxy/modules/watchdogs'
 require_relative 'rsmp/proxy/modules/acknowledgements'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.38.0
+  version: 0.40.0
 platform: ruby
 authors:
 - Emil Tin
@@ -138,6 +138,7 @@ files:
 - cucumber.yml
 - documentation/classes_and_modules.md
 - documentation/collecting_message.md
+- documentation/configuration.md
 - documentation/message_distribution.md
 - documentation/tasks.md
 - exe/rsmp
@@ -186,6 +187,13 @@ files:
 - lib/rsmp/node/supervisor/modules/sites.rb
 - lib/rsmp/node/supervisor/supervisor.rb
 - lib/rsmp/node/task.rb
+- lib/rsmp/options/options.rb
+- lib/rsmp/options/schemas/site.json
+- lib/rsmp/options/schemas/supervisor.json
+- lib/rsmp/options/schemas/traffic_controller_site.json
+- lib/rsmp/options/site_options.rb
+- lib/rsmp/options/supervisor_options.rb
+- lib/rsmp/options/traffic_controller_site_options.rb
 - lib/rsmp/proxy/modules/acknowledgements.rb
 - lib/rsmp/proxy/modules/receive.rb
 - lib/rsmp/proxy/modules/send.rb
@@ -248,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: RoadSide Message Protocol (RSMP) library.
 test_files: []