@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
|
+
# V1MountMotorSystemSettings
|
|
2
|
+
|
|
3
|
+
Configuration settings for telescope mount motor motion control including slew speed, acceleration, and travel limits.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**accelerationDegreesPerSecondSquared** | **number** | Maximum acceleration of the mount motor in degrees per second squared. Controls how quickly the mount motor ramps up to slew speed. Higher values reduce slew time but may cause vibration or tracking errors. Typical values range from 0.5 to 5 degrees per second squared. | [optional] [default to undefined]
|
|
10
|
+
**negativeLimitDegrees** | **number** | Negative travel limit of the mount motor in degrees. The motor should not move below this position. | [optional] [default to undefined]
|
|
11
|
+
**positiveLimitDegrees** | **number** | Positive travel limit of the mount motor in degrees. The motor should not move above this position. | [optional] [default to undefined]
|
|
12
|
+
**velocityDegreesPerSecond** | **number** | Maximum slew velocity of the mount motor in degrees per second. Higher values enable faster slewing between targets but may reduce pointing accuracy or cause mechanical stress. Typical values range from 1 to 10 degrees per second. | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1MountMotorSystemSettings } from '@ourskyai/node_platform-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1MountMotorSystemSettings = {
|
|
20
|
+
accelerationDegreesPerSecondSquared,
|
|
21
|
+
negativeLimitDegrees,
|
|
22
|
+
positiveLimitDegrees,
|
|
23
|
+
velocityDegreesPerSecond,
|
|
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
|
+
# V1MountStatus
|
|
2
|
+
|
|
3
|
+
Current operational status of the telescope mount including position coordinates, tracking state, and location information.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**altitude** | **number** | Current altitude (elevation) angle above the horizon in degrees. Range is 0 (horizon) to 90 (zenith) degrees. | [default to undefined]
|
|
10
|
+
**azimuth** | **number** | Current azimuth angle measured clockwise from north in degrees. Range is 0 to 360 degrees where 0/360 is north, 90 is east, 180 is south, 270 is west. | [default to undefined]
|
|
11
|
+
**connected** | **boolean** | Indicates whether the mount is currently connected and communicating. When false, mount commands will fail and position data may be stale. | [default to undefined]
|
|
12
|
+
**dec** | **number** | Current declination coordinate of the telescope pointing in degrees (J2000 epoch). Range is -90 to +90 degrees. | [default to undefined]
|
|
13
|
+
**geometry** | **number** | Encoded mount geometry state indicating the physical orientation of the telescope. Used internally for pier side determination and flip logic. | [default to undefined]
|
|
14
|
+
**height** | **number** | Elevation of the observatory above sea level in meters. Used for atmospheric refraction corrections and satellite tracking calculations. | [default to undefined]
|
|
15
|
+
**isEmergencyStopPressed** | **boolean** | Indicates whether the physical emergency stop button has been activated. When true, all mount motion is inhibited until the emergency stop is released. | [optional] [default to undefined]
|
|
16
|
+
**latitude** | **number** | Geographic latitude of the observatory location in decimal degrees. Positive values indicate north of the equator, negative values indicate south. | [default to undefined]
|
|
17
|
+
**longitude** | **number** | Geographic longitude of the observatory location in decimal degrees. Positive values indicate east of the prime meridian, negative values indicate west. | [default to undefined]
|
|
18
|
+
**ra** | **number** | Current right ascension coordinate of the telescope pointing in degrees (J2000 epoch). Range is 0 to 360 degrees. | [default to undefined]
|
|
19
|
+
**slewing** | **boolean** | Indicates whether the mount is currently slewing (moving rapidly) to a new position. True during goto operations, false when stationary or tracking. | [default to undefined]
|
|
20
|
+
**tracking** | **boolean** | Indicates whether sidereal tracking is currently active. When true, the mount compensates for Earth rotation to keep objects centered. | [default to undefined]
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { V1MountStatus } from '@ourskyai/node_platform-api';
|
|
26
|
+
|
|
27
|
+
const instance: V1MountStatus = {
|
|
28
|
+
altitude,
|
|
29
|
+
azimuth,
|
|
30
|
+
connected,
|
|
31
|
+
dec,
|
|
32
|
+
geometry,
|
|
33
|
+
height,
|
|
34
|
+
isEmergencyStopPressed,
|
|
35
|
+
latitude,
|
|
36
|
+
longitude,
|
|
37
|
+
ra,
|
|
38
|
+
slewing,
|
|
39
|
+
tracking,
|
|
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,23 @@
|
|
|
1
|
+
# V1MountSystemSettings
|
|
2
|
+
|
|
3
|
+
Configuration settings for telescope mount motion control including motor specific slew speed, acceleration, and travel limits.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**motorA** | [**V1MountMotorSystemSettings**](V1MountMotorSystemSettings.md) | | [optional] [default to undefined]
|
|
10
|
+
**motorB** | [**V1MountMotorSystemSettings**](V1MountMotorSystemSettings.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1MountSystemSettings } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1MountSystemSettings = {
|
|
18
|
+
motorA,
|
|
19
|
+
motorB,
|
|
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
|
+
# V1MountTrackPathAltAzSample
|
|
2
|
+
|
|
3
|
+
Time-tagged geometric topocentric altitude/azimuth control point. Angles are degrees. Provide exactly one of time or julianDay.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**altitudeDegrees** | **number** | | [default to undefined]
|
|
10
|
+
**azimuthDegrees** | **number** | | [default to undefined]
|
|
11
|
+
**julianDay** | **number** | Julian Date timestamp. Provide exactly one of time or julianDay. | [optional] [default to undefined]
|
|
12
|
+
**time** | **string** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1MountTrackPathAltAzSample } from '@ourskyai/node_platform-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1MountTrackPathAltAzSample = {
|
|
20
|
+
altitudeDegrees,
|
|
21
|
+
azimuthDegrees,
|
|
22
|
+
julianDay,
|
|
23
|
+
time,
|
|
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,13 @@
|
|
|
1
|
+
# V1MountTrackPathEndedReason
|
|
2
|
+
|
|
3
|
+
Normal terminal reason for an ENDED custom path tracking session.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `PATH_COMPLETE` (value: `'PATH_COMPLETE'`)
|
|
8
|
+
|
|
9
|
+
* `USER_REQUESTED` (value: `'USER_REQUESTED'`)
|
|
10
|
+
|
|
11
|
+
* `REPLACED` (value: `'REPLACED'`)
|
|
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,29 @@
|
|
|
1
|
+
# V1MountTrackPathEnuSample
|
|
2
|
+
|
|
3
|
+
Time-tagged local east/north/up direction control point. The vector must be finite and nonzero; it is normalized by the edge controller. Provide exactly one of time or julianDay.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**east** | **number** | | [default to undefined]
|
|
10
|
+
**julianDay** | **number** | Julian Date timestamp. Provide exactly one of time or julianDay. | [optional] [default to undefined]
|
|
11
|
+
**north** | **number** | | [default to undefined]
|
|
12
|
+
**time** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**up** | **number** | | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { V1MountTrackPathEnuSample } from '@ourskyai/node_platform-api';
|
|
19
|
+
|
|
20
|
+
const instance: V1MountTrackPathEnuSample = {
|
|
21
|
+
east,
|
|
22
|
+
julianDay,
|
|
23
|
+
north,
|
|
24
|
+
time,
|
|
25
|
+
up,
|
|
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,15 @@
|
|
|
1
|
+
# V1MountTrackPathFrame
|
|
2
|
+
|
|
3
|
+
Coordinate frame used by every control point in a custom path tracking request.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `APPARENT_RA_DEC` (value: `'APPARENT_RA_DEC'`)
|
|
8
|
+
|
|
9
|
+
* `J2000_RA_DEC` (value: `'J2000_RA_DEC'`)
|
|
10
|
+
|
|
11
|
+
* `TOPOCENTRIC_ALT_AZ` (value: `'TOPOCENTRIC_ALT_AZ'`)
|
|
12
|
+
|
|
13
|
+
* `ENU_UNIT_VECTOR` (value: `'ENU_UNIT_VECTOR'`)
|
|
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,27 @@
|
|
|
1
|
+
# V1MountTrackPathRaDecSample
|
|
2
|
+
|
|
3
|
+
Time-tagged equatorial RA/Dec control point. Angles are degrees. Provide exactly one of time or julianDay.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**decDegrees** | **number** | | [default to undefined]
|
|
10
|
+
**julianDay** | **number** | Julian Date timestamp. Provide exactly one of time or julianDay. | [optional] [default to undefined]
|
|
11
|
+
**raDegrees** | **number** | | [default to undefined]
|
|
12
|
+
**time** | **string** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1MountTrackPathRaDecSample } from '@ourskyai/node_platform-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1MountTrackPathRaDecSample = {
|
|
20
|
+
decDegrees,
|
|
21
|
+
julianDay,
|
|
22
|
+
raDegrees,
|
|
23
|
+
time,
|
|
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,17 @@
|
|
|
1
|
+
# V1MountTrackPathState
|
|
2
|
+
|
|
3
|
+
Lifecycle state of the current custom path tracking session.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `NO_SESSION` (value: `'NO_SESSION'`)
|
|
8
|
+
|
|
9
|
+
* `PENDING` (value: `'PENDING'`)
|
|
10
|
+
|
|
11
|
+
* `TRACKING` (value: `'TRACKING'`)
|
|
12
|
+
|
|
13
|
+
* `ENDED` (value: `'ENDED'`)
|
|
14
|
+
|
|
15
|
+
* `FAILED` (value: `'FAILED'`)
|
|
16
|
+
|
|
17
|
+
[[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,49 @@
|
|
|
1
|
+
# V1MountTrackPathStatus
|
|
2
|
+
|
|
3
|
+
Metadata-only status for the current custom path tracking session.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**acceptedSamples** | **number** | Request-local accepted control point count for start/append responses. | [optional] [default to undefined]
|
|
10
|
+
**endedAt** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**endedReason** | [**V1MountTrackPathEndedReason**](V1MountTrackPathEndedReason.md) | | [optional] [default to undefined]
|
|
12
|
+
**errorMessage** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**firstControlPointTime** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**frame** | [**V1MountTrackPathFrame**](V1MountTrackPathFrame.md) | | [optional] [default to undefined]
|
|
15
|
+
**ignoredSamples** | **number** | Request-local ignored stale control point count for start/append responses. | [optional] [default to undefined]
|
|
16
|
+
**lastControlPointTime** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**lastTrackableTime** | **string** | Last generated sample in the first continuous above-horizon resolved segment. | [optional] [default to undefined]
|
|
18
|
+
**retainedSamples** | **number** | | [optional] [default to undefined]
|
|
19
|
+
**startsAt** | **string** | First generated above-horizon sample time when tracking will engage. | [optional] [default to undefined]
|
|
20
|
+
**state** | [**V1MountTrackPathState**](V1MountTrackPathState.md) | | [default to undefined]
|
|
21
|
+
**totalAcceptedSamples** | **number** | | [optional] [default to undefined]
|
|
22
|
+
**totalIgnoredSamples** | **number** | | [optional] [default to undefined]
|
|
23
|
+
**trackingSessionId** | **string** | | [optional] [default to undefined]
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import { V1MountTrackPathStatus } from '@ourskyai/node_platform-api';
|
|
29
|
+
|
|
30
|
+
const instance: V1MountTrackPathStatus = {
|
|
31
|
+
acceptedSamples,
|
|
32
|
+
endedAt,
|
|
33
|
+
endedReason,
|
|
34
|
+
errorMessage,
|
|
35
|
+
firstControlPointTime,
|
|
36
|
+
frame,
|
|
37
|
+
ignoredSamples,
|
|
38
|
+
lastControlPointTime,
|
|
39
|
+
lastTrackableTime,
|
|
40
|
+
retainedSamples,
|
|
41
|
+
startsAt,
|
|
42
|
+
state,
|
|
43
|
+
totalAcceptedSamples,
|
|
44
|
+
totalIgnoredSamples,
|
|
45
|
+
trackingSessionId,
|
|
46
|
+
};
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
[[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
|
+
# V1MoveFocuserPositionRequest
|
|
2
|
+
|
|
3
|
+
Request to move the focuser to a specific absolute position. Used with the deprecated moveToPosition endpoint.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**operation** | [**FocusOperation**](FocusOperation.md) | | [default to undefined]
|
|
10
|
+
**position** | **number** | The absolute position to move the focuser to in focuser-specific units. Valid range depends on the focuser hardware travel limits. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1MoveFocuserPositionRequest } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1MoveFocuserPositionRequest = {
|
|
18
|
+
operation,
|
|
19
|
+
position,
|
|
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,23 @@
|
|
|
1
|
+
# V1MoveFocuserResponse
|
|
2
|
+
|
|
3
|
+
Response returned after a focuser move operation completes, containing the result message and final position.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | Human-readable message describing the result of the move operation. May contain success confirmation or error details. | [optional] [default to undefined]
|
|
10
|
+
**position** | [**FocuserPosition**](FocuserPosition.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1MoveFocuserResponse } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1MoveFocuserResponse = {
|
|
18
|
+
message,
|
|
19
|
+
position,
|
|
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,23 @@
|
|
|
1
|
+
# V1MoveFocuserStepsRequest
|
|
2
|
+
|
|
3
|
+
Request to move the focuser by a relative number of steps. Used with the deprecated move endpoint.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**operation** | [**FocusOperation**](FocusOperation.md) | | [default to undefined]
|
|
10
|
+
**steps** | **number** | The number of steps to move the focuser. This is a relative movement value; the actual direction depends on the operation parameter. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1MoveFocuserStepsRequest } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1MoveFocuserStepsRequest = {
|
|
18
|
+
operation,
|
|
19
|
+
steps,
|
|
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,24 @@
|
|
|
1
|
+
# V1NtpStatus
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**connected** | **boolean** | Whether an NTP source is connected and reachable | [default to undefined]
|
|
9
|
+
**sourceStatistics** | [**V1TimeSourceStatistics**](V1TimeSourceStatistics.md) | | [default to undefined]
|
|
10
|
+
**status** | [**V1NtpStatusDetails**](V1NtpStatusDetails.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1NtpStatus } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1NtpStatus = {
|
|
18
|
+
connected,
|
|
19
|
+
sourceStatistics,
|
|
20
|
+
status,
|
|
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)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# V1NtpStatusDetails
|
|
2
|
+
|
|
3
|
+
Detailed NTP status information
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**peerAddresses** | **Array<string>** | List of NTP peer server addresses | [optional] [default to undefined]
|
|
10
|
+
**poolAddress** | **string** | Address of the NTP pool being used | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1NtpStatusDetails } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1NtpStatusDetails = {
|
|
18
|
+
peerAddresses,
|
|
19
|
+
poolAddress,
|
|
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
|
+
# V1OpenEnclosureShuttersRequest
|
|
2
|
+
|
|
3
|
+
Request parameters for opening enclosure shutters. Includes optional safety override settings for manual operation scenarios.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**ignoreSafety** | **boolean** | When set to true, bypasses safety interlock checks and forces the shutters to open regardless of weather or other safety conditions. Use with caution and only when manual observation confirms safe conditions. Default is false, which enforces all safety checks. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpenEnclosureShuttersRequest } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpenEnclosureShuttersRequest = {
|
|
17
|
+
ignoreSafety,
|
|
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
|
+
# V1OpenRoofRequest
|
|
2
|
+
|
|
3
|
+
Optional request body containing safety override settings for the roof open operation.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**ignoreSafety** | **boolean** | When set to true, bypasses safety interlock checks and forces the roof to open regardless of weather or other safety conditions. Use with extreme caution and only when manual verification confirms safe conditions. Default is false. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpenRoofRequest } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpenRoofRequest = {
|
|
17
|
+
ignoreSafety,
|
|
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
|
+
# V1OpticalPowerMeterStatus
|
|
2
|
+
|
|
3
|
+
Connection status of the optical power meter.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**connected** | **boolean** | Is the Optical Power Meter connected | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpticalPowerMeterStatus } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpticalPowerMeterStatus = {
|
|
17
|
+
connected,
|
|
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
|
+
# V1OpticalTubeCoverSelectorRequest
|
|
2
|
+
|
|
3
|
+
Optional optical tube selector. If omitted, the default optical tube is used.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**opticalTubeId** | **string** | Unique identifier of the optical tube to command. Obtain valid optical tube IDs from the optical tube statuses endpoint. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpticalTubeCoverSelectorRequest } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpticalTubeCoverSelectorRequest = {
|
|
17
|
+
opticalTubeId,
|
|
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,27 @@
|
|
|
1
|
+
# V1OpticalTubeCoverStatus
|
|
2
|
+
|
|
3
|
+
Current status of the optical tube dust cover including connection state and open/closed position.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**connected** | **boolean** | Indicates whether communication with the cover controller is active. When false, the cover cannot be operated and its state may be unknown. | [default to undefined]
|
|
10
|
+
**id** | **string** | Unique identifier of the optical tube within the system. | [optional] [default to undefined]
|
|
11
|
+
**isHomed** | **boolean** | Indicates whether the cover is homed. | [optional] [default to false]
|
|
12
|
+
**isOpen** | **boolean** | Indicates whether the cover is currently open. True means the cover is fully open and the primary mirror is exposed for observing. False means the cover is closed and protecting the mirror. | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1OpticalTubeCoverStatus } from '@ourskyai/node_platform-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1OpticalTubeCoverStatus = {
|
|
20
|
+
connected,
|
|
21
|
+
id,
|
|
22
|
+
isHomed,
|
|
23
|
+
isOpen,
|
|
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
|
+
# V1OpticalTubeCoverStatuses
|
|
2
|
+
|
|
3
|
+
Collection of cover statuses, one per optical tube.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**statuses** | [**Array<V1OpticalTubeCoverStatus>**](V1OpticalTubeCoverStatus.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpticalTubeCoverStatuses } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpticalTubeCoverStatuses = {
|
|
17
|
+
statuses,
|
|
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
|
+
# V1OpticalTubeFanGroupStatus
|
|
2
|
+
|
|
3
|
+
Fan statuses for a specific optical tube.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique identifier of the optical tube within the system. Null when the status source does not provide component IDs. | [optional] [default to undefined]
|
|
10
|
+
**statuses** | [**Array<V1OpticalTubeFanStatus>**](V1OpticalTubeFanStatus.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1OpticalTubeFanGroupStatus } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1OpticalTubeFanGroupStatus = {
|
|
18
|
+
id,
|
|
19
|
+
statuses,
|
|
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
|
+
# V1OpticalTubeFanGroupStatuses
|
|
2
|
+
|
|
3
|
+
Collection of fan statuses grouped by optical tube.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**statuses** | [**Array<V1OpticalTubeFanGroupStatus>**](V1OpticalTubeFanGroupStatus.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpticalTubeFanGroupStatuses } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpticalTubeFanGroupStatuses = {
|
|
17
|
+
statuses,
|
|
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
|
+
# V1OpticalTubeFanRole
|
|
2
|
+
|
|
3
|
+
Identifies the specific fan location and purpose within the optical tube assembly. M1 refers to the primary mirror, M2 to the secondary mirror, and M3 to the tertiary mirror. HEATER variants are fans associated with the dew heater systems.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `M1` (value: `'M1'`)
|
|
8
|
+
|
|
9
|
+
* `M1_REAR` (value: `'M1_REAR'`)
|
|
10
|
+
|
|
11
|
+
* `M1_SIDE` (value: `'M1_SIDE'`)
|
|
12
|
+
|
|
13
|
+
* `M2` (value: `'M2'`)
|
|
14
|
+
|
|
15
|
+
* `M3` (value: `'M3'`)
|
|
16
|
+
|
|
17
|
+
* `M1_HEATER` (value: `'M1_HEATER'`)
|
|
18
|
+
|
|
19
|
+
* `M2_HEATER` (value: `'M2_HEATER'`)
|
|
20
|
+
|
|
21
|
+
* `M3_HEATER` (value: `'M3_HEATER'`)
|
|
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,25 @@
|
|
|
1
|
+
# V1OpticalTubeFanStatus
|
|
2
|
+
|
|
3
|
+
Status information for a single cooling fan in the optical tube assembly.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**connected** | **boolean** | Indicates whether communication with this fan controller is active. When false, the fan cannot be controlled and its state may be unknown. | [default to undefined]
|
|
10
|
+
**isOn** | **boolean** | Indicates whether this fan is currently running. True when the fan is actively spinning, false when stopped. | [default to undefined]
|
|
11
|
+
**role** | [**V1OpticalTubeFanRole**](V1OpticalTubeFanRole.md) | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1OpticalTubeFanStatus } from '@ourskyai/node_platform-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1OpticalTubeFanStatus = {
|
|
19
|
+
connected,
|
|
20
|
+
isOn,
|
|
21
|
+
role,
|
|
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)
|