@ourskyai/node_platform-api 1.4.123
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +397 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +646 -0
- package/api.ts +22146 -0
- package/base.ts +62 -0
- package/common.ts +126 -0
- package/configuration.ts +121 -0
- package/dist/api.d.ts +12807 -0
- package/dist/api.js +14064 -0
- package/dist/base.d.ts +42 -0
- package/dist/base.js +46 -0
- package/dist/common.d.ts +34 -0
- package/dist/common.js +138 -0
- package/dist/configuration.d.ts +98 -0
- package/dist/configuration.js +44 -0
- package/dist/esm/api.d.ts +12807 -0
- package/dist/esm/api.js +14057 -0
- package/dist/esm/base.d.ts +42 -0
- package/dist/esm/base.js +41 -0
- package/dist/esm/common.d.ts +34 -0
- package/dist/esm/common.js +125 -0
- package/dist/esm/configuration.d.ts +98 -0
- package/dist/esm/configuration.js +40 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.js +15 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/docs/AllSkyCameraDiagnosisReport.md +23 -0
- package/docs/AllSkyImageCapturedEventData.md +20 -0
- package/docs/AllSkyKeogramGeneratedEventData.md +20 -0
- package/docs/AllSkyTimelapseGeneratedEventData.md +20 -0
- package/docs/AstroCameraDiagnosisReport.md +29 -0
- package/docs/AstroImageCapturedEventData.md +20 -0
- package/docs/AutoStretchImageCompleted.md +21 -0
- package/docs/AutoStretchImageStarted.md +21 -0
- package/docs/AutofocusFailed.md +21 -0
- package/docs/AutofocusFinished.md +25 -0
- package/docs/AutofocusMethod.md +13 -0
- package/docs/AutofocusPointAdded.md +25 -0
- package/docs/AutofocusPointMeasuredEventData.md +24 -0
- package/docs/AutofocusStarted.md +29 -0
- package/docs/CameraImageCaptured.md +21 -0
- package/docs/CameraStatusUpdated.md +25 -0
- package/docs/CameraTemperatureSet.md +21 -0
- package/docs/CancelAllTasksEventData.md +20 -0
- package/docs/CancelTaskEventData.md +20 -0
- package/docs/CaptureImageEventData.md +20 -0
- package/docs/CaptureImageStarted.md +29 -0
- package/docs/CaptureImagesContinuouslyEventData.md +20 -0
- package/docs/ConnectionStatus.md +13 -0
- package/docs/CreateMountModelCompleted.md +21 -0
- package/docs/CreateMountModelFailed.md +21 -0
- package/docs/CreateMountModelStarted.md +21 -0
- package/docs/CycleRelaysEventData.md +20 -0
- package/docs/DebugLogged.md +23 -0
- package/docs/DefaultApi.md +10356 -0
- package/docs/DeleteImageEventData.md +20 -0
- package/docs/DeleteVideoEventData.md +20 -0
- package/docs/DiagnoseSystemEventData.md +20 -0
- package/docs/ElevationMaskDiagnosticCompleted.md +21 -0
- package/docs/ElevationMaskDiagnosticFailed.md +21 -0
- package/docs/ElevationMaskDiagnosticStarted.md +21 -0
- package/docs/ElevationMaskPointAdded.md +25 -0
- package/docs/ElevationMaskPointAddedEventData.md +24 -0
- package/docs/EmptySuccess.md +20 -0
- package/docs/EnclosureHvacError.md +25 -0
- package/docs/EnclosureHvacFanSpeed.md +19 -0
- package/docs/EnclosureHvacMode.md +17 -0
- package/docs/EnclosureHvacTemperatureLimits.md +31 -0
- package/docs/EnclosureShutterLabel.md +11 -0
- package/docs/EnclosureShutterState.md +23 -0
- package/docs/EnclosureShutterStatusesChangedEventData.md +20 -0
- package/docs/EnclosureShutterStatusesUpdated.md +21 -0
- package/docs/EnclosureShutterWatchdogTriggeredEventData.md +24 -0
- package/docs/EnclosureState.md +31 -0
- package/docs/EventType.md +118 -0
- package/docs/FitsHeader.md +23 -0
- package/docs/FocusOperation.md +17 -0
- package/docs/FocuserDiagnosisReport.md +23 -0
- package/docs/FocuserPosition.md +31 -0
- package/docs/FocuserStatusUpdated.md +21 -0
- package/docs/GenericEventData.md +22 -0
- package/docs/GoToAltitudeAzimuthCompleted.md +23 -0
- package/docs/GoToAltitudeAzimuthFailed.md +23 -0
- package/docs/GoToAltitudeAzimuthStarted.md +23 -0
- package/docs/GoToFilterWheelPositionEventData.md +20 -0
- package/docs/GoToFocuserPositionEventData.md +20 -0
- package/docs/GoToHomeCompleted.md +21 -0
- package/docs/GoToHomeFailed.md +21 -0
- package/docs/GoToHomeStarted.md +21 -0
- package/docs/GoToMechanicalCoordinatesCompleted.md +23 -0
- package/docs/GoToMechanicalCoordinatesFailed.md +23 -0
- package/docs/GoToMechanicalCoordinatesStarted.md +23 -0
- package/docs/GoToMountCoordinatesEventData.md +20 -0
- package/docs/GoToOpticalTubeM3PortEventData.md +20 -0
- package/docs/GoToRaDecCompleted.md +23 -0
- package/docs/GoToRaDecFailed.md +23 -0
- package/docs/GoToRaDecStarted.md +23 -0
- package/docs/GoToRotatorPositionEventData.md +20 -0
- package/docs/GpsDataUpdated.md +33 -0
- package/docs/GpsDataUpdatedEventData.md +32 -0
- package/docs/HardwareDaemonLogged.md +21 -0
- package/docs/IceMessage.md +26 -0
- package/docs/ImageFileFormat.md +15 -0
- package/docs/JogEnclosureRotatorEventData.md +20 -0
- package/docs/JogEnclosureShuttersEventData.md +20 -0
- package/docs/JogEnclosureWindowEventData.md +20 -0
- package/docs/JogMountEventData.md +20 -0
- package/docs/KernelLogEntryDetectedEventData.md +22 -0
- package/docs/MessageType.md +22 -0
- package/docs/MessageTypeWrapper.md +20 -0
- package/docs/MotorFaultClearedEventData.md +20 -0
- package/docs/MotorFaultDetectedEventData.md +24 -0
- package/docs/MotorFaulted.md +25 -0
- package/docs/MotorFaultsCleared.md +21 -0
- package/docs/MountDiagnosisReport.md +27 -0
- package/docs/MountFollowTLEEventData.md +20 -0
- package/docs/MountModelPointAdded.md +27 -0
- package/docs/MountModelPointAddedEventData.md +26 -0
- package/docs/MountModelPointFailed.md +23 -0
- package/docs/MountStatusUpdated.md +21 -0
- package/docs/OpenEnclosureShuttersEventData.md +20 -0
- package/docs/OperationStatusUpdated.md +21 -0
- package/docs/OpticalTubeStatus.md +21 -0
- package/docs/OpticalTubeStatusUpdated.md +21 -0
- package/docs/Peer.md +24 -0
- package/docs/PeerRole.md +10 -0
- package/docs/PlaceholderEventData.md +20 -0
- package/docs/PlateSolveCompleted.md +25 -0
- package/docs/PlateSolveFailed.md +21 -0
- package/docs/PlateSolveStarted.md +21 -0
- package/docs/PlatformConnectionDiagnosisReport.md +21 -0
- package/docs/Point2D.md +22 -0
- package/docs/RecordVideoEventData.md +20 -0
- package/docs/RelayChannel.md +21 -0
- package/docs/RelayFunction.md +29 -0
- package/docs/RelaysDiagnosisReport.md +25 -0
- package/docs/RelaysStatus.md +21 -0
- package/docs/RelaysUpdated.md +23 -0
- package/docs/ResetSystemSettingsToDefaultEventData.md +20 -0
- package/docs/RoofDiagnosisReport.md +25 -0
- package/docs/RoofState.md +31 -0
- package/docs/RoofStatus.md +21 -0
- package/docs/RoofUpdated.md +23 -0
- package/docs/RotatorPosition.md +23 -0
- package/docs/RotatorStatusUpdated.md +21 -0
- package/docs/RotatorTargetType.md +11 -0
- package/docs/RunAutofocusEventData.md +20 -0
- package/docs/SafetyStatusUpdated.md +21 -0
- package/docs/SaveImageEventData.md +20 -0
- package/docs/SaveVideoEventData.md +20 -0
- package/docs/SdpMessage.md +22 -0
- package/docs/SetEnclosureHvacFanSpeedEventData.md +20 -0
- package/docs/SetEnclosureHvacModeEventData.md +20 -0
- package/docs/SetEnclosureHvacTargetTemperatureEventData.md +20 -0
- package/docs/SetMountParkPositionEventData.md +20 -0
- package/docs/SetOpticalTubeHeaterPowerEventData.md +20 -0
- package/docs/SlewDemoEnabled.md +21 -0
- package/docs/StackedAstroImageGeneratedEventData.md +20 -0
- package/docs/StarMeasurementFailed.md +21 -0
- package/docs/StarMeasurementStarted.md +21 -0
- package/docs/StarsMeasured.md +25 -0
- package/docs/StartupWizardStep.md +25 -0
- package/docs/StopCapturingImagesContinuouslyEventData.md +20 -0
- package/docs/StopRecordingVideoEventData.md +20 -0
- package/docs/SystemEventData.md +216 -0
- package/docs/SystemEventOperation.md +24 -0
- package/docs/SystemEventOperationStatus.md +12 -0
- package/docs/SystemEventSeverity.md +14 -0
- package/docs/SystemEventType.md +123 -0
- package/docs/SystemStatusChangedEventData.md +20 -0
- package/docs/TaskCancelled.md +27 -0
- package/docs/TaskCompleted.md +25 -0
- package/docs/TaskScheduled.md +25 -0
- package/docs/TaskStarted.md +25 -0
- package/docs/TurnOffOpticalTubeFansEventData.md +20 -0
- package/docs/TurnOffRelayEventData.md +20 -0
- package/docs/TurnOnOpticalTubeFansEventData.md +20 -0
- package/docs/TurnOnRelayEventData.md +20 -0
- package/docs/UpdateFilterEventData.md +20 -0
- package/docs/UpdateSystemSettingsEventData.md +20 -0
- package/docs/V1AddMountModelPointHereRequest.md +23 -0
- package/docs/V1AllSkyClassification.md +23 -0
- package/docs/V1AllSkyClassificationLabel.md +17 -0
- package/docs/V1AllSkyImage.md +29 -0
- package/docs/V1AllSkyImages.md +21 -0
- package/docs/V1AllSkyKeogram.md +31 -0
- package/docs/V1AllSkyKeograms.md +21 -0
- package/docs/V1AllSkySourceType.md +11 -0
- package/docs/V1AllSkyTimelapse.md +33 -0
- package/docs/V1AllSkyTimelapses.md +21 -0
- package/docs/V1AppendMountTrackPathRequest.md +29 -0
- package/docs/V1AstroImage.md +29 -0
- package/docs/V1AstroImages.md +21 -0
- package/docs/V1CameraFunction.md +19 -0
- package/docs/V1CameraSelectorRequest.md +21 -0
- package/docs/V1CameraStatus.md +39 -0
- package/docs/V1CameraStatuses.md +21 -0
- package/docs/V1CancelAllTasksRequest.md +21 -0
- package/docs/V1CancelTaskRequest.md +23 -0
- package/docs/V1CaptureImageRequest.md +39 -0
- package/docs/V1CaptureImagesContinuouslyRequest.md +39 -0
- package/docs/V1ConnectedCamera.md +23 -0
- package/docs/V1CreateMountModelRequest.md +31 -0
- package/docs/V1CycleRelaysRequest.md +23 -0
- package/docs/V1DeleteImageRequest.md +21 -0
- package/docs/V1DeleteVideoRequest.md +21 -0
- package/docs/V1DiagnoseSystemRequest.md +35 -0
- package/docs/V1DisableLiveVideoRequest.md +21 -0
- package/docs/V1EdfaStatus.md +22 -0
- package/docs/V1EdfaStatusDetails.md +26 -0
- package/docs/V1ElevationMask.md +23 -0
- package/docs/V1ElevationMaskPoint.md +25 -0
- package/docs/V1EnableLiveVideoRequest.md +31 -0
- package/docs/V1EnclosureFanRole.md +9 -0
- package/docs/V1EnclosureFanStatus.md +25 -0
- package/docs/V1EnclosureFanStatuses.md +21 -0
- package/docs/V1EnclosureHvacStatus.md +23 -0
- package/docs/V1EnclosureHvacStatusDetails.md +33 -0
- package/docs/V1EnclosureMotorSystemSettings.md +27 -0
- package/docs/V1EnclosureRotatorStatus.md +27 -0
- package/docs/V1EnclosureShutterStatus.md +29 -0
- package/docs/V1EnclosureShutterStatuses.md +21 -0
- package/docs/V1EnclosureStatus.md +27 -0
- package/docs/V1EnclosureSystemSettings.md +25 -0
- package/docs/V1EnclosureWindowStatus.md +27 -0
- package/docs/V1EndSessionRequest.md +23 -0
- package/docs/V1Event.md +24 -0
- package/docs/V1EventData.md +166 -0
- package/docs/V1Filter.md +23 -0
- package/docs/V1FilterType.md +61 -0
- package/docs/V1FilterWheelStatus.md +29 -0
- package/docs/V1FilterWheelStatuses.md +21 -0
- package/docs/V1FocuserLimit.md +23 -0
- package/docs/V1FocuserMotorSystemSettings.md +27 -0
- package/docs/V1FocuserSelectorRequest.md +21 -0
- package/docs/V1FocuserStatus.md +31 -0
- package/docs/V1FocuserStatuses.md +21 -0
- package/docs/V1FocuserSystemSettings.md +23 -0
- package/docs/V1FollowTLERequest.md +23 -0
- package/docs/V1GetComponentStatusResponse.md +43 -0
- package/docs/V1GetHealthCheckResponse.md +33 -0
- package/docs/V1GetImageProcessingPluginLogsRequest.md +24 -0
- package/docs/V1GetImageProcessingPluginRequest.md +20 -0
- package/docs/V1GetStorageStatusResponse.md +25 -0
- package/docs/V1GnssPpsStatus.md +24 -0
- package/docs/V1GnssPpsStatusDetails.md +27 -0
- package/docs/V1GoToFilterWheelPositionRequest.md +23 -0
- package/docs/V1GoToFocuserPositionRequest.md +24 -0
- package/docs/V1GoToMountCoordinatesRequest.md +27 -0
- package/docs/V1GoToMountMechanicalCoordinatesRequest.md +23 -0
- package/docs/V1GoToOpticalTubeM3PortRequest.md +23 -0
- package/docs/V1GoToRotatorPositionRequest.md +25 -0
- package/docs/V1Image.md +43 -0
- package/docs/V1ImageProcessingPlugin.md +30 -0
- package/docs/V1ImageProcessingPluginList.md +22 -0
- package/docs/V1ImageProcessingPluginLogEntry.md +22 -0
- package/docs/V1ImageProcessingPluginLogList.md +22 -0
- package/docs/V1Images.md +21 -0
- package/docs/V1JogEnclosureRotatorRequest.md +23 -0
- package/docs/V1JogEnclosureShutterRequest.md +25 -0
- package/docs/V1JogEnclosureShuttersRequest.md +21 -0
- package/docs/V1JogEnclosureWindowRequest.md +23 -0
- package/docs/V1JogMountRequest.md +25 -0
- package/docs/V1ListProducersRequest.md +23 -0
- package/docs/V1ListProducersResponse.md +23 -0
- package/docs/V1Motor.md +23 -0
- package/docs/V1MotorRole.md +22 -0
- package/docs/V1MotorStatus.md +37 -0
- package/docs/V1MountModel.md +23 -0
- package/docs/V1MountModelPoint.md +27 -0
- package/docs/V1MountMotorSystemSettings.md +27 -0
- package/docs/V1MountStatus.md +43 -0
- package/docs/V1MountSystemSettings.md +23 -0
- package/docs/V1MountTrackPathAltAzSample.md +27 -0
- package/docs/V1MountTrackPathEndedReason.md +13 -0
- package/docs/V1MountTrackPathEnuSample.md +29 -0
- package/docs/V1MountTrackPathFrame.md +15 -0
- package/docs/V1MountTrackPathRaDecSample.md +27 -0
- package/docs/V1MountTrackPathState.md +17 -0
- package/docs/V1MountTrackPathStatus.md +49 -0
- package/docs/V1MoveFocuserPositionRequest.md +23 -0
- package/docs/V1MoveFocuserResponse.md +23 -0
- package/docs/V1MoveFocuserStepsRequest.md +23 -0
- package/docs/V1NtpStatus.md +24 -0
- package/docs/V1NtpStatusDetails.md +23 -0
- package/docs/V1OpenEnclosureShuttersRequest.md +21 -0
- package/docs/V1OpenRoofRequest.md +21 -0
- package/docs/V1OpticalPowerMeterStatus.md +21 -0
- package/docs/V1OpticalTubeCoverSelectorRequest.md +21 -0
- package/docs/V1OpticalTubeCoverStatus.md +27 -0
- package/docs/V1OpticalTubeCoverStatuses.md +21 -0
- package/docs/V1OpticalTubeFanGroupStatus.md +23 -0
- package/docs/V1OpticalTubeFanGroupStatuses.md +21 -0
- package/docs/V1OpticalTubeFanRole.md +23 -0
- package/docs/V1OpticalTubeFanStatus.md +25 -0
- package/docs/V1OpticalTubeHeaterGroupStatus.md +23 -0
- package/docs/V1OpticalTubeHeaterGroupStatuses.md +21 -0
- package/docs/V1OpticalTubeHeaterRole.md +13 -0
- package/docs/V1OpticalTubeHeaterStatus.md +25 -0
- package/docs/V1OpticalTubeM3SelectorRequest.md +21 -0
- package/docs/V1OpticalTubeM3Status.md +25 -0
- package/docs/V1OpticalTubeM3Statuses.md +21 -0
- package/docs/V1OpticalTubeStatus.md +31 -0
- package/docs/V1OpticalTubeStatuses.md +21 -0
- package/docs/V1OpticalTubeTemperatureSensorRole.md +15 -0
- package/docs/V1OpticalTubeTemperatureSensorStatus.md +23 -0
- package/docs/V1OpticalTubeTemperatureSensorStatuses.md +21 -0
- package/docs/V1PeerStatusChangedRequest.md +27 -0
- package/docs/V1PtpDataSet.md +25 -0
- package/docs/V1PtpPortProperties.md +27 -0
- package/docs/V1PtpStatus.md +24 -0
- package/docs/V1PtpStatusDetails.md +25 -0
- package/docs/V1PtpTimeStatus.md +35 -0
- package/docs/V1RecordVideoRequest.md +21 -0
- package/docs/V1Relay.md +23 -0
- package/docs/V1ResetEnclosureMotorSystemSettingsToDefaultRequest.md +27 -0
- package/docs/V1ResetEnclosureSystemSettingsToDefaultRequest.md +25 -0
- package/docs/V1ResetFocuserMotorSystemSettingsToDefaultRequest.md +27 -0
- package/docs/V1ResetFocuserSystemSettingsToDefaultRequest.md +23 -0
- package/docs/V1ResetMountMotorSystemSettingsToDefaultRequest.md +27 -0
- package/docs/V1ResetMountSystemSettingsToDefaultRequest.md +23 -0
- package/docs/V1ResetRotatorMotorSystemSettingsToDefaultRequest.md +27 -0
- package/docs/V1ResetRotatorSystemSettingsToDefaultRequest.md +23 -0
- package/docs/V1ResetSystemSettingsToDefaultRequest.md +27 -0
- package/docs/V1RoofStatus.md +27 -0
- package/docs/V1RotatorMotorSystemSettings.md +27 -0
- package/docs/V1RotatorSelectorRequest.md +21 -0
- package/docs/V1RotatorStatus.md +33 -0
- package/docs/V1RotatorStatuses.md +21 -0
- package/docs/V1RotatorSystemSettings.md +23 -0
- package/docs/V1RunAutofocusRequest.md +32 -0
- package/docs/V1RunBlindAutofocusRequest.md +24 -0
- package/docs/V1SafetyStatus.md +33 -0
- package/docs/V1SaveImageRequest.md +21 -0
- package/docs/V1SaveVideoRequest.md +21 -0
- package/docs/V1SetEnclosureHvacFanSpeedRequest.md +21 -0
- package/docs/V1SetEnclosureHvacModeRequest.md +21 -0
- package/docs/V1SetEnclosureHvacTargetTemperatureRequest.md +21 -0
- package/docs/V1SetMountParkPositionRequest.md +23 -0
- package/docs/V1SetOpticalTubeHeaterPowerRequest.md +25 -0
- package/docs/V1SetPeerStatusRequest.md +29 -0
- package/docs/V1SetRelayStateRequest.md +23 -0
- package/docs/V1SignalMessageRequest.md +27 -0
- package/docs/V1SignallingRequest.md +40 -0
- package/docs/V1StackedAstroImage.md +25 -0
- package/docs/V1StackedAstroImages.md +21 -0
- package/docs/V1StartLiveStackingSessionRequest.md +20 -0
- package/docs/V1StartLiveStackingSessionResponse.md +20 -0
- package/docs/V1StartMountTrackPathRequest.md +27 -0
- package/docs/V1StartSessionRequest.md +27 -0
- package/docs/V1StopCapturingImagesContinuouslyRequest.md +21 -0
- package/docs/V1StopLiveStackingSessionRequest.md +20 -0
- package/docs/V1StopRecordingVideoRequest.md +21 -0
- package/docs/V1SystemDiagnosisReport.md +35 -0
- package/docs/V1SystemEvent.md +25 -0
- package/docs/V1SystemEventData.md +173 -0
- package/docs/V1SystemEvents.md +21 -0
- package/docs/V1SystemHealthCheck.md +33 -0
- package/docs/V1SystemLocation.md +29 -0
- package/docs/V1SystemLocationGpsDetails.md +27 -0
- package/docs/V1SystemMetric.md +29 -0
- package/docs/V1SystemMetricNames.md +21 -0
- package/docs/V1SystemMetricTag.md +23 -0
- package/docs/V1SystemMetricType.md +11 -0
- package/docs/V1SystemMetrics.md +21 -0
- package/docs/V1SystemMetricsCollection.md +27 -0
- package/docs/V1SystemMetricsCollections.md +21 -0
- package/docs/V1SystemNetworkInterface.md +25 -0
- package/docs/V1SystemNetworkInterfaceInfo.md +25 -0
- package/docs/V1SystemNetworkInterfaces.md +21 -0
- package/docs/V1SystemOperationMode.md +13 -0
- package/docs/V1SystemOperationStatus.md +23 -0
- package/docs/V1SystemSettings.md +27 -0
- package/docs/V1SystemStatus.md +43 -0
- package/docs/V1SystemStorageStatus.md +25 -0
- package/docs/V1SystemTime.md +31 -0
- package/docs/V1Task.md +29 -0
- package/docs/V1TaskType.md +31 -0
- package/docs/V1TimeSource.md +15 -0
- package/docs/V1TimeSourceLastSample.md +25 -0
- package/docs/V1TimeSourceStatistics.md +35 -0
- package/docs/V1TrackBodyRequest.md +21 -0
- package/docs/V1TurnOffEnclosureFansRequest.md +21 -0
- package/docs/V1TurnOffOpticalTubeFansRequest.md +23 -0
- package/docs/V1TurnOnEnclosureFansRequest.md +21 -0
- package/docs/V1TurnOnOpticalTubeFansRequest.md +23 -0
- package/docs/V1UIOperationMode.md +11 -0
- package/docs/V1UpdateElevationMaskRequest.md +21 -0
- package/docs/V1UpdateFilterRequest.md +25 -0
- package/docs/V1UpdateImageProcessingPluginRequest.md +24 -0
- package/docs/V1Video.md +51 -0
- package/docs/V1Videos.md +21 -0
- package/docs/V1WeatherStationStatus.md +21 -0
- package/docs/V2CaptureImageRequest.md +39 -0
- package/docs/V2CycleRelaysRequest.md +23 -0
- package/docs/V2EnclosureStatus.md +29 -0
- package/docs/V2MountStatus.md +37 -0
- package/docs/V2RelayStatus.md +25 -0
- package/docs/V2RelayStatuses.md +21 -0
- package/docs/V2SystemEvent.md +33 -0
- package/docs/V2SystemEventType.md +205 -0
- package/docs/V2SystemEvents.md +21 -0
- package/docs/V2TurnOffRelayRequest.md +21 -0
- package/docs/V2TurnOnRelayRequest.md +21 -0
- package/docs/VideoCodec.md +8 -0
- package/docs/VideoContainerFormat.md +8 -0
- package/docs/WavefrontSensorDataUpdated.md +57 -0
- package/docs/WavefrontSensorDataUpdatedEventData.md +57 -0
- package/docs/WeatherStationDiagnosisReport.md +23 -0
- package/docs/WeatherStationStatusUpdated.md +21 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/package.json +33 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# V1SystemMetricsCollection
|
|
2
|
+
|
|
3
|
+
A compact collection of measurements for a metric identity. Each measurement is encoded as [measuredAt, value].
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**metrics** | **Array<Array<any>>** | Measurements encoded as fixed two-item arrays. Index 0 is measuredAt as an ISO 8601 date-time string; index 1 is value as a number. | [default to undefined]
|
|
10
|
+
**name** | **string** | The metric identifier that describes what is being measured, such as cpu_temperature or mount_position_altitude. | [default to undefined]
|
|
11
|
+
**tags** | [**Array<V1SystemMetricTag>**](V1SystemMetricTag.md) | Additional metadata tags that provide context for this metric, enabling filtering by component, sensor, or other dimensions. | [default to undefined]
|
|
12
|
+
**type** | [**V1SystemMetricType**](V1SystemMetricType.md) | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1SystemMetricsCollection } from '@ourskyai/node_platform-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1SystemMetricsCollection = {
|
|
20
|
+
metrics,
|
|
21
|
+
name,
|
|
22
|
+
tags,
|
|
23
|
+
type,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1SystemMetricsCollections
|
|
2
|
+
|
|
3
|
+
Container for compact metric collections returned from a metrics query.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**collections** | [**Array<V1SystemMetricsCollection>**](V1SystemMetricsCollection.md) | Metric collections grouped by metric identity. May be empty if no metrics match the specified filters. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1SystemMetricsCollections } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1SystemMetricsCollections = {
|
|
17
|
+
collections,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# V1SystemNetworkInterface
|
|
2
|
+
|
|
3
|
+
Represents a single network interface with its name, type, and IP configuration details. Each interface may have multiple IP address assignments.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**info** | [**Array<V1SystemNetworkInterfaceInfo>**](V1SystemNetworkInterfaceInfo.md) | Array of IP address configurations assigned to this interface. An interface may have multiple IPv4 and IPv6 addresses. | [default to undefined]
|
|
10
|
+
**_interface** | **string** | The system name of the network interface, such as eth0, wlan0, or enp3s0. Used to identify the interface in system configurations. | [default to undefined]
|
|
11
|
+
**type** | **string** | The type of network interface. `MIKROTIK_WAN` identifies the Mikrotik WAN uplink, while `LOCAL` identifies a local-only interface. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1SystemNetworkInterface } from '@ourskyai/node_platform-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1SystemNetworkInterface = {
|
|
19
|
+
info,
|
|
20
|
+
_interface,
|
|
21
|
+
type,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# V1SystemNetworkInterfaceInfo
|
|
2
|
+
|
|
3
|
+
IP address configuration details for a network interface, including the address, subnet, and default gateway.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**address** | **string** | The IP address assigned to this interface in dotted decimal notation for IPv4 or colon-separated notation for IPv6. | [default to undefined]
|
|
10
|
+
**gateway** | **string** | The IP address of the default gateway for this network. Traffic destined for addresses outside the local subnet is routed through this gateway. | [default to undefined]
|
|
11
|
+
**prefix** | **number** | The network prefix length in bits, indicating the subnet size. For example, 24 represents a /24 subnet with netmask 255.255.255.0. | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1SystemNetworkInterfaceInfo } from '@ourskyai/node_platform-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1SystemNetworkInterfaceInfo = {
|
|
19
|
+
address,
|
|
20
|
+
gateway,
|
|
21
|
+
prefix,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1SystemNetworkInterfaces
|
|
2
|
+
|
|
3
|
+
Container for all network interfaces configured on the edge controller. Provides a complete view of network connectivity options.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**systemNetworkInterfaces** | [**Array<V1SystemNetworkInterface>**](V1SystemNetworkInterface.md) | Array of all network interfaces on the system, including both physical and virtual interfaces. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1SystemNetworkInterfaces } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1SystemNetworkInterfaces = {
|
|
17
|
+
systemNetworkInterfaces,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# V1SystemOperationMode
|
|
2
|
+
|
|
3
|
+
Defines the level of automation for telescope operations, determining how much human intervention is required.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `AUTONOMOUS` (value: `'AUTONOMOUS'`)
|
|
8
|
+
|
|
9
|
+
* `ASSISTED` (value: `'ASSISTED'`)
|
|
10
|
+
|
|
11
|
+
* `MANUAL` (value: `'MANUAL'`)
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# V1SystemOperationStatus
|
|
2
|
+
|
|
3
|
+
Represents the current operational configuration of the telescope system, combining both the system automation level and UI interaction mode.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**systemOperationMode** | [**V1SystemOperationMode**](V1SystemOperationMode.md) | | [default to undefined]
|
|
10
|
+
**uiOperationMode** | [**V1UIOperationMode**](V1UIOperationMode.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1SystemOperationStatus } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1SystemOperationStatus = {
|
|
18
|
+
systemOperationMode,
|
|
19
|
+
uiOperationMode,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# V1SystemSettings
|
|
2
|
+
|
|
3
|
+
Container for all configurable system settings. Each subsystem has its own settings object that can be read and updated independently.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**enclosure** | [**V1EnclosureSystemSettings**](V1EnclosureSystemSettings.md) | | [optional] [default to undefined]
|
|
10
|
+
**focuser** | [**V1FocuserSystemSettings**](V1FocuserSystemSettings.md) | | [optional] [default to undefined]
|
|
11
|
+
**mount** | [**V1MountSystemSettings**](V1MountSystemSettings.md) | | [optional] [default to undefined]
|
|
12
|
+
**rotator** | [**V1RotatorSystemSettings**](V1RotatorSystemSettings.md) | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1SystemSettings } from '@ourskyai/node_platform-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1SystemSettings = {
|
|
20
|
+
enclosure,
|
|
21
|
+
focuser,
|
|
22
|
+
mount,
|
|
23
|
+
rotator,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# V1SystemStatus
|
|
2
|
+
|
|
3
|
+
Comprehensive status snapshot of all hardware components in the telescope system. Provides a unified view for monitoring and diagnostics.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**cameras** | [**V1CameraStatuses**](V1CameraStatuses.md) | | [optional] [default to undefined]
|
|
10
|
+
**edfa** | [**V1EdfaStatus**](V1EdfaStatus.md) | | [optional] [default to undefined]
|
|
11
|
+
**enclosure** | [**V2EnclosureStatus**](V2EnclosureStatus.md) | | [optional] [default to undefined]
|
|
12
|
+
**filterWheel** | [**V1FilterWheelStatus**](V1FilterWheelStatus.md) | | [optional] [default to undefined]
|
|
13
|
+
**focuser** | [**V1FocuserStatus**](V1FocuserStatus.md) | | [optional] [default to undefined]
|
|
14
|
+
**mount** | [**V2MountStatus**](V2MountStatus.md) | | [optional] [default to undefined]
|
|
15
|
+
**opticalPowerMeter** | [**V1OpticalPowerMeterStatus**](V1OpticalPowerMeterStatus.md) | | [optional] [default to undefined]
|
|
16
|
+
**opticalTube** | [**V1OpticalTubeStatus**](V1OpticalTubeStatus.md) | | [optional] [default to undefined]
|
|
17
|
+
**relays** | [**V2RelayStatuses**](V2RelayStatuses.md) | | [optional] [default to undefined]
|
|
18
|
+
**rotator** | [**V1RotatorStatus**](V1RotatorStatus.md) | | [optional] [default to undefined]
|
|
19
|
+
**safety** | [**V1SafetyStatus**](V1SafetyStatus.md) | | [optional] [default to undefined]
|
|
20
|
+
**weatherStation** | [**V1WeatherStationStatus**](V1WeatherStationStatus.md) | | [optional] [default to undefined]
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { V1SystemStatus } from '@ourskyai/node_platform-api';
|
|
26
|
+
|
|
27
|
+
const instance: V1SystemStatus = {
|
|
28
|
+
cameras,
|
|
29
|
+
edfa,
|
|
30
|
+
enclosure,
|
|
31
|
+
filterWheel,
|
|
32
|
+
focuser,
|
|
33
|
+
mount,
|
|
34
|
+
opticalPowerMeter,
|
|
35
|
+
opticalTube,
|
|
36
|
+
relays,
|
|
37
|
+
rotator,
|
|
38
|
+
safety,
|
|
39
|
+
weatherStation,
|
|
40
|
+
};
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# V1SystemStorageStatus
|
|
2
|
+
|
|
3
|
+
Storage utilization information for the edge controller filesystem. Use this to monitor available space for image data and plan data management operations.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**totalStorage** | **number** | Total available storage capacity in bytes. This represents the combined capacity of all storage partitions accessible to the system. | [default to undefined]
|
|
10
|
+
**usedDataStorage** | **number** | Storage space consumed by user data in bytes. This includes captured images, calibration frames, and other observational data. | [default to undefined]
|
|
11
|
+
**usedSystemStorage** | **number** | Storage space consumed by system files in bytes. This includes the operating system, logs, and application data. Not directly manageable by users. | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1SystemStorageStatus } from '@ourskyai/node_platform-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1SystemStorageStatus = {
|
|
19
|
+
totalStorage,
|
|
20
|
+
usedDataStorage,
|
|
21
|
+
usedSystemStorage,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# V1SystemTime
|
|
2
|
+
|
|
3
|
+
Comprehensive time synchronization status including the current system time, active time source, and detailed status for all available time sources.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**currentSystemTime** | **string** | Current system time in ISO 8601 format. This is the authoritative time used for all timestamping operations on the edge controller. | [default to undefined]
|
|
10
|
+
**currentTimeSource** | [**V1TimeSource**](V1TimeSource.md) | | [default to undefined]
|
|
11
|
+
**gnssPps** | [**V1GnssPpsStatus**](V1GnssPpsStatus.md) | | [optional] [default to undefined]
|
|
12
|
+
**ntp** | [**V1NtpStatus**](V1NtpStatus.md) | | [optional] [default to undefined]
|
|
13
|
+
**ptp** | [**V1PtpStatus**](V1PtpStatus.md) | | [optional] [default to undefined]
|
|
14
|
+
**timeUncertaintySeconds** | **number** | Estimated uncertainty of the system time in seconds. Lower values indicate higher confidence in time accuracy. Critical for precise astronomical timing. | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { V1SystemTime } from '@ourskyai/node_platform-api';
|
|
20
|
+
|
|
21
|
+
const instance: V1SystemTime = {
|
|
22
|
+
currentSystemTime,
|
|
23
|
+
currentTimeSource,
|
|
24
|
+
gnssPps,
|
|
25
|
+
ntp,
|
|
26
|
+
ptp,
|
|
27
|
+
timeUncertaintySeconds,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/V1Task.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# V1Task
|
|
2
|
+
|
|
3
|
+
Represents a scheduled or running task in the telescope system with its execution timing and type information.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**concurrencyKey** | **string** | Key used for permitting concurrency. Only one task instance of a type and concurrencyKey combination can run at a time. | [optional] [default to undefined]
|
|
10
|
+
**id** | **string** | Unique identifier for this task. Use this ID to cancel the task or track its progress. | [default to undefined]
|
|
11
|
+
**scheduledAt** | **string** | ISO 8601 timestamp when the task was scheduled to run. For immediate tasks, this is the creation time. | [default to undefined]
|
|
12
|
+
**startedAt** | **string** | ISO 8601 timestamp when the task actually began execution. Null if the task is still waiting to start. | [optional] [default to undefined]
|
|
13
|
+
**type** | [**V1TaskType**](V1TaskType.md) | | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { V1Task } from '@ourskyai/node_platform-api';
|
|
19
|
+
|
|
20
|
+
const instance: V1Task = {
|
|
21
|
+
concurrencyKey,
|
|
22
|
+
id,
|
|
23
|
+
scheduledAt,
|
|
24
|
+
startedAt,
|
|
25
|
+
type,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# V1TaskType
|
|
2
|
+
|
|
3
|
+
Type classification for system tasks. CREATE_MOUNT_MODEL builds a pointing model by measuring and correcting for mount alignment errors. CREATE_ELEVATION_MASK generates a horizon obstruction map for the observatory location. CALIBRATE_ENCLOSURE_ROTATOR measures the enclosure rotator to mount azimuth relationship and persists the resulting mount offset. CALIBRATE_ENCLOSURE_WINDOW sweeps the enclosure window through its full motion range to derive and persist motor counts per revolution. RUN_AUTOFOCUS executes an automated focus optimization routine. RUN_PERPETUAL_INSTRUCTION_LOOP continuously executes observation sequences. STARTUP_WIZARD guides initial telescope setup and configuration. SET_CAMERA_TEMPERATURE manages camera cooling to target temperature. ENGAGE_ADHOC_DEPLOYMENT activates portable operation mode. RUN_SLEW_DEMO performs a demonstration slew sequence. TAKE_CALIBRATION_FRAMES captures bias, dark, or flat calibration images. RUN_LIVE_STACKING_SESSION runs a live stacking session.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `CREATE_MOUNT_MODEL` (value: `'CREATE_MOUNT_MODEL'`)
|
|
8
|
+
|
|
9
|
+
* `CREATE_ELEVATION_MASK` (value: `'CREATE_ELEVATION_MASK'`)
|
|
10
|
+
|
|
11
|
+
* `CALIBRATE_ENCLOSURE_ROTATOR` (value: `'CALIBRATE_ENCLOSURE_ROTATOR'`)
|
|
12
|
+
|
|
13
|
+
* `CALIBRATE_ENCLOSURE_WINDOW` (value: `'CALIBRATE_ENCLOSURE_WINDOW'`)
|
|
14
|
+
|
|
15
|
+
* `RUN_AUTOFOCUS` (value: `'RUN_AUTOFOCUS'`)
|
|
16
|
+
|
|
17
|
+
* `RUN_PERPETUAL_INSTRUCTION_LOOP` (value: `'RUN_PERPETUAL_INSTRUCTION_LOOP'`)
|
|
18
|
+
|
|
19
|
+
* `STARTUP_WIZARD` (value: `'STARTUP_WIZARD'`)
|
|
20
|
+
|
|
21
|
+
* `SET_CAMERA_TEMPERATURE` (value: `'SET_CAMERA_TEMPERATURE'`)
|
|
22
|
+
|
|
23
|
+
* `ENGAGE_ADHOC_DEPLOYMENT` (value: `'ENGAGE_ADHOC_DEPLOYMENT'`)
|
|
24
|
+
|
|
25
|
+
* `RUN_SLEW_DEMO` (value: `'RUN_SLEW_DEMO'`)
|
|
26
|
+
|
|
27
|
+
* `TAKE_CALIBRATION_FRAMES` (value: `'TAKE_CALIBRATION_FRAMES'`)
|
|
28
|
+
|
|
29
|
+
* `RUN_LIVE_STACKING_SESSION` (value: `'RUN_LIVE_STACKING_SESSION'`)
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# V1TimeSource
|
|
2
|
+
|
|
3
|
+
Identifies the source used for system time synchronization, listed in order of typical precision from highest to lowest.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `PTP` (value: `'PTP'`)
|
|
8
|
+
|
|
9
|
+
* `GNSS_PPS` (value: `'GNSS_PPS'`)
|
|
10
|
+
|
|
11
|
+
* `NTP` (value: `'NTP'`)
|
|
12
|
+
|
|
13
|
+
* `UNKNOWN` (value: `'UNKNOWN'`)
|
|
14
|
+
|
|
15
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# V1TimeSourceLastSample
|
|
2
|
+
|
|
3
|
+
Last time sample received by network manager
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**adjustedOffset** | **number** | Adjusted offset after corrections in seconds | [default to undefined]
|
|
10
|
+
**margin** | **number** | Estimated error margin in seconds | [default to undefined]
|
|
11
|
+
**originalOffset** | **number** | Original measured offset in seconds | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1TimeSourceLastSample } from '@ourskyai/node_platform-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1TimeSourceLastSample = {
|
|
19
|
+
adjustedOffset,
|
|
20
|
+
margin,
|
|
21
|
+
originalOffset,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# V1TimeSourceStatistics
|
|
2
|
+
|
|
3
|
+
Source status information
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**lastRx** | **number** | Time since last sample was received in seconds | [default to undefined]
|
|
10
|
+
**lastSample** | [**V1TimeSourceLastSample**](V1TimeSourceLastSample.md) | | [default to undefined]
|
|
11
|
+
**mode** | **string** | Source mode indicator | [default to undefined]
|
|
12
|
+
**name** | **string** | Source name or address | [default to undefined]
|
|
13
|
+
**poll** | **number** | Polling interval in log2 seconds | [default to undefined]
|
|
14
|
+
**reach** | **string** | Reachability register in octal | [default to undefined]
|
|
15
|
+
**state** | **string** | Source state | [default to undefined]
|
|
16
|
+
**stratum** | **number** | Stratum level of the source | [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { V1TimeSourceStatistics } from '@ourskyai/node_platform-api';
|
|
22
|
+
|
|
23
|
+
const instance: V1TimeSourceStatistics = {
|
|
24
|
+
lastRx,
|
|
25
|
+
lastSample,
|
|
26
|
+
mode,
|
|
27
|
+
name,
|
|
28
|
+
poll,
|
|
29
|
+
reach,
|
|
30
|
+
state,
|
|
31
|
+
stratum,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1TrackBodyRequest
|
|
2
|
+
|
|
3
|
+
Request to track a solar system body using ephemerides.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**body** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1TrackBodyRequest } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1TrackBodyRequest = {
|
|
17
|
+
body,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1TurnOffEnclosureFansRequest
|
|
2
|
+
|
|
3
|
+
Request to turn off specific fans in the dome enclosure by their roles.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**roles** | [**Array<V1EnclosureFanRole>**](V1EnclosureFanRole.md) | List of fan roles to turn off. Multiple fans can be deactivated in a single request. Only the specified fans will be affected. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1TurnOffEnclosureFansRequest } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1TurnOffEnclosureFansRequest = {
|
|
17
|
+
roles,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# V1TurnOffOpticalTubeFansRequest
|
|
2
|
+
|
|
3
|
+
Request to turn off specific fans in the optical tube assembly by their roles.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**opticalTubeId** | **string** | Unique identifier of the optical tube whose fans should be turned off. If omitted, the default optical tube is used. | [optional] [default to undefined]
|
|
10
|
+
**roles** | [**Array<V1OpticalTubeFanRole>**](V1OpticalTubeFanRole.md) | List of fan roles to turn off. Multiple fans can be deactivated in a single request. Only the specified fans will be affected. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1TurnOffOpticalTubeFansRequest } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1TurnOffOpticalTubeFansRequest = {
|
|
18
|
+
opticalTubeId,
|
|
19
|
+
roles,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1TurnOnEnclosureFansRequest
|
|
2
|
+
|
|
3
|
+
Request to turn on specific fans in the dome enclosure by their roles.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**roles** | [**Array<V1EnclosureFanRole>**](V1EnclosureFanRole.md) | List of fan roles to turn on. Multiple fans can be activated in a single request. Only the specified fans will be affected. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1TurnOnEnclosureFansRequest } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1TurnOnEnclosureFansRequest = {
|
|
17
|
+
roles,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# V1TurnOnOpticalTubeFansRequest
|
|
2
|
+
|
|
3
|
+
Request to turn on specific fans in the optical tube assembly by their roles.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**opticalTubeId** | **string** | Unique identifier of the optical tube whose fans should be turned on. If omitted, the default optical tube is used. | [optional] [default to undefined]
|
|
10
|
+
**roles** | [**Array<V1OpticalTubeFanRole>**](V1OpticalTubeFanRole.md) | List of fan roles to turn on. Multiple fans can be activated in a single request. Only the specified fans will be affected. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1TurnOnOpticalTubeFansRequest } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1TurnOnOpticalTubeFansRequest = {
|
|
18
|
+
opticalTubeId,
|
|
19
|
+
roles,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# V1UIOperationMode
|
|
2
|
+
|
|
3
|
+
Indicates how the user interface interacts with the telescope control system.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `EMBEDDED` (value: `'EMBEDDED'`)
|
|
8
|
+
|
|
9
|
+
* `MANUAL` (value: `'MANUAL'`)
|
|
10
|
+
|
|
11
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1UpdateElevationMaskRequest
|
|
2
|
+
|
|
3
|
+
Request payload for replacing the current elevation mask points stored for a node.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**points** | [**Array<V1ElevationMaskPoint>**](V1ElevationMaskPoint.md) | Replacement elevation mask points. Submit an empty array to clear the stored mask. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1UpdateElevationMaskRequest } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1UpdateElevationMaskRequest = {
|
|
17
|
+
points,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# V1UpdateFilterRequest
|
|
2
|
+
|
|
3
|
+
Request to update the filter type configuration for a specific wheel position.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**filterWheelId** | **string** | Unique identifier of the filter wheel whose filter configuration should be updated. If omitted, the default filter wheel is used. | [optional] [default to undefined]
|
|
10
|
+
**position** | **number** | Filter wheel slot position to update as a zero-based index. Valid values range from 0 to (capacity - 1). | [default to undefined]
|
|
11
|
+
**type** | [**V1FilterType**](V1FilterType.md) | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1UpdateFilterRequest } from '@ourskyai/node_platform-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1UpdateFilterRequest = {
|
|
19
|
+
filterWheelId,
|
|
20
|
+
position,
|
|
21
|
+
type,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# V1UpdateImageProcessingPluginRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**active** | **boolean** | If true, the plugin will run and receive images from the primary pipeline. If false, the plugin will not run. | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | The human-friendly name of the image processing plugin. | [optional] [default to undefined]
|
|
10
|
+
**pluginId** | **string** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1UpdateImageProcessingPluginRequest } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1UpdateImageProcessingPluginRequest = {
|
|
18
|
+
active,
|
|
19
|
+
name,
|
|
20
|
+
pluginId,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|