openc3 6.9.1 → 6.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83838350c2ec54b5fcd1b6108f42fe9d7f45fd24f6de04fb7c5c98855251b9b9
-  data.tar.gz: c1b89314a5af6f7740857228d01c0ab9e2b2e03e59c209b0e646fefb4f281425
+  metadata.gz: 1432f7bc925107320f327e82f47ebe6d6da648d00fc6c6469f4f093e69a8dc96
+  data.tar.gz: 5aea790bee69e50decbbf418b295eda17a653305f78661c334531afa94f9d265
 SHA512:
-  metadata.gz: 35be666ae0ea4d134fa6c7d54d79ee323e5d878918c25706d17514b1db8b28b6ca05c6c0f175426f285227e6fd16d6b90ccbf21316c71057aaaf958660a7c8a7
-  data.tar.gz: 3c0f703c797d6fbd1be90d526a91ac94a06ec6d9ad042e3ea1212da4c73557be6e4634be73ca49f17c8277f7b7052154e0283b0a994f84f91cf96422811155ac
+  metadata.gz: dbb54c3b45300cc626c4497ef71c7069567dad94d6f6c73fb1a7dd7093219531d31ffee8bd175ac08b9fee682ab93a488c796d3bf408365a64027740ed9913a3
+  data.tar.gz: a703fe408f123953eccf8e9e2b6fb63306404501456a5463410babb95512c68387440279e0d91e61b674ea3bf72122d3480d0001d994cf943d6b901f1a10cc08

data/bin/openc3cli

@@ -875,6 +875,22 @@ if not ARGV[0].nil? # argument(s) given
   case ARGV[0].downcase
 
   when 'irb'
+    if ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli irb"
+      puts ""
+      puts "Start an interactive Ruby (IRB) session with COSMOS libraries loaded"
+      puts ""
+      puts "This provides access to all COSMOS classes and methods for interactive"
+      puts "debugging and exploration. Use 'exit' or Ctrl-D to quit the IRB session."
+      puts ""
+      puts "Example:"
+      puts "  cli irb"
+      puts "  > require 'openc3'"
+      puts "  > OpenC3::System.targets"
+      puts ""
+      puts "Note: For IRB-specific options, start IRB first then type 'help'"
+      exit 0
+    end
     ARGV.clear
     IRB.start
 
@@ -882,6 +898,29 @@ if not ARGV[0].nil? # argument(s) given
     cli_script(ARGV[1..-1])
 
   when 'rake'
+    # Check for --help first, before checking for Rakefile
+    if ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli rake [RAKE_OPTIONS] [TASKS...]"
+      puts ""
+      puts "Run rake tasks in the current directory"
+      puts ""
+      puts "This runs the standard Ruby rake tool with all COSMOS libraries available."
+      puts "A Rakefile must exist in the current directory."
+      puts ""
+      puts "Common rake options:"
+      puts "  -T, --tasks              List all available rake tasks with descriptions"
+      puts "  -D, --describe PATTERN   Describe tasks matching PATTERN"
+      puts "  -h, --help               Show rake's full help message"
+      puts ""
+      puts "Examples:"
+      puts "  cli rake -T              # List all available tasks"
+      puts "  cli rake build           # Run the 'build' task"
+      puts "  cli rake test            # Run tests"
+      puts ""
+      puts "Note: Must be run in a directory containing a Rakefile"
+      exit 0
+    end
+    # Now check for Rakefile existence
     if File.exist?('Rakefile')
       puts `rake #{ARGV[1..-1].join(' ')}`
     else
@@ -889,9 +928,70 @@ if not ARGV[0].nil? # argument(s) given
     end
 
   when 'validate'
+    if ARGV[1].nil? || ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli validate PLUGIN.gem [SCOPE] [VARIABLES.json]"
+      puts ""
+      puts "Validate a COSMOS plugin gem file"
+      puts ""
+      puts "Arguments:"
+      puts "  PLUGIN.gem        Plugin gem file to validate (required)"
+      puts "  SCOPE             Scope for validation (optional, default: DEFAULT)"
+      puts "  VARIABLES.json    Variables JSON file (optional)"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit(ARGV[1].nil? ? 1 : 0)
+    end
     validate_plugin(ARGV[1], scope: ARGV[2], variables_file: ARGV[3])
 
   when 'load'
