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

ourskyai_node_platform_api/models/v1_system_network_interface.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 List, Optional
+from pydantic import BaseModel, Field, StrictStr, conlist
+from ourskyai_node_platform_api.models.v1_system_network_interface_info import V1SystemNetworkInterfaceInfo
+
+class V1SystemNetworkInterface(BaseModel):
+    """
+    Represents a single network interface with its name, type, and IP configuration details. Each interface may have multiple IP address assignments.  # noqa: E501
+    """
+    interface: StrictStr = Field(..., description="The system name of the network interface, such as eth0, wlan0, or enp3s0. Used to identify the interface in system configurations.")
+    type: Optional[StrictStr] = Field(None, description="The type of network interface, such as ethernet, wifi, or loopback. Indicates the underlying network technology.")
+    info: conlist(V1SystemNetworkInterfaceInfo) = Field(..., description="Array of IP address configurations assigned to this interface. An interface may have multiple IPv4 and IPv6 addresses.")
+    __properties = ["interface", "type", "info"]
+
+    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) -> V1SystemNetworkInterface:
+        """Create an instance of V1SystemNetworkInterface 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 info (list)
+        _items = []
+        if self.info:
+            for _item in self.info:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['info'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SystemNetworkInterface:
+        """Create an instance of V1SystemNetworkInterface from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemNetworkInterface.parse_obj(obj)
+
+        _obj = V1SystemNetworkInterface.parse_obj({
+            "interface": obj.get("interface"),
+            "type": obj.get("type"),
+            "info": [V1SystemNetworkInterfaceInfo.from_dict(_item) for _item in obj.get("info")] if obj.get("info") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_network_interface_info.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 pydantic import BaseModel, Field, StrictInt, StrictStr
+
+class V1SystemNetworkInterfaceInfo(BaseModel):
+    """
+    IP address configuration details for a network interface, including the address, subnet, and default gateway.  # noqa: E501
+    """
+    address: StrictStr = Field(..., description="The IP address assigned to this interface in dotted decimal notation for IPv4 or colon-separated notation for IPv6.")
+    prefix: StrictInt = Field(..., description="The network prefix length in bits, indicating the subnet size. For example, 24 represents a /24 subnet with netmask 255.255.255.0.")
+    gateway: StrictStr = Field(..., description="The IP address of the default gateway for this network. Traffic destined for addresses outside the local subnet is routed through this gateway.")
+    __properties = ["address", "prefix", "gateway"]
+
+    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) -> V1SystemNetworkInterfaceInfo:
+        """Create an instance of V1SystemNetworkInterfaceInfo 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) -> V1SystemNetworkInterfaceInfo:
+        """Create an instance of V1SystemNetworkInterfaceInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemNetworkInterfaceInfo.parse_obj(obj)
+
+        _obj = V1SystemNetworkInterfaceInfo.parse_obj({
+            "address": obj.get("address"),
+            "prefix": obj.get("prefix"),
+            "gateway": obj.get("gateway")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_network_interfaces.py

@@ -0,0 +1,79 @@
+# coding: utf-8
+
+"""
+    OurSky
+
+    Node Platform API
+
+    The version of the OpenAPI document: 1.3.9821
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import List
+from pydantic import BaseModel, Field, conlist
+from ourskyai_node_platform_api.models.v1_system_network_interface import V1SystemNetworkInterface
+
+class V1SystemNetworkInterfaces(BaseModel):
+    """
+    Container for all network interfaces configured on the edge controller. Provides a complete view of network connectivity options.  # noqa: E501
+    """
+    system_network_interfaces: conlist(V1SystemNetworkInterface) = Field(..., alias="systemNetworkInterfaces", description="Array of all network interfaces on the system, including both physical and virtual interfaces.")
+    __properties = ["systemNetworkInterfaces"]
+
+    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) -> V1SystemNetworkInterfaces:
+        """Create an instance of V1SystemNetworkInterfaces 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 system_network_interfaces (list)
+        _items = []
+        if self.system_network_interfaces:
+            for _item in self.system_network_interfaces:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['systemNetworkInterfaces'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SystemNetworkInterfaces:
+        """Create an instance of V1SystemNetworkInterfaces from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemNetworkInterfaces.parse_obj(obj)
+
+        _obj = V1SystemNetworkInterfaces.parse_obj({
+            "system_network_interfaces": [V1SystemNetworkInterface.from_dict(_item) for _item in obj.get("systemNetworkInterfaces")] if obj.get("systemNetworkInterfaces") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_operation_mode.py

@@ -0,0 +1,41 @@
+# 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 V1SystemOperationMode(str, Enum):
+    """
+    Defines the level of automation for telescope operations, determining how much human intervention is required.
+    """
+
+    """
+    allowed enum values
+    """
+    AUTONOMOUS = 'AUTONOMOUS'
+    ASSISTED = 'ASSISTED'
+    MANUAL = 'MANUAL'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> V1SystemOperationMode:
+        """Create an instance of V1SystemOperationMode from a JSON string"""
+        return V1SystemOperationMode(json.loads(json_str))
+
+

ourskyai_node_platform_api/models/v1_system_operation_status.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 pydantic import BaseModel, Field
+from ourskyai_node_platform_api.models.v1_system_operation_mode import V1SystemOperationMode
+from ourskyai_node_platform_api.models.v1_ui_operation_mode import V1UIOperationMode
+
+class V1SystemOperationStatus(BaseModel):
+    """
+    Represents the current operational configuration of the telescope system, combining both the system automation level and UI interaction mode.  # noqa: E501
+    """
+    system_operation_mode: V1SystemOperationMode = Field(..., alias="systemOperationMode")
+    ui_operation_mode: V1UIOperationMode = Field(..., alias="uiOperationMode")
+    __properties = ["systemOperationMode", "uiOperationMode"]
+
+    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) -> V1SystemOperationStatus:
+        """Create an instance of V1SystemOperationStatus 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) -> V1SystemOperationStatus:
+        """Create an instance of V1SystemOperationStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemOperationStatus.parse_obj(obj)
+
+        _obj = V1SystemOperationStatus.parse_obj({
+            "system_operation_mode": obj.get("systemOperationMode"),
+            "ui_operation_mode": obj.get("uiOperationMode")
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_settings.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_mount_system_settings import V1MountSystemSettings
+
+class V1SystemSettings(BaseModel):
+    """
+    Container for all configurable system settings. Each subsystem has its own settings object that can be read and updated independently.  # noqa: E501
+    """
+    mount: Optional[V1MountSystemSettings] = 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) -> V1SystemSettings:
+        """Create an instance of V1SystemSettings 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) -> V1SystemSettings:
+        """Create an instance of V1SystemSettings from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemSettings.parse_obj(obj)
+
+        _obj = V1SystemSettings.parse_obj({
+            "mount": V1MountSystemSettings.from_dict(obj.get("mount")) if obj.get("mount") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_status.py

@@ -0,0 +1,135 @@
+# 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
+from ourskyai_node_platform_api.models.v1_camera_statuses import V1CameraStatuses
+from ourskyai_node_platform_api.models.v1_filter_wheel_status import V1FilterWheelStatus
+from ourskyai_node_platform_api.models.v1_focuser_status import V1FocuserStatus
+from ourskyai_node_platform_api.models.v1_m3_status import V1M3Status
+from ourskyai_node_platform_api.models.v1_optical_tube_status import V1OpticalTubeStatus
+from ourskyai_node_platform_api.models.v1_rotator_status import V1RotatorStatus
+from ourskyai_node_platform_api.models.v1_safety_status import V1SafetyStatus
+from ourskyai_node_platform_api.models.v1_weather_station_status import V1WeatherStationStatus
+from ourskyai_node_platform_api.models.v2_enclosure_status import V2EnclosureStatus
+from ourskyai_node_platform_api.models.v2_mount_status import V2MountStatus
+from ourskyai_node_platform_api.models.v2_relay_statuses import V2RelayStatuses
+
+class V1SystemStatus(BaseModel):
+    """
+    Comprehensive status snapshot of all hardware components in the telescope system. Provides a unified view for monitoring and diagnostics.  # noqa: E501
+    """
+    cameras: Optional[V1CameraStatuses] = None
+    mount: Optional[V2MountStatus] = None
+    focuser: Optional[V1FocuserStatus] = None
+    rotator: Optional[V1RotatorStatus] = None
+    optical_tube: Optional[V1OpticalTubeStatus] = Field(None, alias="opticalTube")
+    weather_station: Optional[V1WeatherStationStatus] = Field(None, alias="weatherStation")
+    relays: Optional[V2RelayStatuses] = None
+    enclosure: Optional[V2EnclosureStatus] = None
+    safety: Optional[V1SafetyStatus] = None
+    filter_wheel: Optional[V1FilterWheelStatus] = Field(None, alias="filterWheel")
+    m3: Optional[V1M3Status] = None
+    __properties = ["cameras", "mount", "focuser", "rotator", "opticalTube", "weatherStation", "relays", "enclosure", "safety", "filterWheel", "m3"]
+
+    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) -> V1SystemStatus:
+        """Create an instance of V1SystemStatus 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 cameras
+        if self.cameras:
+            _dict['cameras'] = self.cameras.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of mount
+        if self.mount:
+            _dict['mount'] = self.mount.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of focuser
+        if self.focuser:
+            _dict['focuser'] = self.focuser.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of rotator
+        if self.rotator:
+            _dict['rotator'] = self.rotator.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of optical_tube
+        if self.optical_tube:
+            _dict['opticalTube'] = self.optical_tube.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of weather_station
+        if self.weather_station:
+            _dict['weatherStation'] = self.weather_station.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of relays
+        if self.relays:
+            _dict['relays'] = self.relays.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of enclosure
+        if self.enclosure:
+            _dict['enclosure'] = self.enclosure.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of safety
+        if self.safety:
+            _dict['safety'] = self.safety.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of filter_wheel
+        if self.filter_wheel:
+            _dict['filterWheel'] = self.filter_wheel.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of m3
+        if self.m3:
+            _dict['m3'] = self.m3.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> V1SystemStatus:
+        """Create an instance of V1SystemStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemStatus.parse_obj(obj)
+
+        _obj = V1SystemStatus.parse_obj({
+            "cameras": V1CameraStatuses.from_dict(obj.get("cameras")) if obj.get("cameras") is not None else None,
+            "mount": V2MountStatus.from_dict(obj.get("mount")) if obj.get("mount") is not None else None,
+            "focuser": V1FocuserStatus.from_dict(obj.get("focuser")) if obj.get("focuser") is not None else None,
+            "rotator": V1RotatorStatus.from_dict(obj.get("rotator")) if obj.get("rotator") is not None else None,
+            "optical_tube": V1OpticalTubeStatus.from_dict(obj.get("opticalTube")) if obj.get("opticalTube") is not None else None,
+            "weather_station": V1WeatherStationStatus.from_dict(obj.get("weatherStation")) if obj.get("weatherStation") is not None else None,
+            "relays": V2RelayStatuses.from_dict(obj.get("relays")) if obj.get("relays") is not None else None,
+            "enclosure": V2EnclosureStatus.from_dict(obj.get("enclosure")) if obj.get("enclosure") is not None else None,
+            "safety": V1SafetyStatus.from_dict(obj.get("safety")) if obj.get("safety") is not None else None,
+            "filter_wheel": V1FilterWheelStatus.from_dict(obj.get("filterWheel")) if obj.get("filterWheel") is not None else None,
+            "m3": V1M3Status.from_dict(obj.get("m3")) if obj.get("m3") is not None else None
+        })
+        return _obj
+
+

ourskyai_node_platform_api/models/v1_system_storage_status.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 pydantic import BaseModel, Field, StrictInt
+
+class V1SystemStorageStatus(BaseModel):
+    """
+    Storage utilization information for the edge controller filesystem. Use this to monitor available space for image data and plan data management operations.  # noqa: E501
+    """
+    total_storage: StrictInt = Field(..., alias="totalStorage", description="Total available storage capacity in bytes. This represents the combined capacity of all storage partitions accessible to the system.")
+    used_data_storage: StrictInt = Field(..., alias="usedDataStorage", description="Storage space consumed by user data in bytes. This includes captured images, calibration frames, and other observational data.")
+    used_system_storage: StrictInt = Field(..., alias="usedSystemStorage", description="Storage space consumed by system files in bytes. This includes the operating system, logs, and application data. Not directly manageable by users.")
+    __properties = ["totalStorage", "usedDataStorage", "usedSystemStorage"]
+
+    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) -> V1SystemStorageStatus:
+        """Create an instance of V1SystemStorageStatus 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) -> V1SystemStorageStatus:
+        """Create an instance of V1SystemStorageStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return V1SystemStorageStatus.parse_obj(obj)
+
+        _obj = V1SystemStorageStatus.parse_obj({
+            "total_storage": obj.get("totalStorage"),
+            "used_data_storage": obj.get("usedDataStorage"),
+            "used_system_storage": obj.get("usedSystemStorage")
+        })
+        return _obj
+
+