pyobs-brot 2.0.0.dev12__tar.gz → 2.0.0.dev14__tar.gz

{pyobs_brot-2.0.0.dev12 → pyobs_brot-2.0.0.dev14}/.github/dependabot.yml

@@ -6,5 +6,10 @@ updates:
       interval: "weekly"
       day: "tuesday"
     target-branch: "develop"
+    groups:
+      patch-and-minor:
+        update-types:
+          - "minor"
+          - "patch"
     labels:
       - "dependencies"

pyobs_brot-2.0.0.dev14/.github/workflows/pyrefly.yml

@@ -0,0 +1,23 @@
+name: pyrefly
+on: push
+
+jobs:
+  pyrefly:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: "3.13"
+
+      - name: Install packages
+        run: uv sync --all-extras --dev
+
+      - name: Run pyrefly
+        run: uv run pyrefly check

pyobs_brot-2.0.0.dev14/.github/workflows/pytest.yml

@@ -0,0 +1,25 @@
+name: PyTest
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: "3.13"
+
+      - name: Install packages
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: uv run pytest tests
+        env:
+          CI: true

{pyobs_brot-2.0.0.dev12 → pyobs_brot-2.0.0.dev14}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: pyobs-brot
-Version: 2.0.0.dev12
+Version: 2.0.0.dev14
 Summary: pyobs module for BROTlib telescopes
 Author-email: Tim-Oliver Husser <thusser@uni-goettingen.de>, Lukas Melzig <lukas.melzig@stud.uni-goettingen.de>
 License-Expression: MIT
@@ -9,4 +9,4 @@ Requires-Python: >=3.11
 Requires-Dist: astropy<8,>=7.0.1
 Requires-Dist: paho-mqtt>=2.1.0
 Requires-Dist: pybrotlib>=1.1.5
-Requires-Dist: pyobs-core<3,>=2.0.0.dev20
+Requires-Dist: pyobs-core<3,>=2.0.0.dev48

{pyobs_brot-2.0.0.dev12 → pyobs_brot-2.0.0.dev14}/pyobs_brot/brotdome.py

@@ -76,6 +76,10 @@ class BrotDome(BaseDome, IDome):
 
     @timeout(300)
     async def init(self, **kwargs: Any) -> None:
+        # weather?
+        if not self.is_weather_good():
+            raise exc.InitError("Weather seems to be bad.")
+
         log.info("Opening roof")
         if self.brot.dome.shutter == DomeShutterStatus.OPEN:
             return

{pyobs_brot-2.0.0.dev12 → pyobs_brot-2.0.0.dev14}/pyobs_brot/brotroof.py

@@ -60,6 +60,10 @@ class BrotRoof(BaseRoof):
 
     @timeout(300)
     async def init(self, **kwargs: Any) -> None:
+        # weather?
+        if not self.is_weather_good():
+            raise exc.InitError("Weather seems to be bad.")
+
         log.info("Opening roof")
         if self.brot.roof.status == RoofStatus.OPEN:
             return

{pyobs_brot-2.0.0.dev12 → pyobs_brot-2.0.0.dev14}/pyobs_brot/brottelescope.py

@@ -95,6 +95,10 @@ class BrotBaseTelescope(
         await self.comm.set_state(IOffsetsRaDec, RaDecOffsetState(ra=0.0, dec=0.0))
         await self.comm.set_state(IOffsetsAltAz, AltAzOffsetState(alt=0.0, az=0.0))
 
+        # placeholder -- real readings only exist once the MQTT client has had a chance to
+        # receive telemetry, which _update_task() (started above) hasn't had time to do yet
+        await self.comm.set_state(ITemperatures, TemperaturesState(readings=[]))
+
     async def close(self) -> None:
         await BaseTelescope.close(self)
         await self.mqtt.close()
@@ -238,6 +242,10 @@ class BrotBaseTelescope(
 
     @timeout(120)
     async def init(self, **kwargs: Any) -> None:
+        # weather?
+        if not self.is_weather_good():
+            raise exc.InitError("Weather seems to be bad.")
+
         match self.brot.telescope.status:
             case TelescopeStatus.PARKED:
                 pass
@@ -324,8 +332,8 @@ class BrotRaDecTelescope(BrotBaseTelescope, IOffsetsRaDec):
         await self.brot.telescope.set_offset_dec(ddec * 3600)
         MAX_TARGET_DISTANCE = 2.0 / 3600.0
         while (
-            self.brot.telescope._telemetry.POSITION.INSTRUMENTAL.HA.TARGETDISTANCE < MAX_TARGET_DISTANCE
-            and self.brot.telescope._telemetry.POSITION.INSTRUMENTAL.DEC.TARGETDISTANCE < MAX_TARGET_DISTANCE
+            self.brot.telescope._telemetry.POSITION.INSTRUMENTAL.HA.TARGETDISTANCE > MAX_TARGET_DISTANCE
+            or self.brot.telescope._telemetry.POSITION.INSTRUMENTAL.DEC.TARGETDISTANCE > MAX_TARGET_DISTANCE
         ):
             await asyncio.sleep(0.1)
         await self.comm.set_state(IOffsetsRaDec, RaDecOffsetState(ra=dra, dec=ddec))

{pyobs_brot-2.0.0.dev12 → pyobs_brot-2.0.0.dev14}/pyproject.toml

@@ -1,23 +1,25 @@
 [project]
 name = "pyobs-brot"
-version = "2.0.0.dev12"
+version = "2.0.0.dev14"
 description = "pyobs module for BROTlib telescopes"
 authors = [{ name = "Tim-Oliver Husser", email = "thusser@uni-goettingen.de" }, { name = "Lukas Melzig", email = "lukas.melzig@stud.uni-goettingen.de" }]
 requires-python = ">=3.11"
 license = "MIT"
 dependencies = [
     "astropy>=7.0.1,<8",
-    "pyobs-core>=2.0.0.dev20,<3",
+    "pyobs-core>=2.0.0.dev48,<3",
     "paho-mqtt>=2.1.0",
     "pybrotlib>=1.1.5",
 ]
 
 [dependency-groups]
 dev = [
-    "black>=23.7.0,<24",
+    "black>=23.7.0,<27",
     "ruff>=0.9.0",
     "pyrefly>=1.1.1",
     "pre-commit>=3.3.3,<5",
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.24.0",
 ]
 
 [build-system]
@@ -37,3 +39,6 @@ select = ["E", "F", "W", "I", "UP", "G"]
 
 [tool.pyrefly]
 python-version = "3.11"
+
+[tool.pytest.ini_options]
+asyncio_mode = "strict"

pyobs_brot-2.0.0.dev14/specs/index.md

@@ -0,0 +1,17 @@
+# Design/planning docs
+
+This repo has no `specs/` structure of its own. Design docs, implementation plans, and ADRs that
+concern `pyobs-brot` — including ones actually implemented here — live in `pyobs-core`'s `specs/`
+tree instead (`specs/design/`, `specs/plans/`, `specs/adrs/`), each tagged with a `Repos:` line
+naming every repo it concerns. See `pyobs-core/CLAUDE.md`'s "Cross-repo docs" section.
+
+Relevant so far:
+
+- `pyobs-core/specs/plans/ejabberd-throughput-benchmarking.md` — XMPP/ejabberd throughput
+  benchmarking, including a production incident investigation involving `BrotDome`/
+  `BrotRaDecTelescope` on `pyobs-iag50` (disco#info capability fetches silently timing out after a
+  few modules restart together) and the `pybrotlib` `MQTTTransport.run()` event-loop-starvation fix
+  found along the way.
+- `pyobs-core/specs/plans/enforce-state-publishing.md` — the state-publishing convention every
+  `Module` follows; `BrotRaDecTelescope`'s `ITemperatures` state had the same gap this doc's
+  convention exists to catch (2026-07-27 addendum).

pyobs_brot-2.0.0.dev14/tests/test_brotroof.py

@@ -0,0 +1,34 @@
+"""Unit tests for the roof-status -> motion-status mapping in BrotRoof.
+
+The BROT/MQTT backend is mocked out; only the state mapping is exercised.
+"""
+
+from unittest.mock import MagicMock
+
+import pytest
+from pybrotlib.components.roof import RoofStatus
+from pyobs.utils.enums import MotionStatus
+
+from pyobs_brot import BrotRoof
+
+
+@pytest.mark.parametrize(
+    ("status", "expected"),
+    [
+        (RoofStatus.ERROR, MotionStatus.ERROR),
+        (RoofStatus.CLOSED, MotionStatus.PARKED),
+        (RoofStatus.OPENING, MotionStatus.INITIALIZING),
+        (RoofStatus.CLOSING, MotionStatus.PARKING),
+        (RoofStatus.OPEN, MotionStatus.POSITIONED),
+        (RoofStatus.STOPPED, MotionStatus.IDLE),
+    ],
+)
+@pytest.mark.asyncio
+async def test_update_status_mapping(status: RoofStatus, expected: MotionStatus) -> None:
+    roof = BrotRoof(host="localhost", name="roof")
+    roof.brot.roof = MagicMock()
+    roof.brot.roof.status = status
+
+    await roof._update_status()
+
+    assert roof.motion_status() == expected

pyobs_brot-2.0.0.dev14/tests/test_brottelescope.py

@@ -0,0 +1,109 @@
+"""Unit tests for the non-hardware logic in the BROT telescope drivers: constructor
+state, focus-offset composition, and the RA/Dec offset scaling + convergence wait.
+
+The BROT/MQTT backend (self.brot) is mocked out; hardware I/O itself is out of scope.
+"""
+
+from types import SimpleNamespace
+from typing import Any
+from unittest.mock import AsyncMock, MagicMock
+
+import pytest
+from pyobs.interfaces import IFocuser, IOffsetsRaDec
+
+from pyobs_brot import BrotRaDecTelescope
+
+
+def test_constructor_defaults() -> None:
+    telescope = BrotRaDecTelescope(host="localhost", name="telescope")
+    assert telescope.temperatures == {}
+    assert telescope.focus_offset == 0.0
+    assert telescope._roof == "None"
+
+
+def test_constructor_temperatures_and_roof() -> None:
+    telescope = BrotRaDecTelescope(
+        host="localhost",
+        name="telescope",
+        temperatures={"ccd": "T1"},
+        roof="some-roof",
+    )
+    assert telescope.temperatures == {"ccd": "T1"}
+    assert telescope._roof == "some-roof"
+
+
+@pytest.mark.asyncio
+async def test_set_focus_offset_composes_and_publishes() -> None:
+    telescope = BrotRaDecTelescope(host="localhost", name="telescope")
+    telescope.brot.focus = MagicMock()
+    telescope.brot.focus.position = 10.0
+    telescope.brot.focus.set = AsyncMock()
+    telescope._wait_for_focus = AsyncMock()  # type: ignore[method-assign]
+    telescope.comm.set_state = AsyncMock()  # type: ignore[method-assign]
+
+    await telescope.set_focus_offset(0.25)
+
+    # the hardware call adds the offset onto the current position...
+    telescope.brot.focus.set.assert_awaited_once_with(10.25)
+    assert telescope.focus_offset == 0.25
+
+    # ...and the published focus subtracts the offset back out of the new position
+    assert telescope.comm.set_state.await_args is not None
+    interface, state = telescope.comm.set_state.await_args.args
+    assert interface is IFocuser
+    assert (state.focus, state.focus_offset) == (9.75, 0.25)
+
+
+def _telemetry(ha_dist: float, dec_dist: float) -> Any:
+    return SimpleNamespace(
+        POSITION=SimpleNamespace(
+            INSTRUMENTAL=SimpleNamespace(
+                HA=SimpleNamespace(TARGETDISTANCE=ha_dist),
+                DEC=SimpleNamespace(TARGETDISTANCE=dec_dist),
+            )
+        )
+    )
+
+
+@pytest.mark.asyncio
+async def test_set_offsets_radec_sends_scaled_and_sign_flipped_offsets() -> None:
+    telescope = BrotRaDecTelescope(host="localhost", name="telescope")
+    telescope.brot.telescope.set_offset_ha = AsyncMock()  # type: ignore[method-assign]
+    telescope.brot.telescope.set_offset_dec = AsyncMock()  # type: ignore[method-assign]
+    telescope.brot.telescope._telemetry = _telemetry(0.0, 0.0)  # already converged
+    telescope.comm.set_state = AsyncMock()  # type: ignore[method-assign]
+
+    await telescope.set_offsets_radec(0.001, 0.002)
+
+    # HA is sign-flipped (RA east is HA west) and both are scaled deg -> arcsec
+    telescope.brot.telescope.set_offset_ha.assert_awaited_once_with(-3.6)
+    telescope.brot.telescope.set_offset_dec.assert_awaited_once_with(7.2)
+    assert telescope.comm.set_state.await_args is not None
+    interface, state = telescope.comm.set_state.await_args.args
+    assert interface is IOffsetsRaDec
+    assert (state.ra, state.dec) == (0.001, 0.002)
+
+
+@pytest.mark.asyncio
+async def test_set_offsets_radec_waits_until_both_axes_converge(monkeypatch: pytest.MonkeyPatch) -> None:
+    telescope = BrotRaDecTelescope(host="localhost", name="telescope")
+    telescope.brot.telescope.set_offset_ha = AsyncMock()  # type: ignore[method-assign]
+    telescope.brot.telescope.set_offset_dec = AsyncMock()  # type: ignore[method-assign]
+    telescope.comm.set_state = AsyncMock()  # type: ignore[method-assign]
+
+    # still slewing for two polls (HA, then DEC, still off-target), converged on the third
+    readings = [(1.0, 1.0), (1.0, 0.0), (0.0, 0.0)]
+    telescope.brot.telescope._telemetry = _telemetry(*readings[0])
+
+    sleep_calls = 0
+
+    async def fake_sleep(_seconds: float) -> None:
+        nonlocal sleep_calls
+        sleep_calls += 1
+        telescope.brot.telescope._telemetry = _telemetry(*readings[sleep_calls])
+
+    monkeypatch.setattr("pyobs_brot.brottelescope.asyncio.sleep", fake_sleep)
+
+    await telescope.set_offsets_radec(0.001, 0.002)
+
+    assert sleep_calls == 2

pyobs_brot-2.0.0.dev14/tests/test_import.py

@@ -0,0 +1,49 @@
+"""Smoke tests: import every public module and instantiate each driver class without
+hardware, asserting the interfaces they claim.
+
+pybrotlib is a pure-Python MQTT client that connects at connect() time, not at
+construction, so instantiation is safe with no broker running.
+"""
+
+from pyobs.interfaces import (
+    IDome,
+    IFocuser,
+    IOffsetsAltAz,
+    IOffsetsRaDec,
+    IPointingAltAz,
+    IPointingRaDec,
+    IRoof,
+    ITemperatures,
+)
+from pyobs.modules import Module
+
+from pyobs_brot import BrotDome, BrotRaDecTelescope, BrotRoof
+from pyobs_brot.brottelescope import BrotAltAzTelescope
+
+
+def test_instantiate_dome() -> None:
+    dome = BrotDome(host="localhost", name="dome")
+    assert isinstance(dome, Module)
+    assert isinstance(dome, IDome)
+
+
+def test_instantiate_roof() -> None:
+    roof = BrotRoof(host="localhost", name="roof")
+    assert isinstance(roof, Module)
+    assert isinstance(roof, IRoof)
+
+
+def test_instantiate_radec_telescope() -> None:
+    telescope = BrotRaDecTelescope(host="localhost", name="telescope")
+    assert isinstance(telescope, Module)
+    assert isinstance(telescope, IFocuser)
+    assert isinstance(telescope, ITemperatures)
+    assert isinstance(telescope, IPointingRaDec)
+    assert isinstance(telescope, IPointingAltAz)
+    assert isinstance(telescope, IOffsetsRaDec)
+
+
+def test_instantiate_altaz_telescope() -> None:
+    telescope = BrotAltAzTelescope(host="localhost", name="telescope")
+    assert isinstance(telescope, Module)
+    assert isinstance(telescope, IOffsetsAltAz)