openc3 5.14.0 → 5.14.2

data/lib/openc3/system/system_config.rb

@@ -14,10 +14,10 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/config/config_parser'
@@ -30,7 +30,6 @@ require 'openc3/logs'
 require 'fileutils'
 require 'openc3/utilities/zip'
 require 'bundler'
-require 'thread'
 
 module OpenC3
   # System is the primary entry point into the OpenC3 framework. It captures
@@ -90,7 +89,7 @@ module OpenC3
     # @param targets_config_dir [String] The configuration directory to
     #   search for the target command and telemetry files.
     def process_file(filename, targets_config_dir)
-      parser = ConfigParser.new("https://openc3.com/docs/v5")
+      parser = ConfigParser.new("https://docs.openc3.com/docs")
 
       # First pass - Everything except targets
       parser.parse_file(filename) do |keyword, parameters|
@@ -192,7 +191,7 @@ module OpenC3
                 # If any of the targets original directory name matches the
                 # current directory then it must have been already processed by
                 # DECLARE_TARGET so we skip it.
-                next if @targets.select { |name, target| target.original_name == dir_filename }.length > 0
+                next if @targets.select { |_name, target| target.original_name == dir_filename }.length > 0
                 next if dir_filename == 'SYSTEM'
 
                 target = Target.new(dir_filename, nil, targets_config_dir)
@@ -352,7 +351,7 @@ module OpenC3
               # If any of the targets original directory name matches the
               # current directory then it must have been already processed by
               # DECLARE_TARGET so we skip it.
-              next if @targets.select { |name, target| target.original_name == target_name }.length > 0
+              next if @targets.select { |_name, target| target.original_name == target_name }.length > 0
 
               target = Target.new(target_name, nil, nil, nil, spec.gem_dir)
               @targets[target.name] = target
@@ -377,7 +376,7 @@ module OpenC3
 
             # Copy target files into archive
             zip_targets = []
-            @targets.each do |target_name, target|
+            @targets.each do |_target_name, target|
               entries = Dir.entries(target.dir) - %w(. ..)
               zip_target = File.join(zip_file_path, target.original_name)
               # Check the stored list of targets. We can't ask the zip file
@@ -390,7 +389,7 @@ module OpenC3
 
             # Create custom system.txt file
             zipfile.get_output_stream(File.join(zip_file_path, 'system.txt')) do |file|
-              @targets.each do |target_name, target|
+              @targets.each do |_target_name, target|
                 target_filename = File.basename(target.filename)
                 target_filename = nil unless File.exist?(target.filename)
                 # Create a newline character since Zip opens files in binary mode
@@ -405,8 +404,8 @@ module OpenC3
           end
           File.rename(configuration_tmp, configuration)
           File.chmod(0444, configuration) # Mark readonly
-        rescue Exception => error
-          Logger.error "Problem saving configuration to #{configuration}: #{error.class}:#{error.message}\n#{error.backtrace.join("\n")}\n"
+        rescue Exception => e
+          Logger.error "Problem saving configuration to #{configuration}: #{e.class}:#{e.message}\n#{e.backtrace.join("\n")}\n"
         end
       end
     end

data/lib/openc3/system/target.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -114,8 +114,8 @@ module OpenC3
     #
     # @param filename [String] The target configuration file to parse
     def process_file(filename)
-      Logger.instance.info "Processing ruby target definition in file '#{filename}'"
-      parser = ConfigParser.new("https://openc3.com/docs/v5/target")
+      Logger.instance.info "Processing target definition in file '#{filename}'"
+      parser = ConfigParser.new("https://docs.openc3.com/docs/configuration/target")
       parser.parse_file(filename) do |keyword, parameters|
         case keyword
         when 'LANGUAGE'
@@ -143,8 +143,8 @@ module OpenC3
             rescue Exception => err
               raise parser.error(err.message)
             end
-          rescue Exception => err
-            raise parser.error(err.message)
+          rescue Exception => e
+            raise parser.error(e.message)
           end
 
           # This code resolves any relative paths to absolute before putting into the @requires array
@@ -196,7 +196,7 @@ module OpenC3
       end
     end
 
-    def as_json(*a)
+    def as_json(*_a)
       config = {}
       config['name'] = @name
       config['requires'] = @requires

data/lib/openc3/utilities/cli_generator.rb

@@ -128,6 +128,16 @@ module OpenC3
         gemspec = File.read(gemspec_filename)
         gemspec.gsub!('plugin.txt', 'plugin.txt requirements.txt')
         File.write(gemspec_filename, gemspec)
+
+        target_txt_filename = "targets/#{target_name}/target.txt"
+        target_txt = File.read(target_txt_filename)
+        target_txt.gsub!('LANGUAGE ruby', 'LANGUAGE python')
+        File.write(target_txt_filename, target_txt)
+      end
+
+      interface_line = "INTERFACE <%= #{target_name.downcase}_target_name %>_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST"
+      if @@language == 'py'
+        interface_line = "INTERFACE <%= #{target_name.downcase}_target_name %>_INT openc3/interfaces/tcpip_client_interface.py host.docker.internal 8080 8081 10.0 None BURST"
       end
 
       # Add this target to plugin.txt
@@ -137,7 +147,7 @@ module OpenC3
           VARIABLE #{target_name.downcase}_target_name #{target_name}
 
           TARGET #{target_name} <%= #{target_name.downcase}_target_name %>
-          INTERFACE <%= #{target_name.downcase}_target_name %>_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
+          #{interface_line}
             MAP_TARGET <%= #{target_name.downcase}_target_name %>
         DOC
       end
@@ -167,12 +177,17 @@ module OpenC3
         false
       end
 
+      cmd_line = "CMD ruby #{microservice_name.downcase}.rb"
+      if @@language == 'py'
+        cmd_line = "CMD python #{microservice_name.downcase}.py"
+      end
+
       # Add this microservice to plugin.txt
       File.open("plugin.txt", 'a') do |file|
         file.puts <<~DOC
 
           MICROSERVICE #{microservice_name} #{microservice_name.downcase.gsub('_','-')}-microservice
-            CMD ruby #{microservice_name.downcase}.rb
+            #{cmd_line}
         DOC
       end
 
@@ -222,7 +237,7 @@ module OpenC3
       end
 
       puts "Widget #{widget_name} successfully generated!"
-      puts "Please be sure #{widget_name} does not overlap an existing widget: https://openc3.com/docs/v5/telemetry-screens"
+      puts "Please be sure #{widget_name} does not overlap an existing widget: https://docs.openc3.com/docs/configuration/telemetry-screens"
       return widget_name
     end
 

data/lib/openc3/utilities/python_proxy.rb

@@ -0,0 +1,52 @@
+# encoding: ascii-8bit
+
+# Copyright 2024 OpenC3, Inc.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+# TODO: Delegate to actual Python to verify that classes exist
+# and to get proper data from them like converted_type
+
+module OpenC3
+  class PythonProxy
+    attr_accessor :name
+    attr_accessor :args
+
+    def initialize(type, class_name, *params)
+      @type = type
+      @class_name = class_name
+      @params = params
+      @args = params
+      @name = nil
+    end
+
+    def class
+      return @class_name
+    end
+
+    def as_json(*args, **kw_args)
+      case @type
+      when "Processor"
+        return { 'name' => @name, 'class' => @class_name, 'params' => @params }
+      when "Conversion"
+        return { 'class' => @class_name, 'params' => @params }
+      when "LimitsResponse"
+        return { "class" => @class_name, 'params' => @params }
+      else
+        raise "Unknown PythonProxy type: #{@type}"
+      end
+    end
+  end
+end

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.14.0'
+OPENC3_VERSION = '5.14.2'
 module OpenC3
   module Version
     MAJOR = '5'
     MINOR = '14'
-    PATCH = '0'
+    PATCH = '2'
     OTHER = ''
-    BUILD = 'dd31e4853fa50ed08ee3100e43e75849617d0a47'
+    BUILD = 'e5d9da06d95d4404fba6f9fd5a74a130ef176bd4'
   end
-  VERSION = '5.14.0'
-  GEM_VERSION = '5.14.0'
+  VERSION = '5.14.2'
+  GEM_VERSION = '5.14.2'
 end

