Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional entities #203

Merged
merged 2 commits into from
Oct 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion custom_components/volkswagen_we_connect_id/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "Volkswagen We Connect ID",
"config_flow": true,
"documentation": "https://www.home-assistant.io/integrations/volkswagen_we_connect_id",
"requirements": ["weconnect==0.55.1", "ascii_magic>=2.0.0"],
"requirements": ["weconnect==0.58.0", "ascii_magic>=2.0.0"],
"ssdp": [],
"zeroconf": [],
"homekit": {},
Expand Down
107 changes: 107 additions & 0 deletions custom_components/volkswagen_we_connect_id/sensor.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
TIME_MINUTES,
UnitOfPower,
UnitOfTemperature,
UnitOfEnergy,
)


Expand All @@ -39,6 +40,14 @@ class VolkswagenIdEntityDescription(SensorEntityDescription):


SENSORS: tuple[VolkswagenIdEntityDescription, ...] = (
VolkswagenIdEntityDescription(
key="carType",
name="Car Type",
icon="mdi:car",
value=lambda data: data["fuelStatus"][
"rangeStatus"
].carType.value,
),
VolkswagenIdEntityDescription(
key="climatisationState",
name="Climatisation State",
Expand Down Expand Up @@ -159,6 +168,15 @@ class VolkswagenIdEntityDescription(SensorEntityDescription):
"maintenanceStatus"
].inspectionDue_days.value,
),
VolkswagenIdEntityDescription(
name="Health Inspection km",
key="inspectionDuekm",
icon="mdi:wrench-clock-outline",
native_unit_of_measurement=LENGTH_KILOMETERS,
value=lambda data: data["vehicleHealthInspection"][
"maintenanceStatus"
].inspectionDue_km.value,
),
VolkswagenIdEntityDescription(
name="Odometer",
key="odometer",
Expand Down Expand Up @@ -346,8 +364,59 @@ class VolkswagenIdEntityDescription(SensorEntityDescription):
icon="mdi:ev-plug-type2",
value=lambda data: data["charging"]["plugStatus"].plugLockState,
),
VolkswagenIdEntityDescription(
name="Fuel Level",
key="fuelLevel",
icon="mdi:fuel",
native_unit_of_measurement=PERCENTAGE,
value=lambda data: data["fuelStatus"]["rangeStatus"].primaryEngine.currentFuelLevel_pct.value,
),
VolkswagenIdEntityDescription(
name="Gasoline Range",
key="GasolineRange",
icon="mdi:car-arrow-right",
native_unit_of_measurement=LENGTH_KILOMETERS,
value=lambda data: data["measurements"][
"rangeStatus"
].gasolineRange.value,
),
VolkswagenIdEntityDescription(
name="Oil Inspection days",
key="oilInspectionDue",
icon="mdi:wrench-clock-outline",
native_unit_of_measurement=TIME_DAYS,
value=lambda data: data["vehicleHealthInspection"][
"maintenanceStatus"
].oilServiceDue_days.value,
),
VolkswagenIdEntityDescription(
name="Oil Inspection km",
key="oilInspectionDuekm",
icon="mdi:wrench-clock-outline",
native_unit_of_measurement=LENGTH_KILOMETERS,
value=lambda data: data["vehicleHealthInspection"][
"maintenanceStatus"
].oilServiceDue_km.value,
),

)

VEHICLE_SENSORS: tuple[VolkswagenIdEntityDescription, ...] = (
VolkswagenIdEntityDescription(
key="lastTripAverageElectricConsumption",
name="Last Trip Average Electric consumption",
native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
device_class=SensorDeviceClass.ENERGY,
value=lambda vehicle: vehicle.trips["shortTerm"].averageElectricConsumption.value,
),
VolkswagenIdEntityDescription(
key="lastTripAverageFuelConsumption",
name="Last Trip Average Fuel consumption",
native_unit_of_measurement="l/100km",
value=lambda vehicle: vehicle.trips["shortTerm"].averageFuelConsumption.value,
),

)

async def async_setup_entry(hass, config_entry, async_add_entities):
"""Add sensors for passed config_entry in HA."""
Expand All @@ -363,6 +432,9 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
for index, vehicle in enumerate(coordinator.data):
for sensor in SENSORS:
entities.append(VolkswagenIDSensor(sensor, we_connect, coordinator, index))
for sensor in VEHICLE_SENSORS:
entities.append(VolkswagenIDVehicleSensor(sensor, we_connect, coordinator, index))

if entities:
async_add_entities(entities)

Expand Down Expand Up @@ -400,3 +472,38 @@ def native_value(self) -> StateType:
return None

return cast(StateType, state)

class VolkswagenIDVehicleSensor(VolkswagenIDBaseEntity, SensorEntity):
"""Representation of a VolkswagenID vehicle sensor."""

entity_description: VolkswagenIdEntityDescription

def __init__(
self,
sensor: VolkswagenIdEntityDescription,
we_connect: weconnect.WeConnect,
coordinator: DataUpdateCoordinator,
index: int,
) -> None:
"""Initialize VolkswagenID vehicle sensor."""
super().__init__(we_connect, coordinator, index)

self.entity_description = sensor
self._coordinator = coordinator
self._attr_name = f"{self.data.nickname} {sensor.name}"
self._attr_unique_id = f"{self.data.vin}-{sensor.key}"
if sensor.native_unit_of_measurement:
self._attr_native_unit_of_measurement = sensor.native_unit_of_measurement
self._attr_state_class = SensorStateClass.MEASUREMENT

@property
def native_value(self) -> StateType:
"""Return the state."""

try:
state = get_object_value(self.entity_description.value(self.data))
except (KeyError, ValueError):
return None

return cast(StateType, state)