openc3 5.1.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa2f9aabf07f0b9c9237f2f44644c8da055ca3069d46399db837b3b9bb22fdb3
-  data.tar.gz: 16afda4302a384d554872ff416ba76f3c822cf36f986687256f71e6c2e729370
+  metadata.gz: aff3df27d8a9cde6fb3e45403131ff0a29fbb5abb2e204e398e33d79c2bb7ead
+  data.tar.gz: ae3041bbd1868d8f3c5627dd5a6ebc381397deae7d27d997e7dfee009683175c
 SHA512:
-  metadata.gz: 394108166336ca206f0d56caa9d805e3c694a8c80b47915e3552fab228e8a9418bb61bd616ac897127e01b920d7da28d7e3c2bb0673e3e28e45283f44d0c9eda
-  data.tar.gz: ce284cea11dc3bf1c788cb89bfced3ff783b892902ec0f0dcc1922ba6edffda0ef9fe0bc5ef358fec95949e15425f8241e66a36f7a5f9472a39167e0cc4f9b53
+  metadata.gz: 967885d19c2ccf945765d355346ffde2aca982e65993630f4a4c4fe36a7f04c425176f50b9a8e4c639a21a5cc673f87928513047c84fccc3d12a8d59762fe44e
+  data.tar.gz: 2d11de60af3e15328db350cd278dc4ec79a848bb8bfbcb5f6f1a819f052f93f37397f2f23e1a1ebc1868b002f9568262599e05aa9c33f960f8fef31fe25e221b

data/bin/openc3cli

@@ -29,6 +29,8 @@ require 'openc3/utilities/bucket'
 require 'openc3/models/scope_model'
 require 'openc3/models/plugin_model'
 require 'openc3/models/gem_model'
+require 'openc3/models/migration_model'
+require 'openc3/models/tool_model'
 require 'openc3/packets/packet_config'
 require 'openc3/bridge/bridge'
 require 'ostruct'
@@ -38,9 +40,9 @@ require 'fileutils'
 require 'find'
 require 'json'
 require 'redis'
-require 'psych'
 require 'erb'
 require 'pp'
+# require 'psych' # Psych code is commented out
 
 $redis_url = "redis://#{ENV['OPENC3_REDIS_HOSTNAME']}:#{ENV['OPENC3_REDIS_PORT']}"
 # Initialize the connection to the bucket library
@@ -62,16 +64,16 @@ def print_usage
   puts "Usage:"
   puts "  cli help                          # Displays this information"
   puts "  cli rake                          # Runs rake in the local directory"
-  puts "  cli validate /PATH/FILENAME.gem SCOPE variables.txt # Validate a OpenC3 plugin gem file"
-  puts "  cli load /PATH/FILENAME.gem SCOPE variables.txt     # Loads a OpenC3 plugin gem file"
-  puts "  cli generate plugin PLUGIN_NAME   # Generate a OpenC3 plugin"
+  puts "  cli validate /PATH/FILENAME.gem SCOPE variables.txt # Validate a COSMOS plugin gem file"
+  puts "  cli load /PATH/FILENAME.gem SCOPE variables.txt     # Loads a COSMOS plugin gem file"
+  puts "  cli generate plugin PLUGIN_NAME   # Generate a COSMOS plugin"
   puts "  #{MIGRATE_PARSER}"
-  puts "  cli bridge CONFIG_FILENAME        # Run OpenC3 host bridge"
+  puts "  cli bridge CONFIG_FILENAME        # Run COSMOS host bridge"
   puts "  cli bridgesetup CONFIG_FILENAME   # Create a default config file"
   puts "  cli geminstall GEMFILENAME SCOPE        # Install loaded gem to /gems"
   puts "  cli rubysloc                      # Counts Ruby SLOC recursively. Run with --help for more info."
   puts "  cli xtce_converter                # Convert to and from the XTCE format. Run with --help for more info."
