Electric Vehicle Registration
Vehicle registration
TomTom currently supports manual vehicle registration via the Thru service. If you haven't been onboarded, send a request to ev-integration-support@tomtom.com to register a vehicle.
Once onboarded, you can access the service to send vehicle data for registration.
After onboarding, TomTom will send you an Excel sheet to complete and return via Thru service. Encrypt each Excel sheet using the built-in password protection feature. Attach the file using Thru email service and share the password in the encrypted private message box.
After registering the new vehicle, TomTom will send you the unique variantId for the registered vehicle variant.
This variantId can then be used for Online Routing API, Long Distance EV route planning via Navigation SDK
and for range calculations.
NOTE
Treat received
variantIdswith the same confidentiality level as the vehicle metadata.
The parameters to be filled in the Excel sheet are described in detail below.
Vehicle parameters
| Parameter | Description | ||||
|---|---|---|---|---|---|
| Type | Unit | Required | Default value | Valid range | |
| Brand Name | Vehicle brand name. Commercial name, not commercial entity (e.g., Fiat, not Stellantis). Consists of a group of models. | ||||
| String | - | True | [1, 40] characters | ||
| Model Name | The model name of a vehicle. | ||||
| String | - | True | [1, 50] characters | ||
| Variant Name | The variant name of a vehicle. | ||||
| String | - | False | [1, 50] characters | ||
| Produced From | Production start date. Empty indicates vehicle is not yet in production. | ||||
| String | - | False | Format: YYYY-MM YYYY: indicates a four-digit year MM: indicates a two-digit month in the format 01-12 Empty: not in production yet | ||
| Produced To | Production end date. Empty indicates vehicle is still in production. Applies only if "Produced From" is not empty. | ||||
| String | - | False | Format: YYYY-MM YYYY: indicates a four-digit year MM: indicates a two-digit month 01-12 Empty: still in production | ||
| Drive Train | Type of the drivetrain. | ||||
| Enum | - | True | FWD: Front-wheel drive RWD: Rear-wheel drive AWD: All-wheel drive | ||
| Length | Overall length of the vehicle in centimeters. | ||||
| Float | Centimeters | True | [200, 2500] | ||
| Width | Overall width of the vehicle in centimeters. | ||||
| Float | Centimeters | True | [100, 300] | ||
| Height | Overall height of the vehicle in centimeters. | ||||
| Float | Centimeters | True | [100, 400] | ||
| Max Speed | Maximum speed of the vehicle. | ||||
| Integer | Kilometers per hour | True | [0, 250] | ||
| Curb Weight | Vehicle weight with all standard equipment, excluding passengers, cargo, or optional equipment. | ||||
| Integer | Kilograms | True | [400, 18000] | ||
| Vehicle Type | Type of the vehicle. | ||||
| Enum | - | True | Possible values:CAR | ||
| Engine Type | Type of the engine. | ||||
| Enum | - | True | Possible values:BATTERY_ELECTRIC | ||
| WLTP Range | EV range measured under the WLTP standard. | ||||
| Float | Kilometers | True | - | (0, ) | |
| WLTP Energy Consumption | EV energy consumption measured under the WLTP standard. | ||||
| Float | Watt-hours per kilometer | True | - | (0, ) | |
| Battery Capacity Nominal | Maximum battery energy storage capacity as specified by manufacturer. Rated or standard energy the battery can hold under normal conditions, including safety buffers. | ||||
| Float | Watt-hours | True | - | (0, 250 000] | |
| Battery Capacity Usable | Portion of battery capacity that can be used to power the vehicle. Often lower than nominal capacity, sometimes intentionally limited by the manufacturer to protect the battery and extend its lifespan. Measurement resolution should be at least full watt-hours. | ||||
| Float | Watt-hours | True | - | [0, Nominal Battery Capacity] | |
| Auxiliary Power | Power required by auxiliary systems (air conditioning, heating, infotainment, lighting) not used for propulsion. | ||||
| Float | Watts | False | 1000 | [0, 15 000] | |
| Charging time offset | Time for plugging and unplugging which is added to the raw charging time. | ||||
| Integer | Seconds | False | 180 | [0, 3600] | |
Battery Charging Curve
Provide a charging curve as a list of "State of Energy" and "Max power" pairs. Include 2 to 20 pairs for interpolation using a piecewise-linear function. This is a global curve, but there are also connector-specific curves, see below. If a single curve is insufficient, omit this global curve and provide individual charging curves for each connector instead.
| Parameter | Description | ||||
|---|---|---|---|---|---|
| Type | Unit | Required | Default value | Valid range | |
| State of energy | The state of the charge level of the battery in kilowatt hours. | ||||
| Float | kWh | True | - | [0, Battery Capacity Usable] | |
| Max Power | Max power in kilowatts that the vehicle can accept at a given state of energy. | ||||
| Float | kW | True | - | [0, ) | |
Validation rules for the curve:
- the first pair must have "State of energy" equal to 0.0
- "Max power" must be greater than 0.0
- no duplicated values for "State of energy"
- order pairs by "State of energy" ascending
Connectors
| Parameter | Description | ||||
|---|---|---|---|---|---|
| Type | Unit | Required | Default value | Valid range | |
| Current Type | The charging current type. | ||||
| Enum | - | Required if maxPowerInKw is not provided | Possible values:Direct_CurrentAlternating_Current_1_PhaseAlternating_Current_3_Phase | ||
| Efficiency | Fraction of the power that reaches the battery after losses in the charging path. Scales the lower of the maximum charging power at the current SoE and the available station power after subtracting the base load. | ||||
| Float | - | False | 1.0 | (0, 1] | |
| Base Load | Power drawn by on-vehicle systems during charging, for example, battery thermal management or auxiliary electronics. Subtracted from the available station power before applying the efficiency factor. | ||||
| Float | Kilowatt | False | 0.4 | (0, ) | |
| Max Charging Power | An upper limit for the charging power. | ||||
| Float | Kilowatt | Required only if not providing maxChargingVoltageInV and maxChargingCurrentInA | [0, ) 0: implies the power is only limited by the charging facility | ||
| Max Charging Voltage | An upper limit for the voltage when charging. The resulting voltage is the minimum of the voltage supported by the respective charging facility and this value. | ||||
| Float | Volt | [0, ) 0: implies the voltage is only limited by the charging facility | |||
| Max Charging Amperage | An upper limit for the current when charging. The resulting amperage is the minimum of the amperage supported by the respective charging facility and this value. | ||||
| Float | Ampere | Required if maxPowerInKw is not provided | [0, ) 0: implies the amperage is only limited by the charging facility positive number | ||
| Voltage Range Min | A bottom limit for the voltage connector range, The voltage range is only used for selecting suitable charging modes. | ||||
| Float | Volt | False | 0 | ||
| Voltage Range Max | An upper limit for the voltage connector range. The voltage range is only used for selecting suitable charging modes. 0 is treated as infinity. During charging, the above Max Power/Voltage/Amperage are used instead. | ||||
| Float | Volt | False | 0 | ||
| Plug Types List | List of plug types that correspond to the above parameters | ||||
| Plug Types List: Connector Type | |||||
| Enum | True | Possible values: Supported connector types | |||
| Plug Types List: Requires Adapter | Indicates that an additional adapter is required for a provided connector type | ||||
| Boolean | True | TrueFalse | |||
Battery Charging Curves for Connectors
Each vehicle must have at least one connector. Multiple connectors can represent different charging capabilities. Each connector can have its own battery charging curve instead of using a single vehicle charging curve. Connector charging curves follow the same rules as the general battery charging curve. A connector can use its maximum power without defining a curve. To use maximum connector power, omit the charging curve for the connector and explicitly state this in the table.
This is a list of 2 up to 20 pairs.
| Parameter | Description | ||||
|---|---|---|---|---|---|
| Type | Unit | Required | Default value | Valid range | |
| State of Energy | The state of energy of the battery. | ||||
| Float | Kilowatt-hours | True | - | [0, Battery Capacity Usable] | |
| Max Power | Maximum power that the vehicle can accept at a given state of energy. | ||||
| Float | Kilowatts | True | - | [0, ) | |
Applying changes to variants
Changes to variant entries are limited to ensure data consistency and reliability. Variant entries are versioned. Versions get their own variant IDs. Parameters which do not affect consumption or charging can be changed without creating a new version. These are:
- Brand name
- Model name
- Produced from
- Produced to
Other changes would affect consumption or charging, which could lead to less accurate consumption predictions. Therefore, to change other parameters, create a new vehicle entry:
- Register a new variant entry with updated parameters. Specify which variant to update. You will get a new variant ID for the updated version.
- Use the new variant ID in Navigation SDK, ANA, or Online Routing API calls. Consider the impact of updates carefully to maintain prediction quality.
Using newly registered vehicles in LDEVR
After successful registration, the vehicle can be used in LDEVR in the following products:
- Navigation SDK – Integration guide for Navigation SDK
- Online Routing API – Integration guide for Online Routing API
- Automotive Navigation Application – Integration guide for Automotive Navigation Application (coming soon)