sr-robot3 2024.0.1__py3-none-any.whl → 2025.0.0__py3-none-any.whl

sr/robot3/utils.py

@@ -2,6 +2,7 @@
 from __future__ import annotations
 
 import logging
+import os
 import signal
 import socket
 from abc import ABC, abstractmethod
@@ -14,6 +15,8 @@ from serial.tools.list_ports_common import ListPortInfo
 T = TypeVar('T')
 logger = logging.getLogger(__name__)
 
+IN_SIMULATOR = os.environ.get('WEBOTS_SIMULATOR', '') == '1'
+
 
 class BoardIdentity(NamedTuple):
     """
@@ -34,6 +37,13 @@ class BoardIdentity(NamedTuple):
     sw_version: str = ""
 
 
+class BoardInfo(NamedTuple):
+    """A container for the information about a board connection."""
+    url: str
+    serial_number: str
+    type_str: str
+
+
 class Board(ABC):
     """
     This is the base class for all boards.
@@ -228,6 +238,36 @@ def ensure_atexit_on_term() -> None:
     signal.signal(signal.SIGTERM, handle_signal)
 
 
+def get_simulator_boards(board_filter: str = '') -> list[BoardInfo]:
+    """
+    Get a list of all boards configured in the simulator.
+
+    This is used to support discovery of boards in the simulator environment.
+
+    :param board_filter: A filter to only return boards of a certain type
+    :return: A list of board connection information
+    """
+    if 'WEBOTS_ROBOT' not in os.environ:
+        return []
+
+    simulator_data = os.environ['WEBOTS_ROBOT'].splitlines()
+    simulator_boards = []
+
+    for board_data in simulator_data:
+        board_data = board_data.rstrip('/')
+        board_fragment, serial_number = board_data.rsplit('/', 1)
+        board_url, board_type = board_fragment.rsplit('/', 1)
+
+        board_info = BoardInfo(url=board_url, serial_number=serial_number, type_str=board_type)
+
+        if board_filter and board_info.type_str != board_filter:
+            continue
+
+        simulator_boards.append(board_info)
+
+    return simulator_boards
+
+
 def list_ports() -> None:
     """
     Print a list of all connected USB serial ports.

{sr_robot3-2024.0.1.dist-info → sr_robot3-2025.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sr-robot3
-Version: 2024.0.1
+Version: 2025.0.0
 Summary: Student Robotics API for Python 3
 Author-email: Student Robotics <kit-team@studentrobotics.org>
 License: MIT License
@@ -37,22 +37,24 @@ Classifier: Topic :: Education
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pyserial <4,>=3
-Requires-Dist: april-vision <3,>=2.1
-Requires-Dist: paho-mqtt <2,>=1.6
-Requires-Dist: pydantic <2,>=1.9.1
-Requires-Dist: typing-extensions ; python_version < "3.10"
+Requires-Dist: pyserial<4,>=3
+Requires-Dist: april-vision==2.2.0
+Requires-Dist: paho-mqtt<3,>=2
+Requires-Dist: pydantic<2,>=1.9.1
+Requires-Dist: typing-extensions; python_version < "3.10"
+Requires-Dist: tomli<3,>=2.0.1; python_version < "3.11"
 Provides-Extra: dev
-Requires-Dist: flake8 ; extra == 'dev'
-Requires-Dist: isort ; extra == 'dev'
-Requires-Dist: mypy ; extra == 'dev'
-Requires-Dist: build ; extra == 'dev'
-Requires-Dist: types-pyserial ; extra == 'dev'
-Requires-Dist: pytest ; extra == 'dev'
-Requires-Dist: pytest-cov ; extra == 'dev'
-Requires-Dist: types-paho-mqtt ; extra == 'dev'
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: types-pyserial; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: paho-mqtt<3,>=2; extra == "dev"
+Requires-Dist: mypy==1.10.0; python_version < "3.9" and extra == "dev"
+Requires-Dist: mypy<2,>=1.7; python_version >= "3.9" and extra == "dev"
 Provides-Extra: vision
-Requires-Dist: opencv-python-headless <5,>=4 ; extra == 'vision'
+Requires-Dist: opencv-python-headless<5,>=4; extra == "vision"
 
 # sr-robot3
 

sr_robot3-2025.0.0.dist-info/RECORD

@@ -0,0 +1,29 @@
+sr/robot3/__init__.py,sha256=lW7j65ruMEkRNJjZzp8929TefPMaMhqXzpsGPJqMkRs,1476
+sr/robot3/_version.py,sha256=-X88o2Nur4PzeUeRdAC4dP3gTVlb9JWw08awOdH4TYg,417
+sr/robot3/arduino.py,sha256=9rGsvGDb1JoHB4c7W61R16Y3eb0-UZ9TE49Qu7BJIZE,16934
+sr/robot3/astoria.py,sha256=0EIXoxvs1glkGuzLDYG7HptKucc8q7sdWAQiu96NG24,8547
+sr/robot3/camera.py,sha256=b2r8-ttQgLqbMv9BI6qWb5sHjeg4Zb5VrGo2uWMYGd8,8686
+sr/robot3/exceptions.py,sha256=A8cpuvFaIFazWSrp9QNts9ikINWymgoGALv4JAL-SU8,1381
+sr/robot3/game_specific.py,sha256=X8vLUbTRdNPZEggC6LxZzaNb9oqMly8-3PyQoD3B1ho,282
+sr/robot3/kch.py,sha256=CxMbRztCNz75Uikv3KaViV6zYlXsJuBbI6qg2AsQW4Q,12500
+sr/robot3/logging.py,sha256=1KO1yW2RP9qSUHr-i1NOMM68szxML5qJyDKtdt34uyg,3464
+sr/robot3/marker.py,sha256=6LzT59xjEFroljcDsejfcUeU-5dlDAEWbPepp-25fOY,5403
+sr/robot3/motor_board.py,sha256=6yYhz0WSLzPvAzREIYUmCLeCtc6Qwkm7hdTOPFgRZ70,11356
+sr/robot3/mqtt.py,sha256=1xKQ0uwkupURWFXrvsD75TE-GlltfbrpVNqoabgmsrc,6679
+sr/robot3/power_board.py,sha256=3Skbc7kmG1pr2K6n94POkMOXT4jzbOiYCz2cb60CWv8,17734
+sr/robot3/py.typed,sha256=dXL7b_5DnfZ_09rOcxu7D-0rT56DRm26uGUohPJOPQc,94
+sr/robot3/raw_serial.py,sha256=rdh0lyS9tJDyHbAZKyJSO8lKvdJ3-_iZzvmUSOdbo08,7368
+sr/robot3/robot.py,sha256=cqUrPFver_yAjdTPBLqPjsoliSuNdiHn7RGrpXLsuMA,15888
+sr/robot3/serial_wrapper.py,sha256=CDRVFbIILf4ahiToIHrVf02hz_GXpFeazDHdw3rGgX0,9327
+sr/robot3/servo_board.py,sha256=1GppUoqdx9wUA551bO95dEbtCGdzS10twv8OZ3S6t8U,12505
+sr/robot3/timeout.py,sha256=qBPCOwnOW9h0fLnL-peraO9RsaKWc92TcTYNgyTzo_g,2678
+sr/robot3/utils.py,sha256=dA2WyB73hnw41jLkOpk6ail7mfrW3oxKU0KrpQuHv1Y,9146
+sr/robot3/calibrations/__init__.py,sha256=TTL-lkU5tj3EszSEInRTftNvX5rsMyRUSHf12RlJ4QY,130
+sr/robot3/simulator/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sr/robot3/simulator/camera.py,sha256=thenTnlyHzHrosUg9juUSfYCs2U4dfkS7vFoto1b3_k,3138
+sr/robot3/simulator/time_server.py,sha256=MwFJM7p3vqf4balmGwIMXcCLBVJQgnq2X4gY_agalwc,2859
+sr_robot3-2025.0.0.dist-info/LICENSE,sha256=d9EjkBp2jG1JOJ3zKfKRwBtPe1nhh1VByrw4iH3A9WA,1101
+sr_robot3-2025.0.0.dist-info/METADATA,sha256=iQFR8uEwpNe7S497QqT56Pash4wDEbw2Ud0V7K6ZjJY,5322
+sr_robot3-2025.0.0.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
+sr_robot3-2025.0.0.dist-info/top_level.txt,sha256=XFzWuC7umCVdV-O6IuC9Rl0qehvEC-U34M9WJ2-2h3E,3
+sr_robot3-2025.0.0.dist-info/RECORD,,

{sr_robot3-2024.0.1.dist-info → sr_robot3-2025.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.2)
+Generator: setuptools (74.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

sr_robot3-2024.0.1.dist-info/RECORD

@@ -1,26 +0,0 @@
-sr/robot3/__init__.py,sha256=lW7j65ruMEkRNJjZzp8929TefPMaMhqXzpsGPJqMkRs,1476
-sr/robot3/_version.py,sha256=97B6f2hqYAk0gPcgMK-iH6WlH9zRXwoLvU-uET4OYWg,166
-sr/robot3/arduino.py,sha256=gFiDxGNJV0T0JPMfBzYv_CSbmfGR3ReEWKB4WYHbp4Y,14403
-sr/robot3/astoria.py,sha256=dyrK_vMFHl9F-E9sXgDGNbuW3SLcTCQzNgu_-d7uB0Q,8435
-sr/robot3/camera.py,sha256=UKvJFLGVptZLquNpGne34AaEnqw07CpH8C-gaxPdUrQ,6621
-sr/robot3/exceptions.py,sha256=A8cpuvFaIFazWSrp9QNts9ikINWymgoGALv4JAL-SU8,1381
-sr/robot3/game_specific.py,sha256=X8vLUbTRdNPZEggC6LxZzaNb9oqMly8-3PyQoD3B1ho,282
-sr/robot3/kch.py,sha256=uPdzxdbFxCS0F7UdkUsIuh7xXyKs8Jw4QpHBeVw_k-U,5413
-sr/robot3/logging.py,sha256=1KO1yW2RP9qSUHr-i1NOMM68szxML5qJyDKtdt34uyg,3464
-sr/robot3/marker.py,sha256=6LzT59xjEFroljcDsejfcUeU-5dlDAEWbPepp-25fOY,5403
-sr/robot3/motor_board.py,sha256=qfwbchUdfdZoSfeTwNuG24GR2cCmo_5vdFSkQtPIQxk,10109
-sr/robot3/mqtt.py,sha256=6JQdPlx1LpVE1g_n2hbQ2vAOUKwWrtNcZlH-F_q-0Lc,6300
-sr/robot3/power_board.py,sha256=hcz6rLxcJNPKpaIaPUOj0ddUYjJc6__JuCzndY7v1Fo,16275
-sr/robot3/py.typed,sha256=dXL7b_5DnfZ_09rOcxu7D-0rT56DRm26uGUohPJOPQc,94
-sr/robot3/raw_serial.py,sha256=rdh0lyS9tJDyHbAZKyJSO8lKvdJ3-_iZzvmUSOdbo08,7368
-sr/robot3/robot.py,sha256=K9574dDSau8F33xl4zD9PdUVDY2iHYV_hbYYck9Z6Zc,13417
-sr/robot3/serial_wrapper.py,sha256=CisWk4NhP9CWw9mKJvSTC3XJ0kJLSYM1e4smt2iuuMc,9055
-sr/robot3/servo_board.py,sha256=EUTxCXq79wGWK2CAmc3nzviGBeJpNq1F_wz-CX2FKmY,11234
-sr/robot3/timeout.py,sha256=7-DaLgS95Fvw8nndBxxVibzrZJIWficxJBE0oD8Pa2Y,1843
-sr/robot3/utils.py,sha256=SZqTmVOSY8MUdj7cQeUkLTLzxoBbOEJMocZy4C4ZmNQ,7954
-sr/robot3/calibrations/__init__.py,sha256=TTL-lkU5tj3EszSEInRTftNvX5rsMyRUSHf12RlJ4QY,130
-sr_robot3-2024.0.1.dist-info/LICENSE,sha256=d9EjkBp2jG1JOJ3zKfKRwBtPe1nhh1VByrw4iH3A9WA,1101
-sr_robot3-2024.0.1.dist-info/METADATA,sha256=iNwskOb8Xh-X3MZAbhzeIxhEi8RjfKrv0Z6s671xvIM,5177
-sr_robot3-2024.0.1.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-sr_robot3-2024.0.1.dist-info/top_level.txt,sha256=XFzWuC7umCVdV-O6IuC9Rl0qehvEC-U34M9WJ2-2h3E,3
-sr_robot3-2024.0.1.dist-info/RECORD,,