Class: RSMP::SupervisorProxy

Inherits:
Proxy
  • Object
show all
Defined in:
lib/rsmp/supervisor_proxy.rb

Constant Summary

Constants inherited from Proxy

Proxy::WRAPPING_DELIMITER

Instance Attribute Summary collapse

Attributes inherited from Proxy

#archive, #collector, #connection_info, #ip, #port, #state, #sxl, #task

Attributes included from Logging

#archive, #logger

Instance Method Summary collapse

Methods inherited from Proxy

#acknowledge, #acknowledged_first_outgoing, #author, #buffer_message, #check_ack_timeout, #check_ingoing_acknowledged, #check_outgoing_acknowledged, #check_rsmp_version, #check_watchdog_timeout, #clear, #clock, #close_socket, #collect, #dont_acknowledge, #dont_expect_acknowledgement, #expect_acknowledgement, #expect_version_message, #extraneous_version, #find_original_for_message, #get_schemas, #inspect, #log, #log_acknowledgement_for_original, #log_acknowledgement_for_unknown, #log_send, #notify_error, #prepare_collection, #process_ack, #process_not_ack, #process_packet, #process_watchdog, #ready?, #revive, #rsmp_versions, #run, #send_message, #send_version, #send_watchdog, #set_state, #setup, #start_reader, #start_timer, #start_watchdog, #stop_tasks, #version_acknowledged, #wait_for_acknowledgement, #wait_for_state, #watchdog_send_timer, #will_not_handle

Methods included from Inspect

#inspect, #inspector

Methods included from Notifier

#add_listener, #initialize_distributor, #inspect, #notify, #remove_listener

Methods included from Wait

#wait_for

Methods included from Logging

#author, #initialize_logging, #log

Constructor Details

#initialize(options) ⇒ SupervisorProxy

Returns a new instance of SupervisorProxy.


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

def initialize options
  super options
  @site = options[:site]
  @site_settings = @site.site_settings.clone
  @ip = options[:ip]
  @port = options[:port]
  @status_subscriptions = {}
  @sxl = @site_settings['sxl']
  @synthetic_id = Supervisor.build_id_from_ip_port @ip, @port
end

Instance Attribute Details

#siteObject (readonly)

Returns the value of attribute site.


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

def site
  @site
end

#supervisor_idObject (readonly)

Returns the value of attribute supervisor_id.


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

def supervisor_id
  @supervisor_id
end

Instance Method Details

#acknowledged_first_ingoing(message) ⇒ Object


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

def acknowledged_first_ingoing message
  # TODO
  # aggregateds status should only be send for later version of rsmp
  # to handle verison differences, we probably need inherited classes
  case message.type
    when "Watchdog"
      if @site_settings['send_after_connect']
        send_all_aggregated_status
      end
  end
end

#check_sxl_version(message) ⇒ Object


388
389
# File 'lib/rsmp/supervisor_proxy.rb', line 388

def check_sxl_version message
end

#connectObject


47
48
49
50
51
52
53
# File 'lib/rsmp/supervisor_proxy.rb', line 47

def connect
  return if @socket
  @endpoint = Async::IO::Endpoint.tcp(@ip, @port)
  @socket = @endpoint.connect
  @stream = Async::IO::Stream.new(@socket)
  @protocol = Async::IO::Protocol::Line.new(@stream,WRAPPING_DELIMITER) # rsmp messages are json terminated with a form-feed
end

#connection_completeObject


55
56
57
58
59
60
# File 'lib/rsmp/supervisor_proxy.rb', line 55

def connection_complete
  super
  sanitized_sxl_version = RSMP::Schemer.sanitize_version(sxl_version)
  log "Connection to supervisor established, using core #{@rsmp_version}, #{sxl} #{sanitized_sxl_version}", level: :info
  start_watchdog
end

#fetch_last_sent_status(component, code, name) ⇒ Object


286
287
288
289
290
291
292
# File 'lib/rsmp/supervisor_proxy.rb', line 286