-  puts "  cli cstol_converter               # Converts CSTOL files (.prc) to OpenC3. Run with --help for more info."
+  puts "  cli cstol_converter               # Converts CSTOL files (.prc) to COSMOS. Run with --help for more info."
   puts ""
 end
 
@@ -240,7 +242,7 @@ def xtce_converter(args)
     packet_config = OpenC3::PacketConfig.new
     puts "Processing #{options[:import]}..."
     packet_config.process_file(options[:import], nil)
-    puts "Writing OpenC3 config files to #{options[:output]}/"
+    puts "Writing COSMOS config files to #{options[:output]}/"
     packet_config.to_config(options[:output])
     exit(0)
   elsif options[:plugin] && options[:output]
@@ -297,7 +299,7 @@ def put_into_archive(disk_file_path, io, zip_file_path)
 end
 
 def validate_plugin(plugin_file_path, scope:, variables_file: nil)
-  ENV['OpenC3_NO_STORE'] = '1' # it can be anything
+  ENV['OPENC3_NO_STORE'] = '1' # it can be anything
   OpenC3::Logger.stdout = false
   OpenC3::Logger.level = OpenC3::Logger::DEBUG
   scope ||= 'DEFAULT'
@@ -457,7 +459,7 @@ end
 
 def get_redis_keys
   redis = Redis.new(url: $redis_url, username: ENV['OPENC3_REDIS_USERNAME'], password: ENV['OPENC3_REDIS_PASSWORD'])
-  puts "\n--- OpenC3 Redis database keys ---"
+  puts "\n--- COSMOS Redis database keys ---"
   cursor = 0
   keys = []
   loop do
@@ -481,6 +483,40 @@ def get_redis_keys
   puts "Packets Defs: #{keys.select { |item| item[/^tlm__/] }}"
 end
 
+def run_migrations(folder)
+  # Determine if this is a brand new installation (no tools installed)
+  # We don't run migrations on new installations
+  tools = OpenC3::ToolModel.names(scope: 'DEFAULT')
+  if tools.length <= 0
+    puts "Brand new installation detected"
+    brand_new = true
+  else
+    puts "Checking for needed migrations..."
+    brand_new = false
+  end
+
+  # Run each newly discovered migration unless brand_new
+  folder = "/openc3/lib/openc3/migrations" unless folder
+  migrations = OpenC3::MigrationModel.all
+  entries = Dir.entries(folder).sort # run in alphabetical order
+  entries.each do |entry|
+    name = File.basename(entry)
+    extension = File.extname(name)
+    if extension == '.rb' and not migrations[name]
+      unless brand_new
+        puts "Running Migration: #{name}"
+        require File.join(folder, entry)
+      end
+      OpenC3::MigrationModel.new(name: name).create
+    end
+  end
+  if brand_new
+    puts "All migrations skipped"
+  else
+    puts "Migrations complete"
+  end
+end
+
 if __FILE__ == $0
   if not ARGV[0].nil? # argument(s) given
 
@@ -594,6 +630,9 @@ if __FILE__ == $0
       client.create(ENV['OPENC3_TOOLS_BUCKET'])
       client.ensure_public(ENV['OPENC3_TOOLS_BUCKET'])
 
+    when 'runmigrations'
+      run_migrations(ARGV[1])
+
     else # Unknown task
       print_usage()
       abort("Unknown task: #{ARGV[0]}")

data/data/config/interface_modifiers.yaml

@@ -6,6 +6,20 @@ MAP_TARGET:
       required: true
       description: Target name to map to this interface
       values: .+
+MAP_CMD_TARGET:
+  summary: Maps a target name to an interface for commands only
+  parameters:
+    - name: Target Name
+      required: true
+      description: Command target name to map to this interface
+      values: .+
+MAP_TLM_TARGET:
+  summary: Maps a target name to an interface for telemetry only
+  parameters:
+    - name: Target Name
+      required: true
+      description: Telemetry target name to map to this interface
+      values: .+
 DONT_CONNECT:
   summary: Server will not automatically try to connect to the interface at startup
 DONT_RECONNECT:

data/data/config/parameter_modifiers.yaml

