foxglove-sdk 0.16.3__cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl → 0.16.4__cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

foxglove/__init__.py

@@ -176,30 +176,26 @@ def _level_names() -> dict[str, int]:
 
 def init_notebook_buffer(context: Context | None = None) -> NotebookBuffer:
     """
-    Create a NotebookBuffer object to manage data buffering and visualization in Jupyter
-    notebooks.
-
-    The NotebookBuffer object will buffer all data logged to the provided context. When you
-    are ready to visualize the data, you can call the :meth:`show` method to display an embedded
-    Foxglove visualization widget. The widget provides a fully-featured Foxglove interface
-    directly within your Jupyter notebook, allowing you to explore multi-modal robotics data
-    including 3D scenes, plots, images, and more.
-
-    Args:
-        context: The Context used to log the messages. If no Context is provided, the global
-            context will be used. Logged messages will be buffered.
-
-    Returns:
-        NotebookBuffer: A NotebookBuffer object that can be used to manage the data buffering
-            and visualization.
-
-    Raises:
-        Exception: If the notebook extra package is not installed. Install it
-            with `pip install foxglove-sdk[notebook]`.
-
-    Note:
-        This function is only available when the `notebook` extra package
-        is installed. Install it with `pip install foxglove-sdk[notebook]`.
+    Create a NotebookBuffer object to manage data buffering and visualization in Jupyter notebooks.
+
+    The NotebookBuffer object will buffer all data logged to the provided context. When you are
+    ready to visualize the data, you can call the
+    :meth:`~notebook.notebook_buffer.NotebookBuffer.show` method to display an embedded Foxglove
+    visualization widget. The widget provides a fully-featured Foxglove interface directly within
+    your Jupyter notebook, allowing you to explore multi-modal robotics data including 3D scenes,
+    plots, images, and more.
+
+    :param context: The Context used to log the messages. If no Context is provided, the global
+        context will be used. Logged messages will be buffered.
+
+    :returns: A NotebookBuffer object that can be used to manage the data buffering and
+        visualization.
+
+    :raises Exception: If the notebook extra package is not installed. Install it with ``pip install
+        foxglove-sdk[notebook]``.
+
+    :note: This function is only available when the `notebook` extra package is installed. Install
+        it with ``pip install foxglove-sdk[notebook]``.
 
     Example:
         >>> import foxglove

foxglove/_foxglove_py/channels.pyi

@@ -24,6 +24,7 @@ from .schemas import (
     PackedElementField,
     Point2,
     Point3,
+    Point3InFrame,
     PointCloud,
     PointsAnnotation,
     Pose,
@@ -1585,6 +1586,73 @@ class Point3Channel:
         """Log a Foxglove Point3 message on the channel."""
         ...
 
+class Point3InFrameChannel:
+    """
+    A channel for logging Point3InFrame messages
+
+    You should choose a unique topic name per channel.
+    """
+
+    def __init__(
+        self,
+        topic: str,
+        *,
+        metadata: dict[str, str] | None = None,
+        context: Context | None = None,
+    ) -> None: ...
+    def id(self) -> int:
+        """The unique ID of the channel."""
+        ...
+
+    def topic(self) -> str:
+        """The topic name of the channel."""
+        ...
+
+    @property
+    def message_encoding(self) -> str:
+        """The message encoding for the channel"""
+        ...
+
+    def metadata(self) -> dict[str, str]:
+        """
+        Returns a copy of the channel's metadata.
+
+        Note that changes made to the returned dictionary will not be applied to
+        the channel's metadata.
+        """
+        ...
+
+    def schema(self) -> Schema | None:
+        """
+        Returns a copy of the channel's schema.
+
+        Note that changes made to the returned object will not be applied to
+        the channel's schema.
+        """
+        ...
+
+    def schema_name(self) -> str | None:
+        """The name of the schema for the channel."""
+        ...
+
+    def has_sinks(self) -> bool:
+        """Returns true if at least one sink is subscribed to this channel"""
+        ...
+
+    def close(self) -> None:
+        """Close the channel."""
+        ...
+
+    def log(
+        self,
+        message: "Point3InFrame",
+        *,
+        log_time: int | None = None,
+        sink_id: int | None = None,
+    ) -> None:
+        """Log a Foxglove Point3InFrame message on the channel."""
+        ...
+
 class PointCloudChannel:
     """
     A channel for logging PointCloud messages