data/templates/conversion/conversion.py

@@ -1,7 +1,7 @@
 from openc3.conversions.conversion import Conversion
 
 # Custom conversion class
-# See https://openc3.com/docs/v5/telemetry#read_conversion
+# See https://docs.openc3.com/docs/configuration/telemetry#read_conversion
 class <%= conversion_class %>(Conversion):
     def __init__(self):
         super().__init__()

data/templates/conversion/conversion.rb

@@ -3,7 +3,7 @@ require 'openc3/conversions/conversion'
 
 module OpenC3
   # Custom conversion class
-  # See https://openc3.com/docs/v5/telemetry#read_conversion
+  # See https://docs.openc3.com/docs/configuration/telemetry#read_conversion
   class <%= conversion_class %> < Conversion
     def initialize
       super()

data/templates/limits_response/response.py

@@ -24,13 +24,13 @@ class <%= response_class %>(LimitsResponse):
                 pass
             # GREEN limits are only available if a telemetry item has them defined
             # COSMOS refers to these as "operational limits"
-            # See https://openc3.com/docs/v5/telemetry#limits
+            # See https://docs.openc3.com/docs/configuration/telemetry#limits
             case "GREEN_LOW":
                 pass
             case "GREEN_HIGH":
                 pass
             # :RED and :YELLOW limits are triggered for STATES with defined RED and YELLOW states
-            # See https://openc3.com/docs/v5/telemetry#state
+            # See https://docs.openc3.com/docs/configuration/telemetry#state
             case "RED":
                 pass
             case "YELLOW":

data/templates/limits_response/response.rb

@@ -21,11 +21,11 @@ module OpenC3
       when :YELLOW_HIGH
       # GREEN limits are only available if a telemetry item has them defined
       # COSMOS refers to these as "operational limits"
-      # See https://openc3.com/docs/v5/telemetry#limits
+      # See https://docs.openc3.com/docs/configuration/telemetry#limits
       when :GREEN_LOW
       when :GREEN_HIGH
       # :RED and :YELLOW limits are triggered for STATES with defined RED and YELLOW states
-      # See https://openc3.com/docs/v5/telemetry#state
+      # See https://docs.openc3.com/docs/configuration/telemetry#state
       when :RED
       when :YELLOW
       end

data/templates/microservice/microservices/TEMPLATE/microservice.py

@@ -14,14 +14,17 @@ class <%= microservice_class %>(Microservice):
                     self.period = int(option[1])
                 case _:
                     self.logger.error(
-                        "Unknown option passed to microservice #{@name}: #{option}"
+                        f"Unknown option passed to microservice {name}: {option}"
                     )
 
-        if not self.period:
+        if not hasattr(self, 'period'):
             self.period = 60  # 1 minutes
         self.sleeper = Sleeper()
 
     def run(self):
+        # Allow the other target processes to start before running the microservice
+        self.sleeper.sleep(self.period)
+
         while True:
             start_time = time.time()
             if self.cancel_thread:
@@ -51,4 +54,4 @@ class <%= microservice_class %>(Microservice):
 
 
 if __name__ == "__main__":
-    <%= microservice_class %>.run()
+    <%= microservice_class %>.class_run()

data/templates/target/targets/TARGET/lib/target.py

@@ -1,9 +1,9 @@
 # This class can be used in your scripts like so:
-#   require_utility '<%= target_class.upcase %>/lib/<%= target_lib_filename %>'
+#   load_utility '<%= target_class.upcase %>/lib/<%= target_lib_filename %>'
 #   <%= target_object %> = <%= target_class %>()
 #   <%= target_object %>.utility()
 # For more information see the OpenC3 scripting guide
 
 class <%= target_class %>:
-    def utility():
+    def utility(self):
         pass

data/templates/target/targets/TARGET/target.txt

@@ -1,3 +1,5 @@
+LANGUAGE ruby
+
 # Ignored Parameters
 IGNORE_PARAMETER PKTID
 

data/templates/tool_angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "5.14.0",
+  "version": "5.14.2",
   "scripts": {
     "ng": "ng",
     "start": "ng serve",
@@ -12,7 +12,7 @@
   },
   "private": true,
   "dependencies": {
-    "@openc3/tool-common": "5.14.0",
+    "@openc3/tool-common": "5.14.2",
     "@angular/animations": "^17.0.8",
     "@angular/cdk": "^17.0.4",
     "@angular/common": "^17.0.8",

data/templates/tool_svelte/package.json

@@ -11,7 +11,7 @@
     "smui-theme": "smui-theme compile build/smui.css -i src/theme"
   },
   "dependencies": {
-    "@openc3/tool-common": "5.14.0",
+    "@openc3/tool-common": "5.14.2",
     "@astrouxds/astro-web-components": "7.20.0",
     "@smui/button": "^7.0.0-beta.16",
     "@smui/card": "^7.0.0-beta.16",

data/templates/tool_svelte/src/services/config-parser.js

@@ -13,7 +13,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -39,8 +39,7 @@ export class ConfigParserService {
   filename = ''
   line = ''
   lineNumber = 0
-  url = 'https://openc3.com/docs/v5'
-
+  url = 'https://docs.openc3.com/docs'
   constructor() {}
 
   verify_num_parameters(min_num_params, max_num_params, usage = '') {
@@ -53,7 +52,7 @@ export class ConfigParserService {
           this,
           `Not enough parameters for ${this.keyword}.`,
           usage,
-          this.url
+          this.url,
         )
       }
     }
@@ -63,7 +62,7 @@ export class ConfigParserService {
         this,
         `Too many parameters for ${this.keyword}.`,
         usage,
-        this.url
+        this.url,
       )
     }
   }
@@ -98,7 +97,7 @@ export class ConfigParserService {
     original_filename,
     yield_non_keyword_lines,
     remove_quotes,
-    handler
+    handler,
   ) {
     let string_concat = false
     this.line = ''

data/templates/tool_svelte/src/services/openc3-api.js

@@ -13,7 +13,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -164,6 +164,14 @@ export class OpenC3Api {
     return this.exec('disconnect_interface', [interface_name])
   }
 
+  interface_cmd(interface_name, command_name, ...command_params) {
+    return this.exec('interface_cmd', [
+      interface_name,
+      command_name,
+      ...command_params,
+    ])
+  }
+
   get_all_router_info() {
     return this.exec('get_all_router_info', [])
   }

data/templates/tool_vue/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "5.14.0",
+  "version": "5.14.2",
   "private": true,
   "scripts": {
     "serve": "vue-cli-service serve",
@@ -11,7 +11,7 @@
     "test:components": "vue-cli-service test:components"
   },
   "dependencies": {
-    "@openc3/tool-common": "5.14.0",
+    "@openc3/tool-common": "5.14.2",
     "@astrouxds/astro-web-components": "7.20.0",
     "axios": "1.6.5",
     "date-fns": "2.30.0",

data/templates/widget/package.json

@@ -1,12 +1,12 @@
 {
   "name": "widget",
-  "version": "5.14.0",
+  "version": "5.14.2",
   "private": true,
   "scripts": {
     "build": "vue-cli-service build --target lib --dest tools/widgets/<%= widget_name %> --formats umd-min <%= widget_path %> --name <%= widget_name %>"
   },
   "dependencies": {
-    "@openc3/tool-common": "5.14.0",
+    "@openc3/tool-common": "5.14.2",
     "@astrouxds/astro-web-components": "7.20.0",
     "vue": "2.7.16",
     "vuetify": "2.7.1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 5.14.0
+  version: 5.14.2
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -761,6 +761,7 @@ files:
 - Rakefile
 - bin/cstol_converter
 - bin/openc3cli
+- bin/pipinstall
 - bin/rubysloc
 - data/config/_array_params.yaml
 - data/config/_canvas_values.yaml
@@ -1096,6 +1097,7 @@ files:
 - lib/openc3/utilities/migration.rb
 - lib/openc3/utilities/open_telemetry.rb
 - lib/openc3/utilities/process_manager.rb
+- lib/openc3/utilities/python_proxy.rb
 - lib/openc3/utilities/quaternion.rb
 - lib/openc3/utilities/redis_secrets.rb
 - lib/openc3/utilities/ruby_lex_utils.rb