openc3 5.4.3.pre.beta0 → 5.5.0

data/lib/openc3/utilities/cli_generator.rb

@@ -0,0 +1,210 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 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.
+
+module OpenC3
+  class CliGenerator
+    GENERATORS = %w(plugin target microservice conversion limits_response)
+    TEMPLATES_DIR = "#{File.dirname(__FILE__)}/../../../templates"
+
+    # Called by openc3cli with ARGV[1..-1]
+    def self.generate(args)
+      unless GENERATORS.include?(args[0])
+        abort("Unknown generator '#{args[0]}'. Valid generators: #{GENERATORS.join(', ')}")
+      end
+      check_args(args)
+      send("generate_#{args[0]}", args)
+    end
+
+    def self.check_args(args)
+      args.each do |arg|
+        if arg =~ /\s/
+          abort("#{args[0].capitalize} arguments can not have spaces!")
+        end
+      end
+      # All generators except 'plugin' must be within an existing plugin
+      if args[0] != 'plugin' and Dir.glob("*.gemspec").empty?
+        abort("No gemspec file detected. #{args[0].capitalize} generator should be run within an existing plugin.")
+      end
+    end
+
+    def self.process_template(template_dir, the_binding)
+      Dir.glob("#{template_dir}/**/*").each do |file|
+        base_name = file.sub("#{template_dir}/", '')
+        yield base_name
+        if File.directory?(file)
+          FileUtils.mkdir(base_name)
+          next
+        end
+        output = ERB.new(File.read(file), trim_mode: "-").result(the_binding)
+        File.open(base_name, 'w') do |file|
+          file.write output
+        end
+      end
+    end
+
+    def self.generate_plugin(args)
+      if args.length != 2
+        abort("Usage: cli generate #{args[0]} <NAME>")
+      end
+
+      # Create the local variables
+      plugin = args[1].downcase.gsub(/_+|-+/, '-')
+      plugin_name = "openc3-cosmos-#{plugin}"
+      if File.exist?(plugin_name)
+        abort("Plugin #{plugin_name} already exists!")
+      end
+      FileUtils.mkdir(plugin_name)
+      Dir.chdir(plugin_name) # Change to the plugin path to make copying easier
+
+      process_template("#{TEMPLATES_DIR}/plugin", binding) do |filename|
+        filename.sub!("plugin.gemspec", "#{plugin_name}.gemspec")
+      end
+
+      puts "Plugin #{plugin_name} successfully generated!"
+      return plugin_name
+    end
+
+    def self.generate_target(args)
+      if args.length != 2
+        abort("Usage: cli generate #{args[0]} <NAME>")
+      end
+
+      # Create the local variables
+      target_name = args[1].upcase.gsub(/_+|-+/, '_')
+      target_path = "targets/#{target_name}"
+      if File.exist?(target_path)
+        abort("Target #{target_path} already exists!")
+      end
+      target_lib_filename = "#{target_name.downcase}.rb"
+      target_class = target_lib_filename.filename_to_class_name
+      target_object = target_name.downcase
+
+      process_template("#{TEMPLATES_DIR}/target", binding) do |filename|
+        # Rename the template TARGET to our actual target named after the plugin
+        filename.sub!("targets/TARGET", "targets/#{target_name}")
+        filename.sub!("target.rb", target_lib_filename)
+      end
+
+      # Add this target to plugin.txt
+      File.open("plugin.txt", 'a') do |file|
+        file.puts <<~DOC
+
+          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
+            MAP_TARGET <%= #{target_name.downcase}_target_name %>
+        DOC
+      end
+
+      puts "Target #{target_name} successfully generated!"
+      return target_name
+    end
+
+    def self.generate_microservice(args)
+      if args.length != 2
+        abort("Usage: cli generate #{args[0]} <NAME>")
+      end
+
+      # Create the local variables
+      microservice_name = args[1].upcase.gsub(/_+|-+/, '_')
+      microservice_path = "microservices/#{microservice_name}"
+      if File.exist?(microservice_path)
+        abort("Microservice #{microservice_path} already exists!")
+      end
+      microservice_filename = "#{microservice_name.downcase}.rb"
+      microservice_class = microservice_filename.filename_to_class_name
+
+      process_template("#{TEMPLATES_DIR}/microservice", binding) do |filename|
+        # Rename the template MICROSERVICE to our actual microservice name
+        filename.sub!("microservices/TEMPLATE", "microservices/#{microservice_name}")
+        filename.sub!("microservice.rb", microservice_filename)
+      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
+        DOC
+      end
+
+      puts "Microservice #{microservice_name} successfully generated!"
+      return microservice_name
+    end
+
+    def self.generate_conversion(args)
+      if args.length != 3
+        abort("Usage: cli generate conversion <TARGET> <NAME>")
+      end
+
+      # Create the local variables
+      target_name = args[1].upcase
+      unless File.exist?("targets/#{target_name}")
+        abort("Target '#{target_name}' does not exist! Conversions must be created for existing targets.")
+      end
+      conversion_name = "#{args[2].upcase.gsub(/_+|-+/, '_')}_CONVERSION"
+      conversion_path = "targets/#{target_name}/lib/"
+      conversion_basename = "#{conversion_name.downcase}.rb"
+      conversion_class = conversion_basename.filename_to_class_name
+      conversion_filename = "targets/#{target_name}/lib/#{conversion_basename}"
+      if File.exist?(conversion_filename)
+        abort("Conversion #{conversion_filename} already exists!")
+      end
+
+      process_template("#{TEMPLATES_DIR}/conversion", binding) do |filename|
+        filename.sub!("conversion.rb", conversion_filename)
+      end
+
+      puts "Conversion #{conversion_filename} successfully generated!"
+      puts "To use the conversion add the following to a telemetry item:"
+      puts "  READ_CONVERSION #{conversion_basename}"
+      return conversion_name
+    end
+
+    def self.generate_limits_response(args)
+      if args.length != 3
+        abort("Usage: cli generate limits_response <TARGET> <NAME>")
+      end
+
+      # Create the local variables
+      target_name = args[1].upcase
+      unless File.exist?("targets/#{target_name}")
+        abort("Target '#{target_name}' does not exist! Limits responses must be created for existing targets.")
+      end
+      response_name = "#{args[2].upcase.gsub(/_+|-+/, '_')}_LIMITS_RESPONSE"
+      response_path = "targets/#{target_name}/lib/"
+      response_basename = "#{response_name.downcase}.rb"
+      response_class = response_basename.filename_to_class_name
+      response_filename = "targets/#{target_name}/lib/#{response_basename}"
+      if File.exist?(response_filename)
+        abort("response #{response_filename} already exists!")
+      end
+
+      process_template("#{TEMPLATES_DIR}/limits_response", binding) do |filename|
+        filename.sub!("response.rb", response_filename)
+      end
+
+      puts "Limits response #{response_filename} successfully generated!"
+      puts "To use the limits response add the following to a telemetry item:"
+      puts "  LIMITS_RESPONSE #{response_basename}"
+      return response_name
+    end
+  end
+end

