Skip to content

Commit fd4a539

Browse files
authored
Update README.md
1 parent 3cd8c68 commit fd4a539

File tree

1 file changed

+50
-1
lines changed

1 file changed

+50
-1
lines changed

vehicle_profiles/README.md

+50-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,56 @@
11
# Vehicle Profiles
22

3-
This folder contains various vehicle profiles to enable people to easily get their car working with WiCan.
3+
This folder contains various vehicle profiles to enable people to easily get their car working with WiCAN adapters.
44

55
The Names of files/folders do not matter to the end result, they are just there to help organize the various files.
66

77
If you would like to add/update a car please make sure it is formatted properly, see various car configs for examples
8+
9+
**car_model**: "Make: Model"
10+
11+
**init**: Initialization string. AT command to initialize the OBD adapter, such as setting the protocol, header, and any other car-specific commands relevant to OBD communication. Every command must end with a semicolon ;
12+
13+
**pids**: Parameter ID request
14+
15+
16+
**parameters**: Parameters within a specific PID request. A PID response might contain multiple parameters, such as battery State of Health (SoH) and battery voltage.
17+
18+
**expression**: The expression used to calculate the parameter value
19+
20+
**unit**: The unit of the parameter, e.g., %, °C, or others
21+
22+
**Example:**
23+
```
24+
{
25+
"car_model": "Hyundai: Ioniq5/Ioniq6/Kona",
26+
"init": "ATSH7E4;ATST96;",
27+
"pids": [
28+
{
29+
"pid": "2201019",
30+
"parameters": [
31+
{
32+
"name": "SOC_BMS",
33+
"expression": "B10/2",
34+
"unit": "%"
35+
},
36+
{
37+
"name": "Aux_Batt_Volts",
38+
"expression": "B38*0.1",
39+
"unit": "V"
40+
}
41+
]
42+
},
43+
{
44+
"pid": "2201057",
45+
"parameters": [
46+
{
47+
"name": "SOH",
48+
"expression": "[B34:B35]/10",
49+
"unit": "%"
50+
}
51+
]
52+
}
53+
]
54+
}
55+
56+
```

0 commit comments

Comments
 (0)