openc3 5.0.6

data/lib/openc3/script/calendar.rb

@@ -0,0 +1,89 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# 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.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+require 'openc3/script/extract'
+require 'time'
+
+module OpenC3
+  module Script
+    include Extract
+
+    private
+
+    # Gets the current metadata
+    #
+    # @return The result of the method call.
+    def get_metadata(scope: $openc3_scope)
+      response = $api_server.request('get', "/openc3-api/metadata/latest", scope: scope)
+      # Non-existant just returns nil
+      return nil if response.nil? || response.code != 200
+      return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+    end
+
+    # Sets the metadata
+    #
+    # @param metadata [Hash<Symbol, Variable>] A hash of metadata
+    # @param color [String] Events color to show on Calendar tool, if nil will be blue
+    # @param start [Time] Metadata time value, if nil will be current time
+    # @return The result of the method call.
+    def set_metadata(metadata, color: nil, start: nil, scope: $openc3_scope)
+      unless metadata.is_a?(Hash)
+        raise "metadata must be a Hash: #{metadata} is a #{metadata.class}"
+      end
+      color = color.nil? ? '#003784' : color
+      data = { color: color, metadata: metadata }
+      data[:start] = start.iso8601 unless start.nil?
+      response = $api_server.request('post', '/openc3-api/metadata', data: data, json: true, scope: scope)
+      if response.nil? || response.code != 201
+        raise "Failed to set_metadata"
+      end
+      return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+    end
+
+    # Updates the metadata
+    #
+    # @param metadata [Hash<Symbol, Variable>] A hash of metadata
+    # @param color [String] Events color to show on Calendar tool, if nil will be blue
+    # @param start [Integer] Metadata time value as integer seconds from epoch
+    # @return The result of the method call.
+    def update_metadata(metadata, color: nil, start: nil, scope: $openc3_scope)
+      unless metadata.is_a?(Hash)
+        raise "metadata must be a Hash: #{metadata} is a #{metadata.class}"
+      end
+      color = color.nil? ? '#003784' : color
+      if start == nil
+        existing = get_metadata()
+        start = existing['start']
+        metadata = existing['metadata'].merge(metadata)
+      end
+      data = { :color => color, :metadata => metadata }
+      data[:start] = Time.at(start).iso8601
+      response = $api_server.request('put', "/openc3-api/metadata/#{start}", data: data, json: true, scope: scope)
+      if response.nil? || response.code != 200
+        raise "Failed to update_metadata"
+      end
+      return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+    end
+
+    # Requests the metadata from the user for a target
+    def input_metadata(*args, **kwargs)
+      raise StandardError "can only be used in Script Runner"
+    end
+  end
+end

data/lib/openc3/script/commands.rb

@@ -0,0 +1,227 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# 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.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+require 'openc3/packets/packet'
+require 'openc3/script/extract'
+
+module OpenC3
+  module Script
+    include Extract
+
+    private
+
+    # Format the command like it appears in a script
+    # TODO: Make this output alternative syntax if any binary data
+    def _cmd_string(target_name, cmd_name, cmd_params, raw, scope: $openc3_scope)
+      output_string = $disconnect ? 'DISCONNECT: ' : ''
+      if raw
+        output_string += 'cmd_raw("'
+      else
+        output_string += 'cmd("'
+      end
+      output_string += target_name + ' ' + cmd_name
+      if cmd_params.nil? or cmd_params.empty?
+        output_string << '")'
+      else
+        params = []
+        cmd_params.each do |key, value|
+          next if Packet::RESERVED_ITEM_NAMES.include?(key)
+
+          if value.is_a?(String)
+            value = value.convert_to_value.to_s
+            if value.length > 256
+              value = value[0..255] + "...'"
+            end
+            if !value.is_printable?
+              value = "BINARY"
+            end
+            value.tr!('"', "'")
+          elsif value.is_a?(Array)
+            value = "[#{value.join(", ")}]"
+          end
+          params << "#{key} #{value}"
+        end
+        params = params.join(", ")
+        output_string += ' with ' + params + '")'
+      end
+      output_string
+    end
+
+    # Log any warnings about disabling checks and log the command itself
+    # NOTE: This is a helper method and should not be called directly
+    def _log_cmd(target_name, cmd_name, cmd_params, raw, no_range, no_hazardous, scope: $openc3_scope)
+      if no_range
+        Logger.warn "Command #{target_name} #{cmd_name} being sent ignoring range checks"
+      end
+      if no_hazardous
+        Logger.warn "Command #{target_name} #{cmd_name} being sent ignoring hazardous warnings"
+      end
+      Logger.info _cmd_string(target_name, cmd_name, cmd_params, raw)
+    end
+
+    def _cmd_disconnect(cmd, raw, no_range, no_hazardous, *args, scope: $openc3_scope)
+      case args.length
+      when 1
+        target_name, cmd_name, cmd_params = extract_fields_from_cmd_text(args[0])
+      when 2, 3
+        target_name = args[0]
+        cmd_name    = args[1]
+        if args.length == 2
+          cmd_params = {}
+        else
+          cmd_params = args[2]
+        end
+      else
+        # Invalid number of arguments
+        raise "ERROR: Invalid number of arguments (#{args.length}) passed to #{cmd}()"
+      end
+      # Get the command and validate the parameters
+      command = $api_server.get_command(target_name, cmd_name, scope: scope)
+      cmd_params.each do |param_name, param_value|
+        param = command['items'].find { |item| item['name'] == param_name }
+        unless param
+          raise "Packet item '#{target_name} #{cmd_name} #{param_name}' does not exist"
+        end
+      end
+      _log_cmd(target_name, cmd_name, cmd_params, raw, no_range, no_hazardous)
+    end
+
+    # Send the command and log the results
+    # NOTE: This is a helper method and should not be called directly
+    def _cmd(cmd, cmd_no_hazardous, *args, **kw_args)
+      if kw_args[:scope]
+        scope = kw_args[:scope]
+        kw_args.delete(:scope)
+      else
+        scope = $openc3_scope
+      end
+      args << kw_args if kw_args.length > 0
+
+      raw = cmd.include?('raw')
+      no_range = cmd.include?('no_range') || cmd.include?('no_checks')
+      no_hazardous = cmd.include?('no_hazardous') || cmd.include?('no_checks')
+
+      if $disconnect
+        _cmd_disconnect(cmd, raw, no_range, no_hazardous, *args, scope: scope)
+      else
+        begin
+          target_name, cmd_name, cmd_params = $api_server.method_missing(cmd, *args, scope: scope)
+          _log_cmd(target_name, cmd_name, cmd_params, raw, no_range, no_hazardous, scope: scope)
+        rescue HazardousError => e
+          # This opens a prompt at which point they can cancel and stop the script
+          # or say Yes and send the command. Thus we don't care about the return value.
+          prompt_for_hazardous(e.target_name, e.cmd_name, e.hazardous_description)
+          target_name, cmd_name, cmd_params = $api_server.method_missing(cmd_no_hazardous, *args, scope: scope)
+          _log_cmd(target_name, cmd_name, cmd_params, raw, no_range, no_hazardous, scope: scope)
+        end
+      end
+    end
+
+    # Send a command to the specified target
+    # Usage:
+    #   cmd(target_name, cmd_name, cmd_params = {})
+    # or
+    #   cmd('target_name cmd_name with cmd_param1 value1, cmd_param2 value2')
+    def cmd(*args, **kw_args)
+      _cmd('cmd', 'cmd_no_hazardous_check', *args, **kw_args)
+    end
+
+    # Send a command to the specified target without range checking parameters
+    # Usage:
+    #   cmd_no_range_check(target_name, cmd_name, cmd_params = {})
+    # or
+    #   cmd_no_range_check('target_name cmd_name with cmd_param1 value1, cmd_param2 value2')
+    def cmd_no_range_check(*args, **kw_args)
+      _cmd('cmd_no_range_check', 'cmd_no_checks', *args, **kw_args)
+    end
+
+    # Send a command to the specified target without hazardous checks
+    # Usage:
+    #   cmd_no_hazardous_check(target_name, cmd_name, cmd_params = {})
+    # or
+    #   cmd_no_hazardous_check('target_name cmd_name with cmd_param1 value1, cmd_param2 value2')
+    def cmd_no_hazardous_check(*args, **kw_args)
+      _cmd('cmd_no_hazardous_check', nil, *args, **kw_args)
+    end
+
+    # Send a command to the specified target without range checking or hazardous checks
+    # Usage:
+    #   cmd_no_checks(target_name, cmd_name, cmd_params = {})
+    # or
+    #   cmd_no_checks('target_name cmd_name with cmd_param1 value1, cmd_param2 value2')
+    def cmd_no_checks(*args, **kw_args)
+      _cmd('cmd_no_checks', nil, *args, **kw_args)
+    end
+
+    # Send a command to the specified target without running conversions
+    # Usage:
+    #   cmd_raw(target_name, cmd_name, cmd_params = {})
+    # or
+    #   cmd_raw('target_name cmd_name with cmd_param1 value1, cmd_param2 value2')
+    def cmd_raw(*args, **kw_args)
+      _cmd('cmd_raw', 'cmd_raw_no_hazardous_check', *args, **kw_args)
+    end
+
+    # Send a command to the specified target without range checking parameters or running conversions
+    # Usage:
+    #   cmd_raw_no_range_check(target_name, cmd_name, cmd_params = {})
+    # or
+    #   cmd_raw_no_range_check('target_name cmd_name with cmd_param1 value1, cmd_param2 value2')
+    def cmd_raw_no_range_check(*args, **kw_args)
+      _cmd('cmd_raw_no_range_check', 'cmd_raw_no_checks', *args, **kw_args)
+    end
+
+    # Send a command to the specified target without hazardous checks or running conversions
+    # Usage:
+    #   cmd_raw_no_hazardous_check(target_name, cmd_name, cmd_params = {})
+    # or
+    #   cmd_raw_no_hazardous_check('target_name cmd_name with cmd_param1 value1, cmd_param2 value2')
+    def cmd_raw_no_hazardous_check(*args, **kw_args)
+      _cmd('cmd_raw_no_hazardous_check', nil, *args, **kw_args)
+    end
+
+    # Send a command to the specified target without range checking or hazardous checks or running conversions
+    # Usage:
+    #   cmd_raw_no_checks(target_name, cmd_name, cmd_params = {})
+    # or
+    #   cmd_raw_no_checks('target_name cmd_name with cmd_param1 value1, cmd_param2 value2')
+    def cmd_raw_no_checks(*args, **kw_args)
+      _cmd('cmd_raw_no_checks', nil, *args, **kw_args)
+    end
+
+    # Sends raw data through an interface from a file
+    def send_raw_file(interface_name, filename, scope: $openc3_scope)
+      data = nil
+      File.open(filename, 'rb') { |file| data = file.read }
+      $api_server.send_raw(interface_name, data, scope: scope)
+    end
+
+    # Returns the time the most recent command was sent
+    def get_cmd_time(target_name = nil, command_name = nil, scope: $openc3_scope)
+      results = $api_server.get_cmd_time(target_name, command_name, scope: scope)
+      if Array === results
+        if results[2] and results[3]
+          results[2] = Time.at(results[2], results[3]).sys
+        end
+        results.delete_at(3)
+      end
+      results
+    end
+  end
+end

data/lib/openc3/script/exceptions.rb

@@ -0,0 +1,29 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# 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.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+module OpenC3
+  # Error raised by the API when a check fails
+  class CheckError < StandardError; end
+
+  # Error raised by the API when a script should be stopped
+  class StopScript < StandardError; end
+
+  # Error raised by the API when a case should be skipped
+  class SkipScript < StandardError; end
+end

data/lib/openc3/script/extract.rb

@@ -0,0 +1,161 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# 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.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+require 'openc3/utilities/store'
+
+module OpenC3
+  module Extract
+    SCANNING_REGULAR_EXPRESSION = %r{ (?:"(?:[^\\"]|\\.)*") | (?:'(?:[^\\']|\\.)*') | (?:\[(?:[^\\\[\]]|\\.)*\]) | \S+ }x # "
+
+    private
+
+    def add_cmd_parameter(keyword, value, packet, cmd_params)
+      quotes_removed = value.remove_quotes
+      if value == quotes_removed
+        type = nil
+        if packet['items']
+          packet['items'].each do |parameter|
+            if parameter['name'] == keyword
+              type = parameter['data_type']
+              break
+            end
+          end
+        end
+        if (type == 'STRING' or type == 'BLOCK') and value.upcase.start_with?("0X")
+          cmd_params[keyword] = value.hex_to_byte_string
+        else
+          cmd_params[keyword] = value.convert_to_value
+        end
+      else
+        cmd_params[keyword] = quotes_removed
+      end
+    end
+
+    def extract_fields_from_cmd_text(text, scope: $openc3_scope)
+      split_string = text.split(/\s+with\s+/i, 2)
+      raise "ERROR: text must not be empty" if split_string.length == 0
+      raise "ERROR: 'with' must be followed by parameters : #{text}" if (split_string.length == 1 and text =~ /\s*with\s*/i) or (split_string.length == 2 and split_string[1].empty?)
+
+      # Extract target_name and cmd_name
+      first_half = split_string[0].split
+      raise "ERROR: Both Target Name and Command Name must be given : #{text}" if first_half.length < 2
+      raise "ERROR: Only Target Name and Command Name must be given before 'with' : #{text}" if first_half.length > 2
+
+      target_name = first_half[0]
+      cmd_name = first_half[1]
+      cmd_params = {}
+
+      begin
+        # Returns the packet JSON representation
+        packet = TargetModel.packet(target_name, cmd_name, type: :CMD, scope: scope)
+      rescue
+        packet = {}
+      end
+
+      if split_string.length == 2
+        # Extract Command Parameters
+        second_half = split_string[1].scan(SCANNING_REGULAR_EXPRESSION)
+        keyword = nil
+        value = nil
+        comma = nil
+        second_half.each do |item|
+          unless keyword
+            keyword = item
+            next
+          end
+          unless value
+            if item[-1..-1] == ','
+              value = item[0..-2]
+              comma = true
+            else
+              value = item
+              next
+            end
+          end
+          unless comma
+            raise "Missing comma in command parameters: #{text}" if item != ','
+          end
+          add_cmd_parameter(keyword, value, packet, cmd_params)
+          keyword = nil
+          value = nil
+          comma = nil
+        end
+        if keyword
+          if value
+            add_cmd_parameter(keyword, value, packet, cmd_params)
+          else
+            raise "Missing value for last command parameter: #{text}"
+          end
+        end
+      end
+
+      return [target_name, cmd_name, cmd_params]
+    end
+
+    def extract_fields_from_tlm_text(text)
+      split_string = text.split
+      raise "ERROR: Telemetry Item must be specified as 'TargetName PacketName ItemName' : #{text}" if split_string.length != 3
+
+      target_name = split_string[0]
+      packet_name = split_string[1]
+      item_name = split_string[2]
+      return [target_name, packet_name, item_name]
+    end
+
+    def extract_fields_from_set_tlm_text(text)
+      error_msg = "ERROR: Set Telemetry Item must be specified as 'TargetName PacketName ItemName = Value' : #{text}"
+      # We have to handle these cases:
+      # set_tlm("TGT PKT ITEM='new item'")
+      # set_tlm("TGT PKT ITEM = 'new item'")
+      # set_tlm("TGT PKT ITEM= 'new item'")
+      # set_tlm("TGT PKT ITEM ='new item'")
+      split_string = text.split('=')
+      raise error_msg if split_string.length < 2 || split_string[1].strip.empty?
+
+      split_string = split_string[0].strip.split << split_string[1..-1].join('=').strip
+      raise error_msg if split_string.length != 4 # Ensure tgt,pkt,item,value
+
+      target_name = split_string[0]
+      packet_name = split_string[1]
+      item_name = split_string[2]
+      value = split_string[3].strip.convert_to_value
+      value = value.remove_quotes if String === value
+      return [target_name, packet_name, item_name, value]
+    end
+
+    def extract_fields_from_check_text(text)
+      split_string = text.split
+      raise "ERROR: Check improperly specified: #{text}" if split_string.length < 3
+
+      target_name = split_string[0]
+      packet_name = split_string[1]
+      item_name = split_string[2]
+      comparison_to_eval = nil
+      return [target_name, packet_name, item_name, comparison_to_eval] if split_string.length == 3
+      raise "ERROR: Check improperly specified: #{text}" if split_string.length < 4
+
+      split_string = text.split(/ /) # Split on regex spaces to preserve spaces in comparison
+      index = split_string.rindex(item_name)
+      comparison_to_eval = split_string[(index + 1)..(split_string.length - 1)].join(" ")
+      raise "ERROR: Use '==' instead of '=': #{text}" if split_string[3] == '='
+
+      return [target_name, packet_name, item_name, comparison_to_eval]
+    end
+  end
+end

data/lib/openc3/script/limits.rb

@@ -0,0 +1,60 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# 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.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+module OpenC3
+  module Script
+    private
+
+    # Define all the modification methods such that we can disconnect them
+    %i(enable_limits disable_limits set_limits enable_limits_group disable_limits_group set_limits_set).each do |method_name|
+      define_method(method_name) do |*args, **kw_args, &block|
+        kw_args[:scope] = $openc3_scope unless kw_args[:scope]
+        if $disconnect
+          Logger.info "DISCONNECT: #{method_name}(#{args}) ignored"
+        else
+          $api_server.public_send(method_name, *args, **kw_args, &block)
+        end
+      end
+    end
+
+    def get_limits_events(offset = nil, count: 100, scope: $openc3_scope)
+      result = $api_server.get_limits_events(offset, count: count, scope: scope)
+      if result
+        result[0] = result[0].to_s.intern
+        if result[0] == :LIMITS_CHANGE
+          result[1][3] = result[1][3].to_s.intern if result[1][3]
+          result[1][4] = result[1][4].to_s.intern if result[1][4]
+          if result[1][5] and result[1][6]
+            result[1][5] = Time.at(result[1][5], result[1][6]).sys
+            result[1].delete_at(6)
+          end
+        elsif result[0] == :LIMITS_SETTINGS
+          result[1][3] = result[1][3].to_s.intern if result[1][3]
+        elsif result[0] == :STALE_PACKET
+          # Nothing extra to do
+        elsif result[0] == :STALE_PACKET_RCVD
+          # Nothing extra to do
+        else
+          result[1] = result[1].to_s.intern
+        end
+      end
+      result
+    end
+  end
+end