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

ourskyai_node_platform_api/models/v1_latest_image.py

@@ -0,0 +1,89 @@
+# 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, StrictStr, validator
+from ourskyai_node_platform_api.models.v1_all_sky_prediction_label import V1AllSkyPredictionLabel
+
+class V1LatestImage(BaseModel):
+    """
+    V1LatestImage
+    """
+    image_id: StrictStr = Field(..., alias="imageId")
+    image_url: StrictStr = Field(..., alias="imageUrl")
+    captured_at: datetime = Field(..., alias="capturedAt")
+    type: StrictStr = Field(...)
+    prediction_label: Optional[V1AllSkyPredictionLabel] = Field(None, alias="predictionLabel")
+    prediction_confidence: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="predictionConfidence")
+    __properties = ["imageId", "imageUrl", "capturedAt", "type", "predictionLabel", "predictionConfidence"]
+
+    @validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in ('ASTRONOMICAL', 'EARTH_ORBITAL', 'GNSS_CALIBRATION', 'SATELLITE_CALIBRATION', 'ALL_SKY', 'RESOLVED_SATELLITE'):
+            raise ValueError("must be one of enum values ('ASTRONOMICAL', 'EARTH_ORBITAL', 'GNSS_CALIBRATION', 'SATELLITE_CALIBRATION', 'ALL_SKY', 'RESOLVED_SATELLITE')")
+        return value
+
+    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) -> V1LatestImage:
+        """Create an instance of V1LatestImage 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) -> V1LatestImage:
+        """Create an instance of V1LatestImage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1LatestImage.parse_obj(obj)
+
+        _obj = V1LatestImage.parse_obj({
+            "image_id": obj.get("imageId"),
+            "image_url": obj.get("imageUrl"),
+            "captured_at": obj.get("capturedAt"),
+            "type": obj.get("type"),
+            "prediction_label": obj.get("predictionLabel"),
+            "prediction_confidence": obj.get("predictionConfidence")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_list_producers_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 V1ListProducersRequest(BaseModel):
+    """
+    list available producers  # noqa: E501
+    """
+    type: StrictStr = Field(..., description="Type of message")
+    __properties = ["type"]
+
+    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) -> V1ListProducersRequest:
+        """Create an instance of V1ListProducersRequest 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) -> V1ListProducersRequest:
+        """Create an instance of V1ListProducersRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1ListProducersRequest.parse_obj(obj)
+
+        _obj = V1ListProducersRequest.parse_obj({
+            "type": obj.get("type")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_list_producers_response.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 List
+from pydantic import BaseModel, Field, StrictStr, conlist
+from ourskyai_node_platform_api.models.peer import Peer
+
+class V1ListProducersResponse(BaseModel):
+    """
+    List Producers response  # noqa: E501
+    """
+    type: StrictStr = Field(..., description="Type of message")
+    producers: conlist(Peer) = Field(..., description="list of peers")
+    __properties = ["type", "producers"]
+
+    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) -> V1ListProducersResponse:
+        """Create an instance of V1ListProducersResponse 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 producers (list)
+        _items = []
+        if self.producers:
+            for _item in self.producers:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['producers'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1ListProducersResponse:
+        """Create an instance of V1ListProducersResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1ListProducersResponse.parse_obj(obj)
+
+        _obj = V1ListProducersResponse.parse_obj({
+            "type": obj.get("type"),
+            "producers": [Peer.from_dict(_item) for _item in obj.get("producers")] if obj.get("producers") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_m3_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, StrictInt
+
+class V1M3Status(BaseModel):
+    """
+    Current status of the M3 tertiary mirror port selector including connection state and active port position.  # noqa: E501
+    """
+    connected: StrictBool = Field(..., description="Indicates whether communication with the M3 mechanism is active. When false, the M3 mirror cannot be controlled and port position may be unknown.")
+    port: StrictInt = Field(..., description="Current port position indicating which instrument port the M3 mirror is directing light to. Use this to verify the active instrument before imaging.")
+    __properties = ["connected", "port"]
+
+    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) -> V1M3Status:
+        """Create an instance of V1M3Status 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) -> V1M3Status:
+        """Create an instance of V1M3Status from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1M3Status.parse_obj(obj)
+
+        _obj = V1M3Status.parse_obj({
+            "connected": obj.get("connected"),
+            "port": obj.get("port")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_metric.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 datetime import datetime
+from typing import List, Optional, Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt, StrictStr, conlist
+from ourskyai_node_platform_api.models.metric_type import MetricType
+
+class V1Metric(BaseModel):
+    """
+    V1Metric
+    """
+    name: StrictStr = Field(...)
+    value: Union[StrictFloat, StrictInt] = Field(...)
+    tags: Optional[conlist(StrictStr)] = Field(None, description="List of colon separated key value pairs, i.e. [\"tag1:value1\",\"tag2:value2\"]")
+    description: Optional[StrictStr] = None
+    type: MetricType = Field(...)
+    measured_at: datetime = Field(..., alias="measuredAt")
+    __properties = ["name", "value", "tags", "description", "type", "measuredAt"]
+
+    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) -> V1Metric:
+        """Create an instance of V1Metric 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) -> V1Metric:
+        """Create an instance of V1Metric from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1Metric.parse_obj(obj)
+
+        _obj = V1Metric.parse_obj({
+            "name": obj.get("name"),
+            "value": obj.get("value"),
+            "tags": obj.get("tags"),
+            "description": obj.get("description"),
+            "type": obj.get("type"),
+            "measured_at": obj.get("measuredAt")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_motor.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 V1Motor(str, Enum):
+    """
+    Identifies a specific motor in the telescope system for fault reporting and control purposes.
+    """
+
+    """
+    allowed enum values
+    """
+    MOUNT_MOTOR_A = 'MOUNT_MOTOR_A'
+    MOUNT_MOTOR_B = 'MOUNT_MOTOR_B'
+    ENCLOSURE_ROTATOR_MOTOR = 'ENCLOSURE_ROTATOR_MOTOR'
+    ENCLOSURE_WINDOW_MOTOR = 'ENCLOSURE_WINDOW_MOTOR'
+    ENCLOSURE_SHUTTER_MOTOR_A = 'ENCLOSURE_SHUTTER_MOTOR_A'
+    ENCLOSURE_SHUTTER_MOTOR_B = 'ENCLOSURE_SHUTTER_MOTOR_B'
+    ROTATOR1_MOTOR = 'ROTATOR1_MOTOR'
+    FOCUSER1_MOTOR = 'FOCUSER1_MOTOR'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1Motor:
+        """Create an instance of V1Motor from a JSON string"""
+        return V1Motor(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/v1_motor_status.py

@@ -0,0 +1,87 @@
+# 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 V1MotorStatus(BaseModel):
+    """
+    Detailed telemetry and status information for a single mount motor axis, providing low-level diagnostic data.  # noqa: E501
+    """
+    connected: StrictBool = Field(..., description="Indicates whether communication with this motor controller is active. When false, the motor cannot be commanded and telemetry may be unavailable.")
+    is_emergency_stop_pressed: StrictBool = Field(..., alias="isEmergencyStopPressed", description="Indicates whether the emergency stop signal is active for this motor. When true, the motor is inhibited from any movement.")
+    is_enabled: StrictBool = Field(..., alias="isEnabled", description="Indicates whether the motor is enabled and ready to accept motion commands. Motors must be enabled before slewing or tracking can occur.")
+    has_error: StrictBool = Field(..., alias="hasError", description="Indicates whether the motor controller has detected a fault condition. Check errorDescription for details when this is true.")
+    error_description: Optional[StrictStr] = Field(None, alias="errorDescription", description="Human-readable description of the current motor error condition. Only populated when hasError is true. Use this for troubleshooting motor faults.")
+    position_degrees: Union[StrictFloat, StrictInt] = Field(..., alias="positionDegrees", description="Current angular position of the motor axis in degrees. This is the raw motor position before any pointing model corrections are applied.")
+    acceleration_degrees_per_second_squared: Union[StrictFloat, StrictInt] = Field(..., alias="accelerationDegreesPerSecondSquared", description="Current acceleration of the motor axis in degrees per second squared. Useful for monitoring motion profile and detecting mechanical issues.")
+    distance_to_target_arcseconds: Union[StrictFloat, StrictInt] = Field(..., alias="distanceToTargetArcseconds", description="Remaining angular distance to the target position in arcseconds. Approaches zero as the motor reaches its commanded position during slews.")
+    measured_velocity_degrees_per_second: Union[StrictFloat, StrictInt] = Field(..., alias="measuredVelocityDegreesPerSecond", description="Current measured angular velocity of the motor in degrees per second. During tracking, this reflects the sidereal rate; during slews, it shows slew speed.")
+    __properties = ["connected", "isEmergencyStopPressed", "isEnabled", "hasError", "errorDescription", "positionDegrees", "accelerationDegreesPerSecondSquared", "distanceToTargetArcseconds", "measuredVelocityDegreesPerSecond"]
+
+    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) -> V1MotorStatus:
+        """Create an instance of V1MotorStatus 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) -> V1MotorStatus:
+        """Create an instance of V1MotorStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1MotorStatus.parse_obj(obj)
+
+        _obj = V1MotorStatus.parse_obj({
+            "connected": obj.get("connected"),
+            "is_emergency_stop_pressed": obj.get("isEmergencyStopPressed"),
+            "is_enabled": obj.get("isEnabled"),
+            "has_error": obj.get("hasError"),
+            "error_description": obj.get("errorDescription"),
+            "position_degrees": obj.get("positionDegrees"),
+            "acceleration_degrees_per_second_squared": obj.get("accelerationDegreesPerSecondSquared"),
+            "distance_to_target_arcseconds": obj.get("distanceToTargetArcseconds"),
+            "measured_velocity_degrees_per_second": obj.get("measuredVelocityDegreesPerSecond")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_mount_model.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 datetime import datetime
+from typing import List
+from pydantic import BaseModel, Field, conlist
+from ourskyai_node_platform_api.models.v1_mount_model_point import V1MountModelPoint
+
+class V1MountModel(BaseModel):
+    """
+    Pointing model data containing calibration points used to correct mount pointing accuracy. Built through automated plate solving at multiple sky positions.  # noqa: E501
+    """
+    points: conlist(V1MountModelPoint) = Field(..., description="Array of calibration points where plate solving determined the actual vs commanded position. More points generally yield better accuracy.")
+    created_at: datetime = Field(..., alias="createdAt", description="ISO 8601 timestamp indicating when this pointing model was created. Models may need rebuilding if mount mechanics change significantly.")
+    __properties = ["points", "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) -> V1MountModel:
+        """Create an instance of V1MountModel 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 points (list)
+        _items = []
+        if self.points:
+            for _item in self.points:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['points'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1MountModel:
+        """Create an instance of V1MountModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1MountModel.parse_obj(obj)
+
+        _obj = V1MountModel.parse_obj({
+            "points": [V1MountModelPoint.from_dict(_item) for _item in obj.get("points")] if obj.get("points") is not None else None,
+            "created_at": obj.get("createdAt")
+        })
+        return _obj
+
+