@@ -38,7 +38,7 @@ STATE:
       STATE FALSE 0
       STATE TRUE 1
     APPEND_PARAMETER STRING 1024 STRING "NOOP" "String parameter"
-      STATE "NOOP" "NOOP"
+      STATE "NOOP" "NOOP" DISABLE_MESSAGES
       STATE "ARM LASER" "ARM LASER" HAZARDOUS "Arming the laser is an eye safety hazard"
       STATE "FIRE LASER" "FIRE LASER" HAZARDOUS "WARNING! Laser will be fired!"
   parameters:
@@ -50,10 +50,12 @@ STATE:
       required: true
       description: The numerical state value
       values: .*
-    - name: Hazardous
+    - name: Hazardous / Disable Messages
       required: false
       description: Indicates the state is hazardous. This will cause a popup
-        to ask for user confirmation when sending this command.
+        to ask for user confirmation when sending this command. For non-hazardous
+        states you can also set DISABLE_MESSAGES which will not print the command
+        when using that state.
       values: ['HAZARDOUS']
     - name: Hazardous Description
       required: false

data/data/config/screen.yaml

@@ -48,8 +48,9 @@ GLOBAL_SETTING:
       description: >
         The setting value which varies by setting. Note that color
         settings can be given as a common string, e.g. 'red', or by RGB values,
-        e.g. 255 0 0. If the setting is RAW the value should be the raw stylesheet
-        string, e.g. "font-size: 10px"
+        e.g. 255 0 0. If the setting is a length the units are required, e.g. 200px.
+        If the setting is RAW the value should be the raw stylesheet
+        key and value, e.g. font-size 10px
       values: .*
 GLOBAL_SUBSETTING:
   summary: Applies a widget subsetting to all widgets of a certain type
@@ -81,8 +82,9 @@ GLOBAL_SUBSETTING:
       description: >
         The setting value which varies by setting. Note that color
         settings can be given as a common string, e.g. 'red', or by RGB values,
-        e.g. 255 0 0. If the setting is RAW the value should be the raw stylesheet
-        string, e.g. "font-size: 10px"
+        e.g. 255 0 0. If the setting is a length the units are required, e.g. 200px.
+        If the setting is RAW the value should be the raw stylesheet
+        key and value, e.g. font-size 10px
       values: .*
 SETTING:
   summary: Applies a widget setting to the previously defined widget
@@ -98,8 +100,9 @@ SETTING:
       description: >
         The setting value which varies by setting. Note that color
         settings can be given as a common string, e.g. 'red', or by RGB values,
-        e.g. 255 0 0. If the setting is RAW the value should be the raw stylesheet
-        string, e.g. "font-size: 10px"
+        e.g. 255 0 0. If the setting is a length the units are required, e.g. 200px.
+        If the setting is RAW the value should be the raw stylesheet
+        key and value, e.g. font-size 10px
       values: .*
 SUBSETTING:
   summary: Applies a widget subsetting to the previously defined widget
@@ -126,8 +129,9 @@ SUBSETTING:
       description: >
         The setting value which varies by setting. Note that color
         settings can be given as a common string, e.g. 'red', or by RGB values,
-        e.g. 255 0 0. If the setting is RAW the value should be the raw stylesheet
-        string, e.g. "font-size: 10px"
+        e.g. 255 0 0. If the setting is a length the units are required, e.g. 200px.
+        If the setting is RAW the value should be the raw stylesheet
+        key and value, e.g. font-size 10px
       values: .*
 NAMED_WIDGET:
   summary: Name a widget to allow access to it via the getNamedWidget method

data/data/config/target.yaml

@@ -14,6 +14,13 @@ TARGET:
         it can be different to create multiple targets based on the same target folder.
       values: .*
   modifiers:
+    CMD_BUFFER_DEPTH:
+      summary: Number of commands to buffer to ensure logged in order
+      parameters:
+        - name: Buffer Depth
+          required: true
+          description: Buffer depth in packets (Default = 5)
+          values: \d+
     CMD_LOG_CYCLE_TIME:
       summary: Command binary logs can be cycled on a time interval.
       parameters:
@@ -56,6 +63,13 @@ TARGET:
           required: true
           description: Number of seconds to keep decom command logs (default = nil = Forever)
           values: \d+
+    TLM_BUFFER_DEPTH:
+      summary: Number of telemetry packets to buffer to ensure logged in order
+      parameters:
+        - name: Buffer Depth
+          required: true
+          description: Buffer depth in packets (Default = 60)
+          values: \d+
     TLM_LOG_CYCLE_TIME:
       summary: Telemetry binary logs can be cycled on a time interval.
       parameters:
@@ -140,3 +154,22 @@ TARGET:
           required: true
           description: Number of seconds between runs of the cleanup process (default = 900 = 15 minutes)
           values: \d+
+    TARGET_MICROSERVICE:
+      summary: Breaks a target microservice out into its own process.
+        Can be used to give more resources to processing that is falling behind.
+        If defined multiple times for the same type, will create multiple processes.
+        Each process can be given specific packets to process with the PACKET keyword.
+      parameters:
+        - name: Type
+          required: true
+          description: The target microservice type. Must be one of
+            DECOM, COMMANDLOG, DECOMCMDLOG, PACKETLOG, DECOMLOG, REDUCER, or CLEANUP
+          values: .*
+    PACKET:
+      summary: Packet Name to allocate to the current TARGET_MICROSERVICE.
+      parameters:
+        - name: Packet Name
+          required: true
+          description: The packet name. Does not apply to
+            REDUCER or CLEANUP target microservice types.
+          values: .*

data/ext/openc3/ext/config_parser/config_parser.c

@@ -18,7 +18,7 @@
 # All changes Copyright 2022, 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.
 */
 
