Skip to content

Entity Reference

This page provides a comprehensive reference of all entities provided by the AutoPi integration.

Sensors

The AutoPi integration provides integration-level sensors and vehicle-level sensors. Data field sensors are created dynamically based on the telemetry fields reported by each vehicle.

Integration Sensors

These sensors provide information about the AutoPi integration itself:

EntityDescriptionCategoryDevice ClassUnitState ClassIcon
Fleet Alert CountSensor showing the total number of fleet alerts.Diagnostic-alertsMeasurementmdi:alert
Fleet Vehicle SummarySensor showing fleet vehicle activity summary.Diagnostic-vehiclesMeasurement-
Update DurationSensor showing the average duration of the last updates across all coordinators.Diagnostic-sMeasurementmdi:timer
Vehicle CountSensor showing the total number of vehicles.Diagnostic-vehiclesMeasurementmdi:car-multiple

Vehicle Status & Trip Sensors

These sensors provide general status information for each vehicle:

EntityDescriptionCategoryDevice ClassUnitState ClassIcon
Event VolumeSensor showing event volume for a tag and window.Diagnostic-eventsMeasurement-
Geofence CountSensor showing geofence count for a vehicle.Diagnostic-geofencesMeasurementmdi:map-marker
Last Charge DurationSensor showing duration of the last charge session.DiagnosticDurationSECONDSMeasurementmdi:timer
Last CommunicationSensor showing last communication timestamp.DiagnosticTimestamp--mdi:clock
Last Trip DistanceSensor showing the distance of the last trip.PrimaryDistanceKILOMETERSMeasurementmdi:road-variant
Location CountSensor showing location count for a vehicle.Diagnostic-locationsMeasurementmdi:map-marker-radius
Trip Average SpeedSensor showing average trip speed.PrimarySpeedKILOMETERS_PER_HOURMeasurementmdi:speedometer
Trip CountSensor showing the total number of trips for a vehicle.Diagnostic-tripsTotalmdi:map-marker-distance
Trip Lifetime DistanceSensor showing total lifetime trip distance.PrimaryDistanceKILOMETERSTotal Increasingmdi:road-variant
Vehicle Alert CountSensor showing open alerts for a vehicle.Diagnostic-alertsMeasurementmdi:alert
Vehicle DTC CountSensor showing DTC count for a vehicle.Diagnostic-codesMeasurementmdi:alert-circle
Vehicle Last DTCSensor showing last DTC code.Diagnostic---mdi:car-wrench
Vehicle SensorSensor representing an individual vehicle.Primary---mdi:car

Data Field Sensors

These sensors are created when the vehicle reports the corresponding telemetry fields:

GPS/Position Sensors

EntityDescriptionCategoryDevice ClassUnitState ClassIcon
GPS AltitudeGPS altitude sensor.PrimaryDistanceMETERSMeasurementmdi:elevation-rise
GPS CourseGPS course/heading sensor.Primary-°Measurementmdi:compass
GPS LatitudeGPS latitude sensor.Diagnostic--Measurementmdi:latitude
GPS LongitudeGPS longitude sensor.Diagnostic--Measurementmdi:longitude
GPS PrecisionGPS precision/position quality sensor.PrimaryDistanceMETERSMeasurementmdi:crosshairs-gps
GPS SatellitesGPS satellites sensor.Primary--Measurementmdi:satellite-variant
GPS SpeedGPS speed sensor.PrimarySpeedMETERS_PER_SECONDMeasurementmdi:speedometer

Battery Sensors

EntityDescriptionCategoryDevice ClassUnitState ClassIcon
Battery Charge LevelBattery charge level sensor.PrimaryBatteryPERCENTAGEMeasurementmdi:battery
Battery Charging StateBattery charging state sensor.Primary---mdi:battery-charging
Battery CurrentBattery current sensor.PrimaryCurrentAMPEREMeasurementmdi:current-dc
Battery VoltageBattery voltage sensor.PrimaryVoltageVOLTMeasurementmdi:lightning-bolt
External VoltageExternal/aux voltage sensor.DiagnosticVoltageVOLTMeasurementmdi:flash
HV Battery Charging StateEV high-voltage battery charging state sensor.Primary---mdi:battery-charging
HV Battery CurrentEV high-voltage battery current sensor.PrimaryCurrentAMPEREMeasurementmdi:current-dc
HV Battery EnergyEV high-voltage battery available energy sensor.PrimaryEnergy StorageKILO_WATT_HOURMeasurementmdi:battery-charging-high
HV Battery Lifetime Energy ChargedEV high-voltage battery lifetime energy charged sensor.Diagnostic---mdi:battery-arrow-up
HV Battery Lifetime Energy UsedEV high-voltage battery lifetime energy discharged sensor.Diagnostic---mdi:battery-arrow-down
HV Battery Max Cell TemperatureEV high-voltage battery maximum cell temperature sensor.DiagnosticTemperatureCELSIUSMeasurementmdi:thermometer-high
HV Battery Max Cell VoltageEV high-voltage battery maximum cell voltage sensor.DiagnosticVoltageVOLTMeasurementmdi:flash-outline
HV Battery Max EnergyEV high-voltage battery maximum energy sensor.DiagnosticEnergy StorageKILO_WATT_HOURMeasurementmdi:battery-high
HV Battery Min Cell TemperatureEV high-voltage battery minimum cell temperature sensor.DiagnosticTemperatureCELSIUSMeasurementmdi:thermometer-low
HV Battery Min Cell VoltageEV high-voltage battery minimum cell voltage sensor.DiagnosticVoltageVOLTMeasurementmdi:flash-outline
HV Battery SocEV high-voltage battery state of charge sensor.PrimaryBatteryPERCENTAGEMeasurementmdi:battery
HV Battery State Of HealthEV high-voltage battery state of health sensor.Diagnostic-PERCENTAGEMeasurementmdi:battery-heart-variant
HV Battery TemperatureEV high-voltage battery pack temperature sensor.PrimaryTemperatureCELSIUSMeasurementmdi:thermometer
HV Battery VoltageEV high-voltage battery pack voltage sensor.PrimaryVoltageVOLTMeasurementmdi:flash
Tracker Battery LevelTracker battery level sensor.DiagnosticBatteryPERCENTAGEMeasurementmdi:battery
Vehicle Battery VoltageVehicle system battery voltage sensor.PrimaryVoltageVOLTMeasurementmdi:car-battery

Engine & Performance Sensors

EntityDescriptionCategoryDevice ClassUnitState ClassIcon
EngineEngine RPM sensor.Primary-rpmMeasurementmdi:engine
Engine LoadEngine load sensor.Primary-PERCENTAGEMeasurementmdi:gauge
Engine Run TimeEngine run time sensor.PrimaryDurationSECONDSMeasurementmdi:timer
Ignition StateIgnition state sensor.Primary---mdi:key
OBD SpeedOBD speed sensor.PrimarySpeedKILOMETERS_PER_HOURMeasurementmdi:speedometer
Throttle PositionThrottle position sensor.Primary-PERCENTAGEMeasurementmdi:gas-pedal

Fuel Sensors

EntityDescriptionCategoryDevice ClassUnitState ClassIcon
Fuel LevelFuel level sensor.Primary-PERCENTAGEMeasurementmdi:gas-station
Fuel Rate ECUInstantaneous fuel rate sensor from ECU.PrimaryVolume Flow RateLITERS_PER_HOURMeasurementmdi:fuel
Fuel Rate GPSFuel rate GPS sensor.Primary-L/hMeasurementmdi:fuel
Fuel Used GPSFuel used GPS sensor.PrimaryVolumeLITERSTotal Increasingmdi:fuel
OEM Fuel LevelOEM fuel level sensor.PrimaryVolume StorageLITERSMeasurementmdi:fuel

Distance & Odometer Sensors

EntityDescriptionCategoryDevice ClassUnitState ClassIcon
Distance Since Codes ClearDistance since diagnostic codes cleared sensor.DiagnosticDistanceKILOMETERSTotal Increasingmdi:road-variant
EV Remaining DistanceEV remaining driving range sensor.PrimaryDistanceKILOMETERSMeasurementmdi:map-marker-distance
OEM Total MileageOEM total mileage sensor.PrimaryDistanceKILOMETERSTotal Increasingmdi:counter
Total OdometerTotal odometer sensor.PrimaryDistanceKILOMETERSTotal Increasingmdi:counter
Trip OdometerTrip odometer sensor.PrimaryDistanceKILOMETERSTotal Increasingmdi:map-marker-distance

