IFieldbus.idl

Go to the documentation of this file.

// -----------------------------------------------------------------------
// MLPI - <IFieldbus.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(C93E9AA2-7761-4AEE-9112-B43D8FA858A1),
  dual,
  nonextensible,
  helpstring("IFieldbus Interface"),
  pointer_default(unique)
]
interface IFieldbus : IDispatch{

  typedef [v1_enum] enum IoFieldbusMasterType
  {
    FIELDBUS_MASTER_GENERIC         = 0,        
    FIELDBUS_MASTER_ONBOARD_IO      = 1,        
    FIELDBUS_MASTER_INLINE_IO       = 2,        
    FIELDBUS_MASTER_PROFIBUS_DP     = 3,        
    FIELDBUS_MASTER_SERCOS_III      = 4,        
    FIELDBUS_MASTER_FAST_IO         = 5,        
    FIELDBUS_MASTER_PROFINET        = 6,        
    FIELDBUS_MASTER_DEVICENET       = 7,        
    FIELDBUS_MASTER_ETHERNET_IP     = 8,        
    FIELDBUS_MASTER_ETHERNET_NETX   = 9         
  }IoFieldbusMasterType;

  typedef [v1_enum] enum IoFieldbusArea
  {
    IO_AREA_INPUT  = 0,           
    IO_AREA_OUTPUT = 1            
  }IoFieldbusArea;

#if defined(WIN32) || defined(WIN64)
  [
    uuid(1EE87246-4A11-4b21-A20B-3BC432D1A6ED)
  ]
  struct IoHandle
  {
    LONG ident;
    LONG hash;
  };

  [
    uuid(5358C15D-48DC-49f6-A973-63B6DE640019)
  ]
  struct IoDiagnosis
  {
    ULONG flags;
  };


  [
    uuid(0AF14472-E6D9-4521-9EE9-29F77C5EE03D)
  ]
  struct IoFieldbusSlaveInfo
  {
    struct IoHandle     handle;
    BSTR                name;
    struct IoDiagnosis  diagnosis;
    BSTR                address;
    LONG                numberOfInputs;
    LONG                numberOfOutputs;
  };

  struct IoFieldbusMasterInfo
  {
    struct IoHandle       handle;
    BSTR                  name;
    struct IoDiagnosis    diagnosis;
    IoFieldbusMasterType  type;
    LONG                  numberOfSlaves;
  };


  [id(1), helpstring("Method ReadFieldbusMasterInfo")] HRESULT ReadFieldbusMasterInfo([out, retval] struct IoFieldbusMasterInfo *masterInfo);


  [id(2), helpstring("Method UpdateFieldbusIo")] HRESULT UpdateFieldbusIo();

  [id(3), helpstring("Method ReadFieldbusSlaveInfos")] HRESULT ReadFieldbusSlaveInfos([out, retval] SAFEARRAY(struct IoFieldbusSlaveInfo) *slaveInfos);
#endif

  [id(4), helpstring("Method WriteFieldbusIoAsByteArray")] HRESULT WriteFieldbusIoAsByteArray([in] BSTR slaveAddress, [in] IoFieldbusArea area, [in] LONG byteOffset, [in] LONG byteLength, [in] SAFEARRAY(BYTE) data);

  [id(5), helpstring("Method ReadFieldbusIoAsByteArray")] HRESULT ReadFieldbusIoAsByteArray([in] BSTR slaveAddress, [in] IoFieldbusArea area, [in] LONG byteOffset, [in] LONG byteLength, [out, retval] SAFEARRAY(BYTE) *data);

};



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