openc3 5.18.0 → 5.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6ba1e299807bdcbb67ae8b2e678d37152286d3061a8127fe982d0d9efe39fac
-  data.tar.gz: 9b76aea8554d86a633ec2b2b35c250a2481550c2069a64e083d74d0cbb89d156
+  metadata.gz: 65a5c8a4ee0645f9d129c7c6140b9e8863e61e035f5e0269a977e8cd7d722c15
+  data.tar.gz: a023d452a32050ab5d81a3edcdc8fccaf10eed1a81b481ef11d89c633d3f6cba
 SHA512:
-  metadata.gz: 34df5327bcfbcdff0c21e5856d7dcc11ee88a8f83e3e83f1a8fc9e70b37b37e36360e54f0f9ad8df8f505f9e7b6ed2cf253d0d4a8efaaec072cced50a0e104d7
-  data.tar.gz: c78d41c4ed5b18ae17450c1e50889d169c714dbc2975cc710158de682f7012be9c8f39e1a0230aaa3d67c57c26fbdeaa82bfa8617658d3ab22ac709828248209
+  metadata.gz: 3ecd41dc83eb1d9af0e847fcb61d8784bfce374c33681008030423f2d1b04c09b62200ec5ca7f878273e6aed704982aeb55fddad1b1ae5490367e5fe48ea844f
+  data.tar.gz: f121f92ac5c6101eb9e3d9ebe52b525235090dc964a7bf409ebf7a47b1bc1c52c7f5a97a7194f5238ade4cee31078cb5822b486954d87983c8fdf9294f557257

data/Gemfile

@@ -8,10 +8,13 @@ gemspec :name => 'openc3'
 
 # Include the rails gems for the convenience of custom microservice plugins
 gem 'bootsnap', '>= 1.9.3', require: false
-gem 'mock_redis', '0.44'
 gem 'rack-cors', '~> 2.0'
 gem 'rails', '~> 7.1.0'
-gem 'rspec-rails', '~> 6.0'
-gem 'simplecov', '~> 0.20'
-gem 'simplecov-cobertura', '~> 2.1'
 gem 'tzinfo-data'
+
+group :test, :development do
+  gem 'mock_redis', '0.45'
+  gem 'rspec-rails', '~> 7.0'
+  gem 'simplecov', '~> 0.20'
+  gem 'simplecov-cobertura', '~> 2.1'
+end

data/bin/cstol_converter

@@ -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.
 
 # This file converts OASIS CSTOL files to OpenC3 scripts
@@ -163,7 +163,7 @@ def parse_expression(vars, quoted = false, in_eval = false)
     when /(\+|-|\*|\/)/ # Arithmetic operator
       str = str + " " + vars[i].tr('[]"', '') + " "
 
-    # Verfies Number followed immediately by units
+    # Verifies Number followed immediately by units
     when /\dDN\z|\ddn\z|\dDEG\z|\ddeg\z|\dRAD\z|\drad\z|\dV\z|\dA\z|\dv\z|\da\z|\dc\z|\dC\z|\df\z|\dF\z|\dDPS\z|\dM\z|\dMPS\z|\dm\z|\dmps\z/ # Checks for decimal/degrees/volts and amps
       temp = vars[i].tr('[]"', '')
       temp = temp.gsub(/DN\z|dn\z|DEG\z|deg\z|RAD\z|rad\z|V\z|A\z|v\z|a\z|c\z|C\z|f\z|F\z|DPS\z|M\z|MPS\z|m\z|mps\z/, '')
@@ -190,7 +190,7 @@ def parse_expression(vars, quoted = false, in_eval = false)
       str = str + parse_time(vars[i].tr('[]"', ''))
 
     when /\dE/ # Floating point
-      temp_number = vars[i].tr('E', '').to_f * 10**vars[i + 2].to_f
+      temp_number = vars[i].tr('E', '').to_f * (10**vars[i + 2].to_f)
       str = str + "#{temp_number}"
       finished = true
     when /\d/ # Decimal number
