Capabilities of the vehicle.

Provides a summary of the supported endpoints and data points for a vehicle. Each endpoint has a capability representation in the capabilities response indicating whether the endpoint is available for the specific vehicle along with additional information specific to that endpoint.

Scopes

Headers

Mandatory request headers:

Response body

The response body is a map of capabilities where each capability includes the isSupported boolean flag indicating support for that specific capability.

Each capability may define its own specific attributes, such as min and max values, and can also contain nested (child) capabilities. For example, getEnergyState capability may be true, but its child capability chargingPower can be false, meaning when calling /state, then the expected result for chargingPower.status is ERROR with code equal to NOT_SUPPORTED.

Response body with a map of Capability items:

Example

{
    "getEnergyState": {
        "isSupported": true,

        ...

        "chargingPower": {
            "isSupported": false
        }
    }
}

Capability:

GetEnergyStateCapability (extends Capability):

For more information on the different properties in energy state, see the /state endpoint.

Example

{
    "isSupported": true,
    "batteryChargeLevel": { "isSupported": true },
    "electricRange": { "isSupported": true },
    "chargerConnectionStatus": { "isSupported": true },
    "chargingStatus": { "isSupported": true },
    "chargingType": { "isSupported": true },
    "chargerPowerStatus": { "isSupported": true },
    "estimatedChargingTimeToTargetBatteryChargeLevel": { "isSupported": true },
    "targetBatteryChargeLevel": { "isSupported": true },
    "chargingCurrentLimit": { "isSupported": true },
    "chargingPower": { "isSupported": true }
}

Examples