Software Design Document

Transcription

1 OSMA GmbH Software Design Document version 0.08 date: CAN2COM Protocol Carl-von-Ossietzky-Straße 3 D Bad Aibling Tel: / Fax: / info@speedsignal.de

2 Directory 1 Directory 2 Definition Protocol specification Interface Modes of operation Blockframe Command specification Summary State messages from vehicle ID 0x10 - Ignition ID 0x11 - Gearshift ID 0x12 - Illumination ID 0x13 - VIN ID 0x14 - Speed ID 0x15 - RPM ID 0x16 - Steering Wheel Buttons ID 0x17 - Time ID 0x18 - Fuel Tank Level ID 0x19 - Mileage ID 0x1A - Date Commands to the Interface Blockframe ID 0x01 - Request data ID 0x02 - set I/O ID 0x03 - read I/O ID 0x0E - config I/O ID 0x0F - config sendmask...12 Revision 1 page 2/13 release of document:

3 Definition 2 Definition 2.1 Protocol specification The protocol defines the transmission from vehicle data to an external device. It standardizes data from different vehicles Interface Data exchange happens with serial interface (RS232) with 9600 baud, 8 data bits, no parity, 1 stop bit (9600, 8n1) Modes of operation The C2C-Interface doesn't send automatically mode request data (ch ) auto send (ch ) discription Send the request commando, you'll receive the data or a corresponding error message, if the data aren't available. Send the configuration mask, you'll receive the corresponding data periodically or when the state has changed. It also possible to request data if you've enabled the autosend via config sendmask Blockframe Dataframe starts with STX and ends with ETX. All data and commands have to be sent in ASCII, except STX and ETX! array size value comment start of text 1 byte STX start of text, 0x02 command 1 byte *) 0x00.. 0xFF command, message id data n Byte *) 0x00.. 0xFF crc 1 byte *) 0x00.. 0xFF check sum, exor over command and data end of text 1 byte ETX end of text, 0x03 *) all databytes are transmitted in ASCII (0xAF: 'A' and 'F') Revision 1 page 3/13 release of document:

4 3 Command specification 3.1 Summary ID value 0x01 0x02 0x03 0x0E 0x0F request data set I/O read I/O config I/O config datamask 0x10 0x11 0x12 0x13 0x14 0x15 0x16 0x17 0x18 0x19 0x1A ignition gearshift illumination VIN (vehicle identification number) speed rpm steering wheel buttons time fuel tank level mileage in km date 3.2 State messages from vehicle ID 0x10 - Ignition Discription: state of the ignition Data: 1 Byte value Byte 0 (0x..) 0 no key 1 key in lock 2 1st position 3 2nd position Revision 1 page 4/13 release of document:

5 value Byte 0 (0x..) 4 start engine when state changes ID 0x11 - Gearshift state of the gearshift Data: 1 Byte value Byte 0 0x00 P *) 0x01 0x02 N *) 0x03 D *) 0x04 S *) reverse gear 0x05 tiptronik activated *) 0xFF no gear available *) if available on CAN when state changes ID 0x12 - Illumination state of the illumination Daten: 1 Byte value byte0 0x00 0x01 lights off parking light Revision 1 page 5/13 release of document:

6 value byte0 0x02 0x03 driving lights upper beam headlights when state changes ID 0x13 - VIN vehicle identification number Data: n Byte (17) value byte 0xn 0.. n VIN in ASCII every 5000ms ID 0x14 - Speed speed from the car Data: 2 Byte byte# 0 high byte 1 low byte speed [km/h] = Byte0Byte1 / 128 when state changes, max. every 100ms Revision 1 page 6/13 release of document:

7 3.2.6 ID 0x15 - RPM rounds per minute from the engine Data: 2 Byte byte# 0 high byte 1 low byte RPM = Byte0Byte1 / 4 when state changes, max. every 100ms ID 0x16 - Steering Wheel Buttons steering wheel buttons if no key is pushed all bits are zero, reserved bits are always initialized with zero Data: 4 Bytes byte# 4 data bytes byte 0 - BITn SKIP DOWN SKIP UP SKIP DOWN UP VOLUME - VOLUME + VOLUME byte 1 - BITn MENU BACKWARD MENU FORWARD MODE MUTE SOURCE END CALL ANSWER CALL PTT Revision 1 page 7/13 release of document:

8 ! reserved! Byte 2-3 BITn when state changes, max. every 100ms ID 0x17 - Time time of vehicle s clock Data: 3 Bytes byte# value hour minute second when state changes, every 1000ms ID 0x18 - Fuel Tank Level tank level Data: 1 Byte byte# value 0 0x00.. 0xFF tank level in litre when state changes ID 0x19 - Mileage Verwendung: Revision 1 page 8/13 release of document:

9 Data: 4 Bytes milage in kilometre byte# 0 high Byte low Byte Mileage [km] = Byte0Byte1Byte2Byte3 / 100 (request command: 0x02 0x30 0x31 0x31 0x39 0x31 0x38 0x03) every 5000ms ID 0x1A - Date date from the vehicle Data: 3 Bytes byte# value day month first digits of year, e.g last digits of year, e.g. 07 e.g. 16nd April 2007, on RS232 you'll receive [STX] [crc][STX] when state changes, every 5000ms 3.3 Commands to the Interface Blockframe Blockframe for commands to the CAN-Interfice like in defined. Revision 1 page 9/13 release of document:

10 3.3.2 ID 0x01 - Request data Data: Request particular data from the vehicle. Respond from the CAN-Interface: see above (4.2.x) If an requested data isn't availabile, the command 0xFF with the requested ID as databyte is sended as respond. 4 Bytes byte value 0 0x02 STX 1 0x01 command: request data 2 0xXX id from the data you request 3 crc checksum: 0xCC = 0x01 ^0xXX 4 0x03 ETX Example: request: illumination respond: if data is available, upper beam headlights sendframe [STX][0x01][0x12][0x13][ETX] [STX][0x10][0x03][0x13][ETX] respond: if data isn't available [STX][0xFF][0x10][0xEF][ETX] On the RS232 line you see the frame [STX][0x01][0x12][0x13][ETX] as follows: [STX]011213[ETX] ID 0x02 - set I/O!!! not implemented yet!!! Descripiton: set I/O ports, ON = 12V (0xFF), OFF = 0V (0x00) Data: 5 Bytes byte# value 0 0x02 STX 1 0x02 command: set I/O 2 port select I/O port (0x x03) Revision 1 page 10/13 release of document:

11 byte# value 3 state state: 0x00 = OFF (0V), 0xFF = ON (12V) 4 crc checksum = byte#1 ^ byte#2 ^ byte#3 5 0x03 ETX Example: set I/O #2 to 12V sendframe [STX][0x02][0x01][0xFF][crc][ETX] ID 0x03 - read I/O!!! not implemented yet!!! Descripiton: read I/O ports databyte from respond: 0x00 low level (0V), 0xFF high level (12V) Data: 1 Byte Request: byte# value 0 0x02 STX 1 0x03 command: read I/O 2 port select I/O port (0x x03) 3 crc checksum = byte#1 ^ byte#2 4 0x03 ETX Example: request port#2 respond port#2 (low level) respond port#2 (high level) sendframe [STX][0x03][0x01][ETX] [STX][0x03][0x01][0x00][ETX] [STX][0x03][0x01][0xFF][ETX] on request Revision 1 page 11/13 release of document:

12 3.3.5 ID 0x0E - config I/O!!! not implemented yet!!! Data: config I/O ports to input or output BITn = 0, input (default) BITn = 1, output 1 Byte byte# value 0 0x02 STX 1 0x0E command: config I/O 2 mask e.g. 0x0A, port#3 and #1 are set to outputs 3 crc checksum = byte#1 ^ byte#2 4 0x03 ETX byte 0 - BITn I/O #3 I/O #2 I/O #1 I/O # ID 0x0F - config sendmask If the bit is set to one, the corresponding data from the vehicle will be sent periodically or when the state changes. BITn = 1, enable sending BITn = 0, disable sending (default) To configurate the sendmask successfully you've to send all 28 databytes. Unused Bits/Bytes configure with zero. As answer you'll receive the same message with edit data bytes, if a bit is set to zero the requested data isn't available, but will be send as soon as its available. If config message and received answer are eqal all data are avialable. Data: 28 Bytes Revision 1 page 12/13 release of document:

13 byte# n maskbytes byte 0 - BITn TIME LKF RPM SPEED FIN ILLUMINATION GEARSHIFT IGNITION byte 1 - BITn DATE MILEAGE FUELLEVEL! reserved! Byte 2-27 BITn Respond: error, false config message configuration successfully Send format [STX][0xFF][0x0F][0xF0][ETX] [STX][0x0F]'n data bytes'[etx] Revision 1 page 13/13 release of document: