rsmp 0.12.3 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d97c24017cb23ab7159bebda96f262f50813d902365e2fa1fabeb90d4771df01
-  data.tar.gz: fde070792556ef05d68ebfe5d7757d696f81921d75e64ced80f2a1c4878d39ef
+  metadata.gz: dfc37b07159cf717f60f293434f6fda0ff6935ad209967b7d5ddb025a9794600
+  data.tar.gz: 5c5e6b1e7728bdffd50776e95a7beb0fd6261dbb58b4ec3f530f7b33ee15cdf4
 SHA512:
-  metadata.gz: 2b58d0ed3307893fdd43fcd361b5da63e541baf199ac21860fa11cca756fe4339a63b4bf3420164232c248667e3cf75fe0b467928642e9fcd99f951308fa6e67
-  data.tar.gz: 3c5cb9a04f22a56a16f51c41faff55a5d587fe51dd2774e6a018846da40b5bf066f08bbbfc7848382ec2a76c64a0b17cad372972b0357d7182359e934864b771
+  metadata.gz: 201cad0d07ee914d79af82d8ad2ee10740fbe49002e1f3cbb2740b3d573df61c26532688651e6f6f70ea538e0475f51cbe0a46055b2b6331cd5fff48aa4b8d3e
+  data.tar.gz: 74a44c4ac848c9dbe5f0fbd772f2839c5565a8322d7292218d64f7e31f5fdf8e4849e59845fee361d0ca1ed0ecaa2ce067fdc71a86eaf0e50959e0d826742b2f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.12.3)
+    rsmp (0.13.2)
       async (~> 1.29.1)
       async-io (~> 1.32.2)
       colorize (~> 0.8.1)
@@ -68,7 +68,7 @@ GEM
     ffi (1.15.5-x64-mingw32)
     fiber-local (1.0.0)
     hana (1.3.7)
-    json_schemer (0.2.20)
+    json_schemer (0.2.21)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
@@ -79,7 +79,7 @@ GEM
     multi_test (0.1.2)
     nio4r (2.5.8)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.4.0)
     rsmp_schemer (0.4.0)
       json_schemer (~> 0.2.18)
     rspec (3.10.0)

data/lib/rsmp/alarm_state.rb

@@ -1,33 +1,94 @@
 module RSMP
   # class that tracks the state of an alarm
   class AlarmState
-    attr_reader :component_id, :code, :acknowledged, :suspended, :active, :timestamp, :category, :priority
+    attr_reader :component_id, :code, :acknowledged, :suspended, :active, :timestamp, :category, :priority, :rvs
 
-    def initialize component_id:, code:
-      @component_id = component_id
+    def initialize component:, code:
+      @component = component
+      @component_id = component.c_id
       @code = code
+      @suspended = false
       @acknowledged = false
       @suspended = false
       @active = false
       @timestamp = nil
-      @category = nil
-      @priority = nil
+      @category = 'D'
+      @priority = 2
+      @rvs = []
     end
 
     def suspend
-      @suspended = true
+      change, @suspended = !@suspended, true
+      update_timestamp if change
+      change
     end
 
     def resume
-      @suspended = false
+      change, @suspended = @suspended, false
+      update_timestamp if change
+      change
     end
 
     def activate
-      @active = true
+      change, @active = !@active, true
+      update_timestamp if change
+      change
     end
 
     def deactivate
-      @active = false
+      change, @active = @active, false
+      update_timestamp if change
+      change
+    end
+    
+    def update_timestamp
+      @timestamp = @component.node.clock.now
+    end
+
+    def to_message specialization:
+      Alarm.new(
+        'cId' => @component_id,
+        'aSp' => specialization,
+        'aCId' => @code,
+        'aTs' => Clock.to_s(@timestamp),
+        'ack' => (@acknowledged ? 'Acknowledged' : 'notAcknowledged'),
+        'sS' => (@suspended ? 'suspended' : 'notSuspended'),
+        'aS' => (@active ? 'Active' : 'inActive'),
+        'cat' => @category,
+        'pri' => @priority.to_s,
+        'rvs' => @rvs
+      )
     end
+
+    def differ_from_message? message
+      return true if @timestamp != message.attribute('aTs')
+      return true if message.attribute('ack') && @acknowledged != (message.attribute('ack') == 'True')
+      return true if message.attribute('sS') && @suspended != (message.attribute('sS') == 'True')
+      return true if message.attribute('aS') && @active != (message.attribute('aS') == 'True')
+      return true if message.attribute('cat') && @category != message.attribute('cat')
+      return true if message.attribute('pri') && @priority != message.attribute('pri').to_i
+      #return true @rvs = message.attribute('rvs')
+      false
+    end
+
+    # update from rsmp message
+    # component id, alarm code and specialization are not updated
+    def update_from_message message
+      unless differ_from_message? message
+        raise RepeatedAlarmError.new("no changes from previous alarm #{message.m_id_short}")
+      end
+      if Time.parse(message.attribute('aTs')) < Time.parse(message.attribute('aTs'))
+        raise TimestampError.new("timestamp is earlier than previous alarm #{message.m_id_short}")
+      end
+    ensure
+      @timestamp = message.attribute('aTs')
+      @acknowledged = message.attribute('ack') == 'True'
+      @suspended = message.attribute('sS') == 'True'
+      @active = message.attribute('aS') == 'True'
+      @category = message.attribute('cat')
+      @priority = message.attribute('pri').to_i
+      @rvs = message.attribute('rvs')
+    end
+
   end
 end

data/lib/rsmp/component.rb

@@ -1,9 +1,7 @@
 module RSMP
-
   # RSMP component
-
   class Component < ComponentBase
-    def initialize node:, id:, grouped: false
+    def initialize node:, id:, ntsOId: nil, xNId: nil, grouped: false
       super
     end
 
@@ -15,40 +13,38 @@ module RSMP
       raise UnknownStatus.new "Status #{status_code}/#{status_name} not implemented by #{self.class}"
     end
 
-    def get_alarm_state alarm_code
-      alarm = @alarms[alarm_code] ||= RSMP::AlarmState.new component_id: c_id, code: alarm_code
-    end
-
     def suspend_alarm alarm_code
       alarm = get_alarm_state alarm_code
-      return if alarm.suspended
-      log "Suspending alarm #{alarm_code}", level: :info
-      alarm.suspend
-      @node.alarm_changed alarm
+      if alarm.suspend
+        log "Suspending alarm #{alarm_code}", level: :info
+        @node.alarm_suspended_or_resumed alarm
+      else
+        log "Alarm #{alarm_code} already suspended", level: :info
+      end       
     end
 
     def resume_alarm alarm_code
       alarm = get_alarm_state alarm_code
-      return unless alarm.suspended
-      log "Resuming alarm #{alarm_code}", level: :info
-      alarm.resume
-      @node.alarm_changed alarm
+      if alarm.resume
+        log "Resuming alarm #{alarm_code}", level: :info
+        @node.alarm_suspended_or_resumed alarm
+      else
+        log "Alarm #{alarm_code} already resumed", level: :info
+      end
     end
 
     def activate_alarm alarm_code
       alarm = get_alarm_state alarm_code
-      return if alarm.active
+      return unless alarm.activate
       log "Activating alarm #{alarm_code}", level: :info
-      alarm.activate
-      @node.alarm_changed alarm
+      @node.alarm_activated_or_deactivated alarm
     end
 
     def deactivate_alarm alarm_code
       alarm = get_alarm_state alarm_code
-      return unless alarm.active
+      return unless alarm.deactivate
       log "Deactivating alarm #{alarm_code}", level: :info
-      alarm.deactivate
-      @node.alarm_changed alarm
+      @node.alarm_activated_or_deactivated alarm
     end
   end
 end

data/lib/rsmp/component_base.rb

@@ -5,7 +5,8 @@ module RSMP
   class ComponentBase
     include Inspect
 
-    attr_reader :c_id, :node, :alarms, :statuses, :aggregated_status, :aggregated_status_bools, :grouped
+    attr_reader :c_id, :ntsOId, :xNId, :node, :alarms, :statuses,
+      :aggregated_status, :aggregated_status_bools, :grouped
 
     AGGREGATED_STATUS_KEYS = [ :local_control,
                                :communication_distruption,
@@ -16,12 +17,21 @@ module RSMP
                                :rest,
                                :not_connected ]
 
-    def initialize node:, id:, grouped: false
+    def initialize node:, id:,  ntsOId: nil, xNId: nil, grouped: false
+      if grouped==false && (ntsOId || xNId)
+        raise RSMP::ConfigurationError.new("ntsOId and xNId are only allowed for grouped objects")
+      end
       @c_id = id
+      @ntsOId = ntsOId
+      @xNId = xNId
       @node = node
       @grouped = grouped
-      @alarms = {}
       clear_aggregated_status
+      @alarms = {}
+    end
+
+    def get_alarm_state alarm_code
+      alarm = @alarms[alarm_code] ||= RSMP::AlarmState.new component: self, code: alarm_code
     end
 
     def clear_aggregated_status

data/lib/rsmp/component_proxy.rb

@@ -1,10 +1,9 @@
 module RSMP
-
   # A proxy to a remote RSMP component.
-
   class ComponentProxy < ComponentBase
     def initialize node:, id:, grouped: false
       super
+      @alarms = {}
       @statuses = {}
       @allow_repeat_updates = {}
     end
@@ -45,23 +44,12 @@ module RSMP
         @allow_repeat_updates[sCI].delete(n) if @allow_repeat_updates[sCI]
       end
     end
- 
+
     # handle incoming alarm
     def handle_alarm message
-#      code = message.attribute('aCId')
-#      previous = @alarms[code]
-#      if previous
-#        unless message.differ?(previous)
-#          raise RepeatedAlarmError.new("no changes from previous alarm #{previous.m_id_short}")
-#        end
-#        if Time.parse(message.attribute('aTs')) < Time.parse(previous.attribute('aTs'))
-#          raise TimestampError.new("timestamp is earlier than previous alarm #{previous.m_id_short}")
-#        end
-#      end
-#      p message
-#    ensure
-#      @alarms[code] = message
+      code = message.attribute('aCId')
+      alarm = get_alarm_state code
+      alarm.update_from_message message
     end
-
- end
+  end
 end

data/lib/rsmp/message.rb

@@ -68,7 +68,13 @@ module RSMP
       when /Acknowledge/i
         AlarmAcknowledged.new attributes
       when /Suspend/i
-        AlarmSuspend.new attributes
+        if attributes['sS'] =~ /suspended/i
+          AlarmSuspended.new attributes
+        elsif attributes['sS'] =~ /notSuspended/i
+          AlarmResumed.new attributes
+        else
+          AlarmSuspend.new attributes
+        end
       when /Resume/i
         AlarmResume.new attributes
       else
@@ -264,7 +270,23 @@ module RSMP
     end
   end
 
+  class AlarmSuspended < Alarm
+    def initialize attributes = {}
+      super({
+        "aSp" => "Suspend",
+        "sS" => "suspended"
+      }.merge attributes)
+    end
+  end
 
+  class AlarmResumed < Alarm
+    def initialize attributes = {}
+      super({
+        "aSp" => "Suspend",
+        "sS" => "notSuspended"
+      }.merge attributes)
+    end
+  end
 
   class Watchdog < Message
     def initialize attributes = {}

data/lib/rsmp/proxy.rb

@@ -643,5 +643,13 @@ module RSMP
         return { sent: message }
       end
     end
+
+    def set_nts_message_attributes message
+      return unless @site && @site.main
+      ntsOId =  @site.main.ntsOId
+      xNId =  @site.main.xNId
+      message.attributes['ntsOId'] = ntsOId if ntsOId
+      message.attributes['xNId'] = xNId if xNId
+    end
   end
 end

data/lib/rsmp/site.rb

@@ -93,23 +93,31 @@ module RSMP
       end
     end
 
-    def alarm_state_to_message alarm_state
-      Alarm.new(
+    def alarm_state_to_hash alarm_state
+      {
         'cId' => alarm_state.component_id,
-        'aTs' => clock.to_s,
         'aCId' => alarm_state.code,
-        'aSp' => (alarm_state.suspended ? 'Suspend' : 'Issue'),
+        'aTs' => Clock.to_s(alarm_state.timestamp),
         'ack' => (alarm_state.acknowledged ? 'Acknowledged' : 'notAcknowledged'),
         'sS' => (alarm_state.suspended ? 'suspended' : 'notSuspended'),
         'aS' => (alarm_state.active ? 'Active' : 'inActive'),
-        'cat' => (alarm_state.category || 'D'),
-        'pri' => (alarm_state.priority || '2'),
-        'rvs' => []
-      )
+        'cat' => alarm_state.category,
+        'pri' => alarm_state.priority.to_s,
+        'rvs' => alarm_state.rvs
+      }
+    end
+
+    def alarm_suspended_or_resumed alarm_state
+      alarm = AlarmIssue.new( alarm_state_to_hash(alarm_state).merge('aSp' => 'Suspend') )
+      send_alarm alarm
+    end
+
+    def alarm_activated_or_deactivated alarm_state
+      alarm = AlarmIssue.new( alarm_state_to_hash(alarm_state).merge('aSp' => 'Issue') )
+      send_alarm alarm
     end
 
-    def alarm_changed alarm_state
-      alarm = alarm_state_to_message alarm_state
+    def send_alarm alarm
       @proxies.each do |proxy|
         proxy.send_message alarm if proxy.ready?
       end

data/lib/rsmp/site_proxy.rb

@@ -63,7 +63,7 @@ module RSMP
           process_aggregated_status message
         when AggregatedStatusRequest
           will_not_handle message
-        when Alarm
+        when AlarmIssue, AlarmSuspended, AlarmResumed
           process_alarm message
         when CommandResponse
           process_command_response message
@@ -114,13 +114,11 @@ module RSMP
     def request_aggregated_status component, options={}
       validate_ready 'request aggregated status'
       m_id = options[:m_id] || RSMP::Message.make_m_id
-
       message = RSMP::AggregatedStatusRequest.new({
-          "ntsOId" => '',
-          "xNId" => '',
-          "cId" => component,
-          "mId" => m_id
+        "cId" => component,
+        "mId" => m_id
       })
+      set_nts_message_attributes message
       send_and_optionally_collect message, options do |collect_options|
         AggregatedStatusCollector.new(
           self,
@@ -187,12 +185,11 @@ module RSMP
       request_list = status_list.map { |item| item.slice('sCI','n') }
 
       message = RSMP::StatusRequest.new({
-          "ntsOId" => '',
-          "xNId" => '',
           "cId" => component,
           "sS" => request_list,
           "mId" => m_id
       })
+      set_nts_message_attributes message
       send_and_optionally_collect message, options do |collect_options|
         StatusCollector.new(
           self,
@@ -232,12 +229,11 @@ module RSMP
       component.allow_repeat_updates subscribe_list
 
       message = RSMP::StatusSubscribe.new({
-          "ntsOId" => '',
-          "xNId" => '',
           "cId" => component_id,
           "sS" => subscribe_list,
           'mId' => m_id
       })
+      set_nts_message_attributes message
       send_and_optionally_collect message, options do |collect_options|
         StatusCollector.new(
           self,
@@ -262,11 +258,10 @@ module RSMP
       end
 
       message = RSMP::StatusUnsubscribe.new({
-        "ntsOId" => '',
-        "xNId" => '',
         "cId" => component_id,
         "sS" => status_list
       })
+      set_nts_message_attributes message
       send_message message, validate: options[:validate]
       message
     end
@@ -292,12 +287,11 @@ module RSMP
       validate_ready 'send command'
       m_id = options[:m_id] || RSMP::Message.make_m_id
       message = RSMP::CommandRequest.new({
-          "ntsOId" => '',
-          "xNId" => '',
           "cId" => component,
           "arg" => command_list,
           "mId" => m_id
       })
+      set_nts_message_attributes message
       send_and_optionally_collect message, options do |collect_options|
         CommandResponseCollector.new(
           self,

data/lib/rsmp/supervisor_proxy.rb

@@ -105,7 +105,7 @@ module RSMP
         process_status_subcribe message
       when StatusUnsubscribe
         process_status_unsubcribe message
-      when AlarmAcknowledged, AlarmSuspend, AlarmResume, AlarmRequest
+      when Alarm, AlarmAcknowledged, AlarmSuspend, AlarmResume, AlarmRequest
         process_alarm message
       else
         super message
@@ -160,7 +160,7 @@ module RSMP
         "se" => component.aggregated_status_bools,
         "mId" => m_id,
       })
-
+      set_nts_message_attributes message
       send_and_optionally_collect message, options do |collect_options|
         Collector.new self, collect_options.merge(task:@task, type: 'MessageAck')
       end

data/lib/rsmp/tlc/traffic_controller.rb

@@ -9,9 +9,9 @@ module RSMP
         :functional_position,
         :startup_sequence_active, :startup_sequence, :startup_sequence_pos
 
-      def initialize node:, id:, cycle_time: 10, signal_plans:,
+      def initialize node:, id:, ntsOId: nil, xNId: nil, cycle_time: 10, signal_plans:,
           startup_sequence:, live_output:nil, inputs:{}
-        super node: node, id: id, grouped: true
+        super node: node, id: id, ntsOId: ntsOId, xNId: xNId, grouped: true
         @signal_groups = []
         @detector_logics = []
         @plans = signal_plans

data/lib/rsmp/tlc/traffic_controller_site.rb

@@ -52,7 +52,10 @@ module RSMP
       def build_component id:, type:, settings:{}
         component = case type
         when 'main'
-          @main = TrafficController.new node: self, id: id,
+          @main = TrafficController.new node: self,
+            id: id,
+            ntsOId: settings['ntsOId'],
+            xNId: settings['xNId'],
             cycle_time: settings['cycle_time'],
             startup_sequence: @startup_sequence,
             signal_plans: @signal_plans,

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.12.3"
+  VERSION = "0.13.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.13.2
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-05 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async