Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
meatpiHQ authored Aug 17, 2024
1 parent 3cd8c68 commit fd4a539
Showing 1 changed file with 50 additions and 1 deletion.
51 changes: 50 additions & 1 deletion vehicle_profiles/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,56 @@
# Vehicle Profiles

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

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

If you would like to add/update a car please make sure it is formatted properly, see various car configs for examples

**car_model**: "Make: Model"

**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 ;

**pids**: Parameter ID request


**parameters**: Parameters within a specific PID request. A PID response might contain multiple parameters, such as battery State of Health (SoH) and battery voltage.

**expression**: The expression used to calculate the parameter value

**unit**: The unit of the parameter, e.g., %, °C, or others

**Example:**
```
{
"car_model": "Hyundai: Ioniq5/Ioniq6/Kona",
"init": "ATSH7E4;ATST96;",
"pids": [
{
"pid": "2201019",
"parameters": [
{
"name": "SOC_BMS",
"expression": "B10/2",
"unit": "%"
},
{
"name": "Aux_Batt_Volts",
"expression": "B38*0.1",
"unit": "V"
}
]
},
{
"pid": "2201057",
"parameters": [
{
"name": "SOH",
"expression": "[B34:B35]/10",
"unit": "%"
}
]
}
]
}
```

0 comments on commit fd4a539

Please sign in to comment.