mirror of
https://github.com/home-assistant/core.git
synced 2025-07-24 21:57:51 +00:00
Add binary sensors to Mazda integration (#64604)
This commit is contained in:
parent
c4b3e2b9cd
commit
5d2a65bb21
@ -37,7 +37,13 @@ from .const import DATA_CLIENT, DATA_COORDINATOR, DATA_VEHICLES, DOMAIN, SERVICE
|
|||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
PLATFORMS = [Platform.BUTTON, Platform.DEVICE_TRACKER, Platform.LOCK, Platform.SENSOR]
|
PLATFORMS = [
|
||||||
|
Platform.BINARY_SENSOR,
|
||||||
|
Platform.BUTTON,
|
||||||
|
Platform.DEVICE_TRACKER,
|
||||||
|
Platform.LOCK,
|
||||||
|
Platform.SENSOR,
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
async def with_timeout(task, timeout_seconds=10):
|
async def with_timeout(task, timeout_seconds=10):
|
||||||
|
135
homeassistant/components/mazda/binary_sensor.py
Normal file
135
homeassistant/components/mazda/binary_sensor.py
Normal file
@ -0,0 +1,135 @@
|
|||||||
|
"""Platform for Mazda binary sensor integration."""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from collections.abc import Callable
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from homeassistant.components.binary_sensor import (
|
||||||
|
BinarySensorDeviceClass,
|
||||||
|
BinarySensorEntity,
|
||||||
|
BinarySensorEntityDescription,
|
||||||
|
)
|
||||||
|
from homeassistant.config_entries import ConfigEntry
|
||||||
|
from homeassistant.core import HomeAssistant
|
||||||
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||||
|
|
||||||
|
from . import MazdaEntity
|
||||||
|
from .const import DATA_CLIENT, DATA_COORDINATOR, DOMAIN
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class MazdaBinarySensorRequiredKeysMixin:
|
||||||
|
"""Mixin for required keys."""
|
||||||
|
|
||||||
|
# Suffix to be appended to the vehicle name to obtain the binary sensor name
|
||||||
|
name_suffix: str
|
||||||
|
|
||||||
|
# Function to determine the value for this binary sensor, given the coordinator data
|
||||||
|
value_fn: Callable[[dict[str, Any]], bool]
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class MazdaBinarySensorEntityDescription(
|
||||||
|
BinarySensorEntityDescription, MazdaBinarySensorRequiredKeysMixin
|
||||||
|
):
|
||||||
|
"""Describes a Mazda binary sensor entity."""
|
||||||
|
|
||||||
|
# Function to determine whether the vehicle supports this binary sensor, given the coordinator data
|
||||||
|
is_supported: Callable[[dict[str, Any]], bool] = lambda data: True
|
||||||
|
|
||||||
|
|
||||||
|
def _plugged_in_supported(data):
|
||||||
|
"""Determine if 'plugged in' binary sensor is supported."""
|
||||||
|
return (
|
||||||
|
data["isElectric"] and data["evStatus"]["chargeInfo"]["pluggedIn"] is not None
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
BINARY_SENSOR_ENTITIES = [
|
||||||
|
MazdaBinarySensorEntityDescription(
|
||||||
|
key="driver_door",
|
||||||
|
name_suffix="Driver Door",
|
||||||
|
icon="mdi:car-door",
|
||||||
|
device_class=BinarySensorDeviceClass.DOOR,
|
||||||
|
value_fn=lambda data: data["status"]["doors"]["driverDoorOpen"],
|
||||||
|
),
|
||||||
|
MazdaBinarySensorEntityDescription(
|
||||||
|
key="passenger_door",
|
||||||
|
name_suffix="Passenger Door",
|
||||||
|
icon="mdi:car-door",
|
||||||
|
device_class=BinarySensorDeviceClass.DOOR,
|
||||||
|
value_fn=lambda data: data["status"]["doors"]["passengerDoorOpen"],
|
||||||
|
),
|
||||||
|
MazdaBinarySensorEntityDescription(
|
||||||
|
key="rear_left_door",
|
||||||
|
name_suffix="Rear Left Door",
|
||||||
|
icon="mdi:car-door",
|
||||||
|
device_class=BinarySensorDeviceClass.DOOR,
|
||||||
|
value_fn=lambda data: data["status"]["doors"]["rearLeftDoorOpen"],
|
||||||
|
),
|
||||||
|
MazdaBinarySensorEntityDescription(
|
||||||
|
key="rear_right_door",
|
||||||
|
name_suffix="Rear Right Door",
|
||||||
|
icon="mdi:car-door",
|
||||||
|
device_class=BinarySensorDeviceClass.DOOR,
|
||||||
|
value_fn=lambda data: data["status"]["doors"]["rearRightDoorOpen"],
|
||||||
|
),
|
||||||
|
MazdaBinarySensorEntityDescription(
|
||||||
|
key="trunk",
|
||||||
|
name_suffix="Trunk",
|
||||||
|
icon="mdi:car-back",
|
||||||
|
device_class=BinarySensorDeviceClass.DOOR,
|
||||||
|
value_fn=lambda data: data["status"]["doors"]["trunkOpen"],
|
||||||
|
),
|
||||||
|
MazdaBinarySensorEntityDescription(
|
||||||
|
key="hood",
|
||||||
|
name_suffix="Hood",
|
||||||
|
icon="mdi:car",
|
||||||
|
device_class=BinarySensorDeviceClass.DOOR,
|
||||||
|
value_fn=lambda data: data["status"]["doors"]["hoodOpen"],
|
||||||
|
),
|
||||||
|
MazdaBinarySensorEntityDescription(
|
||||||
|
key="ev_plugged_in",
|
||||||
|
name_suffix="Plugged In",
|
||||||
|
device_class=BinarySensorDeviceClass.PLUG,
|
||||||
|
is_supported=_plugged_in_supported,
|
||||||
|
value_fn=lambda data: data["evStatus"]["chargeInfo"]["pluggedIn"],
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
async def async_setup_entry(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
config_entry: ConfigEntry,
|
||||||
|
async_add_entities: AddEntitiesCallback,
|
||||||
|
) -> None:
|
||||||
|
"""Set up the sensor platform."""
|
||||||
|
client = hass.data[DOMAIN][config_entry.entry_id][DATA_CLIENT]
|
||||||
|
coordinator = hass.data[DOMAIN][config_entry.entry_id][DATA_COORDINATOR]
|
||||||
|
|
||||||
|
async_add_entities(
|
||||||
|
MazdaBinarySensorEntity(client, coordinator, index, description)
|
||||||
|
for index, data in enumerate(coordinator.data)
|
||||||
|
for description in BINARY_SENSOR_ENTITIES
|
||||||
|
if description.is_supported(data)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class MazdaBinarySensorEntity(MazdaEntity, BinarySensorEntity):
|
||||||
|
"""Representation of a Mazda vehicle binary sensor."""
|
||||||
|
|
||||||
|
entity_description: MazdaBinarySensorEntityDescription
|
||||||
|
|
||||||
|
def __init__(self, client, coordinator, index, description):
|
||||||
|
"""Initialize Mazda binary sensor."""
|
||||||
|
super().__init__(client, coordinator, index)
|
||||||
|
self.entity_description = description
|
||||||
|
|
||||||
|
self._attr_name = f"{self.vehicle_name} {description.name_suffix}"
|
||||||
|
self._attr_unique_id = f"{self.vin}_{description.key}"
|
||||||
|
|
||||||
|
@property
|
||||||
|
def is_on(self):
|
||||||
|
"""Return the state of the binary sensor."""
|
||||||
|
return self.entity_description.value_fn(self.data)
|
@ -3,6 +3,7 @@ from __future__ import annotations
|
|||||||
|
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
from homeassistant.components.sensor import (
|
from homeassistant.components.sensor import (
|
||||||
SensorDeviceClass,
|
SensorDeviceClass,
|
||||||
@ -35,7 +36,7 @@ class MazdaSensorRequiredKeysMixin:
|
|||||||
name_suffix: str
|
name_suffix: str
|
||||||
|
|
||||||
# Function to determine the value for this sensor, given the coordinator data and the configured unit system
|
# Function to determine the value for this sensor, given the coordinator data and the configured unit system
|
||||||
value: Callable[[dict, UnitSystem], StateType]
|
value: Callable[[dict[str, Any], UnitSystem], StateType]
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
@ -45,7 +46,7 @@ class MazdaSensorEntityDescription(
|
|||||||
"""Describes a Mazda sensor entity."""
|
"""Describes a Mazda sensor entity."""
|
||||||
|
|
||||||
# Function to determine whether the vehicle supports this sensor, given the coordinator data
|
# Function to determine whether the vehicle supports this sensor, given the coordinator data
|
||||||
is_supported: Callable[[dict], bool] = lambda data: True
|
is_supported: Callable[[dict[str, Any]], bool] = lambda data: True
|
||||||
|
|
||||||
# Function to determine the unit of measurement for this sensor, given the configured unit system
|
# Function to determine the unit of measurement for this sensor, given the configured unit system
|
||||||
# Falls back to description.native_unit_of_measurement if it is not provided
|
# Falls back to description.native_unit_of_measurement if it is not provided
|
||||||
|
@ -30,11 +30,11 @@
|
|||||||
"odometerKm": 2795.8,
|
"odometerKm": 2795.8,
|
||||||
"doors": {
|
"doors": {
|
||||||
"driverDoorOpen": false,
|
"driverDoorOpen": false,
|
||||||
"passengerDoorOpen": false,
|
"passengerDoorOpen": true,
|
||||||
"rearLeftDoorOpen": false,
|
"rearLeftDoorOpen": false,
|
||||||
"rearRightDoorOpen": false,
|
"rearRightDoorOpen": false,
|
||||||
"trunkOpen": false,
|
"trunkOpen": false,
|
||||||
"hoodOpen": false,
|
"hoodOpen": true,
|
||||||
"fuelLidOpen": false
|
"fuelLidOpen": false
|
||||||
},
|
},
|
||||||
"doorLocks": {
|
"doorLocks": {
|
||||||
|
@ -29,11 +29,11 @@
|
|||||||
"odometerKm": 2795.8,
|
"odometerKm": 2795.8,
|
||||||
"doors": {
|
"doors": {
|
||||||
"driverDoorOpen": false,
|
"driverDoorOpen": false,
|
||||||
"passengerDoorOpen": false,
|
"passengerDoorOpen": true,
|
||||||
"rearLeftDoorOpen": false,
|
"rearLeftDoorOpen": false,
|
||||||
"rearRightDoorOpen": false,
|
"rearRightDoorOpen": false,
|
||||||
"trunkOpen": false,
|
"trunkOpen": false,
|
||||||
"hoodOpen": false,
|
"hoodOpen": true,
|
||||||
"fuelLidOpen": false
|
"fuelLidOpen": false
|
||||||
},
|
},
|
||||||
"doorLocks": {
|
"doorLocks": {
|
||||||
|
@ -8,11 +8,11 @@
|
|||||||
"odometerKm": 2795.8,
|
"odometerKm": 2795.8,
|
||||||
"doors": {
|
"doors": {
|
||||||
"driverDoorOpen": false,
|
"driverDoorOpen": false,
|
||||||
"passengerDoorOpen": false,
|
"passengerDoorOpen": true,
|
||||||
"rearLeftDoorOpen": false,
|
"rearLeftDoorOpen": false,
|
||||||
"rearRightDoorOpen": false,
|
"rearRightDoorOpen": false,
|
||||||
"trunkOpen": false,
|
"trunkOpen": false,
|
||||||
"hoodOpen": false,
|
"hoodOpen": true,
|
||||||
"fuelLidOpen": false
|
"fuelLidOpen": false
|
||||||
},
|
},
|
||||||
"doorLocks": {
|
"doorLocks": {
|
||||||
|
98
tests/components/mazda/test_binary_sensor.py
Normal file
98
tests/components/mazda/test_binary_sensor.py
Normal file
@ -0,0 +1,98 @@
|
|||||||
|
"""The binary sensor tests for the Mazda Connected Services integration."""
|
||||||
|
|
||||||
|
from homeassistant.components.binary_sensor import BinarySensorDeviceClass
|
||||||
|
from homeassistant.const import ATTR_DEVICE_CLASS, ATTR_FRIENDLY_NAME, ATTR_ICON
|
||||||
|
from homeassistant.helpers import entity_registry as er
|
||||||
|
|
||||||
|
from . import init_integration
|
||||||
|
|
||||||
|
|
||||||
|
async def test_binary_sensors(hass):
|
||||||
|
"""Test creation of the binary sensors."""
|
||||||
|
await init_integration(hass)
|
||||||
|
|
||||||
|
entity_registry = er.async_get(hass)
|
||||||
|
|
||||||
|
# Driver Door
|
||||||
|
state = hass.states.get("binary_sensor.my_mazda3_driver_door")
|
||||||
|
assert state
|
||||||
|
assert state.attributes.get(ATTR_FRIENDLY_NAME) == "My Mazda3 Driver Door"
|
||||||
|
assert state.attributes.get(ATTR_ICON) == "mdi:car-door"
|
||||||
|
assert state.attributes.get(ATTR_DEVICE_CLASS) == BinarySensorDeviceClass.DOOR
|
||||||
|
assert state.state == "off"
|
||||||
|
entry = entity_registry.async_get("binary_sensor.my_mazda3_driver_door")
|
||||||
|
assert entry
|
||||||
|
assert entry.unique_id == "JM000000000000000_driver_door"
|
||||||
|
|
||||||
|
# Passenger Door
|
||||||
|
state = hass.states.get("binary_sensor.my_mazda3_passenger_door")
|
||||||
|
assert state
|
||||||
|
assert state.attributes.get(ATTR_FRIENDLY_NAME) == "My Mazda3 Passenger Door"
|
||||||
|
assert state.attributes.get(ATTR_ICON) == "mdi:car-door"
|
||||||
|
assert state.attributes.get(ATTR_DEVICE_CLASS) == BinarySensorDeviceClass.DOOR
|
||||||
|
assert state.state == "on"
|
||||||
|
entry = entity_registry.async_get("binary_sensor.my_mazda3_passenger_door")
|
||||||
|
assert entry
|
||||||
|
assert entry.unique_id == "JM000000000000000_passenger_door"
|
||||||
|
|
||||||
|
# Rear Left Door
|
||||||
|
state = hass.states.get("binary_sensor.my_mazda3_rear_left_door")
|
||||||
|
assert state
|
||||||
|
assert state.attributes.get(ATTR_FRIENDLY_NAME) == "My Mazda3 Rear Left Door"
|
||||||
|
assert state.attributes.get(ATTR_ICON) == "mdi:car-door"
|
||||||
|
assert state.attributes.get(ATTR_DEVICE_CLASS) == BinarySensorDeviceClass.DOOR
|
||||||
|
assert state.state == "off"
|
||||||
|
entry = entity_registry.async_get("binary_sensor.my_mazda3_rear_left_door")
|
||||||
|
assert entry
|
||||||
|
assert entry.unique_id == "JM000000000000000_rear_left_door"
|
||||||
|
|
||||||
|
# Rear Right Door
|
||||||
|
state = hass.states.get("binary_sensor.my_mazda3_rear_right_door")
|
||||||
|
assert state
|
||||||
|
assert state.attributes.get(ATTR_FRIENDLY_NAME) == "My Mazda3 Rear Right Door"
|
||||||
|
assert state.attributes.get(ATTR_ICON) == "mdi:car-door"
|
||||||
|
assert state.attributes.get(ATTR_DEVICE_CLASS) == BinarySensorDeviceClass.DOOR
|
||||||
|
assert state.state == "off"
|
||||||
|
entry = entity_registry.async_get("binary_sensor.my_mazda3_rear_right_door")
|
||||||
|
assert entry
|
||||||
|
assert entry.unique_id == "JM000000000000000_rear_right_door"
|
||||||
|
|
||||||
|
# Trunk
|
||||||
|
state = hass.states.get("binary_sensor.my_mazda3_trunk")
|
||||||
|
assert state
|
||||||
|
assert state.attributes.get(ATTR_FRIENDLY_NAME) == "My Mazda3 Trunk"
|
||||||
|
assert state.attributes.get(ATTR_ICON) == "mdi:car-back"
|
||||||
|
assert state.attributes.get(ATTR_DEVICE_CLASS) == BinarySensorDeviceClass.DOOR
|
||||||
|
assert state.state == "off"
|
||||||
|
entry = entity_registry.async_get("binary_sensor.my_mazda3_trunk")
|
||||||
|
assert entry
|
||||||
|
assert entry.unique_id == "JM000000000000000_trunk"
|
||||||
|
|
||||||
|
# Hood
|
||||||
|
state = hass.states.get("binary_sensor.my_mazda3_hood")
|
||||||
|
assert state
|
||||||
|
assert state.attributes.get(ATTR_FRIENDLY_NAME) == "My Mazda3 Hood"
|
||||||
|
assert state.attributes.get(ATTR_ICON) == "mdi:car"
|
||||||
|
assert state.attributes.get(ATTR_DEVICE_CLASS) == BinarySensorDeviceClass.DOOR
|
||||||
|
assert state.state == "on"
|
||||||
|
entry = entity_registry.async_get("binary_sensor.my_mazda3_hood")
|
||||||
|
assert entry
|
||||||
|
assert entry.unique_id == "JM000000000000000_hood"
|
||||||
|
|
||||||
|
|
||||||
|
async def test_electric_vehicle_binary_sensors(hass):
|
||||||
|
"""Test sensors which are specific to electric vehicles."""
|
||||||
|
|
||||||
|
await init_integration(hass, electric_vehicle=True)
|
||||||
|
|
||||||
|
entity_registry = er.async_get(hass)
|
||||||
|
|
||||||
|
# Plugged In
|
||||||
|
state = hass.states.get("binary_sensor.my_mazda3_plugged_in")
|
||||||
|
assert state
|
||||||
|
assert state.attributes.get(ATTR_FRIENDLY_NAME) == "My Mazda3 Plugged In"
|
||||||
|
assert state.attributes.get(ATTR_DEVICE_CLASS) == BinarySensorDeviceClass.PLUG
|
||||||
|
assert state.state == "on"
|
||||||
|
entry = entity_registry.async_get("binary_sensor.my_mazda3_plugged_in")
|
||||||
|
assert entry
|
||||||
|
assert entry.unique_id == "JM000000000000000_ev_plugged_in"
|
@ -8,7 +8,7 @@ from homeassistant.const import ATTR_ENTITY_ID, ATTR_FRIENDLY_NAME, ATTR_ICON
|
|||||||
from homeassistant.exceptions import HomeAssistantError
|
from homeassistant.exceptions import HomeAssistantError
|
||||||
from homeassistant.helpers import entity_registry as er
|
from homeassistant.helpers import entity_registry as er
|
||||||
|
|
||||||
from tests.components.mazda import init_integration
|
from . import init_integration
|
||||||
|
|
||||||
|
|
||||||
async def test_button_setup_non_electric_vehicle(hass) -> None:
|
async def test_button_setup_non_electric_vehicle(hass) -> None:
|
||||||
|
@ -9,7 +9,7 @@ from homeassistant.const import (
|
|||||||
)
|
)
|
||||||
from homeassistant.helpers import entity_registry as er
|
from homeassistant.helpers import entity_registry as er
|
||||||
|
|
||||||
from tests.components.mazda import init_integration
|
from . import init_integration
|
||||||
|
|
||||||
|
|
||||||
async def test_device_tracker(hass):
|
async def test_device_tracker(hass):
|
||||||
|
@ -20,8 +20,9 @@ from homeassistant.exceptions import HomeAssistantError
|
|||||||
from homeassistant.helpers import device_registry as dr
|
from homeassistant.helpers import device_registry as dr
|
||||||
from homeassistant.util import dt as dt_util
|
from homeassistant.util import dt as dt_util
|
||||||
|
|
||||||
|
from . import init_integration
|
||||||
|
|
||||||
from tests.common import MockConfigEntry, async_fire_time_changed, load_fixture
|
from tests.common import MockConfigEntry, async_fire_time_changed, load_fixture
|
||||||
from tests.components.mazda import init_integration
|
|
||||||
|
|
||||||
FIXTURE_USER_INPUT = {
|
FIXTURE_USER_INPUT = {
|
||||||
CONF_EMAIL: "example@example.com",
|
CONF_EMAIL: "example@example.com",
|
||||||
|
@ -9,7 +9,7 @@ from homeassistant.components.lock import (
|
|||||||
from homeassistant.const import ATTR_ENTITY_ID, ATTR_FRIENDLY_NAME
|
from homeassistant.const import ATTR_ENTITY_ID, ATTR_FRIENDLY_NAME
|
||||||
from homeassistant.helpers import entity_registry as er
|
from homeassistant.helpers import entity_registry as er
|
||||||
|
|
||||||
from tests.components.mazda import init_integration
|
from . import init_integration
|
||||||
|
|
||||||
|
|
||||||
async def test_lock_setup(hass):
|
async def test_lock_setup(hass):
|
||||||
|
@ -18,7 +18,7 @@ from homeassistant.const import (
|
|||||||
from homeassistant.helpers import entity_registry as er
|
from homeassistant.helpers import entity_registry as er
|
||||||
from homeassistant.util.unit_system import IMPERIAL_SYSTEM
|
from homeassistant.util.unit_system import IMPERIAL_SYSTEM
|
||||||
|
|
||||||
from tests.components.mazda import init_integration
|
from . import init_integration
|
||||||
|
|
||||||
|
|
||||||
async def test_sensors(hass):
|
async def test_sensors(hass):
|
||||||
|
Loading…
x
Reference in New Issue
Block a user