def fetch_last_sent_status component, code, name
  if @last_status_sent && @last_status_sent[component] && @last_status_sent[component][code]
    @last_status_sent[component][code][name]
  else
    nil
  end
end

#nodeObject


21
22
23
# File 'lib/rsmp/supervisor_proxy.rb', line 21

def node
  site
end

#process_aggregated_status(message) ⇒ Object


151
152
153
154
155
156
157
# File 'lib/rsmp/supervisor_proxy.rb', line 151

def process_aggregated_status message
  se = message.attribute("se")
  validate_aggregated_status(message,se) == false
  on = set_aggregated_status se
  log "Received #{message.type} status [#{on.join(', ')}]", message: message, level: :log
  acknowledge message
end

#process_aggregated_status_request(message) ⇒ Object


180
181
182
183
184
185
186
# File 'lib/rsmp/supervisor_proxy.rb', line 180

def process_aggregated_status_request message
  log "Received #{message.type}", message: message, level: :log
  component_id = message.attributes["cId"]
  component = @site.find_component component_id
  acknowledge message
  send_aggregated_status component
end

#process_alarm(message) ⇒ Object


159
160
161
162
163
164
165
# File 'lib/rsmp/supervisor_proxy.rb', line 159

def process_alarm message
  alarm_code = message.attribute("aCId")
  asp = message.attribute("aSp")
  status = ["ack","aS","sS"].map { |key| message.attribute(key) }.join(',')
  log "Received #{message.type}, #{alarm_code} #{asp} [#{status}]", message: message, level: :log
  acknowledge message
end

#process_command_request(message) ⇒ Object


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/rsmp/supervisor_proxy.rb', line 188

def process_command_request message
  log "Received #{message.type}", message: message, level: :log
  component_id = message.attributes["cId"]
  component = @site.find_component component_id
  commands = simplify_command_requests message.attributes["arg"]
  commands.each_pair do |command_code,arg|
    component.handle_command command_code,arg
  end

  rvs = message.attributes["arg"].map do |item|
    item = item.dup.merge('age'=>'recent')
    item.delete 'cO'
    item
  end
  response = CommandResponse.new({
    "cId"=>component_id,
    "cTS"=>clock.to_s,
    "rvs"=>rvs
  })
  acknowledge message
  send_message response
end

#process_deferredObject


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

def process_deferred
  site.process_deferred
end

#process_message(message) ⇒ Object


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/rsmp/supervisor_proxy.rb', line 62

def process_message message
  case message
    when Alarm
    when StatusResponse
    when StatusUpdate
    when AggregatedStatus
      will_not_handle message
    when AggregatedStatusRequest
      process_aggregated_status_request message
    when CommandRequest
      process_command_request message
    when CommandResponse
      process_command_response message
    when StatusRequest
      process_status_request message
    when StatusSubscribe
      process_status_subcribe message
    when StatusUnsubscribe
      process_status_unsubcribe message
    else
      super message
  end
rescue UnknownComponent, UnknownCommand, UnknownStatus,
       MessageRejected, MissingAttribute => e
  dont_acknowledge message, '', e.to_s
end

#process_status_request(message, options = {}) ⇒ Object


211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/rsmp/supervisor_proxy.rb', line 211

def process_status_request message, options={}
  component_id = message.attributes["cId"]
  component = @site.find_component component_id
  log "Received #{message.type}", message: message, level: :log
  sS = message.attributes["sS"].map do |arg|
    value, quality =  component.get_status arg['sCI'], arg['n']
    { "s" => value.to_s, "q" => quality.to_s }.merge arg
  end
  response = StatusResponse.new({
    "cId"=>component_id,
    "sTs"=>clock.to_s,
    "sS"=>sS,
    "mId" => options[:m_id]
  })
  acknowledge message
  send_message response
end

#process_status_subcribe(message) ⇒ Object


229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/rsmp/supervisor_proxy.rb', line 229

def process_status_subcribe message
  log "Received #{message.type}", message: message, level: :log


  # @status_subscriptions is organized by component/code/name, for example:
  #
  # {"AA+BBCCC=DDDEE002"=>{"S001"=>["number"]}}
  #
  # This is done to make it easy to send a single status update
  # for each component, containing all the requested statuses

  update_list = {}

  component = message.attributes["cId"]
  
  @status_subscriptions[component] ||= {}
  update_list[component] ||= {} 

  subs = @status_subscriptions[component]
  now = Time.now  # internal timestamp

  message.attributes["sS"].each do |arg|
    sCI = arg["sCI"]
    subcription = {interval: arg["uRt"].to_i, last_sent_at: now}
    subs[sCI] ||= {}
    subs[sCI][arg["n"]] = subcription

    update_list[component][sCI] ||= []
    update_list[component][sCI] << arg["n"]
  end
  acknowledge message
  send_status_updates update_list   # send status after subscribing is accepted
end

#process_status_unsubcribe(message) ⇒ Object


263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/rsmp/supervisor_proxy.rb', line 263

def process_status_unsubcribe message
  log "Received #{message.type}", message: message, level: :log
  component = message.attributes["cId"]

  subs = @status_subscriptions[component]
  if subs
    message.attributes["sS"].each do |arg|
      sCI = arg["sCI"]
      if subs[sCI]
        subs[sCI].delete arg["n"]
        subs.delete(sCI) if subs[sCI].empty?
      end
    end
    @status_subscriptions.delete(component) if subs.empty?
  end
  acknowledge message
end

#process_version(message) ⇒ Object


380
381
382
383
384
385
386
# File 'lib/rsmp/supervisor_proxy.rb', line 380

def process_version message
  return extraneous_version message if @version_determined
  check_rsmp_version message
  check_sxl_version message
  @site_id = Supervisor.build_id_from_ip_port @ip, @port
  version_accepted message
end

#reconnect_delayObject


113
114
115
116
117
# File 'lib/rsmp/supervisor_proxy.rb', line 113

def reconnect_delay
  interval = @site_settings['intervals']['reconnect']
  log "Waiting #{interval} seconds before trying to reconnect", level: :info
  @task.sleep interval
end

#send_aggregated_status(component, options = {}) ⇒ Object


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/rsmp/supervisor_proxy.rb', line 127

def send_aggregated_status component, options={}
  m_id = options[:m_id] || RSMP::Message.make_m_id
  message = AggregatedStatus.new({
    "aSTS" => clock.to_s,
    "cId" =>  component.c_id,
    "fP" => 'NormalControl',
    "fS" => nil,
    "se" => component.aggregated_status_bools,
    "mId" => m_id,
  })

  if options[:collect]
    result = nil
    task = @task.async do |task|
      wait_for_acknowledgement task, options[:collect], m_id
    end
    send_message message, validate: options[:validate]
    return message, task.wait
  else
    send_message message, validate: options[:validate]
    message
  end
end

#send_alarmObject


366
367
368
369
370
371
372
373
374
# File 'lib/rsmp/supervisor_proxy.rb', line 366

def send_alarm
  message = Alarm.new({
    "aSTS"=>clock.to_s,
    "fP"=>nil,
    "fS"=>nil,
    "se"=>@site.aggregated_status_bools
  })
  send_message message
end

#send_all_aggregated_statusObject


105
106
107
108
109
110
111
# File 'lib/rsmp/supervisor_proxy.rb', line 105

def send_all_aggregated_status
  @site.components.each_pair do |c_id,component|
    if component.grouped
      send_aggregated_status component
    end
  end
end

#send_status_updates(update_list) ⇒ Object


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
# File 'lib/rsmp/supervisor_proxy.rb', line 339

def send_status_updates update_list
  now = clock.to_s
  update_list.each_pair do |component_id,by_code|
    component = @site.find_component component_id
    sS = []
    by_code.each_pair do |code,names|
      names.map do |status_name,value|
        if value
          quality = 'recent'
        else
          value,quality = component.get_status code, status_name
        end
        sS << { "sCI" => code,
                 "n" => status_name,
                 "s" => value.to_s,
                 "q" => quality }
      end
    end
    update = StatusUpdate.new({
      "cId"=>component_id,
      "sTs"=>now,
      "sS"=>sS
    })
    send_message update
  end
end

#simplify_command_requests(arg) ⇒ Object

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: “securityCode”=>“5678”, “timeplan”=>“3”}


171
172
173
174
175
176
177
178
# File 'lib/rsmp/supervisor_proxy.rb', line 171

def simplify_command_requests arg
  sorted = {}
  arg.each do |item|
    sorted[item['cCI']] ||= {}
    sorted[item['cCI']][item['n']] = item['v']
  end
  sorted
end

#startObject


25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# File 'lib/rsmp/supervisor_proxy.rb', line 25

def start
  log "Connecting to superviser at #{@ip}:#{@port}", level: :info
  super
  connect
  @logger.unmute @ip, @port
  log "Connected to superviser at #{@ip}:#{@port}", level: :info
  start_reader
  send_version @site_settings['site_id'], @site_settings["rsmp_versions"]
rescue Errno::ECONNREFUSED
  log "No connection to supervisor at #{@ip}:#{@port}", level: :error
  unless @site.site_settings['intervals']['reconnect'] == :no
    log "Will try to reconnect again every #{@site.site_settings['intervals']['reconnect']} seconds..", level: :info
    @logger.mute @ip, @port
  end
end

#status_update_timer(now) ⇒ Object


301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
# File 'lib/rsmp/supervisor_proxy.rb', line 301

def status_update_timer now
  update_list = {}
  # go through subscriptons and build a similarly organized list,
  # that only contains what should be send

  @status_subscriptions.each_pair do |component,by_code|
    component_object = @site.find_component component
    by_code.each_pair do |code,by_name|
      by_name.each_pair do |name,subscription|
        current = nil
        if subscription[:interval] == 0 
          # send as soon as the data changes
          if component_object
            current, age = *(component_object.get_status code, name)
          end
          last_sent = fetch_last_sent_status component, code, name
          if current != last_sent
            should_send = true
            store_last_sent_status component, code, name, current
          end
        else
          # send at regular intervals
          if subscription[:last_sent_at] == nil || (now - subscription[:last_sent_at]) >= subscription[:interval]
            should_send = true
          end
        end
        if should_send
          subscription[:last_sent_at] = now
          update_list[component] ||= {}
          update_list[component][code] ||= {}
          update_list[component][code][name] = current
       end
      end
    end
  end
  send_status_updates update_list
end

#stopObject


41
42
43
44
45
# File 'lib/rsmp/supervisor_proxy.rb', line 41

def stop
  log "Closing connection to supervisor", level: :info
  super
  @last_status_sent = nil
end

#store_last_sent_status(component, code, name, value) ⇒ Object


294
295
296
297
298
299
# File 'lib/rsmp/supervisor_proxy.rb', line 294

def store_last_sent_status component, code, name, value
  @last_status_sent ||= {}
  @last_status_sent[component] ||= {}
  @last_status_sent[component][code] ||= {}
  @last_status_sent[component][code][name] = value
end

#sxl_versionObject


376
377
378
# File 'lib/rsmp/supervisor_proxy.rb', line 376

def sxl_version
  @site_settings['sxl_version']
end

#timer(now) ⇒ Object


281
282
283
284
# File 'lib/rsmp/supervisor_proxy.rb', line 281

def timer now
  super
  status_update_timer now if ready?
end

#version_accepted(message) ⇒ Object


119
120
121
122
123
124
125
# File 'lib/rsmp/supervisor_proxy.rb', line 119

def version_accepted message
  log "Received Version message, using RSMP #{@rsmp_version}", message: message, level: :log
  start_timer
  acknowledge message
  connection_complete
  @version_determined = true
end