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

ourskyai_node_platform_api/models/v1_system_time.py

@@ -0,0 +1,94 @@
+# 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 Optional, Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt
+from ourskyai_node_platform_api.models.v1_gnss_pps_status import V1GnssPpsStatus
+from ourskyai_node_platform_api.models.v1_ntp_status import V1NtpStatus
+from ourskyai_node_platform_api.models.v1_ptp_status import V1PtpStatus
+from ourskyai_node_platform_api.models.v1_time_source import V1TimeSource
+
+class V1SystemTime(BaseModel):
+    """
+    Comprehensive time synchronization status including the current system time, active time source, and detailed status for all available time sources.  # noqa: E501
+    """
+    current_time_source: V1TimeSource = Field(..., alias="currentTimeSource")
+    current_system_time: datetime = Field(..., alias="currentSystemTime", description="Current system time in ISO 8601 format. This is the authoritative time used for all timestamping operations on the edge controller.")
+    time_uncertainty_seconds: Union[StrictFloat, StrictInt] = Field(..., alias="timeUncertaintySeconds", description="Estimated uncertainty of the system time in seconds. Lower values indicate higher confidence in time accuracy. Critical for precise astronomical timing.")
+    ptp: Optional[V1PtpStatus] = None
+    gnss_pps: Optional[V1GnssPpsStatus] = Field(None, alias="gnssPps")
+    ntp: Optional[V1NtpStatus] = None
+    __properties = ["currentTimeSource", "currentSystemTime", "timeUncertaintySeconds", "ptp", "gnssPps", "ntp"]
+
+    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) -> V1SystemTime:
+        """Create an instance of V1SystemTime 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 ptp
+        if self.ptp:
+            _dict['ptp'] = self.ptp.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of gnss_pps
+        if self.gnss_pps:
+            _dict['gnssPps'] = self.gnss_pps.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of ntp
+        if self.ntp:
+            _dict['ntp'] = self.ntp.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SystemTime:
+        """Create an instance of V1SystemTime from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemTime.parse_obj(obj)
+
+        _obj = V1SystemTime.parse_obj({
+            "current_time_source": obj.get("currentTimeSource"),
+            "current_system_time": obj.get("currentSystemTime"),
+            "time_uncertainty_seconds": obj.get("timeUncertaintySeconds"),
+            "ptp": V1PtpStatus.from_dict(obj.get("ptp")) if obj.get("ptp") is not None else None,
+            "gnss_pps": V1GnssPpsStatus.from_dict(obj.get("gnssPps")) if obj.get("gnssPps") is not None else None,
+            "ntp": V1NtpStatus.from_dict(obj.get("ntp")) if obj.get("ntp") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_variant.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 V1SystemVariant(str, Enum):
+    """
+    V1SystemVariant
+    """
+
+    """
+    allowed enum values
+    """
+    ENCLOSURE_300 = 'ENCLOSURE_300'
+    ENCLOSURE_700_OR_1000 = 'ENCLOSURE_700_OR_1000'
+    STANDALONE_RC_700_OR_1000 = 'STANDALONE_RC_700_OR_1000'
+    WEATHERIZED = 'WEATHERIZED'
+    CUSTOM = 'CUSTOM'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1SystemVariant:
+        """Create an instance of V1SystemVariant from a JSON string"""
+        return V1SystemVariant(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/v1_task.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 datetime import datetime
+from typing import Optional
+from pydantic import BaseModel, Field, StrictStr
+from ourskyai_node_platform_api.models.v1_task_type import V1TaskType
+
+class V1Task(BaseModel):
+    """
+    Represents a scheduled or running task in the telescope system with its execution timing and type information.  # noqa: E501
+    """
+    id: StrictStr = Field(..., description="Unique identifier for this task. Use this ID to cancel the task or track its progress.")
+    type: V1TaskType = Field(...)
+    scheduled_at: datetime = Field(..., alias="scheduledAt", description="ISO 8601 timestamp when the task was scheduled to run. For immediate tasks, this is the creation time.")
+    started_at: Optional[datetime] = Field(None, alias="startedAt", description="ISO 8601 timestamp when the task actually began execution. Null if the task is still waiting to start.")
+    __properties = ["id", "type", "scheduledAt", "startedAt"]
+
+    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) -> V1Task:
+        """Create an instance of V1Task 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) -> V1Task:
+        """Create an instance of V1Task from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1Task.parse_obj(obj)
+
+        _obj = V1Task.parse_obj({
+            "id": obj.get("id"),
+            "type": obj.get("type"),
+            "scheduled_at": obj.get("scheduledAt"),
+            "started_at": obj.get("startedAt")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_task_type.py

@@ -0,0 +1,47 @@
+# 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 V1TaskType(str, Enum):
+    """
+    Type classification for system tasks. CREATE_MOUNT_MODEL builds a pointing model by measuring and correcting for mount alignment errors. CREATE_ELEVATION_MASK generates a horizon obstruction map for the observatory location. RUN_AUTOFOCUS executes an automated focus optimization routine. RUN_PERPETUAL_INSTRUCTION_LOOP continuously executes observation sequences. STARTUP_WIZARD guides initial telescope setup and configuration. SET_CAMERA_TEMPERATURE manages camera cooling to target temperature. ENGAGE_ADHOC_DEPLOYMENT activates portable operation mode. RUN_SLEW_DEMO performs a demonstration slew sequence. TAKE_CALIBRATION_FRAMES captures bias, dark, or flat calibration images. 
+    """
+
+    """
+    allowed enum values
+    """
+    CREATE_MOUNT_MODEL = 'CREATE_MOUNT_MODEL'
+    CREATE_ELEVATION_MASK = 'CREATE_ELEVATION_MASK'
+    RUN_AUTOFOCUS = 'RUN_AUTOFOCUS'
+    RUN_PERPETUAL_INSTRUCTION_LOOP = 'RUN_PERPETUAL_INSTRUCTION_LOOP'
+    STARTUP_WIZARD = 'STARTUP_WIZARD'
+    SET_CAMERA_TEMPERATURE = 'SET_CAMERA_TEMPERATURE'
+    ENGAGE_ADHOC_DEPLOYMENT = 'ENGAGE_ADHOC_DEPLOYMENT'
+    RUN_SLEW_DEMO = 'RUN_SLEW_DEMO'
+    TAKE_CALIBRATION_FRAMES = 'TAKE_CALIBRATION_FRAMES'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1TaskType:
+        """Create an instance of V1TaskType from a JSON string"""
+        return V1TaskType(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/v1_time_source.py

@@ -0,0 +1,42 @@
+# 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 V1TimeSource(str, Enum):
+    """
+    Identifies the source used for system time synchronization, listed in order of typical precision from highest to lowest.
+    """
+
+    """
+    allowed enum values
+    """
+    PTP = 'PTP'
+    GNSS_PPS = 'GNSS_PPS'
+    NTP = 'NTP'
+    UNKNOWN = 'UNKNOWN'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1TimeSource:
+        """Create an instance of V1TimeSource from a JSON string"""
+        return V1TimeSource(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/v1_time_windowed_asset.py

@@ -0,0 +1,86 @@
+# 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 pydantic import BaseModel, Field, StrictStr
+from ourskyai_node_platform_api.models.v1_time_windowed_asset_type import V1TimeWindowedAssetType
+
+class V1TimeWindowedAsset(BaseModel):
+    """
+    V1TimeWindowedAsset  # noqa: E501
+    """
+    id: StrictStr = Field(...)
+    description: StrictStr = Field(...)
+    url: StrictStr = Field(...)
+    node_id: StrictStr = Field(..., alias="nodeId")
+    asset_type: V1TimeWindowedAssetType = Field(..., alias="assetType")
+    asset_start_time: datetime = Field(..., alias="assetStartTime")
+    asset_end_time: datetime = Field(..., alias="assetEndTime")
+    created_at: datetime = Field(..., alias="createdAt")
+    __properties = ["id", "description", "url", "nodeId", "assetType", "assetStartTime", "assetEndTime", "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) -> V1TimeWindowedAsset:
+        """Create an instance of V1TimeWindowedAsset 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) -> V1TimeWindowedAsset:
+        """Create an instance of V1TimeWindowedAsset from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1TimeWindowedAsset.parse_obj(obj)
+
+        _obj = V1TimeWindowedAsset.parse_obj({
+            "id": obj.get("id"),
+            "description": obj.get("description"),
+            "url": obj.get("url"),
+            "node_id": obj.get("nodeId"),
+            "asset_type": obj.get("assetType"),
+            "asset_start_time": obj.get("assetStartTime"),
+            "asset_end_time": obj.get("assetEndTime"),
+            "created_at": obj.get("createdAt")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_time_windowed_asset_type.py

@@ -0,0 +1,40 @@
+# 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 V1TimeWindowedAssetType(str, Enum):
+    """
+    V1TimeWindowedAssetType
+    """
+
+    """
+    allowed enum values
+    """
+    TIMELAPSE = 'TIMELAPSE'
+    KEOGRAM = 'KEOGRAM'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1TimeWindowedAssetType:
+        """Create an instance of V1TimeWindowedAssetType from a JSON string"""
+        return V1TimeWindowedAssetType(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/v1_turn_off_optical_tube_fans_request.py

@@ -0,0 +1,72 @@
+# 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_role import V1OpticalTubeFanRole
+
+class V1TurnOffOpticalTubeFansRequest(BaseModel):
+    """
+    Request to turn off specific fans in the optical tube assembly by their roles.  # noqa: E501
+    """
+    roles: conlist(V1OpticalTubeFanRole) = Field(..., description="List of fan roles to turn off. Multiple fans can be deactivated in a single request. Only the specified fans will be affected.")
+    __properties = ["roles"]
+
+    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) -> V1TurnOffOpticalTubeFansRequest:
+        """Create an instance of V1TurnOffOpticalTubeFansRequest 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) -> V1TurnOffOpticalTubeFansRequest:
+        """Create an instance of V1TurnOffOpticalTubeFansRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1TurnOffOpticalTubeFansRequest.parse_obj(obj)
+
+        _obj = V1TurnOffOpticalTubeFansRequest.parse_obj({
+            "roles": obj.get("roles")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_turn_on_optical_tube_fans_request.py

@@ -0,0 +1,72 @@
+# 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_role import V1OpticalTubeFanRole
+
+class V1TurnOnOpticalTubeFansRequest(BaseModel):
+    """
+    Request to turn on specific fans in the optical tube assembly by their roles.  # noqa: E501
+    """
+    roles: conlist(V1OpticalTubeFanRole) = Field(..., description="List of fan roles to turn on. Multiple fans can be activated in a single request. Only the specified fans will be affected.")
+    __properties = ["roles"]
+
+    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) -> V1TurnOnOpticalTubeFansRequest:
+        """Create an instance of V1TurnOnOpticalTubeFansRequest 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) -> V1TurnOnOpticalTubeFansRequest:
+        """Create an instance of V1TurnOnOpticalTubeFansRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1TurnOnOpticalTubeFansRequest.parse_obj(obj)
+
+        _obj = V1TurnOnOpticalTubeFansRequest.parse_obj({
+            "roles": obj.get("roles")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_ui_operation_mode.py

@@ -0,0 +1,40 @@
+# 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 V1UIOperationMode(str, Enum):
+    """
+    Indicates how the user interface interacts with the telescope control system.
+    """
+
+    """
+    allowed enum values
+    """
+    EMBEDDED = 'EMBEDDED'
+    MANUAL = 'MANUAL'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1UIOperationMode:
+        """Create an instance of V1UIOperationMode from a JSON string"""
+        return V1UIOperationMode(json.loads(json_str))
+
+