openc3 5.5.0.pre.beta0 → 5.5.1

data/templates/conversion/conversion.rb

@@ -0,0 +1,43 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 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/conversions/conversion'
+
+module OpenC3
+  # Custom conversion class
+  # See https://openc3.com/docs/v5/telemetry#read_conversion
+  class <%= conversion_class %> < Conversion
+    def initialize
+      super()
+      # Should be one of :INT, :UINT, :FLOAT, :STRING, :BLOCK
+      @converted_type = :STRING
+      # Size of the converted type in bits
+      # Use 0 for :STRING or :BLOCK where the size can be variable
+      @converted_bit_size = 0
+    end
+
+    # @param value [Object] Value based on the item definition. This could be
+    #   a string, integer, float, or array of values.
+    # @param packet [Packet] The packet object where the conversion is defined
+    # @param buffer [String] The raw packet buffer
+    def call(value, packet, buffer)
+      # Typically perform conversion logic directly on value
+      # e.g. value.upcase()
+    end
+  end
+end

data/templates/limits_response/response.rb

@@ -0,0 +1,51 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 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/packets/limits_response'
+
+module OpenC3
+  class <%= response_class %> < LimitsResponse
+    # @param packet [Packet] Packet the limits response is assigned to
+    # @param item [PacketItem] PacketItem the limits response is assigned to
+    # @param old_limits_state [Symbol] Previous value of the limit. One of nil,
+    #   :GREEN_HIGH, :GREEN_LOW, :YELLOW, :YELLOW_HIGH, :YELLOW_LOW,
+    #   :RED, :RED_HIGH, :RED_LOW. nil if the previous limit state has not yet
+    #   been established.
+    def call(packet, item, old_limits_state)
+      # Take action based on the current limits state
+      # Delete any of the 'when' lines that do not apply or you don't care about
+      case item.limits.state
+      when :RED_HIGH
+        # Take action like sending a command:
+        # cmd('TARGET SAFE')
+      when :RED_LOW
+      when :YELLOW_LOW
+      when :YELLOW_HIGH
+      # GREEN limits are only available if a telemetry item has them defined
+      # COSMOS refers to these as "operational limits"
+      # See https://openc3.com/docs/v5/telemetry#limits
+      when :GREEN_LOW
+      when :GREEN_HIGH
+      # :RED and :YELLOW limits are triggered for STATES with defined RED and YELLOW states
+      # See https://openc3.com/docs/v5/telemetry#state
+      when :RED
+      when :YELLOW
+      end
+    end
+  end
+end

data/templates/microservice/microservices/TEMPLATE/microservice.rb

@@ -0,0 +1,62 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+require 'openc3/microservices/microservice'
+require 'openc3/api/api'
+
+module OpenC3
+  class <%= microservice_class %> < Microservice
+    include Api # Provides access to api methods
+
+    def initialize(name)
+      super(name)
+      @config['options'].each do |option|
+        # Update with your own OPTION handling
+        case option[0].upcase
+        when 'PERIOD'
+          @period = option[1].to_i
+        else
+          @logger.error("Unknown option passed to microservice #{@name}: #{option}")
+        end
+      end
+
+      @period = 60 unless @period # 1 minutes
+      @sleeper = Sleeper.new
+    end
+
+    def run
+      while true
+        start_time = Time.now
+        break if @cancel_thread
+
+        # Do your microservice work here
+        Logger.info("Template Microservice ran")
+        # cmd("INST ABORT")
+
+        # The @state variable is set to 'RUNNING' by the microservice base class
+        # The @state is reflected to the user in the MICROSERVICES tab so you can
+        # convey long running actions by changing it, e.g. @state = 'CALCULATING ...'
+
+        run_time = Time.now - start_time
+        delta = @period - run_time
+        if delta > 0
+          # Delay till the next period
+          break if @sleeper.sleep(delta) # returns true and breaks loop on shutdown
+        end
+        @count += 1
+      end
+    end
+
+    def shutdown
+      @sleeper.cancel # Breaks out of run()
+      super()
+    end
+  end
+end
+
+OpenC3::<%= microservice_class %>.run if __FILE__ == $0

data/templates/plugin/plugin.txt

@@ -0,0 +1 @@
+# Set VARIABLEs here to allow variation in your plugin

data/templates/{plugin-template → target}/targets/TARGET/screens/status.txt

@@ -2,8 +2,7 @@ SCREEN AUTO AUTO 1.0
 
 TITLE "Status"
 
-VERTICALBOX
-  SECTIONHEADER "Information"
+VERTICALBOX "Information"
   LABELVALUE <%= target_name %> STATUS VALUE
   LABELVALUE <%= target_name %> STATUS BOOL
 END

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 5.5.0.pre.beta0
+  version: 5.5.1
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2023-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -692,6 +692,8 @@ files:
 - bin/openc3cli
 - bin/rubysloc
 - data/config/_array_params.yaml
+- data/config/_canvas_values.yaml
+- data/config/_graph_params.yaml
 - data/config/_id_items.yaml
 - data/config/_id_params.yaml
 - data/config/_interfaces.yaml
@@ -700,6 +702,7 @@ files:
 - data/config/command.yaml
 - data/config/command_modifiers.yaml
 - data/config/command_telemetry.yaml
+- data/config/graph_settings.yaml
 - data/config/interface_modifiers.yaml
 - data/config/item_modifiers.yaml
 - data/config/microservice.yaml
@@ -708,6 +711,7 @@ files:
 - data/config/plugins.yaml
 - data/config/protocols.yaml
 - data/config/screen.yaml
+- data/config/settings.yaml
 - data/config/table_manager.yaml
 - data/config/table_parameter_modifiers.yaml
 - data/config/target.yaml
@@ -899,7 +903,6 @@ files:
 - lib/openc3/models/timeline_model.rb
 - lib/openc3/models/tool_config_model.rb
 - lib/openc3/models/tool_model.rb
-- lib/openc3/models/traefik_model.rb
 - lib/openc3/models/trigger_group_model.rb
 - lib/openc3/models/trigger_model.rb
 - lib/openc3/models/widget_model.rb
@@ -985,6 +988,7 @@ files:
 - lib/openc3/utilities/bucket.rb
 - lib/openc3/utilities/bucket_file_cache.rb
 - lib/openc3/utilities/bucket_utilities.rb
+- lib/openc3/utilities/cli_generator.rb
 - lib/openc3/utilities/crc.rb
 - lib/openc3/utilities/csv.rb
 - lib/openc3/utilities/local_bucket.rb
@@ -1012,17 +1016,20 @@ files:
 - lib/openc3/win32/win32_main.rb
 - tasks/gemfile_stats.rake
 - tasks/spec.rake
-- templates/plugin-template/LICENSE.txt
-- templates/plugin-template/README.md
-- templates/plugin-template/Rakefile
-- templates/plugin-template/plugin.gemspec
-- templates/plugin-template/plugin.txt
-- templates/plugin-template/targets/TARGET/cmd_tlm/cmd.txt
-- templates/plugin-template/targets/TARGET/cmd_tlm/tlm.txt
-- templates/plugin-template/targets/TARGET/lib/target.rb
-- templates/plugin-template/targets/TARGET/procedures/procedure.rb
-- templates/plugin-template/targets/TARGET/screens/status.txt
-- templates/plugin-template/targets/TARGET/target.txt
+- templates/conversion/conversion.rb
+- templates/limits_response/response.rb
+- templates/microservice/microservices/TEMPLATE/microservice.rb
+- templates/plugin/LICENSE.txt
+- templates/plugin/README.md
+- templates/plugin/Rakefile
+- templates/plugin/plugin.gemspec
+- templates/plugin/plugin.txt
+- templates/target/targets/TARGET/cmd_tlm/cmd.txt
+- templates/target/targets/TARGET/cmd_tlm/tlm.txt
+- templates/target/targets/TARGET/lib/target.rb
+- templates/target/targets/TARGET/procedures/procedure.rb
+- templates/target/targets/TARGET/screens/status.txt
+- templates/target/targets/TARGET/target.txt
 homepage: https://github.com/OpenC3/openc3
 licenses:
 - AGPL-3.0-only
@@ -1041,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: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.14
 signing_key:

data/lib/openc3/models/traefik_model.rb

@@ -1,47 +0,0 @@
-# encoding: ascii-8bit
-
-# Copyright 2023 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/utilities/store'
-
-module OpenC3
-  class TraefikModel
-    def self.register_route(microservice_name:, port:, prefix:, priority: 20)
-      prefix = '/' + prefix unless prefix[0] == '/'
-      if ENV['KUBERNETES_SERVICE_HOST']
-        url = "http://#{microservice_name.gsub('__', '-')}:#{port}"
-      else
-        url = "http://openc3-operator:#{port}"
-      end
-      service_name = microservice_name
-      router_name = microservice_name
-      Store.set("traefik/http/services/#{service_name}/loadbalancer/servers/0/url", url)
-      Store.set("traefik/http/routers/#{router_name}/service", service_name)
-      Store.set("traefik/http/routers/#{router_name}/priority", priority)
-      Store.set("traefik/http/routers/#{router_name}/rule", "PathPrefix(`#{prefix}`)")
-    end
-
-    def self.unregister_route(microservice_name:)
-      service_name = microservice_name
-      router_name = microservice_name
-      Store.del("traefik/http/routers/#{router_name}/rule")
-      Store.del("traefik/http/routers/#{router_name}/priority")
-      Store.del("traefik/http/routers/#{router_name}/service")
-      Store.del("traefik/http/services/#{service_name}/loadbalancer/servers/0/url")
-    end
-  end
-end

data/templates/plugin-template/plugin.txt

@@ -1,9 +0,0 @@
-# Set VARIABLEs here to allow variation in your plugin
-# See https://openc3.com/docs/v5/plugins for more information
-VARIABLE <%= target_name.downcase %>_target_name <%= target_name %>
-
-# Modify this according to your actual target connection
-# See https://openc3.com/docs/v5/interfaces for more information
-TARGET <%= target_name %> <%%= <%= target_name.downcase %>_target_name %>
-INTERFACE <%%= <%= target_name.downcase %>_target_name %>_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
-  MAP_TARGET <%%= <%= target_name.downcase %>_target_name %>