+    # Check for help flag or missing arguments
+    if ARGV[1].nil? || ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage:"
+      puts "  cli load PLUGIN.gem"
+      puts "  cli load PLUGIN.gem --variables VARIABLES.json"
+      puts "  cli load PLUGIN.gem SCOPE PLUGIN_HASH.json [force]"
+      puts "  cli load PLUGIN.gem --variables VARIABLES.json SCOPE PLUGIN_HASH.json [force]"
+      puts ""
+      puts "Load a COSMOS plugin gem file"
+      puts ""
+      puts "Common Usage (Auto-detect):"
+      puts "  cli load PLUGIN.gem"
+      puts "    - Installs new plugin in DEFAULT scope"
+      puts "    - Automatically detects and upgrades if plugin already exists"
+      puts "    - Skips installation if same version already installed"
+      puts ""
+      puts "  cli load PLUGIN.gem --variables VARIABLES.json"
+      puts "    - Same as above, but provides variables for plugin configuration"
+      puts ""
+      puts "Advanced Usage (Manual Control):"
+      puts "  cli load PLUGIN.gem SCOPE PLUGIN_HASH.json [force]"
+      puts "    - Used by Admin UI for plugin create/edit/upgrade operations"
+      puts "    - Requires PLUGIN_HASH.json (output from install_phase1)"
+      puts "    - 'force' argument forces reinstall even if version unchanged"
+      puts ""
+      puts "Arguments:"
+      puts "  PLUGIN.gem           Plugin gem file to load (required)"
+      puts "  SCOPE                Scope to install plugin in (default: DEFAULT)"
+      puts "  PLUGIN_HASH.json     Plugin hash JSON file from install_phase1 (optional)"
+      puts "  force                Force plugin installation even if no changes (optional)"
+      puts ""
+      puts "Options:"
+      puts "  --variables FILE     Variables JSON file for plugin installation"
+      puts "  -h, --help           Show this help message"
+      puts ""
+      puts "IMPORTANT LIMITATION:"
+      puts "  To specify SCOPE without PLUGIN_HASH.json, you must use the --variables"
+      puts "  option (even with an empty JSON file) to prevent argument misinterpretation."
+      puts ""
+      puts "Examples:"
+      puts "  cli load my-plugin-1.0.0.gem"
+      puts "  cli load my-plugin-1.0.0.gem --variables vars.json"
+      puts "  cli load my-plugin-1.0.0.gem DEFAULT plugin_hash.json"
+      puts "  cli load my-plugin-1.0.0.gem DEFAULT plugin_hash.json force"
+      exit(ARGV[1].nil? ? 1 : 0)
+    end
+
     # force is a boolean so if they pass 'force' it is true
     # See plugins_controller.rb install for usage
     variables_option = ARGV.find_index('--variables')
@@ -908,15 +1008,68 @@ if not ARGV[0].nil? # argument(s) given
     load_plugin(ARGV[1], scope: scope, plugin_hash_file: plugin_hash_file, force: force, variables_file: variables_file)
 
   when 'list'
+    if ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli list [SCOPE]"
+      puts ""
+      puts "List all installed plugins in the specified scope"
+      puts ""
+      puts "Arguments:"
+      puts "  SCOPE             Scope to list plugins from (optional, default: DEFAULT)"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit 0
+    end
     list_plugins(scope: ARGV[1])
 
   when 'unload'
+    if ARGV[1].nil? || ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli unload PLUGIN_NAME [SCOPE]"
+      puts ""
+      puts "Unload a COSMOS plugin"
+      puts ""
+      puts "Arguments:"
+      puts "  PLUGIN_NAME       Name of the plugin to unload (required)"
+      puts "  SCOPE             Scope to unload from (optional, default: DEFAULT)"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit(ARGV[1].nil? ? 1 : 0)
+    end
     unload_plugin(ARGV[1], scope: ARGV[2])
 
   when 'pkginstall', 'geminstall'
