ourskyai-node-platform-api 1.3.9821__py3-none-any.whl

ourskyai_node_platform_api/models/autofocus_finished.py

@@ -0,0 +1,80 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Optional, Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt
+
+class AutofocusFinished(BaseModel):
+    """
+    Event data for the successful completion of an autofocus routine.  # noqa: E501
+    """
+    focus_position: StrictInt = Field(..., alias="focusPosition", description="The optimal focus position determined by the autofocus routine, in focuser steps or encoder units.")
+    r_squared: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="rSquared", description="The R-squared value of the focus curve fit, indicating how well the data fits the expected parabolic curve. Values closer to 1 indicate better fits. Null if not calculated.")
+    points_used: Optional[StrictInt] = Field(None, alias="pointsUsed", description="Number of measurement points used in the final focus curve calculation.")
+    __properties = ["focusPosition", "rSquared", "pointsUsed"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> AutofocusFinished:
+        """Create an instance of AutofocusFinished from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # set to None if r_squared (nullable) is None
+        # and __fields_set__ contains the field
+        if self.r_squared is None and "r_squared" in self.__fields_set__:
+            _dict['rSquared'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> AutofocusFinished:
+        """Create an instance of AutofocusFinished from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return AutofocusFinished.parse_obj(obj)
+
+        _obj = AutofocusFinished.parse_obj({
+            "focus_position": obj.get("focusPosition"),
+            "r_squared": obj.get("rSquared"),
+            "points_used": obj.get("pointsUsed")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/autofocus_method.py

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import json
+import pprint
+import re  # noqa: F401
+from aenum import Enum, no_arg
+
+
+
+
+
+class AutofocusMethod(str, Enum):
+    """
+    Algorithm used to measure focus quality during autofocus routines. FWHM (Full Width at Half Maximum) measures the diameter of star images at half their peak brightness - smaller values indicate sharper focus. HFR (Half Flux Radius) measures the radius containing half the star's total light - also minimized at best focus. CONTRAST measures image sharpness through edge detection - maximized at best focus. Use FWHM or HFR for point sources (stars), CONTRAST for extended objects. 
+    """
+
+    """
+    allowed enum values
+    """
+    FWHM = 'FWHM'
+    CONTRAST = 'CONTRAST'
+    HFR = 'HFR'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> AutofocusMethod:
+        """Create an instance of AutofocusMethod from a JSON string"""
+        return AutofocusMethod(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/autofocus_point_added.py

@@ -0,0 +1,75 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Optional, Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt, StrictStr
+
+class AutofocusPointAdded(BaseModel):
+    """
+    Event data for an autofocus measurement point added during the focus optimization routine.  # noqa: E501
+    """
+    focuser_position: StrictInt = Field(..., alias="focuserPosition", description="Focuser position in steps or encoder units where this measurement was taken.")
+    measurement_method: StrictStr = Field(..., alias="measurementMethod", description="Method used to measure focus quality, such as HFR, FWHM, or contrast-based metrics.")
+    measurement_value: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="measurementValue", description="The measured focus quality value. Interpretation depends on the measurement method used.")
+    __properties = ["focuserPosition", "measurementMethod", "measurementValue"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> AutofocusPointAdded:
+        """Create an instance of AutofocusPointAdded from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> AutofocusPointAdded:
+        """Create an instance of AutofocusPointAdded from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return AutofocusPointAdded.parse_obj(obj)
+
+        _obj = AutofocusPointAdded.parse_obj({
+            "focuser_position": obj.get("focuserPosition"),
+            "measurement_method": obj.get("measurementMethod"),
+            "measurement_value": obj.get("measurementValue")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/autofocus_started.py

@@ -0,0 +1,79 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Union
+from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, StrictStr
+
+class AutofocusStarted(BaseModel):
+    """
+    Event data for the start of an autofocus routine with configuration parameters.  # noqa: E501
+    """
+    step_microns: StrictInt = Field(..., alias="stepMicrons", description="Step size between focus measurement points in microns. Smaller steps provide finer resolution but require more time.")
+    max_focus_points: StrictInt = Field(..., alias="maxFocusPoints", description="Maximum number of focus positions to sample during the autofocus routine.")
+    r_squared_threshold: Union[StrictFloat, StrictInt] = Field(..., alias="rSquaredThreshold", description="Minimum R-squared value required for the focus curve fit to be considered successful. Range is 0 to 1.")
+    method: StrictStr = Field(..., description="Focus measurement method being used, such as HFR, FWHM, or contrast-based analysis.")
+    blind: StrictBool = Field(..., description="When true, performs a wide-range blind search for focus. When false, refines focus near the current position.")
+    __properties = ["stepMicrons", "maxFocusPoints", "rSquaredThreshold", "method", "blind"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> AutofocusStarted:
+        """Create an instance of AutofocusStarted from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> AutofocusStarted:
+        """Create an instance of AutofocusStarted from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return AutofocusStarted.parse_obj(obj)
+
+        _obj = AutofocusStarted.parse_obj({
+            "step_microns": obj.get("stepMicrons"),
+            "max_focus_points": obj.get("maxFocusPoints"),
+            "r_squared_threshold": obj.get("rSquaredThreshold"),
+            "method": obj.get("method"),
+            "blind": obj.get("blind")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/bff_v1_all_sky_images.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import List, Optional
+from pydantic import BaseModel, Field, conlist
+from ourskyai_node_platform_api.models.v1_latest_image import V1LatestImage
+from ourskyai_node_platform_api.models.v1_time_windowed_asset import V1TimeWindowedAsset
+
+class BffV1AllSkyImages(BaseModel):
+    """
+    BffV1AllSkyImages
+    """
+    all_sky_images: conlist(V1LatestImage) = Field(..., alias="allSkyImages")
+    timelapse: Optional[V1TimeWindowedAsset] = None
+    keogram: Optional[V1TimeWindowedAsset] = None
+    __properties = ["allSkyImages", "timelapse", "keogram"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> BffV1AllSkyImages:
+        """Create an instance of BffV1AllSkyImages from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in all_sky_images (list)
+        _items = []
+        if self.all_sky_images:
+            for _item in self.all_sky_images:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['allSkyImages'] = _items
+        # override the default output from pydantic by calling `to_dict()` of timelapse
+        if self.timelapse:
+            _dict['timelapse'] = self.timelapse.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of keogram
+        if self.keogram:
+            _dict['keogram'] = self.keogram.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> BffV1AllSkyImages:
+        """Create an instance of BffV1AllSkyImages from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return BffV1AllSkyImages.parse_obj(obj)
+
+        _obj = BffV1AllSkyImages.parse_obj({
+            "all_sky_images": [V1LatestImage.from_dict(_item) for _item in obj.get("allSkyImages")] if obj.get("allSkyImages") is not None else None,
+            "timelapse": V1TimeWindowedAsset.from_dict(obj.get("timelapse")) if obj.get("timelapse") is not None else None,
+            "keogram": V1TimeWindowedAsset.from_dict(obj.get("keogram")) if obj.get("keogram") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/camera_image_captured.py

@@ -0,0 +1,75 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+
+from pydantic import BaseModel, Field
+from ourskyai_node_platform_api.models.v1_image import V1Image
+
+class CameraImageCaptured(BaseModel):
+    """
+    Event data for a completed image capture. Contains metadata about the captured image including storage location and capture parameters.  # noqa: E501
+    """
+    image: V1Image = Field(...)
+    __properties = ["image"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> CameraImageCaptured:
+        """Create an instance of CameraImageCaptured from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of image
+        if self.image:
+            _dict['image'] = self.image.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> CameraImageCaptured:
+        """Create an instance of CameraImageCaptured from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return CameraImageCaptured.parse_obj(obj)
+
+        _obj = CameraImageCaptured.parse_obj({
+            "image": V1Image.from_dict(obj.get("image")) if obj.get("image") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/camera_status_updated.py

@@ -0,0 +1,76 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+
+from pydantic import BaseModel, Field, StrictStr
+from ourskyai_node_platform_api.models.connection_status import ConnectionStatus
+
+class CameraStatusUpdated(BaseModel):
+    """
+    Event data for a camera status change. Indicates which camera changed state and its new connection status.  # noqa: E501
+    """
+    id: StrictStr = Field(..., description="Unique identifier for the camera that changed status. Used to distinguish between multiple cameras in the system.")
+    name: StrictStr = Field(..., description="Human-readable name of the camera, such as the manufacturer and model or a user-assigned label.")
+    connection_status: ConnectionStatus = Field(..., alias="connectionStatus")
+    __properties = ["id", "name", "connectionStatus"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> CameraStatusUpdated:
+        """Create an instance of CameraStatusUpdated from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> CameraStatusUpdated:
+        """Create an instance of CameraStatusUpdated from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return CameraStatusUpdated.parse_obj(obj)
+
+        _obj = CameraStatusUpdated.parse_obj({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "connection_status": obj.get("connectionStatus")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/camera_temperature_set.py

@@ -0,0 +1,71 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt
+
+class CameraTemperatureSet(BaseModel):
+    """
+    Event data for a camera temperature setpoint change. Indicates the target temperature for the camera cooling system.  # noqa: E501
+    """
+    celsius: Union[StrictFloat, StrictInt] = Field(..., description="The new temperature setpoint in degrees Celsius. Negative values are common for cooled astronomical cameras to reduce thermal noise.")
+    __properties = ["celsius"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> CameraTemperatureSet:
+        """Create an instance of CameraTemperatureSet from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> CameraTemperatureSet:
+        """Create an instance of CameraTemperatureSet from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return CameraTemperatureSet.parse_obj(obj)
+
+        _obj = CameraTemperatureSet.parse_obj({
+            "celsius": obj.get("celsius")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/capture_image_started.py

@@ -0,0 +1,79 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt
+
+class CaptureImageStarted(BaseModel):
+    """
+    Event data for the start of an image capture. Contains all exposure settings used for this capture.  # noqa: E501
+    """
+    exposure: Union[StrictFloat, StrictInt] = Field(..., description="Exposure duration in seconds. Longer exposures collect more light but increase noise and trailing risk.")
+    gain: StrictInt = Field(..., description="Camera gain setting controlling signal amplification. Higher values increase sensitivity but also increase noise.")
+    binning: StrictInt = Field(..., description="Pixel binning factor where adjacent pixels are combined. Higher binning reduces resolution but improves sensitivity and download speed.")
+    offset: StrictInt = Field(..., description="Camera offset or black level setting. Ensures the histogram does not clip at zero for proper calibration.")
+    gain_mode: StrictInt = Field(..., alias="gainMode", description="Camera gain mode selection for cameras with multiple gain modes such as high dynamic range or low noise modes.")
+    __properties = ["exposure", "gain", "binning", "offset", "gainMode"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> CaptureImageStarted:
+        """Create an instance of CaptureImageStarted from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> CaptureImageStarted:
+        """Create an instance of CaptureImageStarted from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return CaptureImageStarted.parse_obj(obj)
+
+        _obj = CaptureImageStarted.parse_obj({
+            "exposure": obj.get("exposure"),
+            "gain": obj.get("gain"),
+            "binning": obj.get("binning"),
+            "offset": obj.get("offset"),
+            "gain_mode": obj.get("gainMode")
+        })
+        return _obj
+
+