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

ourskyai_node_platform_api/models/v1_disable_live_video_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 pydantic import BaseModel, Field, StrictStr
+
+class V1DisableLiveVideoRequest(BaseModel):
+    """
+    Disable Live Video  # noqa: E501
+    """
+    camera_id: StrictStr = Field(..., alias="cameraId")
+    __properties = ["cameraId"]
+
+    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) -> V1DisableLiveVideoRequest:
+        """Create an instance of V1DisableLiveVideoRequest 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) -> V1DisableLiveVideoRequest:
+        """Create an instance of V1DisableLiveVideoRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1DisableLiveVideoRequest.parse_obj(obj)
+
+        _obj = V1DisableLiveVideoRequest.parse_obj({
+            "camera_id": obj.get("cameraId")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_elevation_mask.py

@@ -0,0 +1,81 @@
+# 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
+from pydantic import BaseModel, Field, conlist
+from ourskyai_node_platform_api.models.v1_elevation_mask_point import V1ElevationMaskPoint
+
+class V1ElevationMask(BaseModel):
+    """
+    Defines the observable sky boundaries accounting for local obstructions at each azimuth angle. Used for observation planning and scheduling.  # noqa: E501
+    """
+    points: conlist(V1ElevationMaskPoint) = Field(..., description="Array of elevation mask points defining the observable altitude range at various azimuth positions around the horizon.")
+    created_at: datetime = Field(..., alias="createdAt", description="ISO 8601 timestamp indicating when this elevation mask was created. Use this to determine if the mask needs updating after site changes.")
+    __properties = ["points", "createdAt"]
+
+    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) -> V1ElevationMask:
+        """Create an instance of V1ElevationMask 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 points (list)
+        _items = []
+        if self.points:
+            for _item in self.points:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['points'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1ElevationMask:
+        """Create an instance of V1ElevationMask from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1ElevationMask.parse_obj(obj)
+
+        _obj = V1ElevationMask.parse_obj({
+            "points": [V1ElevationMaskPoint.from_dict(_item) for _item in obj.get("points")] if obj.get("points") is not None else None,
+            "created_at": obj.get("createdAt")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_elevation_mask_point.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 V1ElevationMaskPoint(BaseModel):
+    """
+    A single point in the elevation mask defining the observable altitude range at a specific azimuth.  # noqa: E501
+    """
+    azimuth_degrees: Union[StrictFloat, StrictInt] = Field(..., alias="azimuthDegrees", description="Azimuth angle in degrees where this mask point applies. Measured clockwise from north (0-360 degrees).")
+    min_altitude_degrees: Union[StrictFloat, StrictInt] = Field(..., alias="minAltitudeDegrees", description="Minimum observable altitude in degrees at this azimuth due to local obstructions like buildings, trees, or terrain.")
+    max_altitude_degrees: Union[StrictFloat, StrictInt] = Field(..., alias="maxAltitudeDegrees", description="Maximum observable altitude in degrees at this azimuth. May be less than 90 degrees if overhead obstructions exist.")
+    __properties = ["azimuthDegrees", "minAltitudeDegrees", "maxAltitudeDegrees"]
+
+    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) -> V1ElevationMaskPoint:
+        """Create an instance of V1ElevationMaskPoint 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) -> V1ElevationMaskPoint:
+        """Create an instance of V1ElevationMaskPoint from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1ElevationMaskPoint.parse_obj(obj)
+
+        _obj = V1ElevationMaskPoint.parse_obj({
+            "azimuth_degrees": obj.get("azimuthDegrees"),
+            "min_altitude_degrees": obj.get("minAltitudeDegrees"),
+            "max_altitude_degrees": obj.get("maxAltitudeDegrees")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_enable_live_video_request.py

@@ -0,0 +1,81 @@
+# 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 V1EnableLiveVideoRequest(BaseModel):
+    """
+    Enable Live Video  # noqa: E501
+    """
+    camera_id: StrictStr = Field(..., alias="cameraId")
+    exposure: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Exposure duration in seconds")
+    gain: Optional[StrictInt] = None
+    binning: Optional[StrictInt] = None
+    offset: Optional[StrictInt] = None
+    gain_mode: Optional[StrictInt] = Field(1, alias="gainMode")
+    __properties = ["cameraId", "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) -> V1EnableLiveVideoRequest:
+        """Create an instance of V1EnableLiveVideoRequest 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) -> V1EnableLiveVideoRequest:
+        """Create an instance of V1EnableLiveVideoRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1EnableLiveVideoRequest.parse_obj(obj)
+
+        _obj = V1EnableLiveVideoRequest.parse_obj({
+            "camera_id": obj.get("cameraId"),
+            "exposure": obj.get("exposure"),
+            "gain": obj.get("gain"),
+            "binning": obj.get("binning"),
+            "offset": obj.get("offset"),
+            "gain_mode": obj.get("gainMode") if obj.get("gainMode") is not None else 1
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_enclosure_rotator_status.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, StrictBool, StrictFloat, StrictInt
+
+class V1EnclosureRotatorStatus(BaseModel):
+    """
+    Comprehensive status information for the dome rotator mechanism including connectivity, current azimuth position, and mount tracking state. Use this to verify proper dome alignment before and during observations.  # noqa: E501
+    """
+    connected: StrictBool = Field(..., description="Indicates whether the rotator controller is currently connected and responding to commands. A false value means the dome cannot be rotated or its position monitored.")
+    azimuth_degrees: Union[StrictFloat, StrictInt] = Field(..., alias="azimuthDegrees", description="The current rotational position of the dome in degrees from north. Values range from 0 to 360, where 0/360 is north, 90 is east, 180 is south, and 270 is west.")
+    is_synced_with_mount: StrictBool = Field(..., alias="isSyncedWithMount", description="Indicates whether the dome is actively tracking the telescope mount position. When true, the dome automatically rotates to keep the aperture aligned with telescope pointing.")
+    __properties = ["connected", "azimuthDegrees", "isSyncedWithMount"]
+
+    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) -> V1EnclosureRotatorStatus:
+        """Create an instance of V1EnclosureRotatorStatus 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) -> V1EnclosureRotatorStatus:
+        """Create an instance of V1EnclosureRotatorStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1EnclosureRotatorStatus.parse_obj(obj)
+
+        _obj = V1EnclosureRotatorStatus.parse_obj({
+            "connected": obj.get("connected"),
+            "azimuth_degrees": obj.get("azimuthDegrees"),
+            "is_synced_with_mount": obj.get("isSyncedWithMount")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_enclosure_shutter_status.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
+from ourskyai_node_platform_api.models.enclosure_shutter_label import EnclosureShutterLabel
+from ourskyai_node_platform_api.models.enclosure_shutter_state import EnclosureShutterState
+
+class V1EnclosureShutterStatus(BaseModel):
+    """
+    Detailed status information for a single shutter panel including its identification, connectivity, operational state, and current position. Use this to monitor individual panel behavior during operations.  # noqa: E501
+    """
+    label: EnclosureShutterLabel = Field(...)
+    connected: StrictBool = Field(..., description="Indicates whether the shutter controller is currently connected and responding. A false value means this shutter cannot be commanded or monitored reliably.")
+    state: EnclosureShutterState = Field(...)
+    position_percent: Union[StrictFloat, StrictInt] = Field(..., alias="positionPercent", description="The current position of the shutter as a percentage from 0 to 100. A value of 0 indicates fully closed, 100 indicates fully open. Intermediate values show partial opening during movement or after a halt.")
+    __properties = ["label", "connected", "state", "positionPercent"]
+
+    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) -> V1EnclosureShutterStatus:
+        """Create an instance of V1EnclosureShutterStatus 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) -> V1EnclosureShutterStatus:
+        """Create an instance of V1EnclosureShutterStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1EnclosureShutterStatus.parse_obj(obj)
+
+        _obj = V1EnclosureShutterStatus.parse_obj({
+            "label": obj.get("label"),
+            "connected": obj.get("connected"),
+            "state": obj.get("state"),
+            "position_percent": obj.get("positionPercent")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_enclosure_shutter_statuses.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_enclosure_shutter_status import V1EnclosureShutterStatus
+
+class V1EnclosureShutterStatuses(BaseModel):
+    """
+    Container object holding the status information for all shutter panels in the enclosure system. This provides a complete view of shutter states for monitoring and control decisions.  # noqa: E501
+    """
+    statuses: conlist(V1EnclosureShutterStatus) = Field(..., description="Array containing the status of each shutter panel in the enclosure. Typically contains entries for shutters A and B, though the number may vary by enclosure configuration.")
+    __properties = ["statuses"]
+
+    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) -> V1EnclosureShutterStatuses:
+        """Create an instance of V1EnclosureShutterStatuses 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 statuses (list)
+        _items = []
+        if self.statuses:
+            for _item in self.statuses:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['statuses'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1EnclosureShutterStatuses:
+        """Create an instance of V1EnclosureShutterStatuses from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1EnclosureShutterStatuses.parse_obj(obj)
+
+        _obj = V1EnclosureShutterStatuses.parse_obj({
+            "statuses": [V1EnclosureShutterStatus.from_dict(_item) for _item in obj.get("statuses")] if obj.get("statuses") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_enclosure_status.py

@@ -0,0 +1,78 @@
+# 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, StrictBool, StrictInt
+from ourskyai_node_platform_api.models.enclosure_state import EnclosureState
+
+class V1EnclosureStatus(BaseModel):
+    """
+    Contains the complete status information for the observatory enclosure including connectivity, operational state, and panel positions. This object provides all necessary information to determine if the enclosure is ready for observations.  # noqa: E501
+    """
+    connected: StrictBool = Field(..., description="Indicates whether the enclosure controller is currently connected and communicating. A false value means commands cannot be sent to the enclosure system.")
+    state: EnclosureState = Field(...)
+    front_position: StrictInt = Field(..., alias="frontPosition", description="The current position of the front roof panel as encoder counts. Higher values indicate more open positions. Use this to track movement progress during open/close operations.")
+    rear_position: StrictInt = Field(..., alias="rearPosition", description="The current position of the rear roof panel as encoder counts. Higher values indicate more open positions. Use this to track movement progress during open/close operations.")
+    __properties = ["connected", "state", "frontPosition", "rearPosition"]
+
+    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) -> V1EnclosureStatus:
+        """Create an instance of V1EnclosureStatus 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) -> V1EnclosureStatus:
+        """Create an instance of V1EnclosureStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1EnclosureStatus.parse_obj(obj)
+
+        _obj = V1EnclosureStatus.parse_obj({
+            "connected": obj.get("connected"),
+            "state": obj.get("state"),
+            "front_position": obj.get("frontPosition"),
+            "rear_position": obj.get("rearPosition")
+        })
+        return _obj
+
+