+    if ARGV[1].nil? || ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli pkginstall PACKAGE_NAME [SCOPE]"
+      puts "       cli geminstall GEM_NAME [SCOPE]"
+      puts ""
+      puts "Install a package/gem into a loaded plugin"
+      puts ""
+      puts "Arguments:"
+      puts "  PACKAGE_NAME      Name of the package to install (required)"
+      puts "  SCOPE             Scope for installation (optional, default: DEFAULT)"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit(ARGV[1].nil? ? 1 : 0)
+    end
     cli_pkg_install(ARGV[1], scope: ARGV[2])
 
   when 'pkguninstall', 'gemuninstall'
+    if ARGV[1].nil? || ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli pkguninstall PACKAGE_NAME [SCOPE]"
+      puts "       cli gemuninstall GEM_NAME [SCOPE]"
+      puts ""
+      puts "Uninstall a package/gem from a loaded plugin"
+      puts ""
+      puts "Arguments:"
+      puts "  PACKAGE_NAME      Name of the package to uninstall (required)"
+      puts "  SCOPE             Scope for uninstallation (optional, default: DEFAULT)"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit(ARGV[1].nil? ? 1 : 0)
+    end
     cli_pkg_uninstall(ARGV[1], scope: ARGV[2])
 
   when 'generate'
@@ -934,6 +1087,19 @@ if not ARGV[0].nil? # argument(s) given
     xtce_converter(ARGV[1..-1])
 
   when 'bridge'
+    if ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli bridge [FILENAME] [PARAMS...]"
+      puts ""
+      puts "Run a COSMOS bridge from a bridge configuration file"
+      puts ""
+      puts "Arguments:"
+      puts "  FILENAME          Bridge config file (optional, default: bridge.txt)"
+      puts "  PARAMS            Additional parameters to pass to bridge"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit 0
+    end
     ENV['OPENC3_NO_STORE'] = '1'
     filename = ARGV[1]
     filename = 'bridge.txt' unless filename
@@ -942,6 +1108,19 @@ if not ARGV[0].nil? # argument(s) given
     run_bridge(filename, params)
 
   when 'bridgegem'
+    if ARGV[1].nil? || ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli bridgegem GEM_NAME [PARAMS...]"
+      puts ""
+      puts "Run a COSMOS bridge from a gem's bridge.txt file"
+      puts ""
+      puts "Arguments:"
+      puts "  GEM_NAME          Name of the gem containing bridge.txt (required)"
+      puts "  PARAMS            Additional parameters to pass to bridge"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit(ARGV[1].nil? ? 1 : 0)
+    end
     ENV['OPENC3_NO_STORE'] = '1'
     filename = nil
     gem_name = ARGV[1]
@@ -967,6 +1146,18 @@ if not ARGV[0].nil? # argument(s) given
     run_bridge(filename, params)
 
   when 'bridgesetup'
+    if ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli bridgesetup [FILENAME]"
+      puts ""
+      puts "Generate a default bridge configuration file"
+      puts ""
+      puts "Arguments:"
+      puts "  FILENAME          Output filename (optional, default: bridge.txt)"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit 0
+    end
     ENV['OPENC3_NO_STORE'] = '1'
     filename = ARGV[1]
     filename = 'bridge.txt' unless filename
@@ -978,10 +1169,36 @@ if not ARGV[0].nil? # argument(s) given
     print_usage()
 
   when 'redis'
+    if ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli redis COMMAND [ARGS...]"
+      puts ""
+      puts "Interact with the Redis database"
+      puts ""
+      puts "Commands:"
+      puts "  keys              Get all Redis keys"
+      puts "  hget HASH KEY     Get a value from a Redis hash"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit 0
+    end
     case (ARGV[1])
     when 'keys'
       get_redis_keys()
     when 'hget'
+      if ARGV[2].nil? || ARGV[3].nil? || ARGV[2] == '--help' || ARGV[2] == '-h'
+        puts "Usage: cli redis hget HASH KEY"
+        puts ""
+        puts "Get a value from a Redis hash"
+        puts ""
+        puts "Arguments:"
+        puts "  HASH              Redis hash name (required)"
+        puts "  KEY               Key within the hash (required)"
+        puts ""
+        puts "Options:"
+        puts "  -h, --help        Show this help message"
+        exit(ARGV[2].nil? || ARGV[3].nil? ? 1 : 0)
+      end
       redis = Redis.new(url: $redis_url, username: ENV['OPENC3_REDIS_USERNAME'], password: ENV['OPENC3_REDIS_PASSWORD'])
       puts JSON.parse(redis.hget(ARGV[2], ARGV[3]), allow_nan: true, create_additions: true)
     else
@@ -990,6 +1207,16 @@ if not ARGV[0].nil? # argument(s) given
     end
 
   when 'removebase'
+    if ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli removebase"
+      puts ""
+      puts "Remove non-enterprise tool base and admin plugins from all scopes"
+      puts "This is typically used to support enterprise upgrades"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit 0
+    end
     # Used to remove tool base to better support enterprise upgrade
     scopes = OpenC3::ScopeModel.all
     scopes.each do |scope_name, _scope|
@@ -1005,6 +1232,16 @@ if not ARGV[0].nil? # argument(s) given
     end
 
   when 'removeenterprise'
+    if ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli removeenterprise"
+      puts ""
+      puts "Remove all enterprise plugins from all scopes"
+      puts "This is typically used to support downgrades"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit 0
+    end
     # Used to remove enterprise plugins to better support downgrade
     scopes = OpenC3::ScopeModel.all
     scopes.each do |scope_name, _scope|
@@ -1017,6 +1254,19 @@ if not ARGV[0].nil? # argument(s) given
     end
 
   when 'createqueue'
+    if ARGV[1].nil? || ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli createqueue QUEUE_NAME [SCOPE]"
+      puts ""
+      puts "Create a new queue in the specified scope"
+      puts ""
+      puts "Arguments:"
+      puts "  QUEUE_NAME        Name of the queue to create (required)"
+      puts "  SCOPE             Scope for the queue (optional, default: DEFAULT)"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit(ARGV[1].nil? ? 1 : 0)
+    end
     queue = OpenC3::QueueModel.get(name: ARGV[1], scope: ARGV[2])
     unless queue
       queue = OpenC3::QueueModel.new(name: ARGV[1], state: 'RELEASE', scope: ARGV[2])
@@ -1024,13 +1274,43 @@ if not ARGV[0].nil? # argument(s) given
     end
 
   when 'destroyscope'
+    if ARGV[1].nil? || ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli destroyscope SCOPE_NAME"
+      puts ""
+      puts "Destroy a scope and all its associated data"
+      puts ""
+      puts "Arguments:"
+      puts "  SCOPE_NAME        Name of the scope to destroy (required)"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit(ARGV[1].nil? ? 1 : 0)
+    end
     scope = OpenC3::ScopeModel.get_model(name: ARGV[1])
     scope.destroy
 
   when 'localinit'
+    if ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli localinit"
+      puts ""
+      puts "Initialize local mode configuration"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit 0
+    end
     OpenC3::LocalMode.local_init()
 
   when 'initbuckets'
+    if ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli initbuckets"
+      puts ""
+      puts "Initialize all configured COSMOS buckets"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit 0
+    end
     client = OpenC3::Bucket.getClient()
     ENV.map do |key, value|
       if key.match(/^OPENC3_(.+)_BUCKET$/) && !value.empty?
@@ -1040,6 +1320,15 @@ if not ARGV[0].nil? # argument(s) given
     client.ensure_public(ENV['OPENC3_TOOLS_BUCKET'])
 
   when 'runmigrations'
+    if ARGV[1] == '--help' || ARGV[1] == '-h'
+      puts "Usage: cli runmigrations"
+      puts ""
+      puts "Run database migrations"
+      puts ""
+      puts "Options:"
+      puts "  -h, --help        Show this help message"
+      exit 0
+    end
     run_migrations(ARGV[1])
 
   else # Unknown task

data/data/config/command_modifiers.yaml

@@ -96,6 +96,68 @@ APPEND_ARRAY_PARAMETER:
       values: .*
     <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
   example: APPEND_ARRAY_PARAMETER ARRAY 64 FLOAT 640 "Array of 10 64bit floats"
