Method: OpenC3::Api#get_interface

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

#get_interface(interface_name, scope: $openc3_scope, token: $openc3_token) ⇒ Hash

Get information about an interface

Parameters:

  • interface_name (String) —

    Interface name

Returns:

  • (Hash) —

    Hash of all the interface information

Since:

  • 5.0.0



48
49
50
51
52
53
54
 
# File 'lib/openc3/api/interface_api.rb', line 48

def get_interface(interface_name, scope: $openc3_scope, token: $openc3_token)
  authorize(permission: 'system', interface_name: interface_name, scope: scope, token: token)
  interface = InterfaceModel.get(name: interface_name, scope: scope)
  raise "Interface '#{interface_name}' does not exist" unless interface

  interface.merge(InterfaceStatusModel.get(name: interface_name, scope: scope))
end