data/lib/openc3/utilities/local_mode.rb

@@ -275,13 +275,13 @@ module OpenC3
       return if DEFAULT_PLUGINS.include?(gem_name)
       puts "Updating local plugin files: #{full_folder_path}"
       FileUtils.mkdir_p(full_folder_path)
-      gems, plugin_instance = scan_plugin_dir(full_folder_path)
+      gems, _ = scan_plugin_dir(full_folder_path)
       gems.each do |gem|
         File.delete(gem)
       end
       temp_dir = Dir.mktmpdir
       begin
-        unless File.exists?(plugin_file_path)
+        unless File.exist?(plugin_file_path)
           plugin_file_path = OpenC3::GemModel.get(plugin_file_path)
         end
         File.open(File.join(full_folder_path, File.basename(plugin_file_path)), 'wb') do |file|

data/lib/openc3/utilities/target_file.rb

@@ -26,41 +26,19 @@ module OpenC3
     # Matches ScriptRunner.vue const TEMP_FOLDER
     TEMP_FOLDER = '__TEMP__'
 
-    def self.all(scope, path_matchers, include_temp: false)
-      result = []
-      modified = []
-      temp = []
+    def self.all(scope, path_matchers, target: nil, include_temp: false)
+      target = target.upcase if target
 
       bucket = Bucket.getClient()
-      resp = bucket.list_objects(
-        bucket: ENV['OPENC3_CONFIG_BUCKET'],
-        prefix: "#{scope}/targets",
-      )
-      resp.each do |object|
-        split_key = object.key.split('/')
-        # DEFAULT/targets_modified/__TEMP__/YYYY_MM_DD_HH_MM_SS_mmm_temp.rb
-        if split_key[2] == TEMP_FOLDER
-          temp << split_key[2..-1].join('/') if include_temp
-          next
-        end
-
-        if path_matchers
-          found = false
-          path_matchers.each do |path|
-            if split_key.include?(path)
-              found = true
-              break
-            end
-          end
-          next unless found
-        end
-        result_no_scope_or_target_folder = split_key[2..-1].join('/')
-        if object.key.include?("#{scope}/targets_modified")
-          modified << result_no_scope_or_target_folder
-        else
-          result << result_no_scope_or_target_folder
-        end
+      if target
+        prefix = "#{scope}/targets/#{target}/"
+        modified_prefix = "#{scope}/targets_modified/#{target}/"
+      else
+        prefix = "#{scope}/targets/"
+        modified_prefix = "#{scope}/targets_modified/"
       end
+      result, _ = remote_target_files(bucket_client: bucket, prefix: prefix, include_temp: false, path_matchers: path_matchers)
+      modified, temp = remote_target_files(bucket_client: bucket, prefix: modified_prefix, include_temp: include_temp, path_matchers: path_matchers)
 
       # Add in local targets_modified if present
       if ENV['OPENC3_LOCAL_MODE']
@@ -172,5 +150,38 @@ module OpenC3
       )
       true
     end
+
+    # protected
+
+    def self.remote_target_files(bucket_client:, prefix:, include_temp: false, path_matchers: nil)
+      result = []
+      temp = []
+      resp = bucket_client.list_objects(
+        bucket: ENV['OPENC3_CONFIG_BUCKET'],
+        prefix: prefix,
+      )
+      resp.each do |object|
+        split_key = object.key.split('/')
+        # DEFAULT/targets_modified/__TEMP__/YYYY_MM_DD_HH_MM_SS_mmm_temp.rb
+        if split_key[2] == TEMP_FOLDER
+          temp << split_key[2..-1].join('/') if include_temp
+          next
+        end
+
+        if path_matchers
+          found = false
+          path_matchers.each do |path|
+            if split_key.include?(path)
+              found = true
+              break
+            end
+          end
+          next unless found
+        end
+        result_no_scope_or_target_folder = split_key[2..-1].join('/')
+        result << result_no_scope_or_target_folder
+      end
+      return result, temp
+    end
   end
 end

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.4.3-beta0'
+OPENC3_VERSION = '5.5.0'
 module OpenC3
   module Version
     MAJOR = '5'
-    MINOR = '4'
-    PATCH = '3'
-    OTHER = 'pre.beta0'
-    BUILD = '3eeed1efa129ce27f14bffc2b6bab4428a20c500'
+    MINOR = '5'
+    PATCH = '0'
+    OTHER = ''
+    BUILD = '6e9e3efe6170bd7adca14b849620f03fb622338d'
   end
-  VERSION = '5.4.3-beta0'
-  GEM_VERSION = '5.4.3.pre.beta0'
+  VERSION = '5.5.0'
+  GEM_VERSION = '5.5.0'
 end

data/templates/conversion/conversion.rb

@@ -0,0 +1,43 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 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.
+
+require 'openc3/conversions/conversion'
+
+module OpenC3
+  # Custom conversion class
+  # See https://openc3.com/docs/v5/telemetry#read_conversion
+  class <%= conversion_class %> < Conversion
+    def initialize
+      super()
+      # Should be one of :INT, :UINT, :FLOAT, :STRING, :BLOCK
+      @converted_type = :STRING
+      # Size of the converted type in bits
+      # Use 0 for :STRING or :BLOCK where the size can be variable
+      @converted_bit_size = 0
+    end
+
+    # @param value [Object] Value based on the item definition. This could be
+    #   a string, integer, float, or array of values.
+    # @param packet [Packet] The packet object where the conversion is defined
+    # @param buffer [String] The raw packet buffer
+    def call(value, packet, buffer)
+      # Typically perform conversion logic directly on value
+      # e.g. value.upcase()
+    end
+  end
+end

data/templates/limits_response/response.rb

@@ -0,0 +1,51 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 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.
+
+require 'openc3/packets/limits_response'
+
+module OpenC3
+  class <%= response_class %> < LimitsResponse
+    # @param packet [Packet] Packet the limits response is assigned to
+    # @param item [PacketItem] PacketItem the limits response is assigned to
+    # @param old_limits_state [Symbol] Previous value of the limit. One of nil,
+    #   :GREEN_HIGH, :GREEN_LOW, :YELLOW, :YELLOW_HIGH, :YELLOW_LOW,
+    #   :RED, :RED_HIGH, :RED_LOW. nil if the previous limit state has not yet
+    #   been established.
+    def call(packet, item, old_limits_state)
+      # Take action based on the current limits state
+      # Delete any of the 'when' lines that do not apply or you don't care about
+      case item.limits.state
+      when :RED_HIGH
+        # Take action like sending a command:
+        # cmd('TARGET SAFE')
+      when :RED_LOW
+      when :YELLOW_LOW
+      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
+      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
+      when :RED
+      when :YELLOW
+      end
+    end
+  end
+end

data/templates/microservice/microservices/TEMPLATE/microservice.rb

@@ -0,0 +1,62 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+require 'openc3/microservices/microservice'
+require 'openc3/api/api'
+
+module OpenC3
+  class <%= microservice_class %> < Microservice
+    include Api # Provides access to api methods
+
+    def initialize(name)
+      super(name)
+      @config['options'].each do |option|
+        # Update with your own OPTION handling
+        case option[0].upcase
+        when 'PERIOD'
+          @period = option[1].to_i
+        else
+          @logger.error("Unknown option passed to microservice #{@name}: #{option}")
+        end
+      end
+
+      @period = 60 unless @period # 1 minutes
+      @sleeper = Sleeper.new
+    end
+
+    def run
+      while true
+        start_time = Time.now
+        break if @cancel_thread
+
+        # Do your microservice work here
+        Logger.info("Template Microservice ran")
+        # cmd("INST ABORT")
+
+        # The @state variable is set to 'RUNNING' by the microservice base class
+        # The @state is reflected to the user in the MICROSERVICES tab so you can
+        # convey long running actions by changing it, e.g. @state = 'CALCULATING ...'
+
+        run_time = Time.now - start_time
+        delta = @period - run_time
+        if delta > 0
+          # Delay till the next period
+          break if @sleeper.sleep(delta) # returns true and breaks loop on shutdown
+        end
+        @count += 1
+      end
+    end
+
+    def shutdown
+      @sleeper.cancel # Breaks out of run()
+      super()
+    end
+  end
+end
+
+OpenC3::<%= microservice_class %>.run if __FILE__ == $0

data/templates/plugin/plugin.txt

@@ -0,0 +1 @@
+# Set VARIABLEs here to allow variation in your plugin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 5.4.3.pre.beta0
+  version: 5.5.0
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-14 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -445,6 +445,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: websocket-native
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dead_end
   requirement: !ruby/object:Gem::Requirement
@@ -916,10 +944,12 @@ files:
 - lib/openc3/script/suite_results.rb
 - lib/openc3/script/suite_runner.rb
 - lib/openc3/script/telemetry.rb
+- lib/openc3/script/web_socket_api.rb
 - lib/openc3/streams/serial_stream.rb
 - lib/openc3/streams/stream.rb
 - lib/openc3/streams/tcpip_client_stream.rb
 - lib/openc3/streams/tcpip_socket_stream.rb
+- lib/openc3/streams/web_socket_client_stream.rb
 - lib/openc3/system.rb
 - lib/openc3/system/system.rb
 - lib/openc3/system/system_config.rb
@@ -955,6 +985,7 @@ files:
 - lib/openc3/utilities/bucket.rb
 - lib/openc3/utilities/bucket_file_cache.rb
 - lib/openc3/utilities/bucket_utilities.rb
+- lib/openc3/utilities/cli_generator.rb
 - lib/openc3/utilities/crc.rb
 - lib/openc3/utilities/csv.rb
 - lib/openc3/utilities/local_bucket.rb
@@ -982,17 +1013,20 @@ files:
 - lib/openc3/win32/win32_main.rb
 - tasks/gemfile_stats.rake
 - tasks/spec.rake
-- templates/plugin-template/LICENSE.txt
-- templates/plugin-template/README.md
-- templates/plugin-template/Rakefile
-- templates/plugin-template/plugin.gemspec
-- templates/plugin-template/plugin.txt
-- templates/plugin-template/targets/TARGET/cmd_tlm/cmd.txt
-- templates/plugin-template/targets/TARGET/cmd_tlm/tlm.txt
-- templates/plugin-template/targets/TARGET/lib/target.rb
-- templates/plugin-template/targets/TARGET/procedures/procedure.rb
-- templates/plugin-template/targets/TARGET/screens/status.txt
-- templates/plugin-template/targets/TARGET/target.txt
+- templates/conversion/conversion.rb
+- templates/limits_response/response.rb
+- templates/microservice/microservices/TEMPLATE/microservice.rb
+- templates/plugin/LICENSE.txt
+- templates/plugin/README.md
+- templates/plugin/Rakefile
+- templates/plugin/plugin.gemspec
+- templates/plugin/plugin.txt
+- templates/target/targets/TARGET/cmd_tlm/cmd.txt
+- templates/target/targets/TARGET/cmd_tlm/tlm.txt
+- templates/target/targets/TARGET/lib/target.rb
+- templates/target/targets/TARGET/procedures/procedure.rb
+- templates/target/targets/TARGET/screens/status.txt
+- templates/target/targets/TARGET/target.txt
 homepage: https://github.com/OpenC3/openc3
 licenses:
 - AGPL-3.0-only
@@ -1011,9 +1045,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.14
 signing_key:

data/templates/plugin-template/plugin.txt

@@ -1,9 +0,0 @@
-# Set VARIABLEs here to allow variation in your plugin
-# See https://openc3.com/docs/v5/plugins for more information
-VARIABLE <%= target_name.downcase %>_target_name <%= target_name %>
-
-# Modify this according to your actual target connection
-# See https://openc3.com/docs/v5/interfaces for more information
-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
-  MAP_TARGET <%%= <%= target_name.downcase %>_target_name %>