openc3 5.12.0 → 5.13.0

data/lib/openc3/script/web_socket_api.rb

@@ -217,14 +217,14 @@ module OpenC3
 
   # Log Messages WebSocket
   class MessagesWebSocketApi < CmdTlmWebSocketApi
-    def initialize(history_count: 0, start_time: nil, end_time: nil, severity: nil, types: nil, url: nil, write_timeout: 10.0, read_timeout: 10.0, connect_timeout: 5.0, authentication: nil, scope: $openc3_scope)
+    def initialize(history_count: 0, start_time: nil, end_time: nil, level: nil, types: nil, url: nil, write_timeout: 10.0, read_timeout: 10.0, connect_timeout: 5.0, authentication: nil, scope: $openc3_scope)
       @identifier = {
         channel: "MessagesChannel",
         history_count: history_count
       }
       @identifier['start_time'] = start_time if start_time
       @identifier['end_time'] = end_time if end_time
-      @identifier['severity'] = severity if severity
+      @identifier['level'] = level if level
       @identifier['types'] = types if types
       super(url: url, write_timeout: write_timeout, read_timeout: read_timeout, connect_timeout: connect_timeout, authentication: authentication, scope: scope)
     end

data/lib/openc3/streams/mqtt_stream.rb

@@ -0,0 +1,109 @@
+# 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/interfaces/mqtt_interface' # For MQTT patches
+require 'openc3/streams/stream'
+require 'openc3/config/config_parser'
+
+module OpenC3
+  class MqttStream < Stream
+    attr_reader :hostname
+    attr_reader :port
+    attr_reader :ssl
+    attr_reader :write_topic
+    attr_reader :read_topic
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :cert
+    attr_accessor :key
+    attr_accessor :ca_file
+
+    def initialize(hostname, port = 1883, ssl = false, write_topic = nil, read_topic = nil)
+      super()
+
+      @hostname = hostname
+      @port = Integer(port)
+      @ssl = ConfigParser.handle_true_false(ssl)
+      @write_topic = ConfigParser.handle_nil(write_topic)
+      @read_topic = ConfigParser.handle_nil(read_topic)
+      @connected = false
+
+      @username = nil
+      @password = nil
+      @cert = nil
+      @key = nil
+      @ca_file = nil
+
+      # Mutex on write is needed to protect from commands coming in from more
+      # than one tool
+      @write_mutex = Mutex.new
+    end
+
+    # @return [String] Returns a binary string of data from the read_topic
+    def read
+      raise "Attempt to read from write only stream" unless @read_topic
+
+      # No read mutex is needed because reads happen serially
+      _, data = @client.get
+      if data.nil? or data.length <= 0
+        Logger.info "MqttStream: read returned nil" if data.nil?
+        Logger.info "MqttStream: read returned 0 bytes" if not data.nil? and data.length <= 0
+        return nil
+      end
+
+      return data
+    end
+
+    # @param data [String] A binary string of data to write to the write_topic
+    def write(data)
+      raise "Attempt to write to read only stream" unless @write_topic
+
+      @write_mutex.synchronize do
+        @client.publish(@write_topic, data)
+      end
+    end
+
+    # Connect the stream
+    def connect
+      @client = MQTT::Client.new
+      @client.host = @hostname
+      @client.port = @port
+      @client.ssl = @ssl
+      @client.username = @username if @username
+      @client.password = @password if @password
+      @client.cert = @cert if @cert
+      @client.key = @key if @key
+      @client.ca_file = @ca_file.path if @ca_file
+      @client.connect
+      @client.subscribe(@read_topic) if @read_topic
+      @connected = true
+    end
+
+    def connected?
+      @connected
+    end
+
+    def disconnect
+      if @connected
+        @client.disconnect
+        @client = nil
+        @connected = false
+      end
+    end
+  end
+end

data/lib/openc3/utilities/cli_generator.rb

@@ -40,20 +40,33 @@ module OpenC3
       if args[0] != 'plugin' and Dir.glob("*.gemspec").empty?
         abort("No gemspec file detected. #{args[0].to_s.downcase} generator should be run within an existing plugin.")
       end
