ISystem.idl

Go to the documentation of this file.

// -----------------------------------------------------------------------
// MLPI - <ISystem.idl>
// -----------------------------------------------------------------------
// Copyright (c) 2012 Bosch Rexroth. All rights reserved.
// Redistribution and use in source and binary forms of this MLPI software
// (SW) provided to you, with or without modification, are permitted
// without prior approval provided that the following conditions are met:
//
// 1. Redistributions of source code of SW must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form of SW must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. User recognizes and acknowledges that it acquires no right,
// title or interest in or to any of the names or trademarks used in
// connection with the SW ("names") by virtue of this License and waives
// any right to or interest in the names. User recognizes and acknowledges
// that names of companies or names or products of companies displayed
// in the documentation of SW to indicate the interoperability of products
// with the SW are the names of their respective owners. The use of such
// names in the documentation of SW does not imply any sponsorship,
// approval, or endorsement by such companies of this product.
//
// 4. Modified code versions, i.e. any addition to or deletion from
// the substance or structure of the original code of the SW running
// the MLPI must be plainly marked as such and must not be misrepresented
// as being original SW.
//
// 5. The SW may only be used in connection with a Bosch Rexroth product.
//
// THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
// AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
// (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
// INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
// ERRORS OR INACCURACIES.
// SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
// THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
// NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
// THE  SOFTWARE  DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
// DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
// -----------------------------------------------------------------------
//
//
// -----------------------------------------------------------------------



[
  object,
  uuid(35AE5C9C-722F-4f07-9AF4-42D2A86065EF),
  dual,
  nonextensible,
  helpstring("ISystem Interface"),
  pointer_default(unique)
]
interface ISystem : IDispatch{

  const BSTR VERSION_FIRMWARE         = "VERSION_FIRMWARE";
  const BSTR VERSION_HARDWARE         = "VERSION_HARDWARE";
  const BSTR VERSION_LOGIC            = "VERSION_LOGIC";
  const BSTR VERSION_BSP              = "VERSION_BSP";
  const BSTR VERSION_MLPI_SERVER_CORE = "VERSION_MLPI_SERVER_CORE";

  typedef [v1_enum] enum Language
  {
    LANGUAGE_GERMAN       = 0,     
    LANGUAGE_ENGLISH      = 1,     
    LANGUAGE_USER_DEFINED = 99
  }Language;

  typedef [v1_enum] enum SystemMode
  {
    SYSTEMMODE_P0         = 0x00,   
    SYSTEMMODE_P1         = 0x01,   
    SYSTEMMODE_P2         = 0x02,   
    SYSTEMMODE_P3         = 0x03,   
    SYSTEMMODE_BB         = 0x04,   
    SYSTEMMODE_SWITCHING  = 0xFF    
  } SystemMode;

  typedef [v1_enum] enum DiagnosisState
  {
    DIAGNOSIS_PASSIVE  = 0x00,      
    DIAGNOSIS_ACTIVE   = 0x01,      
    DIAGNOSIS_RESET    = 0x02,      
    DIAGNOSIS_UNKNOWN  = 0x03       
  } DiagnosisState;

  typedef [v1_enum] enum DiagnosisDespatcher
  {
    DESPATCHER_CONTROL   = 0x00,   
    DESPATCHER_DRIVE     = 0x01,   
    DESPATCHER_LOGIC     = 0x02,   
    DESPATCHER_AXIS      = 0x03,   
    DESPATCHER_KINEMATIC = 0x04,   
    DESPATCHER_PCI       = 0x05    
  }DiagnosisDespatcher;

  typedef [v1_enum] enum SpecialPath
  {
    PATH_SYSTEM                             = 0x00,   
    PATH_OEM                                = 0x01,   
    PATH_USER                               = 0x02,   
    PATH_PROJECTDATAPROTECTED               = 0x03,   
    PATH_PROJECTDATA                        = 0x04,   
    PATH_PROJECTDATA_BUNDLES                = 0x05,   
    PATH_PROJECTDATA_PLC                    = 0x06,   
    PATH_PROJECTDATA_TMP                    = 0x07,   
    PATH_PROJECTDATA_JVM                    = 0x08,   
    PATH_PROJECTDATA_JVM_BUNDLES            = 0x09,   
    PATH_PROJECTDATA_JVM_LIC                = 0x0A,   
    PATH_PROJECTDATA_JVM_USER               = 0x0B,   
    PATH_PROJECTDATAPROTECTED_BUNDLES       = 0x0C,   
    PATH_PROJECTDATAPROTECTED_JVM           = 0x0D,   
    PATH_PROJECTDATAPROTECTED_JVM_BUNDLES   = 0x0E,   
    PATH_PROJECTDATAPROTECTED_JVM_LIC       = 0x0F,   
    PATH_PROJECTDATAPROTECTED_JVM_USER      = 0x10,   
  } SpecialPath;

  typedef [v1_enum] enum DiagnosisCategory
  {
    DIAGNOSIS_ERROR_FATAL    = 0xF8,   
    DIAGNOSIS_ERROR_NONFATAL = 0xF0,   
    DIAGNOSIS_WARNING        = 0xE0,   
    DIAGNOSIS_MESSAGE        = 0xA0    
  } DiagnosisCategory;



#if defined(WIN32) || defined(WIN64)
  [
    uuid(8099CC06-2940-4ddd-ACB3-CAAE9C268F2B)
  ]
  struct DateAndTime
  {
    SHORT  year;          
    SHORT  month;         
    SHORT  day;           
    SHORT  hour;          
    SHORT  minute;        
    SHORT  second;        
    SHORT  milliSecond;   
    SHORT  microSecond;   
    SHORT  dayOfWeek;     
    SHORT  dayOfYear;     
  };


