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

ourskyai_node_platform_api/models/v1_image.py

@@ -0,0 +1,103 @@
+# 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 datetime import datetime
+from typing import List, Optional, Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt, StrictStr, conlist
+from ourskyai_node_platform_api.models.fits_header import FitsHeader
+
+class V1Image(BaseModel):
+    """
+    Complete metadata for a captured image including exposure settings, timing information, plate solve results, and FITS headers. Use this object to understand the capture parameters and retrieve associated image files.  # noqa: E501
+    """
+    id: StrictStr = Field(..., description="Unique identifier for this image. Use this ID with the file endpoint to download the actual image data or with other image-related operations.")
+    ra: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Right Ascension of the image center in decimal degrees (0-360), populated when plate solving succeeds. Represents the celestial longitude coordinate in the equatorial coordinate system.")
+    dec: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Declination of the image center in decimal degrees (-90 to +90), populated when plate solving succeeds. Represents the celestial latitude coordinate in the equatorial coordinate system.")
+    exposure: Union[StrictFloat, StrictInt] = Field(..., description="Actual exposure duration in seconds that was used when capturing this image.")
+    gain: StrictInt = Field(..., description="Sensor gain setting that was applied during capture. Higher values indicate more signal amplification.")
+    binning: StrictInt = Field(..., description="Pixel binning factor that was used during capture. A value of 1 indicates full resolution with no binning.")
+    offset: StrictInt = Field(..., description="Sensor offset or black level setting that was applied during capture.")
+    gain_mode: Optional[StrictStr] = Field(None, alias="gainMode", description="Name or identifier of the gain mode that was active during capture, if applicable to the camera model.")
+    fits_headers: conlist(FitsHeader) = Field(..., alias="fitsHeaders", description="Complete collection of FITS header keyword-value pairs associated with this image. Contains detailed metadata about the observation, equipment, and processing.")
+    exposure_started_at: Optional[datetime] = Field(None, alias="exposureStartedAt", description="ISO 8601 timestamp indicating when the camera shutter opened and exposure began.")
+    exposure_ended_at: Optional[datetime] = Field(None, alias="exposureEndedAt", description="ISO 8601 timestamp indicating when the camera shutter closed and exposure ended.")
+    created_at: datetime = Field(..., alias="createdAt", description="ISO 8601 timestamp indicating when this image record was created in the database. Used for pagination with the before parameter.")
+    updated_at: datetime = Field(..., alias="updatedAt", description="ISO 8601 timestamp indicating when this image record was last modified, such as after plate solving completes or metadata is updated.")
+    __properties = ["id", "ra", "dec", "exposure", "gain", "binning", "offset", "gainMode", "fitsHeaders", "exposureStartedAt", "exposureEndedAt", "createdAt", "updatedAt"]
+
+    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) -> V1Image:
+        """Create an instance of V1Image 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 fits_headers (list)
+        _items = []
+        if self.fits_headers:
+            for _item in self.fits_headers:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['fitsHeaders'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1Image:
+        """Create an instance of V1Image from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1Image.parse_obj(obj)
+
+        _obj = V1Image.parse_obj({
+            "id": obj.get("id"),
+            "ra": obj.get("ra"),
+            "dec": obj.get("dec"),
+            "exposure": obj.get("exposure"),
+            "gain": obj.get("gain"),
+            "binning": obj.get("binning"),
+            "offset": obj.get("offset"),
+            "gain_mode": obj.get("gainMode"),
+            "fits_headers": [FitsHeader.from_dict(_item) for _item in obj.get("fitsHeaders")] if obj.get("fitsHeaders") is not None else None,
+            "exposure_started_at": obj.get("exposureStartedAt"),
+            "exposure_ended_at": obj.get("exposureEndedAt"),
+            "created_at": obj.get("createdAt"),
+            "updated_at": obj.get("updatedAt")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_images.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 List
+from pydantic import BaseModel, Field, conlist
+from ourskyai_node_platform_api.models.v1_image import V1Image
+
+class V1Images(BaseModel):
+    """
+    Container object holding a paginated list of images. Use the before parameter with the last image's createdAt timestamp to retrieve the next page of results.  # noqa: E501
+    """
+    images: conlist(V1Image) = Field(..., description="Array of image metadata objects sorted by creation time in descending order (newest first). May be empty if no images match the query criteria.")
+    __properties = ["images"]
+
+    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) -> V1Images:
+        """Create an instance of V1Images 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 images (list)
+        _items = []
+        if self.images:
+            for _item in self.images:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['images'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1Images:
+        """Create an instance of V1Images from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1Images.parse_obj(obj)
+
+        _obj = V1Images.parse_obj({
+            "images": [V1Image.from_dict(_item) for _item in obj.get("images")] if obj.get("images") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_jog_enclosure_rotator_request.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 V1JogEnclosureRotatorRequest(BaseModel):
+    """
+    Request parameters for manually jogging the dome rotator at a specified angular velocity. Use this for fine position adjustments during manual operation or maintenance.  # noqa: E501
+    """
+    degrees_per_second: Union[StrictFloat, StrictInt] = Field(..., alias="degreesPerSecond", description="The angular velocity at which to rotate the dome, in degrees per second. Positive values rotate clockwise (increasing azimuth), negative values rotate counterclockwise. Typical values range from -5 to 5 degrees per second.")
+    __properties = ["degreesPerSecond"]
+
+    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) -> V1JogEnclosureRotatorRequest:
+        """Create an instance of V1JogEnclosureRotatorRequest 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) -> V1JogEnclosureRotatorRequest:
+        """Create an instance of V1JogEnclosureRotatorRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1JogEnclosureRotatorRequest.parse_obj(obj)
+
+        _obj = V1JogEnclosureRotatorRequest.parse_obj({
+            "degrees_per_second": obj.get("degreesPerSecond")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_jog_enclosure_shutter_request.py

@@ -0,0 +1,74 @@
+# 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
+from ourskyai_node_platform_api.models.enclosure_shutter_label import EnclosureShutterLabel
+
+class V1JogEnclosureShutterRequest(BaseModel):
+    """
+    Request parameters for jogging a single shutter panel at a specified velocity. Use this to fine-tune shutter position during manual operation or testing scenarios.  # noqa: E501
+    """
+    label: EnclosureShutterLabel = Field(...)
+    position_percent_per_second: Union[StrictFloat, StrictInt] = Field(..., alias="positionPercentPerSecond", description="The velocity at which to move the shutter, expressed as percentage of travel per second. Positive values move toward open, negative values move toward closed. Typical values range from -10 to 10.")
+    __properties = ["label", "positionPercentPerSecond"]
+
+    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) -> V1JogEnclosureShutterRequest:
+        """Create an instance of V1JogEnclosureShutterRequest 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) -> V1JogEnclosureShutterRequest:
+        """Create an instance of V1JogEnclosureShutterRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1JogEnclosureShutterRequest.parse_obj(obj)
+
+        _obj = V1JogEnclosureShutterRequest.parse_obj({
+            "label": obj.get("label"),
+            "position_percent_per_second": obj.get("positionPercentPerSecond")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_jog_enclosure_shutters_request.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 List
+from pydantic import BaseModel, Field, conlist
+from ourskyai_node_platform_api.models.v1_jog_enclosure_shutter_request import V1JogEnclosureShutterRequest
+
+class V1JogEnclosureShuttersRequest(BaseModel):
+    """
+    Request parameters for jogging multiple shutter panels simultaneously. Each shutter can be assigned an independent velocity, allowing coordinated movement of all panels.  # noqa: E501
+    """
+    shutters: conlist(V1JogEnclosureShutterRequest) = Field(..., description="Array of individual shutter jog commands. Include an entry for each shutter you want to move. Shutters not included in the array will not be affected.")
+    __properties = ["shutters"]
+
+    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) -> V1JogEnclosureShuttersRequest:
+        """Create an instance of V1JogEnclosureShuttersRequest 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 shutters (list)
+        _items = []
+        if self.shutters:
+            for _item in self.shutters:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['shutters'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1JogEnclosureShuttersRequest:
+        """Create an instance of V1JogEnclosureShuttersRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1JogEnclosureShuttersRequest.parse_obj(obj)
+
+        _obj = V1JogEnclosureShuttersRequest.parse_obj({
+            "shutters": [V1JogEnclosureShutterRequest.from_dict(_item) for _item in obj.get("shutters")] if obj.get("shutters") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_jog_enclosure_window_request.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 V1JogEnclosureWindowRequest(BaseModel):
+    """
+    Request parameters for manually jogging the observation window at a specified angular velocity. Use this for fine position adjustments during manual operation or maintenance.  # noqa: E501
+    """
+    degrees_per_second: Union[StrictFloat, StrictInt] = Field(..., alias="degreesPerSecond", description="The angular velocity at which to move the window, in degrees per second. Positive values tilt the window upward (increasing elevation angle), negative values tilt it downward. Typical values range from -5 to 5 degrees per second.")
+    __properties = ["degreesPerSecond"]
+
+    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) -> V1JogEnclosureWindowRequest:
+        """Create an instance of V1JogEnclosureWindowRequest 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) -> V1JogEnclosureWindowRequest:
+        """Create an instance of V1JogEnclosureWindowRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1JogEnclosureWindowRequest.parse_obj(obj)
+
+        _obj = V1JogEnclosureWindowRequest.parse_obj({
+            "degrees_per_second": obj.get("degreesPerSecond")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_jog_mount_request.py

@@ -0,0 +1,73 @@
+# 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 V1JogMountRequest(BaseModel):
+    """
+    Request to manually jog the mount at specified velocities for fine positioning adjustments. Set velocities to zero to stop movement.  # noqa: E501
+    """
+    motor_a_degrees_per_second: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="motorADegreesPerSecond", description="Angular velocity for motor A (azimuth/RA axis) in degrees per second. Positive values move in one direction, negative in the opposite. Zero stops movement.")
+    motor_b_degrees_per_second: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="motorBDegreesPerSecond", description="Angular velocity for motor B (altitude/Dec axis) in degrees per second. Positive values move in one direction, negative in the opposite. Zero stops movement.")
+    __properties = ["motorADegreesPerSecond", "motorBDegreesPerSecond"]
+
+    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) -> V1JogMountRequest:
+        """Create an instance of V1JogMountRequest 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) -> V1JogMountRequest:
+        """Create an instance of V1JogMountRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1JogMountRequest.parse_obj(obj)
+
+        _obj = V1JogMountRequest.parse_obj({
+            "motor_a_degrees_per_second": obj.get("motorADegreesPerSecond"),
+            "motor_b_degrees_per_second": obj.get("motorBDegreesPerSecond")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_last_sample.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 Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt
+
+class V1LastSample(BaseModel):
+    """
+    Last time sample received by network manager  # noqa: E501
+    """
+    original_offset: Union[StrictFloat, StrictInt] = Field(..., alias="originalOffset", description="Original measured offset in seconds")
+    adjusted_offset: Union[StrictFloat, StrictInt] = Field(..., alias="adjustedOffset", description="Adjusted offset after corrections in seconds")
+    margin: Union[StrictFloat, StrictInt] = Field(..., description="Estimated error margin in seconds")
+    __properties = ["originalOffset", "adjustedOffset", "margin"]
+
+    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) -> V1LastSample:
+        """Create an instance of V1LastSample 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) -> V1LastSample:
+        """Create an instance of V1LastSample from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1LastSample.parse_obj(obj)
+
+        _obj = V1LastSample.parse_obj({
+            "original_offset": obj.get("originalOffset"),
+            "adjusted_offset": obj.get("adjustedOffset"),
+            "margin": obj.get("margin")
+        })
+        return _obj
+
+