Protocol Documentation
Volvo Cars Fleet Streamed Data enable consuming data about fleet vehicles in real-time.
Table of Contents
events/state_updated.proto
StateUpdated
Main wrapper for any updated container. See the data field for knowing what type of data exists in the event.
| Field | Type | Label | Description |
Field id | Type | Label | Description |
Field vin | Type | Label | Description The VIN of the car. |
Field fleet_id | Type | Label | Description The fleet id the event is generated for. If a car appears in multiple fleets you will duplicate events for a vin from the perspective of the fleet configuration. |
Field event_timestamp | Type | Label | Description The timestamp representing the time when the status was last updated. This is set in the service emitting the event. |
Field fuel | Type | Label | Description See entities.vehiclestates.fuel for more details. |
Field health | Type | Label | Description See entities.vehiclestates.health for more details. |
Field battery | Type | Label | Description See entities.vehiclestates.battery for more details. |
Field exterior | Type | Label | Description See entities.vehiclestates.exterior for more details. |
Field odometer | Type | Label | Description See entities.vehiclestates.odometer for more details. |
Field location | Type | Label | Description See entities.location.location for more details. |
Field availability | Type | Label | Description See entities.vehiclestates.availability for more details. |
entities/location/location.proto
LastKnownLocation
LastKnownLocation represents the last known location of a vehicle, whilst the vehicle is in use. The frequency of updates is dependent on the product definition of the fleet it belongs to.
Data is updated in real-time depending on configuration for a fleet.
| Field | Type | Label | Description |
Field timestamp | Type | Label | Description Timestamp representing the time when the sensors status was captured. The timestamp is set in the car. |
Field longitude | Type | Label | Description GPS longitude of a vehicle in WGS8 decimal format |
Field latitude | Type | Label | Description GPS latitude of a vehicle in WGS8 decimal format |
Field altitude | Type | Label | Description GPS altitude of a vehicle in WGS8 decimal format |
Field speed_km_per_hour | Type | Label | Description Vehicle current speed in km/h |
Field heading_degree | Type | Label | Description Direction in which vehicle is pointing relative to true north in degrees. 0.0 (inclusive) and 360.0 (exclusive), with 0 indicating north, 90 east, 180 south, and 270 west. The exact value is an Android combination of underlying physical sensors like GPS, magnetometer, accelerometer and gyroscope. |
entities/vehiclestates/battery.proto
Battery
The battery status of the car. This includes information about the battery charge level, estimated distance to empty.
Data is updated in real-time when the status changes.
| Field | Type | Label | Description |
Field timestamp | Type | Label | Description Timestamp representing the time when the status was last updated. The timestamp is set in the car. |
Field battery_charge_level_percentage | Type | Label optional | Description The battery charge level in percentage. The value will be updated while the car is driving, charging or discharging, with events emitted on every .1% change. For classic cars this is not reliably updated. |
Field estimated_distance_to_empty_km | Type | Label optional | Description The estimated distance to empty in kilometers and miles. These values are not always exact equal distances, as the conversion is done to match what is shown in the car. |
Field estimated_distance_to_empty_miles | Type | Label optional | Description |
Field charger_connection_status | Type | Label | Description Information on if a cable is connected to the car. See enum for more details. |
Field charging_status | Type | Label | Description The charging status of the car. See enum for more details. |
Field charging_type | Type | Label | Description Information about charge type. See enum for more details. |
Field estimated_charging_time_to_full_minutes | Type | Label optional | Description The estimated time to charge in minutes. Target SOC is considered as full if set. |
Field estimated_charging_time_minutes_to_target_distance | Type | Label optional | Description The estimated time to charge in minutes to reach the target distance set in the car. Only available for SPA2. |
Field estimated_charging_time_minutes_to_minimum_soc | Type | Label optional | Description The estimated time to charge in minutes to reach the minimum SOC set. Only available for SPA2. |
Field charging_power_watts | Type | Label optional | Description Current charging watts. This data is not supported for PHEV cars. |
Field charging_current_amps | Type | Label optional | Description Current charging amps This data is not supported for PHEV cars. |
Field charging_voltage_volts | Type | Label optional | Description Current charging volts This data is not supported for PHEV cars. |
Field average_energy_consumption_kwh_per_100_km_manual | Type | Label optional | Description The average energy consumption in kWh per 100 kilometer for manual, |
Field average_energy_consumption_kwh_per_100_km | Type | Label optional | Description The average energy consumption in kWh per 100 kilometer for automatic Only available for SPA2. |
Field average_energy_consumption_kwh_per_100_km_since_charge | Type | Label optional | Description The average energy consumption in kWh per 100 kilometer since last charge. Only available for SPA2. |
Field total_energy_consumption_wh | Type | Label optional | Description The total energy consumption in Wh for manual trip meter Only available for SPA2. |
Field total_energy_consumption_wh_automatic | Type | Label optional | Description The total energy consumption in Wh for automatic trip meter Only available for SPA2. |
Field total_energy_consumption_wh_since_charge | Type | Label optional | Description The total energy consumption in since last charge. Only available for SPA2. |
Field energy_consumption_wh_manual | Type | Label | Description The detailed energy consumption in Wh for manual trip meter. See enum for more details. Only available for SPA2. |
Field energy_consumption_wh_automatic | Type | Label | Description The detailed energy consumption in Wh for automatic trip meter. See enum for more details. Only available for SPA2. |
Field energy_consumption_wh_since_charge | Type | Label | Description The detailed energy consumption in Wh since last charge. See enum for more details. Only available for SPA2. |
Field energy_consumption_percentage_manual | Type | Label | Description The energy consumption as a percentage for manual trip meters See enum for more details. Only available for SPA2. |
Field energy_consumption_percentage_automatic | Type | Label | Description The energy consumption as a percentage for automatic trip meters See enum for more details. Only available for SPA2. |
Field energy_consumption_percentage_since_charge | Type | Label | Description The energy consumption as a percentage since last charge See enum for more details. Only available for SPA2. |
Field charger_power_status | Type | Label | Description The chargers power status. Can be used to determine if the charger is providing power or if it has an issue. See enum for more details. |
Battery.EnergyConsumptionPercentage
Defines the energy consumption percentage spread across the different categories which should all add up to 100%.
| Field | Type | Label | Description |
Field other | Type | Label optional | Description The energy consumption for other categories. |
Field driving | Type | Label optional | Description The energy consumption for driving the car. |
Field climate | Type | Label optional | Description The energy consumption of the cabin climate. |
Field battery | Type | Label optional | Description The energy consumption for battery conditioning. |
Battery.EnergyConsumptionWh
Defines the energy consumption in Wh spread across the different categories.
| Field | Type | Label | Description |
Field other | Type | Label optional | Description The energy consumption for other categories. |
Field driving | Type | Label optional | Description The energy consumption for driving the car. |
Field climate | Type | Label optional | Description The energy consumption of the cabin climate. |
Field battery | Type | Label optional | Description The energy consumption for battery conditioning. |
Battery.ChargerConnectionStatus
The connection status for charging cable
| Name | Number | Description |
Name CHARGER_CONNECTION_STATUS_UNSPECIFIED | Number 0 | Description The charger connection status is not set. |
Name CHARGER_CONNECTION_STATUS_CONNECTED | Number 1 | Description The charger is connected to the car. |
Name CHARGER_CONNECTION_STATUS_DISCONNECTED | Number 2 | Description The charger is not connected to the car. |
Name CHARGER_CONNECTION_STATUS_FAULT | Number 3 | Description The charger is connected, but faulty and cannot charge the car. |
Battery.ChargerPowerStatus
Detailed information about the chargers power status.
| Name | Number | Description |
Name CHARGER_POWER_STATUS_UNSPECIFIED | Number 0 | Description Charger power status is not set. |
Name CHARGER_POWER_STATUS_NO_POWER_AVAILABLE | Number 1 | Description The charger is not providing power. This will also be set when the charger is disconnected. |
Name CHARGER_POWER_STATUS_INITIALIZATION | Number 2 | Description The charger is initializing. It could be stuck in this state if the charger is waiting for payment, etc. |
Name CHARGER_POWER_STATUS_POWER_AVAILABLE_BUT_NOT_ACTIVATED | Number 3 | Description The charger is connected and power is available but not activated. This could happen when the charging is scheduled. |
Name CHARGER_POWER_STATUS_PROVIDING_POWER | Number 4 | Description The charger is providing power. |
Name CHARGER_POWER_STATUS_FAULT | Number 5 | Description The charger is connected but faulty and cannot provide power. |
Battery.ChargingStatus
Current charging status when connected
| Name | Number | Description |
Name CHARGING_STATUS_UNSPECIFIED | Number 0 | Description The charging status is not set. |
Name CHARGING_STATUS_CHARGING | Number 1 | Description The car is charging. |
Name CHARGING_STATUS_IDLE | Number 2 | Description The car is not charging. |
Name CHARGING_STATUS_SCHEDULED | Number 3 | Description The car is not charging due to a charging schedule. |
Name CHARGING_STATUS_DISCHARGING | Number 4 | Description The car is discharging. |
Name CHARGING_STATUS_ERROR | Number 5 | Description The car is not charging due to an error. |
Name CHARGING_STATUS_SMART_CHARGING | Number 6 | Description The car is charging due to smart charging. The car will charge according to electricity prices, when the car should be ready and other factors. |
Name CHARGING_STATUS_SMART_CHARGING_PAUSED | Number 8 | Description The car is not charging due to smart charging. |
Name CHARGING_STATUS_DONE | Number 7 | Description The car is done charging. It has reached the target SOC or full battery if no target SOC is set. |
Battery.ChargingType
Type of charging connection
| Name | Number | Description |
Name CHARGING_TYPE_UNSPECIFIED | Number 0 | Description The charging type is not set. |
Name CHARGING_TYPE_NONE | Number 1 | Description The car is not charging. |
Name CHARGING_TYPE_AC | Number 2 | Description The car is charging with AC. |
Name CHARGING_TYPE_DC | Number 3 | Description The car is charging with DC. |
Name CHARGING_TYPE_WIRELESS | Number 4 | Description The car is charging wirelessly. Only very few cars supports this. |
entities/vehiclestates/fuel.proto
Fuel
This describes the fuel status of the car, meaning it is valid for both ICE and PHEV cars. The fuel status is not valid for BEV cars. Data is updated on keyin and keyout events, i.e. not real-time.
| Field | Type | Label | Description |
Field timestamp | Type | Label | Description Timestamp representing the time when the status was last updated. The timestamp is set in the car. |
Field distance_to_empty_km | Type | Label optional | Description The distance to empty in kilometers. Note that these are not always exact equal distances, as the conversion is done to match what is shown in the car. |
Field distance_to_empty_miles | Type | Label optional | Description The distance to empty in kilometers. Note that these are not always exact equal distances, as the conversion is done to match what is shown in the car. |
Field fuel_amount_liters | Type | Label optional | Description The current fuel amount in liters. |
Field average_fuel_consumption_liters_per_100_km | Type | Label optional | Description The average fuel consumption in liters per 100 kilometer for manual trip meters. |
Field average_fuel_consumption_liters_per_100_km_manual | Type | Label optional | Description The average fuel consumption in liters per 100 kilometer for automatic trip meters. |
entities/vehiclestates/health.proto
Health
This describes the health status of the car, including fluid levels, tyre warnings, light warnings, and service warnings. Statuses for when the car needs service can go to 0 and stay there until the car is serviced. Data is updated on keyin and keyout events, i.e. not real-time.
| Field | Type | Label | Description |
Field timestamp | Type | Label | Description Timestamp representing the time when the status was last updated. The timestamp is set in the car. |
Field engine_hours_to_service | Type | Label optional | Description Engine hours before service is needed. |
Field days_to_service | Type | Label optional | Description Days before service is needed. |
Field distance_to_service_km | Type | Label optional | Description Distance, in km, before service is needed. |
Field service_warning | Type | Label | Description Service warnings that is also shown in the car. See enum for more details. |
Field brake_fluid_level_warning | Type | Label | Description Break fluid level warnings. See enums for more details. |
Field engine_coolant_level_warning | Type | Label | Description Engine coolant fluid level warnings. See enums for more details. |
Field oil_level_warning | Type | Label | Description Oil level warnings. See enums for more details. |
Field washer_fluid_level_warning | Type | Label | Description Washer fluid level warnings. See enums for more details. |
Field front_left_tyre_pressure_warning | Type | Label | Description Front left tyre pressure warnings. See enum for more details. |
Field front_right_tyre_pressure_warning | Type | Label | Description Front right tyre pressure warnings. See enum for more details. |
Field rear_left_tyre_pressure_warning | Type | Label | Description Rear left tyre pressure warnings. See enum for more details. |
Field rear_right_tyre_pressure_warning | Type | Label | Description Rear right tyre pressure warnings. See enum for more details. |
Field front_left_tyre_pressure_kpa | Type | Label optional | Description Front left tyre pressure value in kPA. Only available for EX30 |
Field front_right_tyre_pressure_kpa | Type | Label optional | Description Front right tyre pressure value in kPA. Only available for EX30 |
Field rear_left_tyre_pressure_kpa | Type | Label optional | Description Rear left tyre pressure value in kPA. Only available for EX30 |
Field rear_right_tyre_pressure_kpa | Type | Label optional | Description Rear right tyre pressure value in kPA. Only available for EX30 |
Field brake_light_left_warning | Type | Label | Description Exterior light warnings. See enum for more details. |
Field brake_light_center_warning | Type | Label | Description |
Field brake_light_right_warning | Type | Label | Description |
Field fog_light_front_warning | Type | Label | Description |
Field fog_light_rear_warning | Type | Label | Description |
Field position_light_front_left_warning | Type | Label | Description |
Field position_light_front_right_warning | Type | Label | Description |
Field position_light_rear_left_warning | Type | Label | Description |
Field position_light_rear_right_warning | Type | Label | Description |
Field high_beam_left_warning | Type | Label | Description |
Field high_beam_right_warning | Type | Label | Description |
Field low_beam_left_warning | Type | Label | Description |
Field low_beam_right_warning | Type | Label | Description |
Field daytime_running_light_left_warning | Type | Label | Description |
Field daytime_running_light_right_warning | Type | Label | Description |
Field turn_indication_front_left_warning | Type | Label | Description |
Field turn_indication_front_right_warning | Type | Label | Description |
Field turn_indication_rear_left_warning | Type | Label | Description |
Field turn_indication_rear_right_warning | Type | Label | Description |
Field registration_plate_light_warning | Type | Label | Description |
Field side_mark_lights_warning | Type | Label | Description iCUP specific light warnings. See enum for more details. |
Field hazard_lights_warning | Type | Label | Description Classic specific light warnings. See enum for more details. |
Field reverse_lights_warning | Type | Label | Description |
Field low_voltage_battery_warning | Type | Label | Description 12V battery warning. See enum for more details. iCUP Only |
Health.BrakeFluidLevelWarning
| Name | Number | Description |
Name BRAKE_FLUID_LEVEL_WARNING_UNSPECIFIED | Number 0 | Description The brake fluid level warning is not set. |
Name BRAKE_FLUID_LEVEL_WARNING_NO_WARNING | Number 1 | Description |
Name BRAKE_FLUID_LEVEL_WARNING_TOO_LOW | Number 2 | Description |
Health.EngineCoolantLevelWarning
| Name | Number | Description |
Name ENGINE_COOLANT_LEVEL_WARNING_UNSPECIFIED | Number 0 | Description The engine coolant level warning is not set. |
Name ENGINE_COOLANT_LEVEL_WARNING_NO_WARNING | Number 1 | Description |
Name ENGINE_COOLANT_LEVEL_WARNING_TOO_LOW | Number 2 | Description |
Health.ExteriorLightWarning
| Name | Number | Description |
Name EXTERIOR_LIGHT_WARNING_UNSPECIFIED | Number 0 | Description The exterior light warning is not set. |
Name EXTERIOR_LIGHT_WARNING_NO_WARNING | Number 1 | Description |
Name EXTERIOR_LIGHT_WARNING_FAILURE | Number 2 | Description |
Health.LowVoltageBatteryWarning
| Name | Number | Description |
Name LOW_VOLTAGE_BATTERY_WARNING_UNSPECIFIED | Number 0 | Description The low voltage battery warning is not set. |
Name LOW_VOLTAGE_BATTERY_WARNING_NO_WARNING | Number 1 | Description |
Name LOW_VOLTAGE_BATTERY_WARNING_TOO_LOW | Number 2 | Description |
Health.OilLevelWarning
| Name | Number | Description |
Name OIL_LEVEL_WARNING_UNSPECIFIED | Number 0 | Description The oil level warning is not set. |
Name OIL_LEVEL_WARNING_NO_WARNING | Number 1 | Description |
Name OIL_LEVEL_WARNING_SERVICE_REQUIRED | Number 2 | Description |
Name OIL_LEVEL_WARNING_TOO_LOW | Number 3 | Description |
Name OIL_LEVEL_WARNING_TOO_HIGH | Number 4 | Description |
Health.ServiceWarning
| Name | Number | Description |
Name SERVICE_WARNING_UNSPECIFIED | Number 0 | Description The service warning is not set. |
Name SERVICE_WARNING_NO_WARNING | Number 1 | Description The car does not need service. |
Name SERVICE_WARNING_UNKNOWN_WARNING | Number 2 | Description Unknown warning, older models (Platform P1, P2) can't give detailed warnings. |
Name SERVICE_WARNING_REGULAR_MAINTENANCE_ALMOST_TIME_FOR_SERVICE | Number 3 | Description It is almost time for service because of the given reason. The trigger for this depends on car model and modely year. |
Name SERVICE_WARNING_ENGINE_HOURS_ALMOST_TIME_FOR_SERVICE | Number 4 | Description |
Name SERVICE_WARNING_DISTANCE_DRIVEN_ALMOST_TIME_FOR_SERVICE | Number 5 | Description |
Name SERVICE_WARNING_REGULAR_MAINTENANCE_TIME_FOR_SERVICE | Number 6 | Description It is time for service because of the given reason. |
Name SERVICE_WARNING_ENGINE_HOURS_TIME_FOR_SERVICE | Number 7 | Description |
Name SERVICE_WARNING_DISTANCE_DRIVEN_TIME_FOR_SERVICE | Number 8 | Description |
Name SERVICE_WARNING_REGULAR_MAINTENANCE_OVERDUE_FOR_SERVICE | Number 9 | Description The car is overdue for service because of the given reason. |
Name SERVICE_WARNING_ENGINE_HOURS_OVERDUE_FOR_SERVICE | Number 10 | Description |
Name SERVICE_WARNING_DISTANCE_DRIVEN_OVERDUE_FOR_SERVICE | Number 11 | Description |
Health.TyrePressureWarning
| Name | Number | Description |
Name TYRE_PRESSURE_WARNING_UNSPECIFIED | Number 0 | Description The tyre pressure warning is not set. |
Name TYRE_PRESSURE_WARNING_NO_WARNING | Number 1 | Description |
Name TYRE_PRESSURE_WARNING_VERY_LOW_PRESSURE | Number 2 | Description |
Name TYRE_PRESSURE_WARNING_LOW_PRESSURE | Number 3 | Description |
Name TYRE_PRESSURE_WARNING_HIGH_PRESSURE | Number 4 | Description |
Health.WasherFluidLevelWarning
| Name | Number | Description |
Name WASHER_FLUID_LEVEL_WARNING_UNSPECIFIED | Number 0 | Description The washer fluid level warning is not set. |
Name WASHER_FLUID_LEVEL_WARNING_NO_WARNING | Number 1 | Description |
Name WASHER_FLUID_LEVEL_WARNING_TOO_LOW | Number 2 | Description |
entities/vehiclestates/odometer.proto
Odometer
Contains the odometer status of the car. Data is updated on keyin and keyout events, i.e. not real-time.
| Field | Type | Label | Description |
Field timestamp | Type | Label | Description Timestamp representing the time when the status was last updated. The timestamp is set in the car. |
Field odometer_meters | Type | Label optional | Description The total distance driven in the lifetime of the car in meters. |
Field trip_meter_manual_km | Type | Label optional | Description The distance of the manual trip meter in km which can be manually reset in the car. |
Field average_speed_km_per_hour_manual | Type | Label optional | Description Average speed in km per hour since reset of the manual trip meter. |
Field trip_meter_automatic_km | Type | Label optional | Description The distance of the automatic trip meter in km which is reset at the start of every trip. |
Field average_speed_km_per_hour | Type | Label optional | Description Average speed in km per hour for the last trip. |
Field trip_meter_since_charge_km | Type | Label optional | Description The distance of the trip meter which is reset every time the car is charged. Only available for SPA2. |
Field average_speed_km_per_hour_since_charge | Type | Label optional | Description Average speed in km per hour since the car was charged. Only available for SPA2. |
entities/vehiclestates/exterior.proto
Exterior
This describes the exterior status of the car. Data is updated in real-time when the status changes.
| Field | Type | Label | Description |
Field timestamp | Type | Label | Description Timestamp representing the time when the status was last updated. The timestamp is set in the car. |
Field central_lock | Type | Label | Description The central lock status of the car. Note that this is not lock status for a specific door, the hood or the tailgate. See enum for more details. |
Field front_left_door | Type | Label | Description Status for front left door. See enum for more details. |
Field front_right_door | Type | Label | Description Status for front right door. See enum for more details. |
Field rear_left_door | Type | Label | Description Status for rear left door. See enum for more details. |
Field rear_right_door | Type | Label | Description Status for rear right door. See enum for more details. |
Field front_left_window | Type | Label | Description Status for front left window. See enum for more details. |
Field front_right_window | Type | Label | Description Status for front right window. See enum for more details. |
Field rear_left_window | Type | Label | Description Status for rear left window. See enum for more details. |
Field rear_right_window | Type | Label | Description Status for rear right window. See enum for more details. |
Field hood | Type | Label | Description Status for hood. See enum for more details. |
Field tailgate | Type | Label | Description Status for tailgate. See enum for more details. |
Field tank_lid | Type | Label | Description Status for tank_lid. See enum for more details. |
Field sunroof | Type | Label | Description Status for sunroof. See enum for more details. |
Field alarm | Type | Label | Description The status if the alarm is triggered or not. Note that this is not the status if the alarm is armed or not. |
Exterior.AlarmStatus
| Name | Number | Description |
Name ALARM_STATUS_UNSPECIFIED | Number 0 | Description The alarm status is not set. |
Name ALARM_STATUS_IDLE | Number 1 | Description No alarm currently triggered |
Name ALARM_STATUS_TRIGGERED | Number 2 | Description |
Exterior.LockStatus
| Name | Number | Description |
Name LOCK_STATUS_UNSPECIFIED | Number 0 | Description The lock status is not set. |
Name LOCK_STATUS_UNLOCKED | Number 1 | Description |
Name LOCK_STATUS_LOCKED | Number 2 | Description |
Exterior.OpenStatus
| Name | Number | Description |
Name OPEN_STATUS_UNSPECIFIED | Number 0 | Description The open status is not set. |
Name OPEN_STATUS_OPEN | Number 1 | Description |
Name OPEN_STATUS_CLOSED | Number 2 | Description |
Name OPEN_STATUS_AJAR | Number 3 | Description Ajar, as in slightly open |
entities/vehiclestates/availability.proto
Availability
This describes the availability of the car.
Data is updated in real-time when the status changes.
| Field | Type | Label | Description |
Field timestamp | Type | Label | Description Timestamp representing the time when the status was last updated. The timestamp is set in the car on CAR_IN_USE. For other reasons the timestamp comes from other systems. |
Field availability_status | Type | Label | Description The remote functions availability status of the vehicle. See enum for more details. |
Field unavailable_reason | Type | Label | Description The reason for the unavailability of the vehicle. This will be set if availability_status is AVAILABILITY_STATUS_UNAVAILABLE. See enum for more details. |
Field usage_mode | Type | Label | Description Detailed information about the car usage mode. See enum for more details. |
Availability.AvailabilityStatus
Availability statuses for a car. Used in tandem with UnavailableReason.
| Name | Number | Description |
Name AVAILABILITY_STATUS_UNSPECIFIED | Number 0 | Description The car availability status is not set. |
Name AVAILABILITY_STATUS_AVAILABLE | Number 1 | Description The car should accept remote invocations requests. |
Name AVAILABILITY_STATUS_UNAVAILABLE | Number 2 | Description The car will reject or not get remote invocations requests. |
Availability.UnavailableReason
Detailed information about why the car is unavailable.
| Name | Number | Description |
Name UNAVAILABLE_REASON_UNSPECIFIED | Number 0 | Description The car availability reason is not set. |
Name UNAVAILABLE_REASON_NO_INTERNET | Number 1 | Description The car is not connected to connected car cloud. |
Name UNAVAILABLE_REASON_POWER_SAVING_MODE | Number 2 | Description The car is in a power saving mode which requires physical user interaction to wake up. |
Name UNAVAILABLE_REASON_CAR_IN_USE | Number 3 | Description The car is in use, driving or engine is running. |
Name UNAVAILABLE_REASON_OTA_INSTALLATION_IN_PROGRESS | Number 4 | Description The car is in the middle of an OTA installation. |
Name UNAVAILABLE_REASON_STOLEN_VEHICLE_TRACKING_IN_PROGRESS | Number 5 | Description The car is being tracked due to it being stolen and should be left to law enforcement. |
Name UNAVAILABLE_REASON_SERVICE_MODE_ACTIVE | Number 6 | Description The car is currently being serviced. |
Availability.UsageMode
Current usage of the car.
| Name | Number | Description |
Name USAGE_MODE_UNSPECIFIED | Number 0 | Description The car usage mode is not set. |
Name USAGE_MODE_ABANDONED | Number 1 | Description |
Name USAGE_MODE_INACTIVE | Number 2 | Description |
Name USAGE_MODE_CONVENIENCE | Number 3 | Description |
Name USAGE_MODE_ACTIVE | Number 4 | Description |
Name USAGE_MODE_DRIVING | Number 5 | Description |
Name USAGE_MODE_ENGINE_ON | Number 6 | Description Indicates that the ICE engine has been started Set only for Classic with ICE |
Name USAGE_MODE_ENGINE_OFF | Number 7 | Description Indicates that the ICE engine has been stopped Set only for Classic with ICE |
entities/common/timestamp.proto
Timestamp
Represents the time of the update. This could be either set by the car or by services, depending on the data.
| Field | Type | Label | Description |
Field seconds | Type | Label | Description Represents seconds of UTC time since 1970-01-01T00:00:00Z (Unix epoch). |
Field nanos | Type | Label | Description Non-negative fractions of a second at nanosecond resolution. This field provides additional precision to the seconds field |
Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
.proto Type | Notes | C++ double | Java double | Python float | Go float64 | C# double | PHP float | Ruby Float |
.proto Type | Notes | C++ float | Java float | Python float | Go float32 | C# float | PHP float | Ruby Float |
.proto Type | Notes Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | C++ int32 | Java int | Python int | Go int32 | C# int | PHP integer | Ruby Bignum or Fixnum (as required) |
.proto Type | Notes Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | C++ int64 | Java long | Python int/long | Go int64 | C# long | PHP integer/string | Ruby Bignum |
.proto Type | Notes Uses variable-length encoding. | C++ uint32 | Java int | Python int/long | Go uint32 | C# uint | PHP integer | Ruby Bignum or Fixnum (as required) |
.proto Type | Notes Uses variable-length encoding. | C++ uint64 | Java long | Python int/long | Go uint64 | C# ulong | PHP integer/string | Ruby Bignum or Fixnum (as required) |
.proto Type | Notes Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | C++ int32 | Java int | Python int | Go int32 | C# int | PHP integer | Ruby Bignum or Fixnum (as required) |
.proto Type | Notes Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | C++ int64 | Java long | Python int/long | Go int64 | C# long | PHP integer/string | Ruby Bignum |
.proto Type | Notes Always four bytes. More efficient than uint32 if values are often greater than 2^28. | C++ uint32 | Java int | Python int | Go uint32 | C# uint | PHP integer | Ruby Bignum or Fixnum (as required) |
.proto Type | Notes Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | C++ uint64 | Java long | Python int/long | Go uint64 | C# ulong | PHP integer/string | Ruby Bignum |
.proto Type | Notes Always four bytes. | C++ int32 | Java int | Python int | Go int32 | C# int | PHP integer | Ruby Bignum or Fixnum (as required) |
.proto Type | Notes Always eight bytes. | C++ int64 | Java long | Python int/long | Go int64 | C# long | PHP integer/string | Ruby Bignum |
.proto Type | Notes | C++ bool | Java boolean | Python boolean | Go bool | C# bool | PHP boolean | Ruby TrueClass/FalseClass |
.proto Type | Notes A string must always contain UTF-8 encoded or 7-bit ASCII text. | C++ string | Java String | Python str/unicode | Go string | C# string | PHP string | Ruby String (UTF-8) |
.proto Type | Notes May contain any arbitrary sequence of bytes. | C++ string | Java ByteString | Python str | Go []byte | C# ByteString | PHP string | Ruby String (ASCII-8BIT) |