ISO 22900-3:2012
Road vehicles — Modular vehicle communication interface (MVCI) — Part 3: Diagnostic server application programming interface (D-Server API)
ISO 22900-3:2012 focuses on the description of an object-oriented programming interface. The objective is the ability to implement server applications, used during the design, production and maintenance phase of a vehicle communication system, compatible to each other and thus exchangeable. From a user's perspective, access and integration of on-board control units is provided by a corresponding application, the communication server and a VCI module for diagnostics. The user is granted access for the handling of control units (ECUs) in vehicles for the diagnostic services.
| Get this standard | Prices exclude GST | |
|---|---|---|
| PDF ( Single user document) |
$429.00 NZD
|
|
| HardCopy |
$473.00 NZD
|
|
| Networkable PDF |
Price varies
|
1 Scope
2 Normative references
3 Terms, definitions, symbols and abbreviated terms
3.1 Terms and definitions
3.2 Symbols
3.3 Abbreviated terms
4 Conventions
4.1 General
4.2 Typographical conventions and mnemonics
4.3 Sequence diagrams
4.4 Stereotypes
5 Specification release version information
6 Structure of a MVCI diagnostic server
7 Diagnostic server
7.1 MCD system object
7.2 Description of terms
7.2.1 General
7.2.2 Access key (AccessKey)
7.2.3 Functional Class (FUNCTIONAL-CLASS)
7.2.4 Job (SINGLE-ECU-JOB, MULTIPLE-ECU-JOB)
7.2.5 Location
7.2.6 Logical Link (LOGICAL-LINK)
7.2.7 Physical Interface Link
7.2.8 Physical Link
7.2.9 Physical Vehicle Link (PHYSICAL-VEHICLE-LINK)
7.2.10 Project
7.3 Version information retrieval
7.4 States of the MCD system
7.5 State changes
7.6 Project configuration
7.7 Interface structure of server API
7.7.1 Hierarchical model overview
7.7.2 Database and runtime side
7.7.2.1 Basics
7.7.2.2 Structure of the database
7.7.2.3 Structure of the runtime side
7.7.3 Parent functionality
7.7.4 Entity Relationship Diagrams
7.7.4.1 Objective
7.7.4.2 Relation between Vehicle Connector Information Table and Logical Link Table
7.7.4.3 ERD DbLocation
7.7.4.4 ERD Logical Link and DiagComPrimitives
7.7.4.5 ERD Request and Response Parameter associations
7.7.4.6 ERD result access
7.7.4.7 ERD Jobs
7.7.5 ODX Data Type mapping for database and runtime side
7.7.5.1 Basics
7.7.5.2 eSTRUCTURE
7.7.5.3 eFIELD
7.7.5.4 eEND_OF_PDU
7.7.5.5 eMULTIPLEXER
7.7.5.6 eENVDATADESC
7.8 Collections
7.8.1 Types and methods
7.8.2 RunTime collections
7.8.3 Database collections
7.9 Registering/deregistering of the EventHandler
7.10 MCD value
7.11 Use cases
7.11.1 View
7.11.2 Instantiation of projects
7.11.3 Database access
7.11.4 Destruction
8 Function block Diagnostic in detail
8.1 Constraints
8.2 System Properties
8.3 Diagnostic DiagComPrimitives and Services
8.3.1 Diagnostic DiagComPrimitives
8.3.1.1 DCP types and hierarchy
8.3.1.2 States of DiagComPrimitives
8.3.2 Service overview
8.3.3 Non-cyclic single diagnostic service
8.3.4 Cyclic diagnostic service
8.3.5 Repeated diag service
8.3.6 Repeated send only diag service
8.3.7 Repeated receive only diag service
8.3.8 Summary
8.3.9 Protocol parameters
8.3.9.1 General
8.3.9.2 Introduction related to ISO 22901-1 ODX
8.3.9.3 Inheritance of protocol parameters
8.3.9.4 Runtime part
8.4 Suppress positive response
8.5 eEND_OF_PDU as RequestParameter
8.5.1 Database side
8.5.2 Runtime side
8.6 Variable length parameters
8.7 Variant identification
8.7.1 Interpretation algorithm
8.7.2 Identification algorithm
8.7.3 Request and ResponseParameter of VI and VIS
8.7.3.1 General
8.7.3.2 RequestParameter structure
8.7.3.3 ResponseParameter structure
8.7.4 Service handling in cases of different locations
8.7.5 Variant Patterns and Matching Parameters
8.8 Use cases
8.8.1 Create Logical Link and use DiagComPrimitives
8.8.2 Removal of communication objects
8.8.3 Service handling
8.8.3.1 Non-cyclic diag service execution
8.8.3.2 Cyclic diag service execution
8.8.4 Result access
8.8.5 Error handling in results
8.9 Read DTC
8.9.1 ODX Data for Example Read DTC
8.9.2 Reading without FaultMemories
8.9.3 Reading with FaultMemories
8.9.4 DTC Read Service
8.10 Logical Link
8.10.1 Connection overview
8.10.2 State diagram of Logical Link
8.10.3 VCI communication lost handling
8.10.3.1 Basics
8.10.3.2 Example of how a client could behave upon receiving onInterfaceError or onStaticInterfaceError
8.10.4 Logical Link examples
8.11 Functional addressing
8.12 Tables
8.12.1 General
8.12.2 Usage of tables within DiagComPrimitives
8.13 Dynamically Defined Identifiers (DynId)
8.13.1 General
8.13.2 DYNID principle and requirements
8.13.3 Lifecycle
8.13.3.1 General
8.13.3.2 Creation of dynamically defined identifier
8.13.3.3 Reading by dynamically defined identifier
8.13.3.4 Deletion of dynamically defined identifier
8.13.3.5 DB-Templates for requests and responses regarding dynamically defined identifier
8.13.3.6 Procedure description
8.14 Internationalization
8.14.1 Multi language support
8.14.2 Units
8.15 Special Data Groups
8.16 ECU (re)programming
8.16.1 Goal
8.16.2 Structuring of the function block flash
8.16.2.1 Database part
8.16.2.2 Online part
8.16.2.3 Progress information
8.16.2.4 Ident mechanism
8.16.3 ECU-MEM
8.17 Handling binary flash data
8.17.1 Late-bound data files
8.17.2 Wildcards in data file names
8.17.3 Flash segment iterator
8.18 Library
8.19 Jobs
8.19.1 General
8.19.2 Input and output parameters
8.19.3 Job result
8.19.4 Single ECU jobs
8.19.5 FlashJobs
8.19.6 Multiple ECU jobs
8.19.7 Job execution
8.19.7.1 Single execution of a Job
8.19.7.2 Repeated execution of Job
8.19.8 Allowed java libraries
8.19.9 Naming conventions
8.19.10 Job Communication Parameter handling
8.19.11 Job Result Generation
8.19.12 Job template SingleEcuJob
8.19.13 Job template MultipleEcuJob
8.19.14 Job template FlashJob
8.20 ECU configuration
8.20.1 Introduction
8.20.2 ECU Configuration database part
8.20.3 ECU Configuration Runtime Part
8.20.4 Error Handling
8.20.5 Initialising an MCDConfigurationRecord
8.20.6 Offline versus Online Configuration
8.20.7 Uploading and Downloading Configuration Strings
8.20.7.1 Basics
8.20.7.2 Decomposing a Configuration String for Transfer
8.20.7.3 Downloading configuration records to an ECU
8.20.7.4 Uploading configuration records from an ECU
8.21 Audiences and additional audiences
8.21.1 General
8.21.2 Audiences
8.21.3 Additional Audiences
8.22 ECU states
8.23 Function dictionary
8.23.1 General
8.23.2 Functions and funtion groups in ODX
8.23.3 Function dictionary data model description
8.23.4 Uniqueness of MVCI diagnostic server function dictionary data resolution
8.23.4.1 MVCI server resolution
8.23.4.2 Example 1
8.23.4.3 Example 2
8.23.4.4 Example 3
8.23.4.5 Example 4
8.23.4.6 Example 5
8.23.5 Function dictionary usage scenario
8.24 Sub-Component data model description
8.24.1 Sub-Component data model
8.24.2 Sub-Component usage scenario
8.25 Monitoring vehicle bus traffic
8.26 Support of VCI module selection and other VCI module features according to ISO 22900-2
8.26.1 Introduction
8.26.2 Definitions
8.26.3 General behaviour of D-PDU API related MVCI diagnostic server methods
8.26.4 Overview of VCI module related classes
8.26.5 VCI module selection
8.26.6 MCDInterface
8.26.7 VCI module selection sequence
8.26.8 Interface status events
8.26.9 MCDInterfaceResource
8.26.10 Selection of an interface resource
8.26.11 Send Break Signal
8.26.12 MCDDbInterfaceCable
8.26.13 Accessing VCI module features
8.26.14 Behaviour of an MVCI diagnostic server not using the VCI Module API
8.27 Handling DoIP entities
8.27.1 General
8.27.2 Detection of DoIP entities
8.27.2.1 Basics
8.27.2.2 Detection of DoIP entities connected to the system
8.27.2.3 Detection of DoIP Entities connected to a specific MVCI device
8.27.3 Selection of DoIP Entities
8.28 Mapping of D-PDU API methods
8.28.1 Introduction
8.28.2 Initialization and Selection of VCI Modules
8.28.3 Communication on a Logical Link
8.28.4 Handling of Communication Parameters
8.28.4.1 Changing communication parameters from the client application
8.28.4.2 Setting temporary communication parameters for a DiagComPrimitive
8.28.4.3 Changing UNIQUE_ID Communication Parameters
8.28.5 MCDStartCommunication and MCDStopCommunication
8.28.6 D-PDU API IO-Control support
9 Error Codes
9.1 Principle
9.2 Description of the errors
9.2.1 Error-free behaviour
9.2.2 Parameterisation errors
9.2.3 RunTime/ProgramViolation errors
9.2.4 Database errors
9.2.5 System errors
9.2.6 Communication errors
9.2.7 Share error
Previous versions
Keep me up-to-date
Sign up to receive updates when there are changes to this standard
1 Scope
2 Normative references
3 Terms, definitions, symbols and abbreviated terms
3.1 Terms and definitions
3.2 Symbols
3.3 Abbreviated terms
4 Conventions
4.1 General
4.2 Typographical conventions and mnemonics
4.3 Sequence diagrams
4.4 Stereotypes
5 Specification release version information
6 Structure of a MVCI diagnostic server
7 Diagnostic server
7.1 MCD system object
7.2 Description of terms
7.2.1 General
7.2.2 Access key (AccessKey)
7.2.3 Functional Class (FUNCTIONAL-CLASS)
7.2.4 Job (SINGLE-ECU-JOB, MULTIPLE-ECU-JOB)
7.2.5 Location
7.2.6 Logical Link (LOGICAL-LINK)
7.2.7 Physical Interface Link
7.2.8 Physical Link
7.2.9 Physical Vehicle Link (PHYSICAL-VEHICLE-LINK)
7.2.10 Project
7.3 Version information retrieval
7.4 States of the MCD system
7.5 State changes
7.6 Project configuration
7.7 Interface structure of server API
7.7.1 Hierarchical model overview
7.7.2 Database and runtime side
7.7.2.1 Basics
7.7.2.2 Structure of the database
7.7.2.3 Structure of the runtime side
7.7.3 Parent functionality
7.7.4 Entity Relationship Diagrams
7.7.4.1 Objective
7.7.4.2 Relation between Vehicle Connector Information Table and Logical Link Table
7.7.4.3 ERD DbLocation
7.7.4.4 ERD Logical Link and DiagComPrimitives
7.7.4.5 ERD Request and Response Parameter associations
7.7.4.6 ERD result access
7.7.4.7 ERD Jobs
7.7.5 ODX Data Type mapping for database and runtime side
7.7.5.1 Basics
7.7.5.2 eSTRUCTURE
7.7.5.3 eFIELD
7.7.5.4 eEND_OF_PDU
7.7.5.5 eMULTIPLEXER
7.7.5.6 eENVDATADESC
7.8 Collections
7.8.1 Types and methods
7.8.2 RunTime collections
7.8.3 Database collections
7.9 Registering/deregistering of the EventHandler
7.10 MCD value
7.11 Use cases
7.11.1 View
7.11.2 Instantiation of projects
7.11.3 Database access
7.11.4 Destruction
8 Function block Diagnostic in detail
8.1 Constraints
8.2 System Properties
8.3 Diagnostic DiagComPrimitives and Services
8.3.1 Diagnostic DiagComPrimitives
8.3.1.1 DCP types and hierarchy
8.3.1.2 States of DiagComPrimitives
8.3.2 Service overview
8.3.3 Non-cyclic single diagnostic service
8.3.4 Cyclic diagnostic service
8.3.5 Repeated diag service
8.3.6 Repeated send only diag service
8.3.7 Repeated receive only diag service
8.3.8 Summary
8.3.9 Protocol parameters
8.3.9.1 General
8.3.9.2 Introduction related to ISO 22901-1 ODX
8.3.9.3 Inheritance of protocol parameters
8.3.9.4 Runtime part
8.4 Suppress positive response
8.5 eEND_OF_PDU as RequestParameter
8.5.1 Database side
8.5.2 Runtime side
8.6 Variable length parameters
8.7 Variant identification
8.7.1 Interpretation algorithm
8.7.2 Identification algorithm
8.7.3 Request and ResponseParameter of VI and VIS
8.7.3.1 General
8.7.3.2 RequestParameter structure
8.7.3.3 ResponseParameter structure
8.7.4 Service handling in cases of different locations
8.7.5 Variant Patterns and Matching Parameters
8.8 Use cases
8.8.1 Create Logical Link and use DiagComPrimitives
8.8.2 Removal of communication objects
8.8.3 Service handling
8.8.3.1 Non-cyclic diag service execution
8.8.3.2 Cyclic diag service execution
8.8.4 Result access
8.8.5 Error handling in results
8.9 Read DTC
8.9.1 ODX Data for Example Read DTC
8.9.2 Reading without FaultMemories
8.9.3 Reading with FaultMemories
8.9.4 DTC Read Service
8.10 Logical Link
8.10.1 Connection overview
8.10.2 State diagram of Logical Link
8.10.3 VCI communication lost handling
8.10.3.1 Basics
8.10.3.2 Example of how a client could behave upon receiving onInterfaceError or onStaticInterfaceError
8.10.4 Logical Link examples
8.11 Functional addressing
8.12 Tables
8.12.1 General
8.12.2 Usage of tables within DiagComPrimitives
8.13 Dynamically Defined Identifiers (DynId)
8.13.1 General
8.13.2 DYNID principle and requirements
8.13.3 Lifecycle
8.13.3.1 General
8.13.3.2 Creation of dynamically defined identifier
8.13.3.3 Reading by dynamically defined identifier
8.13.3.4 Deletion of dynamically defined identifier
8.13.3.5 DB-Templates for requests and responses regarding dynamically defined identifier
8.13.3.6 Procedure description
8.14 Internationalization
8.14.1 Multi language support
8.14.2 Units
8.15 Special Data Groups
8.16 ECU (re)programming
8.16.1 Goal
8.16.2 Structuring of the function block flash
8.16.2.1 Database part
8.16.2.2 Online part
8.16.2.3 Progress information
8.16.2.4 Ident mechanism
8.16.3 ECU-MEM
8.17 Handling binary flash data
8.17.1 Late-bound data files
8.17.2 Wildcards in data file names
8.17.3 Flash segment iterator
8.18 Library
8.19 Jobs
8.19.1 General
8.19.2 Input and output parameters
8.19.3 Job result
8.19.4 Single ECU jobs
8.19.5 FlashJobs
8.19.6 Multiple ECU jobs
8.19.7 Job execution
8.19.7.1 Single execution of a Job
8.19.7.2 Repeated execution of Job
8.19.8 Allowed java libraries
8.19.9 Naming conventions
8.19.10 Job Communication Parameter handling
8.19.11 Job Result Generation
8.19.12 Job template SingleEcuJob
8.19.13 Job template MultipleEcuJob
8.19.14 Job template FlashJob
8.20 ECU configuration
8.20.1 Introduction
8.20.2 ECU Configuration database part
8.20.3 ECU Configuration Runtime Part
8.20.4 Error Handling
8.20.5 Initialising an MCDConfigurationRecord
8.20.6 Offline versus Online Configuration
8.20.7 Uploading and Downloading Configuration Strings
8.20.7.1 Basics
8.20.7.2 Decomposing a Configuration String for Transfer
8.20.7.3 Downloading configuration records to an ECU
8.20.7.4 Uploading configuration records from an ECU
8.21 Audiences and additional audiences
8.21.1 General
8.21.2 Audiences
8.21.3 Additional Audiences
8.22 ECU states
8.23 Function dictionary
8.23.1 General
8.23.2 Functions and funtion groups in ODX
8.23.3 Function dictionary data model description
8.23.4 Uniqueness of MVCI diagnostic server function dictionary data resolution
8.23.4.1 MVCI server resolution
8.23.4.2 Example 1
8.23.4.3 Example 2
8.23.4.4 Example 3
8.23.4.5 Example 4
8.23.4.6 Example 5
8.23.5 Function dictionary usage scenario
8.24 Sub-Component data model description
8.24.1 Sub-Component data model
8.24.2 Sub-Component usage scenario
8.25 Monitoring vehicle bus traffic
8.26 Support of VCI module selection and other VCI module features according to ISO 22900-2
8.26.1 Introduction
8.26.2 Definitions
8.26.3 General behaviour of D-PDU API related MVCI diagnostic server methods
8.26.4 Overview of VCI module related classes
8.26.5 VCI module selection
8.26.6 MCDInterface
8.26.7 VCI module selection sequence
8.26.8 Interface status events
8.26.9 MCDInterfaceResource
8.26.10 Selection of an interface resource
8.26.11 Send Break Signal
8.26.12 MCDDbInterfaceCable
8.26.13 Accessing VCI module features
8.26.14 Behaviour of an MVCI diagnostic server not using the VCI Module API
8.27 Handling DoIP entities
8.27.1 General
8.27.2 Detection of DoIP entities
8.27.2.1 Basics
8.27.2.2 Detection of DoIP entities connected to the system
8.27.2.3 Detection of DoIP Entities connected to a specific MVCI device
8.27.3 Selection of DoIP Entities
8.28 Mapping of D-PDU API methods
8.28.1 Introduction
8.28.2 Initialization and Selection of VCI Modules
8.28.3 Communication on a Logical Link
8.28.4 Handling of Communication Parameters
8.28.4.1 Changing communication parameters from the client application
8.28.4.2 Setting temporary communication parameters for a DiagComPrimitive
8.28.4.3 Changing UNIQUE_ID Communication Parameters
8.28.5 MCDStartCommunication and MCDStopCommunication
8.28.6 D-PDU API IO-Control support
9 Error Codes
9.1 Principle
9.2 Description of the errors
9.2.1 Error-free behaviour
9.2.2 Parameterisation errors
9.2.3 RunTime/ProgramViolation errors
9.2.4 Database errors
9.2.5 System errors
9.2.6 Communication errors
9.2.7 Share error