RubyGems - cosmos-unpacking_interface - Versions diffs - 1.0.0 - Mend

cosmos-unpacking_interface 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (84) hide show

checksums.yaml +7 -0
data/.gitignore +10 -0
data/.travis.yml +7 -0
data/Gemfile +4 -0
data/LICENSE.txt +21 -0
data/README.md +158 -0
data/Rakefile +12 -0
data/bin/console +14 -0
data/bin/setup +8 -0
data/config/data/README.txt +1 -0
data/config/data/crc.txt +198 -0
data/config/system/system.txt +29 -0
data/config/targets/COSMOS/cmd_tlm/cosmos_server_cmds.txt +41 -0
data/config/targets/COSMOS/cmd_tlm/cosmos_server_tlm.txt +15 -0
data/config/targets/COSMOS/cmd_tlm_server.txt +6 -0
data/config/targets/COSMOS/screens/limits_change.txt +20 -0
data/config/targets/COSMOS/screens/version.txt +19 -0
data/config/targets/COSMOS/target.txt +9 -0
data/config/targets/PI/cmd_tlm/pi_tlm_test.txt +12 -0
data/config/targets/PI/cmd_tlm/pi_tlm_test_1.txt +13 -0
data/config/targets/PI/cmd_tlm/pi_tlm_test_2.txt +68 -0
data/config/targets/PI/cmd_tlm/pi_tlm_test_3.txt +12 -0
data/config/targets/PI/cmd_tlm_server.txt +4 -0
data/config/targets/PI/target.txt +4 -0
data/cosmos-unpacking_interface.gemspec +34 -0
data/doc/Cosmos.html +98 -0
data/doc/Cosmos/AggregatePacketMapper.html +152 -0
data/doc/Cosmos/AggregatePacketProcesser.html +249 -0
data/doc/Cosmos/BaseNameMap.html +364 -0
data/doc/Cosmos/UnpackingInterface.html +399 -0
data/doc/UnpackingInterface.html +110 -0
data/doc/created.rid +7 -0
data/doc/css/fonts.css +167 -0
data/doc/css/rdoc.css +590 -0
data/doc/fonts/Lato-Light.ttf +0 -0
data/doc/fonts/Lato-LightItalic.ttf +0 -0
data/doc/fonts/Lato-Regular.ttf +0 -0
data/doc/fonts/Lato-RegularItalic.ttf +0 -0
data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
data/doc/images/add.png +0 -0
data/doc/images/arrow_up.png +0 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/delete.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_blue.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/transparent.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +91 -0
data/doc/js/darkfish.js +161 -0
data/doc/js/jquery.js +4 -0
data/doc/js/navigation.js +141 -0
data/doc/js/navigation.js.gz +0 -0
data/doc/js/search.js +109 -0
data/doc/js/search_index.js +1 -0
data/doc/js/search_index.js.gz +0 -0
data/doc/js/searcher.js +229 -0
data/doc/js/searcher.js.gz +0 -0
data/doc/lib/README_rdoc.html +118 -0
data/doc/table_of_contents.html +140 -0
data/lib/cosmos/unpacking_interface.rb +14 -0
data/lib/cosmos/unpacking_interface/aggregate_packet_mapper.rb +14 -0
data/lib/cosmos/unpacking_interface/aggregate_packet_processor.rb +42 -0
data/lib/cosmos/unpacking_interface/base_name_map.rb +67 -0
data/lib/cosmos/unpacking_interface/unpacking_interface.rb +87 -0
data/lib/cosmos/unpacking_interface/version.rb +3 -0
metadata +174 -0

data/doc/table_of_contents.html ADDED Viewed

@@ -0,0 +1,140 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8">
+<title>Table of Contents - RDoc Documentation</title>
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+<script src="./js/jquery.js"></script>
+<script src="./js/darkfish.js"></script>
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+<body id="top" class="table-of-contents">
+<main role="main">
+<h1 class="class">Table of Contents - RDoc Documentation</h1>
+<h2 id="classes">Classes and Modules</h2>
+<ul>
+  <li class="module">
+    <a href="Cosmos.html">Cosmos</a>
+  </li>
+  <li class="class">
+    <a href="Cosmos/AggregatePacketMapper.html">Cosmos::AggregatePacketMapper</a>
+  </li>
+  <li class="class">
+    <a href="Cosmos/AggregatePacketProcesser.html">Cosmos::AggregatePacketProcesser</a>
+  </li>
+  <li class="class">
+    <a href="Cosmos/BaseNameMap.html">Cosmos::BaseNameMap</a>
+  </li>
+  <li class="class">
+    <a href="Cosmos/UnpackingInterface.html">Cosmos::UnpackingInterface</a>
+  </li>
+  <li class="module">
+    <a href="UnpackingInterface.html">UnpackingInterface</a>
+  </li>
+</ul>
+<h2 id="methods">Methods</h2>
+<ul>
+  <li class="method">
+    <a href="Cosmos/AggregatePacketProcesser.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Cosmos::AggregatePacketProcesser</span>
+  <li class="method">
+    <a href="Cosmos/BaseNameMap.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Cosmos::BaseNameMap</span>
+  <li class="method">
+    <a href="Cosmos/AggregatePacketProcesser.html#method-i-_extract_map">#_extract_map</a>
+    &mdash;
+    <span class="container">Cosmos::AggregatePacketProcesser</span>
+  <li class="method">
+    <a href="Cosmos/BaseNameMap.html#method-i-_field_arity">#_field_arity</a>
+    &mdash;
+    <span class="container">Cosmos::BaseNameMap</span>
+  <li class="method">
+    <a href="Cosmos/BaseNameMap.html#method-i-_max_arity">#_max_arity</a>
+    &mdash;
+    <span class="container">Cosmos::BaseNameMap</span>
+  <li class="method">
+    <a href="Cosmos/UnpackingInterface.html#method-i-agg_pkt_map">#agg_pkt_map</a>
+    &mdash;
+    <span class="container">Cosmos::UnpackingInterface</span>
+  <li class="method">
+    <a href="Cosmos/AggregatePacketMapper.html#method-i-build_map">#build_map</a>
+    &mdash;
+    <span class="container">Cosmos::AggregatePacketMapper</span>
+  <li class="method">
+    <a href="Cosmos/UnpackingInterface.html#method-i-connect">#connect</a>
+    &mdash;
+    <span class="container">Cosmos::UnpackingInterface</span>
+  <li class="method">
+    <a href="Cosmos/BaseNameMap.html#method-i-extract_all">#extract_all</a>
+    &mdash;
+    <span class="container">Cosmos::BaseNameMap</span>
+  <li class="method">
+    <a href="Cosmos/UnpackingInterface.html#method-i-packet_mapper">#packet_mapper</a>
+    &mdash;
+    <span class="container">Cosmos::UnpackingInterface</span>
+  <li class="method">
+    <a href="Cosmos/UnpackingInterface.html#method-i-process">#process</a>
+    &mdash;
+    <span class="container">Cosmos::UnpackingInterface</span>
+  <li class="method">
+    <a href="Cosmos/UnpackingInterface.html#method-i-read">#read</a>
+    &mdash;
+    <span class="container">Cosmos::UnpackingInterface</span>
+  <li class="method">
+    <a href="Cosmos/BaseNameMap.html#method-i-size">#size</a>
+    &mdash;
+    <span class="container">Cosmos::BaseNameMap</span>
+  <li class="method">
+    <a href="Cosmos/UnpackingInterface.html#method-i-target">#target</a>
+    &mdash;
+    <span class="container">Cosmos::UnpackingInterface</span>
+  <li class="method">
+    <a href="Cosmos/UnpackingInterface.html#method-i-transforms">#transforms</a>
+    &mdash;
+    <span class="container">Cosmos::UnpackingInterface</span>
+  <li class="method">
+    <a href="Cosmos/AggregatePacketProcesser.html#method-i-unpack">#unpack</a>
+    &mdash;
+    <span class="container">Cosmos::AggregatePacketProcesser</span>
+</ul>
+</main>
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.1.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>

data/lib/cosmos/unpacking_interface.rb ADDED Viewed

@@ -0,0 +1,14 @@
+require "cosmos/unpacking_interface/version"
+##
+# A custom extendable interface that unpacks aggregate packets (packets with many granules) into many
+# simple packets (packets with a single granule). This way we can use all the cosmos niceties
+# without having to send packets for individual measurements. Essentially we unpack an aggregate
+# packet into many packets that are stored in a queue that is read from. When the queue is empty
+# we look for new aggregate packets
+module UnpackingInterface
+end
+require "cosmos/unpacking_interface/base_name_map"
+require "cosmos/unpacking_interface/aggregate_packet_mapper"
+require "cosmos/unpacking_interface/aggregate_packet_processor"
+require "cosmos/unpacking_interface/unpacking_interface"

data/lib/cosmos/unpacking_interface/aggregate_packet_mapper.rb ADDED Viewed

@@ -0,0 +1,14 @@
+##
+# Encapsulates the conversion of an aggregate packet into a BaseNameMap, our
+# internal representation of the fields in an aggregate packet
+module Cosmos
+class AggregatePacketMapper
+  ##
+  # Builds a BaseNameMap from a cosmos aggregate packet
+  def build_map(packet)
+    BaseNameMap.new({}, packet.packet_name)
+  end
+end
+end

data/lib/cosmos/unpacking_interface/aggregate_packet_processor.rb ADDED Viewed

@@ -0,0 +1,42 @@
+module Cosmos
+##
+# Encapsulates the transformation of an aggregate packet into many simple packets
+class AggregatePacketProcesser
+  def initialize(mapper, transforms = {})
+    @mapper = mapper
+    @transforms = transforms
+  end
+  ##
+  # Converts the aggregate packet into an array of simple packets.
+  def unpack(packet, target, item)
+    values_map = @mapper.build_map(packet) #
+    _extract_map(values_map, target, item)
+  end
+  ##
+  # Extract our internal BaseNameMap into an array of packets of type target/item, applying
+  # transformations if applicable
+  def _extract_map(map, target, item)
+    map.extract_all.each_with_index.map do |m, i|
+     keys = m.keys
+     pkt = System.telemetry.packet(target, item).clone
+     keys.reduce(pkt) do |p, key|
+       value = m[key]
+       transform_key = [target, item, key].join("-")
+       if @transforms[transform_key]
+         p.write(key, @transforms[transform_key].call(target, item, key, value, i))
+       else
+         p.write(key, value)
+       end
+       p
+     end
+    end
+  end
+end
+end

data/lib/cosmos/unpacking_interface/base_name_map.rb ADDED Viewed

@@ -0,0 +1,67 @@
+##
+# Internal respresentation of an aggregate packet
+module Cosmos
+class BaseNameMap
+  attr_accessor :map, :name
+  ##
+  # map is a hash where keys are normalized item names (i.e. VALUE_A instead of VALUE_A_0) and
+  # values are arrays of all the values whose original keys (VALUE_A_x) mapped to that value. For example:
+  # { 'VALUE_A' => [1,2,3]}.
+  #
+  # name is the name of the packet
+  def initialize(map, name)
+    @map = map
+    @name = name # packet name
+  end
+  ##
+  # Number of simple packets contained within the aggregate packet
+  def size
+    if @map.empty?
+      return 0
+    else
+      _max_arity
+    end
+  end
+  def _max_arity
+    return 0 if @map.empty?
+    @map.max_by {|k, v| v.length}.last.length
+  end
+  def _field_arity(k)
+    result = @map[k]
+    if result.nil?
+      0
+    else
+      result.length
+    end
+  end
+  ##
+  # Expands map of keys to arrays of values into a single array containing hashes where
+  # each key maps to only a single value
+  # i.e. {'VALUE_A' => [1,2]} => [{'VALUE_A' => 1}, {'VALUE_A' => 2}]
+  def extract_all
+   max = _max_arity
+   range = if(max > 0)
+     [*0..(max - 1)]
+   else
+     [0]
+   end
+   range.map do |i|
+     keys = @map.keys
+     keys.reduce({}) do |acc, k|
+       if(_field_arity(k) == 1)
+         acc[k] = @map[k].first
+       else
+         acc[k] = @map[k][i]
+       end
+       acc
+     end
+   end
+  end
+end
+end

data/lib/cosmos/unpacking_interface/unpacking_interface.rb ADDED Viewed

@@ -0,0 +1,87 @@
+require 'cosmos'
+require 'cosmos/interfaces/tcpip_server_interface'
+module Cosmos
+##
+# A custom interface that unpacks aggregate packets (packets with many granules) into many
+# simple packets (packets with a single granule). This way we can use all the cosmos niceties
+# without having to send packets for individual measurements. Essentially we unpack an aggregate
+# packet into many packets that are stored in a queue that is read from. When the queue is empty
+# we look for new aggregate packets
+class UnpackingInterface < TcpipServerInterface
+  ##
+  # Transformations defined on an item in a simple packet. Entries should be of the
+  # form: "<TARGET>-<PACKET_NAME>-<ITEM_NAME>" => Proc
+  # where the proc can accept the following parameters TargetName, ItemName, key, value, index
+  # index is the index of the granule in the aggregate packet that was transformed into the simple packet
+  # More info about procs can be found here: https://ruby-doc.org/core-2.4.1/Proc.html
+  def transforms
+    {}
+  end
+  ##
+  # Maps aggregate packets (packets with many granules) to simple packets (packets with a single granule)
+  # should have the form 'AggregatePacket' => 'SimplePacket'
+  # For example: 'Science' => 'Science2'
+  def agg_pkt_map
+    {}
+  end
+  ##
+  # Cosmos target interface is being used with
+  def target
+   ""
+  end
+  ##
+  # Create and return a new instance of your own custom PacketMapper
+  def packet_mapper
+    PacketMapper.new
+  end
+  def connect
+    @derived_queue = []
+    super()
+  end
+  ##
+  # Unpack an aggregate packet if necessary and add resulting packets to the internal FIFO queue
+  def process(packet:, target:, agg_packet:, simple_packet:)
+     agg_pkt = System.telemetry.packet(target, agg_packet)
+     if(agg_pkt.identify?(packet.buffer))
+       processor = AggregatePacketProcesser.new(packet_mapper, transforms)
+       agg_pkt.buffer = packet.buffer.clone
+       result = processor.unpack(agg_pkt, target, simple_packet)
+       @derived_queue.concat(result)
+     end
+     return packet
+  end
+  ##
+  # This method is called by COSMOS internally, essentially if we have packets on the queue read those
+  # otherwise wait for a packet, and unpack if necessary
+  def read
+    if !@derived_queue.empty?
+      p1 = @derived_queue.shift
+      return p1
+    else
+     # This is a blocking call to wait for an actual packet to come over the wire
+     packet = super()
+     agg_pkt_map.select do |agg_packet, simple_packet|
+       agg_pkt = System.telemetry.packet(target, agg_packet)
+       if(agg_pkt.identify?(packet.buffer))
+         process(packet: packet, target: target, agg_packet: agg_packet, simple_packet: simple_packet)
+       end
+     end
+     return packet
+    end
+  end
+end
+end

data/lib/cosmos/unpacking_interface/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module UnpackingInterface
+  VERSION = "1.0.0"
+end

metadata ADDED Viewed

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: cosmos-unpacking_interface
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Center for Space Engineering
+- Nick Benoit
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2019-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: cosmos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description:
+email:
+- cse@engineering.usu.edu
+- nick.benoit14@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/data/README.txt
+- config/data/crc.txt
+- config/system/system.txt
+- config/targets/COSMOS/cmd_tlm/cosmos_server_cmds.txt
+- config/targets/COSMOS/cmd_tlm/cosmos_server_tlm.txt
+- config/targets/COSMOS/cmd_tlm_server.txt
+- config/targets/COSMOS/screens/limits_change.txt
+- config/targets/COSMOS/screens/version.txt
+- config/targets/COSMOS/target.txt
+- config/targets/PI/cmd_tlm/pi_tlm_test.txt
+- config/targets/PI/cmd_tlm/pi_tlm_test_1.txt
+- config/targets/PI/cmd_tlm/pi_tlm_test_2.txt
+- config/targets/PI/cmd_tlm/pi_tlm_test_3.txt
+- config/targets/PI/cmd_tlm_server.txt
+- config/targets/PI/target.txt
+- cosmos-unpacking_interface.gemspec
+- doc/Cosmos.html
+- doc/Cosmos/AggregatePacketMapper.html
+- doc/Cosmos/AggregatePacketProcesser.html
+- doc/Cosmos/BaseNameMap.html
+- doc/Cosmos/UnpackingInterface.html
+- doc/UnpackingInterface.html
+- doc/created.rid
+- doc/css/fonts.css
+- doc/css/rdoc.css
+- doc/fonts/Lato-Light.ttf
+- doc/fonts/Lato-LightItalic.ttf
+- doc/fonts/Lato-Regular.ttf
+- doc/fonts/Lato-RegularItalic.ttf
+- doc/fonts/SourceCodePro-Bold.ttf
+- doc/fonts/SourceCodePro-Regular.ttf
+- doc/images/add.png
+- doc/images/arrow_up.png
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/delete.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_blue.png
+- doc/images/tag_green.png
+- doc/images/transparent.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/navigation.js
+- doc/js/navigation.js.gz
+- doc/js/search.js
+- doc/js/search_index.js
+- doc/js/search_index.js.gz
+- doc/js/searcher.js
+- doc/js/searcher.js.gz
+- doc/lib/README_rdoc.html
+- doc/table_of_contents.html
+- lib/cosmos/unpacking_interface.rb
+- lib/cosmos/unpacking_interface/aggregate_packet_mapper.rb
+- lib/cosmos/unpacking_interface/aggregate_packet_processor.rb
+- lib/cosmos/unpacking_interface/base_name_map.rb
+- lib/cosmos/unpacking_interface/unpacking_interface.rb
+- lib/cosmos/unpacking_interface/version.rb
+homepage: https://github.com/nick-benoit14/cosmos-unpacking_interface
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: A custom interface that unpacks aggregate packets (packets with many granules)
+  into many  simple packets (packets with a single granule). This way we can use all
+  the cosmos niceties  without having to send packets for individual measurements.
+  Essentially we unpack an aggregate  packet into many packets that are stored in
+  a queue that is read from. When the queue is empty  we look for new aggregate packets
+test_files: []