ESI (Tronic) : COM Interface Specification For Vehicle Identification and Acceptance of Data From Work Card

Page 1 of 10
ESI[tronic]
COM Interface Specification
for Vehicle Identification and
Acceptance of Data from Work Card
Date: 03.05.06
Version 1.2
Contact:
Email: ESItronic@msw-stuttgart.de
Web: www.esitronic.com
Fax:
+49 (0) 180 5812310
Document:
ESI_COM.PDF (created from ESI_COM.DOC source file)
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
Page 2 of 10
Table of contents
1. Objective ...................................................................................................................................3
2. Interface....................................................................................................................................3
2.1. Description...........................................................................................................................3
2.1.1. Vehicle identification ......................................................................................................3
2.1.2. Vehicle selection ............................................................................................................5
2.1.3. Job card ........................................................................................................................5
2.1.4. ESI[tronic] framework program.......................................................................................7
3. Annex........................................................................................................................................8
3.1. TypeLib ...............................................................................................................................8
3.2. ESI[tronic] language abbreviation .......................................................................................10
Page 3 of 10
1. Objective
Description/provision of a communication interface between the ESI[tronic] and an external
application.
2. Interface
The functions to be realized are based on the COM technology developed by Microsoft and are specified below. ESI[tronic] is used here solely as a COM server.
2.1. Description
2.1.1. Vehicle identification
Identification via KBA numbers, numeric (deprecated):
Function name:
Type:
Brief description:
Call-up:
Detail:
Ident_KBA
Method
Identifies in ESI[tronic] a vehicle via KBA number (numeric)
ext. application ESI[tronic]
HRESULT
[in]
[in]
[in,
Ident_KBA(
short ManufacturerNo, (vehicle man., code no. "for 2")
short TypeModelNo,
(Type/version, code no. "for 3")
optional, defaultvalue(0)] short Year);
(first reg., line 32)
Identification via KBA numbers, alphanumeric (new!):

Function name:
Type:
Brief description:
Call-up:
Detail:
Ident_KBA 2
Method
Identifies in ESI[tronic] a vehicle via KBA number (alphanumeric)
HRESULT Ident_KBA(
[in] BSTR ManufacturerNo, (vehicle man., code
[in] BSTR TypeModelNo,
(Type/version, code
(first three digits
[in, optional, defaultvalue(0)] short Year);
no. "for 2.1")

no. "for 2.2"
only))
(first reg., line 32)
Identification via RB code (KHKZ):

Function name:
Type:
Brief description:
Call-up:
Detail:
Ident_RB
Method
Identifies in ESI[tronic] a vehicle via RB code
HRESULT Ident_RB(
[in] BSTR Brand,
[in] long Number,
(Brand abbreviation)
(Number)
(Year of manufacture)
Identification via designation:

Function name:
Type:
Brief description:
Ident_Description
Method
Identifies in ESI[tronic] a vehicle via designation
Page 4 of 10
Call-up:
Detail:

HRESULT Ident_Description(
[in] BSTR Manufacturer,
[in] BSTR Model,
[in, optional, defaultvalue("")] BSTR Type,
[in, optional, defaultvalue(0)] single Litres,
[in, optional, defaultvalue(0)] short Kw,
(Manufacturer)
(Model range)
(Type)
(Liters)
(Output in kW)
Page 5 of 10
2.1.2. Vehicle selection

Function name:
Type:
Brief description:
Call-up:
Detail:
Ident_RB
Event
Sends the vehicle currently selected in ESI[tronic] to ext. application
whether the vehicle was identified by the KBA/RB code or
designation
ESI[tronic] ext. application
HRESULT Ident_RB(
[in] BSTR Brand,
[in] long Number,
[in] short Year);
(Brand abbreviation)
(Number)
2.1.3. Job card

Placing/retrieving fitter:
Function name:
Type:
Brief description:
Call-up:
Detail:
Fitter
Property
Place fitter in work card
HRESULT Fitter([out, retval] BSTR* pVal);
Function name:
Type:
Brief description:
Call-up:
Detail:
(Fitter)
Fitter
Property
Retrieve fitter from work card
HRESULT Fitter([in] BSTR pVal);
(Fitter)
Placing/retrieving order number:

Function name:
Type:
Brief description:
Call-up:
Detail:
OrderNo
Property
Place order number in work card
ext. application ESI[tr onic]
HRESULT OrderNo([out, retval] BSTR* pVal);
Function name:
Type:
Brief description:
Call-up:
Detail:
(Order number)
OrderNo
Property
Retrieve order number from work card
HRESULT OrderNo([in] BSTR pVal);
(Order number)
Page 6 of 10
Place ESI[tronic] ButtonText:

Function name:
Type:
Brief description:
Call-up:
Detail:
SndBtnTitle
Property
This property is used to place the send button text in the ESI[tronic] work
card. Only the first 10 characters are sent.
HRESULT SndBtnTitle([out, retval] VARIANT_BOOL* pVal); (Buttontext)
Sending work card data:

Process
1.
2.
3.
phase:
Initialization
Data acceptance
Completion
Initialization phase:
Function name:
Type:
Brief description:
Call-up:
Detail:
BeginData
Event
Initialization of data acceptance
HRESULT BeginData(
[in] short NumPositions,
[in] BSTR Currency,
[in] single VAT);
(Number of work card positions)

(Currency)
(Value added tax rate)
Data acceptance phase::

Function name:
DataItem
Type:
Event
Brief description:
Work card data sent to ext. application
Call-up:
Detail:
HRESULT DataItem(
[in] short PosNo,
[in] BSTR PosType,
[in] BSTR ArticleNo,
[in] BSTR ArticleDesc,
[in] single Quantity,
[in] BSTR Unit,
[in] single Discount,
[in] single SinglePrice);
Completion phase
Function name:
Type:
Brief description:
Call-up:
Detail:
(Position number)
(Type of position)
(Article no.)
(Manufacturer)
(Article designation)
(Quantity)
(Unit)
(Discount)
(Single-Price)
EndData
Event
Data acceptance completion
HRESULT EndData();
Page 7 of 10
2.1.4. ESI[tronic] framework program

Placing/retrieving language abbreviation:
Function name:
Type:
Brief description:
Call-up:
Detail:
Language
Property
Placing language abbreviations
HRESULT Language([out, retval] BSTR* pVal); (Language abb., see cha. 3)
Function name:
Type:
Brief description:
Call-up:
Detail:
Language
Property
Retrieving language abbreviation
HRESULT Language([in] BSTR pVal);
(Language abb., see cha. 3)
Placing/retrieving close ESI[tronic]:

Function name:
Type:
Brief description:
Call-up:
Detail:
CloseOnRelease
Property
This property is used to set, whether ESI[tronic] should be closed or not after
ending the COM clients
HRESULT CloseOnRelease([out, retval] VARIANT_BOOL* pVal);
Function name :
Type:
Brief description:
Call-up:
Detail:
(Flag:
TRUE/FALSE)
CloseOnRelease
Property
Retrieval of current property status
HRESULT CloseOnRelease([in] VARIANT_BOOL pVal);
(Flag: TRUE/FALSE)
Placing/retrieving minimize ESI[tronic] window:

Function name:
Type:
Brief description:
Call-up:
Detail:
Minimized
Property
This property is set to determine whether ESI[tronic] should be minimized or
not
HRESULT Minimized([out, retval] VARIANT_BOOL* pVal);
Function name:
Type:
Brief description:
Call-up:
Detail:
(Flag:
TRUE/FALSE)
Minimized
Property
Retrieval of current property status
HRESULT Minimized([in] VARIANT_BOOL pVal);
(Flag: TRUE/FALSE)
Page 8 of 10
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 Typbibliothek")
]
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;
. . .
[
uuid(73AF0232-F6CE-4AE7-93BC-F34D97D410AB),
helpstring("RepDoc Class")
]
coclass RepDoc {
[default] interface IRepDoc;
[default, source] dispinterface _IRepDocEvents;
};
[
odl,
uuid(CA9A7C1E-B4D0-4E59-ACD8-429154570A13),
helpstring("IRepDoc interface"),
dual,
oleautomation
]
interface IRepDoc : IDispatch {
[id(0x00000001)]
HRESULT Ident_KBA(
[in] short ManufacturerNo,
[in] short TypeModelNo,
[id(0x0000000b)]
HRESULT Ident_KBA2(
[in] BSTR ManufacturerNo,
[in] BSTR TypeModelNo,
[id(0x00000002)]
HRESULT Ident_RB(
[in] BSTR Brand,
[in] long Number,
[id(0x00000003)]
HRESULT Ident_Description(
[in] BSTR Model,
[in, optional, defaultvalue("")] BSTR Type,
[in, optional, defaultvalue(0)] single Litres,
[in, optional, defaultvalue(0)] short Kw,
. . .
[id(0x00000005), propget]
HRESULT Fitter([out, retval] BSTR* pVal);
[id(0x00000005), propput]
HRESULT Fitter([in] BSTR pVal);
Page 9 of 10
HRESULT OrderNo([out, retval] BSTR* pVal);
HRESULT OrderNo([in] BSTR pVal);
HRESULT Language([out, retval] BSTR* pVal);
HRESULT Language([in] BSTR pVal);
HRESULT CloseOnRelease([out, retval] VARIANT_BOOL* pVal);
HRESULT CloseOnRelease([in] VARIANT_BOOL pVal);
HRESULT Minimized([out, retval] VARIANT_BOOL* pVal);
HRESULT Minimized([in] VARIANT_BOOL pVal);
[id(0x0000000a), propget]
HRESULT SndBtnTitle([out, retval] BSTR* pVal);
[id(0x0000000a), propput]
HRESULT SndBtnTitle([in] BSTR pVal);
};
[
uuid(423886EE-9413-4365-8E5B-B92AF77C2FFE),
helpstring("_IRepDocEreignisschnittstelle")
]
dispinterface _IRepDocEvents
properties:
methods:
. . .
[id(0x00000002)]
HRESULT Ident_RB(
[in]
[in]
[in]
. . .
[id(0x00000004)]
HRESULT BeginData(
[in]
[in]
[in]
[id(0x00000005)]
HRESULT DataItem(
[in]
[in]
[in]
[in]
[in]
[in]
[in]
[in]
[in]
[id(0x00000006)]
HRESULT EndData();
};
};
BSTR Brand,
long Number,
short Year);
short NumPositions,
BSTR Currency,
single VAT);
short PosNo,
BSTR PosType,
BSTR ArticleNo,
BSTR Manufacturer,
BSTR ArticleDesc,
single Quantity,
BSTR Unit,
single Discount,
single SinglePrice);
Page 10 of 10
3.2. ESI[tronic] language abbreviation

Language
German
English
French
Spanish
Italian
Swedish
Portuguese
Finnish
Dutch
Danish
Norwegian
Czech
Polish
Hungarian
Croat
Romanian
Russian
Bulgarian
Turkish
Greek
Japanese
Chinese
Korean
Abbreviation
DE
EN
FR
ES
IT
SV
PT
FI
NL
DA
NO
CS
PL
HU
HR
RO
RU
BG
TR
GR
JP
CN
KR

ESI (Tronic) : COM Interface Specification For Vehicle Identification and Acceptance of Data From Work Card

Загружено:

Сведения о документе

Исходное описание:

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

ESI (Tronic) : COM Interface Specification For Vehicle Identification and Acceptance of Data From Work Card

Загружено:

Авторское право:

Доступные форматы

Page 1 of 10

Identification via KBA numbers, alphanumeric (new!):

no. "for 2.1")

Identification via RB code (KHKZ):

Identification via designation:

ext. application ESI[tronic]

2.1.2. Vehicle selection

2.1.3. Job card

Placing/retrieving order number:

Place ESI[tronic] ButtonText:

Sending work card data:

(Number of work card positions)

Data acceptance phase::

2.1.4. ESI[tronic] framework program

(Language abb., see cha. 3)

Placing/retrieving close ESI[tronic]:

Placing/retrieving minimize ESI[tronic] window:

3.2. ESI[tronic] language abbreviation

Вам также может понравиться