Add binary sensors

[gerard33]

• Doors
• Windows
• Door lock state
• Parking lights
• Condition based services
• Control messages
• Charging
• Connector status

You can assign this to me. I can rewrite my existing binary sensor component to work with your bimmer connected module. Can you confirm that I should add these as
@property @backend_parameter in the bimmer connected module?

SENSOR_TYPES = {
    'doors_closed': ['Doors', 'opening'],
    'windows_closed': ['Windows', 'opening'],
    'door_lock_state': ['Door lock state', 'safety'],
    'lights_parking': ['Parking lights', 'light'],
    'condition_based_services': ['Condition based services', 'problem'],
    'check_control_messages': ['Control messages', 'problem']
}

SENSOR_TYPES_ELEC = {
    'charging_status': ['Charging', 'power'],       # CHARGINGACTIVE, CHARGINGENDED # attributes: lastChargingEndReason, lastChargingEndResult
    'connectorStatus': ['Connector status', 'plug']
}

CODE_TO_SERVICE_NAME = {
    '00001': 'motor_oil',
    '00003': 'brake_fluid',
    '00017': 'vehicle_inspection',  # from BMW i3
    '00100': 'car_check',
    '00032': 'vehicle_inspection'   # from BMW X1
}

[ChristianKuehnel]

Hi @gerard33,

yes that makes sense.

FYI: The decorator @backend_parameter is just a convenient way to handling the errors around parsing the parameters.

[gerard33]

@ChristianKuehnel, I have started with the doors, windows and lock state but need some help so I can understand your module correctly. The code of the binary sensor script is added below.

1. How can I show the device_state_attributes correct like in the attached picture from my old setup?
   I have used for lid in vehicle_state.lids: but can't get that data to show correct as dict in the return.

2. The status of the binary sensors are not shown correctly. For example the door lock state is shown as False/True however that should be Safe/Unsafe. I am using the device_class for this. In my old version I used def is_on(self) for the state, but can't get that to work correctly. Any ideas how to fix this?

3. I also get the following errors in the log:

Error doing job: Task exception was never retrieved
Traceback (most recent call last):
  File "/usr/local/lib/python3.6/asyncio/tasks.py", line 180, in _step
    result = coro.send(None)
  File "/usr/src/app/homeassistant/helpers/entity.py", line 196, in async_update_ha_state
    "No entity id specified for entity {}".format(self.name))
homeassistant.exceptions.NoEntitySpecifiedError: No entity id specified for entity Mileage

Old setup

New setup

The code for the binary sensor is as follows (using it as a custom component):

Show code

"""
Reads vehicle status from BMW connected drive portal.

For more details about this platform, please refer to the documentation at
https://home-assistant.io/components/binary_sensor.bmw_connected_drive/
"""
import logging
import asyncio

from custom_components.bmw_connected_drive import DOMAIN as BMW_DOMAIN
from homeassistant.helpers.entity import Entity
from homeassistant.components.binary_sensor import (
     BinarySensorDevice, DEVICE_CLASSES_SCHEMA)

DEPENDENCIES = ['bmw_connected_drive']

_LOGGER = logging.getLogger(__name__)

SENSOR_TYPES = {
    'all_lids_closed': ['Doors', 'opening'],
    'all_windows_closed': ['Windows', 'opening'],
    'door_lock_state': ['Door lock state', 'safety']
}


def setup_platform(hass, config, add_devices, discovery_info=None):
    """Set up the BMW sensors."""
    accounts = hass.data[BMW_DOMAIN]
    _LOGGER.debug('Found BMW accounts: %s',
                  ', '.join([a.name for a in accounts]))
    devices = []
    for account in accounts:
        for vehicle in account.account.vehicles:
            for key, value in sorted(SENSOR_TYPES.items()):
                device = BMWConnectedDriveSensor(account, vehicle, key, value[0], value[1])
                devices.append(device)
    add_devices(devices, True)


class BMWConnectedDriveSensor(Entity):
    """Representation of a BMW vehicle binary sensor."""

    def __init__(self, account, vehicle, attribute: str, sensor_name, device_class):
        """Constructor."""
        self._account = account
        self._vehicle = vehicle
        self._attribute = attribute
        self._name = sensor_name
        self._device_class = device_class
        self._state = None
        self._unit_of_measurement = None

    @property
    def should_poll(self) -> bool:
        """Data update is triggered from BMWConnectedDriveEntity."""
        return False

    @property
    def device_class(self):
        """Return the class of the binary sensor."""
        return self._device_class
    
    @property
    def name(self):
        """Return the name of the binary sensor."""
        return self._name

    @property
    def state(self):
        """Return the state of the binary sensor.
        The return type of this call depends on the attribute that
        is configured.
        """
        return self._state
    
    # @property
    # def is_on(self):
    #     """Return the state of the binary sensor."""
    #     return self._state

    @property
    def unit_of_measurement(self) -> str:
        """Get the unit of measurement."""
        return self._unit_of_measurement

    @property
    def device_state_attributes(self):
        """Return the state attributes of the binary sensor."""
        vehicle_state = self._vehicle.state

        if self._attribute == 'all_lids_closed':
            ### Show all lids and statuses here
            return
        else:
            return {
                'last_update': vehicle_state.timestamp,
                'car': self._vehicle.modelName
            }

    def update(self) -> None:
        """Read new state data from the library."""
        vehicle_state = self._vehicle.state
        #self._state = getattr(vehicle_state, self._attribute)

        # device class opening: On means open, Off means closed
        if self._attribute == 'all_lids_closed':
            _LOGGER.debug("Status of lid: %s", vehicle_state.all_lids_closed)
            self._state = not vehicle_state.all_lids_closed
        if self._attribute == 'all_windows_closed':
            self._state = not vehicle_state.all_windows_closed
        # device class safety: On means unsafe, Off means safe
        if self._attribute == 'door_lock_state': # LOCKED, SECURED, SELECTIVELOCKED, UNLOCKED
            self._state = bool(vehicle_state.door_lock_state in ('UNLOCKED', 'SELECTIVELOCKED'))

        self.schedule_update_ha_state()
    
    @asyncio.coroutine
    def async_added_to_hass(self):
        """Add callback after being added to hass.
        Show latest data after startup.
        """
        self._account.add_update_listener(self.update)
        self.update()

[ChristianKuehnel]

@gerard33 I just uploaded your code to a new branch on top of my pull request so that I could test and modify it. Looks good to me. I only did some small changes 😄
ChristianKuehnel/home-assistant@ce7699d

The results looks like this:

Is that what you wanted to have?

On second thought having a state "false" is not so nice, so I changed it to "open"/"closed" in another commit:
ChristianKuehnel/home-assistant@d3ff1b3

Concerning the NoEntitySpecifiedError error: I could resolve it be changing add_devices(devices, True) to add_devices(devices). I'm not really sure where this problem comes from, but I had the same issue with my sensor component.

My branch is here: home-assistant/core@dev...ChristianKuehnel:bimmer_binary
Feel free to fork it or only copy the file or do what helps you the most.

[gerard33]

That’s exactly what I wanted to achieve :)

I fully agree with the open/closed state. Strange thing is that on my old version that used to work automatically by using device classes. Will have another look at it, but your solution also works.

Will copy the updated code from your github this evening :)

[gerard33]

I have fixed the open/closed state by using device classes. Had to do with importing the right parts.
This is how it looks right now.

Next on the list can be to add the extra attributes from the list in the first post to the bimmer module.

Forget about the False status in the history, that is still part of the previous solution.

[gerard33]

And this is the latest version.

Show code

"""
Reads vehicle status from BMW connected drive portal.

For more details about this platform, please refer to the documentation at
https://home-assistant.io/components/binary_sensor.bmw_connected_drive/
"""
import logging
import asyncio

from custom_components.bmw_connected_drive import DOMAIN as BMW_DOMAIN
#from homeassistant.components.bmw_connected_drive import DOMAIN as BMW_DOMAIN
from homeassistant.components.binary_sensor import (
    BinarySensorDevice, DEVICE_CLASSES_SCHEMA)
