Complete Async Component Example

DaAwesomeP · May 12, 2019, 6:17am

Hi,
I set out to develop an async component, but the documentation is lacking, and I cannot find a complete example of a component that has config loading flows, lights, sensors, and switches. I have looked at the hue component source, but there is a lot more going on there with connecting to the hubs and hues and so so so much boilerplate that I am lost. Is there a better starting point for developing an async component?

Thanks!
DaAwesomeP

Robban · May 12, 2019, 8:31am

Deconz uses it all and is quite streamlined

DaAwesomeP · May 17, 2019, 8:35pm

So I took a look at the deconz component and there a lot of parts that are very different than the hue component, which is just more confusing. Is there an empty async component example that doesn’t include a platform-specific discovery process or other platform-specific methods? I guess what is also confusing is that I’m trying to read through the source files and link where things are called from where, but there have to be a hundred different functions. I know these things take time and effort, and I’m only asking because I think that is what would help most, but are there plans for full async docs in the roadmap?

I guess one thing I have been struggling with is just a list of all of the async methods that I need to assign and what their expected output is. For example, what do I call when my platform has an update for a switch/sensor/etc.?

Robban · May 17, 2019, 8:49pm

Well all of deconz different platforms keep a common base, so that should really help you identify these kinds of things.

Updating an entity:

github.com

home-assistant/core/blob/fffc4dd3fd5f5aef399eedc17ae404ea5438b719/homeassistant/components/deconz/deconz_device.py#L36



async def async_will_remove_from_hass(self) -> None:
    """Disconnect device object when removed."""
    self._device.remove_callback(self.async_update_callback)
    del self.gateway.deconz_ids[self.entity_id]
    self.unsub_dispatcher()

@callback
def async_update_callback(self, reason):
    """Update the device's state."""
    self.async_schedule_update_ha_state()

@property
def name(self):
    """Return the name of the device."""
    return self._device.name

@property
def unique_id(self):
    """Return a unique identifier for this device."""
    return self._device.uniqueid

This will read state and a lot of other properties of the entity, so make sure to have them updated before calling self.async_schedule_update_ha_state()

Feel free to use this thread to ask dev questions, or pm me on discord

DaAwesomeP · May 17, 2019, 9:02pm

Thank you for all the help! I really appreciate it!

So I should have the callback from my library call my own internal function to change the entity’s state and then call async_schedule_update_ha_state()?

Robban · May 17, 2019, 9:04pm

That works

In deconz it specifically registers the update callback to be called

github.com

home-assistant/core/blob/fffc4dd3fd5f5aef399eedc17ae404ea5438b719/homeassistant/components/deconz/deconz_device.py#L21


"""Representation of a deCONZ device."""

def __init__(self, device, gateway):
    """Set up device and add update callback to get data from websocket."""
    self._device = device
    self.gateway = gateway
    self.unsub_dispatcher = None

async def async_added_to_hass(self):
    """Subscribe to device events."""
    self._device.register_async_callback(self.async_update_callback)
    self.gateway.deconz_ids[self.entity_id] = self._device.deconz_id
    self.unsub_dispatcher = async_dispatcher_connect(
        self.hass, self.gateway.event_reachable,
        self.async_update_callback)

async def async_will_remove_from_hass(self) -> None:
    """Disconnect device object when removed."""
    self._device.remove_callback(self.async_update_callback)
    del self.gateway.deconz_ids[self.entity_id]
    self.unsub_dispatcher()

DaAwesomeP · May 17, 2019, 9:23pm

It looks like deconz adds sensors, etc. by querying the gateway. How would I do this by simply looking for a config entry where the platform is set to my domain and some other attributes?

Robban · May 17, 2019, 9:29pm

The config entry is for credentials, then you set up your communication and create entities.

Or are you meaning you configure it from configuration.yaml?

Maybe Im misunderstanding your question…

DaAwesomeP · May 17, 2019, 9:32pm

yes, from configuration.yaml.

I’m making an async firmata component from scratch using the newer pymata_aio. It makes much more sense to define arduino pins/i2c devices/etc in the config than attempt autodiscover what could be 30 unused pins. The current firmata/arduino component doesn’t support the full capabilities of digital and analog io. Also, each pin has to be put in a mode, so that really wouldn’t work well.

Robban · May 17, 2019, 9:34pm

Maybe you shouldn’t bother with config entries yet if you need a lot of advanced configuration then that will not be acceptable for config entries. Unless you more or less load all in a dynamic way.

DaAwesomeP · May 17, 2019, 9:41pm

I think it makes sense for config entries. Basically, it would configure like this:

firmata:
  - name: board1
    serialport: /dev/ttyACM0
  - name: remoteboard
    host: myip
    port: 12345
    handshake: mycoolstring

binary_sensor:
  platform: firmata
  board1:
   - type: pullup
     pin: 3
     name: mycoolbutton

Robban · May 17, 2019, 9:43pm

You will probably get resistance with config entries and needing to specify exact pin per sensor.

The broader configuration part would be ok. But there would be too many things to configure a part from the service and it’s credentials.

If the component can be smart and do that automatically that would be a different thing

DaAwesomeP · May 17, 2019, 9:47pm

The way an arduino works—you have to configure each pin. How else would I do that? That is how the current arduino component works. I’m sure the Raspberry Pi GPIO component would work the same way. I could detect how many analog and digital pins a device has, but that is about it. I still have to tell those pins to listen and what mode to listen in. Firmata doesn’t remember states.

Robban · May 17, 2019, 9:48pm

Then you will probably not achieve this as a config entry.

Feel free to ping Balloob on discord for a more correct answer though

DaAwesomeP · May 17, 2019, 9:52pm

I’m really confused. This is how the current component is configured (from the component doc):

switch:
  platform: arduino
  pins:
    11:
      name: Fan Office
    12:
      name: Light Desk
      initial: true
      negate: true

This is very similar to what I am trying to do. What is the limitation? Do async components not allow config via configuration.yaml outside the base of the component? Is it assumed that all async components are self-discovering?

Robban · May 17, 2019, 9:53pm

Config entry is when you initiate the integration from the front end. If that is what youre meaning then the configuration.yaml is the way and you will be just fine

Scrolled up… Sorry missread your comment about config entry.

DaAwesomeP · May 17, 2019, 9:55pm

Ah no problem! So do I completely cut out the config flow parts? How do I get attributes from a sensor in configuration.yaml in my sensor.py?

Robban · May 17, 2019, 9:56pm

If all you want to do is to create binary sensors, you don’t really need the component.

But if you wish to use component, you can pass configuration to the binary sensor platform that can do what you seek.

DaAwesomeP · May 17, 2019, 10:00pm

Right, but specifically from this example:

binary_sensor:
  platform: firmata
  board1:
   - type: pullup
     pin: 3
     name: mycoolbutton

how do I fetch type and pin from binary_sensor.py (as in what code)? In __init__.py it’s config.get(DOMAIN), so what would it be in an entity file?

Robban · May 17, 2019, 10:02pm

They would be a part of the config

Look for how the gpio is read

github.com

home-assistant/core/blob/dev/homeassistant/components/rpi_rf/switch.py

"""Support for a switch using a 433MHz module via GPIO on a Raspberry Pi."""
import importlib
import logging
from threading import RLock

import voluptuous as vol

from homeassistant.components.switch import PLATFORM_SCHEMA, SwitchEntity
from homeassistant.const import CONF_NAME, CONF_SWITCHES, EVENT_HOMEASSISTANT_STOP
import homeassistant.helpers.config_validation as cv

_LOGGER = logging.getLogger(__name__)

CONF_CODE_OFF = "code_off"
CONF_CODE_ON = "code_on"
CONF_GPIO = "gpio"
CONF_PROTOCOL = "protocol"
CONF_PULSELENGTH = "pulselength"
CONF_SIGNAL_REPETITIONS = "signal_repetitions"

This file has been truncated. show original

Time for me to sleep