openc3 5.17.1 → 5.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c70541c17780bda9cd1adb897963eb1daedfc459bc2637a511745180430e162
-  data.tar.gz: a6eb2e273a1bb9dd5d849b68e8910b7c8eaaca65cee41eed8bdb155891eec1db
+  metadata.gz: 65a5c8a4ee0645f9d129c7c6140b9e8863e61e035f5e0269a977e8cd7d722c15
+  data.tar.gz: a023d452a32050ab5d81a3edcdc8fccaf10eed1a81b481ef11d89c633d3f6cba
 SHA512:
-  metadata.gz: 60e677a6a9b13c7d94d4f32b70b824509e2c87cf691bebb9285b96c544318a8016f2f98b119c657de1cee77b0ec197301bd040962ec9055afe0cd0ae3228ad74
-  data.tar.gz: a8a9f67755a4768806f92134a42c50a44cd686a95ad55877f66fcc735ceb75741845ffe1e71aaa66f5ac5181cb929f999f808c86abc6a1b9408f44f122933892
+  metadata.gz: 3ecd41dc83eb1d9af0e847fcb61d8784bfce374c33681008030423f2d1b04c09b62200ec5ca7f878273e6aed704982aeb55fddad1b1ae5490367e5fe48ea844f
+  data.tar.gz: f121f92ac5c6101eb9e3d9ebe52b525235090dc964a7bf409ebf7a47b1bc1c52c7f5a97a7194f5238ade4cee31078cb5822b486954d87983c8fdf9294f557257

data/Gemfile

@@ -8,10 +8,13 @@ gemspec :name => 'openc3'
 
 # Include the rails gems for the convenience of custom microservice plugins
 gem 'bootsnap', '>= 1.9.3', require: false
-gem 'mock_redis', '0.44'
 gem 'rack-cors', '~> 2.0'
 gem 'rails', '~> 7.1.0'
-gem 'rspec-rails', '~> 6.0'
-gem 'simplecov', '~> 0.20'
-gem 'simplecov-cobertura', '~> 2.1'
 gem 'tzinfo-data'
+
+group :test, :development do
+  gem 'mock_redis', '0.45'
+  gem 'rspec-rails', '~> 7.0'
+  gem 'simplecov', '~> 0.20'
+  gem 'simplecov-cobertura', '~> 2.1'
+end

data/bin/cstol_converter

@@ -18,7 +18,7 @@
 # All changes Copyright 2022, 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.
 
 # This file converts OASIS CSTOL files to OpenC3 scripts
@@ -163,7 +163,7 @@ def parse_expression(vars, quoted = false, in_eval = false)
     when /(\+|-|\*|\/)/ # Arithmetic operator
       str = str + " " + vars[i].tr('[]"', '') + " "
 
-    # Verfies Number followed immediately by units
+    # Verifies Number followed immediately by units
     when /\dDN\z|\ddn\z|\dDEG\z|\ddeg\z|\dRAD\z|\drad\z|\dV\z|\dA\z|\dv\z|\da\z|\dc\z|\dC\z|\df\z|\dF\z|\dDPS\z|\dM\z|\dMPS\z|\dm\z|\dmps\z/ # Checks for decimal/degrees/volts and amps
       temp = vars[i].tr('[]"', '')
       temp = temp.gsub(/DN\z|dn\z|DEG\z|deg\z|RAD\z|rad\z|V\z|A\z|v\z|a\z|c\z|C\z|f\z|F\z|DPS\z|M\z|MPS\z|m\z|mps\z/, '')
@@ -190,7 +190,7 @@ def parse_expression(vars, quoted = false, in_eval = false)
       str = str + parse_time(vars[i].tr('[]"', ''))
 
     when /\dE/ # Floating point
-      temp_number = vars[i].tr('E', '').to_f * 10**vars[i + 2].to_f
+      temp_number = vars[i].tr('E', '').to_f * (10**vars[i + 2].to_f)
       str = str + "#{temp_number}"
       finished = true
     when /\d/ # Decimal number
@@ -279,7 +279,7 @@ def parse_id(id, quoted = false, in_eval = false, in_command = false, in_single_
   elsif id.match?(/\dE\+\d/) # Floating point
     id = id.gsub('+', ' + ')
     temp_num_arr = id.split(' ')
-    temp_number = temp_num_arr[0].tr('E', '').to_f * 10**temp_num_arr[2].to_f
+    temp_number = temp_num_arr[0].tr('E', '').to_f * (10**temp_num_arr[2].to_f)
     str = str + "#{temp_number}"
   elsif id.match(/\A\d/) or id.match(/\A-\d/) # starts with Decimal number
     str = id
@@ -332,7 +332,7 @@ def parse_time(time)
     end
 
     # Compute the number of seconds
-    secs = (3600 * tok[0].to_i + 60 * tok[1].to_i + tok[2].to_i).to_s
+    secs = ((3600 * tok[0].to_i) + (60 * tok[1].to_i) + tok[2].to_i).to_s
 
   # Other cases not handled
   else
@@ -341,7 +341,7 @@ def parse_time(time)
 end
 
 def parse_tlm_item(tlm)
-  # Remove preceeding parentheses
+  # Remove preceding parentheses
   if tlm[0].index("(") == 0
     tlm[0] = tlm[0][1..-1]
   end
@@ -371,7 +371,7 @@ def parse_line(full_line, loc_out_file, wait_check_flag = false)
     return
   end
 
-  # Detemine the location of any comments in this line
+  # Determine the location of any comments in this line
   commentIdx = full_line.index(";")
 
   # If we found a comment operator
@@ -653,7 +653,7 @@ def parse_line(full_line, loc_out_file, wait_check_flag = false)
     # TODO not sure if this is wise, for some files the loop is infinite and
     # there's no exist case
     if words[1] == nil
-      str = str + "# TODO Possible inifinite loop case check script file" +
+      str = str + "# TODO Possible infinite loop case check script file" +
             "\n" + str + "while(true)"
     else
       str = str + words[1] + ".times do |i|"
@@ -694,7 +694,7 @@ def parse_line(full_line, loc_out_file, wait_check_flag = false)
       # Print the function name and the first argument
       str = str + "def " + words[1].downcase + "(" + parse_id(listWords[0])
 
-      # Print the remaining arguments preceeded by a separator
+      # Print the remaining arguments preceded by a separator
       (listWords.length - 1).times do |i|
         str = str + ", " + parse_id(listWords[i + 1])
       end
@@ -759,7 +759,7 @@ def parse_line(full_line, loc_out_file, wait_check_flag = false)
       # Print the function name and the first argument
       str = str + words[1].downcase + "(" + parse_id(listWords[0])
 
-      # Print the remaining arguments preceeded by a separator
+      # Print the remaining arguments preceded by a separator
       (listWords.length - 1).times do |i|
         str = str + ", " + parse_id(listWords[i + 1])
       end
@@ -783,7 +783,7 @@ def parse_line(full_line, loc_out_file, wait_check_flag = false)
     str = str + "# SCL Ignored: " + line
 
   when "wait"
-    # add a space incase there's no space between or and parantheses
+    # add a space in case there's no space between or and parentheses
     line = line.gsub(')or', ') or')
     words = line.split(' ')
     # Only a wait
@@ -1055,8 +1055,8 @@ end
 
 begin
   opts.parse!(ARGV)
-rescue => err
-  puts err
+rescue => e
+  puts e
   puts opts
   exit
 end
@@ -1164,7 +1164,7 @@ else
       @universal_index = 0
       @data_by_lines = @data.lines.to_a
       # Parse each line in the file
-      @data_by_lines.each do |line|
+      @data_by_lines.each do |_line|
         if @verify_wait_check == true
           # Skip line
           @verify_wait_check = false

data/bin/openc3cli

@@ -58,17 +58,30 @@ MIGRATE_PARSER = OptionParser.new do |opts|
 end
 ERROR_CODE = 1
 
+CLI_SCRIPT_ACTIONS = %w(help list run spawn)
+$script_interrupt_text = ''
+trap('INT') do
+  abort("Interrupted at console; exiting.#{$script_interrupt_text}")
+end
+
 # Prints the usage text for the openc3cli executable
 def print_usage
   puts "Usage:"
   puts "  cli help                          # Displays this information"
   puts "  cli rake                          # Runs rake in the local directory"
   puts "  cli irb                           # Runs irb in the local directory"
+  puts "  cli script list /PATH SCOPE       # lists script names filtered by path within scope, 'DEFAULT' if not given"
+  puts "  cli script spawn NAME SCOPE  variable1=value1 variable2=value2  # Starts named script remotely"
+  puts "  cli script run NAME SCOPE variable1=value1 variable2=value2  # Starts named script, monitoring status on console,\
+  by default until error or exit"
+  puts "    PARAMETERS name-value pairs to form the script's runtime environment"
+  puts "    OPTIONS: --wait 0 seconds to monitor status before detaching from the running script; ie --wait 100"
+  puts "             --disconnect run the script in disconnect mode"
   puts "  cli validate /PATH/FILENAME.gem SCOPE variables.txt # Validate a COSMOS plugin gem file"
   puts "  cli load /PATH/FILENAME.gem SCOPE variables.txt     # Loads a COSMOS plugin gem file"
   puts "  cli list <SCOPE>                  # Lists installed plugins, SCOPE is DEFAULT if not given"
   puts "  cli generate TYPE OPTIONS         # Generate various COSMOS entities"
-  puts "    OPTIONS: --ruby or --python to specify the language in the generated code"
+  puts "    OPTIONS: --ruby or --python is required to specify the language in the generated code unless OPENC3_LANGUAGE is set"
   puts "  #{MIGRATE_PARSER}"
   puts "  cli bridge CONFIG_FILENAME        # Run COSMOS host bridge"
   puts "  cli bridgegem gem_name variable1=value1 variable2=value2 # Runs bridge using gem bridge.txt"
@@ -160,8 +173,8 @@ def migrate(args)
   end
 
   # Migrate cmd_tlm_server.txt info to plugin.txt
-  Dir.glob('targets/**/cmd_tlm_server*.txt') do |file|
-    File.open(file) do |file|
+  Dir.glob('targets/**/cmd_tlm_server*.txt') do |cmd_tlm_server_file|
+    File.open(cmd_tlm_server_file) do |file|
       file.each do |line|
         next if line =~ /^\s*#/ # Ignore comments
         next if line.strip.empty? # Ignore empty lines
@@ -193,9 +206,9 @@ def migrate(args)
     lines = screen.split("\n")
     lines.map! do |line|
       if line.include?('Qt.')
-        line = "# FIXME (no Qt): #{line.sub("<%", "< %").sub("%>", "% >")}"
+        "# FIXME (no Qt): #{line.sub("<%", "< %").sub("%>", "% >")}"
       elsif line.include?('Cosmos::')
-        line = "# FIXME (no Cosmos::): #{line.sub("<%", "< %").sub("%>", "% >")}"
+        "# FIXME (no Cosmos::): #{line.sub("<%", "< %").sub("%>", "% >")}"
       else
         line
       end
@@ -425,7 +438,7 @@ def load_plugin(plugin_file_path, scope:, plugin_hash_file: nil, force: false)
     unless OpenC3::ScopeModel.names.include?(scope)
       begin
         puts "Creating scope: #{scope}"
-        scope_model = OpenC3::ScopeModel.new(name: scope, scope: scope)
+        scope_model = OpenC3::ScopeModel.new(name: scope)
         scope_model.create
         scope_model.deploy(".", {})
       rescue => e
@@ -493,7 +506,6 @@ def load_plugin(plugin_file_path, scope:, plugin_hash_file: nil, force: false)
   else
     # Outside Cluster
     require 'openc3/script'
-
     if plugin_hash_file
       plugin_hash = JSON.parse(File.read(plugin_hash_file), :allow_nan => true, :create_additions => true)
     else
@@ -648,6 +660,167 @@ def run_bridge(filename, params)
   end
 end
 
+def cli_script_monitor(script_id)
+  ret_code = ERROR_CODE
+  require 'openc3/script'
+  OpenC3::RunningScriptWebSocketApi.new(id: script_id) do |api|
+    while (resp = api.read) do
+      # see ScriptRunner.vue for types and states
+      case resp['type']
+      when 'error', 'fatal'
+        $script_interrupt_text = ''
+        puts 'script failed'
+        break
+      when 'file'
+        puts "Filename #{resp['filename']} scope #{resp['scope']}"
+      when 'line'
+        fn = resp['filename'].nil? ? '<no file>' : resp['filename']
+        puts "At [#{fn}:#{resp['line_no']}] state [#{resp['state']}]"
+        if resp['state'] == 'error'
+          $script_interrupt_text = ''
+          puts 'script failed'
+          break
+        end
+      when 'output'
+        puts resp['line']
+      when 'paused'
+        if resp['state'] == 'fatal'
+          $script_interrupt_text = ''
+          puts 'script failed'
+          break
+        end
+      when 'complete'
+        $script_interrupt_text = ''
+        puts 'script complete'
+        ret_code = 0
+        break
+      # These conditions are all handled by the else
+      # when 'running', 'breakpoint', 'waiting', 'time'
+      else
+        puts resp.pretty_inspect
+      end
+    end
+  end
+  return ret_code
+end
+
+def cli_script_list(args=[])
+  path = ''
+  if (args[0] && args[0][0] == '/')
+    path = (args.shift)[1..-1]+'/'
+  end
+  scope = args[1]
+  scope ||= 'DEFAULT'
+  require 'openc3/script'
+  script_list(scope: scope).each do |script_name|
+    puts(script_name) if script_name.start_with?(path)
+  end
+  return 0
+end
+
+def cli_script_run(disconnect=false, environment={}, args=[])
+  #  we are limiting the wait for status, not the script run time
+  #  we make 0 mean 'forever'
+  ret_code = ERROR_CODE
+  wait_limit = 0
+  if (i = args.index('--wait'))
+    begin
+      args.delete('--wait')
+      # pull out the flag
+      seconds = args[i]
+      wait_limit = Integer(seconds, 10) # only decimal, ignore leading 0
+      args.delete_at(i)
+      # and its value
+    rescue ArgumentError
+      abort("  --wait requires a number of seconds to wait, not [#{seconds}]")
+    end
+  end
+  abort("No script file provided") if args[0].nil?
+  scope = args[1]
+  scope ||= 'DEFAULT'
+  require 'openc3/script'
+  id = script_run(args[0], disconnect: disconnect, environment: environment, scope: scope) # could raise
+  $script_interrupt_text = "  Script #{args[0]} still running remotely.\n" # for Ctrl-C
+  if (wait_limit < 1) then
+    ret_code = cli_script_monitor(id)
+  else
+    Timeout::timeout(wait_limit, nil, "--wait #{wait_limit} exceeded") do
+      ret_code = cli_script_monitor(id)
+    rescue Timeout::ExitException, Timeout::Error => e
+      # Timeout exceptions are also raised by the Websocket API, so we check
+      if e.message =~ /^--wait /
+        puts e.message + ", detaching from running script #{args[0]}"
+      else
+        raise
+      end
+    end
+  end
+  return ret_code
+end
+
+def cli_script_spawn(disconnect=false, environment={}, args=[])
+  ret_code = ERROR_CODE
+  if (args.index('--wait'))
+    abort("Did you mean \"script run --wait <seconds> [...]\"?")
+  end
+  abort("No script file provided") if args[0].nil?
+  # heaven help you if you left out the script name
+  scope = args[1]
+  scope ||= 'DEFAULT'
+  require 'openc3/script'
+  if (id = script_run(args[0], disconnect: disconnect, environment: environment, scope: scope))
+    puts id
+    ret_code = 0
+  end
+  return ret_code
+end
+
+## cli_script(args) turns an ARGV of [spawn|run] <--wait 123...> <--disconnect> SCRIPT <scope> <ENV_A=1 ENV_B=2 ...>
+#                   into function calls and tidied parameters to remote-control a script via RunningScriptWebSocketApi
+def cli_script(args=[])
+  ret_code = ERROR_CODE
+  check_environment()
+  # Double check for the OPENC3_API_PASSWORD because it is absolutely required
+  # We always pass it via openc3.sh even if it's not defined so check for empty
+  if ENV['OPENC3_API_PASSWORD'].nil? or ENV['OPENC3_API_PASSWORD'].empty?
+    abort "OPENC3_API_PASSWORD environment variable is required for cli script"
+  end
+  command = args.shift
+  # pull out the disconnect flag
+  discon = args.delete('--disconnect')
+  discon = (discon.is_a? String) ? true : false
+  environ = {}
+  args.each do |arg|
+    name, value = arg.split('=')
+    if name and value
+    # add env[k]=v ; pull out "k=v"
+      environ[name] = value
+      args.delete(arg)
+    end
+  end
+  case command
+  # for list
+  # args[] should now be ["/<path>", "<scope>"]
+  #                   or ["/<path>"]
+  #                   or ["<scope>"]
+  #                   or []
+  when 'list'
+    ret_code = cli_script_list(args)
+  # for spawn or run
+  # args[] should now be ["--wait 100", "script_name", "<scope>"]
+  #                   or ["--wait 100", "script_name"]
+  #                   or ["script_name", "<scope>"]
+  #                   or ["script_name"]
+  when 'spawn'
+    ret_code = cli_script_spawn(discon, environ, args)
+  when 'run'
+    ret_code = cli_script_run(discon, environ, args)
+  else
+    abort 'openc3cli internal error: parsing arguments'
+  end
+  exit(ret_code)
+end
+
 if not ARGV[0].nil? # argument(s) given
 
   # Handle each task
@@ -657,11 +830,20 @@ if not ARGV[0].nil? # argument(s) given
     ARGV.clear
     IRB.start
 
+  when 'script'
+    case ARGV[1]
+    when 'list', 'run', 'spawn'
+      cli_script(ARGV[1..-1])
+    else
+      # invalid actions, misplaced and malformed leading options and 'help' come here
+      abort("cli script <action> must be one of #{CLI_SCRIPT_ACTIONS}, not [#{ARGV[1]}]")
+    end
+
   when 'rake'
     if File.exist?('Rakefile')
       puts `rake #{ARGV[1..-1].join(' ')}`
     else
-      puts "No Rakefile found! Only run 'rake' in the presense of a Rakefile which is typically at the root of your COSMOS project."
+      puts "No Rakefile found! Only run 'rake' in the presence of a Rakefile which is typically at the root of your COSMOS project."
     end
 
   when 'validate'

data/data/config/_interfaces.yaml

@@ -1,5 +1,5 @@
 ---
-tcpip_client_interface.rb:
+tcpip_client_interface:
   parameters:
     - name: Host
       required: true
@@ -29,7 +29,7 @@ tcpip_client_interface.rb:
       # prettier-ignore
       values:
         <%= MetaConfigParser.load('protocols.yaml').to_meta_config_yaml(8) %>
-tcpip_server_interface.rb:
+tcpip_server_interface:
   parameters:
     - name: Write Port
       required: true
@@ -54,7 +54,7 @@ tcpip_server_interface.rb:
       # prettier-ignore
       values:
         <%= MetaConfigParser.load('protocols.yaml').to_meta_config_yaml(8) %>
-udp_interface.rb:
+udp_interface:
   description: The UDP interface uses UDP packets to send and receive telemetry
     from the target
   parameters:
@@ -76,7 +76,7 @@ udp_interface.rb:
       description: Port on the local machine to send commands from. Default is
         'nil' (socket is not bound to an outgoing port).
       values: \d{2,5}
-    - name: Inteface Address
+    - name: Interface Address
       required: false
       description:
         If the remote machine supports multicast the interface address
@@ -100,7 +100,7 @@ udp_interface.rb:
       required: false
       description: Address to bind UDP ports to
       values: .+
-serial_interface.rb:
+serial_interface:
   description: Connects to a target over a serial port. OpenC3 provides drivers
     for both Windows and POSIX drivers for UNIX based systems.
   parameters:

data/data/config/command_modifiers.yaml

@@ -171,6 +171,10 @@ ACCESSOR:
       required: true
       description: The name of the accessor class
       values: .+
+    - name: Argument
+      required: false
+      description: Additional argument passed to the accessor class constructor
+      values: .+
   since: 5.0.10
 TEMPLATE:
   summary: Defines a template string used to initialize the command before default values are filled in
@@ -244,3 +248,58 @@ SCREEN:
       description: Screen Name of related telemetry screen
       values: .+
   since: 5.14.0
+VIRTUAL:
+  summary: Marks this packet as virtual and not participating in identification
+  description: Used for packet definitions that can be used as structures for items with a given packet.
+  since: 5.18.0
+VALIDATOR:
+  summary: Defines a validator class for a command
+  description: Validator class is used to validate the command success or failure with both a pre_check and post_check method.
+  parameters:
+    - name: Class Filename
+      required: true
+      description: The filename which contains the Ruby or Python class. The filename must
+        be named after the class such that the class is a CamelCase version of the
+        underscored filename. For example, 'command_validator.rb' should contain
+        'class CommandValidator'.
+      values: .*
+    - name: Argument
+      required: false
+      description: Additional argument passed to the validator class constructor
+      values: .*
+  ruby_example: |
+    VALIDATOR custom_validator.rb
+
+    Defined in custom_validator.rb:
+
+    require 'openc3/packets/command_validator'
+    class CustomValidator < OpenC3::CommandValidator
+      def pre_check(packet)
+        if tlm("TGT PKT ITEM") == 0
+          return [false, "TGT PKT ITEM is 0"]
+        end
+        @cmd_acpt_cnt = tlm("TGT PKT CMD_ACPT_CNT")
+        return [true, nil]
+      end
+      def post_check(packet)
+        wait_check("TGT PKT CMD_ACPT_CNT > #{@cmd_acpt_cnt}", 10)
+        return [true, nil]
+      end
+    end
+
+  python_example: |
+    VALIDATOR custom_validator.rb
+
+    Defined in custom_validator.py:
+
+    class CustomValidator(CommandValidator):
+        def pre_check(self, command):
+            if tlm("TGT PKT ITEM") == 0:
+                return [False, "TGT PKT ITEM is 0"]
+            self.cmd_acpt_cnt = tlm("INST HEALTH_STATUS CMD_ACPT_CNT")
+            return [True, None]
+
+        def post_check(self, command):
+            wait_check(f"INST HEALTH_STATUS CMD_ACPT_CNT > {self.cmd_acpt_cnt}", 10)
+            return [True, None]
+  since: 5.19.0

data/data/config/interface_modifiers.yaml

@@ -6,9 +6,12 @@ MAP_TARGET:
       required: true
       description: Target name to map to this interface
       values: .+
-  example: |
+  ruby_example: |
     INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
       MAP_TARGET DATA
+  python_example: |
+    INTERFACE DATA_INT openc3/interfaces/tcpip_client_interface.py host.docker.internal 8080 8081 10.0 nil BURST
+      MAP_TARGET DATA
 MAP_CMD_TARGET:
   summary: Maps a target name to an interface for commands only
   since: 5.2.0
@@ -17,9 +20,12 @@ MAP_CMD_TARGET:
       required: true
       description: Command target name to map to this interface
       values: .+
-  example: |
+  ruby_example: |
     INTERFACE CMD_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
       MAP_CMD_TARGET DATA # Only DATA commands go on the CMD_INT interface
+  python_example: |
+    INTERFACE CMD_INT openc3/interfaces/tcpip_client_interface.py host.docker.internal 8080 8081 10.0 nil BURST
+      MAP_CMD_TARGET DATA # Only DATA commands go on the CMD_INT interface
 MAP_TLM_TARGET:
   summary: Maps a target name to an interface for telemetry only
   since: 5.2.0
@@ -28,9 +34,12 @@ MAP_TLM_TARGET:
       required: true
       description: Telemetry target name to map to this interface
       values: .+
-  example: |
+  ruby_example: |
     INTERFACE TLM_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
       MAP_TLM_TARGET DATA # Only DATA telemetry received on TLM_INT interface
+  python_example: |
+    INTERFACE TLM_INT openc3/interfaces/tcpip_client_interface.py host.docker.internal 8080 8081 10.0 nil BURST
+      MAP_TLM_TARGET DATA # Only DATA telemetry received on TLM_INT interface
 DONT_CONNECT:
   summary: Server will not automatically try to connect to the interface at startup
 DONT_RECONNECT:
@@ -51,7 +60,7 @@ DISABLE_DISCONNECT:
   description:
     Use this keyword to prevent the user from disconnecting from the interface.
     This is typically used in a 'production' environment where you would not want
-    the user to inadvertantly disconnect from a target.
+    the user to inadvertently disconnect from a target.
 LOG_RAW:
   summary: Deprecated, use LOG_STREAM
 LOG_STREAM:
@@ -102,17 +111,18 @@ PROTOCOL:
       values: ["READ", "WRITE", "READ_WRITE"]
     - name: Protocol Filename or Classname
       required: true
-      description: Ruby filename or class name which implements the protocol
+      description: Ruby or Python filename or class name which implements the protocol
       values: .*
     - name: Protocol specific parameters
       required: false
       description: Additional parameters used by the protocol
-  example: |
+  ruby_example: |
     INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil nil
       MAP_TARGET DATA
       # Rather than defining the LENGTH protocol on the INTERFACE line we define it here
       PROTOCOL READ LengthProtocol 0 16 0 1 BIG_ENDIAN 4 0xBA5EBA11
-    INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
+  python_example: |
+    INTERFACE DATA_INT openc3/interfaces/tcpip_client_interface.py host.docker.internal 8080 8081 10.0 nil BURST
       MAP_TARGET DATA
       PROTOCOL READ IgnorePacketProtocol INST IMAGE # Drop all INST IMAGE packets
 OPTION:
@@ -220,8 +230,8 @@ CMD:
       required: true
       description: One or more arguments to exec to run the microservice.
       values: .+
-  example: |
-    CMD ruby interface_microservice.rb DEFAULT__INTERFACE__INT1
+  ruby_example: CMD ruby interface_microservice.rb DEFAULT__INTERFACE__INT1
+  python_example: CMD python interface_microservice.py DEFAULT__INTERFACE__INT1
 CONTAINER:
   summary: Docker Container
   description: Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition.