Recalculate the route

Besides the updateNavigation mutation, there is another way to alter the route in a navigation session. By using the recalculateNavigation mutation a new route calculation can be enforced.

Mutation

To recalculate a route a navigation id and current_location need to be provided. Optionally, via points, a state_of_charge, and telemetry data can be included to optimize the new route. If the mutation executed succesfully, OK will be returned on the data object. The updates itself will be reflected on the navigationUpdatedById subscription or the navigation query. When using a query, please be aware that changes can take a little while to process.

To illustrate when this mutation should be used, two scenario's are described below.

1. Deviate from the route

In case a vehicle deviates from the calculated route (e.g. the driver takes a wrong exit), most navigation SDKs will detect this. It is recommended to hook into the event and send the location from the off route callback. Since recalculating a route can take a little while, make sure to not send multiple requests but wait until the navigationUpdatedById returns a new route.

2. Changing the via points

The second use case for using this operation is to change the manually added via points. This allows the driver to change the order of the via points, to add new ones or to delete them. Note that via points that were already reached are eliminated automatically.

Arguments

input • NavigationRecalculateInput

• Required

Navigation recalculate input

id • ID

• Required

ID of the navigation session

state_of_charge • StateOfChargeInput

State of charge at origin

current_location • PointInput

• Required

Origin location of a new route

via • FeaturePointInput

Via points of a new route. If this field is not sent, the original via points will be used

telemetry • TelemetryInput

Telemetry data input

auxiliary_consumption • AuxiliaryConsumptionInput

Average auxiliary power consumption

battery_current • Float

Battery current in ampere

battery_temperature • BatteryTemperatureInput

Battery temperature

battery_voltage • Float

Battery voltage in volts

is_charging • Boolean

Is the vehicle currently charging

charge_speed • ChargeSpeedInput

Rate of charge

charge_total • ChargeTotalInput

Amount charged

total_occupant_weight • TotalOccupantWeightInput

Cumulated weight of the occupants

total_cargo_weight • TotalCargoWeightInput

Weight of the cargo

elevation • ElevationInput

Current elevation

heading • Float

Current heading in degrees

motor_rpm • Int

RPM of the motor

occupants • Int

Number of occupants in the vehicle

odometer • OdometerInput

Mileage or odometer reading

outside_temperature • OutsideTempInput

Outside temperature

is_parked • Boolean

Vehicle is in park, neutral or turned off

power • PowerInput

Vehicle power

state_of_charge • StateOfChargeInput

Battery state of charge

tire_pressure • TirePressureInput

Average tire pressures of all wheels, starting from the front side right to left and to the rear

timestamp • Int

UNIX timestamp in seconds

vehicle_speed • VehicleSpeedInput

Vehicle speed

custom • JSON

Custom input fields can be added based on telemetry architecture

Response

A response can either contain a data or an errors object. The response header will always return 200 as a status code.

Data object

When successful, a data object will be returned with the requested fields. If there are no fields present the data object will return the operation name with the appropriate return type. If the operation was a query, this output will be an object of the schema’s query root type; if the operation was a mutation, this output will be an object of the schema’s mutation root type.

Error object

If unsuccessful, an errors object will be returned with more details in the extensions object. The error object can contain any of the following objects.