Sie sind auf Seite 1von 10

Seite 1 von 10

ESI[tronic]

COM-Schnittstellenbeschreibung zur Fahrzeugidentifikation und zur Übernahme von Daten aus der Arbeitskarte

Stand: 03.05.06

Version 1.2

Kontakt:

Email:

ESItronic@msw-stuttgart.de

Web:

www.esitronic.com

Fax:

+49 (0) 180 5812310

Dokument:

ESI_COM.PDF (aus Quelldatei ESI_COM.DOC erstellt)

Inhaltsverzeichnis

Seite 2 von 10

1. Zielsetzung

3

2. Schnittstelle

3

2.1.

Beschreibung

3

2.1.1.

Fahrzeugidentifikation

3

2.1.2.

Fahrzeugselektion

5

2.1.3.

Arbeitskarte

5

2.1.4.

ESI[tronic] Rahmenprogramm

7

3. Anhang

8

3.1. TypeLib

8

3.2. ESI[tronic] Sprachkürzel

10

1. Zielsetzung

Seite 3 von 10

Beschreibung/Bereitstellung einer Kommunikationsschnittstelle zwischen ESI[tronic] und einer exter- nen Anwendung.

2. Schnittstelle

Die zu realisierenden Funktionen basieren auf der von Microsoft entwickelten COM-Technologie und sind im folgenden detailliert beschrieben. ESI[tronic] wird dabei ausschließlich als COM–Server einge- setzt.

2.1. Beschreibung

2.1.1. Fahrzeugidentifikation

Identifikation über KBA - Nummer, numerisch (veraltet):

Funktionsname:

Ident_KBA

Typ:

Methode

Kurzbeschreibung:

Identifiziert in ESI[tronic] ein Fahrzeug über KBA-Nummer (numerisch)

Aufruf:

ext. Anwendung ESI[tronic]

Detail:

HRESULT Ident_KBA(

[in] short ManufacturerNo, (Fahrzeugherst., Schlüssel-Nr. „zu 2“)

[in] short TypeModelNo,

(Typ/Ausführung, Schlüssel-Nr. „zu 3“)

[in, optional, defaultvalue(0)] short Year);

(Erstzul., Zeile 32)

Identifikation über KBA - Nummer, alphanumerisch (neu!):

Funktionsname:

Ident_KBA2

Typ:

Methode

Kurzbeschreibung:

Identifiziert in ESI[tronic] ein Fahrzeug über KBA-Nummer (alphanumerisch)

Aufruf:

ext. Anwendung ESI[tronic]

Detail:

HRESULT Ident_KBA2(

[in] BSTR ManufacturerNo, (Fahrzeugherst., Schlüssel-Nr. „zu 2.1“)

[in] BSTR TypeModelNo,

(Typ/Ausführung, Schlüssel-Nr. „zu 2.2“ (nur die ersten 3 Stellen))

[in, optional, defaultvalue(0)] short Year);

(Erstzul., Zeile 32)

Identifikation über RB-Schlüssel (KHKZ):

Funktionsname:

Ident_RB

Typ:

Methode

Kurzbeschreibung:

Identifiziert in ESI[tronic] ein Fahrzeug über RB-Schlüssel

Aufruf:

ext. Anwendung ESI[tronic]

Detail:

HRESULT Ident_RB( [in] BSTR Brand,

(Markenkurzzeichen)

[in] long Number,

(Nummer)

[in, optional, defaultvalue(0)] short Year);

(Baujahr)

Identifikation über Bezeichnung:

Funktionsname:

Ident_Description

Typ:

Methode

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

Seite 4 von 10

Kurzbeschreibung:

Identifiziert in ESI[tronic] ein Fahrzeug über Bezeichnung

Aufruf:

ext. Anwendung ESI[tronic]

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, [in, optional, defaultvalue(0)] short Year);

(Hersteller) (Modellreihe) (Typ) (Liter) (Leistung in kW) (Baujahr)

Seite 5 von 10

2.1.2. Fahrzeugselektion

Funktionsname:

Ident_RB

Typ:

Event

Kurzbeschreibung:

Sendet das aktuell in ESI[tronic] selektierte Fahrzeug an ext. Anwendung,

Aufruf:

unabhängig davon, ob die Fahrzeugidentifikation über KBA-/RB-Schlüssel oder Bezeichnung durchgeführt wurde ESI[tronic] ext. Anwendung

Detail:

 

HRESULT Ident_RB( [in] BSTR Brand,

(Markenkurzzeichen)

[in] long Number,

(Nummer)

[in] short Year);

(Baujahr)

2.1.3.

Arbeitskarte

‚Monteur’ setzen/holen:

 

Funktionsname:

Fitter

Typ:

Property

Kurzbeschreibung:

 

Aufruf:

Monteur in Arbeitskarte setzen ext. Anwendung ESI[tronic]

Detail:

 

HRESULT Fitter([out, retval] BSTR* pVal);

(Monteur)

Funktionsname:

Fitter

 

Typ:

Property

Kurzbeschreibung:

 

Aufruf:

Monteur aus Arbeitskarte holen ext. Anwendung ESI[tronic]

Detail:

 

HRESULT Fitter([in] BSTR pVal);

(Monteur)

‚Auftragsnummer’ setzen/holen:

 

Funktionsname:

OrderNo

Typ:

Property

Kurzbeschreibung:

Auftragsnummer in Arbeitskarte setzen

 

Aufruf:

ext. Anwendung

ESI[tronic]

Detail:

 

HRESULT OrderNo([out, retval] BSTR* pVal);

(Auftragsnummer)

Funktionsname:

OrderNo

 

Typ:

Property

Kurzbeschreibung:

 

Aufruf:

Auftragsnummer aus Arbeitskarte holen ext. Anwendung ESI[tronic]

Detail:

 

HRESULT OrderNo([in] BSTR pVal);

(Auftragsnummer)

Seite 6 von 10

ESI[tronic] ButtonText setzen:

Funktionsname:

SndBtnTitle

Typ:

Property

Kurzbeschreibung:

Über dieses Property wird der Text des Sende- Buttons in der Arbeitskarte von ESI[tronic] gesetzt. Es werden nur die ersten zehn Zeichen übernommen.

Aufruf:

ext. Anwendung

ESI[tronic]

Detail:

HRESULT SndBtnTitle([out, retval] VARIANT_BOOL* pVal); (Buttontext)

Senden der Arbeit skartendaten:

Ablaufphasen:

1. Initialisierung

2. Datenübernahme

3. Abschluss

Phase Initialisierung:

Funktionsname: BeginData

Typ:

Kurzbeschreibung: Initialisierung der Datenübernahme Aufruf: ESI[tronic] ext. Anwendung Detail:

Event

HRESULT BeginData( [in] short NumPositions, [in] BSTR Currency, [in] single VAT);

(Anzahl Arbeitskarten-Positionen) (Währung) (Mehrwertsteuersatz)

Phase Datenübernahme:

Funktionsname:

DataItem

Typ:

Event

Kurzbeschreibung:

Daten der Arbeitskarte werden an ext. Anwendung gesendet

Aufruf:

ESI[tronic] ext. Anwendung

Detail:

 

HRESULT DataItem( [in] short PosNo,

(Positionsnummer)

[in] BSTR PosType,

(Positionstyp)

[in] BSTR ArticleNo,

(Artikelnummer)

[in] BSTR Manufacturer,

(Hersteller)

[in] BSTR ArticleDesc,

(Artikelbezeichnung)

[in] single Quantity,

(Menge)

[in] BSTR Unit,

(Einheit)

[in] single Discount,

(Rabatt)

[in] single SinglePrice);

(Einzelpreis)

Phase Abschluss:

Funktionsname: EndData

Typ:

Kurzbeschreibung: Abschluss der Datenübernahme Aufruf: ESI[tronic] ext. Anwendung Detail:

Event

HRESULT EndData();

Seite 7 von 10

2.1.4. ESI[tronic] Rahmenprogramm

‚Sprachkürzel’ setzen/holen:

Funktionsname:

Language

Typ:

Property

Kurzbeschreibung:

Sprachkürzel setzen

Aufruf:

ext. Anwendung ESI[tronic]

Detail:

HRESULT Language([out, retval] BSTR* pVal); (Sprachkürzel, s. Kap.3)

Funktionsname: Language

Typ:

Kurzbeschreibung: Sprachkürzel holen Aufruf: ext. Anwendung ESI[tronic]

Detail:

Property

HRESULT Language([in] BSTR pVal);

‚ESI[tronic] schließen’ setzen/holen:

(Sprachkürzel, s. Kap.3)

Funktionsname:

CloseOnRelease

Typ:

Property

Kurzbeschreibung:

Über dieses Property wird gesetzt, ob ESI[tronic] nach Beendigung des COM- Clients geschlossen werden soll oder nicht

Aufruf:

ext. Anwendung

ESI[tronic]

Detail:

 

HRESULT CloseOnRelease([out, retval] VARIANT_BOOL* pVal); (Flag:

 

TRUE/FALSE)

Funktionsname:

CloseOnRelease

Typ:

Property

Kurzbeschreibung:

Abholen des aktuellen Propertystatus

Aufruf:

ext. Anwendung ESI[tronic]

Detail:

HRESULT CloseOnRelease([in] VARIANT_BOOL pVal);

‚ESI[tronic] Fenster minimieren’ setzen/holen:

(Flag: TRUE/FALSE)

Funktionsname:

Minimized

Typ:

Property

Kurzbeschreibung:

Über dieses Property wird gesetzt, ob ESI[tronic] minimiert werden soll oder

Aufruf:

nicht ext. Anwendung ESI[tronic]

Detail:

 

HRESULT Minimized([out, retval] VARIANT_BOOL* pVal);

(Flag:

 

TRUE/FALSE)

Funktionsname:

Minimized

Typ:

Property

Kurzbeschreibung:

Abholen des aktuellen Propertystatus

Aufruf:

ext. Anwendung ESI[tronic]

Detail:

HRESULT Minimized([in] VARIANT_BOOL pVal);

(Flag: TRUE/FALSE)

3. Anhang

3.1. TypeLib

Seite 8 von 10

// 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 -Schnittstelle"), dual, oleautomation

 

]

interface IRepDoc : IDispatch {

 

[id(0x00000001)]

HRESULT Ident_KBA( [in] short ManufacturerNo, [in] short TypeModelNo, [in, optional, defaultvalue(0)] short Year);

[id(0x0000000b)]

HRESULT Ident_KBA2( [in] BSTR ManufacturerNo, [in] BSTR TypeModelNo, [in, optional, defaultvalue(0)] short Year);

[id(0x00000002)]

HRESULT Ident_RB( [in] BSTR Brand, [in] long Number, [in, optional, defaultvalue(0)] short Year);

[id(0x00000003)]

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, [in, optional, defaultvalue(0)] short Year);

.

.

.

 

[id(0x00000005), propget] HRESULT Fitter([out, retval] BSTR* pVal); [id(0x00000005), propput] HRESULT Fitter([in] BSTR pVal); [id(0x00000006), propget]

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

Seite 9 von 10

HRESULT OrderNo([out, retval] BSTR* pVal); [id(0x00000006), propput] HRESULT OrderNo([in] BSTR pVal); [id(0x00000007), propget] HRESULT Language([out, retval] BSTR* pVal); [id(0x00000007), propput] HRESULT Language([in] BSTR pVal); [id(0x00000008), propget] HRESULT CloseOnRelease([out, retval] VARIANT_BOOL* pVal); [id(0x00000008), propput] HRESULT CloseOnRelease([in] VARIANT_BOOL pVal); [id(0x00000009), propget] HRESULT Minimized([out, retval] VARIANT_BOOL* pVal); [id(0x00000009), propput] 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] BSTR Brand, [in] long Number, [in] short Year);

.

.

.

 

[id(0x00000004)]

HRESULT BeginData( [in] short NumPositions, [in] BSTR Currency, [in] single VAT);

[id(0x00000005)]

HRESULT DataItem( [in] short PosNo, [in] BSTR PosType, [in] BSTR ArticleNo, [in] BSTR Manufacturer, [in] BSTR ArticleDesc, [in] single Quantity, [in] BSTR Unit, [in] single Discount, [in] single SinglePrice);

[id(0x00000006)]

HRESULT EndData();

 

};

};

Seite 10 von 10

3.2. ESI[tronic] Sprachkürzel

Sprache

Kürzel

Deutsch

DE

Englisch

EN

Französisch

FR

Spanisch

ES

Italienisch

IT

Schwedisch

SV

Portugiesisch

PT

Finnisch

FI

Niederländisch

NL

Dänisch

DA

Norwegisch

NO

Tschechisch

CS

Polnisch

PL

Ungarisch

HU

Kroatisch

HR

Rumänisch

RO

Russisch

RU

Bulgarisch

BG

Türkisch

TR

Griechisch

GR

Japanisch

JP

Chinesisch

CN

Koreanisch

KR