pybricks 3.3.0a4__tar.gz → 3.3.0a5__tar.gz

{pybricks-3.3.0a4 → pybricks-3.3.0a5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pybricks
-Version: 3.3.0a4
+Version: 3.3.0a5
 Summary: Documentation and user-API stubs for Pybricks MicroPython
 Home-page: https://pybricks.com
 License: MIT

{pybricks-3.3.0a4 → pybricks-3.3.0a5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pybricks"
-version = "3.3.0a4"
+version = "3.3.0a5"
 description = "Documentation and user-API stubs for Pybricks MicroPython"
 authors = ["The Pybricks Authors <dev@pybricks.com>"]
 maintainers = ["Laurens Valk <laurens@pybricks.com>", "David Lechner <david@pybricks.com>" ]
@@ -29,10 +29,12 @@ packages = [
 [tool.poetry.dependencies]
 python = "^3.8"
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.lint.dependencies]
 black = "^22.3.0"
 doc8 = "^0.8.1"
 flake8 = "^4.0"
+
+[tool.poetry.group.doc.dependencies]
 Sphinx = { git = "https://github.com/pybricks/sphinx.git", rev = "b00124cb" }
 sphinx-rtd-theme = "^1.0.0"
 toml = "^0.10.0"

{pybricks-3.3.0a4 → pybricks-3.3.0a5}/src/pybricks/_common.py

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: MIT
-# Copyright (c) 2018-2021 The Pybricks Authors
+# Copyright (c) 2018-2023 The Pybricks Authors
 
 """Generic cross-platform module for typical devices like lights, displays,
 speakers, and batteries."""
@@ -1285,3 +1285,79 @@ class AmbientColorSensor(CommonColorSensor):
             Measured color. The color is described by a hue (0--359), a
             saturation (0--100), and a brightness value (0--100).
         """
+
+
+class BLE:
+    """
+    Bluetooth Low Energy.
+
+    .. versionadded:: 3.3
+    """
+
+    def broadcast(self, *args: Union[None, bool, int, float, str, bytes]) -> None:
+        """broadcast(data0, data1, ...)
+
+        Starts broadcasting the given data values.
+
+        Each value can be any of ``int``, ``float``, ``str`, ``bytes``,
+        ``None``, ``True``, or ``False``. The data is broadcasted on the
+        *broadcast_channel* you selected when initializing the hub.
+
+        The total data size is quite limited (26 bytes). ``None``, ``True`` and
+        ``False`` take 1 byte each. ``float`` takes 5 bytes. ``int`` takes 2 to
+        5 bytes depending on how big the number is. ``str`` and ``bytes`` take
+        the number of bytes in the object plus one extra byte.
+
+        Params:
+            args: Zero or more values to be broadcast.
+
+
+
+        .. versionadded:: 3.3
+        """
+
+    def observe(
+        self, channel: int
+    ) -> Optional[Tuple[Union[None, bool, int, float, str, bytes], ...]]:
+        """observe(channel) -> tuple | None
+
+        Retrieves the last observed data for a given channel.
+
+        Args:
+            channel (int): The channel to observe (0 to 255).
+
+        Returns:
+            A tuple of the received data or ``None`` if no recent data is
+            available.
+
+        .. tip:: Receiving data is more reliable when the hub is not connected
+            to a computer or other devices at the same time.
+
+        .. versionadded:: 3.3
+        """
+
+    def signal_strength(self, channel: int) -> int:
+        """signal_strength(channel) -> int: dBm
+
+        Gets the average signal strength in dBm for the given channel.
+
+        This is useful for detecting how near the broadcasting device is. A close
+        device may have a signal strength around -40 dBm while a far away device
+        might have a signal strength around -70 dBm.
+
+        Args:
+            channel (int): The channel number (0 to 255).
+
+        Returns:
+            The signal strength or ``-128`` if there is no recent observed data.
+
+        .. versionadded:: 3.3
+        """
+
+    def version(self) -> str:
+        """version() -> str
+
+        Gets the firmware version from the Bluetooth chip.
+
+        .. versionadded:: 3.3
+        """

{pybricks-3.3.0a4 → pybricks-3.3.0a5}/src/pybricks/hubs.py

@@ -1,7 +1,10 @@
 # SPDX-License-Identifier: MIT
-# Copyright (c) 2018-2022 The Pybricks Authors
+# Copyright (c) 2018-2023 The Pybricks Authors
 
 """LEGO® Programmable Hubs."""
+
+from typing import Sequence
+
 from . import _common
 from .ev3dev import _speaker
 from .media.ev3dev import Image as _Image
@@ -38,6 +41,25 @@ class MoveHub:
     imu = _common.SimpleAccelerometer()
     system = _common.System()
     button = _common.Keypad([_Button.CENTER])
+    ble = _common.BLE()
+
+    def __init__(
+        self, broadcast_channel: int = 0, observe_channels: Sequence[int] = []
+    ):
+        """MoveHub(broadcast_channel=0, observe_channels=[])
+
+        Arguments:
+            broadcast_channel:
+                A value from 0 to 255 indicating which channel ``hub.ble.broadcast()``
+                will use. Default is channel 0.
+            observe_channels:
+                A list of channels to listen to when ``hub.ble.observe()`` is
+                called. Listening to more channels requires more memory.
+                Default is an empty list (no channels).
+
+        .. versionchanged:: 3.3
+            Added *broadcast_channel* and *observe_channels* arguments.
+        """
 
 
 class CityHub:
@@ -49,6 +71,25 @@ class CityHub:
     light = _common.ColorLight()
     system = _common.System()
     button = _common.Keypad([_Button.CENTER])
+    ble = _common.BLE()
+
+    def __init__(
+        self, broadcast_channel: int = 0, observe_channels: Sequence[int] = []
+    ):
+        """CityHub(broadcast_channel=0, observe_channels=[])
+
+        Arguments:
+            broadcast_channel:
+                A value from 0 to 255 indicating which channel ``hub.ble.broadcast()``
+                will use. Default is channel 0.
+            observe_channels:
+                A list of channels to listen to when ``hub.ble.observe()`` is
+                called. Listening to more channels requires more memory.
+                Default is an empty list (no channels).
+
+        .. versionchanged:: 3.3
+            Added *broadcast_channel* and *observe_channels* arguments.
+        """
 
 
 class TechnicHub:
@@ -61,9 +102,16 @@ class TechnicHub:
     imu = _common.IMU()
     system = _common.System()
     button = _common.Keypad([_Button.CENTER])
+    ble = _common.BLE()
 
-    def __init__(self, top_side: Axis = Axis.Z, front_side: Axis = Axis.X):
-        """TechnicHub(top_side=Axis.Z, front_side=Axis.X)
+    def __init__(
+        self,
+        top_side: Axis = Axis.Z,
+        front_side: Axis = Axis.X,
+        broadcast_channel: int = 0,
+        observe_channels: Sequence[int] = [],
+    ):
+        """TechnicHub(top_side=Axis.Z, front_side=Axis.X, broadcast_channel=0, observe_channels=[])
 
         Initializes the hub. Optionally, specify how the hub is
         :ref:`placed in your design <robotframe>` by saying in which
@@ -75,6 +123,16 @@ class TechnicHub:
                 the hub.
             front_side (Axis): The axis that passes through the *front side* of
                 the hub.
+            broadcast_channel:
+                A value from 0 to 255 indicating which channel ``hub.ble.broadcast()``
+                will use. Default is channel 0.
+            observe_channels:
+                A list of channels to listen to when ``hub.ble.observe()`` is
+                called. Listening to more channels requires more memory.
+                Default is an empty list (no channels).
+
+        .. versionchanged:: 3.3
+            Added *broadcast_channel* and *observe_channels* arguments.
         """
 
 
@@ -89,9 +147,16 @@ class EssentialHub:
     light = _common.ColorLight()
     imu = _common.IMU()
     system = _common.System()
+    ble = _common.BLE()
 
-    def __init__(self, top_side=Axis.Z, front_side=Axis.X):
-        """__init__(top_side=Axis.Z, front_side=Axis.X)
+    def __init__(
+        self,
+        top_side: Axis = Axis.Z,
+        front_side: Axis = Axis.X,
+        broadcast_channel: int = 0,
+        observe_channels: Sequence[int] = [],
+    ):
+        """EssentialHub(top_side=Axis.Z, front_side=Axis.X, broadcast_channel=0, observe_channels=[])
 
         Initializes the hub. Optionally, specify how the hub is
         :ref:`placed in your design <robotframe>` by saying in which
@@ -103,6 +168,16 @@ class EssentialHub:
                 the hub.
             front_side (Axis): The axis that passes through the *front side* of
                 the hub.
+            broadcast_channel:
+                A value from 0 to 255 indicating which channel ``hub.ble.broadcast()``
+                will use. Default is channel 0.
+            observe_channels:
+                A list of channels to listen to when ``hub.ble.observe()`` is
+                called. Listening to more channels requires more memory.
+                Default is an empty list (no channels).
+
+        .. versionchanged:: 3.3
+            Added *broadcast_channel* and *observe_channels* arguments.
         """
         pass
 
@@ -127,9 +202,16 @@ class PrimeHub:
     speaker = _common.Speaker()
     imu = _common.IMU()
     system = _common.System()
+    ble = _common.BLE()
 
-    def __init__(self, top_side: Axis = Axis.Z, front_side: Axis = Axis.X):
-        """PrimeHub(top_side=Axis.Z, front_side=Axis.X)
+    def __init__(
+        self,
+        top_side: Axis = Axis.Z,
+        front_side: Axis = Axis.X,
+        broadcast_channel: int = 0,
+        observe_channels: Sequence[int] = [],
+    ):
+        """PrimeHub(top_side=Axis.Z, front_side=Axis.X, broadcast_channel=0, observe_channels=[])
 
         Initializes the hub. Optionally, specify how the hub is
         :ref:`placed in your design <robotframe>` by saying in which
@@ -141,6 +223,16 @@ class PrimeHub:
                 the hub.
             front_side (Axis): The axis that passes through the *front side* of
                 the hub.
+            broadcast_channel:
+                A value from 0 to 255 indicating which channel ``hub.ble.broadcast()``
+                will use. Default is channel 0.
+            observe_channels:
+                A list of channels to listen to when ``hub.ble.observe()`` is
+                called. Listening to more channels requires more memory.
+                Default is an empty list (no channels).
+
+        .. versionchanged:: 3.3
+            Added *broadcast_channel* and *observe_channels* arguments.
         """
 
 

{pybricks-3.3.0a4 → pybricks-3.3.0a5}/src/pybricks/pupdevices.py

@@ -97,7 +97,7 @@ class Remote:
             Button.RIGHT_PLUS,
         )
     )
-    addresss: Union[str, None]
+    address: Union[str, None]
 
     def __init__(self, name: Optional[str] = None, timeout: int = 10000):
         """Remote(name=None, timeout=10000)