openc3 5.11.3 → 5.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a810e5031ff4cc16e2e2f171700189e4ba5c6ca041793033eb56129d087016b
-  data.tar.gz: 61c2caa4d9a234dbffa4cc3ec5192df934b55f9fc3de88b013313ff71208bbfc
+  metadata.gz: 70d4819352855e3fdb8b4c4d39331968e3e60af59beb0555743b42669d5b4b4a
+  data.tar.gz: c906a678c11f68b8751000875fe5cfdfdbbe98880e182edc572791246d625491
 SHA512:
-  metadata.gz: dab9c2811db9e91bd078b618da8b788c7ea2ae353cd7941fd9afccff77649e8dc5703575e16aa3cd3cd04d6a499b1fd97dd127eae9b2b4cc52c6ae853ad4ebfb
-  data.tar.gz: 402ab73b30182f61554f085465872a84d47f67238d630012b20f3d385f40d6bb652f6aec640acd5df24d7fe5c349475d07d80a6fc626fb3ac7ea6dd27d32842d
+  metadata.gz: 2adcf16c91e84be3d1ef2b412ffc57eda1e7ed87e2d808519f9502c2cd937dcc06e766fad4f74b346daa0122a08745442decdbeb9185990206d7098c0331bf51
+  data.tar.gz: 413edafbcaebcb868c68f1e0ddfeadc4ef32e4950be652a2520858060efd2274d28e9f15f85d944ae48058c1c52cc72ad768f097f5a7830217ae71345869044d

data/Gemfile

@@ -7,11 +7,11 @@ gem 'ruby-termios', '>= 0.9' if RbConfig::CONFIG['target_os'] !~ /mswin|mingw|cy
 gemspec :name => 'openc3'
 
 # Include the rails gems for the convenience of custom microservice plugins
-gem 'rails', '~> 7.0.0'
+gem 'rails', '~> 7.1.0'
 gem 'bootsnap', '>= 1.9.3', require: false
 gem 'rack-cors', '~> 2.0'
 gem 'tzinfo-data'
 gem 'rspec-rails', '~> 6.0'
 gem 'simplecov', '~> 0.20'
 gem 'simplecov-cobertura', '~> 2.1'
-gem 'mock_redis', '0.36'
+gem 'mock_redis', '0.40'

data/bin/openc3cli

@@ -42,9 +42,8 @@ require 'find'
 require 'json'
 require 'redis'
 require 'erb'
-require 'pp'
-require "irb"
-require "irb/completion"
+require 'irb'
+require 'irb/completion'
 
 $redis_url = "redis://#{ENV['OPENC3_REDIS_HOSTNAME']}:#{ENV['OPENC3_REDIS_PORT']}"
 
@@ -68,11 +67,13 @@ def print_usage
   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 TYPE OPTIONS         # Generate various COSMOS entities"
+  puts "    OPTIONS includes either --ruby or --python to specify the language in the generated code"
   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"
   puts "  cli bridgesetup CONFIG_FILENAME   # Create a default config file"
-  puts "  cli geminstall GEMFILENAME SCOPE  # Install loaded gem to /gems"
+  puts "  cli pkginstall PKGFILENAME SCOPE  # Install loaded package (Ruby gem or python package)"
+  puts "  cli pkguninstall PKGFILENAME SCOPE  # Uninstall loaded package (Ruby gem or python package)"
   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 COSMOS. Run with --help for more info."
@@ -507,30 +508,43 @@ def unload_plugin(plugin_name, scope:)
   end
 end
 
-def cli_gem_install(gem_filename, scope:)
+def cli_pkg_install(filename, scope:)
   scope ||= 'DEFAULT'
   check_environment()
   if $openc3_in_cluster
-    OpenC3::GemModel.install(gem_filename, scope: scope)
+    if File.extname(filename) == '.gem'
+      OpenC3::GemModel.install(filename, scope: scope)
+    else
+      OpenC3::PythonPackageModel.install(filename, scope: scope)
+    end
   else
     # Outside Cluster
     require 'openc3/script'
-    process_name = gem_install(gem_filename, scope: scope)
+    process_name = package_install(filename, scope: scope)
     print "Installing..."
     wait_process_complete(process_name)
   end
 end
 
-def cli_gem_uninstall(gem_filename, scope:)
+def cli_pkg_uninstall(filename, scope:)
   scope ||= 'DEFAULT'
   check_environment()
   if $openc3_in_cluster
-    OpenC3::GemModel.destroy(gem_filename)
+    if File.extname(filename) == '.rb'
+      OpenC3::GemModel.destroy(filename)
+    else
+      OpenC3::PythonPackageModel.destroy(filename, scope: scope)
+    end
   else
     # Outside Cluster
     require 'openc3/script'
-    gem_uninstall(gem_filename, scope: scope)
-    puts "Success!"
+    process_name = package_uninstall(filename, scope: scope)
+    if File.extname(filename) == '.rb'
+      puts "Uninstalled"
+    else
+      print "Uninstalling..."
+      wait_process_complete(process_name)
+    end
   end
 end
 
@@ -637,11 +651,11 @@ if not ARGV[0].nil? # argument(s) given
   when 'unload'
     unload_plugin(ARGV[1], scope: ARGV[2])
 
-  when 'geminstall'
-    cli_gem_install(ARGV[1], scope: ARGV[2])
+  when 'pkginstall', 'geminstall'
+    cli_pkg_install(ARGV[1], scope: ARGV[2])
 
-  when 'gemuninstall'
-    cli_gem_uninstall(ARGV[1], scope: ARGV[2])
+  when 'pkguninstall', 'gemuninstall'
+    cli_pkg_uninstall(ARGV[1], scope: ARGV[2])
 
   when 'generate'
     OpenC3::CliGenerator.generate(ARGV[1..-1])

data/data/config/_id_items.yaml

@@ -1,7 +1,8 @@
 ---
 - name: Bit Size
   required: true
-  description: Bit size of this telemetry item. Zero or Negative values may be used
+  description:
+    Bit size of this telemetry item. 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'.
@@ -17,9 +18,10 @@
 - name: Description
   required: false
   description: Description for this telemetry item which must be enclosed with quotes
-  values: "['\"].*['\"]"
+  values: '[''"].*[''"]'
 - name: Endianness
   required: false
-  description: Indicates if the item is to be interpreted in Big Endian or Little Endian format.
-    See guide on <a href="https://openc3.com/docs/v5/little-endian-bitfields">Little Endian Bitfields</a>.
+  description:
+    Indicates if the item is to be interpreted in Big Endian or Little Endian format.
+    See guide on [Little Endian Bitfields](../guides/little-endian-bitfields.md).
   values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>

data/data/config/_id_params.yaml

@@ -22,17 +22,19 @@
           values: .*
         - name: ID Value
           required: true
-          description: Identification value for this parameter. The binary data must
+          description:
+            Identification value for this parameter. The binary data must
             match this value for the buffer to be identified as this packet.
           values: .*
         - name: Description
           required: false
           description: Description for this parameter which must be enclosed with quotes
-          values: "['\"].*['\"]"
+          values: '[''"].*[''"]'
         - name: Endianness
           required: false
-          description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format.
-            See guide on <a href="https://openc3.com/docs/v5/little-endian-bitfields">Little Endian Bitfields</a>.
+          description:
+            Indicates if the data in this command is to be sent in Big Endian or Little Endian format.
+            See guide on [Little Endian Bitfields](../guides/little-endian-bitfields.md).
           values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>
     UINT:
       parameters: *params
@@ -44,13 +46,14 @@
       parameters: &sparams
         - name: Default Value
           required: true
-          description: Default value for this parameter. You must provide a default
+          description:
+            Default value for this parameter. You must provide a default
             but if you mark the parameter REQUIRED then scripts will be forced to specify a value.
           values: .*
         - name: Description
           required: false
           description: Description for this parameter which must be enclosed with quotes
-          values: "['\"].*['\"]"
+          values: '[''"].*[''"]'
         - name: Endianness
           required: false
           description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format

data/data/config/_items.yaml

@@ -1,7 +1,8 @@
 ---
 - name: Bit Size
   required: true
-  description: Bit size of this telemetry item. Zero or Negative values may be used
+  description:
+    Bit size of this telemetry item. 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'.
@@ -13,9 +14,10 @@
 - name: Description
   required: false
   description: Description for this telemetry item which must be enclosed with quotes
-  values: "['\"].*['\"]"
+  values: '[''"].*[''"]'
 - name: Endianness
   required: false
-  description: Indicates if the item is to be interpreted in Big Endian or Little Endian format.
-    See guide on <a href="https://openc3.com/docs/v5/little-endian-bitfields">Little Endian Bitfields</a>.
+  description:
+    Indicates if the item is to be interpreted in Big Endian or Little Endian format.
+    See guide on [Little Endian Bitfields](../guides/little-endian-bitfields.md).
   values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>

data/data/config/_params.yaml

@@ -32,8 +32,9 @@
           values: '[''"].*[''"]'
         - name: Endianness
           required: false
-          description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format.
-            See guide on <a href="https://openc3.com/docs/v5/little-endian-bitfields">Little Endian Bitfields</a>.
+          description:
+            Indicates if the data in this command is to be sent in Big Endian or Little Endian format.
+            See guide on [Little Endian Bitfields](../guides/little-endian-bitfields.md).
           values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>
     UINT:
       parameters: *params

data/data/config/graph_settings.yaml

@@ -18,7 +18,7 @@ HISTORY:
   parameters:
     - name: Value
       required: true
-      description: Value{d,h,m,s}. For example 1d, 2h, 30m, 15s
+      description: Value(d,h,m,s). For example 1d, 2h, 30m, 15s
       values: .+
 SECONDSGRAPHED:
   summary: Display the specified number of seconds in the graph

data/data/config/interface_modifiers.yaml

@@ -93,7 +93,7 @@ PROTOCOL:
     Protocols can be either READ, WRITE, or READ_WRITE. READ protocols act on the data
     received by the interface while write acts on the data before it is sent out. READ_WRITE applies
     the protocol to both reading and writing.<br/><br/>
-    For information on creating your own custom protocol please see <a href="https://openc3.com/docs/v5/protocols">https://openc3.com/docs/v5/protocols</a>
+    For information on creating your own custom protocol please see [Protocols](../configuration/protocols.md)
   since: 4.0.0
   parameters:
     - name: Type

data/data/config/item_modifiers.yaml

@@ -32,8 +32,7 @@ STATE:
 READ_CONVERSION:
   summary: Applies a conversion to the current telemetry item
   description: Conversions are implemented in a custom Ruby file which should be
-    located in the target's lib folder and required by the target's target.txt
-    file (see REQUIRE). The class must require 'openc3/conversions/conversion'
+    located in the target's lib folder. The class must require 'openc3/conversions/conversion'
     and inherit from Conversion. It must implement the initialize method if it
     takes extra parameters and must always implement the call method. The conversion
     factor is applied to the raw value in the telemetry packet before it is displayed

data/data/config/microservice.yaml

@@ -4,7 +4,7 @@ MICROSERVICE:
   description: Defines a microservice that the plugin adds to the OpenC3 system. Microservices are background software processes that perform persistent processing.
   parameters:
     - name: Microservice Folder Name
-      description: The exact name of the microservice folder in the plugin. ie. microservices/<Microservice Folder Name>
+      description: The exact name of the microservice folder in the plugin. ie. microservices/MicroserviceFolderName
       required: true
       values: .+
     - name: Microservice Name
@@ -148,3 +148,12 @@ MICROSERVICE:
       example: |
         MICROSERVICE CFDP CFDP
           ROUTE_PREFIX /cfdp
+    DISABLE_ERB:
+      summary: Disable ERB processing
+      description: Disable ERB processing for the entire microservice or a set of regular expressions over its filenames
+      since: 5.12.0
+      parameters:
+        - name: Regex
+          required: false
+          description: Regex to match against filenames. If match, then no ERB processing
+          values: .+

data/data/config/parameter_modifiers.yaml

@@ -63,23 +63,22 @@ STATE:
       values: "['\"].*['\"]"
 WRITE_CONVERSION:
   summary: Applies a conversion when writing the current command parameter
-  description: Conversions are implemented in a custom Ruby file which should be
-    located in the target's lib folder and required by the target's target.txt
-    file (see REQUIRE). The class must require 'openc3/conversions/conversion'
+  description: |
+    Conversions are implemented in a custom Ruby file which should be
+    located in the target's lib folder. The class must require 'openc3/conversions/conversion'
     and inherit from Conversion. It must implement the initialize method if it
     takes extra parameters and must always implement the call method. The conversion
     factor is applied to the value entered by the user before it is written into
     the binary command packet and sent.
 
-    <div class="note info">
-    <h5>Multiple write conversions on command parameters</h5>
-    <p>When a command is built, each item gets written (and write conversions are run)
+    :::info Multiple write conversions on command parameters
+    When a command is built, each item gets written (and write conversions are run)
     to set the default value. Then items are written (again write conversions are run)
     with user provided values. Thus write conversions can be run twice. Also there are
     no guarantees which parameters have already been written. The packet itself has a
     given_values() method which can be used to retrieve a hash of the user provided
-    values to the command. That can be used to check parameter values passed in.</p>
-    </div>
+    values to the command. That can be used to check parameter values passed in.
+    :::
   example: |
     WRITE_CONVERSION the_great_conversion.rb 1000
 
@@ -154,7 +153,8 @@ SEG_POLY_WRITE_CONVERSION:
       values: .*
 GENERIC_WRITE_CONVERSION_START:
   summary: Start a generic write conversion
-  description: Adds a generic conversion function to the current command parameter.
+  description: |
+    Adds a generic conversion function to the current command parameter.
     This conversion factor is applied to the value entered by the user before it
     is written into the binary command packet and sent. The conversion is specified
     as ruby code that receives two implied parameters. 'value' which is the raw
@@ -164,15 +164,14 @@ GENERIC_WRITE_CONVERSION_START:
     value. The GENERIC_WRITE_CONVERSION_END keyword specifies that all lines of
     ruby code for the conversion have been given.
 
-    <div class="note info">
-    <h5>Multiple write conversions on command parameters</h5>
-    <p>When a command is built, each item gets written (and write conversions are run)
+    :::info Multiple write conversions on command parameters
+    When a command is built, each item gets written (and write conversions are run)
     to set the default value. Then items are written (again write conversions are run)
     with user provided values. Thus write conversions can be run twice. Also there are
     no guarantees which parameters have already been written. The packet itself has a
     given_values() method which can be used to retrieve a hash of the user provided
-    values to the command. That can be used to check parameter values passed in.</p>
-    </div>
+    values to the command. That can be used to check parameter values passed in.
+    :::
   warning: Generic conversions are not a good long term solution. Consider creating
     a conversion class and using WRITE_CONVERSION instead. WRITE_CONVERSION is easier
     to debug and higher performance.

data/data/config/plugins.yaml

@@ -40,7 +40,7 @@ INTERFACE:
       description: Ruby file to use when instantiating the interface.
       values:
         <%= MetaConfigParser.load('_interfaces.yaml').to_meta_config_yaml(8) %>
-      documentation: Additional parameters are required. Please see the [Interfaces](/docs/v5/interfaces)
+      documentation: Additional parameters are required. Please see the [Interfaces](../configuration/interfaces.md)
         documentation for more details.
 ROUTER:
   modifiers:
@@ -60,7 +60,7 @@ ROUTER:
       description: Ruby file to use when instantiating the interface.
       values:
         <%= MetaConfigParser.load('_interfaces.yaml').to_meta_config_yaml(8) %>
-      documentation: Additional parameters are required. Please see the [Interfaces](/docs/v5/interfaces)
+      documentation: Additional parameters are required. Please see the [Interfaces](../configuration/interfaces.md)
         documentation for more details.
 <%= MetaConfigParser.load('target.yaml').to_meta_config_yaml() %>
 <%= MetaConfigParser.load('microservice.yaml').to_meta_config_yaml() %>
@@ -71,7 +71,17 @@ 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](/docs/v5/custom-widgets)
+      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)
         guide for more details.
       required: true
       values: .+
+  modifiers:
+    DISABLE_ERB:
+      summary: Disable ERB processing
+      description: Disable ERB processing for the entire widget or a set of regular expressions over its filenames
+      since: 5.12.0
+      parameters:
+        - name: Regex
+          required: false
+          description: Regex to match against filenames. If match, then no ERB processing
+          values: .+

data/data/config/screen.yaml

@@ -53,7 +53,7 @@ GLOBAL_SETTING:
       description: See SETTING for details.
       values: .*
   example: |
-    GLOBAL_SETTING LABELVALUELIMITSBAR COLORBLIND TRUE
+    GLOBAL_SETTING LABELVALUELIMITSBAR TEXTCOLOR BLACK
 GLOBAL_SUBSETTING:
   summary: Applies a widget subsetting to all widgets of a certain type
   description: Subsettings are only valid for widgets that are
@@ -81,7 +81,6 @@ GLOBAL_SUBSETTING:
       description: See SETTING for details.
       values: .*
   example: |
-    GLOBAL_SUBSETTING LABELVALUELIMITSBAR 1 COLORBLIND TRUE
     # Set all text color to white for labelvaluelimitsbars
     GLOBAL_SUBSETTING LABELVALUELIMITSBAR 0:0 TEXTCOLOR white
 SETTING:

data/data/config/target.yaml

@@ -187,3 +187,12 @@ TARGET:
           description: The packet name. Does not apply to
             REDUCER or CLEANUP target microservice types.
           values: .*
+    DISABLE_ERB:
+      summary: Disable ERB processing
+      description: Disable ERB processing for the entire target or a set of regular expressions over its filenames
+      since: 5.12.0
+      parameters:
+        - name: Regex
+          required: false
+          description: Regex to match against filenames. If match, then no ERB processing
+          values: .+

data/data/config/target_config.yaml

@@ -1,10 +1,19 @@
 ---
+LANGUAGE:
+  summary: Programming language of the target interfaces and microservices
+  description: The target language must be either Ruby or Python. The language
+    determines how the target's interfaces and microservices are run. Note that
+    both Ruby and Python still use ERB to perform templating.
+  example: LANGUAGE python
+  parameters:
+    - language: Programming language
+      required: true
+      description: Ruby or Python
+      values: ["ruby", "python"]
+  since: 5.11.1
 REQUIRE:
   summary: Requires a Ruby file
-  description:
-    Ruby files must be required to be available to call in other code.
-    Files are first required from the target's lib folder. If no file is found the
-    Ruby system path is checked which includes the base openc3/lib folder.
+  description: Ruby files optionally be required to explicitly declare dependencies.
   example: REQUIRE limits_response.rb
   parameters:
     - name: Filename
@@ -13,8 +22,7 @@ REQUIRE:
         simply supply the filename, e.g. "REQUIRE my_file". Files in the base OpenC3
         lib directory also should just list the filename. If a file is in a folder
         under the lib directory then you must specify the folder name, e.g. "REQUIRE
-        folder/my_file". The filename can also be an absolute path but this is not
-        common. Note the ".rb" extension is optional when specifying the filename.
+        folder/my_file". Note the ".rb" extension is optional when specifying the filename.
       values: .+
 IGNORE_PARAMETER:
   summary: Ignore the given command parameter

data/data/config/tool.yaml

@@ -5,7 +5,7 @@ TOOL:
   description: Defines a tool that the plugin adds to the OpenC3 system. Tools are web based applications that make use of the Single-SPA javascript library that allows them to by dynamically added to the running system as independent frontend microservices.
   parameters:
     - name: Tool Folder Name
-      description: The exact name of the tool folder in the plugin. ie. tools/<Tool Folder Name>
+      description: The exact name of the tool folder in the plugin. ie. tools/ToolFolderName
       required: true
       values: .+
     - name: Tool Name
@@ -15,11 +15,11 @@ TOOL:
   modifiers:
     URL:
       summary: Url used to access the tool
-      description: The relative url used to access the tool. Defaults to "/tools/<Tool Folder Name>".
+      description: The relative url used to access the tool. Defaults to "/tools/ToolFolderName".
       parameters:
         - name: Url
           required: true
-          description: The url. If not given defaults to tools/<Tool Folder Name>. Generally should not be given unless linking to external tools.
+          description: The url. If not given defaults to tools/ToolFolderName. Generally should not be given unless linking to external tools.
           values: .+
     INLINE_URL:
       summary: Internal url to load a tool
@@ -70,3 +70,12 @@ TOOL:
           required: true
           description: Numerical position
           values: \d+
+    DISABLE_ERB:
+      summary: Disable ERB processing
+      description: Disable ERB processing for the entire tool or a set of regular expressions over its filenames
+      since: 5.12.0
+      parameters:
+        - name: Regex
+          required: false
+          description: Regex to match against filenames. If match, then no ERB processing
+          values: .+

data/lib/openc3/api/api.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2023, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license