@@ -96,13 +96,13 @@ static VALUE parse_loop(VALUE self, VALUE io, VALUE yield_non_keyword_lines, VAL
   volatile VALUE progress_callback = rb_cvar_get(cConfigParser, id_cvar_progress_callback);
   volatile VALUE line = Qnil;
   volatile VALUE data = Qnil;
-  volatile VALUE line_continuation = Qfalse;
+  volatile VALUE string_concat = Qfalse;
   volatile VALUE string = Qnil;
   volatile VALUE array = rb_ary_new();
   volatile VALUE first_item = Qnil;
   volatile VALUE ivar_keyword = Qnil;
   volatile VALUE ivar_parameters = rb_ary_new();
-  volatile VALUE ivar_line = Qnil;
+  volatile VALUE ivar_line = rb_str_new2("");
 
   rb_ivar_set(self, id_ivar_line_number, INT2FIX(0));
   rb_ivar_set(self, id_ivar_keyword, ivar_keyword);
@@ -130,57 +130,88 @@ static VALUE parse_loop(VALUE self, VALUE io, VALUE yield_non_keyword_lines, VAL
       break;
     }
     line = rb_funcall(line, id_method_strip, 0);
-    data = rb_funcall(line, id_method_scan, 1, rx);
-    first_item = rb_funcall(rb_ary_entry(data, 0), id_method_to_s, 0);
+    // Ensure the line length is not 0
+    if (RSTRING_LEN(line) == 0) {
+      continue;
+    }
 
-    if (RTEST(line_continuation))
+    if (RTEST(string_concat))
     {
-      rb_str_concat(ivar_line, line);
-      /* Carry over keyword and parameters */
+      /* Skip comment lines after a string concat */
+      if (RSTRING_PTR(line)[0] == '#')
+      {
+        continue;
+      }
+      /* Remove the opening quote if we're continuing the line */
+      line = rb_str_new(RSTRING_PTR(line) + 1, RSTRING_LEN(line) - 1);
     }
-    else
+
+    /* Check for string continuation */
+    if ((RSTRING_PTR(line)[RSTRING_LEN(line) - 1] == '+') ||
+        (RSTRING_PTR(line)[RSTRING_LEN(line) - 1] == '\\'))
     {
-      ivar_line = line;
-      rb_ivar_set(self, id_ivar_line, ivar_line);
-      if ((RSTRING_LEN(first_item) == 0) || (RSTRING_PTR(first_item)[0] == '#'))
+      int newline = 0;
+      if (RSTRING_PTR(line)[RSTRING_LEN(line) - 1] == '+')
       {
-        ivar_keyword = Qnil;
+        newline = 1;
       }
-      else
+      rb_str_resize(line, RSTRING_LEN(line) - 1);
+      line = rb_funcall(line, id_method_strip, 0);
+      rb_str_append(ivar_line, line);
+      rb_str_resize(ivar_line, RSTRING_LEN(ivar_line) - 1);
+      if (newline == 1)
       {
-        ivar_keyword = rb_funcall(first_item, id_method_upcase, 0);
+        rb_str_cat2(ivar_line, "\n");
       }
-      rb_ivar_set(self, id_ivar_keyword, ivar_keyword);
-      ivar_parameters = rb_ary_new();
-      rb_ivar_set(self, id_ivar_parameters, ivar_parameters);
+      rb_ivar_set(self, id_ivar_line, ivar_line);
+      string_concat = Qtrue;
+      continue;
+    }
+    if (RSTRING_PTR(line)[RSTRING_LEN(line) - 1] == '&')
+    {
+      rb_str_append(ivar_line, line);
+      rb_str_resize(ivar_line, RSTRING_LEN(ivar_line) - 1);
+      rb_ivar_set(self, id_ivar_line, ivar_line);
+      continue;
+    }
+    rb_str_append(ivar_line, line);
+    rb_ivar_set(self, id_ivar_line, ivar_line);
+    string_concat = Qfalse;
+
+    data = rb_funcall(ivar_line, id_method_scan, 1, rx);
+    first_item = rb_str_new2("");
+    if (RARRAY_LEN(data) > 0)
+    {
+      rb_str_cat2(first_item, RSTRING_PTR(rb_ary_entry(data, 0)));
+    }
+
+    if ((RSTRING_LEN(first_item) == 0) || (RSTRING_PTR(first_item)[0] == '#'))
+    {
+      ivar_keyword = Qnil;
+    }
+    else
+    {
+      ivar_keyword = rb_funcall(first_item, id_method_upcase, 0);
     }
+    rb_ivar_set(self, id_ivar_keyword, ivar_keyword);
+    ivar_parameters = rb_ary_new();
+    rb_ivar_set(self, id_ivar_parameters, ivar_parameters);
 
-    /* Ignore comments and blank lines */
+    /* Ignore lines without keywords: comments and blank lines */
     if (ivar_keyword == Qnil)
     {
-      if ((RTEST(yield_non_keyword_lines)) && (!(RTEST(line_continuation))))
+      if (RTEST(yield_non_keyword_lines))
       {
         rb_ary_clear(array);
         rb_ary_push(array, ivar_keyword);
         rb_ary_push(array, ivar_parameters);
         rb_yield(array);
       }
+      ivar_line = rb_str_new2("");
+      rb_ivar_set(self, id_ivar_line, ivar_line);
       continue;
     }
 
-    if (RTEST(line_continuation))
-    {
-      if (RTEST(remove_quotes))
-      {
-        rb_ary_push(ivar_parameters, string_remove_quotes(first_item));
-      }
-      else
-      {
-        rb_ary_push(ivar_parameters, first_item);
-      }
-      line_continuation = Qfalse;
-    }
-
     length = RARRAY_LEN(data);
     if (length > 1)
     {
@@ -202,16 +233,6 @@ static VALUE parse_loop(VALUE self, VALUE io, VALUE yield_non_keyword_lines, VAL
           }
         }
 
-        /*
-         * If the string is simply '&' and its the last string then its a line continuation so break the loop
-         */
-        if ((RSTRING_LEN(string) == 1) && (RSTRING_PTR(string)[0] == '&') && (index == (length - 1)))
-        {
-          line_continuation = Qtrue;
-          continue;
-        }
-
-        line_continuation = Qfalse;
         if (RTEST(remove_quotes))
         {
           rb_ary_push(ivar_parameters, string_remove_quotes(string));
@@ -223,30 +244,12 @@ static VALUE parse_loop(VALUE self, VALUE io, VALUE yield_non_keyword_lines, VAL
       }
     }
 
-    /*
-     * If we detected a line continuation while going through all the
-     * strings on the line then we strip off the continuation character and
-     * return to the top of the loop to continue processing the line.
-     */
-    if (RTEST(line_continuation))
-    {
-      /* Strip the continuation character */
-      if (RSTRING_LEN(ivar_line) >= 1)
-      {
-        ivar_line = rb_str_new(RSTRING_PTR(ivar_line), RSTRING_LEN(ivar_line) - 1);
-      }
-      else
-      {
-        ivar_line = rb_str_new2("");
-      }
-      rb_ivar_set(self, id_ivar_line, ivar_line);
-      continue;
-    }
-
     rb_ary_clear(array);
     rb_ary_push(array, ivar_keyword);
     rb_ary_push(array, ivar_parameters);
     rb_yield(array);
+    ivar_line = rb_str_new2("");
+    rb_ivar_set(self, id_ivar_line, ivar_line);
   }
 
   if (RTEST(progress_callback))

data/ext/openc3/ext/packet/packet.c

@@ -18,7 +18,7 @@
 # All changes Copyright 2022, 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.
 */
 
@@ -47,7 +47,6 @@ static ID id_ivar_hazardous_description = 0;
 static ID id_ivar_given_values = 0;
 static ID id_ivar_limits_items = 0;
 static ID id_ivar_processors = 0;
-static ID id_ivar_stale = 0;
 static ID id_ivar_limits_change_callback = 0;
 static ID id_ivar_read_conversion_cache = 0;
 static ID id_ivar_raw = 0;
@@ -274,7 +273,6 @@ static VALUE packet_initialize(int argc, VALUE *argv, VALUE self)
   rb_ivar_set(self, id_ivar_given_values, Qnil);
   rb_ivar_set(self, id_ivar_limits_items, Qnil);
   rb_ivar_set(self, id_ivar_processors, Qnil);
-  rb_ivar_set(self, id_ivar_stale, Qtrue);
   rb_ivar_set(self, id_ivar_limits_change_callback, Qnil);
   rb_ivar_set(self, id_ivar_read_conversion_cache, Qnil);
   rb_ivar_set(self, id_ivar_raw, Qnil);
@@ -312,7 +310,6 @@ void Init_packet(void)
   id_ivar_given_values = rb_intern("@given_values");
   id_ivar_limits_items = rb_intern("@limits_items");
   id_ivar_processors = rb_intern("@processors");
-  id_ivar_stale = rb_intern("@stale");
   id_ivar_limits_change_callback = rb_intern("@limits_change_callback");
   id_ivar_read_conversion_cache = rb_intern("@read_conversion_cache");
   id_ivar_raw = rb_intern("@raw");

data/lib/openc3/api/README.md

@@ -0,0 +1,5 @@
+# API Architecture
+
+All the files under lib/openc3/api define methods which are added to the WHITELIST. Then in lib/openc3/script/script.rb they are defined as methods on the $api_server which proxies the methods as requests to the JsonDRbObject.
+
+They use Models to store data back to the Redis data store after using authorize() to ensure permission.

data/lib/openc3/api/api.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, 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/script/extract'
@@ -26,8 +26,10 @@ require 'openc3/api/cmd_api'
 require 'openc3/api/config_api'
 require 'openc3/api/interface_api'
 require 'openc3/api/limits_api'
+require 'openc3/api/offline_access_api'
 require 'openc3/api/router_api'
 require 'openc3/api/settings_api'
+require 'openc3/api/stash_api'
 require 'openc3/api/target_api'
 require 'openc3/api/tlm_api'
 require 'openc3/utilities/authorization'