openc3 6.0.2 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7cb703367de9f45fc0ffb6d7fd9e2d4fbf075d3c2be95081468558a757df2f6
-  data.tar.gz: 2580ce86c27ac4dc6a8dcdaa2e8c8531de1ff3ad5fb803516b70e4c8ac74c90f
+  metadata.gz: be3485e674a1fe4a236e3a71b57aff4d7d7398a0638a21d8069994739a53edab
+  data.tar.gz: 911ee7331cc9100dc1dfbb7abe3e7f38baaa5b201be2974d882f0ef01701e9da
 SHA512:
-  metadata.gz: 43cb5951f41970eed0b27f355894d5c014b3f69132abe381640e6d9c1d9d04ab7eab8aecaf14c8e7ec1a51353ec953c68ee4e1ba7783f6d58014ae545dde48cf
-  data.tar.gz: a146e2222479e99a6afe1b726bc0e5c08863db658203538d3781ba83d06e3944f74e41e85b49572f52ddd59d56b55428b937e4ab3a6902277a4dd34df2746e22
+  metadata.gz: eafafaac4ae90e0bb594446fefdfc7b9e6eb96be4b08c5798d827d60a2377fad9252bca9d2e4495b8d4073283aa957d89fab0214d998bd9c4bbbb5d9174000cc
+  data.tar.gz: ea90586ba1347a74964c3cbb181810463caf507bb22c88bed8253b2fc9164b7f1648300d35163aba95f9e96f29f31ccb6f4406063dfefa7d33fd8057acddc416

data/bin/pipinstall

@@ -9,6 +9,6 @@ else
     echo "Command failed - retrying with --no-index"
     pip3 install --no-index "$@"
     if [ $? -eq 0 ]; then
-        echo "ERROR: pip install failed"
+        echo "ERROR: pip3 install failed"
     fi
 fi

data/bin/pipuninstall

@@ -0,0 +1,10 @@
+#!/bin/sh
+python3 -m venv $PYTHONUSERBASE
+source $PYTHONUSERBASE/bin/activate
+echo "pip3 uninstall $@"
+pip3 uninstall "$@"
+if [ $? -eq 0 ]; then
+    echo "Command succeeded"
+else
+    echo "ERROR: pip3 uninstall failed"
+fi

data/data/config/parameter_modifiers.yaml

@@ -71,6 +71,17 @@ WRITE_CONVERSION:
     factor is applied to the value entered by the user before it is written into
     the binary command packet and sent.
 
+    When applying a write_conversion sometimes the data type changes,
+    e.g. creating a UINT from an input STRING (for an example of this see
+    [ip_write_conversion.rb](https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/conversions/ip_write_conversion.rb)
+    or [ip_write_conversion.py](https://github.com/OpenC3/cosmos/blob/main/openc3/python/openc3/conversions/ip_write_conversion.py)).
+    In this case, the command definition data type is UINT and the min, max values don't matter
+    (but must be given) so are typically set to MIN MAX. The default value is important
+    and should be specified as a string. For a full example see the IP_ADDRESS parameter
+    in the TIME_OFFSET command definition of the COSMOS Demo
+    [INST inst_cmds.txt](https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST/cmd_tlm/inst_cmds.txt)
+    or [INST2 inst_cmds.txt](https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST2/cmd_tlm/inst_cmds.txt).
+
     :::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)

data/data/config/widgets.yaml

@@ -245,6 +245,40 @@ Telemetry Widgets:
       example: |
         ARRAY INST HEALTH_STATUS ARY 250 80 "0x%x" 6 FORMATTED
         ARRAY INST HEALTH_STATUS ARY2 200 100 nil 4 WITH_UNITS
+    ARRAYPLOT:
+      summary: Plot an array of values.
+      description:
+        The item can either be a simple array or a 2D array of x values and y values, e.g. [[x1, x2, x3], [y1, y2, y3]].
+        If the X_AXIS setting is not specified, the X axis starts with 0 and increments by 1.
+        If the X_AXIS setting is used the x values of a 2D array will be ignored.
+      settings:
+        TITLE:
+          summary: Title of the plot
+          parameters:
+            - name: Title
+              required: true
+              description: Title of the plot
+              values: .+
+        X_AXIS:
+          summary: Define the x-axis parameters for the plot
+          parameters:
+            - name: Start
+              required: true
+              description: Start value for the x-axis
+              values: .+
+            - name: Step
+              required: true
+              description: Step value for the x-axis
+              values: .+
+        # Inject the graph settings
+        <%= MetaConfigParser.load('graph_settings.yaml').to_meta_config_yaml(8) %>
+      example: |
+        ARRAYPLOT
+          SETTING TITLE "Array Data"
+          SETTING ITEM INST HEALTH_STATUS ARY
+          SETTING ITEM INST HEALTH_STATUS ARY2
+          SETTING SIZE 600 400
+          SETTING X_AXIS 10 10
     BLOCK:
       summary: Displays BLOCK data organized into rows and space separated
       parameters:
@@ -372,6 +406,7 @@ Telemetry Widgets:
         FORMATVALUE INST LATEST TEMP1 %.2f CONVERTED 20
     LABELLED:
       summary: Displays a LABEL followed by a LED
+      description: See the LED widget for more information
       parameters:
         - name: Target name
           required: true
@@ -688,6 +723,7 @@ Telemetry Widgets:
         Additional values can be added by using the LED_COLOR setting. For example
         LED INST PARAMS VALUE3 RAW can be followed by SETTING LED_COLOR 0 GREEN,
         SETTING LED_COLOR 1 RED, and SETTING LED_COLOR ANY ORANGE.
+        See LIMITSCOLOR for a widget that displays a circle depicting the limits color of an item.
       parameters:
         - name: Target name
           required: true
@@ -791,7 +827,8 @@ Telemetry Widgets:
         LIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 50 200
         LIMITSCOLUMN INST HEALTH_STATUS TEMP1
     LIMITSCOLOR:
-      summary: Displays a circle depicting the limits color of an item
+      summary: Displays a circle depicting the limits color of an item.
+        See LED for a widget that displays a circle which changes to an arbitrary color based on telemetry values.
       parameters:
         - name: Target name
           required: true

data/lib/openc3/api/settings_api.rb

@@ -14,13 +14,23 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
+begin
+  require 'openc3-enterprise/version'
+  VERSION = OPENC3_ENTERPRISE_VERSION
+  ENTERPRISE = true
+rescue LoadError
+  require 'openc3/version'
+  VERSION = OPENC3_VERSION
+  ENTERPRISE = false
+end
 require 'openc3/models/setting_model'
+require 'openc3/models/news_model'
 
 module OpenC3
   module Api
@@ -31,7 +41,8 @@ module OpenC3
                        'get_setting',
                        'get_settings',
                        'set_setting',
-                       'save_setting' # DEPRECATED
+                       'save_setting', # DEPRECATED
+                       'update_news',
                      ])
 
     def list_settings(manual: false, scope: $openc3_scope, token: $openc3_token)
@@ -68,5 +79,27 @@ module OpenC3
     end
     # save_setting is DEPRECATED
     alias save_setting set_setting
+
+    # Update the news feed on demand to respond to frontend setting changes
+    def update_news(manual: false, scope: $openc3_scope, token: $openc3_token)
+      authorize(permission: 'admin', manual: manual, scope: scope, token: token)
+      conn = Faraday.new(
+        url: 'https://news.openc3.com',
+        params: {version: VERSION, enterprise: ENTERPRISE},
+      )
+      response = conn.get('/news')
+      if response.success?
+        NewsModel.set(response.body)
+      else
+        NewsModel.news_error(response)
+      end
+
+      # Test code to update the news feed with a dummy message
+      # data = NewsModel.all()
+      # json = JSON.parse(data)
+      # json.unshift( { date: Time.now.utc.iso8601, title: "News at #{Time.now}", body: "The news feed has been updated at #{Time.now}." })
+      # json.pop if json.length > 5
+      # NewsModel.set(json.to_json)
+    end
   end
 end

data/lib/openc3/api/tlm_api.rb

@@ -35,7 +35,7 @@ module OpenC3
                        'tlm_raw',
                        'tlm_formatted',
                        'tlm_with_units',
-                       'tlm_variable',
+                       'tlm_variable', # DEPRECATED
                        'set_tlm',
                        'inject_tlm',
                        'override_tlm',
@@ -131,7 +131,16 @@ module OpenC3
       if item_hash
         item_hash = item_hash.transform_keys(&:upcase)
         # Check that the items exist ... exceptions are raised if not
-        TargetModel.packet_items(target_name, packet_name, item_hash.keys, scope: scope)
+        items = TargetModel.packet_items(target_name, packet_name, item_hash.keys, scope: scope)
+        if type == :CONVERTED
+          # If the type is converted, check that the item states are valid
+          item_hash.each do |item_name, item_value|
+            item = items.find { |i| i['name'] == item_name.to_s.upcase }
+            if item['states'] && !item['states'][item_value]
+              raise "Unknown state '#{item_value}' for #{item['name']}, must be one of #{item['states'].keys.join(', ')}"
+            end
+          end
+        end
       else
         # Check that the packet exists ... exceptions are raised if not
         TargetModel.packet(target_name, packet_name, scope: scope)

data/lib/openc3/config/config_parser.rb

@@ -380,9 +380,11 @@ module OpenC3
           return Float::INFINITY
         when 'NEG_INFINITY'
           return -Float::INFINITY
-        else
-          raise ArgumentError, "Could not convert constant: #{value}"
         end
+        # NOTE: No else case because of the following scenario:
+        # If the value type is a UINT but they have a WRITE_CONVERSION that takes a string
+        # then the default value will be a string. In that case we just want to return the string.
+        # For example, the IP_ADDRESS parameter in the TIME_OFFSET command in the Demo plugin.
       end
       return value
     end

data/lib/openc3/io/json_api_object.rb

