openc3 5.20.0 → 6.0.0

data/lib/openc3/packets/packet_item.rb

@@ -112,8 +112,6 @@ module OpenC3
       @messages_disabled = nil
       @state_colors = nil
       @limits = PacketItemLimits.new
-      @persistence_setting = 1
-      @persistence_count = 0
       @meta = nil
     end
 
@@ -426,15 +424,13 @@ module OpenC3
       config << self.read_conversion.to_config(:READ) if self.read_conversion
       config << self.write_conversion.to_config(:WRITE) if self.write_conversion
 
-      if self.limits
-        if self.limits.values
-          self.limits.values.each do |limits_set, limits_values|
-            config << "    LIMITS #{limits_set} #{self.limits.persistence_setting} #{self.limits.enabled ? 'ENABLED' : 'DISABLED'} #{limits_values[0]} #{limits_values[1]} #{limits_values[2]} #{limits_values[3]}"
-            if limits_values[4] && limits_values[5]
-              config << " #{limits_values[4]} #{limits_values[5]}\n"
-            else
-              config << "\n"
-            end
+      if self.limits.values
+        self.limits.values.each do |limits_set, limits_values|
+          config << "    LIMITS #{limits_set} #{self.limits.persistence_setting} #{self.limits.enabled ? 'ENABLED' : 'DISABLED'} #{limits_values[0]} #{limits_values[1]} #{limits_values[2]} #{limits_values[3]}"
+          if limits_values[4] && limits_values[5]
+            config << " #{limits_values[4]} #{limits_values[5]}\n"
+          else
+            config << "\n"
           end
         end
         config << self.limits.response.to_config if self.limits.response
@@ -489,35 +485,33 @@ module OpenC3
       config['read_conversion'] = self.read_conversion.as_json(*a) if self.read_conversion
       config['write_conversion'] = self.write_conversion.as_json(*a) if self.write_conversion
 
-      if self.limits
-        config['limits'] ||= {}
-        if self.limits.enabled
-          config['limits']['enabled'] = true
-        else
-          config['limits']['enabled'] = false
+      config['limits'] ||= {}
+      if self.limits.enabled
+        config['limits']['enabled'] = true
+      elsif self.limits.values || (self.state_colors && self.state_colors.length > 0)
+        # Only set to false if there are limits or state colors
+        # to avoid items without limits acting like they can be enabled
+        config['limits']['enabled'] = false
+      end
+      if self.limits.values
+        # Only set these if there are limits.values because persistence_setting has a default
+        # and we don't want keys on the 'limits' hash if there aren't any limits
+        config['limits']['persistence_setting'] = self.limits.persistence_setting if self.limits.persistence_setting
+        config['limits']['response'] = self.limits.response.to_s if self.limits.response
+        self.limits.values.each do |limits_set, limits_values|
+          limits = {}
+          limits['red_low'] =  limits_values[0]
+          limits['yellow_low'] = limits_values[1]
+          limits['yellow_high'] = limits_values[2]
+          limits['red_high'] = limits_values[3]
+          limits['green_low'] = limits_values[4] if limits_values[4]
+          limits['green_high'] = limits_values[5] if limits_values[5]
+          config['limits'][limits_set] = limits
         end
-        if self.limits.values
-          config['limits'] ||= {}
-          config['limits']['persistence_setting'] = self.limits.persistence_setting
-          config['limits']['response'] = self.limits.response.to_s if self.limits.response
-          self.limits.values.each do |limits_set, limits_values|
-            limits = {}
-            limits['red_low'] =  limits_values[0]
-            limits['yellow_low'] = limits_values[1]
-            limits['yellow_high'] = limits_values[2]
-            limits['red_high'] = limits_values[3]
-            limits['green_low'] = limits_values[4] if limits_values[4]
-            limits['green_high'] = limits_values[5] if limits_values[5]
-            config['limits'][limits_set] = limits
-          end
-        end
-        config['limits_response'] = self.limits.response.as_json(*a) if self.limits.response
       end
 
       config['meta'] = @meta if @meta
-      if @variable_bit_size
-        config['variable_bit_size'] = @variable_bit_size
-      end
+      config['variable_bit_size'] = @variable_bit_size if @variable_bit_size
       config
     end
 

data/lib/openc3/packets/structure_item.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 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -141,7 +141,7 @@ module OpenC3
     end
 
     def key=(key)
-      raise ArgumentError, "key must be a String but is a #{name.class}" unless String === key
+      raise ArgumentError, "key must be a String but is a #{key.class}" unless String === key
       raise ArgumentError, "key must contain at least one character" if key.empty?
 
       @key = key

data/lib/openc3/script/script.rb

@@ -133,16 +133,6 @@ module OpenC3
       $disconnect = true
     end
 
-    # DEPRECATED
-    def play_wav_file(wav_filename)
-      # NOOP
-    end
-
-    # DEPRECATED
-    def status_bar(message)
-      # NOOP
-    end
-
     def ask_string(question, blank_or_default = false, password = false)
       answer = ''
       default = ''

data/lib/openc3/script/web_socket_api.rb

@@ -240,7 +240,7 @@ module OpenC3
     end
   end
 
-  # Autonomic Events WebSocket
+  # Autonomic Events WebSocket (Enterprise Only)
   class AutonomicEventsWebSocketApi < CmdTlmWebSocketApi
     def initialize(history_count: 0, url: nil, write_timeout: 10.0, read_timeout: 10.0, connect_timeout: 5.0, authentication: nil, scope: $openc3_scope)
       @identifier = {
@@ -251,7 +251,7 @@ module OpenC3
     end
   end
 
-  # Calendar Events WebSocket
+  # Calendar Events WebSocket (Enterprise Only)
   class CalendarEventsWebSocketApi < CmdTlmWebSocketApi
     def initialize(history_count: 0, url: nil, write_timeout: 10.0, read_timeout: 10.0, connect_timeout: 5.0, authentication: nil, scope: $openc3_scope)
       @identifier = {

data/lib/openc3/streams/mqtt_stream.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2023 OpenC3, Inc.
+# Copyright 2024 OpenC3, Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -33,7 +33,7 @@ module OpenC3
     attr_accessor :key
     attr_accessor :ca_file
 
-    def initialize(hostname, port = 1883, ssl = false, write_topic = nil, read_topic = nil)
+    def initialize(hostname, port = 1883, ssl = false, write_topic = nil, read_topic = nil, ack_timeout = 5)
       super()
 
       @hostname = hostname
@@ -41,7 +41,7 @@ module OpenC3
       @ssl = ConfigParser.handle_true_false(ssl)
       @write_topic = ConfigParser.handle_nil(write_topic)
       @read_topic = ConfigParser.handle_nil(read_topic)
-      @connected = false
+      @ack_timeout = Float(ack_timeout)
 
       @username = nil
       @password = nil
@@ -49,11 +49,47 @@ module OpenC3
       @key = nil
       @ca_file = nil
 
-      # Mutex on write is needed to protect from commands coming in from more
-      # than one tool
+      # Mutex on write is needed to protect from commands coming in from more than one tool
       @write_mutex = Mutex.new
     end
 
+    # Connect the stream
+    def connect
+      @client = MQTT::Client.new
+      @client.ack_timeout = @ack_timeout
+      @client.host = @hostname
+      @client.port = @port
+      @client.ssl = @ssl
+      @client.username = @username if @username
+      @client.password = @password if @password
+      if @cert and @key
+        @client.ssl = true
+        @client.cert_file = @cert.path
+        @client.key_file = @key.path
+      end
+      if @ca_file
+        @client.ssl = true
+        @client.ca_file = @ca_file.path
+      end
+      @client.connect
+      @client.subscribe(@read_topic) if @read_topic
+    end
+
+    def connected?
+      if @client
+        return @client.connected?
+      else
+        return false
+      end
+    end
+
+    def disconnect
+      if @client
+        @client.disconnect
+        @client = nil
+      end
+    end
+
     # @return [String] Returns a binary string of data from the read_topic
     def read
       raise "Attempt to read from write only stream" unless @read_topic
@@ -77,33 +113,5 @@ module OpenC3
         @client.publish(@write_topic, data)
       end
     end
-
-    # Connect the stream
-    def connect
-      @client = MQTT::Client.new
-      @client.host = @hostname
-      @client.port = @port
-      @client.ssl = @ssl
-      @client.username = @username if @username
-      @client.password = @password if @password
-      @client.cert = @cert if @cert
-      @client.key = @key if @key
-      @client.ca_file = @ca_file.path if @ca_file
-      @client.connect
-      @client.subscribe(@read_topic) if @read_topic
-      @connected = true
-    end
-
-    def connected?
-      @connected
-    end
-
-    def disconnect
-      if @connected
-        @client.disconnect
-        @client = nil
-        @connected = false
-      end
-    end
   end
 end

data/lib/openc3/streams/serial_stream.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 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -115,31 +115,6 @@ module OpenC3
       @write_mutex = Mutex.new
     end
 
-    # @return [String] Returns a binary string of data from the serial port
-    def read
-      raise "Attempt to read from write only stream" unless @read_serial_port
-
-      # No read mutex is needed because reads happen serially
-      @read_serial_port.read
-    end
-
-    # @return [String] Returns a binary string of data from the serial port without blocking
-    def read_nonblock
-      raise "Attempt to read from write only stream" unless @read_serial_port
-
-      # No read mutex is needed because reads happen serially
-      @read_serial_port.read_nonblock
-    end
-
-    # @param data [String] A binary string of data to write to the serial port
-    def write(data)
-      raise "Attempt to write to read only stream" unless @write_serial_port
-
-      @write_mutex.synchronize do
-        @write_serial_port.write(data)
-      end
-    end
-
     # Connect the stream
     def connect
       # N/A - Serial streams 'connect' on creation
@@ -168,5 +143,30 @@ module OpenC3
         @connected = false
       end
     end
-  end # class SerialStream
+
+    # @return [String] Returns a binary string of data from the serial port
+    def read
+      raise "Attempt to read from write only stream" unless @read_serial_port
+
+      # No read mutex is needed because reads happen serially
+      @read_serial_port.read
+    end
+
+    # @return [String] Returns a binary string of data from the serial port without blocking
+    def read_nonblock
+      raise "Attempt to read from write only stream" unless @read_serial_port
+
+      # No read mutex is needed because reads happen serially
+      @read_serial_port.read_nonblock
+    end
+
+    # @param data [String] A binary string of data to write to the serial port
+    def write(data)
+      raise "Attempt to write to read only stream" unless @write_serial_port
+
+      @write_mutex.synchronize do
+        @write_serial_port.write(data)
+      end
+    end
+  end
 end

data/lib/openc3/streams/stream.rb

@@ -27,6 +27,22 @@ module OpenC3
   # allows Streams to simply focus on getting and sending raw data while the
   # higher level processing occurs in {Protocol}.
   class Stream
+    # Connects the stream
+    def connect
+      raise "connect not defined by Stream"
+    end
+
+    # @return [Boolean] true if connected or false otherwise
+    def connected?
+      raise "connected? not defined by Stream"
+    end
+
+    # Disconnects the stream
+    # Note that streams are not designed to be reconnected and must be recreated
+    def disconnect
+      raise "disconnect not defined by Stream"
+    end
+
     # Expected to return any amount of data on success, or a blank string on
     # closed/EOF, and may raise Timeout::Error, or other errors
     def read
@@ -46,21 +62,5 @@ module OpenC3
     def write(data)
       raise "write not defined by Stream"
     end
-
-    # Connects the stream
-    def connect
-      raise "connect not defined by Stream"
-    end
-
-    # @return [Boolean] true if connected or false otherwise
-    def connected?
-      raise "connected? not defined by Stream"
-    end
-
-    # Disconnects the stream
-    # Note that streams are not designed to be reconnected and must be recreated
-    def disconnect
-      raise "disconnect not defined by Stream"
-    end
-  end # class Stream
+  end
 end

data/lib/openc3/streams/tcpip_client_stream.rb

@@ -118,5 +118,5 @@ module OpenC3
     rescue IOError, Errno::ENOTSOCK
       raise "Connect canceled"
     end
-  end # class TcpipClientStream
+  end
 end

data/lib/openc3/streams/tcpip_socket_stream.rb

@@ -58,6 +58,25 @@ module OpenC3
       @connected = false
     end
 
+    # Connect the stream
+    def connect
+      # If called directly this class is acting as a server and does not need to connect the sockets
+      @connected = true
+    end
+
+    # @return [Boolean] Whether the sockets are connected
+    def connected?
+      @connected
+    end
+
+    # Disconnect by closing the sockets
+    def disconnect
+      OpenC3.close_socket(@write_socket)
+      OpenC3.close_socket(@read_socket)
+      @pipe_writer.write('.')
+      @connected = false
+    end
+
     # @return [String] Returns a binary string of data from the socket
     def read
       raise "Attempt to read from write only stream" unless @read_socket
@@ -142,25 +161,6 @@ module OpenC3
       end
     end
 
-    # Connect the stream
-    def connect
-      # If called directly this class is acting as a server and does not need to connect the sockets
-      @connected = true
-    end
-
-    # @return [Boolean] Whether the sockets are connected
-    def connected?
-      @connected
-    end
-
-    # Disconnect by closing the sockets
-    def disconnect
-      OpenC3.close_socket(@write_socket)
-      OpenC3.close_socket(@read_socket)
-      @pipe_writer.write('.')
-      @connected = false
-    end
-
     def set_option(option_name, option_values)
       option_name_upcase = option_name.upcase
 

data/lib/openc3/system/system.rb

@@ -89,7 +89,7 @@ module OpenC3
         FileUtils.mkdir_p("#{base_dir}/targets")
         bucket = Bucket.getClient()
         target_names.each do |target_name|
-          # Retrieve bucket/targets/target_name/target_id.zip
+          # Retrieve bucket/targets/target_name/<TARGET>_current.zip
           zip_path = "#{base_dir}/targets/#{target_name}_current.zip"
           FileUtils.mkdir_p(File.dirname(zip_path))
           bucket_key = "#{scope}/target_archives/#{target_name}/#{target_name}_current.zip"

data/lib/openc3/system.rb

@@ -14,14 +14,13 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, 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.
 
 module OpenC3
   autoload(:Target, "openc3/system/target.rb")
   autoload(:System, "openc3/system/system.rb")
-  autoload(:SystemConfig, "openc3/system/system_config.rb")
 end

data/lib/openc3/tools/table_manager/table.rb

@@ -14,10 +14,10 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, 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/packets/packet'

data/lib/openc3/tools/table_manager/table_parser.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 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license

data/lib/openc3/top_level.rb

@@ -465,11 +465,6 @@ module OpenC3
     raise $!, msg, $!.backtrace
   end
 
-  # @param filename [String] Name of the file to open in the web browser
-  def self.open_in_web_browser(_filename)
-    puts "open_in_web_browser is DEPRECATED"
-  end
-
   # Temporarily set the working directory during a block
   # Working directory is global, so this can make other threads wait
   # Ruby Dir.chdir with block always throws an error if multiple threads

data/lib/openc3/topics/command_decom_topic.rb

@@ -47,13 +47,6 @@ module OpenC3
     def self.get_cmd_item(target_name, packet_name, param_name, type: :WITH_UNITS, scope: $openc3_scope)
       msg_id, msg_hash = Topic.get_newest_message("#{scope}__DECOMCMD__{#{target_name}}__#{packet_name}")
       if msg_id
-        # TODO: We now have these reserved items directly on command packets
-        # Do we still calculate from msg_hash['time'] or use the times directly?
-        #
-        # if param_name == 'RECEIVED_TIMESECONDS' || param_name == 'PACKET_TIMESECONDS'
-        #   Time.from_nsec_from_epoch(msg_hash['time'].to_i).to_f
-        # elsif param_name == 'RECEIVED_TIMEFORMATTED' || param_name == 'PACKET_TIMEFORMATTED'
-        #   Time.from_nsec_from_epoch(msg_hash['time'].to_i).formatted
         if param_name == 'RECEIVED_COUNT'
           msg_hash['received_count'].to_i
         else

data/lib/openc3/utilities/bucket_utilities.rb

@@ -123,7 +123,7 @@ module OpenC3
     def self.get_cache_control(filename)
       # Allow caching for files that have a filename versioning strategy
       has_version_number = /(-|_|\.)\d+(-|_|\.)\d+(-|_|\.)\d+\./.match(filename)
-      has_content_hash = /\.[a-f0-9]{20}\./.match(filename)
+      has_content_hash = /[\.-][a-f0-9]{20}\./.match(filename)
       return nil if has_version_number or has_content_hash
       return 'no-store'
     end

data/lib/openc3/utilities/cli_generator.rb

@@ -281,7 +281,6 @@ module OpenC3
 
       # Add this tool to plugin.txt
       js_file = 'main.js'
-      js_file = 'js/app.js' if tool_type == 'tool_vue'
       File.open("plugin.txt", 'a') do |file|
         file.puts <<~DOC
 

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.20.0'
+OPENC3_VERSION = '6.0.0'
 module OpenC3
   module Version
-    MAJOR = '5'
-    MINOR = '20'
+    MAJOR = '6'
+    MINOR = '0'
     PATCH = '0'
     OTHER = ''
-    BUILD = 'a9fc89b5317151fc339e62d33b40ddef19830fdc'
+    BUILD = '8aad1e8cd4d45e7e207dbe6f61f892e38857b4ed'
   end
-  VERSION = '5.20.0'
-  GEM_VERSION = '5.20.0'
+  VERSION = '6.0.0'
+  GEM_VERSION = '6.0.0'
 end

data/templates/plugin/README.md

@@ -42,7 +42,7 @@ docker run -it -v %cd%:/openc3/local -w /openc3/local docker.io/openc3inc/openc3
 ## Installing into OpenC3 COSMOS
 
 1. Go to the OpenC3 Admin Tool, Plugins Tab
-1. Click the paperclip icon and choose your plugin.gem file
+1. Click the install button and choose your plugin.gem file
 1. Fill out plugin parameters
 1. Click Install
 

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

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

data/templates/tool_angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "5.20.0",
+  "version": "6.0.0",
   "scripts": {
     "ng": "ng",
     "start": "ng serve",
@@ -18,20 +18,20 @@
     "@angular/compiler": "^18.2.6",
     "@angular/core": "^18.2.6",
     "@angular/forms": "^18.2.6",
-    "@angular/material": "18.2.10",
+    "@angular/material": "^18.2.10",
     "@angular/platform-browser": "^18.2.6",
     "@angular/platform-browser-dynamic": "^18.2.6",
     "@angular/router": "^18.2.6",
-    "@astrouxds/astro-web-components": "7.24.0",
-    "@openc3/tool-common": "5.20.0",
+    "@astrouxds/astro-web-components": "^7.24.0",
+    "@openc3/js-common": "6.0.0",
     "rxjs": "~7.8.0",
-    "single-spa": "5.9.5",
+    "single-spa": "^5.9.5",
     "single-spa-angular": "^9.2.0",
     "tslib": "^2.7.0",
-    "zone.js": "~0.15.0"
+    "zone.js": "^0.13.0"
   },
   "devDependencies": {
-    "@angular-builders/custom-webpack": "18.0.0",
+    "@angular-builders/custom-webpack": "^18.0.0",
     "@angular-devkit/build-angular": "^18.2.6",
     "@angular/cli": "~18.2.6",
     "@angular/compiler-cli": "^18.2.6",
@@ -43,6 +43,6 @@
     "karma-jasmine": "~5.1.0",
     "karma-jasmine-html-reporter": "~2.1.0",
     "style-loader": "^4.0.0",
-    "typescript": "~5.6.2"
+    "typescript": "~5.5.4"
   }
 }

data/templates/tool_angular/src/app/app.component.html

@@ -1,13 +1,4 @@
-<!-- This menu position hack should only be necessary in the portal -->
 <style>
-::ng-deep .mat-mdc-menu-panel.myMenu {
-  background-color:white;
-  color:black;
-  position:absolute !important;
-  top:0px;
-  left:60px;
-}
-
 .mat-mdc-card {
   background: white;
 }
@@ -20,11 +11,11 @@
   </mat-card>
 
   <ng-template cdk-portal>
-    <button mat-raised-button [matMenuTriggerFor]="menu">File</button>
-    <mat-menu #menu="matMenu" class="myMenu">
-      <button mat-menu-item (click)="clickHandler()">Send Command</button>
+    <div style="display: inline-block; width: 80%; text-align: center; font-size: 32px"><%= tool_name_display %></div>
+    <button mat-raised-button [matMenuTriggerFor]="menu" style="background-color: rgb(33, 150, 243)">File</button>
+    <mat-menu #menu="matMenu" class="myMenu" style="background-color: white">
+      <button mat-menu-item (click)="clickHandler()" style="background-color: rgb(33, 150, 243)">Send Command</button>
     </mat-menu>
-    <div style="display: inline-block; width: 80%; text-align: center"><%= tool_name_display %></div>
   </ng-template>
 </div>