Scoped state to track whether to update component state

Author: EmilyRagan

.gitignore

@@ -1,3 +1,6 @@
+mm/
+cosmos/
+output/
 *.o
 *.def
 *.so

Gemfile

@@ -1,4 +1,4 @@
-source ENV['RUBYGEMS_URL']
+source ENV['RUBYGEMS_URL'] || "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gem 'dotenv'

compose.yaml

@@ -185,7 +185,9 @@ services:
     user: "${OPENC3_USER_ID:-1001}:${OPENC3_GROUP_ID:-1001}"
     image: "${OPENC3_REGISTRY}/${OPENC3_NAMESPACE}/openc3-operator${OPENC3_IMAGE_SUFFIX}:${OPENC3_TAG}"
     restart: "unless-stopped"
-    # ports:
+    ports:
+      - "127.0.0.1:8080:8080"
+      - "127.0.0.1:8081:8081"
     #   - "127.0.0.1:7779:7779" # Open port for the demo router
     #   - "127.0.0.1:8081:8081/udp" # Open a udp port
     depends_on:

docs.openc3.com/docs/configuration/interfaces.md

@@ -666,7 +666,18 @@ For a full example, please see the [openc3-cosmos-proto-target](https://github.c
 
 ## Custom Interfaces
 
-Interfaces have the following methods that must be implemented:
+Custom interfaces should be created in the `lib/` folder of your plugin and then referenced in `plugin.txt` simply by the file name, no pathing necessary.
+```ruby
+# my_custom_interface.py
+from openc3.interfaces.interface import Interface
+class MyCustomInterface(Interface):
+  ... your code here ...
+
+# plugin.txt
+INTERFACE MY_INTEFACE_NAME my_custom_interface.py arg1 arg2 arg3
+```
+
+All interfaces must be subclasses of the `Cosmos::Interface` class or one of its subclasses. Interfaces have the following methods that must be implemented:
 
 1. **connect** - Open the socket or port or somehow establish the connection to the target. Note: This method may not block indefinitely. Be sure to call super() in your implementation.
 1. **connected?** - Return true or false depending on the connection state. Note: This method should return immediately.
@@ -683,5 +694,5 @@ Interfaces also have the following methods that exist and have default implement
 1. **write_raw** - Send a raw binary string of data to the target. COSMOS implements this method by basically calling write_interface with the raw data.
 
 :::warning Naming Conventions
-When creating your own interfaces, in most cases they will be subclasses of one of the built-in interfaces described below. It is important to know that both the filename and class name of the interface files must match with correct capitalization or you will receive "class not found" errors when trying to load your new interface. For example, an interface file called labview_interface.rb must contain the class LabviewInterface. If the class was named, LabVIEWInterface, for example, COSMOS would not be able to find the class because of the unexpected capitalization.
+When creating your own interfaces, in most cases they will be subclasses of one of the built-in interfaces described above. It is important to know that both the filename and class name of the interface files must match with correct capitalization or you will receive "class not found" errors when trying to load your new interface. For example, an interface file called labview_interface.rb must contain the class LabviewInterface. If the class was named, LabVIEWInterface, for example, COSMOS would not be able to find the class because of the unexpected capitalization.
 :::

docs.openc3.com/docs/getting-started/generators.md

@@ -26,9 +26,9 @@ The plugin generator creates the scaffolding for a new COSMOS Plugin. It require
 
 ```bash
 % openc3.sh cli generate plugin
-Usage: cli generate plugin <NAME>
+Usage: cli generate plugin <NAME> (--ruby or --python)
 
-% openc3.sh cli generate plugin GSE
+% openc3.sh cli generate plugin GSE --python
 Plugin openc3-cosmos-gse successfully generated!
 ```
 

openc3-cosmos-init/plugins/packages/openc3-cosmos-tool-packetviewer/src/tools/PacketViewer/PacketViewer.vue

@@ -70,7 +70,7 @@
         :items="rows"
         :custom-filter="filter"
         :sort-by="sortBy"
-        :loading="loading"
+        :loading="loading > 0"
         multi-sort
         fixed-header
         density="compact"
@@ -240,8 +240,7 @@ export default {
   data() {
     return {
       panel: 0,
-      loadingPacketItems: false,
-      loadingTlmData: false,
+      loading: 0,
       title: 'Packet Viewer',
       configKey: 'packet_viewer',
       showOpenConfig: false,
@@ -419,9 +418,6 @@ export default {
       }
       return options
     },
-    loading: function () {
-      return this.loadingPacketItems || this.loadingTlmData
-    },
   },
   watch: {
     showIgnored: function () {
@@ -542,7 +538,7 @@ export default {
         return // No change
       }
       try {
-        this.loadingPacketItems = true
+        this.loading++
         const target = await this.api.get_target(event.targetName)
         if (target) {
           this.ignoredItems = target.ignored_items
@@ -588,7 +584,7 @@ export default {
           })
         }
       } finally {
-        this.loadingPacketItems = false
+        this.loading--
       }
     },
     latestGetTlmValues(values) {
@@ -640,12 +636,17 @@ export default {
         this.latestAvailable = null
         this.latestItems = null
       }
+      let loadingFirstTlm = false
       if (!this.rows.length) {
-        this.loadingTlmData = true
+        this.loading++
+        loadingFirstTlm = true
       }
       this.updater = setInterval(() => {
         if (!this.targetName || !this.packetName) {
-          this.loadingTlmData = false
+          if (loadingFirstTlm) {
+            loadingFirstTlm = false
+            this.loading--
+          }
           return // noop if target/packet aren't set
         }
 
@@ -742,7 +743,10 @@ export default {
               console.log(error)
             })
         }
-        this.loadingTlmData = false
+        if (loadingFirstTlm) {
+          loadingFirstTlm = false
+          this.loading--
+        }
       }, this.refreshInterval)
     },
     resetConfig: function () {

openc3-cosmos-init/plugins/packages/openc3-vue-common/src/components/TargetPacketItemChooser.vue

@@ -209,6 +209,10 @@ export default {
       type: String,
       default: '',
     },
+    initialValueType: {
+      type: String,
+      default: 'CONVERTED',
+    },
     selectTypes: {
       type: Boolean,
       default: false,
@@ -264,7 +268,7 @@ export default {
       itemNames: [],
       selectedItemName: this.initialItemName?.toUpperCase(),
       valueTypes: ['CONVERTED', 'RAW'],
-      selectedValueType: 'CONVERTED',
+      selectedValueType: this.initialValueType.toUpperCase(),
       reductionModes: [
         // Map NONE to DECOM for clarity
         { title: 'NONE', value: 'DECOM' },
@@ -378,6 +382,11 @@ export default {
         this.selectedItemName = val.toUpperCase()
       }
     },
+    initialValueType: function (val) {
+      if (val) {
+        this.selectedValueType = val.toUpperCase()
+      }
+    },
     mode: function (newVal, oldVal) {
       this.selectedPacketName = null
       this.selectedItemName = null
@@ -405,17 +414,19 @@ export default {
 
     // Fetch queues if in command mode
     if (this.mode === 'cmd') {
-      Api.get('/openc3-api/queues').then((response) => {
-        this.queueNames = [{ label: 'None', value: null }]
-        if (response.data && Array.isArray(response.data)) {
-          response.data.forEach((queue) => {
-            this.queueNames.push({ label: queue.name, value: queue.name })
-          })
-        }
-      }).catch((error) => {
-        console.error('Error fetching queues:', error)
-        // Keep default "None" option even if fetch fails
-      })
+      Api.get('/openc3-api/queues')
+        .then((response) => {
+          this.queueNames = [{ label: 'None', value: null }]
+          if (response.data && Array.isArray(response.data)) {
+            response.data.forEach((queue) => {
+              this.queueNames.push({ label: queue.name, value: queue.name })
+            })
+          }
+        })
+        .catch((error) => {
+          console.error('Error fetching queues:', error)
+          // Keep default "None" option even if fetch fails
+        })
     }
 
     this.api.get_target_names().then((result) => {

openc3/openc3.gemspec

@@ -95,11 +95,11 @@ spec = Gem::Specification.new do |s|
   s.add_runtime_dependency 'rubyzip',   '~> 3.0'
   s.add_runtime_dependency 'uuidtools', '~> 2.2'
   s.add_runtime_dependency 'yard',      '~> 0.9'
-  # faraday includes faraday-net_http as the default adapter
   s.add_runtime_dependency 'aws-sdk-s3', '< 2'
   s.add_runtime_dependency 'cbor', '~> 0.5.10'
   s.add_runtime_dependency 'childprocess', '~> 5.0'
   s.add_runtime_dependency 'connection_pool', '~> 2.4'
+  # faraday includes faraday-net_http as the default adapter
   s.add_runtime_dependency 'faraday',   '~> 2.7'
   s.add_runtime_dependency 'faraday-follow_redirects', '~> 0.3'
   s.add_runtime_dependency 'faraday-multipart',   '~> 1.0'

openc3/spec/api/cmd_api_spec.rb

@@ -355,16 +355,33 @@ def test_cmd_unknown(method)
       end
 
       it "returns a command packet buffer" do
+        time = Time.now
         @api.cmd("INST ABORT")
-        output = @api.get_cmd_buffer("inst", "Abort")
-        expect(output["buffer"][6..7].unpack("n")[0]).to eq 2
-        output = @api.get_cmd_buffer("inst   Abort")
-        expect(output["buffer"][6..7].unpack("n")[0]).to eq 2
+        [
+          @api.get_cmd_buffer("inst", "Abort"),
+          @api.get_cmd_buffer("inst   Abort")
+        ].each do |output|
+          expect(output["buffer"][6..7].unpack("n")[0]).to eq 2
+          expect(output["target_name"]).to eq "INST"
+          expect(output["packet_name"]).to eq "ABORT"
+          expect(output["time"].to_i / 1_000_000_000).to be_within(1).of(time.to_i)
+          expect(output["received_time"].to_i / 1_000_000_000).to be_within(1).of(time.to_i)
+          expect(output["received_count"].to_i).to eq 1
+          expect(output["stored"]).to eq "false"
+        end
         @api.cmd("INST COLLECT with TYPE NORMAL, DURATION 5")
-        output = @api.get_cmd_buffer("INST", "COLLECT")
-        expect(output["buffer"][6..7].unpack("n")[0]).to eq 1
-        output = @api.get_cmd_buffer("INST COLLECT")
-        expect(output["buffer"][6..7].unpack("n")[0]).to eq 1
+        [
+          @api.get_cmd_buffer("INST", "COLLECT"),
+          @api.get_cmd_buffer("INST COLLECT")
+        ].each do |output|
+          expect(output["buffer"][6..7].unpack("n")[0]).to eq 1
+          expect(output["target_name"]).to eq "INST"
+          expect(output["packet_name"]).to eq "COLLECT"
+          expect(output["time"].to_i / 1_000_000_000).to be_within(1).of(time.to_i)
+          expect(output["received_time"].to_i / 1_000_000_000).to be_within(1).of(time.to_i)
+          expect(output["received_count"].to_i).to eq 1
+          expect(output["stored"]).to eq "false"
+        end
       end
     end
 

openc3/spec/api/tlm_api_spec.rb

@@ -469,14 +469,22 @@ def test_tlm_unknown(method)
 
     describe "get_tlm_buffer" do
       it "returns a telemetry packet buffer" do
+        time = Time.now
         buffer = "\x01\x02\x03\x04"
         packet = System.telemetry.packet('INST', 'HEALTH_STATUS')
         packet.buffer = buffer
         TelemetryTopic.write_packet(packet, scope: 'DEFAULT')
-        output = @api.get_tlm_buffer("INST", "Health_Status")
-        expect(output["buffer"][0..3]).to eq buffer
-        output = @api.get_tlm_buffer("INST Health_Status")
-        expect(output["buffer"][0..3]).to eq buffer
+        [
+          @api.get_tlm_buffer("INST", "Health_Status"),
+          @api.get_tlm_buffer("INST Health_Status")
+        ].each do |output|
+          expect(output["buffer"][0..3]).to eq buffer
+          expect(output["target_name"]).to eq "INST"
+          expect(output["packet_name"]).to eq "HEALTH_STATUS"
+          expect(output["time"].to_i / 1_000_000_000).to be_within(1).of(time.to_i)
+          expect(output["received_time"].to_i / 1_000_000_000).to be_within(1).of(time.to_i)
+          expect(output["stored"]).to eq "false"
+        end
       end
     end