@@ -67,6 +67,7 @@ module OpenC3
       @authentication = authentication.nil? ? generate_auth() : authentication
       @timeout = timeout
       @shutdown = false
+      # JsonDRb.debug = true # Enable for debugging
     end
 
     # generate the auth object
@@ -179,12 +180,11 @@ module OpenC3
     # NOTE: This is a helper method and should not be called directly
     def _generate_data(kwargs)
       data = kwargs[:data]
-      if data.nil?
-        data = kwargs[:data] = {}
-      elsif data.is_a?(Hash) == false and data.is_a?(String) == false
+      # data can be nil but otherwise must be a Hash or String
+      if !data.nil? and !data.is_a?(Hash) and !data.is_a?(String)
         raise JsonApiError, "incorrect type for keyword 'data' MUST be Hash or String: #{data}"
       end
-      return kwargs[:json] ? JSON.generate(kwargs[:data]) : kwargs[:data]
+      return kwargs[:json] ? JSON.generate(data) : data
     end
 
     # NOTE: This is a helper method and should not be called directly

data/lib/openc3/microservices/interface_decom_common.rb

@@ -36,6 +36,10 @@ module OpenC3
       packet.received_count += 1
       packet.received_time = Time.now.sys
       TelemetryTopic.write_packet(packet, scope: @scope)
+    # If the inject_tlm parameters are bad we rescue so
+    # interface_microservice and decom_microservice can continue
+    rescue => e
+      @logger.error "inject_tlm error due to #{e.message}"
     end
 
     def handle_build_cmd(build_cmd_json, msg_id)

data/lib/openc3/microservices/periodic_microservice.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2022 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -18,15 +18,39 @@
 
 require 'openc3/microservices/microservice'
 require 'openc3/models/offline_access_model'
+require 'openc3/models/news_model'
+# The VERSION and ENTERPRISE constants are set by settings_api.rb
+require 'openc3/api/settings_api'
 
 module OpenC3
   class PeriodicMicroservice < Microservice
+    include Api
+
     STARTUP_DELAY_SECONDS = 2 * 60 # Two Minutes
     SLEEP_PERIOD_SECONDS = 24 * 60 * 60 # Run once per day
 
     def initialize(*args)
       super(*args)
       @metric.set(name: 'periodic_total', value: @count, type: 'counter')
+      @conn = nil # Faraday connection set by get_news
+      get_news()
+    end
+
+    def get_news
+      if get_setting('news_feed', scope: @scope)
+        unless @conn
+          @conn = Faraday.new(
+            url: 'https://news.openc3.com',
+            params: {version: VERSION, enterprise: ENTERPRISE},
+          )
+        end
+        response = @conn.get('/news')
+        if response.success?
+          NewsModel.set(response.body)
+        else
+          NewsModel.news_error(response)
+        end
+      end
     end
 
     def run
@@ -52,6 +76,7 @@ module OpenC3
         @metric.set(name: 'periodic_total', value: @count, type: 'counter')
         break if @cancel_thread
         break if @run_sleeper.sleep(SLEEP_PERIOD_SECONDS)
+        get_news()
       end
     end
 

data/lib/openc3/migrations/20250108060000_news_feed.rb

@@ -0,0 +1,15 @@
+require 'openc3/utilities/migration'
+require 'openc3/models/scope_model'
+require 'openc3/models/setting_model'
+
+module OpenC3
+  class NewsFeed < Migration
+    def self.run
+      SettingModel.set({ name: 'news_feed', data: true }, scope: 'DEFAULT')
+    end
+  end
+end
+
+unless ENV['OPENC3_NO_MIGRATE']
+  OpenC3::NewsFeed.run
+end

data/lib/openc3/models/activity_model.rb

@@ -66,10 +66,17 @@ module OpenC3
     end
 
     # @return [String|nil] String of the saved json or nil if score not found under primary_key
-    def self.score(name:, score:, scope:)
-      value = Store.zrangebyscore("#{scope}#{PRIMARY_KEY}__#{name}", score, score, :limit => [0, 1]).first
-      if value
-        return ActivityModel.from_json(value, name: name, scope: scope)
+    def self.score(name:, score:, scope:, uuid: nil)
+      values = Store.zrangebyscore("#{scope}#{PRIMARY_KEY}__#{name}", score, score)
+      if values and values.length > 0
+        if uuid
+          values.each do |value|
+            activity = ActivityModel.from_json(value, name: name, scope: scope)
+            return activity if activity.uuid == uuid
+          end
+        else
+          return ActivityModel.from_json(values[0], name: name, scope: scope)
+        end
       end
       return nil
     end

data/lib/openc3/models/news_model.rb

@@ -0,0 +1,38 @@
+# encoding: ascii-8bit
+
+# Copyright 2025 OpenC3, Inc.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+require 'openc3/models/model'
+require 'openc3/utilities/store'
+
+module OpenC3
+  class NewsModel < Model
+    PRIMARY_KEY = 'openc3_news'
+
+    def self.set(news)
+      Store.set(PRIMARY_KEY, news)
+    end
+
+    def self.all()
+      Store.get(PRIMARY_KEY)
+    end
+
+    def self.news_error(response)
+      Store.set(PRIMARY_KEY, [{ date: Time.now.utc.iso8601, title: 'News Error', body: "Error contacting OpenC3 news feed (status: #{response.status})" }].to_json)
+    end
+  end
+end

data/lib/openc3/models/python_package_model.rb

@@ -104,7 +104,8 @@ module OpenC3
     def self.destroy(name, scope:)
       package_name, version = self.extract_name_and_version(name)
       Logger.info "Uninstalling package: #{name}"
-      result = OpenC3::ProcessManager.instance.spawn(["pip", "uninstall", package_name, "-y"], "package_uninstall", name, Time.now + 3600.0, scope: scope)
+      pip_args = ["-y", package_name]
+      result = OpenC3::ProcessManager.instance.spawn(["/openc3/bin/pipuninstall"] + pip_args, "package_uninstall", name, Time.now + 3600.0, scope: scope)
       return result.name
     end
 

data/lib/openc3/models/scope_model.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2024, OpenC3, Inc.
+# All changes Copyright 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -400,6 +400,8 @@ module OpenC3
       SettingModel.set({ name: 'rubygems_url', data: ENV['RUBYGEMS_URL'] || 'https://rubygems.org' }, scope: @scope) unless setting
       setting = SettingModel.get(name: 'pypi_url')
       SettingModel.set({ name: 'pypi_url', data: ENV['PYPI_URL'] || 'https://pypi.org' }, scope: @scope) unless setting
+      # Set the news feed to true by default, don't bother checking if it's already set
+      SettingModel.set({ name: 'news_feed', data: true }, scope: @scope)
     end
   end
 end

data/lib/openc3/models/timeline_model.rb

@@ -94,13 +94,10 @@ module OpenC3
       if color.nil?
         color = '#%06x' % (rand * 0xffffff)
       end
-      valid_color = color =~ /[0-9a-fA-F]{6}/
-      if valid_color.nil?
-        raise RuntimeError.new "invalid color but in hex format. #FF0000"
-      end
-      unless color.start_with?('#')
-        color = "##{color}"
+      unless color =~ /#?([0-9a-fA-F]{6})/
+        raise TimelineInputError.new "invalid color, must be in hex format, e.g. #FF0000"
       end
+      color = "##{color}" unless color.start_with?('#')
       @color = color
     end
 

data/lib/openc3/packets/commands.rb

@@ -326,7 +326,8 @@ module OpenC3
           end
 
           range = item.range
-          if range
+          # Don't range check a string default value
+          if range and !item.default.is_a?(String)
             # Perform Range Check on command parameter
             if not range.include?(range_check_value)
               range_check_value = "'#{range_check_value}'" if String === range_check_value

data/lib/openc3/packets/packet.rb

@@ -756,7 +756,7 @@ module OpenC3
           super(item, value, :RAW, buffer)
         rescue ArgumentError => e
           if item.states and String === value and e.message =~ /invalid value for/
-            raise "Unknown state #{value} for #{item.name}, must be one of #{item.states.keys.join(', ')}"
+            raise "Unknown state '#{value}' for #{item.name}, must be one of #{item.states.keys.join(', ')}"
           else
             raise e
           end

data/lib/openc3/script/calendar.rb

@@ -23,12 +23,12 @@ module OpenC3
 
     private
 
-    def list_timelines(scope: $openc3_scope, token: $openc3_token)
+    def list_timelines(scope: $openc3_scope)
       response = $api_server.request('get', "/openc3-api/timeline", scope: scope)
       return _handle_response(response, 'Failed to list timelines')
     end
 
-    def create_timeline(name, color: nil, scope: $openc3_scope, token: $openc3_token)
+    def create_timeline(name, color: nil, scope: $openc3_scope)
       data = {}
       data['name'] = name
       data['color'] = color if color
@@ -36,19 +36,19 @@ module OpenC3
       return _handle_response(response, 'Failed to create timeline')
     end
 
-    def get_timeline(name, scope: $openc3_scope, token: $openc3_token)
+    def get_timeline(name, scope: $openc3_scope)
       response = $api_server.request('get', "/openc3-api/timeline/#{name}", scope: scope)
       return _handle_response(response, 'Failed to get timeline')
     end
 
-    def set_timeline_color(name, color, scope: $openc3_scope, token: $openc3_token)
+    def set_timeline_color(name, color, scope: $openc3_scope)
       post_data = {}
       post_data['color'] = color
       response = $api_server.request('post', "/openc3-api/timeline/#{name}/color", data: post_data, json: true, scope: scope)
       return _handle_response(response, 'Failed to set timeline color')
     end
 
-    def delete_timeline(name, force: false, scope: $openc3_scope, token: $openc3_token)
+    def delete_timeline(name, force: false, scope: $openc3_scope)
       url = "/openc3-api/timeline/#{name}"
       if force
         url += "?force=true"
@@ -57,16 +57,7 @@ module OpenC3
       return _handle_response(response, 'Failed to delete timeline')
     end
 
-    def get_timeline_activities(name, start: nil, stop: nil, scope: $openc3_scope, token: $openc3_token)
-      url = "/openc3-api/timeline/#{name}/activities"
-      if start and stop
-        url += "?start=#{start}&stop=#{stop}"
-      end
-      response = $api_server.request('get', url, scope: scope)
-      return _handle_response(response, 'Failed to get timeline activities')
-    end
-
-    def create_timeline_activity(name, kind:, start:, stop:, data: {}, scope: $openc3_scope, token: $openc3_token)
+    def create_timeline_activity(name, kind:, start:, stop:, data: {}, scope: $openc3_scope)
       kind = kind.to_s.downcase()
       kinds = %w(command script reserve)
       unless kinds.include?(kind)
@@ -81,12 +72,24 @@ module OpenC3
       return _handle_response(response, 'Failed to create timeline activity')
     end
 
-    def get_timeline_activity(name, start: nil, scope: $openc3_scope, token: $openc3_token)
-      response = $api_server.request('get', "/openc3-api/timeline/#{name}/activity/#{start}", scope: scope)
+    def get_timeline_activity(name, start, uuid, scope: $openc3_scope)
+      response = $api_server.request('get', "/openc3-api/timeline/#{name}/activity/#{start}/#{uuid}", scope: scope)
       return _handle_response(response, 'Failed to get timeline activity')
     end
 
-    def delete_timeline_activity(name, start, uuid, scope: $openc3_scope, token: $openc3_token)
+    def get_timeline_activities(name, start: nil, stop: nil, limit: nil, scope: $openc3_scope)
+      url = "/openc3-api/timeline/#{name}/activities"
+      if start and stop
+        url += "?start=#{start}&stop=#{stop}"
+      end
+      if limit
+        url += "?limit=#{limit}"
+      end
+      response = $api_server.request('get', url, scope: scope)
+      return _handle_response(response, 'Failed to get timeline activities')
+    end
+
+    def delete_timeline_activity(name, start, uuid, scope: $openc3_scope)
       response = $api_server.request('delete', "/openc3-api/timeline/#{name}/activity/#{start}/#{uuid}", scope: scope)
       return _handle_response(response, 'Failed to delete timeline activity')
     end

data/lib/openc3/script/plugins.rb

@@ -20,7 +20,7 @@ module OpenC3
   module Script
     private
 
-    def plugin_list(scope: $openc3_scope)
+    def plugin_list(default: false, scope: $openc3_scope)
       response_body = nil
       begin
         endpoint = "/openc3-api/plugins?scope=#{scope}"
@@ -35,7 +35,15 @@ module OpenC3
           http.request(request) do |response|
             response_body = response.body
             response.value() # Raises an HTTP error if the response is not 2xx (success)
-            return JSON.parse(response.body, allow_nan: true, create_additions: true)
+            plugins = JSON.parse(response.body, allow_nan: true, create_additions: true)
+            if default
+              return plugins
+            else
+              return plugins.select do |plugin|
+                !plugin.include?('openc3-cosmos-tool-') and !plugin.include?('openc3-tool-base') and
+                !plugin.include?('openc3-cosmos-enterprise-tool-') and !plugin.include?('openc3-enterprise-tool-base')
+              end
+            end
           end
         end
       rescue => e

data/lib/openc3/script/script.rb

@@ -25,18 +25,23 @@ require 'openc3/api/api'
 require 'openc3/io/json_drb_object'
 require 'openc3/script/api_shared'
 require 'openc3/script/calendar'
-require 'openc3/script/metadata'
 require 'openc3/script/commands'
-require 'openc3/script/telemetry'
-require 'openc3/script/limits'
+require 'openc3/script/critical_cmd'
 require 'openc3/script/exceptions'
+# openc3/script/extract is just helper methods
+require 'openc3/script/limits'
+require 'openc3/script/metadata'
+require 'openc3/script/packages'
+require 'openc3/script/plugins'
 require 'openc3/script/screen'
 require 'openc3/script/script_runner'
 require 'openc3/script/storage'
+# openc3/script/suite_results and suite_runner are used by
+# running_script.rb and the script_runner_api
+# openc3/script/suite is used by end user SR Suites
+require 'openc3/script/tables'
+require 'openc3/script/telemetry'
 require 'openc3/script/web_socket_api'
-require 'openc3/script/packages'
-require 'openc3/script/plugins'
-require 'openc3/script/critical_cmd'
 require 'openc3/utilities/authentication'
 
 $api_server = nil

data/lib/openc3/script/script_runner.rb

@@ -34,22 +34,29 @@ module OpenC3
       if response.nil? || response.status != 200
         _script_response_error(response, "Script list request failed", scope: scope)
       else
-        return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+        scripts = JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+        # Remove the '*' from the script names
+        return scripts.each { |script| script.gsub!(/\*$/, '') }
       end
     end
 
     def script_syntax_check(script, scope: $openc3_scope)
-      endpoint = "/script-api/scripts/syntax"
-      response = $script_runner_api_server.request('post', endpoint, json: true, data: script, scope: scope)
+      endpoint = "/script-api/scripts/temp.rb/syntax"
+      # Explicitly set the headers to plain/text so the request.body is set correctly
+      headers = {
+        'Content-Type': 'plain/text',
+      }
+      response = $script_runner_api_server.request('post', endpoint, headers: headers, data: script, scope: scope)
       if response.nil? || response.status != 200
         _script_response_error(response, "Script syntax check request failed", scope: scope)
       else
         result = JSON.parse(response.body, :allow_nan => true, :create_additions => true)
         if result['title'] == "Syntax Check Successful"
-          return true
+          result['success'] = true
         else
-          raise result.inspect
+          result['success'] = false
         end
+        return result
       end
     end
 
@@ -59,8 +66,8 @@ module OpenC3
       if response.nil? || response.status != 200
         _script_response_error(response, "Failed to get #{filename}", scope: scope)
       else
-        script = response.body
-        return script
+        result = JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+        return result['contents']
       end
     end
 
@@ -120,9 +127,13 @@ module OpenC3
       end
     end
 
-    def script_instrumented(filename, script, scope: $openc3_scope)
-      endpoint = "/script-api/scripts/#{filename}/instrumented"
-      response = $script_runner_api_server.request('post', endpoint, json: true, data: script, scope: scope)
+    def script_instrumented(script, scope: $openc3_scope)
+      endpoint = "/script-api/scripts/temp.rb/instrumented"
+      # Explicitly set the headers to plain/text so the request.body is set correctly
+      headers = {
+        'Content-Type': 'plain/text',
+      }
+      response = $script_runner_api_server.request('post', endpoint, headers: headers, data: script, scope: scope)
       if response.nil? || response.status != 200
         _script_response_error(response, "Script instrumented request failed", scope: scope)
       else
@@ -178,7 +189,7 @@ module OpenC3
 
     def _running_script_action(id, action_name, scope: $openc3_scope)
       endpoint = "/script-api/running-script/#{id}/#{action_name}"
-      response = $script_runner_api_server.request('post', endpoint, scope: scope)
+      response = $script_runner_api_server.request('post', endpoint, json: true, scope: scope)
       if response.nil? || response.status != 200
         _script_response_error(response, "Running script #{action_name} request failed", scope: scope)
       else

data/lib/openc3/script/storage.rb

@@ -127,7 +127,9 @@ module OpenC3
       end
     end
 
-    def get_download_url(path, scope: $openc3_scope)
+    # These are helper methods ... should not be used directly
+
+    def _get_download_url(path, scope: $openc3_scope)
       targets = "targets_modified" # First try targets_modified
       response = $api_server.request('get', "/openc3-api/storage/exists/#{scope}/#{targets}/#{path}", query: { bucket: 'OPENC3_CONFIG_BUCKET' }, scope: scope)
       if response.status != 200
@@ -143,8 +145,6 @@ module OpenC3
       return result['url']
     end
 
-    # These are helper methods ... should not be used directly
-
     def _get_storage_file(path, scope: $openc3_scope)
       # Create Tempfile to store data
       file = Tempfile.new('target', binmode: true)

data/lib/openc3/script/tables.rb

@@ -0,0 +1,49 @@
+# encoding: ascii-8bit
+
+# Copyright 2025 OpenC3, Inc.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+module OpenC3
+  module Script
+    private
+
+    def table_create_binary(definition, scope: $openc3_scope)
+      post_data = {}
+      post_data['definition'] = definition
+      response = $api_server.request('post', '/openc3-api/tables/generate', json: true, data: post_data, scope: scope)
+      return _handle_response(response, 'Failed to create binary')
+    end
+
+    def table_create_report(filename, definition, table_name: nil, scope: $openc3_scope)
+      post_data = {}
+      post_data['binary'] = filename
+      post_data['definition'] = definition
+      post_data['table_name'] = table_name if table_name
+      response = $api_server.request('post', '/openc3-api/tables/report', json: true, data: post_data, scope: scope)
+      return _handle_response(response, 'Failed to create report')
+    end
+
+    # Helper method to handle the response
+    def _handle_response(response, error_message)
+      return nil if response.nil?
+      if response.status >= 400
+        result = JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+        raise "#{error_message} due to #{result['message']}"
+      end
+      return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+    end
+  end
+end

data/lib/openc3/script/web_socket_api.rb

@@ -182,7 +182,7 @@ module OpenC3
     def generate_url
       schema = ENV['OPENC3_API_SCHEMA'] || 'http'
       hostname = ENV['OPENC3_API_HOSTNAME'] || (ENV['OPENC3_DEVEL'] ? '127.0.0.1' : 'openc3-cosmos-cmd-tlm-api')
-      port = ENV['OPENC3_API_PORT'] || '2901'
+      port = ENV['OPENC3_API_CABLE_PORT'] || ENV['OPENC3_API_PORT'] || '3901'
       port = port.to_i
       return "#{schema}://#{hostname}:#{port}/openc3-api/cable"
     end
@@ -198,7 +198,7 @@ module OpenC3
     def generate_url
       schema = ENV['OPENC3_SCRIPT_API_SCHEMA'] || 'http'
       hostname = ENV['OPENC3_SCRIPT_API_HOSTNAME'] || (ENV['OPENC3_DEVEL'] ? '127.0.0.1' : 'openc3-cosmos-script-runner-api')
-      port = ENV['OPENC3_SCRIPT_API_PORT'] || '2902'
+      port = ENV['OPENC3_SCRIPT_API_CABLE_PORT'] || ENV['OPENC3_SCRIPT_API_PORT'] || '3902'
       port = port.to_i
       return "#{schema}://#{hostname}:#{port}/script-api/cable"
     end

data/lib/openc3/utilities/local_mode.rb

@@ -380,6 +380,7 @@ module OpenC3
 
     def self.put_target_file(path, io_or_string, scope:)
       full_folder_path = "#{OPENC3_LOCAL_MODE_PATH}/#{path}"
+      return unless File.expand_path(full_folder_path).start_with?(OPENC3_LOCAL_MODE_PATH)
       FileUtils.mkdir_p(File.dirname(full_folder_path))
       File.open(full_folder_path, 'wb') do |file|
         if String === io_or_string
@@ -393,7 +394,10 @@ module OpenC3
 
     def self.open_local_file(path, scope:)
       full_path = "#{OPENC3_LOCAL_MODE_PATH}/#{scope}/targets_modified/#{path}"
-      return File.open(full_path, 'rb')
+      if File.expand_path(full_path).start_with?(OPENC3_LOCAL_MODE_PATH)
+        return File.open(full_path, 'rb')
+      end
+      nil
     rescue Errno::ENOENT
       nil
     end
@@ -446,6 +450,7 @@ module OpenC3
     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"
+      return unless File.expand_path(config_path).start_with?(OPENC3_LOCAL_MODE_PATH)
       FileUtils.mkdir_p(File.dirname(config_path))
       File.open(config_path, 'w') do |file|
         file.write(JSON.pretty_generate(json, :allow_nan => true))
@@ -453,7 +458,9 @@ module OpenC3
     end
 
     def self.delete_tool_config(scope, tool, name)
-      FileUtils.rm_f("#{OPENC3_LOCAL_MODE_PATH}/#{scope}/tool_config/#{tool}/#{name}.json")
+      config_path = "#{OPENC3_LOCAL_MODE_PATH}/#{scope}/tool_config/#{tool}/#{name}.json"
+      return unless File.expand_path(config_path).start_with?(OPENC3_LOCAL_MODE_PATH)
+      FileUtils.rm_f(config_path)
     end
 
     def self.sync_settings()
@@ -471,6 +478,7 @@ module OpenC3
 
     def self.save_setting(scope, name, data)
       config_path = "#{OPENC3_LOCAL_MODE_PATH}/#{scope}/settings/#{name}.json"
+      return unless File.expand_path(config_path).start_with?(OPENC3_LOCAL_MODE_PATH)
       FileUtils.mkdir_p(File.dirname(config_path))
       # Anything can be stored as a setting so write it out directly
       File.write(config_path, data)
@@ -480,12 +488,14 @@ module OpenC3
 
     def self.sync_remote_to_local(bucket, key)
       local_path = "#{OPENC3_LOCAL_MODE_PATH}/#{key}"
+      return unless File.expand_path(local_path).start_with?(OPENC3_LOCAL_MODE_PATH)
       FileUtils.mkdir_p(File.dirname(local_path))
       bucket.get_object(bucket: ENV['OPENC3_CONFIG_BUCKET'], key: key, path: local_path)
     end
 
     def self.sync_local_to_remote(bucket, key)
       local_path = "#{OPENC3_LOCAL_MODE_PATH}/#{key}"
+      return unless File.expand_path(local_path).start_with?(OPENC3_LOCAL_MODE_PATH)
       File.open(local_path, 'rb') do |read_file|
         bucket.put_object(bucket: ENV['OPENC3_CONFIG_BUCKET'], key: key, body: read_file)
       end
@@ -493,6 +503,7 @@ module OpenC3
 
     def self.delete_local(key)
       local_path = "#{OPENC3_LOCAL_MODE_PATH}/#{key}"
+      return unless File.expand_path(local_path).start_with?(OPENC3_LOCAL_MODE_PATH)
       File.delete(local_path) if File.exist?(local_path)
       nil
     end

data/lib/openc3/utilities/target_file.rb

@@ -94,7 +94,13 @@ module OpenC3
       # First try opening a potentially modified version by looking for the modified target
       if ENV['OPENC3_LOCAL_MODE']
         local_file = OpenC3::LocalMode.open_local_file(name, scope: scope)
-        return local_file.read if local_file
+        if local_file
+          if File.extname(name) == ".bin"
+            return local_file.read
+          else
+            return local_file.read.force_encoding('UTF-8')
+          end
+        end
       end
 
       bucket = Bucket.getClient()