+STRUCTURE:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Adds and flattens a structure (generally a virtual packet) into the current packet. The specific named item is BLOCK type and hidden.
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: .*
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the command packet of the Most Significant Bit of this parameter.
+        May be negative to indicate an offset from the end of the packet.
+        Always use a bit offset of 0 for derived parameters.
+      values: '[-]?\d+'
+    - name: Bit Size
+      required: true
+      description: Bit size of this parameter. Zero or Negative values may be used
+        to indicate that a string fills the packet up to the offset from the end of
+        the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then
+        this is a derived parameter and the Data Type must be set to 'DERIVED'.
+      values: \d+
+    - name: Command or telemetry
+      required: true
+      description: Whether the structure packet is a command or telemetry packet
+      values: <%= %w(CMD COMMAND TLM TELEMETRY) %>
+    - name: Target Name
+      required: true
+      description: Target Name of the structure packet
+      values: .+
+    - name: Packet Name
+      required: true
+      description: Packet Name of the structure packet
+      values: .+
+APPEND_STRUCTURE:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Adds and flattens a structure (generally a virtual packet) into the current packet. The specific named item is BLOCK type and hidden.
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: .*
+    - name: Bit Size
+      required: true
+      description: Bit size of this parameter. Zero or Negative values may be used
+        to indicate that a string fills the packet up to the offset from the end of
+        the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then
+        this is a derived parameter and the Data Type must be set to 'DERIVED'.
+      values: \d+
+    - name: Command or telemetry
+      required: true
+      description: Whether the structure packet is a command or telemetry packet
+      values: <%= %w(CMD COMMAND TLM TELEMETRY) %>
+    - name: Target Name
+      required: true
+      description: Target Name of the structure packet
+      values: .+
+    - name: Packet Name
+      required: true
+      description: Packet Name of the structure packet
+      values: .+
 SELECT_PARAMETER:
   modifiers:
     <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
@@ -176,6 +238,19 @@ ACCESSOR:
       description: Additional argument passed to the accessor class constructor
       values: .+
   since: 5.0.10
+SUBPACKETIZER:
+  summary: Defines a class used to break up the packet into subpackets before decom
+  description: Defines a class used to break up the packet into subpackets before decom. Defaults to nil/None.
+  parameters:
+    - name: Subpacketizer Class Name
+      required: true
+      description: The name of the Subpacketizer class
+      values: .+
+    - name: Argument
+      required: false
+      description: Additional argument passed to the Subpacketizer class constructor
+      values: .+
+  since: 6.10.0
 TEMPLATE:
   summary: Defines a template string used to initialize the command before default values are filled in
   description: Generally the template string is formatted in JSON or HTML and then values are filled in with
@@ -256,6 +331,10 @@ RESTRICTED:
   summary: Marks this packet as restricted and will require approval if critical commanding is enabled
   description: Used as one of the two types of critical commands (HAZARDOUS and RESTRICTED)
   since: 5.20.0
+SUBPACKET:
+  summary: Marks this packet as as a subpacket which will exclude it from Interface level identification
+  description: Used with a SUBPACKETIZER to breakup up packets into subpackets at decom time
+  since: 6.10.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.

data/data/config/item_modifiers.yaml

@@ -176,3 +176,8 @@ LIMITS_RESPONSE:
       description: Variable length number of options that will be passed to the
         class constructor
       values: .+
+HIDDEN:
+  summary: Hides this item from all the OpenC3 tools
+  description: This item will not appear in PacketViewer or Item Choosers.
+    It also hides this item from appearing in the Script Runner popup helper
+    when writing scripts. The item will also not be included in decom data.

data/data/config/parameter_modifiers.yaml

@@ -167,3 +167,8 @@ OVERFLOW:
       description: How OpenC3 treats an overflow value. Only applies to signed and
         unsigned integer data types.
       values: <%= %w(ERROR ERROR_ALLOW_HEX TRUNCATE SATURATE) %>
+HIDDEN:
+  summary: Hides this parameter from all the OpenC3 tools
+  description: This item will not appear in CmdSender.
+    It also hides this item from appearing in the Script Runner popup helper
+    when writing scripts. The parameter should not be provided to commands.

data/data/config/telemetry_modifiers.yaml

@@ -86,6 +86,68 @@ APPEND_ARRAY_ITEM:
       description: Name of the telemety item. Must be unique within the packet.
       values: \'
     <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
+STRUCTURE:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Adds and flattens a structure (generally a virtual packet) into the current packet. The specific named item is BLOCK type and hidden.
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: .*
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the command packet of the Most Significant Bit of this parameter.
+        May be negative to indicate an offset from the end of the packet.
+        Always use a bit offset of 0 for derived parameters.
+      values: '[-]?\d+'
+    - name: Bit Size
+      required: true
+      description: Bit size of this parameter. Zero or Negative values may be used
+        to indicate that a string fills the packet up to the offset from the end of
+        the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then
+        this is a derived parameter and the Data Type must be set to 'DERIVED'.
+      values: \d+
+    - name: Command or telemetry
+      required: true
+      description: Whether the structure packet is a command or telemetry packet
+      values: <%= %w(CMD COMMAND TLM TELEMETRY) %>
+    - name: Target Name
+      required: true
+      description: Target Name of the structure packet
+      values: .+
+    - name: Packet Name
+      required: true
+      description: Packet Name of the structure packet
+      values: .+
+APPEND_STRUCTURE:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Adds and flattens a structure (generally a virtual packet) into the current packet. The specific named item is BLOCK type and hidden.
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: .*
+    - name: Bit Size
+      required: true
+      description: Bit size of this parameter. Zero or Negative values may be used
+        to indicate that a string fills the packet up to the offset from the end of
+        the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then
+        this is a derived parameter and the Data Type must be set to 'DERIVED'.
+      values: \d+
+    - name: Command or telemetry
+      required: true
+      description: Whether the structure packet is a command or telemetry packet
+      values: <%= %w(CMD COMMAND TLM TELEMETRY) %>
+    - name: Target Name
+      required: true
+      description: Target Name of the structure packet
+      values: .+
+    - name: Packet Name
+      required: true
+      description: Packet Name of the structure packet
+      values: .+
 SELECT_ITEM:
   modifiers:
     <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
@@ -173,6 +235,19 @@ ACCESSOR:
       description: The name of the accessor class
       values: .+
   since: 5.0.10
+SUBPACKETIZER:
+  summary: Defines a class used to break up the packet into subpackets before decom
+  description: Defines a class used to break up the packet into subpackets before decom. Defaults to nil/None.
+  parameters:
+    - name: Subpacketizer Class Name
+      required: true
+      description: The name of the Subpacketizer class
+      values: .+
+    - name: Argument
+      required: false
+      description: Additional argument passed to the Subpacketizer class constructor
+      values: .+
+  since: 6.10.0
 TEMPLATE:
   summary: Defines a template string used to pull telemetry values from a string buffer
   parameters:
@@ -198,3 +273,7 @@ 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
+SUBPACKET:
+  summary: Marks this packet as as a subpacket which will exclude it from Interface level identification
+  description: Used with a SUBPACKETIZER to breakup up packets into subpackets at decom time
+  since: 6.10.0

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

@@ -64,6 +64,9 @@ static ID id_ivar_packet_time = 0;
 static ID id_ivar_ignore_overlap = 0;
 static ID id_ivar_virtual = 0;
 static ID id_ivar_restricted = 0;
+static ID id_ivar_subpacket = 0;
+static ID id_ivar_subpacketizer = 0;
+static ID id_ivar_obfuscated_items = 0;
 
 /* Sets the target name this packet is associated with. Unidentified packets
  * will have target name set to nil.
@@ -291,6 +294,9 @@ static VALUE packet_initialize(int argc, VALUE *argv, VALUE self)
   rb_ivar_set(self, id_ivar_ignore_overlap, Qfalse);
   rb_ivar_set(self, id_ivar_virtual, Qfalse);
   rb_ivar_set(self, id_ivar_restricted, Qfalse);
+  rb_ivar_set(self, id_ivar_subpacket, Qfalse);
+  rb_ivar_set(self, id_ivar_subpacketizer, Qnil);
+  rb_ivar_set(self, id_ivar_obfuscated_items, Qnil);
   return self;
 }
 
@@ -335,6 +341,9 @@ void Init_packet(void)
   id_ivar_ignore_overlap = rb_intern("@ignore_overlap");
   id_ivar_virtual = rb_intern("@virtual");
   id_ivar_restricted = rb_intern("@restricted");
+  id_ivar_subpacket = rb_intern("@subpacket");
+  id_ivar_subpacketizer = rb_intern("@subpacketizer");
+  id_ivar_obfuscated_items = rb_intern("@obfuscated_items");
 
   cPacket = rb_define_class_under(mOpenC3, "Packet", cStructure);
   rb_define_method(cPacket, "initialize", packet_initialize, -1);