foxglove/_foxglove_py/schemas.pyi

@@ -567,6 +567,27 @@ class Point3:
         """Encodes the Point3."""
         ...
 
+class Point3InFrame:
+    """
+    A timestamped point for a position in 3D space
+    """
+
+    def __init__(
+        self,
+        *,
+        timestamp: Timestamp | None = None,
+        frame_id: str = "",
+        point: Point3 | None = None,
+    ) -> None: ...
+    @staticmethod
+    def get_schema() -> Schema:
+        """Returns the Point3InFrame schema"""
+        ...
+
+    def encode(self) -> bytes:
+        """Encodes the Point3InFrame."""
+        ...
+
 class PointCloud:
     """
     A collection of N-dimensional points, which may contain additional fields with information like normals, intensity, etc.
@@ -992,6 +1013,7 @@ FoxgloveSchema = Union[
     PackedElementField,
     Point2,
     Point3,
+    Point3InFrame,
     PointCloud,
     PointsAnnotation,
     Pose,

foxglove/channel.py

@@ -35,7 +35,7 @@ class Channel:
         Create a new channel for logging messages on a topic.
 
         :param topic: The topic name. You should choose a unique topic name per channel.
-        :param message_encoding: The message encoding. Optional if :py:param:`schema` is a
+        :param message_encoding: The message encoding. Optional if :any:`schema` is a
             dictionary, in which case the message encoding is presumed to be "json".
         :param schema: A definition of your schema. Pass a :py:class:`Schema` for full control. If a
             dictionary is passed, it will be treated as a JSON schema.

foxglove/channels/__init__.py

@@ -29,6 +29,7 @@ from foxglove._foxglove_py.channels import (
     PackedElementFieldChannel,
     Point2Channel,
     Point3Channel,
+    Point3InFrameChannel,
     PointCloudChannel,
     PointsAnnotationChannel,
     PoseChannel,
@@ -73,6 +74,7 @@ __all__ = [
     "PackedElementFieldChannel",
     "Point2Channel",
     "Point3Channel",
+    "Point3InFrameChannel",
     "PointCloudChannel",
     "PointsAnnotationChannel",
     "PoseChannel",

foxglove/layouts/__init__.py

@@ -0,0 +1,17 @@
+"""
+This module defines types for programmatically constructing Foxglove `layouts <https://docs.foxglove.dev/docs/visualization/layouts>`_.
+
+This API is currently experimental and not ready for public use.
+"""
+
+
+class Layout:
+    """A Foxglove layout
+
+    :raises NotImplementedError: This class is currently experimental and not ready for public use.
+    """
+
+    def to_json(self) -> str:
+        raise NotImplementedError(
+            "This class is currently experimental and not ready for public use."
+        )

foxglove/notebook/foxglove_widget.py

@@ -1,24 +1,19 @@
 from __future__ import annotations
 
 import pathlib
-from typing import TYPE_CHECKING, Any, Literal
+from typing import TYPE_CHECKING, Literal
 
 import anywidget
 import traitlets
 
 if TYPE_CHECKING:
+    from ..layouts import Layout
     from .notebook_buffer import NotebookBuffer
 
 
 class FoxgloveWidget(anywidget.AnyWidget):
     """
     A widget that displays a Foxglove viewer in a notebook.
