openc3 5.5.1 → 5.5.2.pre.beta0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2b1524aa1d06a8149e80ffb2843b3a9304d73cf432ecd641396292bf5209439
-  data.tar.gz: f35947a803088cb83705c3748fb860751cf40228a5c4720d151c867a001157ce
+  metadata.gz: 9afdd0579f3b0663d3cd0d378483b372c2f3c34faa5856d1c5ef5b4a1e582af3
+  data.tar.gz: 9224b37cda9d56d8e867a0ead73d815b3140979355a85d408824377e628fec10
 SHA512:
-  metadata.gz: 245f9f7fe39f5ac4f82bab653de55f413432b3ad9f73b586f2d82f2a14e50bcd6d77a5bc11e1b4a9a2f95c4b11c2aef55dcc325ab330da076ecdb7f0245fb374
-  data.tar.gz: 2f142eea4029f7b1efd3564578413e09d23acd6b9136799d123db48e733577d28a50c3e90640143e20e8f092874ec08c277df6ca721cf2a33bc4c1ffeabf42ba
+  metadata.gz: 2c3e6009efea9ee0b7669634ba9dd0c45dd81fa9f47405ddd44ec375993e7d85b8f4b51547cb943c3229e2bfd7e5aa5ddfc5ad1de8963a6d05e8220c029e3baf
+  data.tar.gz: 4cbe48f762771ad19429e19102f5fe427607814b1eb2149a06ed713a972d807481b767b023031fe21c21465a67108e39ceb0fef003d0ffea533b3db223960764

data/data/config/_canvas_values.yaml

@@ -1,5 +1,6 @@
 VALUE_EQ:
   summary: Map a value to a color
+  since: 5.5.1
   parameters:
     - name: Value
       required: true

data/data/config/command.yaml

@@ -5,7 +5,6 @@ COMMAND:
   modifiers:
     <%= MetaConfigParser.load('command_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Defines a new command packet
-  example: COMMAND INST COLLECT BIG_ENDIAN "Start collect"
   parameters:
     - name: Target
       required: true
@@ -24,6 +23,7 @@ COMMAND:
       required: false
       description: Description of this command which must be enclosed with quotes
       values: '[''"].*[''"]'
+  example: COMMAND INST COLLECT BIG_ENDIAN "Start collect"
 SELECT_COMMAND:
   # prettier-ignore
   modifiers:
@@ -31,8 +31,8 @@ SELECT_COMMAND:
   summary: Selects an existing command packet for editing
   description:
     Typically used in a separate configuration file from where the original
-    command is defined to override or add to the existing command definition
-  example: SELECT_COMMAND INST COLLECT
+    command is defined to override or add to the existing command definition.
+    Must be used in conjunction with SELECT_PARAMETER to change an individual parameter.
   parameters:
     - name: Target Name
       required: true
@@ -42,3 +42,8 @@ SELECT_COMMAND:
       required: true
       description: Name of the command to select
       values: .*
+  example: |
+    SELECT_COMMAND INST COLLECT
+      SELECT_PARAMETER DURATION
+        # Add units
+        UNITS Seconds S

data/data/config/command_modifiers.yaml

@@ -3,12 +3,6 @@ PARAMETER:
   modifiers:
     <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Defines a command parameter in the current command packet
-  example: |
-    PARAMETER SYNC 0 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"
-    PARAMETER DATA 32 32 INT MIN MAX 0 "Data value"
-    PARAMETER VALUE 64 32 FLOAT 0 10.5 2.5
-    PARAMETER LABEL 96 96 STRING "OPENC3" "The label to apply"
-    PARAMETER BLOCK 192 0 BLOCK 0x0 "Block of binary data"
   parameters:
     - name: Name
       required: true
@@ -21,20 +15,26 @@ PARAMETER:
         Always use a bit offset of 0 for derived parameters.
       values: '[-]?\d+'
     <%= MetaConfigParser.load('_params.yaml').to_meta_config_yaml(4) %>
+  example: |
+    PARAMETER SYNC 0 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"
+    PARAMETER DATA 32 32 INT MIN MAX 0 "Data value"
+    PARAMETER VALUE 64 32 FLOAT 0 10.5 2.5
+    PARAMETER LABEL 96 96 STRING "OPENC3" "The label to apply"
+    PARAMETER BLOCK 192 0 BLOCK 0x0 "Block of binary data"
 APPEND_PARAMETER:
   modifiers:
     <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Defines a command parameter in the current command packet
-  example: |
-    APPEND_PARAMETER SYNC 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"
-    APPEND_PARAMETER VALUE 32 FLOAT 0 10.5 2.5
-    APPEND_PARAMETER LABEL 0 STRING "OPENC3" "The label to apply"
   parameters:
     - name: Name
       required: true
       description: Name of the parameter. Must be unique within the command.
       values: .+
     <%= MetaConfigParser.load('_params.yaml').to_meta_config_yaml(4) %>
+  example: |
+    APPEND_PARAMETER SYNC 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"
+    APPEND_PARAMETER VALUE 32 FLOAT 0 10.5 2.5
+    APPEND_PARAMETER LABEL 0 STRING "OPENC3" "The label to apply"
 ID_PARAMETER:
   modifiers:
     <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
@@ -42,7 +42,6 @@ ID_PARAMETER:
   description: ID parameters are used to identify the binary block of data as a
     particular command. A command packet may have one or more ID_PARAMETERs and all
     must match the binary data for the command to be identified.
-  example: ID_PARAMETER OPCODE 32 32 UINT 2 2 2 "Opcode identifier"
   parameters:
     - name: Name
       required: true
@@ -55,6 +54,7 @@ ID_PARAMETER:
         Always use a bit offset of 0 for derived parameters.
       values: '[-]?\d+'
     <%= MetaConfigParser.load('_id_params.yaml').to_meta_config_yaml(4) %>
+  example: ID_PARAMETER OPCODE 32 32 UINT 2 2 2 "Opcode identifier"
 APPEND_ID_PARAMETER:
   modifiers:
     <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
@@ -62,18 +62,17 @@ APPEND_ID_PARAMETER:
   description: ID parameters are used to identify the binary block of data as a
     particular command. A command packet may have one or more ID_PARAMETERs and all
     must match the binary data for the command to be identified.
-  example: APPEND_ID_PARAMETER OPCODE 32 UINT 2 2 2 "Opcode identifier"
   parameters:
     - name: Name
       required: true
       description: Name of the parameter. Must be unique within the command.
       values: .+
     <%= MetaConfigParser.load('_id_params.yaml').to_meta_config_yaml(4) %>
+  example: APPEND_ID_PARAMETER OPCODE 32 UINT 2 2 2 "Opcode identifier"
 ARRAY_PARAMETER:
   modifiers:
     <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Defines a command parameter in the current command packet that is an array
-  example: ARRAY_PARAMETER ARRAY 64 64 FLOAT 640 "Array of 10 64bit floats"
   parameters:
     - name: Name
       required: true
@@ -86,44 +85,50 @@ ARRAY_PARAMETER:
         Always use a bit offset of 0 for derived parameters.
       values: '[-]?\d+'
     <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
+  example: ARRAY_PARAMETER ARRAY 64 64 FLOAT 640 "Array of 10 64bit floats"
 APPEND_ARRAY_PARAMETER:
   modifiers:
     <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Defines a command parameter in the current command packet that is an array
-  example: APPEND_ARRAY_PARAMETER ARRAY 64 FLOAT 640 "Array of 10 64bit floats"
   parameters:
     - name: Name
       required: true
       description: Name of the parameter. Must be unique within the command.
       values: .*
     <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
+  example: APPEND_ARRAY_PARAMETER ARRAY 64 FLOAT 640 "Array of 10 64bit floats"
 SELECT_PARAMETER:
   modifiers:
     <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Selects an existing command parameter for editing
-  example: |
-    SELECT_COMMAND INST COLLECT
-      SELECT_PARAMETER DURATION
+  description: Must be used in conjunction with SELECT_COMMAND to first select
+    the packet. Typically used to override generated values or make specific changes
+    to commands that only affect a particular instance of a target used multiple times.
   parameters:
     - name: Parameter
       required: true
       description: Name of the parameter to select for modification
       values: .+
+  example: |
+    SELECT_COMMAND INST COLLECT
+      SELECT_PARAMETER DURATION
+        # Add units
+        UNITS Seconds S
 DELETE_PARAMETER:
   summary: Deletes an existing command parameter from the packet definition
   description: Deleting a parameter from the command definition does not remove the
     defined space for that parameter. Thus unless you redefine a new parameter, there
     will be a "hole" in the packet where the data is not accessible. You can
     use SELECT_COMMAND and then PARAMETER to define a new parameter.
-  example: |
-    SELECT_COMMAND INST COLLECT
-      DELETE_PARAMETER DURATION
   since: 4.4.1
   parameters:
     - name: Parameter
       required: true
       description: Name of the parameter to delete
       values: .+
+  example: |
+    SELECT_COMMAND INST COLLECT
+      DELETE_PARAMETER DURATION
 HIDDEN:
   summary: Hides this command from all OpenC3 tools such as Command Sender and Handbook Creator
   description: Hidden commands do not appear in the Script Runner popup helper when writing scripts.
@@ -139,7 +144,6 @@ META:
   description: Meta data is user specific data that can be used by custom tools
     for various purposes. One example is to store additional information needed
     to generate source code header files.
-  example: META FSW_TYPE "struct command"
   parameters:
     - name: Meta Name
       required: true
@@ -149,6 +153,7 @@ META:
       required: false
       description: One or more values to be stored for this Meta Name
       values: .*
+  example: META FSW_TYPE "struct command"
 HAZARDOUS:
   summary: Designates the current command as hazardous
   description: Sending a hazardous command causes a dialog asking for confirmation

data/data/config/graph_settings.yaml

@@ -6,6 +6,7 @@ ITEM:
     <%= MetaConfigParser.load('_graph_params.yaml').to_meta_config_yaml(4) %>
 STARTTIME:
   summary: Start the graph history at the designated Time
+  since: 5.5.1
   parameters:
     - name: Start Time
       required: true
@@ -13,6 +14,7 @@ STARTTIME:
       values: .+
 HISTORY:
   summary: Display an initial history of data
+  since: 5.5.1
   parameters:
     - name: Value
       required: true

data/data/config/interface_modifiers.yaml

@@ -8,6 +8,7 @@ MAP_TARGET:
       values: .+
 MAP_CMD_TARGET:
   summary: Maps a target name to an interface for commands only
+  since: 5.2.0
   parameters:
     - name: Target Name
       required: true
@@ -15,6 +16,7 @@ MAP_CMD_TARGET:
       values: .+
 MAP_TLM_TARGET:
   summary: Maps a target name to an interface for telemetry only
+  since: 5.2.0
   parameters:
     - name: Target Name
       required: true
@@ -82,8 +84,7 @@ OPTION:
         interfaces. The SerialInterface defines FLOW_CONTROL which can be NONE (default) or RTSCTS
         and DATA_BITS which changes the data bits of the serial interface.
         The TcpipServerInterface defines LISTEN_ADDRESS which is the IP address to accept
-        connections on (default 0.0.0.0) and AUTO_SYSTEM_META which will automatically send
-        SYSTEM META when the interface connects (default false).
+        connections on (default 0.0.0.0).
       values: .*
     - name: Parameters
       required: false
@@ -92,6 +93,7 @@ OPTION:
 SECRET:
   summary: Define a secret needed by this interface
   description: Defines a secret for this interface and optionally assigns its value to an option
+  since: 5.3.0
   parameters:
     - name: Type
       required: true

data/data/config/item_modifiers.yaml

@@ -224,10 +224,10 @@ LIMITS_RESPONSE:
 KEY:
   summary: Defines the key used to access this raw value in the packet.
   description: Keys are often JsonPath or XPath strings
-  example: KEY $.book.title
+  since: 5.0.10
   parameters:
     - name: Key string
       required: true
       description: The key to access this item
       values: .+
-  since: 5.0.10
+  example: KEY $.book.title

data/data/config/microservice.yaml

@@ -35,6 +35,7 @@ MICROSERVICE:
     PORT:
       summary: Open port for the microservice
       description: Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support
+      since: 5.0.10
       parameters:
         - name: Number
           required: true
@@ -91,6 +92,7 @@ MICROSERVICE:
     SECRET:
       summary: Define a secret needed by this microservice
       description: Defines a secret for this microservice
+      since: 5.3.0
       parameters:
         - name: Type
           required: true
@@ -113,6 +115,7 @@ MICROSERVICE:
     ROUTE_PREFIX:
       summary: Prefix of route
       description: Prefix of route to the microservice to expose externally with Traefik
+      since: 5.5.0
       parameters:
         - name: Route Prefix
           required: true

data/data/config/plugins.yaml

@@ -18,6 +18,7 @@ NEEDS_DEPENDENCIES:
   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.
+  since: 5.5.0
 INTERFACE:
   modifiers:
     <%= MetaConfigParser.load('interface_modifiers.yaml').to_meta_config_yaml(4) %>

data/data/config/screen.yaml

@@ -27,6 +27,7 @@ END:
     to indicate where the VERTICALBOX ends.
 STALE_TIME:
   summary: Values are marked stale if the packet time is more than Stale Time seconds in the past
+  since: 5.1.0
   parameters:
     - name: value
       required: true

data/data/config/target.yaml

@@ -16,6 +16,7 @@ TARGET:
   modifiers:
     CMD_BUFFER_DEPTH:
       summary: Number of commands to buffer to ensure logged in order
+      since: 5.2.0
       parameters:
         - name: Buffer Depth
           required: true
@@ -65,6 +66,7 @@ TARGET:
           values: \d+
     TLM_BUFFER_DEPTH:
       summary: Number of telemetry packets to buffer to ensure logged in order
+      since: 5.2.0
       parameters:
         - name: Buffer Depth
           required: true
@@ -160,6 +162,7 @@ TARGET:
         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.
+      since: 5.2.0
       parameters:
         - name: Type
           required: true
@@ -168,6 +171,7 @@ TARGET:
           values: .*
     PACKET:
       summary: Packet Name to allocate to the current TARGET_MICROSERVICE.
+      since: 5.2.0
       parameters:
         - name: Packet Name
           required: true

data/data/config/telemetry.yaml

@@ -5,7 +5,6 @@ TELEMETRY:
   modifiers:
     <%= MetaConfigParser.load('telemetry_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Defines a new telemetry packet
-  example: TELEMETRY SYSTEM LIMITS_CHANGE BIG_ENDIAN "OpenC3 limits change"
   parameters:
     - name: Target
       required: true
@@ -25,6 +24,7 @@ TELEMETRY:
       required: false
       description: Description of this telemetry packet which must be enclosed with quotes
       values: '[''"].*[''"]'
+  example: TELEMETRY INST HEALTH_STATUS BIG_ENDIAN "Instrument health and status"
 SELECT_TELEMETRY:
   # prettier-ignore
   modifiers:
@@ -32,17 +32,22 @@ SELECT_TELEMETRY:
   summary: Selects an existing telemetry packet for editing
   description:
     Typically used in a separate configuration file from where the original
-    telemetry is defined to override or add to the existing telemetry definition
-  example: SELECT_TELEMETRY SYSTEM LIMITS_CHANGE
+    telemetry is defined to override or add to the existing telemetry definition.
+    Must be used in conjunction with SELECT_ITEM to change an individual item.
   parameters:
     - name: Target Name
       required: true
       description: Name of the target this telemetry packet is associated with
       values: .+
-    - name: Command Name
+    - name: Packet Name
       required: true
       description: Name of the telemetry packet to select
       values: .+
+  example: |
+    SELECT_TELEMETRY INST HEALTH_STATUS
+      SELECT_ITEM TEMP1
+        # Define limits for this item, overrides or replaces any existing
+        LIMITS DEFAULT 3 ENABLED -90.0 -80.0 80.0 90.0 -20.0 20.0
 LIMITS_GROUP:
   summary: Defines a group of related limits Items
   description:
@@ -63,15 +68,7 @@ LIMITS_GROUP_ITEM:
   summary: Adds the specified telemetry item to the last defined LIMITS_GROUP
   description:
     Limits group information is typically kept in a separate configuration
-    file in the config/TARGET/cmd_tlm folder named limits_groups.txt. If you want to
-    configure multiple target items in a particular group you should put this information
-    in the config/SYSTEM/cmd_tlm/limits_groups.txt file. The SYSTEM target is processed
-    last and contains information that crosses target boundaries.
-  example: |
-    LIMITS_GROUP SUBSYSTEM
-      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP1
-      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP2
-      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP3
+    file in the config/TARGET/cmd_tlm folder named limits_groups.txt.
   parameters:
     - name: Target Name
       required: true
@@ -85,3 +82,8 @@ LIMITS_GROUP_ITEM:
       required: true
       description: Name of the telemetry item to add to the group
       values: .+
+  example: |
+    LIMITS_GROUP SUBSYSTEM
+      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP1
+      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP2
+      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP3

data/data/config/telemetry_modifiers.yaml

@@ -91,9 +91,14 @@ SELECT_ITEM:
   modifiers:
     <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Selects an existing telemetry item for editing
+  description: Must be used in conjunction with SELECT_TELEMETRY to first select
+    the packet. Typically used to override generated values or make specific changes
+    to telemetry that only affect a particular instance of a target used multiple times.
   example: |
-    SELECT_TELEMETRY SYSTEM LIMITS_CHANGE
-      SELECT_ITEM ITEM
+    SELECT_TELEMETRY INST HEALTH_STATUS
+      SELECT_ITEM TEMP1
+        # Define limits for this item, overrides or replaces any existing
+        LIMITS DEFAULT 3 ENABLED -90.0 -80.0 80.0 90.0 -20.0 20.0
   parameters:
     - name: Item
       required: true
@@ -106,8 +111,8 @@ DELETE_ITEM:
     will be a "hole" in the packet where the data is not accessible. You can
     use SELECT_TELEMETRY and then ITEM to define a new item.
   example: |
-    SELECT_TELEMETRY SYSTEM LIMITS_CHANGE
-      DELETE_ITEM ITEM
+    SELECT_TELEMETRY INST HEALTH_STATUS
+      DELETE_ITEM TEMP4
   since: 4.4.1
   parameters:
     - name: Item

data/data/config/tool.yaml

@@ -64,6 +64,7 @@ TOOL:
     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.
+      since: 5.0.8
       parameters:
         - name: Position
           required: true

data/data/config/widgets.yaml

@@ -168,6 +168,7 @@ Decoration Widgets:
         LABEL "Note: This is only a warning"
     HORIZONTALLINE:
       summary: Displays a horizontal line on the screen that can be used as a separator
+      since: 5.5.1
       example: |
         LABEL Over
         HORIZONTALLINE

data/lib/openc3/api/settings_api.rb

@@ -20,7 +20,7 @@
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
-require 'openc3/models/settings_model'
+require 'openc3/models/setting_model'
 
 module OpenC3
   module Api
@@ -35,41 +35,35 @@ module OpenC3
 
     def list_settings(scope: $openc3_scope, token: $openc3_token)
       authorize(permission: 'system', scope: scope, token: token)
-      SettingsModel.names(scope: scope)
+      SettingModel.names(scope: scope)
     end
 
     def get_all_settings(scope: $openc3_scope, token: $openc3_token)
       authorize(permission: 'system', scope: scope, token: token)
-      SettingsModel.all(scope: scope)
+      SettingModel.all(scope: scope)
     end
 
     def get_setting(name, scope: $openc3_scope, token: $openc3_token)
       authorize(permission: 'system', scope: scope, token: token)
-      setting = SettingsModel.get(name: name, scope: scope)
+      setting = SettingModel.get(name: name, scope: scope)
       if setting
-        return setting["data"]
+        setting['data']
       else
-        return nil
+        nil
       end
     end
 
-    def get_settings(*args, scope: $openc3_scope, token: $openc3_token)
+    def get_settings(*settings, scope: $openc3_scope, token: $openc3_token)
       authorize(permission: 'system', scope: scope, token: token)
-      ret = []
-      args.each do |name|
-        setting = SettingsModel.get(name: name, scope: scope)
-        if setting
-          ret << setting["data"]
-        else
-          ret << nil
-        end
-      end
-      return ret
+      result = []
+      settings.each { |name| result << get_setting(name, scope: scope, token: token) }
+      result
     end
 
     def save_setting(name, data, scope: $openc3_scope, token: $openc3_token)
       authorize(permission: 'admin', scope: scope, token: token)
-      SettingsModel.set({ name: name,  data: data }, scope: scope)
+      SettingModel.set({ name: name, data: data }, scope: scope)
+      LocalMode.save_setting(scope, name, data)
     end
   end
 end

data/lib/openc3/models/scope_model.rb

@@ -24,7 +24,7 @@ require 'openc3/version'
 require 'openc3/models/model'
 require 'openc3/models/plugin_model'
 require 'openc3/models/microservice_model'
-require 'openc3/models/settings_model'
+require 'openc3/models/setting_model'
 
 module OpenC3
   class ScopeModel < Model
@@ -261,8 +261,10 @@ module OpenC3
     end
 
     def seed_database
-      setting = SettingsModel.get(name: 'source_url')
-      SettingsModel.set({ name: 'source_url', data: 'https://github.com/OpenC3/cosmos' }, scope: @scope) unless setting
+      setting = SettingModel.get(name: 'source_url')
+      SettingModel.set({ name: 'source_url', data: 'https://github.com/OpenC3/cosmos' }, scope: @scope) unless setting
+      setting = SettingModel.get(name: 'rubygems_url')
+      SettingModel.set({ name: 'rubygems_url', data: 'https://rubygems.org' }, scope: @scope) unless setting
     end
   end
 end

data/lib/openc3/models/{settings_model.rb → setting_model.rb}

@@ -23,7 +23,7 @@
 require 'openc3/models/model'
 
 module OpenC3
-  class SettingsModel < Model
+  class SettingModel < Model
     PRIMARY_KEY = 'openc3__settings'
 
     # NOTE: The following three class methods are used by the ModelController

data/lib/openc3/models/tool_config_model.rb

@@ -17,9 +17,11 @@
 # 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/utilities/local_mode'
+
 module OpenC3
   class ToolConfigModel
     def self.list_configs(tool, scope: $openc3_scope)
@@ -30,12 +32,14 @@ module OpenC3
       Store.hget("#{scope}__config__#{tool}", name)
     end
 
-    def self.save_config(tool, name, data, scope: $openc3_scope)
+    def self.save_config(tool, name, data, scope: $openc3_scope, local_mode: true)
       Store.hset("#{scope}__config__#{tool}", name, data)
+      LocalMode.save_tool_config(scope, tool, name, data) if local_mode
     end
 
     def self.delete_config(tool, name, scope: $openc3_scope)
       Store.hdel("#{scope}__config__#{tool}", name)
+      LocalMode.delete_tool_config(scope, tool, name)
     end
   end
 end

data/lib/openc3/script/api_shared.rb

@@ -501,6 +501,10 @@ module OpenC3
       return start(procedure_name)
     end
     def require_utility(procedure_name)
+      # Ensure require_utility works like require where you don't need the .rb extension
+      if File.extname(procedure_name) != '.rb'
+        procedure_name += '.rb'
+      end
       @require_utility_cache ||= {}
       if @require_utility_cache[procedure_name]
         return false

data/lib/openc3/utilities/authentication.rb

@@ -144,7 +144,7 @@ module OpenC3
 
     # Make the post request to keycloak
     def _make_request(headers, data)
-      uri = URI("#{@url}/auth/realms/openc3/protocol/openid-connect/token")
+      uri = URI("#{@url}/realms/openc3/protocol/openid-connect/token")
       @log[0] = "request uri: #{uri.to_s} header: #{headers.to_s} body: #{data.to_s}"
       STDOUT.puts @log[0] if JsonDRb.debug?
       saved_verbose = $VERBOSE; $VERBOSE = nil

data/lib/openc3/utilities/aws_bucket.rb

@@ -129,7 +129,7 @@ module OpenC3
     end
 
     # Lists the files under a specified path
-    def list_files(bucket:, path:, only_directories: false, include_head: false)
+    def list_files(bucket:, path:, only_directories: false, metadata: false)
       # Trailing slash is important in AWS S3 when listing files
       # See https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Types/ListObjectsV2Output.html#common_prefixes-instance_method
       if path[-1] != '/'
@@ -163,8 +163,8 @@ module OpenC3
             item['name'] = aws_item.key.split('/')[-1]
             item['modified'] = aws_item.last_modified
             item['size'] = aws_item.size
-            if include_head
-              item['head'] = head_object(bucket: bucket, key: aws_item.key)
+            if metadata
+              item['metadata'] = head_object(bucket: bucket, key: aws_item.key)
             end
             files << item
           end
@@ -180,12 +180,12 @@ module OpenC3
 
     # get metadata for a specific object
     def head_object(bucket:, key:)
-      head = @client.head_object({
+      @client.head_object({
         bucket: bucket,
         key: key
       })
-    rescue Aws::S3::Errors::NotFound => error
-      raise NotFound, "Object: #{bucket}/#{key}"
+    rescue Aws::S3::Errors::NotFound
+      raise NotFound, "Object '#{bucket}/#{key}' does not exist."
     end
 
     # put_object fires off the request to store but does not confirm

data/lib/openc3/utilities/bucket.rb

@@ -61,7 +61,7 @@ module OpenC3
       raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
     end
 
-    def list_files(bucket:, path:, only_directories: false)
+    def list_files(bucket:, path:, only_directories: false, metadata: false)
       raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
     end
 

data/lib/openc3/utilities/local_mode.rb

@@ -58,7 +58,10 @@ module OpenC3
           puts "Local init found scope: #{scope_dir}"
           Dir.each_child("#{OPENC3_LOCAL_MODE_PATH}/#{scope_dir}") do |plugin_dir|
             full_folder_path = "#{OPENC3_LOCAL_MODE_PATH}/#{scope_dir}/#{plugin_dir}"
-            next if plugin_dir == "targets_modified" or not File.directory?(full_folder_path)
+            if plugin_dir == "targets_modified" || plugin_dir == "tool_config" ||
+               plugin_dir == "settings" || !File.directory?(full_folder_path)
+              next
+            end
             puts "Local init found plugin_dir: #{full_folder_path}"
             gems, plugin_instance = scan_plugin_dir(full_folder_path)
 
@@ -79,6 +82,8 @@ module OpenC3
           end
         end
         sync_targets_modified()
+        sync_tool_config()
+        sync_settings()
         puts "Local init complete"
       else
         puts "Local init canceled: Local mode not enabled or #{OPENC3_LOCAL_MODE_PATH} does not exist"
@@ -322,12 +327,10 @@ module OpenC3
     end
 
     def self.sync_targets_modified
-      if ENV['OPENC3_LOCAL_MODE'] and Dir.exist?(OPENC3_LOCAL_MODE_PATH)
-        bucket = Bucket.getClient()
-        scopes = ScopeModel.names()
-        scopes.each do |scope|
-          sync_with_bucket(bucket, scope: scope)
-        end
+      bucket = Bucket.getClient()
+      scopes = ScopeModel.names()
+      scopes.each do |scope|
+        sync_with_bucket(bucket, scope: scope)
       end
     end
 
@@ -417,6 +420,58 @@ module OpenC3
       return files.sort
     end
 
+    def self.sync_tool_config()
+      scopes = ScopeModel.names()
+      scopes.each do |scope|
+        Dir["#{OPENC3_LOCAL_MODE_PATH}/#{scope}/tool_config/**/*.json"].each do |config|
+          parts = config.split('/')
+          puts "Syncing tool_config #{parts[-2]} #{File.basename(config)}"
+          data = File.read(config)
+          begin
+            # Parse just to ensure we have valid JSON
+            JSON.parse(data, :allow_nan => true, :create_additions => true)
+            # Only save if the parse was successful
+            ToolConfigModel.save_config(parts[-2], File.basename(config), data, scope: scope, local_mode: false)
+          rescue JSON::ParserError => error
+            puts "Unable to initialize tool config due to #{error.message}"
+          end
+        end
+      end
+    end
+
+    def self.save_tool_config(scope, tool, name, data)
+      json = JSON.parse(data, :allow_nan => true, :create_additions => true)
+      config_path = "#{OPENC3_LOCAL_MODE_PATH}/#{scope}/tool_config/#{tool}/#{name}.json"
+      FileUtils.mkdir_p(File.dirname(config_path))
+      File.open(config_path, 'w') do |file|
+        file.write(JSON.pretty_generate(json, :allow_nan => true))
+      end
+    end
+
+    def self.delete_tool_config(scope, tool, name)
+      FileUtils.rm_f("#{OPENC3_LOCAL_MODE_PATH}/#{scope}/tool_config/#{tool}/#{name}.json")
+    end
+
+    def self.sync_settings()
+      scopes = ScopeModel.names()
+      scopes.each do |scope|
+        Dir["#{OPENC3_LOCAL_MODE_PATH}/#{scope}/settings/*.json"].each do |config|
+          name = File.basename(config, ".json")
+          puts "Syncing setting #{name}"
+          # Anything can be stored in settings so read and set directly
+          data = File.read(config)
+          SettingModel.set({ name: name, data: data }, scope: scope)
+        end
+      end
+    end
+
+    def self.save_setting(scope, name, data)
+      config_path = "#{OPENC3_LOCAL_MODE_PATH}/#{scope}/settings/#{name}.json"
+      FileUtils.mkdir_p(File.dirname(config_path))
+      # Anything can be stored as a setting so write it out directly
+      File.write(config_path, data)
+    end
+
     # Helper methods
 
     def self.sync_remote_to_local(bucket, key)

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.5.1'
+OPENC3_VERSION = '5.5.2-beta0'
 module OpenC3
   module Version
     MAJOR = '5'
     MINOR = '5'
-    PATCH = '1'
-    OTHER = ''
-    BUILD = 'a1e84e1850e06f2c01726e03372e2872137b3852'
+    PATCH = '2'
+    OTHER = 'pre.beta0'
+    BUILD = '417d0e4ab762ecc0ada17fd8e230b394721f9cd4'
   end
-  VERSION = '5.5.1'
-  GEM_VERSION = '5.5.1'
+  VERSION = '5.5.2-beta0'
+  GEM_VERSION = '5.5.2.pre.beta0'
 end

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

@@ -1,5 +1,5 @@
 # This class can be used in your scripts like so:
-#   require '<%= target_lib_filename %>'
+#   require_utility '<%= target_class.upcase %>/lib/<%= target_lib_filename %>'
 #   <%= target_object %> = <%= target_class %>.new
 #   <%= target_object %>.utility
 # For more information see the OpenC3 scripting guide

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 5.5.1
+  version: 5.5.2.pre.beta0
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-26 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -896,7 +896,7 @@ files:
 - lib/openc3/models/router_status_model.rb
 - lib/openc3/models/scope_model.rb
 - lib/openc3/models/secret_model.rb
-- lib/openc3/models/settings_model.rb
+- lib/openc3/models/setting_model.rb
 - lib/openc3/models/sorted_model.rb
 - lib/openc3/models/stash_model.rb
 - lib/openc3/models/target_model.rb
@@ -1048,9 +1048,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.14
 signing_key: