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

ourskyai_node_platform_api/models/v1_run_blind_autofocus_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 V1RunBlindAutofocusRequest(BaseModel):
+    """
+    V1RunBlindAutofocusRequest
+    """
+    step_size: StrictInt = Field(..., alias="stepSize", description="The step size to use for moving the focuser")
+    r_squared_threshold: Optional[Union[StrictFloat, StrictInt]] = Field(0.7, alias="rSquaredThreshold", description="The r-squared threshold to use for the blind autofocus")
+    __properties = ["stepSize", "rSquaredThreshold"]
+
+    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) -> V1RunBlindAutofocusRequest:
+        """Create an instance of V1RunBlindAutofocusRequest 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) -> V1RunBlindAutofocusRequest:
+        """Create an instance of V1RunBlindAutofocusRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1RunBlindAutofocusRequest.parse_obj(obj)
+
+        _obj = V1RunBlindAutofocusRequest.parse_obj({
+            "step_size": obj.get("stepSize"),
+            "r_squared_threshold": obj.get("rSquaredThreshold") if obj.get("rSquaredThreshold") is not None else 0.7
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_safety_status.py

@@ -0,0 +1,83 @@
+# 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 V1SafetyStatus(BaseModel):
+    """
+    Comprehensive safety assessment for the observatory including individual safety factors and overall status. This information is critical for determining whether conditions allow safe telescope operations.  # noqa: E501
+    """
+    is_safe: StrictBool = Field(..., alias="isSafe", description="The overall safety determination combining all safety factors. True indicates conditions are safe for observations with the enclosure open. False indicates at least one safety condition is not met and the enclosure should remain closed or be closed.")
+    is_weather_safe: StrictBool = Field(..., alias="isWeatherSafe", description="Indicates whether current weather conditions are safe for observations. Factors include wind speed, humidity, rain detection, and temperature. False will contribute to an unsafe overall status.")
+    is_all_sky_safe: StrictBool = Field(..., alias="isAllSkySafe", description="Indicates whether the all-sky camera analysis shows safe sky conditions. This includes cloud cover assessment and sky brightness. False suggests cloudy or otherwise unsuitable sky conditions.")
+    is_night: StrictBool = Field(..., alias="isNight", description="Indicates whether it is currently astronomical night at the observatory location. True means the sun is sufficiently below the horizon for observations. The threshold is typically astronomical twilight.")
+    is_roof_open: StrictBool = Field(..., alias="isRoofOpen", description="Indicates whether the enclosure roof or shutters are currently open. True means the telescope has sky access. This is informational and does not directly affect the safety determination.")
+    is_manual_operation_mode: StrictBool = Field(..., alias="isManualOperationMode", description="Indicates whether the observatory is in manual operation mode. When true, safety interlocks may be overridden to allow manual control. Use with caution as automated safety protections are reduced.")
+    is_alpaca_safe: Optional[StrictBool] = Field(None, alias="isAlpacaSafe", description="Indicates the safety status as reported by ALPACA-compatible safety devices. This provides an additional safety signal from external safety monitoring equipment when available.")
+    __properties = ["isSafe", "isWeatherSafe", "isAllSkySafe", "isNight", "isRoofOpen", "isManualOperationMode", "isAlpacaSafe"]
+
+    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) -> V1SafetyStatus:
+        """Create an instance of V1SafetyStatus 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) -> V1SafetyStatus:
+        """Create an instance of V1SafetyStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SafetyStatus.parse_obj(obj)
+
+        _obj = V1SafetyStatus.parse_obj({
+            "is_safe": obj.get("isSafe"),
+            "is_weather_safe": obj.get("isWeatherSafe"),
+            "is_all_sky_safe": obj.get("isAllSkySafe"),
+            "is_night": obj.get("isNight"),
+            "is_roof_open": obj.get("isRoofOpen"),
+            "is_manual_operation_mode": obj.get("isManualOperationMode"),
+            "is_alpaca_safe": obj.get("isAlpacaSafe")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_save_image_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 V1SaveImageRequest(BaseModel):
+    """
+    Request object to mark an image as saved and protected from automatic deletion. Contains the identifier of the image to preserve.  # noqa: E501
+    """
+    id: StrictStr = Field(..., description="Unique identifier of the image to save. Once saved, the image will not be automatically deleted during storage cleanup operations.")
+    __properties = ["id"]
+
+    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) -> V1SaveImageRequest:
+        """Create an instance of V1SaveImageRequest 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) -> V1SaveImageRequest:
+        """Create an instance of V1SaveImageRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SaveImageRequest.parse_obj(obj)
+
+        _obj = V1SaveImageRequest.parse_obj({
+            "id": obj.get("id")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_set_mount_park_position_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 Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt
+
+class V1SetMountParkPositionRequest(BaseModel):
+    """
+    Request to set the mount park position using specific motor coordinates. The park position defines where the mount will move when the park command is issued.  # noqa: E501
+    """
+    motor_a_position_degrees: Union[StrictFloat, StrictInt] = Field(..., alias="motorAPositionDegrees", description="Target position for motor A (azimuth/RA axis) in degrees. This is the raw motor position the mount will move to when parking.")
+    motor_b_position_degrees: Union[StrictFloat, StrictInt] = Field(..., alias="motorBPositionDegrees", description="Target position for motor B (altitude/Dec axis) in degrees. This is the raw motor position the mount will move to when parking.")
+    __properties = ["motorAPositionDegrees", "motorBPositionDegrees"]
+
+    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) -> V1SetMountParkPositionRequest:
+        """Create an instance of V1SetMountParkPositionRequest 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) -> V1SetMountParkPositionRequest:
+        """Create an instance of V1SetMountParkPositionRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SetMountParkPositionRequest.parse_obj(obj)
+
+        _obj = V1SetMountParkPositionRequest.parse_obj({
+            "motor_a_position_degrees": obj.get("motorAPositionDegrees"),
+            "motor_b_position_degrees": obj.get("motorBPositionDegrees")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_set_optical_tube_heater_power_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 pydantic import BaseModel, Field, StrictInt
+from ourskyai_node_platform_api.models.v1_optical_tube_heater_role import V1OpticalTubeHeaterRole
+
+class V1SetOpticalTubeHeaterPowerRequest(BaseModel):
+    """
+    Request to set the power level for a specific dew heater identified by its role.  # noqa: E501
+    """
+    role: V1OpticalTubeHeaterRole = Field(...)
+    power: StrictInt = Field(..., description="Heater power level as a percentage from 0 (off) to 100 (full power). Adjust based on environmental conditions to balance dew prevention with thermal effects on imaging.")
+    __properties = ["role", "power"]
+
+    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) -> V1SetOpticalTubeHeaterPowerRequest:
+        """Create an instance of V1SetOpticalTubeHeaterPowerRequest 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) -> V1SetOpticalTubeHeaterPowerRequest:
+        """Create an instance of V1SetOpticalTubeHeaterPowerRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SetOpticalTubeHeaterPowerRequest.parse_obj(obj)
+
+        _obj = V1SetOpticalTubeHeaterPowerRequest.parse_obj({
+            "role": obj.get("role"),
+            "power": obj.get("power")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_set_peer_status_request.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 Dict, List, Optional
+from pydantic import BaseModel, Field, StrictStr, conlist
+from ourskyai_node_platform_api.models.peer_role import PeerRole
+
+class V1SetPeerStatusRequest(BaseModel):
+    """
+    Set peer status request  # noqa: E501
+    """
+    type: StrictStr = Field(..., description="Type of message")
+    peer_id: Optional[StrictStr] = Field(None, alias="peerId", description="optional peer ID")
+    roles: conlist(PeerRole) = Field(..., description="List of roles for the peer")
+    meta: Optional[Dict[str, StrictStr]] = Field(None, description="Optional metadata map")
+    __properties = ["type", "peerId", "roles", "meta"]
+
+    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) -> V1SetPeerStatusRequest:
+        """Create an instance of V1SetPeerStatusRequest 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)
+        # set to None if peer_id (nullable) is None
+        # and __fields_set__ contains the field
+        if self.peer_id is None and "peer_id" in self.__fields_set__:
+            _dict['peerId'] = None
+
+        # set to None if meta (nullable) is None
+        # and __fields_set__ contains the field
+        if self.meta is None and "meta" in self.__fields_set__:
+            _dict['meta'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SetPeerStatusRequest:
+        """Create an instance of V1SetPeerStatusRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SetPeerStatusRequest.parse_obj(obj)
+
+        _obj = V1SetPeerStatusRequest.parse_obj({
+            "type": obj.get("type"),
+            "peer_id": obj.get("peerId"),
+            "roles": obj.get("roles"),
+            "meta": obj.get("meta")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_set_relay_state_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 pydantic import BaseModel, Field, StrictBool
+from ourskyai_node_platform_api.models.relay_channel import RelayChannel
+
+class V1SetRelayStateRequest(BaseModel):
+    """
+    Request parameters for setting the power state of a specific relay channel (deprecated). Use this to turn equipment on or off by specifying the channel and desired state.  # noqa: E501
+    """
+    channel: RelayChannel = Field(...)
+    relay_on: StrictBool = Field(..., alias="relayOn", description="The desired power state for the relay. True turns power on to the equipment, false turns power off.")
+    __properties = ["channel", "relayOn"]
+
+    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) -> V1SetRelayStateRequest:
+        """Create an instance of V1SetRelayStateRequest 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) -> V1SetRelayStateRequest:
+        """Create an instance of V1SetRelayStateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SetRelayStateRequest.parse_obj(obj)
+
+        _obj = V1SetRelayStateRequest.parse_obj({
+            "channel": obj.get("channel"),
+            "relay_on": obj.get("relayOn")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_signal_message_request.py

@@ -0,0 +1,90 @@
+# 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, StrictStr
+from ourskyai_node_platform_api.models.ice_message import IceMessage
+from ourskyai_node_platform_api.models.sdp_message import SdpMessage
+
+class V1SignalMessageRequest(BaseModel):
+    """
+    WebRTC Signaling message (SDP or ICE)  # noqa: E501
+    """
+    session_id: StrictStr = Field(..., alias="sessionId", description="session ID")
+    type: Optional[StrictStr] = None
+    ice: Optional[IceMessage] = None
+    sdp: Optional[SdpMessage] = None
+    __properties = ["sessionId", "type", "ice", "sdp"]
+
+    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) -> V1SignalMessageRequest:
+        """Create an instance of V1SignalMessageRequest 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 ice
+        if self.ice:
+            _dict['ice'] = self.ice.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of sdp
+        if self.sdp:
+            _dict['sdp'] = self.sdp.to_dict()
+        # set to None if type (nullable) is None
+        # and __fields_set__ contains the field
+        if self.type is None and "type" in self.__fields_set__:
+            _dict['type'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SignalMessageRequest:
+        """Create an instance of V1SignalMessageRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SignalMessageRequest.parse_obj(obj)
+
+        _obj = V1SignalMessageRequest.parse_obj({
+            "session_id": obj.get("sessionId"),
+            "type": obj.get("type"),
+            "ice": IceMessage.from_dict(obj.get("ice")) if obj.get("ice") is not None else None,
+            "sdp": SdpMessage.from_dict(obj.get("sdp")) if obj.get("sdp") is not None else None
+        })
+        return _obj
+
+