Connecting to HighRes Bio Cellario#

This guide will walk you through how to connect Artificial to Cellario using the Cellario Resource Library.

Attention

Before you get started, make sure your local Adapter development environment is set up and ready to go.

Supported Cellario versions#

HighRes Bio Cellario 3.5, 4.0, and 4.1

Note

No driver is needed for the Cellario Resource Library.

Install the Resource Library in your Adapter#

Run the following command in the terminal of your adapter repository to install Artificial’s Cellario Resource Library:

uv add artificial-cellario-resource-library==0.0.53

Your pyproject.toml file should now include artificial-cellario-resource-library in the project dependencies section:

[project]
dependencies = [
  ...
  "artificial-cellario-resource-library==0.0.53"
]

Update your Adapter Config#

config.yaml#
adapter:
  name: cellarioTutorialAdapter
  remoteConfig: False
  allowAnySequenceId: True # Useful when running in a local dev container
  plugin: # all resources this adapter can connect to
    resource:
      name: "MyCellario"  # user friendly name, unique in the adapter
      id: "cellario"
      driver:
        name: "cellario" # Driver name, this is a non-configurable string that needs to match the driver identity
        url: "http://cellario.webaddress.com:8444" #  URL of the hardware and driver
        resource_simulation: false     # Set to true to run simulation without hardware
        driver_simulation: false       # Set to true to run simulation without a driver
        cert_file: ""
        user_name: “t”
        user_password: “t”
  asset_sync:
    devices: # device string names/prefix must match resource id above
      "ACell 1.1": { rid: "92b68c16-440c-4806-87f0-ef5f0ebb5299" }

  1. Fill in the correct URL for the Cellario device. The device’s IPv4 URL can be obtained from Network & Internet Settings or by running ipconfig in a command window.

  2. You may update the resource name above if you wish. Any string will work but it must be unique across the instance.

  3. Fill in the user_name and password, if needed.

  4. If you wish to run in simulation without hardware or without a driver, change resource_simulation or driver_simulation to true, respectively.

  5. Update the asset_sync section to map at least one Cellario device to an asset instance id in the digital twin. You can fill out the rest of the devices later. See Asset Sync Config for more information.

Use the Resource Library in your Adapter#

adapter/main/plugin.py file#
from artificial.adapter_common import ActionModulePlugin, action_modules
from artificial.adapter_common.plugin import PluginContext, plugin_config
from artificial.cellario.actions import CellarioActions
from artificial.cellario.models import PluginConfig
from artificial.logging import get_logger
from artificial.resource_base.models import SyncConfig

logger = get_logger(__name__)


@action_modules(CellarioActions)
class AdapterPlugin(ActionModulePlugin):
    cfg = plugin_config(PluginConfig)

    async def setup(self, pctx: PluginContext) -> None:
        sync_config = pctx.raw_config.to_dataclass(SyncConfig, 'adapter.asset_sync')
        cellario_actions = await CellarioActions.create(pctx, self.cfg, sync_config)
        self.add_module(cellario_actions)
        self.add_webroute(cellario_actions.event_web_route)
        await pctx.lab.health.add_monitor('Cellario', cellario_actions.check_health, 60, 30)

Add the required Actors#

Add the following actors to the list of actors in adapter/main/__main__.py.

actors = [
    ActorConfig(id='cellario', abilities={'cellario': 100}),
]

Publish and run a test Workflow#

This sample workflow will connect with Cellario, start the system, and then log a message in the UI upon successful completion.

Note

We recommend pausing or stopping Cellario before running this workflow so you can more clearly see the effect of the start_system() action.

from artificial.workflows.decorators import workflow
from artificial.workflows.runtime import show_info
from stubs.stubs_actions import start_system


@workflow('Simple Cellario Connectivity Test Workflow', 'simple_cellario_connectivity_workflow')
async def simple_cellario_connectivity_workflow() -> None:
    await start_system()
    await show_info('Congratulations, you successfully ran your hardware!', 'Hardware Success')