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

ourskyai_node_platform_api/models/plate_solve_started.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, StrictBool
+
+class PlateSolveStarted(BaseModel):
+    """
+    Event data for the start of an astrometric plate solve operation.  # noqa: E501
+    """
+    ignore_coordinates: StrictBool = Field(..., alias="ignoreCoordinates", description="When true, the plate solver performs a blind solve without using mount coordinates as a hint. This is slower but works even if the mount pointing is significantly off.")
+    __properties = ["ignoreCoordinates"]
+
+    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) -> PlateSolveStarted:
+        """Create an instance of PlateSolveStarted 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) -> PlateSolveStarted:
+        """Create an instance of PlateSolveStarted from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return PlateSolveStarted.parse_obj(obj)
+
+        _obj = PlateSolveStarted.parse_obj({
+            "ignore_coordinates": obj.get("ignoreCoordinates")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/platform_connection_diagnosis_report.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 PlatformConnectionDiagnosisReport(BaseModel):
+    """
+    Diagnostic results for the network connection to the cloud platform backend.  # noqa: E501
+    """
+    can_get_node: Optional[StrictBool] = Field(None, alias="canGetNode", description="True if the edge controller can successfully communicate with the platform API and retrieve node information.")
+    __properties = ["canGetNode"]
+
+    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) -> PlatformConnectionDiagnosisReport:
+        """Create an instance of PlatformConnectionDiagnosisReport 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) -> PlatformConnectionDiagnosisReport:
+        """Create an instance of PlatformConnectionDiagnosisReport from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return PlatformConnectionDiagnosisReport.parse_obj(obj)
+
+        _obj = PlatformConnectionDiagnosisReport.parse_obj({
+            "can_get_node": obj.get("canGetNode")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/point2_d.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 Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt
+
+class Point2D(BaseModel):
+    """
+    A two-dimensional point with x and y coordinates. Used for image positions and measurements.  # noqa: E501
+    """
+    x: Union[StrictFloat, StrictInt] = Field(..., description="The x coordinate of the point. For image coordinates, this is typically the column position in pixels.")
+    y: Union[StrictFloat, StrictInt] = Field(..., description="The y coordinate of the point. For image coordinates, this is typically the row position in pixels.")
+    __properties = ["x", "y"]
+
+    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) -> Point2D:
+        """Create an instance of Point2D 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) -> Point2D:
+        """Create an instance of Point2D from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return Point2D.parse_obj(obj)
+
+        _obj = Point2D.parse_obj({
+            "x": obj.get("x"),
+            "y": obj.get("y")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/relay_channel.py

@@ -0,0 +1,45 @@
+# 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 RelayChannel(str, Enum):
+    """
+    Legacy identifier for relay channels controlling observatory equipment (deprecated, see RelayFunction). MOUNT controls power to the telescope mount for tracking and slewing operations. UNIFI controls power to UniFi networking equipment such as switches and access points. PRIMARY_CAMERA controls power to the main imaging camera used for astronomical observations. UNIFI_PROTECT controls power to UniFi Protect security camera systems. WEATHER_STATION controls power to the local weather monitoring station. NODE_CONTROLLER controls power to the observatory node controller. FOCUSER controls power to the telescope focuser mechanism. 
+    """
+
+    """
+    allowed enum values
+    """
+    MOUNT = 'MOUNT'
+    UNIFI = 'UNIFI'
+    PRIMARY_CAMERA = 'PRIMARY_CAMERA'
+    UNIFI_PROTECT = 'UNIFI_PROTECT'
+    WEATHER_STATION = 'WEATHER_STATION'
+    NODE_CONTROLLER = 'NODE_CONTROLLER'
+    FOCUSER = 'FOCUSER'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> RelayChannel:
+        """Create an instance of RelayChannel from a JSON string"""
+        return RelayChannel(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/relay_function.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 RelayFunction(str, Enum):
+    """
+    Identifies the equipment function controlled by each power relay. MOUNT controls power to the telescope mount for tracking and slewing. NETWORK controls power to networking equipment such as switches and routers. PRIMARY_CAMERA controls power to the main imaging camera used for observations. SECURITY_CAMERA controls power to security and monitoring cameras. WEATHER_STATION controls power to the local weather monitoring station. EDGE_CONTROLLER controls power to the edge computing controller. FOCUSER controls power to the telescope focuser mechanism. ENCLOSURE controls power to the enclosure motors and controller. 
+    """
+
+    """
+    allowed enum values
+    """
+    MOUNT = 'MOUNT'
+    NETWORK = 'NETWORK'
+    PRIMARY_CAMERA = 'PRIMARY_CAMERA'
+    SECURITY_CAMERA = 'SECURITY_CAMERA'
+    WEATHER_STATION = 'WEATHER_STATION'
+    EDGE_CONTROLLER = 'EDGE_CONTROLLER'
+    FOCUSER = 'FOCUSER'
+    ENCLOSURE = 'ENCLOSURE'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> RelayFunction:
+        """Create an instance of RelayFunction from a JSON string"""
+        return RelayFunction(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/relays_diagnosis_report.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
+from pydantic import BaseModel, Field, StrictBool
+
+class RelaysDiagnosisReport(BaseModel):
+    """
+    Diagnostic results for the power relay controller used for equipment power management.  # noqa: E501
+    """
+    is_connected: Optional[StrictBool] = Field(None, alias="isConnected", description="True if the relay controller board is connected and responding to commands.")
+    can_power_cycle_mount: Optional[StrictBool] = Field(None, alias="canPowerCycleMount", description="True if the relay can successfully cycle power to the telescope mount for recovery purposes.")
+    can_power_cycle_astro_camera: Optional[StrictBool] = Field(None, alias="canPowerCycleAstroCamera", description="True if the relay can successfully cycle power to the astronomical camera for recovery purposes.")
+    __properties = ["isConnected", "canPowerCycleMount", "canPowerCycleAstroCamera"]
+
+    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) -> RelaysDiagnosisReport:
+        """Create an instance of RelaysDiagnosisReport 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) -> RelaysDiagnosisReport:
+        """Create an instance of RelaysDiagnosisReport from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return RelaysDiagnosisReport.parse_obj(obj)
+
+        _obj = RelaysDiagnosisReport.parse_obj({
+            "is_connected": obj.get("isConnected"),
+            "can_power_cycle_mount": obj.get("canPowerCycleMount"),
+            "can_power_cycle_astro_camera": obj.get("canPowerCycleAstroCamera")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/relays_status.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, StrictBool
+
+class RelaysStatus(BaseModel):
+    """
+    Connection status of the relay controller board.  # noqa: E501
+    """
+    connected: StrictBool = Field(..., description="True if the relay controller is connected and responding to commands.")
+    __properties = ["connected"]
+
+    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) -> RelaysStatus:
+        """Create an instance of RelaysStatus 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) -> RelaysStatus:
+        """Create an instance of RelaysStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return RelaysStatus.parse_obj(obj)
+
+        _obj = RelaysStatus.parse_obj({
+            "connected": obj.get("connected")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/relays_updated.py

@@ -0,0 +1,82 @@
+# 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.connection_status import ConnectionStatus
+from ourskyai_node_platform_api.models.v1_relay import V1Relay
+
+class RelaysUpdated(BaseModel):
+    """
+    Event data for a change in relay controller state or individual relay states.  # noqa: E501
+    """
+    connection_status: ConnectionStatus = Field(..., alias="connectionStatus")
+    relays: conlist(V1Relay) = Field(..., description="Array of all relay states showing the current on/off status of each controllable relay.")
+    __properties = ["connectionStatus", "relays"]
+
+    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) -> RelaysUpdated:
+        """Create an instance of RelaysUpdated 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 relays (list)
+        _items = []
+        if self.relays:
+            for _item in self.relays:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['relays'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> RelaysUpdated:
+        """Create an instance of RelaysUpdated from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return RelaysUpdated.parse_obj(obj)
+
+        _obj = RelaysUpdated.parse_obj({
+            "connection_status": obj.get("connectionStatus"),
+            "relays": [V1Relay.from_dict(_item) for _item in obj.get("relays")] if obj.get("relays") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/roof_diagnosis_report.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
+from pydantic import BaseModel, Field, StrictBool
+
+class RoofDiagnosisReport(BaseModel):
+    """
+    Diagnostic results for the roll-off roof or dome enclosure controller.  # noqa: E501
+    """
+    is_connected: Optional[StrictBool] = Field(None, alias="isConnected", description="True if the roof or dome controller is connected and responding to commands.")
+    can_open: Optional[StrictBool] = Field(None, alias="canOpen", description="True if the roof or dome can successfully open to expose the telescope to the sky.")
+    can_close: Optional[StrictBool] = Field(None, alias="canClose", description="True if the roof or dome can successfully close to protect the telescope from weather.")
+    __properties = ["isConnected", "canOpen", "canClose"]
+
+    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) -> RoofDiagnosisReport:
+        """Create an instance of RoofDiagnosisReport 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) -> RoofDiagnosisReport:
+        """Create an instance of RoofDiagnosisReport from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return RoofDiagnosisReport.parse_obj(obj)
+
+        _obj = RoofDiagnosisReport.parse_obj({
+            "is_connected": obj.get("isConnected"),
+            "can_open": obj.get("canOpen"),
+            "can_close": obj.get("canClose")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/roof_state.py

@@ -0,0 +1,50 @@
+# 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 RoofState(str, Enum):
+    """
+    Represents the current operational state of the roll-off roof system (deprecated, see EnclosureState). OPENED indicates the roof is fully retracted and the sky is accessible. CLOSED indicates the roof is fully closed and sealed. ROOF_ERROR indicates an error condition requiring investigation and resolution. PARKING_MOUNT indicates the mount is being parked before roof operation can proceed. UNKNOWN indicates the state cannot be determined, possibly due to communication issues. MOVING_OPEN_FRONT indicates the front panel is currently retracting. MOVING_CLOSE_FRONT indicates the front panel is currently closing. HOMING_FRONT indicates the front panel is performing a position calibration sequence. HOMING_REAR indicates the rear panel is performing a position calibration sequence. MOVING_OPEN_REAR indicates the rear panel is currently retracting. MOVING_CLOSE_REAR indicates the rear panel is currently closing. HALTED indicates all motion was stopped by a halt command. 
+    """
+
+    """
+    allowed enum values
+    """
+    OPENED = 'OPENED'
+    CLOSED = 'CLOSED'
+    ROOF_ERROR = 'ROOF_ERROR'
+    PARKING_MOUNT = 'PARKING_MOUNT'
+    UNKNOWN = 'UNKNOWN'
+    MOVING_OPEN_FRONT = 'MOVING_OPEN_FRONT'
+    MOVING_CLOSE_FRONT = 'MOVING_CLOSE_FRONT'
+    HOMING_FRONT = 'HOMING_FRONT'
+    HOMING_REAR = 'HOMING_REAR'
+    MOVING_OPEN_REAR = 'MOVING_OPEN_REAR'
+    MOVING_CLOSE_REAR = 'MOVING_CLOSE_REAR'
+    HALTED = 'HALTED'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> RoofState:
+        """Create an instance of RoofState from a JSON string"""
+        return RoofState(json.loads(json_str))
+
+