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]

Class Method Summary collapse

Class Method Details

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

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

Raises:

  • (ArgumentError) 


206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/openc3/models/cvt_model.rb', line 206

def self._parse_item(lookups, overrides, item, scope:)
  target_name, packet_name, item_name, value_type = item.split('__')
  raise ArgumentError, "items must be formatted as TGT__PKT__ITEM__TYPE" if target_name.nil? || packet_name.nil? || item_name.nil? || value_type.nil?

  # 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.upcase
  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
  tgt_pkt_key = "#{target_name}__#{packet_name}"
  # Check the overrides cache for this target / packet
  unless overrides[tgt_pkt_key]
    override_data = Store.hget("#{scope}__override__#{target_name}", packet_name)
    if override_data
      overrides[tgt_pkt_key] = JSON.parse(override_data, :allow_nan => true, :create_additions => true)
    else
      overrides[tgt_pkt_key] = {}
    end
  end
  if overrides[tgt_pkt_key][keys[0]]
    # Set the result as a Hash to distingish it from the key array and from an overridden Array value
    keys = {'value' => overrides[tgt_pkt_key][keys[0]]}
  end
  lookups << [tgt_pkt_key, target_name, packet_name, keys]
end

.build_json_from_packet(packet) ⇒ Object 



28
29
30
 
# File 'lib/openc3/models/cvt_model.rb', line 28

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



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

def self.del(target_name:, packet_name:, scope: $openc3_scope)
  Store.hdel("#{scope}__tlm__#{target_name}", packet_name)
end

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

Get an item from the current value table



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/openc3/models/cvt_model.rb', line 64

def self.get_item(target_name, packet_name, item_name, type:, 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
  overrides = Store.hget("#{scope}__override__#{target_name}", packet_name)
  if overrides
    result = JSON.parse(overrides, :allow_nan => true, :create_additions => true)[override_key]
    return result if result
  end
  hash = JSON.parse(Store.hget("#{scope}__tlm__#{target_name}", packet_name), :allow_nan => true, :create_additions => true)
  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, 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



104
105
106
107
108
109
110
111
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
 
# File 'lib/openc3/models/cvt_model.rb', line 104

def self.get_tlm_values(items, stale_time: 30, scope: $openc3_scope)
  now = Time.now.sys.to_f
  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(lookups, overrides, item, scope: scope) }

  lookups.each do |target_packet_key, target_name, packet_name, value_keys|
    unless packet_lookup[target_packet_key]
      packet = Store.hget("#{scope}__tlm__#{target_name}", packet_name)
      raise "Packet '#{target_name} #{packet_name}' does not exist" unless packet
      packet_lookup[target_packet_key] = JSON.parse(packet, :allow_nan => true, :create_additions => true)
    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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/openc3/models/cvt_model.rb', line 174

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
  if hash.empty?
    Store.hdel("#{scope}__override__#{target_name}", packet_name)
  else
    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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/openc3/models/cvt_model.rb', line 149

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
  Store.hset("#{scope}__override__#{target_name}", packet_name, JSON.generate(hash.as_json(:allow_nan => true)))
end

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

Set the current value table for a target, packet



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

def self.set(hash, target_name:, packet_name:, scope: $openc3_scope)
  Store.hset("#{scope}__tlm__#{target_name}", packet_name, JSON.generate(hash.as_json(:allow_nan => true)))
end

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

Set an item in the current value table



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/openc3/models/cvt_model.rb', line 43

def self.set_item(target_name, packet_name, item_name, value, type:, scope: $openc3_scope)
  case type
  when :WITH_UNITS
    field = "#{item_name}__U"
    value = value.to_s # WITH_UNITS should always be a string
  when :FORMATTED
    field = "#{item_name}__F"
    value = value.to_s # FORMATTED should always be a string
  when :CONVERTED
    field = "#{item_name}__C"
  when :RAW
    field = item_name
  else
    raise "Unknown type '#{type}' for #{target_name} #{packet_name} #{item_name}"
  end
  hash = JSON.parse(Store.hget("#{scope}__tlm__#{target_name}", packet_name), :allow_nan => true, :create_additions => true)
  hash[field] = value
  Store.hset("#{scope}__tlm__#{target_name}", packet_name, JSON.generate(hash.as_json(:allow_nan => true)))
end