ESI_EC_COM_EN

Embed Size (px)

Citation preview

  • 7/25/2019 ESI_EC_COM_EN

    1/5

    Page 1 of 5

    Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment

    ESI[tronic]

    COM Interface SpecificationFor acceptance of an SIS/CAS error code log from ESI[tronic]

    Status: 2.18.04

    Version 1.0

    Contact:Email: [email protected]: www.esitronic.comFax: +49 (0) 180 5812310

    Document:ESI_EC_COM.PDF (Created from source file ESI_EC_COM.DOC)

  • 7/25/2019 ESI_EC_COM_EN

    2/5

    Page 2 of 5

    Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment

    Table of contents

    1. Objective ................................................................................................................................ 32. Interface................................................................................................................................. 3

    2.1. Description ....................................................................................................................... 32.1.1. Setting application names in ESI[tronic] ........................................................................ 3

    2.1.2. Sending SIS/CAS error code log.................................................................................... 33. Annex..................................................................................................................................... 5

    3.1. TypeLib ............................................................................................................................ 5

  • 7/25/2019 ESI_EC_COM_EN

    3/5

    Page 3 of 5

    Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment

    1.Objective

    Description/provision of a communication interface between the ESI[tronic] and an external applicati-on.

    2.Interface

    The functions to be realized are based on the COM technology developed by Microsoft and are speci-fied below. ESI[tronic] is used here solely as a COM server.

    2.1.Description

    2.1.1.Setting application names in ESI[tronic]

    Call-up in client application by:

    Function name: RegisterType: MethodBrief description: Identifies client application in ESI[tronic]Call-up: ext. application ESI[tronic]

    Detail:HRESULT Register(

    [in] BSTR ApplicationName); (Content of application name accepted inESI[tronic] button)

    2.1.2.Sending SIS/CAS error code log

    'Call-up in ESI[tronic] by:

    Menu: Settings ->User defined ->

    Table tab: SIS/CAS operation log ->Button: Send log to ext. application

    Direction: ESI[tronic] ext. applicationPreconditions:

    - A COM connection must be given, otherwise the send button is hidden.-

    A fault log must be given, otherwise the send button is visible but disabled.

  • 7/25/2019 ESI_EC_COM_EN

    4/5

    Page 4 of 5

    Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment

    Sending of SIS/CAS error code log:

    Process phase:1. Initialization2. Data acceptance

    3. Finish

    Initialization phase:

    Function name: Ident_RBType: EventBrief description: Transfer of vehicle dataCall-up: ESI[tronic] ext. application

    Detail:HRESULT Ident_RB (

    [in] BSTR Brand, (Make)[in] long Number, (Number)

    [in] BSTR Year); (Year(s) of manufacture)

    Function name: BeginTransferECType: EventBrief description: Number of error codes transferredCall-up: ESI[tronic] ext. applicationDetail:

    HRESULT BeginTransferEC (

    [in] short NumOfCodes);, (Number of data records)

    Data acceptance phase::Function name: ECItemType: EventBrief description: Data record of error code log to be sent to ext. application

    Call-up: ESI[tronic] ext. applicationDetail:

    HRESULT ECItem(

    [in] BSTR ErrorCode); (Lines error code log)

    Completion phaseFunction name: EndTransferECType: EventBrief description: Data acceptance completionCall-up: ESI[tronic] ext. applicationDetail:

    HRESULT EndData();

  • 7/25/2019 ESI_EC_COM_EN

    5/5

    Page 5 of 5

    Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment

    3.Annex

    3.1.TypeLib// Generated .IDL file (by the OLE/COM Object Viewer)

    //

    // typelib filename: Esi2.tlb

    [

    uuid(AF21D48D-7AED-4A7C-9D03-773FC64B2361),

    version(1.0),

    helpstring("Esi2 1.0 Type library")

    ]

    library Esi2Lib

    {

    // TLib : // TLib : OLE Automation : {00020430-0000-0000-C000-000000000046}

    importlib("stdole2.tlb");

    // Forward declare all types defined in this typelib

    interface ICASSIS;

    dispinterface _IESImaticEvents;

    interface IESImaticCP;

    interface IAWConnectionMsgSink;

    interface IESImatic;interface IPWEventProxy;

    dispinterface _IRepDocEvents;

    interface IRepDoc;

    dispinterface _IErrorCodeEvents;

    interface IErrorCode;

    . . .

    [

    uuid(E6683D90-853E-4E08-A058-C4C2E3CB80C1),

    helpstring("_IErrorCode event interface")

    ]

    dispinterface _IErrorCodeEvents {

    properties:

    methods:

    [id(0x00000001)]void Ident_RB(

    [in] BSTR Brand,

    [in] long Number,

    [in] BSTR Year);

    [id(0x00000002)]

    void BeginTransferEC([in] short NumOfCodes);

    [id(0x00000003)]

    void ECItem([in] BSTR ErrorCode);

    [id(0x00000004)]

    void EndTransferEC();

    };

    [

    uuid(FD2DFFBE-3C0D-458A-AFD3-4E8EBD12459F),

    helpstring("ErrorCode Class")

    ]

    coclass ErrorCode {

    [default] interface IErrorCode;

    [default, source] dispinterface _IErrorCodeEvents;

    };

    [

    odl,

    uuid(4085EDF9-CC9C-41B6-AB69-BCD83A1D7A02),

    helpstring("IErrorCode interface"),

    dual,

    oleautomation

    ]

    interface IErrorCode : IDispatch {

    [id(0x00000001)]

    HRESULT Register([in] BSTR ApplicationName);

    };

    };