-
-    :param buffer: The NotebookBuffer object that contains the data to display in the widget.
-    :param layout_storage_key: The storage key of the layout to use for the widget.
-    :param width: The width of the widget. Defaults to "full".
-    :param height: The height of the widget in pixels. Defaults to 500.
-    :param src: The source URL of the Foxglove viewer. Defaults to "https://embed.foxglove.dev/".
     """
 
     _esm = pathlib.Path(__file__).parent / "static" / "widget.js"
@@ -27,26 +22,25 @@ class FoxgloveWidget(anywidget.AnyWidget):
     ).tag(sync=True)
     height = traitlets.Int(default_value=500).tag(sync=True)
     src = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
-    _layout_params = traitlets.Dict(
-        per_key_traits={
-            "storage_key": traitlets.Unicode(),
-            "opaque_layout": traitlets.Dict(allow_none=True, default_value=None),
-            "force": traitlets.Bool(False),
-        },
-        allow_none=True,
-        default_value=None,
-    ).tag(sync=True)
+    _layout = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
 
     def __init__(
         self,
+        *,
         buffer: NotebookBuffer,
-        layout_storage_key: str,
         width: int | Literal["full"] | None = None,
         height: int | None = None,
         src: str | None = None,
-        **kwargs: Any,
+        layout: Layout | None = None,
     ):
-        super().__init__(**kwargs)
+        """
+        :param buffer: The NotebookBuffer object that contains the data to display in the widget.
+        :param width: The width of the widget. Defaults to "full".
+        :param height: The height of the widget in pixels. Defaults to 500.
+        :param src: The source URL of the Foxglove viewer. Defaults to
+            "https://embed.foxglove.dev/".
+        """
+        super().__init__()
         if width is not None:
             self.width = width
         else:
@@ -56,7 +50,8 @@ class FoxgloveWidget(anywidget.AnyWidget):
         if src is not None:
             self.src = src
 
-        self.select_layout(layout_storage_key, **kwargs)
+        if layout is not None:
+            self._layout = layout.to_json()
 
         # Callback to get the data to display in the widget
         self._buffer = buffer
@@ -67,25 +62,12 @@ class FoxgloveWidget(anywidget.AnyWidget):
         self.on_msg(self._handle_custom_msg)
         self.refresh()
 
-    def select_layout(self, storage_key: str, **kwargs: Any) -> None:
-        """
-        Select a layout in the Foxglove viewer.
-        """
-        opaque_layout = kwargs.get("opaque_layout", None)
-        force_layout = kwargs.get("force_layout", False)
-
-        self._layout_params = {
-            "storage_key": storage_key,
-            "opaque_layout": opaque_layout if isinstance(opaque_layout, dict) else None,
-            "force": force_layout,
-        }
-
     def refresh(self) -> None:
         """
         Refresh the widget by getting the data from the callback function and sending it
         to the widget.
         """
-        data = self._buffer.get_data()
+        data = self._buffer._get_data()
         if not self._ready:
             self._pending_data = data
         else:

foxglove/notebook/notebook_buffer.py

@@ -3,11 +3,12 @@ from __future__ import annotations
 import os
 import uuid
 from tempfile import TemporaryDirectory
-from typing import Any, Literal
+from typing import Literal
 
 from mcap.reader import make_reader
 
 from .._foxglove_py import Context, open_mcap
+from ..layouts import Layout
 from .foxglove_widget import FoxgloveWidget
 
 
@@ -20,14 +21,14 @@ class NotebookBuffer:
     Foxglove visualization widget. The widget provides a fully-featured Foxglove interface
     directly within your Jupyter notebook, allowing you to explore multi-modal robotics data
     including 3D scenes, plots, images, and more.
-
-    :param context: The Context used to log the messages. If no Context is provided, the global
-        context will be used. Logged messages will be buffered.
     """
 
-    def __init__(self, context: Context | None = None):
+    def __init__(self, *, context: Context | None = None):
         """
         Initialize a new NotebookBuffer for collecting logged messages.
+
+        :param context: The Context used to log the messages. If no Context is provided, the global
+            context will be used. Logged messages will be buffered.
         """
         # We need to keep the temporary directory alive until the writer is closed
         self._temp_directory = TemporaryDirectory()
