boulder-opal-scale-up-sdk 1.0.5__py3-none-any.whl → 1.0.6__py3-none-any.whl

boulderopalscaleupsdk/experiments/readout_optimization.py

@@ -0,0 +1,57 @@
+# Copyright 2025 Q-CTRL. All rights reserved.
+#
+# Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
+# copying or use of this file, via any medium, is strictly prohibited.
+# Proprietary and confidential. You may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+#    https://q-ctrl.com/terms
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS. See the
+# License for the specific language.
+
+from typing import Literal
+
+from pydantic import PrivateAttr
+
+from .common import (
+    CWSIterable,
+    Experiment,
+    HypIterable,
+    LinspaceIterable,
+    RangeIterable,
+)
+
+
+class ReadoutOptimization(Experiment):
+    """
+    Parameters for optimizing the readout classifier.
+
+    Parameters
+    ----------
+    transmon : str
+        The reference for the transmon to target.
+    frequencies : list[int] or LinspaceIterable or RangeIterable or CWSIterable or HypIterable
+        The readout frequencies to sweep, in Hz.
+    amplitudes : list[float]
+        The readout amplitudes to sweep.
+    recycle_delay_ns : int
+        The delay between consecutive shots, in nanoseconds. Defaults to 200,000 ns.
+    shot_count : int, optional
+        The number of shots to take. Defaults to 5,000.
+    run_mixer_calibration: bool
+        Whether to run mixer calibrations before running a program. Defaults to False.
+    update : "auto" or "off", optional
+        How the device should be updated after an experiment run. Defaults to auto.
+    """
+
+    _experiment_name: str = PrivateAttr("readout_optimization")
+
+    transmon: str
+    frequencies: list[int] | LinspaceIterable | RangeIterable | CWSIterable | HypIterable
+    amplitudes: list[float]
+    recycle_delay_ns: int = 200_000
+    shot_count: int = 5000
+    run_mixer_calibration: bool = False
+    update: Literal["auto", "off"] = "auto"

boulderopalscaleupsdk/experiments/resonator_spectroscopy_by_bias.py

@@ -24,8 +24,6 @@ from .common import (
 )
 from .waveforms import ConstantWaveform
 
-DEFAULT_BIASES = LinspaceIterable(start=-0.49, stop=0.49, count=21)
-
 
 class ResonatorSpectroscopyByBias(Experiment):
     """
@@ -67,7 +65,7 @@ class ResonatorSpectroscopyByBias(Experiment):
         None
     )
     biases: list[float] | LinspaceIterable | RangeIterable | CWSIterable | HypIterable = (
-        DEFAULT_BIASES
+        LinspaceIterable(start=-0.49, stop=0.49, count=21)
     )
     recycle_delay_ns: int = 1_000
     shot_count: int = 100

boulderopalscaleupsdk/experiments/transmon_anharmonicity.py

@@ -24,8 +24,6 @@ from .common import (
 )
 from .waveforms import ConstantWaveform
 
-DEFAULT_RECYCLE_DELAY_NS = 1_000  # ns
-
 
 class TransmonAnharmonicity(Experiment):
     """

boulderopalscaleupsdk/grpc_interceptors/error.py

