Learn about what to expect from Vehicle Simulator and how it compares to Live mode.
mode=simulated
in the Connect URL.
SDKs
mode
in the auth client builder to simulated
.No SDK
mode=simulated
in the Connect URLPermission | Request Method / Path | Example Response |
---|---|---|
read_engine_oil | GET /engine/oil | { lifeRemaining: 0.35 } |
read_battery | GET /battery | { percentRemaining: 0.3, range: 40.5 } |
read_battery | GET /battery/capacity | { capacity: 28 } |
read_charge | GET /charge | { isPluggedIn: true, state: 'FULLY_CHARGED' } |
read_charge | GET /charge/limit | { limit: 1 } |
read_fuel | GET /fuel | { amountRemaining: 53.2, percentRemaining: 0.3, range: 40.5 } |
read_location | GET /location | { latitude: 37.4292, longitude: 122.1382 } |
read_odometer | GET /odometer | { distance: 104.32 } |
read_tires | GET /tires/pressure | { backLeft: 219.3, backRight: 219.3, frontLeft: 219.3, frontRight: 219.3 } |
read_vehicle_info | GET / | { id: 36ab27d0-fd9d-4455-823a-ce30af709ffc, make: "TESLA", model: "Model S", year: 2014 } |
read_vin | GET /vin | { vin: 1234A67Q90F2T4567 } |
Permission | Request (method / path) | Action request | Vehicle state | Response |
---|---|---|---|---|
control_security | POST /security | LOCK | Parked / Charging | { status: "success" } |
control_security | POST /security | UNLOCK | Parked / Charging | { status: "success" } |
control_security | POST /security | LOCK | Driving | { type: VEHICLE_STATE, code: IN_MOTION } |
control_security | POST /security | UNLOCK | Driving | { type: VEHICLE_STATE, code: IN_MOTION } |
control_charge | POST /charge | START | Charging | { status: "success" } |
control_charge | POST /charge | STOP | Charging | { status: "success" } |
control_charge | POST /charge | STOP | Parked / Driving (not plugged in) | { type: VEHICLE_STATE, code: CHARGING_PLUG_NOT_CONNECTED } |
control_charge | POST /charge | START | Parked / Driving (not plugged in) | { type: VEHICLE_STATE, code: CHARGING_PLUG_NOT_CONNECTED } |
control_charge | POST /charge-limit | <limit> | Charging | { "type": "COMPATIBILITY", "code": "SMARTCAR_NOT_CAPABLE", } |
control_charge | POST /charge-limit | <limit> | Parked / Driving (not plugged in) | { type: VEHICLE_STATE, code: CHARGING_PLUG_NOT_CONNECTED } |
Event | Error response | Suggested resolution |
---|---|---|
Making an API request to a simulated vehicle before connecting the vehicle to your application via Smartcar Connect | { type: "PERMISSION", statusCode: 403, resolution: "REAUTHENTICATE" } | Locate the ‘Connect Credentials’ button at the top of the simulation screen in the Smartcar Dashboard for your simulated vehicle. There you will find the credentials necessary to connect the vehicle to your application as well as instructions for doing so through Smartcar Connect. |
Making an API request to a simulated vehicle before a simulation has been started on Dashboard | { type: "CONNECTED_SERVICES_ACCOUNT", code: "ACCOUNT_ISSUE", statusCode: 400 } | Open the Simulator tab in the Smartcar Dashboard and navigate to your target vehicle. If you haven’t yet selected a vehicle state, do so now, and then start the simulation using the ‘Play’ button on the simulation screen. |
Making an API request to a simulated vehicle that is not associated with your application | { type: "CONNECTED_SERVICES_ACCOUNT", code: "VEHICLE_MISSING", statusCode: 400 } | Ensure the simulated vehicle you are making requests to has been created in the Simulator within your Smartcar Dashboard. |
Feature | Simulator | Live | |
---|---|---|---|
Single Select | ✅ | ✅ | |
Brand Select | ✅ | ✅ | |
Compatibility API* | ✅ | ✅ | |
control_security | ✅ | ✅ | |
control_charge | ✅ | ✅ | |
Make-Specific Endpoints | ❌ | ✅ | |
Scheduled Webhooks | ❌ | ✅ | |
Event Based Webhooks** | ❌ | ✅ |
VIN@smartcar
for test
mode, or generating a simulated vehicle with a real VIN.0SC and 1SC prefixed VINs will not work.
**For supported brands - Toyota, Ford and Tesla.
How are tokens handled?
live
mode:Are there any limits on how many vehicles I can create?
I'm getting an invalid credentials error when I try to sign in to a connected service account.
mode=simulated
parameter