  [
    uuid(D0129DE4-876B-4567-9BD1-103E1BDD1234)
  ]
  struct Diagnosis
  {
    LONG                number;            
    DiagnosisState      state;             
    struct DateAndTime  dateTime;          
    LONG                logicalAddress;    
    LONG                physicalAddress;   
    DiagnosisDespatcher despatcher;        
    LONG                index;             
    BSTR                text;              
  };
#endif

  struct MemoryInfo
  {
    VARIANT totalVolatileBytes;     
    VARIANT totalNonvolatileBytes;  
    VARIANT  freeVolatileBytes;     
    VARIANT freeNonvolatileBytes;   
  };


  struct SpecialPathInfo
  {
    VARIANT totalBytes;      
    VARIANT freeBytes;       
  };


  [id(4), helpstring("Method GetName")] HRESULT GetName([out, retval] BSTR* name);

  [id(5), helpstring("Method SetName")] HRESULT SetName([in] BSTR name);

  [id(7), helpstring("Method GetTemperature")] HRESULT GetTemperature([out, retval] FLOAT* temperature);

  [id(8), helpstring("Method GetTemperatureMax")] HRESULT GetTemperatureMax([out, retval] FLOAT* temperature);

  [id(13), helpstring("Method GetIpAddress")] HRESULT GetIpAddress([out, retval] BSTR* address);

  [id(14), helpstring("Method SetIpAddress")] HRESULT SetIpAddress([in] BSTR address);

  [id(15), helpstring("Method GetSubnetMask")] HRESULT GetSubnetMask([out, retval] BSTR* address);

  [id(16), helpstring("Method SetSubnetMask")] HRESULT SetSubnetMask([in] BSTR address);

  [id(17), helpstring("Method GetGateway")] HRESULT GetGateway([out, retval] BSTR* address);

  [id(18), helpstring("Method SetGateway")] HRESULT SetGateway([in] BSTR address);

  [id(19), helpstring("Method GetCurrentMode")] HRESULT GetCurrentMode([out, retval] SystemMode* mode);

  [id(20), helpstring("Method SetTargetControlMode")] HRESULT SetTargetMode([in] SystemMode mode);

  [id(21), helpstring("Method GetCpuLoad")] HRESULT GetCpuLoad([out, retval] FLOAT* cpuLoad);

  [id(22), helpstring("Method GetCpuLoadMax")] HRESULT GetCpuLoadMax([out, retval] FLOAT* cpuLoad);

#if defined(WIN32) || defined(WIN64)
  [id(23), helpstring("Method GetDisplayedDiagnosis")] HRESULT GetDisplayedDiagnosis([out, retval] struct Diagnosis* diagnosis);
#endif

  [id(24), helpstring("Method GetNewestDiagnosisIndex")] HRESULT GetNewestDiagnosisIndex([out, retval] LONG* index);

  [id(25), helpstring("Method GetOldestDiagnosisIndex")] HRESULT GetOldestDiagnosisIndex([out, retval] LONG* index);

#if defined(WIN32) || defined(WIN64)
  [id(45), helpstring("Method GetDiagnosisLog")] HRESULT GetDiagnosisLog([in] LONG startIndex, [in] LONG numToRead, [out, retval] SAFEARRAY (struct Diagnosis) *diagnosis);
#endif

  [id(44), helpstring("Method ConvertDiagnosisNumberToText")] HRESULT ConvertDiagnosisNumberToText([in] VARIANT diagnosisNumber, [out, retval] BSTR *diagnosis);

  [id(26), helpstring("Method GetOperationHours")] HRESULT GetOperationHours([out, retval] LONG* hours);

  [id(27), helpstring("Method GetVersionInfo")] HRESULT GetVersionInfo([in] BSTR component, [out, retval] BSTR* version);

  [id(28), helpstring("Method GetSerialNumber")] HRESULT GetSerialNumber([out, retval] BSTR* serial);

  [id(29), helpstring("Method GetMacAddress")] HRESULT GetMacAddress([out, retval] BSTR* address);

  [id(30), helpstring("Method ClearError")] HRESULT ClearError(void);

  [id(31), helpstring("Method Reboot")] HRESULT Reboot(void);

  [id(32), helpstring("Method Cleanup")] HRESULT Cleanup(void);

  [id(33), helpstring("Method GetLanguage")] HRESULT GetLanguage([out, retval] Language* language);

  [id(34), helpstring("Method SetLanguage")] HRESULT SetLanguage([in] Language language);

  [id(35), helpstring("Method GetHardwareDetails")] HRESULT GetHardwareDetails([out, retval] BSTR* hardwareDetails);

  [id(36), helpstring("Method GetMemoryInfo")] HRESULT GetMemoryInfo([out, retval] struct MemoryInfo *memory);

#if defined(WIN32) || defined(WIN64)
  [id(37), helpstring("Method GetDateAndTimeUtc")] HRESULT GetDateAndTimeUtc([out, retval] struct DateAndTime* dateTime);
#endif

  [id(38), helpstring("Method GetSpecialPath")] HRESULT GetSpecialPath([in] SpecialPath pathIdentifier, [out, retval] BSTR *path);

  [id(39), helpstring("Method GetSpecialPathInfo")] HRESULT GetSpecialPathInfo([in] SpecialPath path, [out,retval] struct SpecialPathInfo *pathInfo);

  [id(40), helpstring("Method SetDiagnosis")] HRESULT SetDiagnosis([in] DiagnosisCategory category, [in] LONG number, BSTR diagnosisText);
};



// -----------------------------------------------------------------------
// HISTORY
// -----------------------------------------------------------------------
// 01-Jan-2012
//   - first release
//