@@ -37,11 +38,11 @@ class NotebookBuffer:
 
     def show(
         self,
-        layout_storage_key: str,
+        *,
         width: int | Literal["full"] | None = None,
         height: int | None = None,
         src: str | None = None,
-        **kwargs: Any,
+        layout: Layout | None = None,
     ) -> FoxgloveWidget:
         """
         Show the Foxglove viewer. Call this method as the last step of a notebook cell
@@ -52,8 +53,7 @@ class NotebookBuffer:
             width=width,
             height=height,
             src=src,
-            layout_storage_key=layout_storage_key,
-            **kwargs,
+            layout=layout,
         )
         return widget
 
@@ -70,7 +70,7 @@ class NotebookBuffer:
         self._temp_directory = TemporaryDirectory()
         self._create_writer()
 
-    def get_data(self) -> list[bytes]:
+    def _get_data(self) -> list[bytes]:
         """
         Retrieve all collected data.
         """

foxglove/schemas/__init__.py

@@ -40,6 +40,7 @@ from foxglove._foxglove_py.schemas import (
     PackedElementFieldNumericType,
     Point2,
     Point3,
+    Point3InFrame,
     PointCloud,
     PointsAnnotation,
     PointsAnnotationType,
@@ -88,6 +89,7 @@ FoxgloveSchema = Union[
     PackedElementField,
     Point2,
     Point3,
+    Point3InFrame,
     PointCloud,
     PointsAnnotation,
     Pose,
@@ -139,6 +141,7 @@ __all__ = [
     "PackedElementFieldNumericType",
     "Point2",
     "Point3",
+    "Point3InFrame",
     "PointCloud",
     "PointsAnnotation",
     "PointsAnnotationType",

{foxglove_sdk-0.16.3.dist-info → foxglove_sdk-0.16.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: foxglove-sdk
-Version: 0.16.3
+Version: 0.16.4
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Rust
 Requires-Dist: anywidget ; extra == 'notebook'

{foxglove_sdk-0.16.3.dist-info → foxglove_sdk-0.16.4.dist-info}/RECORD

@@ -1,22 +1,23 @@
-foxglove/__init__.py,sha256=utf_uU_ViL7xDrTqheP6JGs3ezfPsnve2EXFdS0uq-A,8490
+foxglove/__init__.py,sha256=AXj9sq9K8_YCgkDDtyyw0bUSsuCpDg7gjzmgTvIUyI0,8478
 foxglove/_foxglove_py/__init__.pyi,sha256=Ppw0LllCD5Jos1ZGPwEefRFJXVEj9ZWd_Nez2hUYjSs,6072
-foxglove/_foxglove_py/channels.pyi,sha256=c3WXhK5FfeCJ1aDGB-AsayIossnC8v8qFij0XWl1AEA,67327
+foxglove/_foxglove_py/channels.pyi,sha256=UfltAzsnYnukOD5aUi_3iFrMNkRQ0CireBsEO-Q2DjY,68973
 foxglove/_foxglove_py/cloud.pyi,sha256=9Hqj7b9S2CTiWeWOIqaAw3GSmR-cGoSL4R7fi5WI-QA,255
 foxglove/_foxglove_py/mcap.pyi,sha256=yh3RDXNiqSN5URCQF0efxezmWldvdQk_VHlW-clS0Cw,4936
-foxglove/_foxglove_py/schemas.pyi,sha256=oVF6fwYlgoZ8a1FmlLhVgCYbz-ueM52NyuuTtwhGuFc,23092
+foxglove/_foxglove_py/schemas.pyi,sha256=7KfRHDMIbwOxsRLMdweMsH_qXiSySmKrVo82dutcjtw,23566
 foxglove/_foxglove_py/schemas_wkt.pyi,sha256=_nHeIdbOKMgPeL5V360-vZXCnEtyRIFzEd_JVsK49qo,2065
 foxglove/_foxglove_py/websocket.pyi,sha256=NuCIpXp9P2bPNLyvjVYqcaeL71wKRyYB6RbTfkE6X7A,10511
-foxglove/_foxglove_py.cpython-312-aarch64-linux-gnu.so,sha256=wR2OWmMU5uQJgyXfvPqEAw4FYo227AEb_ZHEO7K3yKM,6461552
+foxglove/_foxglove_py.cpython-312-aarch64-linux-gnu.so,sha256=F5odzTQmvOk7S0PJtYRNcV_JOlg3NjbKdSsKGT9uvRY,6513304
 foxglove/benchmarks/test_mcap_serialization.py,sha256=Ab_J2Mz8Vya5ZD8Yypp2jdfhaOCxYW7hw5fos7LyFXk,4682
-foxglove/channel.py,sha256=MRiiOm09ZNATOvVCFuvn19KB9HkVCtsDTJYiqE7LQlA,8452
-foxglove/channels/__init__.py,sha256=qTr5-HKlr4e386onX9OiYBPWUsS1n2vO23PncL0TiPY,2398
+foxglove/channel.py,sha256=N9jUQXhD-wZq1lnZbRlNUPgBb79CiDksTeFYwTnAY6Y,8447
+foxglove/channels/__init__.py,sha256=DOdeiFZ0bSquutHtkVxtmQmX78eiDfTmIl-OdVc7Btg,2452
 foxglove/cloud.py,sha256=eOHV8ZCnut59uBLiw1c5MiwbIALeVwPzxo2Yb-2jbII,1942
+foxglove/layouts/__init__.py,sha256=iC2-pMCrwGKkGWHzAsAbADONmL-tI3Rh_GT1AAfP6YI,517
 foxglove/mcap.py,sha256=LR9TSyRlDWuHZpXR8iglmDp-S-4BRqgmvTOiUKHwlsA,200
 foxglove/notebook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-foxglove/notebook/foxglove_widget.py,sha256=mOXElZLZSIQfvzbZfMd2jtvmWA-H4Z8j7fa39Vwns34,3418
-foxglove/notebook/notebook_buffer.py,sha256=ooQIb8xcyNeuCoRm7CL0Uhnh9VPcd41YMUNYRu15FYg,3801
+foxglove/notebook/foxglove_widget.py,sha256=o-X47mFMU_WxZqNQxKMGQUFXWrqdSeUB_TYrwqXY4WM,2715
+foxglove/notebook/notebook_buffer.py,sha256=o-m1coYMluqusBIeSAIvfSLaJQyMx7yRTGZzLX6vByw,3784
 foxglove/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-foxglove/schemas/__init__.py,sha256=bqYBLc0HXRe-BMRP3VnF9IUB2yKYsvku3pZnulss3GY,3232
+foxglove/schemas/__init__.py,sha256=Jd-tsarhV55ZsK4z75-6BUAqINxoNkeyYLnwWZjmfW4,3291
 foxglove/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 foxglove/tests/test_channel.py,sha256=coIPG-P_8Uczhw2-zRo4FoanlkReiE1CKUppM9mO1oE,7146
 foxglove/tests/test_context.py,sha256=OvtvjzsRaZZHPT0RyRkwrpBip-7uLaxVPwlu2RJ12yY,256
@@ -27,6 +28,6 @@ foxglove/tests/test_schemas.py,sha256=4empQg8gqS7MD63ibU3kdQgJUSsUpnNQQWQ7oAf-4x
 foxglove/tests/test_server.py,sha256=rR50x21OOUMVuyYmYqiRTxOrgJFyL4ZL9W4pOshfAFc,3795
 foxglove/tests/test_time.py,sha256=By_sM5r87s9iu4Df12r6p9DJrzTeZSLys3XGUGhvUps,4661
 foxglove/websocket.py,sha256=PvsSGmWFayjRV20u86ZEZ9zcUD7nBC9j6CKPWNZy5ks,6331
-foxglove_sdk-0.16.3.dist-info/METADATA,sha256=-R_TiQnJptVFk1IqvoAQ10Fbk0wSm17dC-gEUe8MPDw,1716
-foxglove_sdk-0.16.3.dist-info/WHEEL,sha256=52Zi36pDPQlOrLthVvXF6f11TX-HRQ2sllWxsSJsrtQ,149
-foxglove_sdk-0.16.3.dist-info/RECORD,,
+foxglove_sdk-0.16.4.dist-info/METADATA,sha256=fkqCQDIXd4Is1uADW2P_0G0aAtHJmpq0_u4tmKZe_xg,1716
+foxglove_sdk-0.16.4.dist-info/WHEEL,sha256=52Zi36pDPQlOrLthVvXF6f11TX-HRQ2sllWxsSJsrtQ,149
+foxglove_sdk-0.16.4.dist-info/RECORD,,