pyobs-brot 0.0.1__tar.gz

pyobs_brot-0.0.1/.gitignore

@@ -0,0 +1,165 @@
+# https://github.com/github/gitignore/blob/main/Python.gitignore
+
+*.yaml
+*.yml
+
+#Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/

pyobs_brot-0.0.1/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2022 Tim-Oliver Husser
+thusser@uni-goettingen.de
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyobs_brot-0.0.1/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: pyobs-brot
+Version: 0.0.1
+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
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: astropy<8,>=7.0.1
+Requires-Dist: paho-mqtt>=2.1.0
+Requires-Dist: pybrotlib>=0.1.3
+Requires-Dist: pyobs-core<2,>=1

pyobs_brot-0.0.1/README.md

@@ -0,0 +1,3 @@
+BROTlib module for *pyobs*
+==========================
+

pyobs_brot-0.0.1/pyobs_brot/__init__.py

@@ -0,0 +1,2 @@
+from .brottelescope import BrotBaseTelescope, BrotRaDecTelescope
+from .brotdome import BrotDome

pyobs_brot-0.0.1/pyobs_brot/brotdome.py

@@ -0,0 +1,194 @@
+import asyncio
+import logging
+from typing import Any
+
+import async_timer  # type: ignore
+import qasync  # type: ignore
+
+from pyobs.events import RoofOpenedEvent, RoofClosingEvent
+from pyobs.interfaces import IDome, IRoof, IMotion
+from pyobs.modules.roof.basedome import BaseDome
+from pyobs.modules import timeout
+from pyobs.utils.enums import MotionStatus
+
+from pybrotlib import BROT
+from pybrotlib.mqtttransport import MQTTTransport
+from pybrotlib.dome import DomeStatus, DomeShutterStatus
+
+log = logging.getLogger(__name__)
+
+
+class BrotDome(BaseDome, IDome, IRoof, IMotion):
+
+    def __init__(
+        self,
+        host: str,
+        name: str,
+        port: int = 1883,
+        keepalive: int = 60,
+        **kwargs: Any,
+    ):
+        BaseDome.__init__(self, **kwargs)
+        self.mqtt = MQTTTransport(host, port)
+        self.brot = BROT(self.mqtt, name)
+        # add thread for pulling the status constantly
+        self.add_background_task(self._update_status)
+
+    async def open(self) -> None:
+        await BaseDome.open(self)
+        asyncio.create_task(self.mqtt.run())
+        await asyncio.sleep(2)
+        await self.comm.register_event(RoofOpenedEvent)
+        await self.comm.register_event(RoofClosingEvent)
+        # check whats up
+        if self.brot.dome.status == DomeStatus.ERROR:
+            await self._error_state()
+        elif self.brot.dome.in_motion:
+            await self._change_motion_status(MotionStatus.SLEWING)
+            log.info("Dome is already in motion. Please make sure it is not used by another instance!")
+        elif self.brot.dome.status == DomeStatus.PARKED and self.brot.dome.shutter == DomeShutterStatus.CLOSED:
+            await self._change_motion_status(MotionStatus.PARKED)
+            log.info("Dome is closed and parked.")
+        else:
+            await self._change_motion_status(MotionStatus.POSITIONED)
+            log.info("Dome is already online. Please make sure it is not used by another instance!")
+
+    async def get_altaz(self, **kwargs: Any) -> tuple[float, float]:
+        """Returns current Alt and Az.
+
+        Returns:
+            Tuple of current Alt and Az in degrees.
+        """
+        return 0.0, self.brot.dome.azimuth
+
+    async def _update_status(self) -> None:
+        while True:
+            try:
+                current_state = await self.get_motion_status()
+                new_state = current_state
+                # first two can only be updated by the init/park method
+                if current_state == MotionStatus.INITIALIZING:
+                    pass
+                elif current_state == MotionStatus.PARKING:
+                    pass
+                elif self.brot.dome.status == DomeStatus.ERROR:
+                    new_state = MotionStatus.ERROR
+                elif self.brot.dome.status == DomeStatus.PARKED and self.brot.dome.shutter == DomeShutterStatus.CLOSED:
+                    new_state = MotionStatus.PARKED
+                elif self.brot.dome.in_motion:
+                    new_state = MotionStatus.SLEWING
+                else:
+                    new_state = MotionStatus.POSITIONED
+                if new_state != current_state:
+                    await self._change_motion_status(new_state)
+            except:
+                pass
+            await asyncio.sleep(1)
+
+    @timeout(300)
+    async def init(self, **kwargs: Any) -> None:
+        log.info("Opening roof")
+        if self.brot.dome.shutter == DomeShutterStatus.OPEN:
+            return
+        elif self.brot.dome.status == DomeStatus.ERROR:
+            await self._error_state("Dome is in error state. Cannot open.")
+            return
+
+        await self._change_motion_status(MotionStatus.INITIALIZING)
+
+        # send open command
+        await self.brot.dome.open()
+
+        while True:
+            match self.brot.dome.shutter:
+                case DomeShutterStatus.OPEN:
+                    log.info("Dome is open.")
+                    break
+                case _:
+                    pass
+            await asyncio.sleep(1)
+        # send tracking command
+        await self.brot.dome.start_tracking()
+        while True:
+            match self.brot.dome.status:
+                case DomeStatus.TRACKING:
+                    log.info("Dome is tracking the telescope azimuth.")
+                    break
+                case DomeStatus.ERROR:
+                    await self._error_state()
+                    return
+                case _:
+                    pass
+            await asyncio.sleep(1)
+        await self._change_motion_status(MotionStatus.POSITIONED)
+        await self.comm.send_event(RoofOpenedEvent())
+
+    @timeout(300)
+    async def park(self, **kwargs: Any) -> None:
+        if self.brot.dome.status == DomeStatus.PARKED and self.brot.some.shutter == DomeShutterStatus.CLOSED:
+            return
+        elif self.brot.dome.status == DomeStatus.ERROR:
+            await self._error_state("Dome is in error state. Cannot close/park.")
+            return
+
+        await self._change_motion_status(MotionStatus.PARKING)
+        await self.comm.send_event(RoofClosingEvent())
+        # stop tracking
+        await self.brot.dome.stop_tracking()
+        while True:
+            match self.brot.dome.status:
+                case DomeStatus.TRACKING:
+                    pass
+                case DomeStatus.ERROR:
+                    await self._error_state()
+                    return
+                case _:
+                    break
+            await asyncio.sleep(1)
+        # close shutter
+        await self.brot.dome.close()
+        while True:
+            match self.brot.dome.shutter:
+                case DomeShutterStatus.CLOSED:
+                    log.info("Dome shutter is closed.")
+                    break
+                case _:
+                    pass
+            await asyncio.sleep(1)
+
+        # go to parking position
+        await self.brot.dome.park()
+        while True:
+            match self.brot.dome.status:
+                case DomeStatus.PARKED:
+                    log.info("Dome is parked.")
+                    break
+                case DomeStatus.ERROR:
+                    await self._error_state()
+                    return
+                case _:
+                    pass
+            await asyncio.sleep(1)
+        await self._change_motion_status(MotionStatus.PARKED)
+
+    async def stop_motion(self, device: str | None = None, **kwargs: Any) -> None:
+        pass  # no stopping of the roof possible
+
+    async def move_altaz(self, alt: float, az: float, **kwargs: Any) -> None:
+        """Moves to given coordinates.
+
+        Args:
+            alt: Alt in deg to move to.
+            az: Az in deg to move to.
+
+        Raises:
+            MoveError: If device could not be moved.
+        """
+        pass
+
+    async def _error_state(self, mess: str = "Dome is in error state.") -> None:
+        log.error(mess)
+        await self._change_motion_status(MotionStatus.ERROR)
+
+
+__all__ = ["BrotDome"]