Temperature Sensors

EntityDescriptionCategoryDevice ClassUnitState ClassIcon
Ambient TemperatureAmbient air temperature sensor.PrimaryTemperatureCELSIUSMeasurementmdi:thermometer
Coolant TemperatureEngine coolant temperature sensor.PrimaryTemperatureCELSIUSMeasurementmdi:thermometer
Intake TemperatureIntake air temperature sensor.PrimaryTemperatureCELSIUSMeasurementmdi:thermometer

Motion & Tracking Sensors

EntityDescriptionCategoryDevice ClassUnitState ClassIcon
Accelerometer XX-axis accelerometer sensor.Primary-gMeasurementmdi:axis-x-arrow
Accelerometer YY-axis accelerometer sensor.Primary-gMeasurementmdi:axis-y-arrow
Accelerometer ZZ-axis accelerometer sensor.Primary-gMeasurementmdi:axis-z-arrow
Tracker SpeedTracker-derived speed sensor.PrimarySpeedKILOMETERS_PER_HOURMeasurementmdi:speedometer

Diagnostic Sensors

EntityDescriptionCategoryDevice ClassUnitState ClassIcon
DTC CountDiagnostic trouble code count sensor.Diagnostic--Measurementmdi:alert-circle
GSM SignalGSM signal strength sensor.Diagnostic-PERCENTAGEMeasurementmdi:signal
Timezone OffsetTimezone offset sensor.Diagnostic---mdi:map-clock

Other Sensors

EntityDescriptionCategoryDevice ClassUnitState ClassIcon
AccelerometerBase accelerometer sensor with stationary suppression.Primary-gMeasurement-
HV Battery Energy Sensor BaseBase class for OEM high-voltage battery energy fields.Primary----

Data Field Sensor Reference

This table shows all data field sensors with their corresponding AutoPi field IDs:

EntityField IDDescriptionCategoryDevice ClassUnitState ClassIcon
Accelerometer-Base accelerometer sensor with stationary suppression.Primary-gMeasurement-
Accelerometer Xstd.accelerometer_axis_x.valueX-axis accelerometer sensor.Primary-gMeasurementmdi:axis-x-arrow
Accelerometer Ystd.accelerometer_axis_y.valueY-axis accelerometer sensor.Primary-gMeasurementmdi:axis-y-arrow
Accelerometer Zstd.accelerometer_axis_z.valueZ-axis accelerometer sensor.Primary-gMeasurementmdi:axis-z-arrow
Ambient Temperatureobd.ambient_air_temp.valueAmbient air temperature sensor.PrimaryTemperatureCELSIUSMeasurementmdi:thermometer
Battery Charge Levelobd.bat.levelBattery charge level sensor.PrimaryBatteryPERCENTAGEMeasurementmdi:battery
Battery Charging Stateobd.bat.stateBattery charging state sensor.Primary---mdi:battery-charging
Battery Currentstd.battery_current.valueBattery current sensor.PrimaryCurrentAMPEREMeasurementmdi:current-dc
Battery Voltageobd.bat.voltageBattery voltage sensor.PrimaryVoltageVOLTMeasurementmdi:lightning-bolt
Coolant Temperatureobd.coolant_temp.valueEngine coolant temperature sensor.PrimaryTemperatureCELSIUSMeasurementmdi:thermometer
DTC Countobd.number_of_dtc.valueDiagnostic trouble code count sensor.Diagnostic--Measurementmdi:alert-circle
Distance Since Codes Clearobd.distance_since_codes_clear.valueDistance since diagnostic codes cleared sensor.DiagnosticDistanceKILOMETERSTotal Increasingmdi:road-variant
EV Remaining Distanceobd.oem_remaining_distance.valueEV remaining driving range sensor.PrimaryDistanceKILOMETERSMeasurementmdi:map-marker-distance
Engineobd.rpm.valueEngine RPM sensor.Primary-rpmMeasurementmdi:engine
Engine Loadobd.engine_load.valueEngine load sensor.Primary-PERCENTAGEMeasurementmdi:gauge
Engine Run Timeobd.run_time.valueEngine run time sensor.PrimaryDurationSECONDSMeasurementmdi:timer
External Voltagestd.external_voltage.valueExternal/aux voltage sensor.DiagnosticVoltageVOLTMeasurementmdi:flash
Fuel Levelobd.fuel_level.valueFuel level sensor.Primary-PERCENTAGEMeasurementmdi:gas-station
Fuel Rate ECUobd.fuel_rate.valueInstantaneous fuel rate sensor from ECU.PrimaryVolume Flow RateLITERS_PER_HOURMeasurementmdi:fuel
Fuel Rate GPSstd.fuel_rate_gps.valueFuel rate GPS sensor.Primary-L/hMeasurementmdi:fuel
Fuel Used GPSstd.fuel_used_gps.valueFuel used GPS sensor.PrimaryVolumeLITERSTotal Increasingmdi:fuel
GPS Altitudetrack.pos.altGPS altitude sensor.PrimaryDistanceMETERSMeasurementmdi:elevation-rise
GPS Coursetrack.pos.cogGPS course/heading sensor.Primary-°Measurementmdi:compass
GPS Latitudetrack.pos.locGPS latitude sensor.Diagnostic--Measurementmdi:latitude
GPS Longitudetrack.pos.locGPS longitude sensor.Diagnostic--Measurementmdi:longitude
GPS Precisiontrack.pos.prGPS precision/position quality sensor.PrimaryDistanceMETERSMeasurementmdi:crosshairs-gps
GPS Satellitestrack.pos.nsatGPS satellites sensor.Primary--Measurementmdi:satellite-variant
GPS Speedtrack.pos.sogGPS speed sensor.PrimarySpeedMETERS_PER_SECONDMeasurementmdi:speedometer
GSM Signalstd.gsm_signal.valueGSM signal strength sensor.Diagnostic-PERCENTAGEMeasurementmdi:signal
HV Battery Charging Stateobd.oem_battery_charge_state.valueEV high-voltage battery charging state sensor.Primary---mdi:battery-charging
HV Battery Currentobd.oem_hv_battery_current.valueEV high-voltage battery current sensor.PrimaryCurrentAMPEREMeasurementmdi:current-dc
HV Battery Energyobd.oem_hv_battery_measured_energy.valueEV high-voltage battery available energy sensor.PrimaryEnergy StorageKILO_WATT_HOURMeasurementmdi:battery-charging-high
HV Battery Energy Sensor Base-Base class for OEM high-voltage battery energy fields.Primary----
HV Battery Lifetime Energy Chargedobd.oem_hv_battery_lifetime_charge_power.valueEV high-voltage battery lifetime energy charged sensor.Diagnostic---mdi:battery-arrow-up
HV Battery Lifetime Energy Usedobd.oem_hv_battery_lifetime_power_use.valueEV high-voltage battery lifetime energy discharged sensor.Diagnostic---mdi:battery-arrow-down
HV Battery Max Cell Temperatureobd.oem_hv_battery_max_cell_temperature.valueEV high-voltage battery maximum cell temperature sensor.DiagnosticTemperatureCELSIUSMeasurementmdi:thermometer-high
HV Battery Max Cell Voltageobd.oem_hv_battery_max_cell_voltage.valueEV high-voltage battery maximum cell voltage sensor.DiagnosticVoltageVOLTMeasurementmdi:flash-outline
HV Battery Max Energyobd.oem_hv_battery_max_energy.valueEV high-voltage battery maximum energy sensor.DiagnosticEnergy StorageKILO_WATT_HOURMeasurementmdi:battery-high
HV Battery Min Cell Temperatureobd.oem_hv_battery_min_cell_temperature.valueEV high-voltage battery minimum cell temperature sensor.DiagnosticTemperatureCELSIUSMeasurementmdi:thermometer-low
HV Battery Min Cell Voltageobd.oem_hv_battery_min_cell_voltage.valueEV high-voltage battery minimum cell voltage sensor.DiagnosticVoltageVOLTMeasurementmdi:flash-outline
HV Battery Socobd.oem_battery_charge_level.valueEV high-voltage battery state of charge sensor.PrimaryBatteryPERCENTAGEMeasurementmdi:battery
HV Battery State Of Healthobd.oem_battery_state_of_health.valueEV high-voltage battery state of health sensor.Diagnostic-PERCENTAGEMeasurementmdi:battery-heart-variant
HV Battery Temperatureobd.oem_battery_temperature.valueEV high-voltage battery pack temperature sensor.PrimaryTemperatureCELSIUSMeasurementmdi:thermometer
HV Battery Voltageobd.oem_hv_battery_voltage.valueEV high-voltage battery pack voltage sensor.PrimaryVoltageVOLTMeasurementmdi:flash
Ignition Statestd.ignition.valueIgnition state sensor.Primary---mdi:key
Intake Temperatureobd.intake_temp.valueIntake air temperature sensor.PrimaryTemperatureCELSIUSMeasurementmdi:thermometer
OBD Speedobd.speed.valueOBD speed sensor.PrimarySpeedKILOMETERS_PER_HOURMeasurementmdi:speedometer
OEM Fuel Levelobd.obd_oem_fuel_level.valueOEM fuel level sensor.PrimaryVolume StorageLITERSMeasurementmdi:fuel
OEM Total Mileageobd.obd_oem_total_mileage.valueOEM total mileage sensor.PrimaryDistanceKILOMETERSTotal Increasingmdi:counter
Throttle Positionobd.throttle_pos.valueThrottle position sensor.Primary-PERCENTAGEMeasurementmdi:gas-pedal
Timezone Offsetstd.tz_offset.valueTimezone offset sensor.Diagnostic---mdi:map-clock
Total Odometerstd.total_odometer.valueTotal odometer sensor.PrimaryDistanceKILOMETERSTotal Increasingmdi:counter
Tracker Battery Levelstd.battery_level.valueTracker battery level sensor.DiagnosticBatteryPERCENTAGEMeasurementmdi:battery
Tracker Speedstd.speed.valueTracker-derived speed sensor.PrimarySpeedKILOMETERS_PER_HOURMeasurementmdi:speedometer
Trip Odometerstd.trip_odometer.valueTrip odometer sensor.PrimaryDistanceKILOMETERSTotal Increasingmdi:map-marker-distance
Vehicle Battery Voltagestd.battery_voltage.valueVehicle system battery voltage sensor.PrimaryVoltageVOLTMeasurementmdi:car-battery

