Академический Документы
Профессиональный Документы
Культура Документы
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)
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
Seite 2 von 10
Inhaltsverzeichnis
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] Sprachkrzel .....................................................................................................10
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
Seite 3 von 10
1. Zielsetzung
Beschreibung/Bereitstellung einer Kommunikationsschnittstelle zwischen ESI[tronic] und einer externen 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 ausschlielich als COMServer eingesetzt.
2.1. Beschreibung
2.1.1. Fahrzeugidentifikation
Identifikation ber KBA - Nummer, numerisch (veraltet):
Funktionsname:
Typ:
Kurzbeschreibung:
Aufruf:
Detail:
Ident_KBA
Methode
Identifiziert in ESI[tronic] ein Fahrzeug ber KBA-Nummer (numerisch)
ext. Anwendung ESI[tronic]
HRESULT Ident_KBA(
[in] short ManufacturerNo, (Fahrzeugherst., Schlssel-Nr. zu 2)
[in] short TypeModelNo,
(Typ/Ausfhrung, Schlssel-Nr. zu 3)
[in, optional, defaultvalue(0)] short Year);
(Erstzul., Zeile 32)
Ident_KBA2
Methode
Identifiziert in ESI[tronic] ein Fahrzeug ber KBA-Nummer (alphanumerisch)
ext. Anwendung ESI[tronic]
HRESULT Ident_KBA2(
[in] BSTR ManufacturerNo,
[in] BSTR TypeModelNo,
Ident_RB
Methode
Identifiziert in ESI[tronic] ein Fahrzeug ber RB-Schlssel
ext. Anwendung ESI[tronic]
HRESULT Ident_RB(
[in] BSTR Brand,
[in] long Number,
[in, optional, defaultvalue(0)] short Year);
(Markenkurzzeichen)
(Nummer)
(Baujahr)
Ident_Description
Methode
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
Seite 4 von 10
Kurzbeschreibung:
Aufruf:
Detail:
(Hersteller)
(Modellreihe)
(Typ)
(Liter)
(Leistung in kW)
(Baujahr)
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
Seite 5 von 10
2.1.2. Fahrzeugselektion
Funktionsname:
Typ:
Kurzbeschreibung:
Aufruf:
Detail:
Ident_RB
Event
Sendet das aktuell in ESI[tronic] selektierte Fahrzeug an ext. Anwendung,
unabhngig davon, ob die Fahrzeugidentifikation ber KBA-/RB-Schlssel oder
Bezeichnung durchgefhrt wurde
ESI[tronic] ext. Anwendung
HRESULT Ident_RB(
[in] BSTR Brand,
[in] long Number,
[in] short Year);
(Markenkurzzeichen)
(Nummer)
(Baujahr)
2.1.3. Arbeitskarte
Monteur setzen/holen:
Funktionsname:
Typ:
Kurzbeschreibung:
Aufruf:
Detail:
Fitter
Property
Monteur in Arbeitskarte setzen
ext. Anwendung ESI[tronic]
HRESULT Fitter([out, retval] BSTR* pVal);
Funktionsname:
Typ:
Kurzbeschreibung:
Aufruf:
Detail:
(Monteur)
Fitter
Property
Monteur aus Arbeitskarte holen
ext. Anwendung ESI[tronic]
HRESULT Fitter([in] BSTR pVal);
(Monteur)
Auftragsnummer setzen/holen:
Funktionsname:
Typ:
Kurzbeschreibung:
Aufruf:
Detail:
OrderNo
Property
Auftragsnummer in Arbeitskarte setzen
ext. Anwendung ESI[tronic]
HRESULT OrderNo([out, retval] BSTR* pVal);
Funktionsname:
Typ:
Kurzbeschreibung:
Aufruf:
Detail:
(Auftragsnummer)
OrderNo
Property
Auftragsnummer aus Arbeitskarte holen
ext. Anwendung ESI[tronic]
HRESULT OrderNo([in] BSTR pVal);
(Auftragsnummer)
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
Seite 6 von 10
SndBtnTitle
Property
ber dieses Property wird der Text des Sende-Buttons in der Arbeitskarte von
ESI[tronic] gesetzt. Es werden nur die ersten zehn Zeichen bernommen.
ext. Anwendung ESI[tronic]
HRESULT SndBtnTitle([out, retval] VARIANT_BOOL* pVal); (Buttontext)
BeginData
Event
Initialisierung der Datenbernahme
ESI[tronic] ext. Anwendung
HRESULT BeginData(
[in] short NumPositions,
[in] BSTR Currency,
[in] single VAT);
(Anzahl Arbeitskarten-Positionen)
(Whrung)
(Mehrwertsteuersatz)
Phase Datenbernahme:
Funktionsname:
DataItem
Typ:
Event
Kurzbeschreibung: Daten der Arbeitskarte werden an ext. Anwendung gesendet
Aufruf:
ESI[tronic] ext. Anwendung
Detail:
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);
Phase Abschluss:
Funktionsname:
Typ:
Kurzbeschreibung:
Aufruf:
Detail:
(Positionsnummer)
(Positionstyp)
(Artikelnummer)
(Hersteller)
(Artikelbezeichnung)
(Menge)
(Einheit)
(Rabatt)
(Einzelpreis)
EndData
Event
Abschluss der Datenbernahme
ESI[tronic] ext. Anwendung
HRESULT EndData();
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
Seite 7 von 10
Language
Property
Sprachkrzel setzen
ext. Anwendung ESI[tronic]
HRESULT Language([out, retval] BSTR* pVal); (Sprachkrzel, s. Kap.3)
Funktionsname:
Typ:
Kurzbeschreibung:
Aufruf:
Detail:
Language
Property
Sprachkrzel holen
ext. Anwendung ESI[tronic]
HRESULT Language([in] BSTR pVal);
(Sprachkrzel, s. Kap.3)
CloseOnRelease
Property
ber dieses Property wird gesetzt, ob ESI[tronic] nach Beendigung des COMClients geschlossen werden soll oder nicht
ext. Anwendung ESI[tronic]
HRESULT CloseOnRelease([out, retval] VARIANT_BOOL* pVal);
Funktionsname:
Typ:
Kurzbeschreibung:
Aufruf:
Detail:
(Flag:
TRUE/FALSE)
CloseOnRelease
Property
Abholen des aktuellen Propertystatus
ext. Anwendung ESI[tronic]
HRESULT CloseOnRelease([in] VARIANT_BOOL pVal);
(Flag: TRUE/FALSE)
Minimized
Property
ber dieses Property wird gesetzt, ob ESI[tronic] minimiert werden soll oder
nicht
ext. Anwendung ESI[tronic]
HRESULT Minimized([out, retval] VARIANT_BOOL* pVal);
Funktionsname:
Typ:
Kurzbeschreibung:
Aufruf:
Detail:
(Flag:
TRUE/FALSE)
Minimized
Property
Abholen des aktuellen Propertystatus
ext. Anwendung ESI[tronic]
HRESULT Minimized([in] VARIANT_BOOL pVal);
(Flag: TRUE/FALSE)
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
Seite 8 von 10
3. Anhang
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-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
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);
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
Seite 10 von 10
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment