Vehicle Configuration

VERSION 0.41.1 PUBLIC PREVIEW

Configure vehicle-specific routing with the vehicle parameter.

Parameters

model (predefined)

variantId – Predefined vehicle model ID from TomTom database (contact support for available models)

model (manual)

dimensions – Object with lengthMeters, widthMeters, heightMeters, weightKG, axleWeightKG
engineType – ‘combustion’ / ‘electric’ / not specified
engine – Engine model (only if engineType is specified)
- Combustion: consumption (fuelEnergyDensityInMJoulesPerLiter, speedToConsumption, auxiliaryPowerInLitersPerHour)
- Electric: consumption (speedToConsumption, auxiliaryPowerInkW, recuperationInKWHPerKMAltitudeLoss, consumptionInKWHPerKMAltitudeGain), charging (maxChargeKWH, chargingCurve, chargingConnectors, chargingTimeOffsetInSec, batteryCurve)

state

Combustion vehicles: currentFuelInLiters
Electric vehicles: currentChargePCT, currentChargeInkWh

restrictions Cargo and usage restrictions, useful for commercial vehicle routing and hazardous material transport:

loadTypes – Array of hazardous cargo types
adrCode – ADR tunnel restriction code (‘B’, ‘C’, ‘D’, ‘E’)
commercial – Boolean, commercial vehicle flag
maxSpeedKMH – Maximum speed in km/h

preferences (electric vehicles only):

chargingPreferences (minChargeAtDestinationPCT, minChargeAtChargingStopsPCT, minChargeAtDestinationInkWh, minChargeAtChargingStopsInkWh)

Providing preferences.chargingPreferences enables Long Distance EV Routing, which adds charging stops to the route as needed.

See Long Distance EV Routing for more details.

Model Examples

Predefined Model

1
const route = await calculateRoute({
2
    locations: [[4.9041, 52.3676], [2.3522, 48.8566]],
3
    vehicle: {
4
        model: {
5
            variantId: 'mercedes-sprinter-316-2021'
6
        },
7
    }
8
});

Generic Vehicle Example

1
const route = await calculateRoute({
2
    locations: [[4.9041, 52.3676], [2.3522, 48.8566]],
3
    vehicle: {
4
        model: {
5
            dimensions: {
6
                heightMeters: 2.5,
7
                weightKG: 3500
8
            }
9
        }
10
    }
11
});

Combustion Vehicle Example

1
const route = await calculateRoute({
2
    locations: [[4.9041, 52.3676], [2.3522, 48.8566]],
3
    vehicle: {
4
        engineType: 'combustion',
5
        model: {
6
            dimensions: {
7
                weightKG: 1500
8
            },
9
            engine: {
10
                consumption: {
11
                    fuelEnergyDensityInMJoulesPerLiter: 34.2,
12
                    speedsToConsumptionsLiters: [
13
                        { speedKMH: 50, consumptionUnitsPer100KM: 6.5 },
14
                        { speedKMH: 90, consumptionUnitsPer100KM: 7.2 },
15
                        { speedKMH: 120, consumptionUnitsPer100KM: 9.0 }
16
                    ]
17
                }
18
            }
19
        },
20
        state: {
21
            currentFuelInLiters: 45
22
        }
23
    }
24
});

Electric Vehicle Example

1
const route = await calculateRoute({
2
    locations: [[4.9, 52.3], [8.5, 50.1]],
3
    vehicle: {
4
        engineType: 'electric',
5
        model: {
6
            dimensions: {
7
                weightKG: 2000
8
            },
9
            engine: {
10
                charging: {
11
                    maxChargeKWH: 75,
12
                    batteryCurve: [
13
                        { stateOfChargeInkWh: 50, maxPowerInkW: 200 },
14
                        { stateOfChargeInkWh: 70, maxPowerInkW: 100 },
15
                        { stateOfChargeInkWh: 80, maxPowerInkW: 40 },
16
                    ],
17
                    chargingConnectors: [
18
                        {
19
                            currentType: 'AC3',
20
                            plugTypes: [
21
                                'IEC_62196_Type_2_Outlet',
22
                                'IEC_62196_Type_2_Connector_Cable_Attached',
23
                                'Combo_to_IEC_62196_Type_2_Base',
24
                            ],
25
                            efficiency: 0.9,
26
                            baseLoadInkW: 0.2,
27
                            maxPowerInkW: 11,
28
                        },
29
                        {
30
                            currentType: 'DC',
31
                            plugTypes: [
32
                                'IEC_62196_Type_2_Outlet',
33
                                'IEC_62196_Type_2_Connector_Cable_Attached',
34
                                'Combo_to_IEC_62196_Type_2_Base',
35
                            ],
36
                            voltageRange: { minVoltageInV: 0, maxVoltageInV: 500 },
37
                            efficiency: 0.9,
38
                            baseLoadInkW: 0.2,
39
                            maxPowerInkW: 150,
40
                        },
41
                    ]
42
                },
43
                consumption: {
44
                    speedsToConsumptionsKWH: [
45
                        { speedKMH: 50, consumptionUnitsPer100KM: 15 },
46
                        { speedKMH: 90, consumptionUnitsPer100KM: 18 },
47
                        { speedKMH: 120, consumptionUnitsPer100KM: 23 }
48
                    ]
49
                }
50
            }
51
        },
52
        state: {
53
            currentChargePCT: 80
54
        },
55
        preferences: {
56
            chargingPreferences: {
57
                minChargeAtDestinationPCT: 20,
58
                minChargeAtChargingStopsPCT: 10
59
            }
60
        }
61
      }
62
});

API Reference

For complete documentation of all route vehicle parameters and types, see the VehicleParameters API Reference .

Routing Quickstart - Getting started with route calculation
Route Planning Parameters - Comprehensive route planning with configuration options
Long Distance EV Routing - In-depth guide to electric vehicle routing with charging stops

Map Integration

Routing Module - Display calculated routes on map