Device Trackers

Device trackers provide GPS-based location tracking for your vehicles:

EntityDescriptionCategoryDevice ClassUnitState ClassIcon
Device TrackerRepresentation of an AutoPi vehicle tracker.Primary---mdi:car

Binary Sensors

Binary sensors provide on/off state information:

EntityField IDDescriptionCategoryDevice ClassUnitState ClassIcon
Battery Charging Stateobd.bat.stateBattery charging binary sensor.PrimaryBattery Charging--mdi:battery-charging
Charging In Progress-Charging in progress binary sensor.PrimaryBattery Charging--mdi:battery-charging
Ignition Runningstd.ignition.valueIgnition/engine running binary sensor.PrimaryRunning--mdi:key
Movement-Vehicle movement binary sensor.PrimaryMoving--mdi:car-traction-control
Tracker Online-Tracker online/offline binary sensor.PrimaryConnectivity--mdi:access-point

Events

Event entities emit Home Assistant events for vehicle activity:

EntityDescriptionCategoryEvent Types
DTC EventEvent entity for DTC events.Diagnosticdtc
RFID EventEvent entity for RFID events.Diagnosticrfid_event
Simplified EventEvent entity for simplified AutoPi events.Diagnosticsimplified_event
Vehicle EventEvent entity for AutoPi vehicle events.Diagnosticcharging, charging_slow, discharging, critical_level, start, stop, engine_start, engine_stop, trip_start, trip_end, standstill, moving, alert, warning, error, unknown, unkown

Base Classes

The AutoPi integration uses the following base classes for entity implementation:

AutoPiEntity

Base entity for AutoPi integration.

Inherits from: CoordinatorEntity, Entity

Key Attributes: - _attr_has_entity_name: True

AutoPiVehicleEntity

Base entity for a specific AutoPi vehicle.

Inherits from: AutoPiEntity

Properties: - vehicle: Get the vehicle data. - device_info: Return device information. - available: Return if entity is available. - extra_state_attributes: Return extra state attributes.

AutoPiDataFieldSensorBase

Base class for AutoPi data field sensors.

Inherits from: AutoPiVehicleEntity, SensorEntity

Properties: - native_value: Return the sensor value. - available: Return if entity is available. - extra_state_attributes: Return extra state attributes.

AutoPiDataFieldSensor

Data field sensor without auto-zero support.

Inherits from: AutoPiDataFieldSensorBase

AutoPiAutoZeroDataFieldSensor

Data field sensor with auto-zero support and state restoration.

Inherits from: AutoPiDataFieldSensorBase, RestoreEntity

Properties: - native_value: Return the sensor value.

AutoPiDataFieldBinarySensor

Base class for data field derived binary sensors.

Inherits from: AutoPiVehicleEntity, BinarySensorEntity

Properties: - available: Return if entity is available. - extra_state_attributes: Return extra state attributes.

Entity Attributes

This section details the attributes available on each entity type.

Vehicle Entity Attributes

Vehicle-based entities include these attributes:

AttributeTypeDescription
vehicle_idstrUnique AutoPi vehicle ID
license_platestrVehicle registration number
vinstrVehicle Identification Number
yearintManufacturing year
typestrVehicle type (ICE, EV, etc.)
battery_voltagefloatNominal battery voltage
make_idstrAutoPi make identifier
model_idstrAutoPi model identifier
deviceslist[str]List of associated AutoPi device IDs

Data Field Sensors

Data field sensors provide real-time vehicle telemetry with these additional attributes:

AttributeTypeDescription
frequencyfloatUpdate frequency in Hz
last_seendatetimeLast time data was received
field_idstrAutoPi field identifier
data_typestrData value type
descriptionstrField description (if available)
data_age_secondsintTime since last update
auto_zero_enabledboolWhether auto-zero is available for this metric

Auto-Zero Enabled Sensors

Sensors with auto-zero support include these additional attributes:

AttributeTypeDescription
auto_zero_activeboolWhether the value is currently zeroed
auto_zero_last_zeroeddatetimeWhen the metric was last zeroed
auto_zero_cooldown_untildatetimeWhen auto-zero can trigger again

Note: Some entities add extra attributes specific to their data (alerts, charging, events, etc.). Check the entity state in Home Assistant for the full list of available attributes.

Entity Properties

Many entities expose additional properties that can be accessed programmatically:

Sensor Properties

  • native_value: The raw sensor value before any unit conversion
  • native_unit_of_measurement: The sensor's native unit
  • device_class: Home Assistant device class for UI representation
  • state_class: Statistical state class (measurement, total, etc.)
  • available: Whether the entity has recent valid data

Device Tracker Properties

  • latitude: Current GPS latitude
  • longitude: Current GPS longitude
  • location_accuracy: Position accuracy in meters

Entity Naming

All entities follow Home Assistant's entity naming conventions:

  • Integration entities: Named with "AutoPi" prefix (e.g., "AutoPi Vehicle Count")
  • Vehicle entities: Named with the vehicle name as prefix (e.g., "My Car Speed")
  • Unique IDs: Generated using entry ID and entity-specific suffixes

Entity Categories

Entities are categorized as follows:

  • Primary: Main functional entities shown in default views
  • Diagnostic: Technical entities for monitoring integration health

Device Classes

Where applicable, entities use standard Home Assistant device classes for consistent representation and unit conversion:

  • Battery: Battery level or charging state
  • Current: Electrical current
  • Distance: Distance and altitude measurements
  • Duration: Time durations
  • Speed: Vehicle speed
  • Temperature: Temperature readings
  • Timestamp: Time-based sensors
  • Connectivity: Tracker connectivity (binary)
  • Moving: Vehicle movement (binary)

State Classes

Entities use appropriate state classes for statistics and energy tracking:

  • Measurement: Current state values
  • Total Increasing: Cumulative counters
  • Total: Reset-able totals