Class: OpenC3::CvtModel

Inherits:
Object show all
Defined in:
lib/openc3/models/cvt_model.rb

Constant Summary collapse

VALUE_TYPES = 
[:RAW, :CONVERTED, :FORMATTED, :WITH_UNITS]
@@packet_cache = 
{}
@@override_cache = 
{}

Class Method Summary collapse

Class Method Details

._get_overrides(now, tgt_pkt_key, overrides, target_name, packet_name, cache_timeout:, scope:) ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/openc3/models/cvt_model.rb', line 295

def self._get_overrides(now, tgt_pkt_key, overrides, target_name, packet_name, cache_timeout:, scope:)
  cache_time, hash = @@override_cache[tgt_pkt_key]
  if hash and (now - cache_time) < cache_timeout
    overrides[tgt_pkt_key] = hash
    return hash
  end
  override_data = Store.hget("#{scope}__override__#{target_name}", packet_name)
  if override_data
    hash = JSON.parse(override_data, :allow_nan => true, :create_additions => true)
    overrides[tgt_pkt_key] = hash
  else
    hash = {}
    overrides[tgt_pkt_key] = {}
  end
  @@override_cache[tgt_pkt_key] = [now, hash] # always update
  return hash
end

._handle_item_override(target_name, packet_name, item_name, type:, cache_timeout:, scope: $openc3_scope) ⇒ Object

PRIVATE METHODS



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/openc3/models/cvt_model.rb', line 269

def self._handle_item_override(target_name, packet_name, item_name, type:, cache_timeout:, scope: $openc3_scope)
  override_key = item_name
  types = []
  case type
  when :WITH_UNITS
    types = ["#{item_name}__U", "#{item_name}__F", "#{item_name}__C", item_name]
    override_key = "#{item_name}__U"
  when :FORMATTED
    types = ["#{item_name}__F", "#{item_name}__C", item_name]
    override_key = "#{item_name}__F"
  when :CONVERTED
    types = ["#{item_name}__C", item_name]
    override_key = "#{item_name}__C"
  when :RAW
    types = [item_name]
  else
    raise "Unknown type '#{type}' for #{target_name} #{packet_name} #{item_name}"
  end

  tgt_pkt_key = "#{scope}__tlm__#{target_name}__#{packet_name}"
  overrides = _get_overrides(Time.now, tgt_pkt_key, {}, target_name, packet_name, cache_timeout: cache_timeout, scope: scope)
  result = overrides[override_key]
  return result, types if result
  return nil, types
end

._parse_item(now, lookups, overrides, item, cache_timeout:, scope:) ⇒ Object

parse item and update lookups with packet_name and target_name and keys return an ordered array of hash with keys



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/openc3/models/cvt_model.rb', line 315

def self._parse_item(now, lookups, overrides, item, cache_timeout:, scope:)
  target_name, packet_name, item_name, value_type = item

  # We build lookup keys by including all the less formatted types to gracefully degrade lookups
  # This allows the user to specify WITH_UNITS and if there is no conversions it will simply return the RAW value
  case value_type.to_s
  when 'RAW'
    keys = [item_name]
  when 'CONVERTED'
    keys = ["#{item_name}__C", item_name]
  when 'FORMATTED'
    keys = ["#{item_name}__F", "#{item_name}__C", item_name]
  when 'WITH_UNITS'
    keys = ["#{item_name}__U", "#{item_name}__F", "#{item_name}__C", item_name]
  else
    raise "Unknown value type '#{value_type}'"
  end

  # Check the overrides cache for this target / packet
  tgt_pkt_key = "#{scope}__tlm__#{target_name}__#{packet_name}"
  _get_overrides(now, tgt_pkt_key, overrides, target_name, packet_name, cache_timeout: cache_timeout, scope: scope) unless overrides[tgt_pkt_key]

  # Set the result as a Hash to distinguish it from the key array and from an overridden Array value
  value = overrides[tgt_pkt_key][keys[0]]
  keys = {'value' => value} if value

  lookups << [tgt_pkt_key, target_name, packet_name, keys]
end

.build_json_from_packet(packet) ⇒ Object 



32
33
34
 
# File 'lib/openc3/models/cvt_model.rb', line 32

def self.build_json_from_packet(packet)
  packet.decom
end

.del(target_name:, packet_name:, scope: $openc3_scope) ⇒ Object

Delete the current value table for a target



37
38
39
40
41
42
 
# File 'lib/openc3/models/cvt_model.rb', line 37

def self.del(target_name:, packet_name:, scope: $openc3_scope)
  key = "#{scope}__tlm__#{target_name}"
  tgt_pkt_key = key + "__#{packet_name}"
  @@packet_cache[tgt_pkt_key] = nil
  Store.hdel(key, packet_name)
end

.determine_latest_packet_for_item(target_name, item_name, cache_timeout: 0.1, scope: $openc3_scope) ⇒ Object 



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/openc3/models/cvt_model.rb', line 249

def self.determine_latest_packet_for_item(target_name, item_name, cache_timeout: 0.1, scope: $openc3_scope)
  item_map = TargetModel.get_item_to_packet_map(target_name, scope: scope)
  packet_names = item_map[item_name]
  raise "Item '#{target_name} LATEST #{item_name}' does not exist for scope: #{scope}" unless packet_names

  latest = -1
  latest_packet_name = nil
  packet_names.each do |packet_name|
    hash = get(target_name: target_name, packet_name: packet_name, cache_timeout: cache_timeout, scope: scope)
    if hash['PACKET_TIMESECONDS'] && hash['PACKET_TIMESECONDS'] > latest
      latest = hash['PACKET_TIMESECONDS']
      latest_packet_name = packet_name
    end
  end
  raise "Item '#{target_name} LATEST #{item_name}' does not exist for scope: #{scope}" if latest == -1
  return latest_packet_name
end

.get(target_name:, packet_name:, cache_timeout: 0.1, scope: $openc3_scope) ⇒ Object

Get the hash for packet in the CVT Note: Does not apply overrides



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/openc3/models/cvt_model.rb', line 55

def self.get(target_name:, packet_name:, cache_timeout: 0.1, scope: $openc3_scope)
  key = "#{scope}__tlm__#{target_name}"
  tgt_pkt_key = key + "__#{packet_name}"
  cache_time, hash = @@packet_cache[tgt_pkt_key]
  now = Time.now
  return hash if hash and (now - cache_time) < cache_timeout
  packet = Store.hget(key, packet_name)
  raise "Packet '#{target_name} #{packet_name}' does not exist" unless packet
  hash = JSON.parse(packet, :allow_nan => true, :create_additions => true)
  @@packet_cache[tgt_pkt_key] = [now, hash]
  hash
end

.get_item(target_name, packet_name, item_name, type:, cache_timeout: 0.1, scope: $openc3_scope) ⇒ Object

Get an item from the current value table



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/openc3/models/cvt_model.rb', line 92

def self.get_item(target_name, packet_name, item_name, type:, cache_timeout: 0.1, scope: $openc3_scope)
  result, types = self._handle_item_override(target_name, packet_name, item_name, type: type, cache_timeout: cache_timeout, scope: scope)
  return result if result
  hash = get(target_name: target_name, packet_name: packet_name, scope: scope)
  hash.values_at(*types).each do |result|
    if result
      if type == :FORMATTED or type == :WITH_UNITS
        return result.to_s
      end
      return result
    end
  end
  return nil
end

.get_tlm_values(items, stale_time: 30, cache_timeout: 0.1, scope: $openc3_scope) ⇒ Array

Return all item values and limit state from the CVT

Parameters:

  • items (Array<String>) —

    Items to return. Must be formatted as TGT__PKT__ITEM__TYPE

  • stale_time (Integer) (defaults to: 30) —

    Time in seconds from Time.now that value will be marked stale

Returns:

  • (Array) —

    Array of values



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/openc3/models/cvt_model.rb', line 112

def self.get_tlm_values(items, stale_time: 30, cache_timeout: 0.1, scope: $openc3_scope)
  now = Time.now
  results = []
  lookups = []
  packet_lookup = {}
  overrides = {}
  # First generate a lookup hash of all the items represented so we can query the CVT
  items.each { |item| _parse_item(now, lookups, overrides, item, cache_timeout: cache_timeout, scope: scope) }

  now = now.to_f
  lookups.each do |target_packet_key, target_name, packet_name, value_keys|
    unless packet_lookup[target_packet_key]
      packet_lookup[target_packet_key] = get(target_name: target_name, packet_name: packet_name, cache_timeout: cache_timeout, scope: scope)
    end
    hash = packet_lookup[target_packet_key]
    item_result = []
    if value_keys.is_a?(Hash) # Set in _parse_item to indicate override
      item_result[0] = value_keys['value']
    else
      value_keys.each do |key|
        item_result[0] = hash[key]
        break if item_result[0] # We want the first value
      end
      # If we were able to find a value, try to get the limits state
      if item_result[0]
        if now - hash['RECEIVED_TIMESECONDS'] > stale_time
          item_result[1] = :STALE
        else
          # The last key is simply the name (RAW) so we can append __L
          # If there is no limits then it returns nil which is acceptable
          item_result[1] = hash["#{value_keys[-1]}__L"]
          item_result[1] = item_result[1].intern if item_result[1] # Convert to symbol
        end
      else
        raise "Item '#{target_name} #{packet_name} #{value_keys[-1]}' does not exist" unless hash.key?(value_keys[-1])
      end
    end
    results << item_result
  end
  results
end

.normalize(target_name, packet_name, item_name, type: :ALL, scope: $openc3_scope) ⇒ Object

Normalize a current value table item such that it returns the actual value



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/openc3/models/cvt_model.rb', line 217

def self.normalize(target_name, packet_name, item_name, type: :ALL, scope: $openc3_scope)
  hash = Store.hget("#{scope}__override__#{target_name}", packet_name)
  hash = JSON.parse(hash, :allow_nan => true, :create_additions => true) if hash
  hash ||= {} # In case the above didn't create anything
  case type
  when :ALL
    hash.delete(item_name)
    hash.delete("#{item_name}__C")
    hash.delete("#{item_name}__F")
    hash.delete("#{item_name}__U")
  when :RAW
    hash.delete(item_name)
  when :CONVERTED
    hash.delete("#{item_name}__C")
  when :FORMATTED
    hash.delete("#{item_name}__F")
  when :WITH_UNITS
    hash.delete("#{item_name}__U")
  else
    raise "Unknown type '#{type}' for #{target_name} #{packet_name} #{item_name}"
  end

  tgt_pkt_key = "#{scope}__tlm__#{target_name}__#{packet_name}"
  if hash.empty?
    @@override_cache.delete(tgt_pkt_key)
    Store.hdel("#{scope}__override__#{target_name}", packet_name)
  else
    @@override_cache[tgt_pkt_key] = [Time.now, hash]
    Store.hset("#{scope}__override__#{target_name}", packet_name, JSON.generate(hash.as_json(:allow_nan => true)))
  end
end

.override(target_name, packet_name, item_name, value, type: :ALL, scope: $openc3_scope) ⇒ Object

Override a current value table item such that it always returns the same value for the given type



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/openc3/models/cvt_model.rb', line 189

def self.override(target_name, packet_name, item_name, value, type: :ALL, scope: $openc3_scope)
  hash = Store.hget("#{scope}__override__#{target_name}", packet_name)
  hash = JSON.parse(hash, :allow_nan => true, :create_additions => true) if hash
  hash ||= {} # In case the above didn't create anything
  case type
  when :ALL
    hash[item_name] = value
    hash["#{item_name}__C"] = value
    hash["#{item_name}__F"] = value.to_s
    hash["#{item_name}__U"] = value.to_s
  when :RAW
    hash[item_name] = value
  when :CONVERTED
    hash["#{item_name}__C"] = value
  when :FORMATTED
    hash["#{item_name}__F"] = value.to_s # Always a String
  when :WITH_UNITS
    hash["#{item_name}__U"] = value.to_s # Always a String
  else
    raise "Unknown type '#{type}' for #{target_name} #{packet_name} #{item_name}"
  end

  tgt_pkt_key = "#{scope}__tlm__#{target_name}__#{packet_name}"
  @@override_cache[tgt_pkt_key] = [Time.now, hash]
  Store.hset("#{scope}__override__#{target_name}", packet_name, JSON.generate(hash.as_json(:allow_nan => true)))
end

.overrides(scope: $openc3_scope) ⇒ Object

Return all the overrides Note: Does not use cache to benefit from hgetall



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/openc3/models/cvt_model.rb', line 156

def self.overrides(scope: $openc3_scope)
  overrides = []
  TargetModel.names(scope: scope).each do |target_name|
    all = Store.hgetall("#{scope}__override__#{target_name}")
    next if all.nil? or all.empty?
    all.each do |packet_name, hash|
      items = JSON.parse(hash, :allow_nan => true, :create_additions => true)
      items.each do |key, value|
        item = {}
        item['target_name'] = target_name
        item['packet_name'] = packet_name
        item_name, value_type_key = key.split('__')
        item['item_name'] = item_name
        case value_type_key
        when 'U'
          item['value_type'] = 'WITH_UNITS'
        when 'F'
          item['value_type'] = 'FORMATTED'
        when 'C'
          item['value_type'] = 'CONVERTED'
        else
          item['value_type'] = 'RAW'
        end
        item['value'] = value
        overrides << item
      end
    end
  end
  overrides
end

.set(hash, target_name:, packet_name:, scope: $openc3_scope) ⇒ Object

Set the current value table for a target, packet



45
46
47
48
49
50
51
 
# File 'lib/openc3/models/cvt_model.rb', line 45

def self.set(hash, target_name:, packet_name:, scope: $openc3_scope)
  packet_json = JSON.generate(hash.as_json(:allow_nan => true))
  key = "#{scope}__tlm__#{target_name}"
  tgt_pkt_key = key + "__#{packet_name}"
  @@packet_cache[tgt_pkt_key] = [Time.now, hash]
  Store.hset(key, packet_name, packet_json)
end

.set_item(target_name, packet_name, item_name, value, type:, scope: $openc3_scope) ⇒ Object

Set an item in the current value table



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/openc3/models/cvt_model.rb', line 69

def self.set_item(target_name, packet_name, item_name, value, type:, scope: $openc3_scope)
  hash = get(target_name: target_name, packet_name: packet_name, cache_timeout: 0.0, scope: scope)
  case type
  when :WITH_UNITS
    hash["#{item_name}__U"] = value.to_s # WITH_UNITS should always be a string
  when :FORMATTED
    hash["#{item_name}__F"] = value.to_s # FORMATTED should always be a string
  when :CONVERTED
    hash["#{item_name}__C"] = value
  when :RAW
    hash[item_name] = value
  when :ALL
    hash["#{item_name}__U"] = value.to_s # WITH_UNITS should always be a string
    hash["#{item_name}__F"] = value.to_s # FORMATTED should always be a string
    hash["#{item_name}__C"] = value
    hash[item_name] = value
  else
    raise "Unknown type '#{type}' for #{target_name} #{packet_name} #{item_name}"
  end
  set(hash, target_name: target_name, packet_name: packet_name, scope: scope)
end