GI.bench architecture
      Back to home
      1. GI.knowledgebase
      2. Data Acquisition Software
      3. GI.bench architecture

      GI.com

      GI.com

      1. Basics

       2. API Base Results

      All methods responding with at least these result elements.

       

      2.1 ReturnState

       

      Results
      Name Type Description
      ReturnState GInsXmlRpcStdAPI::GIns_Info_State Method result state information marked as Info, Warning, Error level
       
       

      3. gicom_DeviceConfigAPI

      3.1 Enums

      3.1.1 EnumDeviceConnectionType

       

      Name Value Comment
      Module_UART 0  
      Controller_Network 1  
      Module_Controller 2  
      Controller_Cloud 3  
      Controller_NetworkMulticaste 4  
       

      3.2 Structs

      3.2.1 Type_Info_Network (17.1)

      • Internal type: 
        class CType_Info_Network : public GInsXmlRpc::XmlRpcValue
      Name Type Comment
      IPAddress_IPv4_Dynamic std::string  
      IPAddress_IPv6_Dynamic std::string  
      IPAddress_IPv4_Static std::string  
      DHCP_Enabled bool Default: false
      MACAddress std::string  
      SubnetMask std::string  
      GatewayAddress std::string  
       

      3.2.2 Type_Info_UART (17.2)

      • Internal type: 
        class CType_Info_UART : public GInsXmlRpc::XmlRpcValue
      Name Type Comment
      PortIndex int32_t Default: 0
      Address int32_t Default: 0
       

      3.2.3 Type_Info_DeviceInfo (17.3)

      • Internal type: 
        class CType_Info_DeviceInfo : public GInsXmlRpc::XmlRpcValue
      Name Type Comment
      Location std::string  
      SerialNumber std::string  
      Firmware std::string  
      TypeName std::string  
      TypeInfo GInsXmlRpcStdAPI::CGIns_Info_DeviceType  
      Ethernet CType_Info_Network  
      RS232_PPP CType_Info_Network  
      RS485_PPP CType_Info_Network  
      UART CType_Info_UART  
       

      3.2.4 Type_Info_Interface (17.9)

      • Internal type: 
        class CType_Info_Interface : public GInsXmlRpc::XmlRpcValue
      Name Type Comment
      ConnectionType GInsXmlRpcStdAPI::CGIns_Base_ElementValue  
      IPAddress_IPv4 std::string  
      SubnetMask_IPv4 std::string  
       

      3.2.5 Type_Info_DeviceScanResult (17.7)

      • Internal type: 
        class CType_Info_DeviceScanResult : public GInsXmlRpc::XmlRpcValue
      Name Type Comment
      ID std::string  
      IDAmbiguous bool Default: false
      Interface CType_Info_Interface  
      DeviceInfo CType_Info_DeviceInfo  
       

      3.2.6 Type_Info_DeviceConfigState (17.4)

      • Internal type: 
        class CType_Info_DeviceConfigState : public GInsXmlRpc::XmlRpcValue
      Name Type Comment
      ConfigDifferent bool Default: false
      ConfigIncompatible bool Default: false
      TransferLocked bool Default: false
      IDInconsistency bool Default: false
      MasterSide bool Default: false
      SlaveSide bool Default: false
      SlaveStateValid bool Default: false
      SlaveStateText std::string  
       

      3.2.7 Type_Info_ConfigModule (17.5)

      • Internal type: 
        class CType_Info_ConfigModule : public GInsXmlRpc::XmlRpcValue
      Name Type Comment
      ID std::string  
      DeviceInfo CType_Info_DeviceInfo  
      ConfigState CType_Info_DeviceConfigState  
       

      3.2.8 Type_Info_ConfigController (17.8)

      • Internal type: 
        class CType_Info_ConfigController : public GInsXmlRpc::XmlRpcValue
      Name Type Comment
      ID std::string  
      DeviceInfo CType_Info_DeviceInfo  
      ConfigState CType_Info_DeviceConfigState  
      Modules array of CType_Info_ConfigModule  
      Events array of GInsXmlRpcStdAPI::CGIns_Info_State  
       

      3.2.9 Type_Info_ConfigState (17.6)

      • Internal type: 
        class CType_Info_ConfigState : public GInsXmlRpc::XmlRpcValue
      Name Type Comment
      MeasModeActive bool Default: false
      ConfigModeActive bool Default: false
      Stable bool Default: false
      Controllers array of CType_Info_ConfigController  
       

      3.3 Methods

      3.3.1 StartDeviceScan

       

      Parameters
      Name Type Comment
      Interface GInsXmlRpcStdAPI::CGIns_Edit_ElementSelectionList Use Type: COptions::CCommon::DeviceScanType::…
      Filter array of std::string  
       
      Results
      Name Type Comment
      ReturnState GInsXmlRpcStdAPI::CGIns_Info_State  
       

      3.3.2 GetDeviceState

       

      Parameters
      Name Type Comment
      ConnectionString std::string  
      ConnectionType GInsXmlRpcStdAPI::CGIns_Edit_ElementSelectionList  
       
      Results
      Name Type Comment
      ReturnState GInsXmlRpcStdAPI::CGIns_Info_State  
      DeviceState CType_Info_DeviceScanResult  
       

      3.3.3 IdentDevice

       

      Parameters
      Name Type Comment
      MACAddress std::string  
       
      Results
      Name Type Comment
      ReturnState GInsXmlRpcStdAPI::CGIns_Info_State  
       

      3.3.4 RebootDevice

       

      Parameters
      Name Type Comment
      MACAddress std::string  
       
      Results
      Name Type Comment
      ReturnState GInsXmlRpcStdAPI::CGIns_Info_State  
       

      3.3.5 DHCPRequest

       

      Parameters
      Name Type Comment
      MACAddress std::string  
      Enable bool Default: false
       
      Results
      Name Type Comment
      ReturnState GInsXmlRpcStdAPI::CGIns_Info_State  
       

      3.3.6 SetNetworkParameter

       

      Parameters
      Name Type Comment
      MACAddress std::string  
      IPAddress std::string  
      SubnetMask std::string  
      DefaultGateway std::string  
      DNSServer std::string  
       
      Results
      Name Type Comment
      ReturnState GInsXmlRpcStdAPI::CGIns_Info_State  
       

      3.3.7 GetDeviceScanResult

       

      Parameters
      Name Type Comment
      ID array of std::string  
      Interface GInsXmlRpcStdAPI::CGIns_Edit_ElementSelectionList  
       
      Results
      Name Type Comment
      ReturnState GInsXmlRpcStdAPI::CGIns_Info_State  
      ScanFinished bool Default: false
      ScanResult array of CType_Info_DeviceScanResult  
       

      3.3.8 Connect

       

      Parameters
      Name Type Comment
      ID std::string ID of the device to connect (empty for own device)
      IPAddress std::string  
      Username std::string  
      Password std::string  
      ProjectPath std::string  
       
      Results
      Name Type Comment
      ReturnState GInsXmlRpcStdAPI::CGIns_Info_State  
      Token std::string Connection identification → needed as parameter for other methods on DeviceConfigAPI
      ProjectPath std::string  
       

      3.3.9 Disconnect

       

      Parameters
      Name Type Comment
      Token std::string Token from method 'Connect'
       
      Results
      Name Type Comment
      ReturnState GInsXmlRpcStdAPI::CGIns_Info_State  
       

      3.3.10 HandleConfig

       

      Parameters
      Name Type Comment
      Token std::string Token from method 'Connect'
      Action GInsXmlRpcStdAPI::CGIns_Edit_ElementSelectionList Use Type: COptions::CCommon::ActionType::…
       
      Results
      Name Type Comment
      ReturnState GInsXmlRpcStdAPI::CGIns_Info_State  
       

      3.3.11 GetConfigState

       

      Parameters
      Name Type Comment
      Token std::string Token from method 'Connect'
      ClearEvents bool Default: false
      Old events will be cleared in the method results → only new will be transferred.
      ConfigModeTimeoutMs int32_t Default: 0
      After this time the config mode will be exited if no communication happens.
       
      Results
      Name Type Comment
      ConfigState CType_Info_ConfigState  
      Events array of GInsXmlRpcStdAPI::CGIns_Info_State  
      ReturnState GInsXmlRpcStdAPI::CGIns_Info_State