Method: OpenC3::Api#cmd_implementation

Defined in:
lib/openc3/api/cmd_api.rb

#cmd_implementation(method_name, *args, range_check:, hazardous_check:, raw:, timeout: nil, scope: $openc3_scope, token: $openc3_token, **kwargs) ⇒ Object

PRIVATE implementation details



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
# File 'lib/openc3/api/cmd_api.rb', line 316

def cmd_implementation(method_name, *args, range_check:, hazardous_check:, raw:, timeout: nil,
                       scope: $openc3_scope, token: $openc3_token, **kwargs)
  extract_string_kwargs_to_args(args, kwargs)

  case args.length
  when 1
    target_name, cmd_name, cmd_params = extract_fields_from_cmd_text(args[0], scope: scope)
  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 #{method_name}()"
  end
  target_name = target_name.upcase
  cmd_name = cmd_name.upcase
  cmd_params = cmd_params.transform_keys(&:upcase)
  authorize(permission: 'cmd', target_name: target_name, packet_name: cmd_name, scope: scope, token: token)
  packet = TargetModel.packet(target_name, cmd_name, type: :CMD, scope: scope)

  command = {
    'target_name' => target_name,
    'cmd_name' => cmd_name,
    'cmd_params' => cmd_params,
    'range_check' => range_check.to_s,
    'hazardous_check' => hazardous_check.to_s,
    'raw' => raw.to_s
  }
  log_cmd = true
  if packet["messages_disabled"]
    log_cmd = false
  else
    cmd_params.each do |key, value|
      item = packet['items'].find { |item| item['name'] == key.to_s }
      if item['states'] && item['states'][value] && item['states'][value]["messages_disabled"]
        log_cmd = false
      end
    end
  end
  if log_cmd
    Logger.info(build_cmd_output_string(target_name, cmd_name, cmd_params, packet, raw), scope: scope)
  end
  CommandTopic.send_command(command, timeout: timeout, scope: scope)
end