Minimal configuration for inserting documents into Tiled

pyproject.toml

@@ -13,6 +13,10 @@ classifiers = [
 ]
 description = "Lightweight bluesky-as-a-service wrapper application. Also usable as a library."
 dependencies = [
+    "tiled",
+    "json_merge_patch",
+    "jsonpatch",
+    "pyarrow",
     "bluesky>=1.13",
     "ophyd",
     "nslsii",
@@ -95,7 +99,8 @@ addopts = """
     --ignore=src/blueapi/startup
     """
 # https://iscinumpy.gitlab.io/post/bound-version-constraints/#watch-for-warnings
-filterwarnings = ["error", "ignore::DeprecationWarning"]
+# Unignore UserWarning after Pydantic warning removed from bluesky/bluesky and release
+filterwarnings = ["error", "ignore::DeprecationWarning", "ignore::UserWarning"]
 # Doctest python code in docs, python code in src docstrings, test functions in tests
 testpaths = "docs src tests"
 asyncio_mode = "auto"

src/blueapi/config.py

@@ -41,6 +41,15 @@ class StompConfig(BaseModel):
     auth: BasicAuthentication | None = None
 
 
+class TiledConfig(BaseModel):
+    """
+    Config for connecting to a tiled instance
+    """
+
+    uri: str
+    api_key: str
+
+
 class WorkerEventConfig(BlueapiBaseModel):
     """
     Config for event broadcasting via the message bus
@@ -160,6 +169,7 @@ class ApplicationConfig(BlueapiBaseModel):
     """
 
     stomp: StompConfig | None = None
+    tiled: TiledConfig | None = None
     env: EnvironmentConfig = Field(default_factory=EnvironmentConfig)
     logging: LoggingConfig = Field(default_factory=LoggingConfig)
     api: RestConfig = Field(default_factory=RestConfig)

src/blueapi/service/interface.py

@@ -3,10 +3,12 @@
 from functools import cache
 from typing import Any
 
+from bluesky.callbacks.tiled_writer import TiledWriter
 from bluesky_stomp.messaging import StompClient
 from bluesky_stomp.models import Broker, DestinationBase, MessageTopic
+from tiled.client import from_uri
 
-from blueapi.config import ApplicationConfig, OIDCConfig, StompConfig
+from blueapi.config import ApplicationConfig, OIDCConfig, StompConfig, TiledConfig
 from blueapi.core.context import BlueskyContext
 from blueapi.core.event import EventStream
 from blueapi.service.model import DeviceModel, PlanModel, WorkerTask
@@ -48,6 +50,19 @@
     return worker
 
 
+@cache
+def tiled_inserter():
+    tiled_config: TiledConfig | None = config().tiled
+    if tiled_config is not None:
+        client = from_uri(tiled_config.uri, api_key=tiled_config.api_key)
+
+        ctx = context()
+        ctx.run_engine.subscribe(TiledWriter(client))
+        return client
+    else:
+        return None
+
+
 @cache
 def stomp_client() -> StompClient | None:
     stomp_config: StompConfig | None = config().stomp
@@ -86,6 +101,7 @@
     logging.basicConfig(format="%(asctime)s - %(message)s", level=config.logging.level)
     worker()
     stomp_client()
+    tiled_inserter()
 
 
 def teardown() -> None:

tests/unit_tests/test_config.py

@@ -224,6 +224,7 @@ def temp_yaml_config_file(
             "logging": {"level": "INFO"},
             "api": {"host": "0.0.0.0", "port": 8000, "protocol": "http"},
             "scratch": None,
+            "tiled": None,
         },
     ],
     indirect=True,
@@ -285,6 +286,7 @@ def test_config_yaml_parsed(temp_yaml_config_file):
                     }
                 ],
             },
+            "tiled": None,
         },
         {
             "stomp": {
@@ -318,6 +320,7 @@ def test_config_yaml_parsed(temp_yaml_config_file):
                     }
                 ],
             },
+            "tiled": None,
         },
     ],
     indirect=True,