Welcome to Open Vehicle API

Open Vehicle API Documentation:

About Open Vehicle API:

• What is Open Vehicle API
  • General
  • Overview
  • Open Vehicle API Framework User
• Key Features
• Open Vehicle API Component Stack
  • Layers & Abstraction Levels
  • Components

Get started / Installation Steps:

• Get started… / Installation Steps
  • Prerequisites
  • Follow Up Steps
  • Create Your Own Project / Working Space
• Project Guide
  • Project File Structure
  • Deep Dive Into Examples
  • Contributing Guidelines
  • Reporting Issues

For Developers

• For Developers
• CMake in the project

Examples / Deep Dive into VAPI:

• Examples of Open Vehicle API
  • Basic Examples
  • Headlight Example
  • Door Service Example
  • Open Trunk Example
  • System Demo Example
  • Additional Examples
• Guide: Create Example Step By Step
  • Step-by-Step: Create IDL Interfaces, Vehicle Devices and Basic Services
  • Step-by-Step: TOML Configuration Files
  • Step-by-Step: Written Code for Wiper Example
  • Step-by-Step: Console & Simulation Data for Wiper Example
  • Step-by-Step: Complex Service implementation
  • Step-by-Step: Data Link & CAN Simulation for Wiper Example
  • Step-by-Step: Diagrams

Simulation / Testing / FMU:

• Simulation / Testing / FMU
  • What is an FMU?
  • How to use a FMU

Further Information:

• A view under the hood
  • Component Definition
  • Interface IDL
• Key Building Blocks of Open Vehicle API
  • Free of Interference
  • Vehicle and Platform Abstraction
  • Mixed-Criticality
  • Event-Driven Architecture
  • Enhanced Testability & Development Process

Components / Services:

• Components & Services
  • Configuration
  • Logging
  • Timer Services
  • CAN Implementations

SDV Executable:

• SDV Executables
  • SDV Utilities (Auto Code Generation)
  • Packaging & Installation
  • System Control
  • List of Executables

Glossary:

• VAPI Glossary

Doxygen Documentation:

• Open Vehicle API
  • Page Hierarchy
  • Full API

Indices and tables:

• Index

• Search Page