@@ -106,8 +112,10 @@ module OpenC3
       if resp && resp.body
         if File.extname(name) == ".bin"
           resp.body.binmode
+          return resp.body.read
+        else
+          return resp.body.read.force_encoding('UTF-8')
         end
-        resp.body.read
       else
         nil
       end

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '6.0.2'
+OPENC3_VERSION = '6.1.0'
 module OpenC3
   module Version
     MAJOR = '6'
-    MINOR = '0'
-    PATCH = '2'
+    MINOR = '1'
+    PATCH = '0'
     OTHER = ''
-    BUILD = '30bcab7b66f6a10baacea338b83fc5bfb89e68d6'
+    BUILD = '4db8ce5a1e1178bf7272dab85bd71299e5d6c3b7'
   end
-  VERSION = '6.0.2'
-  GEM_VERSION = '6.0.2'
+  VERSION = '6.1.0'
+  GEM_VERSION = '6.1.0'
 end

data/templates/tool_angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "6.0.2",
+  "version": "6.1.0",
   "scripts": {
     "ng": "ng",
     "start": "ng serve",
@@ -23,7 +23,7 @@
     "@angular/platform-browser-dynamic": "^18.2.6",
     "@angular/router": "^18.2.6",
     "@astrouxds/astro-web-components": "^7.24.0",
-    "@openc3/js-common": "6.0.2",
+    "@openc3/js-common": "6.1.0",
     "rxjs": "~7.8.0",
     "single-spa": "^5.9.5",
     "single-spa-angular": "^9.2.0",

data/templates/tool_react/package.json

@@ -16,7 +16,7 @@
     "@emotion/react": "^11.13.3",
     "@emotion/styled": "^11.11.0",
     "@mui/material": "^6.1.1",
-    "@openc3/js-common": "6.0.2",
+    "@openc3/js-common": "6.1.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "single-spa-react": "^5.1.4"

data/templates/tool_svelte/package.json

@@ -12,7 +12,7 @@
   },
   "dependencies": {
     "@astrouxds/astro-web-components": "^7.24.0",
-    "@openc3/js-common": "6.0.2",
+    "@openc3/js-common": "6.1.0",
     "@smui/button": "^7.0.0",
     "@smui/common": "^7.0.0",
     "@smui/card": "^7.0.0",

data/templates/tool_vue/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "6.0.2",
+  "version": "6.1.0",
   "private": true,
   "type": "module",
   "scripts": {
@@ -11,8 +11,8 @@
   },
   "dependencies": {
     "@astrouxds/astro-web-components": "^7.24.0",
-    "@openc3/js-common": "6.0.2",
-    "@openc3/vue-common": "6.0.2",
+    "@openc3/js-common": "6.1.0",
+    "@openc3/vue-common": "6.1.0",
     "axios": "^1.7.7",
     "date-fns": "^4.1.0",
     "lodash": "^4.17.21",

data/templates/widget/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= widget_name %>",
-  "version": "6.0.2",
+  "version": "6.1.0",
   "private": true,
   "type": "module",
   "scripts": {
@@ -8,7 +8,7 @@
   },
   "dependencies": {
     "@astrouxds/astro-web-components": "^7.24.0",
-    "@openc3/vue-common": "6.0.2",
+    "@openc3/vue-common": "6.1.0",
     "vuetify": "^3.7.1"
   },
   "devDependencies": {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 6.0.2
+  version: 6.1.0
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-09 00:00:00.000000000 Z
+date: 2025-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -791,6 +791,7 @@ files:
 - bin/cstol_converter
 - bin/openc3cli
 - bin/pipinstall
+- bin/pipuninstall
 - bin/rubysloc
 - data/config/_array_params.yaml
 - data/config/_canvas_values.yaml
@@ -993,6 +994,7 @@ files:
 - lib/openc3/migrations/20231022000000_tlm_viewer_config.rb
 - lib/openc3/migrations/20241208080000_no_critical_cmd.rb
 - lib/openc3/migrations/20241208080001_no_trigger_group.rb
+- lib/openc3/migrations/20250108060000_news_feed.rb
 - lib/openc3/models/activity_model.rb
 - lib/openc3/models/auth_model.rb
 - lib/openc3/models/cvt_model.rb
@@ -1007,6 +1009,7 @@ files:
 - lib/openc3/models/microservice_status_model.rb
 - lib/openc3/models/migration_model.rb
 - lib/openc3/models/model.rb
+- lib/openc3/models/news_model.rb
 - lib/openc3/models/note_model.rb
 - lib/openc3/models/offline_access_model.rb
 - lib/openc3/models/ping_model.rb
@@ -1075,6 +1078,7 @@ files:
 - lib/openc3/script/suite.rb
 - lib/openc3/script/suite_results.rb
 - lib/openc3/script/suite_runner.rb
+- lib/openc3/script/tables.rb
 - lib/openc3/script/telemetry.rb
 - lib/openc3/script/web_socket_api.rb
 - lib/openc3/streams/mqtt_stream.rb