@@ -279,7 +279,7 @@ def parse_id(id, quoted = false, in_eval = false, in_command = false, in_single_
   elsif id.match?(/\dE\+\d/) # Floating point
     id = id.gsub('+', ' + ')
     temp_num_arr = id.split(' ')
-    temp_number = temp_num_arr[0].tr('E', '').to_f * 10**temp_num_arr[2].to_f
+    temp_number = temp_num_arr[0].tr('E', '').to_f * (10**temp_num_arr[2].to_f)
     str = str + "#{temp_number}"
   elsif id.match(/\A\d/) or id.match(/\A-\d/) # starts with Decimal number
     str = id
@@ -332,7 +332,7 @@ def parse_time(time)
     end
 
     # Compute the number of seconds
-    secs = (3600 * tok[0].to_i + 60 * tok[1].to_i + tok[2].to_i).to_s
+    secs = ((3600 * tok[0].to_i) + (60 * tok[1].to_i) + tok[2].to_i).to_s
 
   # Other cases not handled
   else
@@ -341,7 +341,7 @@ def parse_time(time)
 end
 
 def parse_tlm_item(tlm)
-  # Remove preceeding parentheses
+  # Remove preceding parentheses
   if tlm[0].index("(") == 0
     tlm[0] = tlm[0][1..-1]
   end
@@ -371,7 +371,7 @@ def parse_line(full_line, loc_out_file, wait_check_flag = false)
     return
   end
 
-  # Detemine the location of any comments in this line
+  # Determine the location of any comments in this line
   commentIdx = full_line.index(";")
 
   # If we found a comment operator
@@ -653,7 +653,7 @@ def parse_line(full_line, loc_out_file, wait_check_flag = false)
     # TODO not sure if this is wise, for some files the loop is infinite and
     # there's no exist case
     if words[1] == nil
-      str = str + "# TODO Possible inifinite loop case check script file" +
+      str = str + "# TODO Possible infinite loop case check script file" +
             "\n" + str + "while(true)"
     else
       str = str + words[1] + ".times do |i|"
@@ -694,7 +694,7 @@ def parse_line(full_line, loc_out_file, wait_check_flag = false)
       # Print the function name and the first argument
       str = str + "def " + words[1].downcase + "(" + parse_id(listWords[0])
 
-      # Print the remaining arguments preceeded by a separator
+      # Print the remaining arguments preceded by a separator
       (listWords.length - 1).times do |i|
         str = str + ", " + parse_id(listWords[i + 1])
       end
@@ -759,7 +759,7 @@ def parse_line(full_line, loc_out_file, wait_check_flag = false)
       # Print the function name and the first argument
       str = str + words[1].downcase + "(" + parse_id(listWords[0])
 
-      # Print the remaining arguments preceeded by a separator
+      # Print the remaining arguments preceded by a separator
       (listWords.length - 1).times do |i|
         str = str + ", " + parse_id(listWords[i + 1])
       end
@@ -783,7 +783,7 @@ def parse_line(full_line, loc_out_file, wait_check_flag = false)
     str = str + "# SCL Ignored: " + line
 
   when "wait"
-    # add a space incase there's no space between or and parantheses
+    # add a space in case there's no space between or and parentheses
     line = line.gsub(')or', ') or')
     words = line.split(' ')
     # Only a wait
@@ -1055,8 +1055,8 @@ end
 
 begin
   opts.parse!(ARGV)
-rescue => err
-  puts err
+rescue => e
+  puts e
   puts opts
   exit
 end
@@ -1164,7 +1164,7 @@ else
       @universal_index = 0
       @data_by_lines = @data.lines.to_a
       # Parse each line in the file
-      @data_by_lines.each do |line|
+      @data_by_lines.each do |_line|
         if @verify_wait_check == true
           # Skip line
           @verify_wait_check = false

data/bin/openc3cli

@@ -58,17 +58,30 @@ MIGRATE_PARSER = OptionParser.new do |opts|
 end
 ERROR_CODE = 1
 
+CLI_SCRIPT_ACTIONS = %w(help list run spawn)
+$script_interrupt_text = ''
+trap('INT') do
+  abort("Interrupted at console; exiting.#{$script_interrupt_text}")
+end
+
 # Prints the usage text for the openc3cli executable
 def print_usage
   puts "Usage:"
   puts "  cli help                          # Displays this information"
   puts "  cli rake                          # Runs rake in the local directory"
   puts "  cli irb                           # Runs irb in the local directory"
+  puts "  cli script list /PATH SCOPE       # lists script names filtered by path within scope, 'DEFAULT' if not given"
+  puts "  cli script spawn NAME SCOPE  variable1=value1 variable2=value2  # Starts named script remotely"
+  puts "  cli script run NAME SCOPE variable1=value1 variable2=value2  # Starts named script, monitoring status on console,\
+  by default until error or exit"
+  puts "    PARAMETERS name-value pairs to form the script's runtime environment"
+  puts "    OPTIONS: --wait 0 seconds to monitor status before detaching from the running script; ie --wait 100"
+  puts "             --disconnect run the script in disconnect mode"
   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 list <SCOPE>                  # Lists installed plugins, SCOPE is DEFAULT if not given"
   puts "  cli generate TYPE OPTIONS         # Generate various COSMOS entities"
-  puts "    OPTIONS: --ruby or --python to specify the language in the generated code"
+  puts "    OPTIONS: --ruby or --python is required to specify the language in the generated code unless OPENC3_LANGUAGE is set"
   puts "  #{MIGRATE_PARSER}"
   puts "  cli bridge CONFIG_FILENAME        # Run COSMOS host bridge"
   puts "  cli bridgegem gem_name variable1=value1 variable2=value2 # Runs bridge using gem bridge.txt"
@@ -160,8 +173,8 @@ def migrate(args)
   end
 
   # Migrate cmd_tlm_server.txt info to plugin.txt
-  Dir.glob('targets/**/cmd_tlm_server*.txt') do |file|
-    File.open(file) do |file|
+  Dir.glob('targets/**/cmd_tlm_server*.txt') do |cmd_tlm_server_file|
+    File.open(cmd_tlm_server_file) do |file|
       file.each do |line|
         next if line =~ /^\s*#/ # Ignore comments
         next if line.strip.empty? # Ignore empty lines
@@ -193,9 +206,9 @@ def migrate(args)
     lines = screen.split("\n")
     lines.map! do |line|
       if line.include?('Qt.')
-        line = "# FIXME (no Qt): #{line.sub("<%", "< %").sub("%>", "% >")}"
+        "# FIXME (no Qt): #{line.sub("<%", "< %").sub("%>", "% >")}"
       elsif line.include?('Cosmos::')
-        line = "# FIXME (no Cosmos::): #{line.sub("<%", "< %").sub("%>", "% >")}"
+        "# FIXME (no Cosmos::): #{line.sub("<%", "< %").sub("%>", "% >")}"
       else
         line
       end
@@ -493,7 +506,6 @@ def load_plugin(plugin_file_path, scope:, plugin_hash_file: nil, force: false)
   else
     # Outside Cluster
     require 'openc3/script'
-
     if plugin_hash_file
       plugin_hash = JSON.parse(File.read(plugin_hash_file), :allow_nan => true, :create_additions => true)
     else
@@ -648,6 +660,167 @@ def run_bridge(filename, params)
   end
 end
 
+def cli_script_monitor(script_id)
+  ret_code = ERROR_CODE
+  require 'openc3/script'
+  OpenC3::RunningScriptWebSocketApi.new(id: script_id) do |api|
+    while (resp = api.read) do
+      # see ScriptRunner.vue for types and states
+      case resp['type']
+      when 'error', 'fatal'
+        $script_interrupt_text = ''
+        puts 'script failed'
+        break
+      when 'file'
+        puts "Filename #{resp['filename']} scope #{resp['scope']}"
+      when 'line'
+        fn = resp['filename'].nil? ? '<no file>' : resp['filename']
+        puts "At [#{fn}:#{resp['line_no']}] state [#{resp['state']}]"
+        if resp['state'] == 'error'
+          $script_interrupt_text = ''
+          puts 'script failed'
+          break
+        end
+      when 'output'
+        puts resp['line']
+      when 'paused'
+        if resp['state'] == 'fatal'
+          $script_interrupt_text = ''
+          puts 'script failed'
+          break
+        end
+      when 'complete'
+        $script_interrupt_text = ''
+        puts 'script complete'
+        ret_code = 0
+        break
+      # These conditions are all handled by the else
+      # when 'running', 'breakpoint', 'waiting', 'time'
+      else
+        puts resp.pretty_inspect
+      end
+    end
+  end
+  return ret_code
+end
+
+def cli_script_list(args=[])
+  path = ''
+  if (args[0] && args[0][0] == '/')
+    path = (args.shift)[1..-1]+'/'
+  end
+  scope = args[1]
+  scope ||= 'DEFAULT'
+  require 'openc3/script'
+  script_list(scope: scope).each do |script_name|
+    puts(script_name) if script_name.start_with?(path)
+  end
+  return 0
+end
+
+def cli_script_run(disconnect=false, environment={}, args=[])
+  #  we are limiting the wait for status, not the script run time
+  #  we make 0 mean 'forever'
+  ret_code = ERROR_CODE
+  wait_limit = 0
+  if (i = args.index('--wait'))
+    begin
+      args.delete('--wait')
+      # pull out the flag
+      seconds = args[i]
+      wait_limit = Integer(seconds, 10) # only decimal, ignore leading 0
+      args.delete_at(i)
+      # and its value
+    rescue ArgumentError
+      abort("  --wait requires a number of seconds to wait, not [#{seconds}]")
+    end
+  end
+  abort("No script file provided") if args[0].nil?
+  scope = args[1]
+  scope ||= 'DEFAULT'
+  require 'openc3/script'
+  id = script_run(args[0], disconnect: disconnect, environment: environment, scope: scope) # could raise
+  $script_interrupt_text = "  Script #{args[0]} still running remotely.\n" # for Ctrl-C
+  if (wait_limit < 1) then
+    ret_code = cli_script_monitor(id)
+  else
+    Timeout::timeout(wait_limit, nil, "--wait #{wait_limit} exceeded") do
+      ret_code = cli_script_monitor(id)
+    rescue Timeout::ExitException, Timeout::Error => e
+      # Timeout exceptions are also raised by the Websocket API, so we check
+      if e.message =~ /^--wait /
+        puts e.message + ", detaching from running script #{args[0]}"
+      else
+        raise
+      end
+    end
+  end
+  return ret_code
+end
+
+def cli_script_spawn(disconnect=false, environment={}, args=[])
+  ret_code = ERROR_CODE
+  if (args.index('--wait'))
+    abort("Did you mean \"script run --wait <seconds> [...]\"?")
+  end
+  abort("No script file provided") if args[0].nil?
+  # heaven help you if you left out the script name
+  scope = args[1]
+  scope ||= 'DEFAULT'
+  require 'openc3/script'
+  if (id = script_run(args[0], disconnect: disconnect, environment: environment, scope: scope))
+    puts id
+    ret_code = 0
+  end
+  return ret_code
+end
+
+## cli_script(args) turns an ARGV of [spawn|run] <--wait 123...> <--disconnect> SCRIPT <scope> <ENV_A=1 ENV_B=2 ...>
+#                   into function calls and tidied parameters to remote-control a script via RunningScriptWebSocketApi
+def cli_script(args=[])
+  ret_code = ERROR_CODE
+  check_environment()
+  # Double check for the OPENC3_API_PASSWORD because it is absolutely required
+  # We always pass it via openc3.sh even if it's not defined so check for empty
+  if ENV['OPENC3_API_PASSWORD'].nil? or ENV['OPENC3_API_PASSWORD'].empty?
+    abort "OPENC3_API_PASSWORD environment variable is required for cli script"
+  end
+  command = args.shift
+  # pull out the disconnect flag
+  discon = args.delete('--disconnect')
+  discon = (discon.is_a? String) ? true : false
+  environ = {}
+  args.each do |arg|
+    name, value = arg.split('=')
+    if name and value
+    # add env[k]=v ; pull out "k=v"
+      environ[name] = value
+      args.delete(arg)
+    end
+  end
+  case command
+  # for list
+  # args[] should now be ["/<path>", "<scope>"]
+  #                   or ["/<path>"]
+  #                   or ["<scope>"]
+  #                   or []
+  when 'list'
+    ret_code = cli_script_list(args)
+  # for spawn or run
+  # args[] should now be ["--wait 100", "script_name", "<scope>"]
+  #                   or ["--wait 100", "script_name"]
+  #                   or ["script_name", "<scope>"]
+  #                   or ["script_name"]
+  when 'spawn'
+    ret_code = cli_script_spawn(discon, environ, args)
+  when 'run'
+    ret_code = cli_script_run(discon, environ, args)
+  else
+    abort 'openc3cli internal error: parsing arguments'
+  end
+  exit(ret_code)
+end
+
 if not ARGV[0].nil? # argument(s) given
 
   # Handle each task
@@ -657,11 +830,20 @@ if not ARGV[0].nil? # argument(s) given
     ARGV.clear
     IRB.start
 
+  when 'script'
+    case ARGV[1]
+    when 'list', 'run', 'spawn'
+      cli_script(ARGV[1..-1])
+    else
+      # invalid actions, misplaced and malformed leading options and 'help' come here
+      abort("cli script <action> must be one of #{CLI_SCRIPT_ACTIONS}, not [#{ARGV[1]}]")
+    end
+
   when 'rake'
     if File.exist?('Rakefile')
       puts `rake #{ARGV[1..-1].join(' ')}`
     else
-      puts "No Rakefile found! Only run 'rake' in the presense of a Rakefile which is typically at the root of your COSMOS project."
+      puts "No Rakefile found! Only run 'rake' in the presence of a Rakefile which is typically at the root of your COSMOS project."
     end
 
   when 'validate'

data/data/config/_interfaces.yaml

@@ -76,7 +76,7 @@ udp_interface:
       description: Port on the local machine to send commands from. Default is
         'nil' (socket is not bound to an outgoing port).
       values: \d{2,5}
-    - name: Inteface Address
+    - name: Interface Address
       required: false
       description:
         If the remote machine supports multicast the interface address

data/data/config/command_modifiers.yaml

@@ -171,6 +171,10 @@ ACCESSOR:
       required: true
       description: The name of the accessor class
       values: .+
+    - name: Argument
+      required: false
+      description: Additional argument passed to the accessor class constructor
+      values: .+
   since: 5.0.10
 TEMPLATE:
   summary: Defines a template string used to initialize the command before default values are filled in
@@ -248,3 +252,54 @@ VIRTUAL:
   summary: Marks this packet as virtual and not participating in identification
   description: Used for packet definitions that can be used as structures for items with a given packet.
   since: 5.18.0
+VALIDATOR:
+  summary: Defines a validator class for a command
+  description: Validator class is used to validate the command success or failure with both a pre_check and post_check method.
+  parameters:
+    - name: Class Filename
+      required: true
+      description: The filename which contains the Ruby or Python class. The filename must
+        be named after the class such that the class is a CamelCase version of the
+        underscored filename. For example, 'command_validator.rb' should contain
+        'class CommandValidator'.
+      values: .*
+    - name: Argument
+      required: false
+      description: Additional argument passed to the validator class constructor
+      values: .*
+  ruby_example: |
+    VALIDATOR custom_validator.rb
+
+    Defined in custom_validator.rb:
+
+    require 'openc3/packets/command_validator'
+    class CustomValidator < OpenC3::CommandValidator
+      def pre_check(packet)
+        if tlm("TGT PKT ITEM") == 0
+          return [false, "TGT PKT ITEM is 0"]
+        end
+        @cmd_acpt_cnt = tlm("TGT PKT CMD_ACPT_CNT")
+        return [true, nil]
+      end
+      def post_check(packet)
+        wait_check("TGT PKT CMD_ACPT_CNT > #{@cmd_acpt_cnt}", 10)
+        return [true, nil]
+      end
+    end
+
+  python_example: |
+    VALIDATOR custom_validator.rb
+
+    Defined in custom_validator.py:
+
+    class CustomValidator(CommandValidator):
+        def pre_check(self, command):
+            if tlm("TGT PKT ITEM") == 0:
+                return [False, "TGT PKT ITEM is 0"]
+            self.cmd_acpt_cnt = tlm("INST HEALTH_STATUS CMD_ACPT_CNT")
+            return [True, None]
+
+        def post_check(self, command):
+            wait_check(f"INST HEALTH_STATUS CMD_ACPT_CNT > {self.cmd_acpt_cnt}", 10)
+            return [True, None]
+  since: 5.19.0

data/data/config/interface_modifiers.yaml

@@ -60,7 +60,7 @@ DISABLE_DISCONNECT:
   description:
     Use this keyword to prevent the user from disconnecting from the interface.
     This is typically used in a 'production' environment where you would not want
-    the user to inadvertantly disconnect from a target.
+    the user to inadvertently disconnect from a target.
 LOG_RAW:
   summary: Deprecated, use LOG_STREAM
 LOG_STREAM:

data/data/config/param_item_modifiers.yaml

@@ -48,7 +48,7 @@ OVERLAP:
   summary: This item is allowed to overlap other items in the packet
   description:
     If an item's bit offset overlaps another item, OpenC3 issues a warning. This keyword explicitly
-    allows an item to overlap another and supresses the warning message.
+    allows an item to overlap another and suppresses the warning message.
   since: 4.4.1
 KEY:
   summary: Defines the key used to access this raw value in the packet.

data/data/config/parameter_modifiers.yaml

@@ -207,7 +207,7 @@ OVERFLOW:
     the value by eliminating any high order bits. You can also set 'SATURATE' which
     causes OpenC3 to replace the value with the maximum or minimum allowable value
     for that type. Finally you can specify 'ERROR_ALLOW_HEX' which will allow for
-    a maximum hex value to be writen, e.g. you can successfully write 255 to a 8
+    a maximum hex value to be written, e.g. you can successfully write 255 to a 8
     bit signed value.
   example: OVERFLOW TRUNCATE
   parameters:

data/data/config/plugins.yaml

@@ -17,7 +17,7 @@ NEEDS_DEPENDENCIES:
   summary: Indicates the plugin needs dependencies and sets the GEM_HOME environment variable
   description: If the plugin has a top level lib folder or lists runtime dependencies in the gemspec,
     NEEDS_DEPENDENCIES is effectively already set. Note that in Enterprise Edition, having
-    NEEDS_DEPENDENCIES adds the NFS volume mount to the Kuberentes pod.
+    NEEDS_DEPENDENCIES adds the NFS volume mount to the Kubernetes pod.
   since: 5.5.0
 INTERFACE:
   modifiers:
@@ -71,10 +71,14 @@ WIDGET:
   description: Defines a custom widget that can be used in Telemetry Viewer screens.
   parameters:
     - name: Widget Name
-      description: The name of the widget wil be used to build a path to the widget implementation. For example, `WIDGET HELLOWORLD` will find the as-built file tools/widgets/HelloworldWidget/HelloworldWidget.umd.min.js. See the [Custom Widgets](../guides/custom-widgets.md)
+      description: The name of the widget will be used to build a path to the widget implementation. For example, `WIDGET HELLOWORLD` will find the as-built file tools/widgets/HelloworldWidget/HelloworldWidget.umd.min.js. See the [Custom Widgets](../guides/custom-widgets.md)
         guide for more details.
       required: true
       values: .+
+    - name: Label
+      description: The label for the widget that will appear in the Data Viewer component drop down
+      required: false
+      values: .+
   modifiers:
     DISABLE_ERB:
       summary: Disable ERB processing

data/data/config/screen.yaml

@@ -93,7 +93,7 @@ SETTING:
     GLOBAL_SETTING and GLOBAL_SUBSETTING applies to all widgets.
 
     Common wiget settings are defined here. Some widgets define their own
-    unqiue settings which are documented under that specific widget.
+    unique settings which are documented under that specific widget.
   collection:
     <%= MetaConfigParser.load('settings.yaml').to_meta_config_yaml(4) %>
 SUBSETTING:
@@ -127,7 +127,7 @@ SUBSETTING:
     END
 NAMED_WIDGET:
   summary: Name a widget to allow access to it via the getNamedWidget method
-  description: To programatically access parts of a telemetry screen you need
+  description: To programmatically access parts of a telemetry screen you need
     to name the widget. This is useful when creating screens with buttons that
     read values from other widgets.
   warning: getNamedWidget returns the widget itself and thus must be operated

data/data/config/table_manager.yaml

@@ -61,7 +61,7 @@ TABLE:
                 used in mouseover popups and status line information.
               values: "['\"].*['\"]"
         ROW_COLUMN:
-          summary: Table rows will be indentical with multiple columns (previously TWO_DIMENSIONAL, now deprecated)
+          summary: Table rows will be identical with multiple columns (previously TWO_DIMENSIONAL, now deprecated)
           parameters:
             - name: Rows
               requires: true
@@ -77,7 +77,7 @@ SELECT_TABLE:
   parameters:
     - name: Table
       required: true
-      description: The name of the existin table
+      description: The name of the existing table
       values: .*
 DEFAULT:
   summary: Specify default values for a SINGLE row in a multi-column table

data/data/config/tool.yaml

@@ -63,7 +63,10 @@ TOOL:
           values: ["true", "false"]
     POSITION:
       summary: Position of the tool in the nav bar
-      description: Position of the tool as an integer starting at 1. Tools without a position are appended to the end as they are installed.
+      description:
+        Position of the tool starting at 2 (1 is reserved for Admin Console).
+        Tools without a position are appended to the end as they are installed.
+        All COSMOS open source tools have consecutive integer values for position.
       since: 5.0.8
       parameters:
         - name: Position

data/data/config/widgets.yaml

@@ -121,7 +121,7 @@ Layout Widgets:
       parameters:
         - name: Tab text
           required: true
-          description: Text to diplay in the tab
+          description: Text to display in the tab
           values: .*
       example: |
         TABBOOK
@@ -1034,7 +1034,7 @@ Telemetry Widgets:
         IMAGEVIEWER INST IMAGE IMAGE jpg
     PROGRESSBAR:
       summary: Displays a progress bar that is useful for displaying percentages
-      parmeters:
+      parameters:
         - name: Target name
           required: true
           description: The target name
@@ -1108,7 +1108,7 @@ Telemetry Widgets:
         RANGEBAR INST HEALTH_STATUS TEMP1 -100 100
     # RANGECOLUMN:
     #   summary: Displays a graphical representation of where
-    #     an item's value falls withing a range vertically
+    #     an item's value falls within a range vertically
     #   parameters:
     #     - name: Target name
     #       required: true

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

@@ -77,7 +77,7 @@ static VALUE string_remove_quotes(VALUE self)
 
 /*
  * Method to read a line from the config file.
- * This is a seperate method so that it can be protected.
+ * This is a separate method so that it can be protected.
  */
 static VALUE config_parser_readline(VALUE io)
 {

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

@@ -177,7 +177,7 @@ static VALUE received_count_equals(VALUE self, VALUE received_count)
   return rb_ivar_get(self, id_ivar_received_count);
 }
 
-/* Creates a new packet by initalizing the attributes.
+/* Creates a new packet by initializing the attributes.
  *
  * @param target_name [String] Name of the target this packet is associated with
  * @param packet_name [String] Name of the packet

data/ext/openc3/ext/platform/platform.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.
 */
 
@@ -93,7 +93,7 @@ __attribute__((noreturn)) static void catch_sigsegv(int sig_num)
            timeinfo.tm_min,
            timeinfo.tm_sec);
 
-  // Fortify warns about Path Manipulation here. We explictly allow this to let
+  // Fortify warns about Path Manipulation here. We explicitly allow this to let
   // segfault files be written to a directory of their choosing.
   // The input is validated above for length and to ensure it is a writable directory.
   // If the checks fail the directory is set to the current directory without additional info.
@@ -124,7 +124,7 @@ __attribute__((noreturn)) static void catch_sigsegv(int sig_num)
 void Init_platform(void)
 {
 #ifdef _WIN32
-  /* Only supprt linux segfault catching */
+  /* Only support linux segfault catching */
 #else
   signal(SIGSEGV, catch_sigsegv);
   signal(SIGILL, catch_sigsegv);