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

ourskyai_node_platform_api/models/v1_ptp_time_status.py

@@ -0,0 +1,85 @@
+# 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, StrictBool, StrictFloat, StrictInt, StrictStr
+
+class V1PtpTimeStatus(BaseModel):
+    """
+    PTP time status from TIME_STATUS_NP  # noqa: E501
+    """
+    master_offset: Optional[StrictInt] = Field(None, alias="masterOffset", description="Offset from master clock in nanoseconds")
+    ingress_time: Optional[StrictInt] = Field(None, alias="ingressTime", description="Ingress time in nanoseconds")
+    cumulative_scaled_rate_offset: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="cumulativeScaledRateOffset", description="Cumulative scaled rate offset")
+    scaled_last_gm_phase_change: Optional[StrictInt] = Field(None, alias="scaledLastGmPhaseChange", description="Scaled last grandmaster phase change")
+    gm_time_base_indicator: Optional[StrictInt] = Field(None, alias="gmTimeBaseIndicator", description="Grandmaster time base indicator")
+    last_gm_phase_change: Optional[StrictStr] = Field(None, alias="lastGmPhaseChange", description="Last grandmaster phase change value")
+    gm_present: Optional[StrictBool] = Field(None, alias="gmPresent", description="Whether a grandmaster is present")
+    gm_identity: Optional[StrictStr] = Field(None, alias="gmIdentity", description="Identity of the grandmaster clock")
+    __properties = ["masterOffset", "ingressTime", "cumulativeScaledRateOffset", "scaledLastGmPhaseChange", "gmTimeBaseIndicator", "lastGmPhaseChange", "gmPresent", "gmIdentity"]
+
+    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) -> V1PtpTimeStatus:
+        """Create an instance of V1PtpTimeStatus 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) -> V1PtpTimeStatus:
+        """Create an instance of V1PtpTimeStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1PtpTimeStatus.parse_obj(obj)
+
+        _obj = V1PtpTimeStatus.parse_obj({
+            "master_offset": obj.get("masterOffset"),
+            "ingress_time": obj.get("ingressTime"),
+            "cumulative_scaled_rate_offset": obj.get("cumulativeScaledRateOffset"),
+            "scaled_last_gm_phase_change": obj.get("scaledLastGmPhaseChange"),
+            "gm_time_base_indicator": obj.get("gmTimeBaseIndicator"),
+            "last_gm_phase_change": obj.get("lastGmPhaseChange"),
+            "gm_present": obj.get("gmPresent"),
+            "gm_identity": obj.get("gmIdentity")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_record_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 V1RecordVideoRequest(BaseModel):
+    """
+    Request object to initiate video recording from a camera. The video will be recorded using the camera's current settings until explicitly stopped.  # noqa: E501
+    """
+    camera_id: StrictStr = Field(..., alias="cameraId", description="Unique identifier of the camera to start recording from. The camera must be connected and not already recording. Obtain valid camera IDs from the camera statuses endpoint.")
+    __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) -> V1RecordVideoRequest:
+        """Create an instance of V1RecordVideoRequest 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) -> V1RecordVideoRequest:
+        """Create an instance of V1RecordVideoRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1RecordVideoRequest.parse_obj(obj)
+
+        _obj = V1RecordVideoRequest.parse_obj({
+            "camera_id": obj.get("cameraId")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_relay.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 V1Relay(BaseModel):
+    """
+    Represents the current state of a single relay channel (deprecated, see V2RelayStatus). Contains the channel identifier and its power state.  # noqa: E501
+    """
+    channel: RelayChannel = Field(...)
+    relay_on: StrictBool = Field(..., alias="relayOn", description="The current power state of the relay. True indicates the relay is closed and power is flowing to the equipment. False indicates the relay is open and equipment is unpowered.")
+    __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) -> V1Relay:
+        """Create an instance of V1Relay 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) -> V1Relay:
+        """Create an instance of V1Relay from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1Relay.parse_obj(obj)
+
+        _obj = V1Relay.parse_obj({
+            "channel": obj.get("channel"),
+            "relay_on": obj.get("relayOn")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_reset_mount_system_settings_to_default_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
+from pydantic import BaseModel, Field, StrictBool
+
+class V1ResetMountSystemSettingsToDefaultRequest(BaseModel):
+    """
+    Specifies which mount settings should be reset to their factory default values. Set each flag to true to reset that particular setting.  # noqa: E501
+    """
+    velocity_degrees_per_second: Optional[StrictBool] = Field(None, alias="velocityDegreesPerSecond", description="When true, resets the mount slew velocity setting to its factory default value.")
+    acceleration_degrees_per_second_squared: Optional[StrictBool] = Field(None, alias="accelerationDegreesPerSecondSquared", description="When true, resets the mount acceleration setting to its factory default value.")
+    __properties = ["velocityDegreesPerSecond", "accelerationDegreesPerSecondSquared"]
+
+    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) -> V1ResetMountSystemSettingsToDefaultRequest:
+        """Create an instance of V1ResetMountSystemSettingsToDefaultRequest 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) -> V1ResetMountSystemSettingsToDefaultRequest:
+        """Create an instance of V1ResetMountSystemSettingsToDefaultRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1ResetMountSystemSettingsToDefaultRequest.parse_obj(obj)
+
+        _obj = V1ResetMountSystemSettingsToDefaultRequest.parse_obj({
+            "velocity_degrees_per_second": obj.get("velocityDegreesPerSecond"),
+            "acceleration_degrees_per_second_squared": obj.get("accelerationDegreesPerSecondSquared")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_reset_system_settings_to_default_request.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
+from ourskyai_node_platform_api.models.v1_reset_mount_system_settings_to_default_request import V1ResetMountSystemSettingsToDefaultRequest
+
+class V1ResetSystemSettingsToDefaultRequest(BaseModel):
+    """
+    Request specifying which system settings should be reset to their factory default values. Include only the subsystems and settings you want to reset.  # noqa: E501
+    """
+    mount: Optional[V1ResetMountSystemSettingsToDefaultRequest] = None
+    __properties = ["mount"]
+
+    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) -> V1ResetSystemSettingsToDefaultRequest:
+        """Create an instance of V1ResetSystemSettingsToDefaultRequest 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 mount
+        if self.mount:
+            _dict['mount'] = self.mount.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1ResetSystemSettingsToDefaultRequest:
+        """Create an instance of V1ResetSystemSettingsToDefaultRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1ResetSystemSettingsToDefaultRequest.parse_obj(obj)
+
+        _obj = V1ResetSystemSettingsToDefaultRequest.parse_obj({
+            "mount": V1ResetMountSystemSettingsToDefaultRequest.from_dict(obj.get("mount")) if obj.get("mount") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_roof_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.roof_state import RoofState
+
+class V1RoofStatus(BaseModel):
+    """
+    Contains the complete status information for the roll-off roof system (deprecated, see V1EnclosureStatus). This object provides connectivity, operational state, and panel positions for legacy integrations.  # noqa: E501
+    """
+    connected: StrictBool = Field(..., description="Indicates whether the roof controller is currently connected and communicating. A false value means commands cannot be sent to the roof system.")
+    state: RoofState = 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) -> V1RoofStatus:
+        """Create an instance of V1RoofStatus 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) -> V1RoofStatus:
+        """Create an instance of V1RoofStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1RoofStatus.parse_obj(obj)
+
+        _obj = V1RoofStatus.parse_obj({
+            "connected": obj.get("connected"),
+            "state": obj.get("state"),
+            "front_position": obj.get("frontPosition"),
+            "rear_position": obj.get("rearPosition")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_rotator_status.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
+from pydantic import BaseModel, Field, StrictBool
+from ourskyai_node_platform_api.models.rotator_position import RotatorPosition
+
+class V1RotatorStatus(BaseModel):
+    """
+    Current operational status of the field rotator including position, movement state, and de-rotation compensation mode.  # noqa: E501
+    """
+    connected: StrictBool = Field(..., description="Indicates whether the rotator is currently connected and communicating. When false, rotator commands will fail and position data may be stale.")
+    moving: StrictBool = Field(..., description="Indicates whether the rotator is currently in motion. True during position changes or active de-rotation compensation adjustments.")
+    is_derotation_enabled: Optional[StrictBool] = Field(None, alias="isDerotationEnabled", description="Indicates whether automatic field de-rotation compensation is active. When true, the rotator continuously adjusts to maintain consistent sky orientation.")
+    position: Optional[RotatorPosition] = None
+    __properties = ["connected", "moving", "isDerotationEnabled", "position"]
+
+    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) -> V1RotatorStatus:
+        """Create an instance of V1RotatorStatus 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 position
+        if self.position:
+            _dict['position'] = self.position.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1RotatorStatus:
+        """Create an instance of V1RotatorStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1RotatorStatus.parse_obj(obj)
+
+        _obj = V1RotatorStatus.parse_obj({
+            "connected": obj.get("connected"),
+            "moving": obj.get("moving"),
+            "is_derotation_enabled": obj.get("isDerotationEnabled"),
+            "position": RotatorPosition.from_dict(obj.get("position")) if obj.get("position") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_run_autofocus_request.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, Optional, Union
+from pydantic import BaseModel, Field, StrictBool, StrictFloat, StrictInt, conlist
+from ourskyai_node_platform_api.models.autofocus_method import AutofocusMethod
+
+class V1RunAutofocusRequest(BaseModel):
+    """
+    V1RunAutofocusRequest
+    """
+    start_position: Optional[StrictInt] = Field(None, alias="startPosition", description="The starting position of the focuser")
+    step_size: Optional[StrictInt] = Field(None, alias="stepSize", description="The step size to use for moving the focuser")
+    max_steps: Optional[StrictInt] = Field(None, alias="maxSteps", description="The number of steps to measure for the run")
+    blind_fallback: StrictBool = Field(..., alias="blindFallback", description="Whether to find the focus position using a blind search")
+    autofocus_methods: Optional[conlist(AutofocusMethod)] = Field(None, alias="autofocusMethods", description="The autofocus method to use")
+    r_squared_threshold: Optional[Union[StrictFloat, StrictInt]] = Field(0.7, alias="rSquaredThreshold", description="The r-squared threshold to use for the autofocus")
+    __properties = ["startPosition", "stepSize", "maxSteps", "blindFallback", "autofocusMethods", "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) -> V1RunAutofocusRequest:
+        """Create an instance of V1RunAutofocusRequest 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) -> V1RunAutofocusRequest:
+        """Create an instance of V1RunAutofocusRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1RunAutofocusRequest.parse_obj(obj)
+
+        _obj = V1RunAutofocusRequest.parse_obj({
+            "start_position": obj.get("startPosition"),
+            "step_size": obj.get("stepSize"),
+            "max_steps": obj.get("maxSteps"),
+            "blind_fallback": obj.get("blindFallback") if obj.get("blindFallback") is not None else False,
+            "autofocus_methods": obj.get("autofocusMethods"),
+            "r_squared_threshold": obj.get("rSquaredThreshold") if obj.get("rSquaredThreshold") is not None else 0.7
+        })
+        return _obj
+
+