@@ -0,0 +1,318 @@
+# Copyright 2025 Q-CTRL. All rights reserved.
+#
+# Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
+# copying or use of this file, via any medium, is strictly prohibited.
+# Proprietary and confidential. You may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+#    https://q-ctrl.com/terms
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS. See the
+# License for the specific language.
+
+from __future__ import annotations
+
+import inspect
+import re
+from typing import TYPE_CHECKING, Any
+
+import grpc
+import grpc.aio
+
+from boulderopalscaleupsdk.errors import ScaleUpServerError
+
+if TYPE_CHECKING:
+    from collections.abc import AsyncIterable, AsyncIterator
+
+# ------------------------
+# Helpers
+# ------------------------
+
+_GRPC_MESSAGE_RE = re.compile(r'grpc_message:"([^"]+)"')
+
+
+def _extract_peer_message(err: grpc.RpcError) -> str | None:
+    dbg = getattr(err, "debug_error_string", None)
+    if callable(dbg):
+        try:
+            s = dbg()
+        except (AttributeError, TypeError, RuntimeError):
+            return None
+        if isinstance(s, str):
+            m = _GRPC_MESSAGE_RE.search(s)
+            if m:
+                return m.group(1)
+    return None
+
+
+def _concise_error(err: grpc.RpcError, *, include_code: bool = False) -> str:
+    msg = _extract_peer_message(err) or (err.details() or "An unknown error occurred.")
+    if include_code:
+        try:
+            return f"{err.code().name}: {msg}"
+        except (AttributeError, ValueError):
+            pass
+    return msg
+
+
+# ------------------------
+# SYNC wrappers
+# ------------------------
+
+
+class _UnaryUnaryCallWrapper:
+    """Proxy that prettifies errors when .result() is called (sync)."""
+
+    def __init__(self, inner: Any, include_code: bool) -> None:
+        self._inner = inner
+        self._include_code = include_code
+
+    def result(self, timeout: float | None = None) -> Any:
+        try:
+            return self._inner.result(timeout)
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def __getattr__(self, name: str) -> Any:
+        return getattr(self._inner, name)
+
+    def __bool__(self) -> bool:
+        return bool(self._inner)
+
+
+class _SyncRespIterWrapper:
+    """Wrap response-stream iterator to prettify RpcError during iteration (sync)."""
+
+    def __init__(self, inner: Any, include_code: bool) -> None:
+        self._inner = inner
+        self._include_code = include_code
+
+    def __iter__(self):
+        try:
+            yield from self._inner
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def __getattr__(self, name: str) -> Any:
+        return getattr(self._inner, name)
+
+
+class _SyncReqIterWrapper:
+    """Wrap request-stream iterator to prettify RpcError while producing items (sync)."""
+
+    def __init__(self, inner: Any, include_code: bool) -> None:
+        self._inner = inner
+        self._include_code = include_code
+
+    def __iter__(self):
+        try:
+            yield from self._inner
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def __getattr__(self, name: str) -> Any:
+        return getattr(self._inner, name)
+
+
+# ------------------------
+# ASYNC wrappers
+# ------------------------
+
+
+class _AioRespAsyncIterWrapper:
+    """
+    Async iterator proxy that prettifies errors from response streams (async).
+    Accepts the Call object (UnaryStreamCall or StreamStreamCall).
+    """
+
+    def __init__(self, inner: Any, include_code: bool) -> None:
+        self._inner = inner
+        self._include_code = include_code
+
+    def __aiter__(self) -> AsyncIterator[Any]:
+        async def gen() -> AsyncIterator[Any]:
+            try:
+                async for item in self._inner:
+                    yield item
+            except grpc.RpcError as e:
+                raise ScaleUpServerError(
+                    _concise_error(e, include_code=self._include_code),
+                ) from None
+
+        return gen()
+
+    async def initial_metadata(self) -> Any:
+        try:
+            return await self._inner.initial_metadata()
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    async def trailing_metadata(self) -> Any:
+        try:
+            return await self._inner.trailing_metadata()
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def cancel(self) -> None:
+        return self._inner.cancel()
+
+    def code(self) -> Any:
+        return self._inner.code()
+
+    def details(self) -> str:
+        return self._inner.details()
+
+    def __getattr__(self, name: str) -> Any:
+        return getattr(self._inner, name)
+
+
+class _AioReqAsyncIterWrapper:
+    """
+    Async request iterator wrapper that prettifies errors when producing request items.
+    Takes any AsyncIterable (not necessarily an AsyncIterator).
+    """
+
+    def __init__(self, inner: AsyncIterable[Any], include_code: bool) -> None:
+        self._inner = inner
+        self._include_code = include_code
+
+    def __aiter__(self) -> AsyncIterator[Any]:
+        async def gen() -> AsyncIterator[Any]:
+            try:
+                async for item in self._inner:
+                    yield item
+            except grpc.RpcError as e:
+                raise ScaleUpServerError(
+                    _concise_error(e, include_code=self._include_code),
+                ) from None
+
+        return gen()
+
+
+# ------------------------
+# Unified interceptor (sync + aio)
+# ------------------------
+
+
+class ErrorFormatterInterceptor(
+    # sync interfaces
+    grpc.UnaryUnaryClientInterceptor,
+    grpc.UnaryStreamClientInterceptor,
+    grpc.StreamUnaryClientInterceptor,
+    grpc.StreamStreamClientInterceptor,
+    # aio interfaces
+    grpc.aio.UnaryUnaryClientInterceptor,
+    grpc.aio.UnaryStreamClientInterceptor,
+    grpc.aio.StreamUnaryClientInterceptor,
+    grpc.aio.StreamStreamClientInterceptor,
+):
+    """
+    Prettifies gRPC errors raised by the server into ScaleUpServerError.
+
+    Works with both sync (grpc) and async (grpc.aio) channels.
+
+    - Detects whether `continuation` is a coroutine function.
+    - In async case, returns a coroutine that yields wrapped awaitable/async-iterable calls.
+    - In sync case, returns wrapped blocking call objects/iterators.
+    """
+
+    def __init__(self, include_code: bool = False) -> None:
+        self._include_code = include_code
+
+    # ---------- UNARY -> UNARY ----------
+
+    async def _async_unary_unary(self, continuation, client_call_details, request) -> Any:
+        try:
+            call = continuation(client_call_details, request)  # awaitable call
+            # Await here so callers receive the *message*, mirroring AuthInterceptor.
+            return await call
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def _sync_unary_unary(self, continuation, client_call_details, request) -> Any:
+        try:
+            call = continuation(client_call_details, request)  # blocking call
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+        return _UnaryUnaryCallWrapper(call, self._include_code)
+
+    def intercept_unary_unary(self, continuation, client_call_details, request):  # type: ignore[override]
+        if inspect.iscoroutinefunction(continuation):
+            return self._async_unary_unary(continuation, client_call_details, request)
+        return self._sync_unary_unary(continuation, client_call_details, request)
+
+    # ---------- UNARY -> STREAM ----------
+
+    async def _async_unary_stream(self, continuation, client_call_details, request) -> Any:
+        try:
+            resp_call = continuation(client_call_details, request)  # async-iterable call
+            # Do NOT await: return an iterator wrapper that prettifies stream errors.
+            return _AioRespAsyncIterWrapper(resp_call, self._include_code)
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def _sync_unary_stream(self, continuation, client_call_details, request) -> Any:
+        try:
+            resp_iter = continuation(client_call_details, request)  # iterator
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+        return _SyncRespIterWrapper(resp_iter, self._include_code)
+
+    def intercept_unary_stream(self, continuation, client_call_details, request):  # type: ignore[override]
+        if inspect.iscoroutinefunction(continuation):
+            return self._async_unary_stream(continuation, client_call_details, request)
+        return self._sync_unary_stream(continuation, client_call_details, request)
+
+    # ---------- STREAM -> UNARY ----------
+
+    async def _async_stream_unary(self, continuation, client_call_details, request_iterator) -> Any:
+        try:
+            wrapped_req = _AioReqAsyncIterWrapper(request_iterator, self._include_code)
+            call = continuation(client_call_details, wrapped_req)  # awaitable call
+            # Await and return the *message*.
+            return await call
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def _sync_stream_unary(self, continuation, client_call_details, request_iterator) -> Any:
+        try:
+            wrapped_req = _SyncReqIterWrapper(request_iterator, self._include_code)
+            call = continuation(client_call_details, wrapped_req)  # blocking call
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+        return _UnaryUnaryCallWrapper(call, self._include_code)
+
+    def intercept_stream_unary(self, continuation, client_call_details, request_iterator):  # type: ignore[override]
+        if inspect.iscoroutinefunction(continuation):
+            return self._async_stream_unary(continuation, client_call_details, request_iterator)
+        return self._sync_stream_unary(continuation, client_call_details, request_iterator)
+
+    # ---------- STREAM -> STREAM ----------
+
+    async def _async_stream_stream(
+        self,
+        continuation,
+        client_call_details,
+        request_iterator,
+    ) -> Any:
+        try:
+            wrapped_req = _AioReqAsyncIterWrapper(request_iterator, self._include_code)
+            resp_call = continuation(client_call_details, wrapped_req)  # async-iterable call
+            # Return iterator wrapper.
+            return _AioRespAsyncIterWrapper(resp_call, self._include_code)
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+
+    def _sync_stream_stream(self, continuation, client_call_details, request_iterator) -> Any:
+        try:
+            wrapped_req = _SyncReqIterWrapper(request_iterator, self._include_code)
+            resp_iter = continuation(client_call_details, wrapped_req)  # iterator
+        except grpc.RpcError as e:
+            raise ScaleUpServerError(_concise_error(e, include_code=self._include_code)) from None
+        return _SyncRespIterWrapper(resp_iter, self._include_code)
+
+    def intercept_stream_stream(self, continuation, client_call_details, request_iterator):  # type: ignore[override]
+        if inspect.iscoroutinefunction(continuation):
+            return self._async_stream_stream(continuation, client_call_details, request_iterator)
+        return self._sync_stream_stream(continuation, client_call_details, request_iterator)

boulderopalscaleupsdk/plotting/dtypes.py

@@ -19,7 +19,6 @@ from pydantic import (
     BaseModel,
     BeforeValidator,
     ConfigDict,
-    Field,
     PlainSerializer,
     ValidationError,
 )
@@ -87,7 +86,7 @@ class PlotConfig(BaseModel):
     report: PlotReport | None = None
 
 
-@dataclass(config=ConfigDict(arbitrary_types_allowed=True))
+@dataclass(config=ConfigDict(arbitrary_types_allowed=True, extra="forbid"))
 class PlotData1D:
     x: _SerializableArray
     y: _SerializableArray
@@ -113,7 +112,7 @@ class PlotData1D:
             raise ValueError("The shapes of y and y_error must match.")
 
 
-@dataclass(config=ConfigDict(arbitrary_types_allowed=True))
+@dataclass(config=ConfigDict(arbitrary_types_allowed=True, extra="forbid"))
 class HeatmapData:
     x: _SerializableArray
     y: _SerializableArray
@@ -123,6 +122,7 @@ class HeatmapData:
 
     # Whether to display the heatmap values as text.
     heatmap_text: bool = False
+    color_map: Literal["sequential", "divergent"] = "sequential"
 
     def __post_init__(self):
         if self.x.ndim != 1:
@@ -158,12 +158,12 @@ class LinePlot(BaseModel):
 
     config: PlotConfig
     heatmap: HeatmapData | None = None
-    lines: Annotated[list[PlotData1D], Field(min_length=1)]
+    lines: list[PlotData1D] = []
     markers: list[Marker] = []
     vlines: list[VLine] = []
 
 
-@dataclass(config=ConfigDict(arbitrary_types_allowed=True))
+@dataclass(config=ConfigDict(arbitrary_types_allowed=True, extra="forbid"))
 class HistogramData:
     data: _SerializableArray
     label: str | None = None

boulderopalscaleupsdk/protobuf/v1/device_pb2.py

@@ -16,7 +16,7 @@ from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2
 from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n.boulderopalscaleupsdk/protobuf/v1/device.proto\x12!boulderopalscaleupsdk.protobuf.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x1cgoogle/protobuf/struct.proto\"-\n\x14GetJobSummaryRequest\x12\x15\n\x06job_id\x18\x01 \x01(\tR\x05jobId\"Z\n\x15GetJobSummaryResponse\x12\x41\n\x10job_summary_data\x18\x01 \x01(\x0b\x32\x17.google.protobuf.StructR\x0ejobSummaryData\"&\n\rGetJobRequest\x12\x15\n\x06job_id\x18\x01 \x01(\tR\x05jobId\"D\n\x0eGetJobResponse\x12\x32\n\x08job_data\x18\x01 \x01(\x0b\x32\x17.google.protobuf.StructR\x07jobData\"\x96\x01\n\x0fListJobsRequest\x12\x1f\n\x0b\x64\x65vice_name\x18\x01 \x01(\tR\ndeviceName\x12\x19\n\x08job_name\x18\x02 \x01(\tR\x07jobName\x12\x12\n\x04page\x18\x03 \x01(\x05R\x04page\x12\x14\n\x05limit\x18\x04 \x01(\x05R\x05limit\x12\x1d\n\nsort_order\x18\x05 \x01(\x05R\tsortOrder\"`\n\x10ListJobsResponse\x12+\n\x04jobs\x18\x01 \x03(\x0b\x32\x17.google.protobuf.StructR\x04jobs\x12\x1f\n\x0btotal_pages\x18\x02 \x01(\x05R\ntotalPages\"\x85\x01\n\rCreateRequest\x12\x19\n\x08\x61pp_name\x18\x01 \x01(\tR\x07\x61ppName\x12\x1f\n\x0b\x64\x65vice_name\x18\x02 \x01(\tR\ndeviceName\x12\x38\n\x0b\x64\x65vice_data\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\ndeviceData\"$\n\x0e\x43reateResponse\x12\x12\n\x04\x64one\x18\x01 \x01(\x08R\x04\x64one\"]\n\x0b\x43opyRequest\x12(\n\x10\x66rom_device_name\x18\x01 \x01(\tR\x0e\x66romDeviceName\x12$\n\x0eto_device_name\x18\x02 \x01(\tR\x0ctoDeviceName\"\"\n\x0c\x43opyResponse\x12\x12\n\x04\x64one\x18\x01 \x01(\x08R\x04\x64one\"L\n\x0eGetDataRequest\x12\x19\n\x08\x61pp_name\x18\x01 \x01(\tR\x07\x61ppName\x12\x1f\n\x0b\x64\x65vice_name\x18\x02 \x01(\tR\ndeviceName\"\xc6\x01\n\x0fGetDataResponse\x12>\n\x0eprocessor_data\x18\x02 \x01(\x0b\x32\x17.google.protobuf.StructR\rprocessorData\x12@\n\x0f\x63ontroller_data\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\x0e\x63ontrollerData\x12\x31\n\x07\x64\x65\x66\x63\x61ls\x18\x04 \x03(\x0b\x32\x17.google.protobuf.StructR\x07\x64\x65\x66\x63\x61ls\"\x8b\x01\n\rUpdateRequest\x12\x19\n\x08\x61pp_name\x18\x01 \x01(\tR\x07\x61ppName\x12\x1f\n\x0b\x64\x65vice_name\x18\x02 \x01(\tR\ndeviceName\x12>\n\x0eprocessor_data\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\rprocessorData\"\x92\x01\n\x0eUpdateResponse\x12>\n\x0eprocessor_data\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\rprocessorData\x12@\n\x0f\x63ontroller_data\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructR\x0e\x63ontrollerData\"K\n\rDeleteRequest\x12\x19\n\x08\x61pp_name\x18\x01 \x01(\tR\x07\x61ppName\x12\x1f\n\x0b\x64\x65vice_name\x18\x02 \x01(\tR\ndeviceName\"$\n\x0e\x44\x65leteResponse\x12\x12\n\x04\x64one\x18\x01 \x01(\x08R\x04\x64one\"5\n\x12GetMetadataRequest\x12\x1f\n\x0b\x64\x65vice_name\x18\x01 \x01(\tR\ndeviceName\"J\n\x13GetMetadataResponse\x12\x33\n\x08metadata\x18\x01 \x01(\x0b\x32\x17.google.protobuf.StructR\x08metadata\"\x1e\n\x1cGetAllDevicesMetadataRequest\"V\n\x1dGetAllDevicesMetadataResponse\x12\x35\n\tmetadatas\x18\x01 \x03(\x0b\x32\x17.google.protobuf.StructR\tmetadatas2\xb0\x0c\n\x14\x44\x65viceManagerService\x12\x8b\x01\n\x06\x43reate\x12\x30.boulderopalscaleupsdk.protobuf.v1.CreateRequest\x1a\x31.boulderopalscaleupsdk.protobuf.v1.CreateResponse\"\x1c\x82\xd3\xe4\x93\x02\x16\"\x11/v1/device/create:\x01*\x12\x83\x01\n\x04\x43opy\x12..boulderopalscaleupsdk.protobuf.v1.CopyRequest\x1a/.boulderopalscaleupsdk.protobuf.v1.CopyResponse\"\x1a\x82\xd3\xe4\x93\x02\x14\"\x0f/v1/device/copy:\x01*\x12\x97\x01\n\x07GetData\x12\x31.boulderopalscaleupsdk.protobuf.v1.GetDataRequest\x1a\x32.boulderopalscaleupsdk.protobuf.v1.GetDataResponse\"%\x82\xd3\xe4\x93\x02\x1f\"\x1a/v1/device/get_device_data:\x01*\x12\x8b\x01\n\x06Update\x12\x30.boulderopalscaleupsdk.protobuf.v1.UpdateRequest\x1a\x31.boulderopalscaleupsdk.protobuf.v1.UpdateResponse\"\x1c\x82\xd3\xe4\x93\x02\x16\"\x11/v1/device/update:\x01*\x12\x8b\x01\n\x06\x44\x65lete\x12\x30.boulderopalscaleupsdk.protobuf.v1.DeleteRequest\x1a\x31.boulderopalscaleupsdk.protobuf.v1.DeleteResponse\"\x1c\x82\xd3\xe4\x93\x02\x16\"\x11/v1/device/delete:\x01*\x12\x94\x01\n\x08ListJobs\x12\x32.boulderopalscaleupsdk.protobuf.v1.ListJobsRequest\x1a\x33.boulderopalscaleupsdk.protobuf.v1.ListJobsResponse\"\x1f\x82\xd3\xe4\x93\x02\x19\"\x14/v1/device/list_jobs:\x01*\x12\x8c\x01\n\x06GetJob\x12\x30.boulderopalscaleupsdk.protobuf.v1.GetJobRequest\x1a\x31.boulderopalscaleupsdk.protobuf.v1.GetJobResponse\"\x1d\x82\xd3\xe4\x93\x02\x17\"\x12/v1/device/get_job:\x01*\x12\xa9\x01\n\rGetJobSummary\x12\x37.boulderopalscaleupsdk.protobuf.v1.GetJobSummaryRequest\x1a\x38.boulderopalscaleupsdk.protobuf.v1.GetJobSummaryResponse\"%\x82\xd3\xe4\x93\x02\x1f\"\x1a/v1/device/get_job_summary:\x01*\x12\xa7\x01\n\x0bGetMetadata\x12\x35.boulderopalscaleupsdk.protobuf.v1.GetMetadataRequest\x1a\x36.boulderopalscaleupsdk.protobuf.v1.GetMetadataResponse\")\x82\xd3\xe4\x93\x02#\"\x1e/v1/device/get_device_metadata:\x01*\x12\xd1\x01\n\x15GetAllDevicesMetadata\x12?.boulderopalscaleupsdk.protobuf.v1.GetAllDevicesMetadataRequest\x1a@.boulderopalscaleupsdk.protobuf.v1.GetAllDevicesMetadataResponse\"5\x82\xd3\xe4\x93\x02/\"*/v1/device/get_all_devices_metadata_by_org:\x01*B\xaa\x02\n%com.boulderopalscaleupsdk.protobuf.v1B\x0b\x44\x65viceProtoP\x01ZNgithub.com/qctrl/boulder-opal-scale-up/proto/boulderopalscaleupsdk/protobuf/v1\xa2\x02\x03\x42PX\xaa\x02!Boulderopalscaleupsdk.Protobuf.V1\xca\x02!Boulderopalscaleupsdk\\Protobuf\\V1\xe2\x02-Boulderopalscaleupsdk\\Protobuf\\V1\\GPBMetadata\xea\x02#Boulderopalscaleupsdk::Protobuf::V1b\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n.boulderopalscaleupsdk/protobuf/v1/device.proto\x12!boulderopalscaleupsdk.protobuf.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x1cgoogle/protobuf/struct.proto\"b\n\x12SetSnapshotRequest\x12\x1f\n\x0b\x64\x65vice_name\x18\x01 \x01(\tR\ndeviceName\x12+\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x17.google.protobuf.StructR\x04\x64\x61ta\"P\n\x13SetSnapshotResponse\x12\x1f\n\x0b\x64\x65vice_name\x18\x01 \x01(\tR\ndeviceName\x12\x18\n\x07version\x18\x02 \x01(\x05R\x07version\"O\n\x12GetSnapshotRequest\x12\x1f\n\x0b\x64\x65vice_name\x18\x01 \x01(\tR\ndeviceName\x12\x18\n\x07version\x18\x02 \x01(\x05R\x07version\"B\n\x13GetSnapshotResponse\x12+\n\x04\x64\x61ta\x18\x01 \x01(\x0b\x32\x17.google.protobuf.StructR\x04\x64\x61ta\"\x85\x01\n\rCreateRequest\x12\x19\n\x08\x61pp_name\x18\x01 \x01(\tR\x07\x61ppName\x12\x1f\n\x0b\x64\x65vice_name\x18\x02 \x01(\tR\ndeviceName\x12\x38\n\x0b\x64\x65vice_data\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\ndeviceData\"$\n\x0e\x43reateResponse\x12\x12\n\x04\x64one\x18\x01 \x01(\x08R\x04\x64one\"]\n\x0b\x43opyRequest\x12(\n\x10\x66rom_device_name\x18\x01 \x01(\tR\x0e\x66romDeviceName\x12$\n\x0eto_device_name\x18\x02 \x01(\tR\x0ctoDeviceName\"\"\n\x0c\x43opyResponse\x12\x12\n\x04\x64one\x18\x01 \x01(\x08R\x04\x64one\"L\n\x0eGetDataRequest\x12\x19\n\x08\x61pp_name\x18\x01 \x01(\tR\x07\x61ppName\x12\x1f\n\x0b\x64\x65vice_name\x18\x02 \x01(\tR\ndeviceName\"\xc6\x01\n\x0fGetDataResponse\x12>\n\x0eprocessor_data\x18\x02 \x01(\x0b\x32\x17.google.protobuf.StructR\rprocessorData\x12@\n\x0f\x63ontroller_data\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\x0e\x63ontrollerData\x12\x31\n\x07\x64\x65\x66\x63\x61ls\x18\x04 \x03(\x0b\x32\x17.google.protobuf.StructR\x07\x64\x65\x66\x63\x61ls\"\x8b\x01\n\rUpdateRequest\x12\x19\n\x08\x61pp_name\x18\x01 \x01(\tR\x07\x61ppName\x12\x1f\n\x0b\x64\x65vice_name\x18\x02 \x01(\tR\ndeviceName\x12>\n\x0eprocessor_data\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\rprocessorData\"\x92\x01\n\x0eUpdateResponse\x12>\n\x0eprocessor_data\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructR\rprocessorData\x12@\n\x0f\x63ontroller_data\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructR\x0e\x63ontrollerData\"K\n\rDeleteRequest\x12\x19\n\x08\x61pp_name\x18\x01 \x01(\tR\x07\x61ppName\x12\x1f\n\x0b\x64\x65vice_name\x18\x02 \x01(\tR\ndeviceName\"$\n\x0e\x44\x65leteResponse\x12\x12\n\x04\x64one\x18\x01 \x01(\x08R\x04\x64one\"5\n\x12GetMetadataRequest\x12\x1f\n\x0b\x64\x65vice_name\x18\x01 \x01(\tR\ndeviceName\"J\n\x13GetMetadataResponse\x12\x33\n\x08metadata\x18\x01 \x01(\x0b\x32\x17.google.protobuf.StructR\x08metadata\"\x1e\n\x1cGetAllDevicesMetadataRequest\"V\n\x1dGetAllDevicesMetadataResponse\x12\x35\n\tmetadatas\x18\x01 \x03(\x0b\x32\x17.google.protobuf.StructR\tmetadatas\"\x90\x01\n\x0bMaskRequest\x12\x44\n\x04mode\x18\x01 \x01(\x0e\x32\x30.boulderopalscaleupsdk.protobuf.v1.SelectionModeR\x04mode\x12\x1f\n\x0b\x64\x65vice_name\x18\x02 \x01(\tR\ndeviceName\x12\x1a\n\x08\x65lements\x18\x03 \x03(\tR\x08\x65lements\"\"\n\x0cMaskResponse\x12\x12\n\x04\x64one\x18\x01 \x01(\x08R\x04\x64one\"L\n\rUnmaskRequest\x12\x1f\n\x0b\x64\x65vice_name\x18\x01 \x01(\tR\ndeviceName\x12\x1a\n\x08\x65lements\x18\x02 \x03(\tR\x08\x65lements\"$\n\x0eUnmaskResponse\x12\x12\n\x04\x64one\x18\x01 \x01(\x08R\x04\x64one*a\n\rSelectionMode\x12\x1e\n\x1aSELECTION_MODE_UNSPECIFIED\x10\x00\x12\x18\n\x14SELECTION_MODE_ITEMS\x10\x01\x12\x16\n\x12SELECTION_MODE_ALL\x10\x02\x32\xb8\r\n\x14\x44\x65viceManagerService\x12\x8b\x01\n\x06\x43reate\x12\x30.boulderopalscaleupsdk.protobuf.v1.CreateRequest\x1a\x31.boulderopalscaleupsdk.protobuf.v1.CreateResponse\"\x1c\x82\xd3\xe4\x93\x02\x16\"\x11/v1/device/create:\x01*\x12\x83\x01\n\x04\x43opy\x12..boulderopalscaleupsdk.protobuf.v1.CopyRequest\x1a/.boulderopalscaleupsdk.protobuf.v1.CopyResponse\"\x1a\x82\xd3\xe4\x93\x02\x14\"\x0f/v1/device/copy:\x01*\x12\x97\x01\n\x07GetData\x12\x31.boulderopalscaleupsdk.protobuf.v1.GetDataRequest\x1a\x32.boulderopalscaleupsdk.protobuf.v1.GetDataResponse\"%\x82\xd3\xe4\x93\x02\x1f\"\x1a/v1/device/get_device_data:\x01*\x12\x8b\x01\n\x06Update\x12\x30.boulderopalscaleupsdk.protobuf.v1.UpdateRequest\x1a\x31.boulderopalscaleupsdk.protobuf.v1.UpdateResponse\"\x1c\x82\xd3\xe4\x93\x02\x16\"\x11/v1/device/update:\x01*\x12\x83\x01\n\x04Mask\x12..boulderopalscaleupsdk.protobuf.v1.MaskRequest\x1a/.boulderopalscaleupsdk.protobuf.v1.MaskResponse\"\x1a\x82\xd3\xe4\x93\x02\x14\"\x0f/v1/device/mask:\x01*\x12\x8b\x01\n\x06Unmask\x12\x30.boulderopalscaleupsdk.protobuf.v1.UnmaskRequest\x1a\x31.boulderopalscaleupsdk.protobuf.v1.UnmaskResponse\"\x1c\x82\xd3\xe4\x93\x02\x16\"\x11/v1/device/unmask:\x01*\x12\x8b\x01\n\x06\x44\x65lete\x12\x30.boulderopalscaleupsdk.protobuf.v1.DeleteRequest\x1a\x31.boulderopalscaleupsdk.protobuf.v1.DeleteResponse\"\x1c\x82\xd3\xe4\x93\x02\x16\"\x11/v1/device/delete:\x01*\x12\xa7\x01\n\x0bGetMetadata\x12\x35.boulderopalscaleupsdk.protobuf.v1.GetMetadataRequest\x1a\x36.boulderopalscaleupsdk.protobuf.v1.GetMetadataResponse\")\x82\xd3\xe4\x93\x02#\"\x1e/v1/device/get_device_metadata:\x01*\x12\xd1\x01\n\x15GetAllDevicesMetadata\x12?.boulderopalscaleupsdk.protobuf.v1.GetAllDevicesMetadataRequest\x1a@.boulderopalscaleupsdk.protobuf.v1.GetAllDevicesMetadataResponse\"5\x82\xd3\xe4\x93\x02/\"*/v1/device/get_all_devices_metadata_by_org:\x01*\x12\xa0\x01\n\x0bGetSnapshot\x12\x35.boulderopalscaleupsdk.protobuf.v1.GetSnapshotRequest\x1a\x36.boulderopalscaleupsdk.protobuf.v1.GetSnapshotResponse\"\"\x82\xd3\xe4\x93\x02\x1c\"\x17/v1/device/get_snapshot:\x01*\x12\xa0\x01\n\x0bSetSnapshot\x12\x35.boulderopalscaleupsdk.protobuf.v1.SetSnapshotRequest\x1a\x36.boulderopalscaleupsdk.protobuf.v1.SetSnapshotResponse\"\"\x82\xd3\xe4\x93\x02\x1c\"\x17/v1/device/set_snapshot:\x01*B\xaa\x02\n%com.boulderopalscaleupsdk.protobuf.v1B\x0b\x44\x65viceProtoP\x01ZNgithub.com/qctrl/boulder-opal-scale-up/proto/boulderopalscaleupsdk/protobuf/v1\xa2\x02\x03\x42PX\xaa\x02!Boulderopalscaleupsdk.Protobuf.V1\xca\x02!Boulderopalscaleupsdk\\Protobuf\\V1\xe2\x02-Boulderopalscaleupsdk\\Protobuf\\V1\\GPBMetadata\xea\x02#Boulderopalscaleupsdk::Protobuf::V1b\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -32,58 +32,66 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetData']._serialized_options = b'\202\323\344\223\002\037\"\032/v1/device/get_device_data:\001*'
   _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Update']._loaded_options = None
   _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Update']._serialized_options = b'\202\323\344\223\002\026\"\021/v1/device/update:\001*'
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Mask']._loaded_options = None
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Mask']._serialized_options = b'\202\323\344\223\002\024\"\017/v1/device/mask:\001*'
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Unmask']._loaded_options = None
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Unmask']._serialized_options = b'\202\323\344\223\002\026\"\021/v1/device/unmask:\001*'
   _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Delete']._loaded_options = None
   _globals['_DEVICEMANAGERSERVICE'].methods_by_name['Delete']._serialized_options = b'\202\323\344\223\002\026\"\021/v1/device/delete:\001*'
-  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['ListJobs']._loaded_options = None
-  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['ListJobs']._serialized_options = b'\202\323\344\223\002\031\"\024/v1/device/list_jobs:\001*'
-  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetJob']._loaded_options = None
-  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetJob']._serialized_options = b'\202\323\344\223\002\027\"\022/v1/device/get_job:\001*'
-  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetJobSummary']._loaded_options = None
-  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetJobSummary']._serialized_options = b'\202\323\344\223\002\037\"\032/v1/device/get_job_summary:\001*'
   _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetMetadata']._loaded_options = None
   _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetMetadata']._serialized_options = b'\202\323\344\223\002#\"\036/v1/device/get_device_metadata:\001*'
   _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetAllDevicesMetadata']._loaded_options = None
   _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetAllDevicesMetadata']._serialized_options = b'\202\323\344\223\002/\"*/v1/device/get_all_devices_metadata_by_org:\001*'
-  _globals['_GETJOBSUMMARYREQUEST']._serialized_start=145
-  _globals['_GETJOBSUMMARYREQUEST']._serialized_end=190
-  _globals['_GETJOBSUMMARYRESPONSE']._serialized_start=192
-  _globals['_GETJOBSUMMARYRESPONSE']._serialized_end=282
-  _globals['_GETJOBREQUEST']._serialized_start=284
-  _globals['_GETJOBREQUEST']._serialized_end=322
-  _globals['_GETJOBRESPONSE']._serialized_start=324
-  _globals['_GETJOBRESPONSE']._serialized_end=392
-  _globals['_LISTJOBSREQUEST']._serialized_start=395
-  _globals['_LISTJOBSREQUEST']._serialized_end=545
-  _globals['_LISTJOBSRESPONSE']._serialized_start=547
-  _globals['_LISTJOBSRESPONSE']._serialized_end=643
-  _globals['_CREATEREQUEST']._serialized_start=646
-  _globals['_CREATEREQUEST']._serialized_end=779
-  _globals['_CREATERESPONSE']._serialized_start=781
-  _globals['_CREATERESPONSE']._serialized_end=817
-  _globals['_COPYREQUEST']._serialized_start=819
-  _globals['_COPYREQUEST']._serialized_end=912
-  _globals['_COPYRESPONSE']._serialized_start=914
-  _globals['_COPYRESPONSE']._serialized_end=948
-  _globals['_GETDATAREQUEST']._serialized_start=950
-  _globals['_GETDATAREQUEST']._serialized_end=1026
-  _globals['_GETDATARESPONSE']._serialized_start=1029
-  _globals['_GETDATARESPONSE']._serialized_end=1227
-  _globals['_UPDATEREQUEST']._serialized_start=1230
-  _globals['_UPDATEREQUEST']._serialized_end=1369
-  _globals['_UPDATERESPONSE']._serialized_start=1372
-  _globals['_UPDATERESPONSE']._serialized_end=1518
-  _globals['_DELETEREQUEST']._serialized_start=1520
-  _globals['_DELETEREQUEST']._serialized_end=1595
-  _globals['_DELETERESPONSE']._serialized_start=1597
-  _globals['_DELETERESPONSE']._serialized_end=1633
-  _globals['_GETMETADATAREQUEST']._serialized_start=1635
-  _globals['_GETMETADATAREQUEST']._serialized_end=1688
-  _globals['_GETMETADATARESPONSE']._serialized_start=1690
-  _globals['_GETMETADATARESPONSE']._serialized_end=1764
-  _globals['_GETALLDEVICESMETADATAREQUEST']._serialized_start=1766
-  _globals['_GETALLDEVICESMETADATAREQUEST']._serialized_end=1796
-  _globals['_GETALLDEVICESMETADATARESPONSE']._serialized_start=1798
-  _globals['_GETALLDEVICESMETADATARESPONSE']._serialized_end=1884
-  _globals['_DEVICEMANAGERSERVICE']._serialized_start=1887
-  _globals['_DEVICEMANAGERSERVICE']._serialized_end=3471
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetSnapshot']._loaded_options = None
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['GetSnapshot']._serialized_options = b'\202\323\344\223\002\034\"\027/v1/device/get_snapshot:\001*'
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['SetSnapshot']._loaded_options = None
+  _globals['_DEVICEMANAGERSERVICE'].methods_by_name['SetSnapshot']._serialized_options = b'\202\323\344\223\002\034\"\027/v1/device/set_snapshot:\001*'
+  _globals['_SELECTIONMODE']._serialized_start=2016
+  _globals['_SELECTIONMODE']._serialized_end=2113
+  _globals['_SETSNAPSHOTREQUEST']._serialized_start=145
+  _globals['_SETSNAPSHOTREQUEST']._serialized_end=243
+  _globals['_SETSNAPSHOTRESPONSE']._serialized_start=245
+  _globals['_SETSNAPSHOTRESPONSE']._serialized_end=325
+  _globals['_GETSNAPSHOTREQUEST']._serialized_start=327
+  _globals['_GETSNAPSHOTREQUEST']._serialized_end=406
+  _globals['_GETSNAPSHOTRESPONSE']._serialized_start=408
+  _globals['_GETSNAPSHOTRESPONSE']._serialized_end=474
+  _globals['_CREATEREQUEST']._serialized_start=477
+  _globals['_CREATEREQUEST']._serialized_end=610
+  _globals['_CREATERESPONSE']._serialized_start=612
+  _globals['_CREATERESPONSE']._serialized_end=648
+  _globals['_COPYREQUEST']._serialized_start=650
+  _globals['_COPYREQUEST']._serialized_end=743
+  _globals['_COPYRESPONSE']._serialized_start=745
+  _globals['_COPYRESPONSE']._serialized_end=779
+  _globals['_GETDATAREQUEST']._serialized_start=781
+  _globals['_GETDATAREQUEST']._serialized_end=857
+  _globals['_GETDATARESPONSE']._serialized_start=860
+  _globals['_GETDATARESPONSE']._serialized_end=1058
+  _globals['_UPDATEREQUEST']._serialized_start=1061
+  _globals['_UPDATEREQUEST']._serialized_end=1200
+  _globals['_UPDATERESPONSE']._serialized_start=1203
+  _globals['_UPDATERESPONSE']._serialized_end=1349
+  _globals['_DELETEREQUEST']._serialized_start=1351
+  _globals['_DELETEREQUEST']._serialized_end=1426
+  _globals['_DELETERESPONSE']._serialized_start=1428
+  _globals['_DELETERESPONSE']._serialized_end=1464
+  _globals['_GETMETADATAREQUEST']._serialized_start=1466
+  _globals['_GETMETADATAREQUEST']._serialized_end=1519
+  _globals['_GETMETADATARESPONSE']._serialized_start=1521
+  _globals['_GETMETADATARESPONSE']._serialized_end=1595
+  _globals['_GETALLDEVICESMETADATAREQUEST']._serialized_start=1597
+  _globals['_GETALLDEVICESMETADATAREQUEST']._serialized_end=1627
+  _globals['_GETALLDEVICESMETADATARESPONSE']._serialized_start=1629
+  _globals['_GETALLDEVICESMETADATARESPONSE']._serialized_end=1715
+  _globals['_MASKREQUEST']._serialized_start=1718
+  _globals['_MASKREQUEST']._serialized_end=1862
+  _globals['_MASKRESPONSE']._serialized_start=1864
+  _globals['_MASKRESPONSE']._serialized_end=1898
+  _globals['_UNMASKREQUEST']._serialized_start=1900
+  _globals['_UNMASKREQUEST']._serialized_end=1976
+  _globals['_UNMASKRESPONSE']._serialized_start=1978
+  _globals['_UNMASKRESPONSE']._serialized_end=2014
+  _globals['_DEVICEMANAGERSERVICE']._serialized_start=2116
+  _globals['_DEVICEMANAGERSERVICE']._serialized_end=3836
 # @@protoc_insertion_point(module_scope)