from homeassistant.const import (CONF_DEVICE_CLASS)

DEPENDENCIES = ['bmw_connected_drive']

_LOGGER = logging.getLogger(__name__)

SENSOR_TYPES = {
    'all_lids_closed': ['Doors', 'opening'],
    'all_windows_closed': ['Windows', 'opening'],
    'door_lock_state': ['Door lock state', 'safety']
}


def setup_platform(hass, config, add_devices, discovery_info=None):
    """Set up the BMW sensors."""
    accounts = hass.data[BMW_DOMAIN]
    _LOGGER.debug('Found BMW accounts: %s',
                  ', '.join([a.name for a in accounts]))
    devices = []
    for account in accounts:
        for vehicle in account.account.vehicles:
            for key, value in sorted(SENSOR_TYPES.items()):
                device = BMWConnectedDriveSensor(account, vehicle, key,
                                                 value[0], value[1])
                devices.append(device)
    add_devices(devices)


class BMWConnectedDriveSensor(BinarySensorDevice):
    """Representation of a BMW vehicle binary sensor."""

    def __init__(self, account, vehicle, attribute: str, sensor_name,
                 device_class):
        """Constructor."""
        self._account = account
        self._vehicle = vehicle
        self._attribute = attribute
        self._name = sensor_name
        self._device_class = device_class
        self._state = None
        self._unit_of_measurement = None

    @property
    def should_poll(self) -> bool:
        """Data update is triggered from BMWConnectedDriveEntity."""
        return False

    @property
    def name(self):
        """Return the name of the binary sensor."""
        return self._name

    @property
    def device_class(self):
        """Return the class of the binary sensor."""
        return self._device_class

    @property
    def is_on(self):
        """Return the state of the binary sensor."""
        return self._state

    @property
    def unit_of_measurement(self) -> str:
        """Get the unit of measurement."""
        return self._unit_of_measurement

    @property
    def device_state_attributes(self):
        """Return the state attributes of the binary sensor."""
        vehicle_state = self._vehicle.state
        result = {
            'last_update': vehicle_state.timestamp,
            'car': self._vehicle.modelName
        }

        if self._attribute == 'all_lids_closed':
            for lid in vehicle_state.lids:
                result[lid.name] = lid.state.value
        
        if self._attribute == 'all_windows_closed':
            for lid in vehicle_state.windows:
                result[lid.name] = lid.state.value
        
        if self._attribute == 'door_lock_state':
            result['door_lock_state'] = vehicle_state.door_lock_state.value

        return result

    def update(self):
        """Read new state data from the library."""
        vehicle_state = self._vehicle.state

        # device class opening: On means open, Off means closed
        if self._attribute == 'all_lids_closed':
            _LOGGER.debug("Status of lid: %s", vehicle_state.all_lids_closed)
            self._state = not vehicle_state.all_lids_closed
        if self._attribute == 'all_windows_closed':
            self._state = not vehicle_state.all_windows_closed
        # device class safety: On means unsafe, Off means safe
        if self._attribute == 'door_lock_state':
            # LOCKED, SECURED, SELECTIVELOCKED, UNLOCKED
            self._state = bool(vehicle_state.door_lock_state.value
                               in ('SELECTIVELOCKED', 'UNLOCKED'))

        self.schedule_update_ha_state()

    @asyncio.coroutine
    def async_added_to_hass(self):
        """Add callback after being added to hass.
        Show latest data after startup.
        """
        self._account.add_update_listener(self.update)
        yield from self.hass.async_add_job(self.update)

[ChristianKuehnel]

@gerard33 just updated the code and it's working for my setup. nice work 👍

[gerard33]

Doors, windows and door lock state will be available in the next HA release home-assistant/core#12591.
Other binary sensors will be added in next releases.

[robbz23]

@gerard33 Can you include lastChargingEndResult when you do the binary sensors for electric cars. I could probably do it this weekend if you can give me an example to follow. I actually had an issue this week where my car blew the fuse in the house and I came out in the morning to a dead battery. Its disappointing that the bmw app can notify me that charging failed.