Add new device to flowchem

Code

In the flowchem.device subpackage, the device modules are organized in folders by manufacturer. Since this is the first device from Weasley & Weasley in flowchem, we need to create a new folder under /flowchem/devices. Let’s call it /flowchem/devices/Weasley to avoid the use of special characters ;)

In this folder we will write a module (i.e. a python file 🐍) called ExtendableEar.py to control our magic device. We create it piece by piece, but the content of the module will look like this:

from flowchem.devices.flowchem_device import FlowchemDevice


class ExtendeableEar(FlowchemDevice):
    """Our virtual Extendable Ear!"""

    def __init__(self):
        ...

from flowchem.devices.flowchem_device import FlowchemDevice


class ExtendeableEar(FlowchemDevice):
    """Our virtual Extendable Ear!"""

    def __init__(self):
        ...

    async def initialize(self):
        ...

    async def deploy(self):
        ...

    async def listen_for(self, seconds: str):
        ...

    async def retract(self):
        ...

• instantiable from dict or if not possible with from_config @classmethod

Finally, to register your new device type to the flowchem add to __init__.py to ensure it is available for import with a statement like

from flowchem.devices import ExtendableEar

Documentation

Write a brief description of the class you created in the /docs/devices/ folder, following the same manufacturer-base hierarchy. Ideally manufacturer communication manual is added to the docs

Note

This is an implementation detail that user do not have to care about since the flowchem.device submodules will hide this nested layer via their __init__.py. If you do not understand what this means it is not important, and you can safely skip this note if you follow this guide.