Vehicles
Permissions:
create_vehicles,read_vehicles,update_vehicles,delete_vehicles,create_vehicle_positions
A vehicle belongs to a product and represents anything that can transport users for a service, such as a car, bus, rickshaw, or carriage. For the vehicle concept—capacity, driving range, and autonomous behavior—see Vehicles in Platform.
View vehicles
Permissions:
read_vehicles
From the product overview in Control Center, select Vehicles in the left sidebar. In this view, non-archived vehicles are listed in a table containing the following information.
| Column | Description |
|---|---|
| ID | Vehicle identifier |
| Operator | Assigned operator |
| License plate | Vehicle license plate |
| Nickname | Vehicle nickname |
| Phone number | Vehicle phone number |
| Available spaces | Available space icons and counts for seats, wheelchair bays, walker bays, and storage units. |
| Ad hoc bookable default | Default ad hoc booking setting for new vehicle plannings |
| Prebookable default | Default prebooking setting for new vehicle plannings |
| Connected | Whether the vehicle is connected to a driver via a vehicle occupation |
| Curr. Position | Vehicle position status icon based on the age of the latest vehicle position update: green for under 10 minutes, yellow/orange for 10 to 60 minutes, red/pink for over 60 minutes, and red/pink x if unavailable |
| Autonomous | Whether the vehicle is autonomous |
| Matching rank | Vehicle matching rank |
An icon indicates whether the vehicle is paused or deactivated, and for how long. A pause is indicated by a coffee cup icon, whereas a deactivation is indicated by a stop sign.
Search vehicles
Permissions:
read_vehicles
You can search vehicles by License plate, Nickname, Manufacturer, and Phone number.
Sort vehicles
Columns that can be sorted have blue headers. You can sort vehicles by license plate, nickname, connected, autonomous, and matching rank.
Create a vehicle
Permissions:
create_vehicles
Vehicles can be created manually by selecting Create new, or imported in bulk by selecting Import, which opens ioki Data Bridge.
The form contains these fields.
Basic setup
- Operator. Select an operator from the dropdown menu. By default, the provider is stored as the operator in this position.
- License plate Enter a license plate number.
- Nickname. Enter a nickname for the vehicle. This is the name under which the vehicle appears for passengers and also for vehicle plannings in Control Center.
- Phone number (optional): If a mobile device is connected to a specific vehicle, the phone number can be specified here. This simplifies communication between an administrator and the vehicle’s current driver.
The use of phone numbers for vehicles is not limited to one vehicle. Phone numbers saved in the system can be applied to different providers and products at the same time.
- External ID (optional)
- Manufacturer (optional): Enter the manufacturer of the vehicle.
- Model (optional): Enter the model of the vehicle.
- Fuel type. Select Unknown, Petrol, Diesel, Hybrid electric vehicle, Electrically chargeable vehicle, Natural gas vehicle, Hydrogen vehicle, or Other from the dropdown menu.
- Description (optional): Enter a description of the vehicle.
Settings
- Matching rank
- Reposition on idle time threshold. Overwrites the default settings of the idle time threshold set on the product when automated repositioning is activated.
Properties
- Ad hoc bookable (default): The vehicle can be booked ad hoc if ad hoc booking is activated for the current product in the Settings for prebooking and ad hoc booking.
- Prebookable (default): The vehicle can be prebooked if prebooking is activated for the current product in the Settings for prebooking and ad hoc booking.
- Deactivate driver app position updates. Usually vehicles positions are tracked by GPS position updates sent by ioki Vehicle App, which can be deactivated here. This is only used for autonomous vehicles.
- Drop driver app position updates (temporary feature). When enabled, the system silently discards vehicle position updates sent by ioki Vehicle App instead of processing them. This differs from Deactivate driver app position updates, which stops position tracking via the app. Only Super Admins can see and change this setting.
- Disable journey calculation. If this option is enabled, the system doesn’t calculate journeys for the vehicle. This is used by ioki internal developers to exclude vehicles from journey planning or routing processes. As a result, no journey-related operations, such as task-list recalculations or route updates, are performed for the corresponding vehicle. This field is visible only to administrators with the
manage_clientspermission. - Ignore interior configuration checks in matching. If this option is enabled, matching treats the vehicle as able to cover any requested seat and resource configuration when it evaluates task lists. It skips checks against the vehicle’s interior configurations, such as seats, wheelchair bays, walker bays, and storage units. Use this option carefully because matching can assign rides that exceed the vehicle’s configured capacity or resources. This field is visible only to administrators with the
manage_clientspermission. - Receive only a partial journey. If this option is enabled, the driver client receives only a partial journey consisting of the first leg and a tail of subsequent legs that collectively meet a minimum distance threshold of 500 meters. This helps reduce the data sent by focusing on relevant legs, particularly for ongoing trips. This field is visible only to administrators with the
manage_clientspermission. - Autonomous. Marking a vehicle as autonomous lets it be matched to ad hoc rides without a connected driver, whereas a non-autonomous vehicle needs a connected driver to take ad hoc rides. Autonomous vehicles are de-prioritized relative to driver-operated vehicles when the system ranks matching options, rides on autonomous vehicles cannot be tipped, and such rides are classified as autonomous in reporting.
- Supports changing the door state via API. This option indicates whether the vehicle supports remote door control via API. It should be enabled for vehicles with compatible hardware integrations (for example, Mobileye) and used to determine whether door control UI should be shown to clients.
If a vehicle is marked as Autonomous, you must define an end place in a vehicle planning.
Driving range
Use these settings to track how much driving range the system stores and projects for a vehicle. Based on the verified code, ioki Platform currently calculates and carries this budget through task chains, but it does not yet use it to accept or reject matches.
- Driving range adapter. Select how the system calculates driving range consumption for the vehicle. The default is None.
- Driving range unit. Select the unit used for the stored budget. Available units are Meters, Seconds, Battery percent, and Watt hours. The default is Meters. The selected unit must match the selected adapter, except None, which works with any unit.
- Maximum driving range. Enter the full available budget in the selected unit. This value is required when the selected adapter calculates a budget. Values must be non-negative integers.
- Current driving range. Enter the currently available budget in the selected unit. This value is optional and can be left empty if the current value is unknown. Values must be non-negative integers.
The following adapters are available.
| Adapter | Required unit | Behavior |
|---|---|---|
| None | Any | Does not calculate driving range consumption. |
| City distance estimator | Meters | Uses the routed distance of each journey leg. If a leg is not available, it estimates the distance between the two task points. |
| City duration estimator | Seconds | Uses the routed duration of each journey leg. If a leg is not available, it estimates the travel time between the two task points. |
| City battery estimator | Battery percent | Estimates battery usage from routed distance with a linear model that assumes a full range of about 250 km in city traffic. |
| City energy estimator | Watt hours | Estimates energy usage from routed distance with a linear model that assumes about 150 Wh per km in city traffic. |
For active vehicle plannings, the projected budget starts at Maximum driving range for a start-of-shift task. Otherwise, it starts at Current driving range.
Telemetry
- Telemetry Warning: Passenger Mismatch. When enabled, the system raises a vehicle telemetry warning when the passenger count reported by the vehicle’s telemetry does not match the number of passengers expected from the current task list.
- Telemetry Warning: Seatbelt. When enabled, the system raises a telemetry warning when the vehicle’s telemetry reports a seatbelt issue, for example an unbuckled passenger or a seatbelt fastened on an unoccupied seat.
- Telemetry Warning: Battery. When enabled, the system raises a telemetry warning when the battery level reported by telemetry falls below the Battery Warning Threshold.
- Telemetry Warning: Tire Pressure. When enabled, the system raises a telemetry warning when any tire’s pressure reported by telemetry falls below the Tire Pressure Warning Threshold.
- Battery Warning Threshold. The battery level, as a percentage, below which a battery telemetry warning is raised when Telemetry Warning: Battery is enabled. The default is
10%. Tire Pressure Warning Threshold. The tire pressure, in pascals, below which a tire-pressure telemetry warning is raised when Telemetry Warning: Tire Pressure is enabled. The default is
170000Pa (about 1.7 bar). The form shows a live conversion to more familiar units.- Custom flags. If custom flags are defined, the flags are displayed here and can be assigned to the vehicle by checking the corresponding boxes.
- Vehicle image (optional): Upload an image of the vehicle (JPG, JPEG, PNG, or GIF) with maximum 10MB.
- Delete vehicle image. If a vehicle image exists, this option allows you to delete it.
Select Save.
Open the detailed view of a vehicle
To open the detailed view of a vehicle, select ⚙️ > Show in the dropdown menu. Alternatively, select its license plate or nickname in the table.
The following tabs are shown in the detailed view.
Overview
This tab provides an overview of the vehicle details and shows the last known position on a map.
Tasks
If there is an active task list/vehicle planning connected to the vehicle, all upcoming tasks are listed here.
Connected Drivers
This tab displays a table containing the current and historical data of all connected drivers.
Vehicle Telemetry
This tab shows data pertaining to vehicle telemetry.
Interior Configurations
This tab shows the vehicle’s interior configurations.
Inspect
This tab provides a technical summary of the vehicle’s attributes.
Edit a vehicle
To edit a vehicle, select ⚙️ > Edit in the dropdown menu. Make the desired changes and then select Save.
Add new position
To add a new position to a vehicle, select ⚙️ > Add new position in the dropdown menu. Enter the required information and then select Save.
Interior configurations
To open the interior configurations of a vehicle, select ⚙️ > Interior configurations in the dropdown menu.
Sync interior configurations to other vehicles
In case you’re using multiple vehicles of the same type, you have to set up the interior configurations only once and can transfer them to other vehicles. Selecting this option opens a wizard to do this quickly.
Archive a vehicle
To archive a vehicle, select ⚙️ > Archive in the dropdown menu and then OK.
Manage High Mobility Vehicle integration
If there is no connection between the vehicle in Control Center and the High Mobility API, selecting ⚙️ > Manage High Mobility Vehicle integration in the dropdown menu prompts you to create one. Select ⚙️ > Create new. Enter the vehicle information number (VIN) and Manufacturer and then select Save.
If there is already a connection between the vehicle and the High Mobility API, selecting this will show the associated VIN, Manufacturer, Clearance state, and the timestamp of its creation.
Whenever you connect a new vehicle with the High Mobility API, an asynchronous process is started on High Mobility’s side to activate data access. High Mobility maintains a state of the vehicle activation, which can be one of the following: pending, approved, rejected, revoking, revoked, canceling, canceled, or error. This corresponds to the Clearance state in Control Center.
For more information on the vehicle state flow and the descriptions of each state, refer to this section in the High Mobility Docs.