pyninaapiio 0.0.3__tar.gz → 0.0.4__tar.gz

{pyninaapiio-0.0.3 → pyninaapiio-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyninaapiio
-Version: 0.0.3
+Version: 0.0.4
 Summary: Python Wrapper for N.I.N.A. Advanced API
 Home-page: https://github.com/mawinkler/pyninaapiio
 Author: Markus Winkler
@@ -23,6 +23,7 @@ Classifier: Programming Language :: Python :: 3.13
 License-File: LICENSE
 Requires-Dist: httpx
 Requires-Dist: attrs
+Requires-Dist: typeguard
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

pyninaapiio-0.0.4/pyninaapiio/dataclasses.py

@@ -0,0 +1,246 @@
+"""Defines the Data Classes used."""
+
+# import math
+# from dataclasses import dataclass
+# from datetime import datetime
+# from pprint import pprint as pp
+from typing import TypedDict, Optional
+
+from typeguard import typechecked
+
+# from pyninaapiio.const import (
+#     # CONDITION,
+#     # CONDITION_PLAIN,
+#     # DEEP_SKY_THRESHOLD,
+#     # LIFTED_INDEX_PLAIN,
+#     # LIFTED_INDEX_RANGE,
+#     # LIFTED_INDEX_VALUE,
+#     # MAG_DEGRATION_MAX,
+#     # SEEING_MAX,
+#     # WIND10M_DIRECTON,
+#     # WIND10M_MAX,
+#     # WIND10M_PLAIN,
+#     # WIND10M_RANGE,
+#     # WIND10M_VALUE,
+# )
+
+
+# @dataclass
+# class TimeDataModel(TypedDict):
+#     """Model for time data"""
+
+#     forecast_time: datetime
+
+
+# @typechecked
+# class TimeData:
+#     """A representation of the time data of forecasts."""
+
+#     def __init__(self, *, data: TimeDataModel):
+#         self.forecast_time = data["forecast_time"]
+
+
+# class GeoLocationDataModel(TypedDict):
+#     """Model for the location"""
+
+#     latitude: float
+#     longitude: float
+#     elevation: float
+#     timezone_info: str
+
+
+# @typechecked
+# class GeoLocationData:
+#     """A representation of the geographic location."""
+
+#     def __init__(self, *, data: GeoLocationDataModel):
+#         self.latitude = data["latitude"]
+#         self.longitude = data["longitude"]
+#         self.elevation = data["elevation"]
+#         self.timezone_info = data["timezone_info"]
+
+
+# #########################################################################
+# Mount
+# #########################################################################
+class DeviceMountListDataModel(TypedDict):
+    items: dict
+
+
+@typechecked
+class DeviceMountListData:
+    """A representation of the geographic location."""
+
+    def __init__(self, *, data: DeviceMountListDataModel):
+        self.items = data["items"]
+
+
+class DeviceMountDataModel(TypedDict):
+    # device_list_response_item
+
+    HasSetupDialog: bool
+    Id: str
+    Name: str
+    DisplayName: str
+    Category: str
+    Connected: bool
+    Description: str
+    DriverInfo: str
+    DriverVersion: str
+    SupportedActions: list
+    # additional_properties: dict
+
+
+@typechecked
+class DeviceMountData:
+    """A representation of the geographic location."""
+
+    def __init__(self, *, data: DeviceMountDataModel):
+        self.has_setup_dialog = data["HasSetupDialog"]
+        self.id = data["Id"]
+        self.name = data["Name"]
+        self.display_name = data["DisplayName"]
+        self.category = data["Category"]
+        self.connected = data["Connected"]
+        self.description = data["Description"]
+        self.driver_info = data["DriverInfo"]
+        self.driver_version = data["DriverVersion"]
+        self.supported_actions = data["SupportedActions"]
+        # self.additional_properties = data["additional_properties"]
+
+
+class MountDataModel(TypedDict):
+    connected: bool
+    name: str
+    display_name: str
+    device_id: str
+    sidereal_time: float
+    right_ascension: float
+    declination: float
+    site_latitude: float
+    site_longitude: float
+    site_elevation: float
+
+
+@typechecked
+class MountData:
+    """A representation of the geographic location."""
+
+    def __init__(self, *, data: MountDataModel):
+        self.connected = data["connected"]
+        self.name = data["name"]
+        self.display_name = data["display_name"]
+        self.device_id = data["device_id"]
+        self.sidereal_time = data["sidereal_time"]
+        self.right_ascension = data["right_ascension"]
+        self.declination = data["declination"]
+        self.site_latitude = data["site_latitude"]
+        self.site_longitude = data["site_longitude"]
+        self.site_elevation = data["site_elevation"]
+
+
+# #########################################################################
+# Switch
+# #########################################################################
+class SwitchPortDataModel(TypedDict, total=False):
+    # device_list_response_item
+
+    Maximum: Optional[int]
+    Minimum: Optional[int]
+    StepSize: Optional[int]
+    TargetValue: Optional[int]
+    Id: int
+    Name: str
+    Description: str
+    Value: float
+
+
+@typechecked
+class SwitchPortData:
+    """A representation of the geographic location."""
+
+    def __init__(self, *, data: SwitchPortDataModel):
+        self.maximum = data.get("Maximum", None)
+        self.minimum = data.get("Minimum", None)
+        self.step_size = data.get("StepSize", None)
+        self.target_value = data.get("TargetValue", None)
+        self.id = data["Id"]
+        self.name = data["Name"]
+        self.description = data["Description"]
+        self.value = data["Value"]
+
+
+class SwitchDataModel(TypedDict, total=False):
+    # device_list_response_item
+
+    WritableSwitches: list[SwitchPortDataModel]
+    ReadonlySwitches: list[SwitchPortDataModel]
+    SupportedActions: list[str]
+    Connected: bool
+    Name: str
+    DisplayName: str
+    Description: str
+    DriverInfo: str
+    DriverVersion: str
+    DeviceId: str
+
+
+@typechecked
+class SwitchData:
+    """A representation of the geographic location."""
+
+    def __init__(self, *, data: SwitchDataModel):
+        self.writable_switches = data["WritableSwitches"]
+        self.readonly_switches = data["ReadonlySwitches"]
+        self.supported_actions = data["SupportedActions"]
+        self.connected = data["Connected"]
+        self.name = data["Name"]
+        self.display_name = data["DisplayName"]
+        self.description = data["Description"]
+        self.driver_info = data["DriverInfo"]
+        self.driver_version = data["DriverVersion"]
+        self.device_id = data["DeviceId"]
+
+
+# #########################################################################
+# Camera
+# #########################################################################
+class CameraDataModel(TypedDict, total=False):
+    DecodedData: bytes
+
+
+class CameraData:
+    def __init__(self, *, data: CameraDataModel):
+        self.decoded_data = data["DecodedData"]
+
+
+# #########################################################################
+# N.I.N.A. Devices
+# #########################################################################
+class NinaDevicesDataModel(TypedDict, total=False):
+    # device_list_response_item
+
+    # Application: Optional[ApplicationData]
+    Camera: Optional[CameraData]
+    # Dome: Optional[DomeData]
+    # FilterWheel: Optional[FilterWheelData]
+    # FlatPanel: Optional[FlatPanelData]
+    # Focuser: Optional[FocuserData]
+    # Guider: Optional[GuiderData]
+    # Image: Optional[ImageData]
+    Mount: Optional[MountData]
+    # Profile: Optional[ProfileData]
+    # Rotator: Optional[RotatorData]
+    # SafetyMonitor: Optional[SafetyMonitorData]
+    # Sequence: Optional[SequenceData]
+    Switch: Optional[SwitchData]
+
+
+@typechecked
+class NinaDevicesData:
+    """A representation of the geographic location."""
+
+    def __init__(self, *, data: NinaDevicesDataModel):
+        self.mount = data["Mount"]
+        self.switch = data["Switch"]
+        self.camera = data["Camera"]

pyninaapiio-0.0.4/pyninaapiio/nina.py

@@ -0,0 +1,145 @@
+# import asyncio
+import base64
+
+# import io
+import logging
+import sys
+from pprint import pprint as pp
+
+from pyninaapiio.api.image import get_image_history, get_image_index
+from pyninaapiio.api.mount import get_equipment_mount_info, get_equipment_mount_list_devices
+from pyninaapiio.api.switch import get_equipment_switch_info
+from pyninaapiio.client import Client
+from pyninaapiio.dataclasses import (
+    CameraData,
+    CameraDataModel,
+    DeviceMountData,
+    DeviceMountDataModel,
+    # DeviceMountListData,
+    # DeviceMountListDataModel,
+    MountData,
+    MountDataModel,
+    NinaDevicesData,
+    NinaDevicesDataModel,
+    SwitchData,
+    # SwitchPortData,
+    # SwitchPortDataModel,
+    SwitchDataModel,
+)
+from pyninaapiio.models.device_list import DeviceList
+from pyninaapiio.models.device_list_response_item import DeviceListResponseItem
+from pyninaapiio.models.get_image_history_response_200 import GetImageHistoryResponse200
+from pyninaapiio.models.get_image_index_bayer_pattern import GetImageIndexBayerPattern
+from pyninaapiio.models.get_image_index_response_200 import GetImageIndexResponse200
+from pyninaapiio.models.mount_info import MountInfo
+from pyninaapiio.models.switch_info import SwitchInfo
+from pyninaapiio.types import Response
+
+_LOGGER = logging.getLogger(__name__)
+logging.basicConfig(
+    stream=sys.stdout,
+    level=logging.INFO,
+    format="%(asctime)s %(levelname)s (%(threadName)s) [%(funcName)s] %(message)s",
+    datefmt="%Y-%m-%d %H:%M:%S",
+)
+
+
+# async with client as client:
+class NinaAPI:
+    def __init__(
+        self,
+        # session: Optional[ClientSession] = None,
+        session=None,
+        base_url="http://192.168.1.234:1888/v2/api",
+    ):
+        self._session = session
+        self._client = Client(base_url=base_url)
+
+        return None
+
+    # #########################################################################
+    # Mount
+    # #########################################################################
+    async def mount_list_devices(self):
+        items = []
+
+        try:
+            _list_devices: Response[DeviceList] = await get_equipment_mount_list_devices.asyncio(client=self._client)
+
+            for _, device in enumerate(_list_devices.response):
+                item = DeviceMountDataModel(device.to_dict())
+
+                try:
+                    items.append(DeviceMountData(data=item))
+                except TypeError as ve:
+                    _LOGGER.error(f"Failed to parse device data model data: {item}")
+                    _LOGGER.error(ve)
+        except KeyError as ke:
+            _LOGGER.error(f"KeyError: {ke}")
+
+        return items
+
+    async def mount_info(self):
+        try:
+            _LOGGER.debug(f"Retrieve mount info")
+            _mount_info: Response[MountInfo] = await get_equipment_mount_info.asyncio(client=self._client)
+            _mount_info_data = MountDataModel(_mount_info.response.to_dict())
+
+            return MountData(data=_mount_info_data)
+
+        except KeyError as ke:
+            _LOGGER.warning(f"Mount not connected. {ke}")
+
+    # #########################################################################
+    # Image
+    # #########################################################################
+    async def image_latest(self):
+        _LOGGER.debug(f"Retrieve index of last capture")
+        image_history: GetImageHistoryResponse200 = await get_image_history.asyncio(client=self._client, count=True)
+        image_index_latest = image_history.response - 1
+
+        _LOGGER.debug(f"Retrieve capture with index {image_index_latest}")
+        image: GetImageIndexResponse200 = await get_image_index.asyncio(index=image_index_latest, client=self._client)
+        # , debayer=True
+        # )  # , bayer_pattern=GetImageIndexBayerPattern.RGGB)
+        if image.success:
+            decoded_data = base64.b64decode(image.response)
+            _LOGGER.debug(f"Capture size: {len(decoded_data)}")
+
+            _camera_data = CameraDataModel({"DecodedData": decoded_data})
+
+            return CameraData(data=_camera_data)
+        else:
+            _LOGGER.warning(f"{image.error}")
+
+    # #########################################################################
+    # Switch
+    # #########################################################################
+    async def switch_info(self):
+        try:
+            _LOGGER.debug(f"Retrieve switch info")
+            _switch_info: Response[SwitchInfo] = await get_equipment_switch_info.asyncio(client=self._client)
+            _switch_info_data = SwitchDataModel(_switch_info.response.to_dict())
+
+            return SwitchData(data=_switch_info_data)
+
+        except KeyError as ke:
+            _LOGGER.warning(f"Switch not connected. {ke}")
+
+    # #########################################################################
+    # Nina
+    # #########################################################################
+    async def nina_info(self):
+        try:
+            _LOGGER.debug(f"Retrieve nina info")
+            _nina = {
+                "Mount": await self.mount_info(),
+                "Switch": await self.switch_info(),
+                "Camera": await self.image_latest(),
+            }
+            _nina_info_data = NinaDevicesDataModel(_nina)
+
+            return NinaDevicesData(data=_nina_info_data)
+
+        except KeyError as ke:
+            _LOGGER.warning(f"Nina not connected. {ke}")

{pyninaapiio-0.0.3 → pyninaapiio-0.0.4}/pyninaapiio.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyninaapiio
-Version: 0.0.3
+Version: 0.0.4
 Summary: Python Wrapper for N.I.N.A. Advanced API
 Home-page: https://github.com/mawinkler/pyninaapiio
 Author: Markus Winkler
@@ -23,6 +23,7 @@ Classifier: Programming Language :: Python :: 3.13
 License-File: LICENSE
 Requires-Dist: httpx
 Requires-Dist: attrs
+Requires-Dist: typeguard
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{pyninaapiio-0.0.3 → pyninaapiio-0.0.4}/pyninaapiio.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ setup.cfg
 setup.py
 pyninaapiio/__init__.py
 pyninaapiio/client.py
+pyninaapiio/dataclasses.py
 pyninaapiio/errors.py
 pyninaapiio/nina.py
 pyninaapiio/py.typed

{pyninaapiio-0.0.3 → pyninaapiio-0.0.4}/pyninaapiio.egg-info/requires.txt

@@ -1,2 +1,3 @@
 httpx
 attrs
+typeguard

{pyninaapiio-0.0.3 → pyninaapiio-0.0.4}/setup.py

@@ -11,7 +11,7 @@ if os.path.isfile(requirement_path):
 setup(
     name="pyninaapiio",
     packages=find_packages(),
-    version="0.0.3",
+    version="0.0.4",
     license="MIT",
     description="Python Wrapper for N.I.N.A. Advanced API",
     long_description=" ".join(

pyninaapiio-0.0.3/pyninaapiio/nina.py

@@ -1,44 +0,0 @@
-import asyncio
-import base64
-import io
-from pprint import pprint as pp
-
-from pyninaapiio.api.image import get_image_history, get_image_index
-from pyninaapiio.api.mount import get_equipment_mount_info
-from pyninaapiio.client import Client
-from pyninaapiio.models.get_image_history_response_200 import GetImageHistoryResponse200
-from pyninaapiio.models.get_image_index_bayer_pattern import GetImageIndexBayerPattern
-from pyninaapiio.models.get_image_index_response_200 import GetImageIndexResponse200
-from pyninaapiio.models.mount_info import MountInfo
-from pyninaapiio.types import Response
-
-
-# async with client as client:
-class NinaAPI:
-    def __init__(
-        self,
-        base_url,
-    ):
-        self._client = Client(base_url=base_url)
-
-        return None
-
-    async def get_mount_info(self):
-        # mount_info: MountInfo = await get_equipment_mount_info.asyncio(client=client)
-        response: Response[MountInfo] = await get_equipment_mount_info.asyncio(client=self._client)
-        pp(response)
-
-    async def get_latest_image(self):
-        image_history: GetImageHistoryResponse200 = await get_image_history.asyncio(client=self._client, count=True)
-        image_index_latest = image_history.response - 1
-        pp(image_index_latest)
-
-        image: GetImageIndexResponse200 = await get_image_index.asyncio(index=image_index_latest, client=self._client)
-        # , debayer=True
-        # )  # , bayer_pattern=GetImageIndexBayerPattern.RGGB)
-
-        if image.success:
-            decoded_data = base64.b64decode(image.response)
-
-            with open("capture.png", "wb") as file:
-                file.write(decoded_data)