Documentation Index
Fetch the complete documentation index at: https://developer.energy-hub.io/llms.txt
Use this file to discover all available pages before exploring further.
Supported Devices
| Model | Limitations |
|---|
| 225xe | - |
| 330e | - |
| 530e | - |
| 740e | - |
| 740Le | - |
| 745e | - |
| 745Le | - |
| 750e | - |
| i3 | - |
| i4 | - |
| i5 | - |
| i7 | - |
| i8 | - |
| iX | - |
| iX1 | - |
| iX2 | - |
| iX3 | - |
| M5 | - |
| M760e | - |
| X1 | - |
| X2 | - |
| X3 | - |
| X5 | - |
| XM | - |
Supported Data Fields
| Field Name | Description | Supported |
|---|
chargeState.chargeRate | Current charging power/rate . | ✓ |
chargeState.chargeCurrentMax | Maximum charging current that the vehicle can accept. | ✓ |
chargeState.lastUpdated | Timestamp for the chargeState snapshot. | ✓ |
chargeState.stateOfCharge | Battery state of charge in percent. | ✓ |
chargeState.chargingTimeRemaining | Estimated time remaining to finish charging . | ✓ |
chargeState.chargeLimitMin | Minimum charge limit set (percent). | ✗ |
chargeState.chargeLimitMax | Maximum charge limit set (percent). | ✓ |
chargeState.scheduledDepartureTime | Scheduled departure time, if set. | ✓ |
chargeState.scheduledChargingStartTime | Scheduled charging start time, if set. | ✗ |
chargeState.estimatedRange | Estimated remaining driving range . | ✓ |
chargeState.chargingState | Charging status enum (e.g., CHARGING, STOPPED, etc.). | ✓ |
chargeState.isPlugged | Indicates if the charger is plugged into the car. | ✓ |
chargeState.remoteChargingAllowed | If charging control is allowed. | ✓ |
odometer.lastUpdated | Timestamp for the odometer snapshot. | ✗ |
odometer.odometer | Vehicle odometer reading . | ✗ |
isOnline | Whether the vehicle is currently online/reachable. | ✓ |
location.lastUpdated | Timestamp for the location snapshot. | ✗ |
location.latitude | Latitude coordinate. | ✗ |
location.longitude | Longitude coordinate. | ✗ |
climateState.lastUpdated | Timestamp for the climateState snapshot. | ✓ |
climateState.isClimateOn | Whether cabin climate is currently on. | ✓ |
climateState.isBatteryHeaterOn | Whether the battery heater is on. | ✗ |
climateState.temperatureCurrent | Current cabin temperature. | ✗ |
climateState.temperatureTarget | Target cabin temperature. | ✗ |
staticData.lastUpdated | Timestamp for the staticData snapshot. | ✓ |
staticData.vendor | Vehicle vendor/manufacturer | ✓ |
staticData.name | Friendly/display name for the vehicle. | ✓ |
staticData.engineType | Engine/fuel type (e.g., BEV, PHEV). | ✗ |
staticData.vin | Vehicle Identification Number. | ✗ |
staticData.model | Model name. | ✓ |
staticData.batteryCapacity | Battery capacity. | ✓ |
staticData.vehicleVariant | Trim/variant designation. | ✗ |
Supported Commands
| Command Name | Short description | Supported |
|---|
| Start Charging | Starts the charging process. | ✓ |
| Stop Charging | Stops the charging process. | ✓ |
| Schedules | Sets a charging schedule for the vehicle. | ✓ |
Data Update Interval
| State | Refresh Rate |
|---|
| Idle | 15 min |
| Driving | 15 min |
| Charging | 5 min |
