# OBD-II-Emulator

**Repository Path**: laizibi/OBD-II-Emulator

## Basic Information

- **Project Name**: OBD-II-Emulator
- **Description**: OBD II Emulator for Adaptive
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-12-31
- **Last Updated**: 2024-02-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OBD-II-Emulator
![example workflow](https://github.com/langroodi/OBD-II-Emulator/actions/workflows/cmake.yml/badge.svg)

This is an OBD-II emulator via CAN over Linux that handles diagnostics queries of OBD2 scanners. The emulator listens to the CAN packets coming from the USB-CAN Analyzer device over a *serial communication* and by using the device *CAN driver*, converts the packets to *CAN frames*. Then the *OBD emulator* extracts the parameter ID (*PID*) from the frames and routes them to the corresponding *OBD service* as shown below:

```
                                 +-------------------------+                                
                                 | Serial Communication :  |                                
                                 | Communication Layer     |                                
                                 +------------|------------+                                
                                              |                                             
                                         Byte Array                                         
                                              |                                             
                                 +-------------------------+                                
                                 |       CAN Driver        |                                
                                 |                         |                                
                                 +------------|------------+                                
                                              |                                             
                                          CAN Frame                                         
                                              |                                             
                                 +------------|------------+                                
                                 |      OBD Emulator       |                                
                                 |                         |                                
                                 /------------|------------\                                
                               /-             |             -\                              
                            PID              PID             PID                            
                           /-                 |                -\                           
+--------------------------      +------------|------------+     --------------------------+
|     OBD Service(0)      |      |     OBD Service(i)      |     |     OBD Service(n)      |
|                         |      |                         |     |                         |
+-------------------------+      +-------------------------+     +-------------------------+
```

## Dependecies
The current library has two categories of dependency as follows:

### Hardware dependencies
- [USB-CAN Analyzer](https://github.com/SeeedDocument/USB-CAN-Analyzer)
- [CH341SER Linux Driver](https://github.com/juliagoda/CH341SER)
> ⚠️ If after loading the driver, the analyzer is got disconnected because of [brltty](https://brltty.app) (which can be seen via launching `sudo dmesg | grep tty` in the termnial), then follow [this solution](https://github.com/juliagoda/CH341SER/issues/18#issue-1050941767).

### Software dependencies
- Cpp Standard: 14
- Cmake mimimum version: 3.14
- Compiler:
    - GCC C/C++ Compiler (x86-64 Linux GNU): 11.2.0; or
    - Clang C/C++ Compiler (x86-64 PC Linux GNU): 14.0.0
- Google Test: v1.12.1
- Linux kernel minimum version: 2.6.25

## Documentation
The library documentation is available from [GitHub Pages](https://langroodi.github.io/OBD-II-Emulator/) which is powered by [Doxygen](https://www.doxygen.nl/index.html) .

## Samples
The library samples build is disabled by default. To be able to build the library with the samples, following bash command can be used:
```bash
cmake -S . -B build -Dbuild_samples=ON
cmake --build build
# To run the tests:
cd build && ctest
```