+
+      if args[-1] == '--python'
+        @@language = 'py'
+      else
+        @@language = 'rb'
+      end
     end
 
     def self.process_template(template_dir, the_binding)
       Dir.glob("#{template_dir}/**/*", File::FNM_DOTMATCH).each do |file|
         next if File.basename(file) == '.'
+        if @@language == 'rb'
+          # Ignore python files if we're ruby
+          next if File.extname(file) == '.py'
+        elsif @@language == 'py'
+          # Ignore ruby files if we're python
+          next if File.extname(file) == '.rb'
+        end
         base_name = file.sub("#{template_dir}/", '')
         next if yield base_name
         if File.directory?(file)
-          FileUtils.mkdir(base_name) unless File.exist?(base_name)
+          FileUtils.mkdir_p(base_name)
           next
         end
-        output = ERB.new(File.read(file).comment_erb(), trim_mode: "-").result(the_binding)
-        File.open(base_name, 'w') do |file|
-          file.write output
+        output = ERB.new(File.read(file), trim_mode: "-").result(the_binding)
+        File.open(base_name, 'w') do |base_file|
+          base_file.write output
         end
       end
     end
@@ -82,8 +95,8 @@ module OpenC3
     end
 
     def self.generate_target(args)
-      if args.length != 2
-        abort("Usage: cli generate #{args[0]} <NAME>")
+      if args.length < 2 or args.length > 3
+        abort("Usage: cli generate #{args[0]} <NAME> (--ruby or --python)")
       end
 
       # Create the local variables
@@ -92,14 +105,14 @@ module OpenC3
       if File.exist?(target_path)
         abort("Target #{target_path} already exists!")
       end
-      target_lib_filename = "#{target_name.downcase}.rb"
+      target_lib_filename = "#{target_name.downcase}.#{@@language}"
       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)
+        filename.sub!("target.#{@@language}", target_lib_filename)
         false
       end
 
@@ -120,8 +133,8 @@ module OpenC3
     end
 
     def self.generate_microservice(args)
-      if args.length != 2
-        abort("Usage: cli generate #{args[0]} <NAME>")
+      if args.length < 2 or args.length > 3
+        abort("Usage: cli generate #{args[0]} <NAME> (--ruby or --python)")
       end
 
       # Create the local variables
@@ -130,13 +143,13 @@ module OpenC3
       if File.exist?(microservice_path)
         abort("Microservice #{microservice_path} already exists!")
       end
-      microservice_filename = "#{microservice_name.downcase}.rb"
+      microservice_filename = "#{microservice_name.downcase}.#{@@language}"
       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)
+        filename.sub!("microservice.#{@@language}", microservice_filename)
         false
       end
 
@@ -252,8 +265,8 @@ module OpenC3
     self.singleton_class.send(:alias_method, :generate_tool_svelte, :generate_tool)
 
     def self.generate_conversion(args)
-      if args.length != 3
-        abort("Usage: cli generate conversion <TARGET> <NAME>")
+      if args.length < 3 or args.length > 4
+        abort("Usage: cli generate conversion <TARGET> <NAME> (--ruby or --python)")
       end
 
       # Create the local variables
@@ -263,7 +276,7 @@ module OpenC3
       end
       conversion_name = "#{args[2].upcase.gsub(/_+|-+/, '_')}_CONVERSION"
       conversion_path = "targets/#{target_name}/lib/"
-      conversion_basename = "#{conversion_name.downcase}.rb"
+      conversion_basename = "#{conversion_name.downcase}.#{@@language}"
       conversion_class = conversion_basename.filename_to_class_name
       conversion_filename = "targets/#{target_name}/lib/#{conversion_basename}"
       if File.exist?(conversion_filename)
@@ -271,7 +284,7 @@ module OpenC3
       end
 
       process_template("#{TEMPLATES_DIR}/conversion", binding) do |filename|
-        filename.sub!("conversion.rb", conversion_filename)
+        filename.sub!("conversion.#{@@language}", conversion_filename)
         false
       end
 
@@ -282,8 +295,8 @@ module OpenC3
     end
 
     def self.generate_limits_response(args)
-      if args.length != 3
-        abort("Usage: cli generate limits_response <TARGET> <NAME>")
+      if args.length < 3 or args.length > 4
+        abort("Usage: cli generate limits_response <TARGET> <NAME> (--ruby or --python)")
       end
 
       # Create the local variables
@@ -293,7 +306,7 @@ module OpenC3
       end
       response_name = "#{args[2].upcase.gsub(/_+|-+/, '_')}_LIMITS_RESPONSE"
       response_path = "targets/#{target_name}/lib/"
-      response_basename = "#{response_name.downcase}.rb"
+      response_basename = "#{response_name.downcase}.#{@@language}"
       response_class = response_basename.filename_to_class_name
       response_filename = "targets/#{target_name}/lib/#{response_basename}"
       if File.exist?(response_filename)
@@ -301,7 +314,7 @@ module OpenC3
       end
 
       process_template("#{TEMPLATES_DIR}/limits_response", binding) do |filename|
-        filename.sub!("response.rb", response_filename)
+        filename.sub!("response.#{@@language}", response_filename)
         false
       end
 

data/lib/openc3/utilities/local_mode.rb

@@ -29,9 +29,7 @@ module OpenC3
     # When updating update local_mode.py, PluginsTab.vue, plugins.spec.ts
     DEFAULT_PLUGINS = [
       'openc3-cosmos-tool-admin',
-      'openc3-cosmos-tool-autonomic',
       'openc3-cosmos-tool-bucketexplorer',
-      'openc3-cosmos-tool-calendar',
       'openc3-cosmos-tool-cmdsender',
       'openc3-cosmos-tool-cmdtlmserver',
       'openc3-cosmos-tool-dataextractor',
@@ -47,6 +45,8 @@ module OpenC3
       'openc3-cosmos-tool-tlmviewer',
       'openc3-cosmos-enterprise-tool-admin',
       'openc3-enterprise-tool-base',
+      'openc3-cosmos-tool-autonomic',
+      'openc3-cosmos-tool-calendar',
       'openc3-tool-base',
     ]
 

data/lib/openc3/utilities/logger.rb

@@ -59,11 +59,11 @@ module OpenC3
     # FATAL prints FATAL, ERROR, WARN, INFO, DEBUG messages
     FATAL = ::Logger::FATAL
 
-    DEBUG_SEVERITY_STRING = 'DEBUG'
-    INFO_SEVERITY_STRING = 'INFO'
-    WARN_SEVERITY_STRING = 'WARN'
-    ERROR_SEVERITY_STRING = 'ERROR'
-    FATAL_SEVERITY_STRING = 'FATAL'
+    DEBUG_LEVEL = 'DEBUG'
+    INFO_LEVEL = 'INFO'
+    WARN_LEVEL = 'WARN'
+    ERROR_LEVEL = 'ERROR'
+    FATAL_LEVEL = 'FATAL'
 
     # Types
     LOG = 'log'
@@ -98,27 +98,27 @@ module OpenC3
     # @param block [Proc] Block to call which should return a string to append
     #   to the log message
     def debug(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, &block)
-      log_message(DEBUG_SEVERITY_STRING, message, scope: scope, user: user, type: type, url: url, &block) if @level <= DEBUG
+      log_message(DEBUG_LEVEL, message, scope: scope, user: user, type: type, url: url, &block) if @level <= DEBUG
     end
 
     # (see #debug)
     def info(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, &block)
-      log_message(INFO_SEVERITY_STRING, message, scope: scope, user: user, type: type, url: url, &block) if @level <= INFO
+      log_message(INFO_LEVEL, message, scope: scope, user: user, type: type, url: url, &block) if @level <= INFO
     end
 
     # (see #debug)
     def warn(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, &block)
-      log_message(WARN_SEVERITY_STRING, message, scope: scope, user: user, type: type, url: url, &block) if @level <= WARN
+      log_message(WARN_LEVEL, message, scope: scope, user: user, type: type, url: url, &block) if @level <= WARN
     end
 
     # (see #debug)
     def error(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, &block)
-      log_message(ERROR_SEVERITY_STRING, message, scope: scope, user: user, type: type, url: url, &block) if @level <= ERROR
+      log_message(ERROR_LEVEL, message, scope: scope, user: user, type: type, url: url, &block) if @level <= ERROR
     end
 
     # (see #debug)
     def fatal(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, &block)
-      log_message(FATAL_SEVERITY_STRING, message, scope: scope, user: user, type: type, url: url, &block) if @level <= FATAL
+      log_message(FATAL_LEVEL, message, scope: scope, user: user, type: type, url: url, &block) if @level <= FATAL
     end
 
     # (see #debug)
@@ -174,10 +174,11 @@ module OpenC3
 
     protected
 
-    def log_message(severity_string, message, scope:, user:, type:, url:)
+    def log_message(log_level, message, scope:, user:, type:, url:)
       @@mutex.synchronize do
-        time = Time.now
-        data = { time: time.to_nsec_from_epoch, '@timestamp' => time.xmlschema(3), severity: severity_string }
+        time = Time.now.utc
+        # timestamp iso8601 with 6 decimal places to match the python output format
+        data = { time: time.to_nsec_from_epoch, '@timestamp' => time.iso8601(6), level: log_level }
         data[:microservice_name] = @microservice_name if @microservice_name
         data[:detail] = @detail_string if @detail_string
         data[:user] = user if user # EE: If a user is passed, put its name. Don't include user data if no user was passed.
@@ -185,12 +186,12 @@ module OpenC3
           message = yield
         end
         data[:container_name] = @container_name
-        data[:log] = message
+        data[:message] = message
         data[:type] = type
         data[:url] = url if url
         if @stdout
-          case severity_string
-          when WARN_SEVERITY_STRING, ERROR_SEVERITY_STRING, FATAL_SEVERITY_STRING
+          case log_level
+          when WARN_LEVEL, ERROR_LEVEL, FATAL_LEVEL
             if ENV['OPENC3_LOG_STDERR']
               $stderr.puts data.as_json(:allow_nan => true).to_json(:allow_nan => true)
               $stderr.flush

data/lib/openc3/utilities/process_manager.rb

@@ -96,7 +96,7 @@ module OpenC3
             process.status.output = output
             if process.exit_code != 0
               process.status.state = "Crashed"
-            elsif output.include?('"severity":"ERROR"') || output.include?('"severity":"WARN"')
+            elsif output.include?('"level":"ERROR"') || output.include?('"level":"WARN"')
               process.status.state = "Warning"
             else
               process.status.state = "Complete"

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.12.0'
+OPENC3_VERSION = '5.13.0'
 module OpenC3
   module Version
     MAJOR = '5'
-    MINOR = '12'
+    MINOR = '13'
     PATCH = '0'
     OTHER = ''
-    BUILD = '8f36977eacfebdcdae21f02223be66e69feaa2bf'
+    BUILD = 'b4c2afb3edf2a5786422538ddef91f00d173855d'
   end
-  VERSION = '5.12.0'
-  GEM_VERSION = '5.12.0'
+  VERSION = '5.13.0'
+  GEM_VERSION = '5.13.0'
 end

data/templates/conversion/conversion.py

@@ -0,0 +1,28 @@
+from openc3.conversions.conversion import Conversion
+
+# Custom conversion class
+# See https://openc3.com/docs/v5/telemetry#read_conversion
+class <%= conversion_class %>(Conversion):
+    def __init__(self):
+        super().__init__()
+        # Should be one of 'INT', 'UINT', 'FLOAT', 'STRING', 'BLOCK'
+        self.converted_type = 'STRING'
+        # Size of the converted type in bits
+        # Use 0 for 'STRING' or 'BLOCK' where the size can be variable
+        self.converted_bit_size = 0
+
+    # @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(self, value, packet, buffer):
+        # Read values from the packet and do a conversion
+        # Used for DERIVED items that don't have a value
+        # item1 = packet.read("ITEM1") # returns CONVERTED value (default)
+        # item2 = packet.read("ITEM2", 'RAW') # returns RAW value
+        # return (item1 + item2) / 2
+        #
+        # Perform conversion logic directly on value
+        # Used when conversion is applied to a regular (not DERIVED) item
+        # NOTE: You can also use packet.read("ITEM") to get additional values
+        # return value / 2 * packet.read("OTHER_ITEM")

data/templates/conversion/conversion.rb

@@ -1,21 +1,4 @@
 # 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
@@ -37,7 +20,7 @@ module OpenC3
     # @param buffer [String] The raw packet buffer
     def call(value, packet, buffer)
       # Read values from the packet and do a conversion
-      # Used for DERVIVED items that don't have a value
+      # Used for DERIVED items that don't have a value
       # item1 = packet.read("ITEM1") # returns CONVERTED value (default)
       # item2 = packet.read("ITEM2", :RAW) # returns RAW value
       # return (item1 + item2) / 2

data/templates/limits_response/response.py

@@ -0,0 +1,37 @@
+from openc3.packets.limits_response import LimitsResponse
+
+
+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(self, packet, item, old_limits_state):
+        # Take action based on the current limits state
+        # Delete any of the case lines that do not apply or you don't care about
+        match item.limits.state:
+            case "RED_HIGH":
+                # Take action like sending a command:
+                # cmd("TARGET SAFE")
+                pass
+            case "RED_LOW":
+                pass
+            case "YELLOW_LOW":
+                pass
+            case "YELLOW_HIGH":
+                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
+            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
+            case "RED":
+                pass
+            case "YELLOW":
+                pass

data/templates/limits_response/response.rb

@@ -1,21 +1,4 @@
 # 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

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

@@ -0,0 +1,54 @@
+import time
+from openc3.microservices.microservice import Microservice
+from openc3.utilities.sleeper import Sleeper
+from openc3.api import *
+
+
+class <%= microservice_class %>(Microservice):
+    def __init__(self, name):
+        super().__init__(name)
+        for option in self.config['options']:
+            # Update with your own OPTION handling
+            match option[0].upper():
+                case 'PERIOD':
+                    self.period = int(option[1])
+                case _:
+                    self.logger.error(
+                        "Unknown option passed to microservice #{@name}: #{option}"
+                    )
+
+        if not self.period:
+            self.period = 60  # 1 minutes
+        self.sleeper = Sleeper()
+
+    def run(self):
+        while True:
+            start_time = time.time()
+            if self.cancel_thread:
+                break
+
+            # Do your microservice work here
+            self.logger.info("Template Microservice ran")
+            # cmd("INST ABORT")
+
+            # The self.state variable is set to 'RUNNING' by the microservice base class
+            # The self.state is reflected to the user in the MICROSERVICES tab so you can
+            # convey long running actions by changing it, e.g. self.state = 'CALCULATING ...'
+
+            run_time = time.time() - start_time
+            delta = self.period - run_time
+            if delta > 0:
+                # Delay till the next period
+                if self.sleeper.sleep(
+                    delta
+                ):  # returns true and breaks loop on shutdown
+                    break
+            self.count += 1
+
+    def shutdown(self):
+        self.sleeper.cancel()  # Breaks out of run()
+        super().shutdown()
+
+
+if __name__ == "__main__":
+    <%= microservice_class %>.run()

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

@@ -1,11 +1,4 @@
 # 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'
 

data/templates/plugin/.gitignore

@@ -0,0 +1 @@
+node_modules

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

@@ -0,0 +1,9 @@
+# This class can be used in your scripts like so:
+#   require_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():
+        pass

data/templates/target/targets/TARGET/procedures/procedure.py

@@ -0,0 +1,3 @@
+# Script Runner test script
+cmd("<%= target_name %> EXAMPLE")
+wait_check("<%= target_name %> STATUS BOOL == 'FALSE'", 5)