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

ourskyai_node_platform_api/models/v1_node_status.py

@@ -0,0 +1,43 @@
+# 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 V1NodeStatus(str, Enum):
+    """
+    V1NodeStatus
+    """
+
+    """
+    allowed enum values
+    """
+    IMAGING = 'IMAGING'
+    DIAGNOSTICS = 'DIAGNOSTICS'
+    UNSAFE = 'UNSAFE'
+    INACTIVE = 'INACTIVE'
+    IDLE = 'IDLE'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1NodeStatus:
+        """Create an instance of V1NodeStatus from a JSON string"""
+        return V1NodeStatus(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/v1_ntp_status.py

@@ -0,0 +1,88 @@
+# 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
+from pydantic import BaseModel, Field, StrictBool
+from ourskyai_node_platform_api.models.v1_ntp_status_details import V1NtpStatusDetails
+from ourskyai_node_platform_api.models.v1_source_statistics import V1SourceStatistics
+
+class V1NtpStatus(BaseModel):
+    """
+    V1NtpStatus
+    """
+    connected: StrictBool = Field(..., description="Whether an NTP source is connected and reachable")
+    status: Optional[V1NtpStatusDetails] = None
+    source_statistics: V1SourceStatistics = Field(..., alias="sourceStatistics")
+    __properties = ["connected", "status", "sourceStatistics"]
+
+    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) -> V1NtpStatus:
+        """Create an instance of V1NtpStatus 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 status
+        if self.status:
+            _dict['status'] = self.status.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of source_statistics
+        if self.source_statistics:
+            _dict['sourceStatistics'] = self.source_statistics.to_dict()
+        # set to None if status (nullable) is None
+        # and __fields_set__ contains the field
+        if self.status is None and "status" in self.__fields_set__:
+            _dict['status'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1NtpStatus:
+        """Create an instance of V1NtpStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1NtpStatus.parse_obj(obj)
+
+        _obj = V1NtpStatus.parse_obj({
+            "connected": obj.get("connected"),
+            "status": V1NtpStatusDetails.from_dict(obj.get("status")) if obj.get("status") is not None else None,
+            "source_statistics": V1SourceStatistics.from_dict(obj.get("sourceStatistics")) if obj.get("sourceStatistics") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_ntp_status_details.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 List, Optional
+from pydantic import BaseModel, Field, StrictStr, conlist
+
+class V1NtpStatusDetails(BaseModel):
+    """
+    Detailed NTP status information  # noqa: E501
+    """
+    pool_address: Optional[StrictStr] = Field(None, alias="poolAddress", description="Address of the NTP pool being used")
+    peer_addresses: Optional[conlist(StrictStr)] = Field(None, alias="peerAddresses", description="List of NTP peer server addresses")
+    __properties = ["poolAddress", "peerAddresses"]
+
+    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) -> V1NtpStatusDetails:
+        """Create an instance of V1NtpStatusDetails 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) -> V1NtpStatusDetails:
+        """Create an instance of V1NtpStatusDetails from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1NtpStatusDetails.parse_obj(obj)
+
+        _obj = V1NtpStatusDetails.parse_obj({
+            "pool_address": obj.get("poolAddress"),
+            "peer_addresses": obj.get("peerAddresses")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_open_enclosure_shutters_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 Optional
+from pydantic import BaseModel, Field, StrictBool
+
+class V1OpenEnclosureShuttersRequest(BaseModel):
+    """
+    Request parameters for opening enclosure shutters. Includes optional safety override settings for manual operation scenarios.  # noqa: E501
+    """
+    ignore_safety: Optional[StrictBool] = Field(None, alias="ignoreSafety", description="When set to true, bypasses safety interlock checks and forces the shutters to open regardless of weather or other safety conditions. Use with caution and only when manual observation confirms safe conditions. Default is false, which enforces all safety checks.")
+    __properties = ["ignoreSafety"]
+
+    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) -> V1OpenEnclosureShuttersRequest:
+        """Create an instance of V1OpenEnclosureShuttersRequest 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) -> V1OpenEnclosureShuttersRequest:
+        """Create an instance of V1OpenEnclosureShuttersRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1OpenEnclosureShuttersRequest.parse_obj(obj)
+
+        _obj = V1OpenEnclosureShuttersRequest.parse_obj({
+            "ignore_safety": obj.get("ignoreSafety")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_open_roof_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 Optional
+from pydantic import BaseModel, Field, StrictBool
+
+class V1OpenRoofRequest(BaseModel):
+    """
+    Optional request body containing safety override settings for the roof open operation.  # noqa: E501
+    """
+    ignore_safety: Optional[StrictBool] = Field(None, alias="ignoreSafety", description="When set to true, bypasses safety interlock checks and forces the roof to open regardless of weather or other safety conditions. Use with extreme caution and only when manual verification confirms safe conditions. Default is false.")
+    __properties = ["ignoreSafety"]
+
+    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) -> V1OpenRoofRequest:
+        """Create an instance of V1OpenRoofRequest 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) -> V1OpenRoofRequest:
+        """Create an instance of V1OpenRoofRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1OpenRoofRequest.parse_obj(obj)
+
+        _obj = V1OpenRoofRequest.parse_obj({
+            "ignore_safety": obj.get("ignoreSafety")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_optical_tube_cover_status.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 pydantic import BaseModel, Field, StrictBool
+
+class V1OpticalTubeCoverStatus(BaseModel):
+    """
+    Current status of the optical tube dust cover including connection state and open/closed position.  # noqa: E501
+    """
+    connected: StrictBool = Field(..., description="Indicates whether communication with the cover controller is active. When false, the cover cannot be operated and its state may be unknown.")
+    is_open: StrictBool = Field(..., alias="isOpen", description="Indicates whether the cover is currently open. True means the cover is fully open and the primary mirror is exposed for observing. False means the cover is closed and protecting the mirror.")
+    __properties = ["connected", "isOpen"]
+
+    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) -> V1OpticalTubeCoverStatus:
+        """Create an instance of V1OpticalTubeCoverStatus 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) -> V1OpticalTubeCoverStatus:
+        """Create an instance of V1OpticalTubeCoverStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1OpticalTubeCoverStatus.parse_obj(obj)
+
+        _obj = V1OpticalTubeCoverStatus.parse_obj({
+            "connected": obj.get("connected"),
+            "is_open": obj.get("isOpen")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_optical_tube_fan_role.py

@@ -0,0 +1,46 @@
+# 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 V1OpticalTubeFanRole(str, Enum):
+    """
+    Identifies the specific fan location and purpose within the optical tube assembly. M1 refers to the primary mirror, M2 to the secondary mirror, and M3 to the tertiary mirror. HEATER variants are fans associated with the dew heater systems.
+    """
+
+    """
+    allowed enum values
+    """
+    M1 = 'M1'
+    M1_REAR = 'M1_REAR'
+    M1_SIDE = 'M1_SIDE'
+    M2 = 'M2'
+    M3 = 'M3'
+    M1_HEATER = 'M1_HEATER'
+    M2_HEATER = 'M2_HEATER'
+    M3_HEATER = 'M3_HEATER'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1OpticalTubeFanRole:
+        """Create an instance of V1OpticalTubeFanRole from a JSON string"""
+        return V1OpticalTubeFanRole(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/v1_optical_tube_fan_status.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, StrictBool
+from ourskyai_node_platform_api.models.v1_optical_tube_fan_role import V1OpticalTubeFanRole
+
+class V1OpticalTubeFanStatus(BaseModel):
+    """
+    Status information for a single cooling fan in the optical tube assembly.  # noqa: E501
+    """
+    connected: StrictBool = Field(..., description="Indicates whether communication with this fan controller is active. When false, the fan cannot be controlled and its state may be unknown.")
+    role: V1OpticalTubeFanRole = Field(...)
+    is_on: StrictBool = Field(..., alias="isOn", description="Indicates whether this fan is currently running. True when the fan is actively spinning, false when stopped.")
+    __properties = ["connected", "role", "isOn"]
+
+    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) -> V1OpticalTubeFanStatus:
+        """Create an instance of V1OpticalTubeFanStatus 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) -> V1OpticalTubeFanStatus:
+        """Create an instance of V1OpticalTubeFanStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1OpticalTubeFanStatus.parse_obj(obj)
+
+        _obj = V1OpticalTubeFanStatus.parse_obj({
+            "connected": obj.get("connected"),
+            "role": obj.get("role"),
+            "is_on": obj.get("isOn")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_optical_tube_fan_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_optical_tube_fan_status import V1OpticalTubeFanStatus
+
+class V1OpticalTubeFanStatuses(BaseModel):
+    """
+    Collection of status information for all cooling fans in the optical tube assembly. Provides a complete view of the fan subsystem state.  # noqa: E501
+    """
+    statuses: conlist(V1OpticalTubeFanStatus) = Field(..., description="Array of individual fan status objects, one for each fan in the optical tube assembly. The array includes all configured fans regardless of their current state.")
+    __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) -> V1OpticalTubeFanStatuses:
+        """Create an instance of V1OpticalTubeFanStatuses 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) -> V1OpticalTubeFanStatuses:
+        """Create an instance of V1OpticalTubeFanStatuses from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1OpticalTubeFanStatuses.parse_obj(obj)
+
+        _obj = V1OpticalTubeFanStatuses.parse_obj({
+            "statuses": [V1OpticalTubeFanStatus.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_optical_tube_heater_role.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 V1OpticalTubeHeaterRole(str, Enum):
+    """
+    Identifies the mirror associated with a specific dew heater. M1 is the primary mirror, M2 is the secondary mirror, and M3 is the tertiary mirror. Each heater is designed to prevent dew formation on its associated optical surface.
+    """
+
+    """
+    allowed enum values
+    """
+    M1 = 'M1'
+    M2 = 'M2'
+    M3 = 'M3'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1OpticalTubeHeaterRole:
+        """Create an instance of V1OpticalTubeHeaterRole from a JSON string"""
+        return V1OpticalTubeHeaterRole(json.loads(json_str))
+
+