Upload
rata-katy
View
213
Download
0
Embed Size (px)
Citation preview
7/25/2019 ESI_COM_DE
1/10
Seite 1 von 10
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
ESI[tronic]
COM-Schnittstellenbeschreibungzur Fahrzeugidentifikation und
zur bernahme von Daten aus der Arbeitskarte
Stand: 03.05.06
Version 1.2
Kontakt:Email: [email protected]: www.esitronic.comFax: +49 (0) 180 5812310
Dokument:
ESI_COM.PDF (aus Quelldatei ESI_COM.DOC erstellt)
7/25/2019 ESI_COM_DE
2/10
Seite 2 von 10
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
Inhaltsverzeichnis
1. Zielsetzung ................................................................................................................................32. Schnittstelle ...............................................................................................................................3
2.1. Beschreibung.......................................................................................................................32.1.1. Fahrzeugidentifikation ....................................................................................................3
2.1.2. Fahrzeugselektion ..........................................................................................................52.1.3. Arbeitskarte ...................................................................................................................52.1.4. ESI[tronic] Rahmenprogramm ........................................................................................7
3. Anhang......................................................................................................................................83.1. TypeLib ...............................................................................................................................83.2. ESI[tronic] Sprachkrzel .....................................................................................................10
7/25/2019 ESI_COM_DE
3/10
Seite 3 von 10
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
1.Zielsetzung
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 undsind im folgenden detailliert beschrieben. ESI[tronic] wird dabei ausschlielich als COMServer einge-setzt.
2.1.Beschreibung
2.1.1.
Fahrzeugidentifikation
Identifikation ber KBA-Nummer, numerisch (veraltet):
Funktionsname: Ident_KBATyp: MethodeKurzbeschreibung: Identifiziert in ESI[tronic] ein Fahrzeug ber KBA- Nummer (numerisch)
Aufruf: ext. AnwendungESI[tronic]Detail:
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)
Identifikation ber KBA-Nummer, alphanumerisch (neu!):
Funktionsname: Ident_KBA2Typ: MethodeKurzbeschreibung: Identifiziert in ESI[tronic] ein Fahrzeug ber KBA- Nummer (alphanumerisch)
Aufruf: ext. AnwendungESI[tronic]Detail:
HRESULT Ident_KBA2([in] BSTR ManufacturerNo, (Fahrzeugherst., Schlssel-Nr. zu 2.1)[in] BSTR TypeModelNo, (Typ/Ausfhrung, Schlssel-Nr. zu 2.2
(nur die ersten 3 Stellen))[in, optional, defaultvalue(0)] short Year); (Erstzul., Zeile 32)
Identifikation ber RB-Schlssel (KHKZ):
Funktionsname: Ident_RBTyp: MethodeKurzbeschreibung: Identifiziert in ESI[tronic] ein Fahrzeug ber RB-Schlssel
Aufruf: ext. AnwendungESI[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_DescriptionTyp: Methode
7/25/2019 ESI_COM_DE
4/10
Seite 4 von 10
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
Kurzbeschreibung: Identifiziert in ESI[tronic] ein Fahrzeug ber BezeichnungAufruf: ext. AnwendungESI[tronic]Detail:
HRESULT Ident_Description([in] BSTR Manufacturer, (Hersteller)[in] BSTR Model, (Modellreihe)[in, optional, defaultvalue("")] BSTR Type, (Typ)
[in, optional, defaultvalue(0)] single Litres, (Liter)[in, optional, defaultvalue(0)] short Kw, (Leistung in kW)[in, optional, defaultvalue(0)] short Year); (Baujahr)
7/25/2019 ESI_COM_DE
5/10
Seite 5 von 10
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
2.1.2.Fahrzeugselektion
Funktionsname: Ident_RBTyp: Event
Kurzbeschreibung: Sendet das aktuell in ESI[tronic] selektierte Fahrzeug an ext. Anwendung,unabhngig davon, ob die Fahrzeugidentifikation ber KBA-/RB-Schlssel oderBezeichnung durchgefhrt wurde
Aufruf: ESI[tronic] ext. AnwendungDetail:
HRESULT Ident_RB([in] BSTR Brand, (Markenkurzzeichen)[in] long Number, (Nummer)[in] short Year); (Baujahr)
2.1.3.Arbeitskarte
Monteur setzen/holen:
Funktionsname: FitterTyp: PropertyKurzbeschreibung: Monteur in Arbeitskarte setzen
Aufruf: ext. AnwendungESI[tronic]Detail:
HRESULT Fitter([out, retval] BSTR* pVal); (Monteur)
Funktionsname: FitterTyp: PropertyKurzbeschreibung: Monteur aus Arbeitskarte holen
Aufruf: ext. Anwendung ESI[tronic]Detail:
HRESULT Fitter([in] BSTR pVal); (Monteur)
Auftragsnummer setzen/holen:
Funktionsname: OrderNoTyp: PropertyKurzbeschreibung: Auftragsnummer in Arbeitskarte setzen
Aufruf: ext. AnwendungESI[tronic]Detail:
HRESULT OrderNo([out, retval] BSTR* pVal); (Auftragsnummer)
Funktionsname: OrderNoTyp: PropertyKurzbeschreibung: Auftragsnummer aus Arbeitskarte holen
Aufruf: ext. Anwendung ESI[tronic]Detail:
HRESULT OrderNo([in] BSTR pVal); (Auftragsnummer)
7/25/2019 ESI_COM_DE
6/10
Seite 6 von 10
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
ESI[tronic] ButtonText setzen:
Funktionsname: SndBtnTitleTyp: PropertyKurzbeschreibung: 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. AnwendungESI[tronic]Detail:
HRESULT SndBtnTitle([out, retval] VARIANT_BOOL* pVal); (Buttontext)
Senden der Arbeitskartendaten:
Ablaufphasen:1. Initialisierung
2. Datenbernahme
3. Abschluss
Phase Initialisierung:
Funktionsname: BeginDataTyp: EventKurzbeschreibung: Initialisierung der Datenbernahme
Aufruf: ESI[tronic] ext. AnwendungDetail:
HRESULT BeginData([in] short NumPositions, (Anzahl Arbeitskarten-Positionen)[in] BSTR Currency, (Whrung)[in] single VAT); (Mehrwertsteuersatz)
Phase Datenbernahme:
Funktionsname: DataItemTyp: EventKurzbeschreibung: Daten der Arbeitskarte werden an ext. Anwendung gesendet
Aufruf: ESI[tronic] ext. AnwendungDetail:
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: EndDataTyp: EventKurzbeschreibung: Abschluss der Datenbernahme
Aufruf: ESI[tronic] ext. AnwendungDetail:
HRESULT EndData();
7/25/2019 ESI_COM_DE
7/10
Seite 7 von 10
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
2.1.4.ESI[tronic] Rahmenprogramm
Sprachkrzel setzen/holen:
Funktionsname: LanguageTyp: PropertyKurzbeschreibung: Sprachkrzel setzen
Aufruf: ext. AnwendungESI[tronic]Detail:
HRESULT Language([out, retval] BSTR* pVal); (Sprachkrzel, s. Kap.3)
Funktionsname: LanguageTyp: PropertyKurzbeschreibung: Sprachkrzel holen
Aufruf: ext. Anwendung ESI[tronic]Detail:
HRESULT Language([in] BSTR pVal); (Sprachkrzel, s. Kap.3)
ESI[tronic] schlieen setzen/holen:
Funktionsname: CloseOnReleaseTyp: PropertyKurzbeschreibung: ber dieses Property wird gesetzt, ob ESI[tronic] nach Beendigung des COM-
Clients geschlossen werden soll oder nichtAufruf: ext. AnwendungESI[tronic]Detail:
HRESULT CloseOnRelease([out, retval] VARIANT_BOOL* pVal); (Flag:TRUE/FALSE)
Funktionsname: CloseOnReleaseTyp: PropertyKurzbeschreibung: Abholen des aktuellen Propertystatus
Aufruf: ext. Anwendung ESI[tronic]Detail:
HRESULT CloseOnRelease([in] VARIANT_BOOL pVal); (Flag: TRUE/FALSE)
ESI[tronic] Fenster minimieren setzen/holen:
Funktionsname: Minimized
Typ: PropertyKurzbeschreibung: ber dieses Property wird gesetzt, ob ESI[tronic] minimiert werden soll odernicht
Aufruf: ext. Anwendung ESI[tronic]Detail:
HRESULT Minimized([out, retval] VARIANT_BOOL* pVal); (Flag:TRUE/FALSE)
Funktionsname: MinimizedTyp: PropertyKurzbeschreibung: Abholen des aktuellen Propertystatus
Aufruf: ext. Anwendung ESI[tronic]Detail:
HRESULT Minimized([in] VARIANT_BOOL pVal); (Flag: TRUE/FALSE)
7/25/2019 ESI_COM_DE
8/10
Seite 8 von 10
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
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 typelibinterface 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]
7/25/2019 ESI_COM_DE
9/10
Seite 9 von 10
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
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();
};};
7/25/2019 ESI_COM_DE
10/10
Seite 10 von 10
Copyright Robert Bosch GmbH, Automotive Aftermarket, Product Marketing Diagnostics & Test Equipment
3.2.ESI[tronic] Sprachkrzel
Sprache Krzel
Deutsch DEEnglisch ENFranzsisch FRSpanisch ESItalienisch ITSchwedisch SVPortugiesisch PTFinnisch FINiederlndisch NLDnisch DANorwegisch NO
Tschechisch CSPolnisch PLUngarisch HUKroatisch HRRumnisch RORussisch RUBulgarisch BGTrkisch TRGriechisch GR
Japanisch JPChinesisch CN
Koreanisch KR