Class: RSMP::AlarmState

Inherits:
Object
  • Object
show all
Defined in:
lib/rsmp/component/alarm_state.rb

Overview

The state of an alarm on a component. The alarm state is for a particular alarm code, a component typically have an alarm state for each alarm code that is defined for the component type.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(component:, code:, **options) ⇒ AlarmState

Returns a new instance of AlarmState.



23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/rsmp/component/alarm_state.rb', line 23

def initialize(component:, code:, **options)
  @component = component
  @component_id = component.c_id
  @code = code
  @suspended = !!options[:suspended]
  @acknowledged = !!options[:acknowledged]
  @active = !!options[:active]
  @timestamp = options[:timestamp]
  @category = options[:category] || 'D'
  @priority = options[:priority] || 2
  @rvs = options[:rvs] || []
end

Instance Attribute Details

#acknowledged ⇒ Object (readonly)

Returns the value of attribute acknowledged.



8
9
10
 
# File 'lib/rsmp/component/alarm_state.rb', line 8

def acknowledged
  @acknowledged
end

#active ⇒ Object (readonly)

Returns the value of attribute active.



8
9
10
 
# File 'lib/rsmp/component/alarm_state.rb', line 8

def active
  @active
end

#category ⇒ Object (readonly)

Returns the value of attribute category.



8
9
10
 
# File 'lib/rsmp/component/alarm_state.rb', line 8

def category
  @category
end

#code ⇒ Object (readonly)

Returns the value of attribute code.



8
9
10
 
# File 'lib/rsmp/component/alarm_state.rb', line 8

def code
  @code
end

#component_id ⇒ Object (readonly)

Returns the value of attribute component_id.



8
9
10
 
# File 'lib/rsmp/component/alarm_state.rb', line 8

def component_id
  @component_id
end

#priority ⇒ Object (readonly)

Returns the value of attribute priority.



8
9
10
 
# File 'lib/rsmp/component/alarm_state.rb', line 8

def priority
  @priority
end

#rvs ⇒ Object (readonly)

Returns the value of attribute rvs.



8
9
10
 
# File 'lib/rsmp/component/alarm_state.rb', line 8

def rvs
  @rvs
end

#suspended ⇒ Object (readonly)

Returns the value of attribute suspended.



8
9
10
 
# File 'lib/rsmp/component/alarm_state.rb', line 8

def suspended
  @suspended
end

#timestamp ⇒ Object (readonly)

Returns the value of attribute timestamp.



8
9
10
 
# File 'lib/rsmp/component/alarm_state.rb', line 8

def timestamp
  @timestamp
end

Class Method Details

.create_from_message(component, message) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/rsmp/component/alarm_state.rb', line 10

def self.create_from_message(component, message)
  options = {
    timestamp: RSMP::Clock.parse(message.attribute('aTs')),
    acknowledged: message.attribute('ack') == 'Acknowledged',
    suspended: message.attribute('aS') == 'Suspended',
    active: message.attribute('sS') == 'Active',
    category: message.attribute('cat'),
    priority: message.attribute('pri').to_i,
    rvs: message.attribute('rvs')
  }
  new(component: component, code: message.attribute('aCId'), **options)
end

Instance Method Details

#acknowledge ⇒ Object 



50
51
52
53
54
55
 
# File 'lib/rsmp/component/alarm_state.rb', line 50

def acknowledge
  change = !@acknowledged
  @acknowledged = true
  update_timestamp if change
  change
end

#activate ⇒ Object

according to the rsmp core spec, the only time an alarm changes to unanknowledged, is when it’s activated. See: rsmp-nordic.org/rsmp_specifications/core/3.2.0/applicability/basic_structure.html#alarm-status



74
75
76
77
78
79
80
 
# File 'lib/rsmp/component/alarm_state.rb', line 74

def activate
  change = !@active
  @active = true
  @acknowledged = false
  update_timestamp if change
  change
end

#clear_timestamp ⇒ Object 



105
106
107
 
# File 'lib/rsmp/component/alarm_state.rb', line 105

def clear_timestamp
  @timestamp = nil
end

#deactivate ⇒ Object 



82
83
84
85
86
87
 
# File 'lib/rsmp/component/alarm_state.rb', line 82

def deactivate
  change = @active
  @active = false
  update_timestamp if change
  change
end

#differ_from_message?(message) ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/rsmp/component/alarm_state.rb', line 93

def differ_from_message?(message)
  return true if timestamp_differs?(message)
  return true if acknowledgment_differs?(message)
  return true if suspension_differs?(message)
  return true if activity_differs?(message)
  return true if category_differs?(message)
  return true if priority_differs?(message)

  # return true @rvs = message.attribute('rvs')
  false
end

#older_message?(message) ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
112
113
 
# File 'lib/rsmp/component/alarm_state.rb', line 109

def older_message?(message)
  return false if @timestamp.nil?

  RSMP::Clock.parse(message.attribute('aTs')) < @timestamp
end

#resume ⇒ Object 



64
65
66
67
68
69
 
# File 'lib/rsmp/component/alarm_state.rb', line 64

def resume
  change = @suspended
  @suspended = false
  update_timestamp if change
  change
end

#suspend ⇒ Object 



57
58
59
60
61
62
 
# File 'lib/rsmp/component/alarm_state.rb', line 57

def suspend
  change = !@suspended
  @suspended = true
  update_timestamp if change
  change
end

#to_hash ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rsmp/component/alarm_state.rb', line 36

def to_hash
  {
    'cId' => @component_id,
    '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

#update_from_message(message) ⇒ Object

update from rsmp message component id, alarm code and specialization are not updated



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/rsmp/component/alarm_state.rb', line 117

def update_from_message(message)
  unless differ_from_message? message
    raise RepeatedAlarmError,
          "no changes from previous alarm #{message.m_id_short}"
  end
  raise TimestampError, "timestamp is earlier than previous alarm #{message.m_id_short}" if older_message? message
ensure
  @timestamp = RSMP::Clock.parse 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

#update_timestamp ⇒ Object 



89
90
91
 
# File 'lib/rsmp/component/alarm_state.rb', line 89

def update_timestamp
  @timestamp = @component.now
end