@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,166 @@
|
|
|
1
|
+
# V1EventData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**image** | [**V1Image**](V1Image.md) | | [default to undefined]
|
|
9
|
+
**celsius** | **number** | The new temperature setpoint in degrees Celsius. Negative values are common for cooled astronomical cameras to reduce thermal noise. | [default to undefined]
|
|
10
|
+
**log** | **string** | The log message content from the hardware daemon. May contain technical details useful for debugging hardware communication issues. | [default to undefined]
|
|
11
|
+
**connectionStatus** | [**ConnectionStatus**](ConnectionStatus.md) | | [default to undefined]
|
|
12
|
+
**id** | **string** | Unique identifier for the task that was cancelled. | [default to undefined]
|
|
13
|
+
**name** | **string** | Human-readable name of the camera, such as the manufacturer and model or a user-assigned label. | [default to undefined]
|
|
14
|
+
**decDegrees** | **number** | Declination of the image center in decimal degrees. Range is -90 to +90 degrees. | [default to undefined]
|
|
15
|
+
**focalLength** | **number** | Calculated effective focal length of the optical system in millimeters based on the plate scale. | [default to undefined]
|
|
16
|
+
**raDegrees** | **number** | Right ascension of the image center in decimal degrees. Range is 0 to 360 degrees. | [default to undefined]
|
|
17
|
+
**binning** | **number** | Pixel binning factor where adjacent pixels are combined. Higher binning reduces resolution but improves sensitivity and download speed. | [default to undefined]
|
|
18
|
+
**exposure** | **number** | Exposure duration in seconds. Longer exposures collect more light but increase noise and trailing risk. | [default to undefined]
|
|
19
|
+
**gain** | **number** | Camera gain setting controlling signal amplification. Higher values increase sensitivity but also increase noise. | [default to undefined]
|
|
20
|
+
**gainMode** | **number** | Camera gain mode selection for cameras with multiple gain modes such as high dynamic range or low noise modes. | [default to undefined]
|
|
21
|
+
**offset** | **number** | Camera offset or black level setting. Ensures the histogram does not clip at zero for proper calibration. | [default to undefined]
|
|
22
|
+
**message** | **string** | Error message describing why the autofocus failed, such as insufficient stars, poor curve fit, or mechanical issues. | [default to undefined]
|
|
23
|
+
**dec** | **number** | Solved declination of the calibration point in decimal degrees. | [default to undefined]
|
|
24
|
+
**ra** | **number** | Solved right ascension of the calibration point in decimal degrees. | [default to undefined]
|
|
25
|
+
**altitude** | **number** | Altitude above mean sea level in meters. | [default to undefined]
|
|
26
|
+
**azimuth** | **number** | Azimuth angle of this measurement point in degrees, measured from north through east. | [default to undefined]
|
|
27
|
+
**enabled** | **boolean** | True if slew demo mode was enabled, false if it was disabled. | [default to undefined]
|
|
28
|
+
**ignoreCoordinates** | **boolean** | Indicates whether the failed solve attempt ignored mount coordinates. If false and the solve failed, a blind solve retry may succeed. | [default to undefined]
|
|
29
|
+
**maxAltitude** | **number** | Maximum observable altitude at this azimuth in degrees. Typically near 90 degrees unless an overhead obstruction exists. | [default to undefined]
|
|
30
|
+
**minAltitude** | **number** | Minimum observable altitude at this azimuth in degrees. Objects below this altitude are obstructed. | [default to undefined]
|
|
31
|
+
**count** | **number** | Number of stars detected and measured in the image. More stars generally provide more reliable statistics. | [default to undefined]
|
|
32
|
+
**hfr** | **number** | Mean half-flux radius of measured stars in pixels. Lower values indicate better focus and seeing conditions. | [default to undefined]
|
|
33
|
+
**hfrStdDev** | **number** | Standard deviation of HFR measurements in pixels. Lower values indicate more consistent star shapes across the image. | [default to undefined]
|
|
34
|
+
**body** | **string** | Full content of the debug message with detailed diagnostic information. | [default to undefined]
|
|
35
|
+
**title** | **string** | Brief title or category of the debug message for quick identification. | [default to undefined]
|
|
36
|
+
**blind** | **boolean** | When true, performs a wide-range blind search for focus. When false, refines focus near the current position. | [default to undefined]
|
|
37
|
+
**maxFocusPoints** | **number** | Maximum number of focus positions to sample during the autofocus routine. | [default to undefined]
|
|
38
|
+
**method** | **string** | Focus measurement method being used, such as HFR, FWHM, or contrast-based analysis. | [default to undefined]
|
|
39
|
+
**rSquaredThreshold** | **number** | Minimum R-squared value required for the focus curve fit to be considered successful. Range is 0 to 1. | [default to undefined]
|
|
40
|
+
**stepMicrons** | **number** | Step size between focus measurement points in microns. Smaller steps provide finer resolution but require more time. | [default to undefined]
|
|
41
|
+
**focusPosition** | **number** | The optimal focus position determined by the autofocus routine, in focuser steps or encoder units. | [default to undefined]
|
|
42
|
+
**pointsUsed** | **number** | Number of measurement points used in the final focus curve calculation. | [optional] [default to undefined]
|
|
43
|
+
**rSquared** | **number** | The R-squared value of the focus curve fit, indicating how well the data fits the expected parabolic curve. Values closer to 1 indicate better fits. Null if not calculated. | [optional] [default to undefined]
|
|
44
|
+
**focuserPosition** | **number** | Focuser position in steps or encoder units where this measurement was taken. | [default to undefined]
|
|
45
|
+
**measurementMethod** | **string** | Method used to measure focus quality, such as HFR, FWHM, or contrast-based metrics. | [default to undefined]
|
|
46
|
+
**measurementValue** | **number** | The measured focus quality value. Interpretation depends on the measurement method used. | [optional] [default to undefined]
|
|
47
|
+
**fix** | **number** | GPS fix quality indicator. 0 means no fix, 1 means 2D fix, 2 means 3D fix. Higher values indicate better positioning. | [default to undefined]
|
|
48
|
+
**latitude** | **number** | Geographic latitude in decimal degrees. Positive values are North, negative are South. | [default to undefined]
|
|
49
|
+
**longitude** | **number** | Geographic longitude in decimal degrees. Positive values are East, negative are West. | [default to undefined]
|
|
50
|
+
**positionError** | **number** | Estimated horizontal position error in meters. Lower values indicate more accurate positioning. | [default to undefined]
|
|
51
|
+
**satellitesUsed** | **number** | Number of satellites used in the position calculation. | [default to undefined]
|
|
52
|
+
**satellitesVisible** | **number** | Total number of satellites visible to the GPS receiver. | [default to undefined]
|
|
53
|
+
**timestamp** | **string** | ISO 8601 timestamp when the task was cancelled. | [default to undefined]
|
|
54
|
+
**type** | [**V1TaskType**](V1TaskType.md) | | [default to undefined]
|
|
55
|
+
**gracefullyCancelled** | **boolean** | True if the task was cancelled gracefully allowing cleanup to complete. False if the task was forcefully terminated. | [default to undefined]
|
|
56
|
+
**step** | **number** | The current step number in the startup wizard sequence. Starts at 1 and increments with each completed step. | [default to undefined]
|
|
57
|
+
**taskId** | **string** | Unique identifier for the task associated with this wizard step. | [default to undefined]
|
|
58
|
+
**relays** | [**Array<V1Relay>**](V1Relay.md) | Array of all relay states showing the current on/off status of each controllable relay. | [default to undefined]
|
|
59
|
+
**roof** | [**V1RoofStatus**](V1RoofStatus.md) | | [default to undefined]
|
|
60
|
+
**safetyStatus** | [**V1SafetyStatus**](V1SafetyStatus.md) | | [default to undefined]
|
|
61
|
+
**operationStatus** | [**V1SystemOperationStatus**](V1SystemOperationStatus.md) | | [default to undefined]
|
|
62
|
+
**dotCalibration** | [**Array<Point2D>**](Point2D.md) | Reference positions from calibration (pixels), one per tracked dot | [default to undefined]
|
|
63
|
+
**dotDisplacement** | **Array<number>** | Euclidean displacement per tracked dot (pixels) | [default to undefined]
|
|
64
|
+
**dotMeasured** | [**Array<Point2D>**](Point2D.md) | Measured positions this frame (pixels), one per tracked dot | [default to undefined]
|
|
65
|
+
**effectivePupilRadiusMm** | **number** | Effective pupil radius in mm | [optional] [default to undefined]
|
|
66
|
+
**focalLengthMm** | **number** | Lenslet array focal length in mm | [default to undefined]
|
|
67
|
+
**gridCols** | **number** | Number of lenslet grid columns | [default to undefined]
|
|
68
|
+
**gridRows** | **number** | Number of lenslet grid rows | [default to undefined]
|
|
69
|
+
**lensletPitchMm** | **number** | Lenslet pitch in mm (for client-side unit conversions) | [default to undefined]
|
|
70
|
+
**pixelSizeMm** | **number** | Sensor pixel size in mm | [default to undefined]
|
|
71
|
+
**pupilCenterX** | **number** | X coordinate of the detected pupil center (grid units) | [optional] [default to undefined]
|
|
72
|
+
**pupilCenterY** | **number** | Y coordinate of the detected pupil center (grid units) | [optional] [default to undefined]
|
|
73
|
+
**pvWavefrontErrorUm** | **number** | Peak-to-valley wavefront error in micrometers | [optional] [default to undefined]
|
|
74
|
+
**radiusOfCurvatureM** | **number** | Radius of curvature in meters | [optional] [default to undefined]
|
|
75
|
+
**rmsWavefrontErrorUm** | **number** | RMS wavefront error in micrometers | [optional] [default to undefined]
|
|
76
|
+
**slopeX** | **Array<number>** | Dense slope field X component (radians), row-major [gridRows x gridCols]. Check valid[] before using — invalid cells are zeroed. | [default to undefined]
|
|
77
|
+
**slopeY** | **Array<number>** | Dense slope field Y component (radians), row-major [gridRows x gridCols]. Check valid[] before using — invalid cells are zeroed. | [default to undefined]
|
|
78
|
+
**timestampMs** | **number** | | [default to undefined]
|
|
79
|
+
**valid** | **Array<boolean>** | Validity mask for the slope grid, row-major [gridRows x gridCols]. False for lenslet cells with no detected dot. | [default to undefined]
|
|
80
|
+
**zernikeCoefficients** | **Array<number>** | Zernike coefficients (empty when not computed) | [default to undefined]
|
|
81
|
+
**statuses** | [**V1EnclosureShutterStatuses**](V1EnclosureShutterStatuses.md) | | [default to undefined]
|
|
82
|
+
|
|
83
|
+
## Example
|
|
84
|
+
|
|
85
|
+
```typescript
|
|
86
|
+
import { V1EventData } from '@ourskyai/node_platform-api';
|
|
87
|
+
|
|
88
|
+
const instance: V1EventData = {
|
|
89
|
+
image,
|
|
90
|
+
celsius,
|
|
91
|
+
log,
|
|
92
|
+
connectionStatus,
|
|
93
|
+
id,
|
|
94
|
+
name,
|
|
95
|
+
decDegrees,
|
|
96
|
+
focalLength,
|
|
97
|
+
raDegrees,
|
|
98
|
+
binning,
|
|
99
|
+
exposure,
|
|
100
|
+
gain,
|
|
101
|
+
gainMode,
|
|
102
|
+
offset,
|
|
103
|
+
message,
|
|
104
|
+
dec,
|
|
105
|
+
ra,
|
|
106
|
+
altitude,
|
|
107
|
+
azimuth,
|
|
108
|
+
enabled,
|
|
109
|
+
ignoreCoordinates,
|
|
110
|
+
maxAltitude,
|
|
111
|
+
minAltitude,
|
|
112
|
+
count,
|
|
113
|
+
hfr,
|
|
114
|
+
hfrStdDev,
|
|
115
|
+
body,
|
|
116
|
+
title,
|
|
117
|
+
blind,
|
|
118
|
+
maxFocusPoints,
|
|
119
|
+
method,
|
|
120
|
+
rSquaredThreshold,
|
|
121
|
+
stepMicrons,
|
|
122
|
+
focusPosition,
|
|
123
|
+
pointsUsed,
|
|
124
|
+
rSquared,
|
|
125
|
+
focuserPosition,
|
|
126
|
+
measurementMethod,
|
|
127
|
+
measurementValue,
|
|
128
|
+
fix,
|
|
129
|
+
latitude,
|
|
130
|
+
longitude,
|
|
131
|
+
positionError,
|
|
132
|
+
satellitesUsed,
|
|
133
|
+
satellitesVisible,
|
|
134
|
+
timestamp,
|
|
135
|
+
type,
|
|
136
|
+
gracefullyCancelled,
|
|
137
|
+
step,
|
|
138
|
+
taskId,
|
|
139
|
+
relays,
|
|
140
|
+
roof,
|
|
141
|
+
safetyStatus,
|
|
142
|
+
operationStatus,
|
|
143
|
+
dotCalibration,
|
|
144
|
+
dotDisplacement,
|
|
145
|
+
dotMeasured,
|
|
146
|
+
effectivePupilRadiusMm,
|
|
147
|
+
focalLengthMm,
|
|
148
|
+
gridCols,
|
|
149
|
+
gridRows,
|
|
150
|
+
lensletPitchMm,
|
|
151
|
+
pixelSizeMm,
|
|
152
|
+
pupilCenterX,
|
|
153
|
+
pupilCenterY,
|
|
154
|
+
pvWavefrontErrorUm,
|
|
155
|
+
radiusOfCurvatureM,
|
|
156
|
+
rmsWavefrontErrorUm,
|
|
157
|
+
slopeX,
|
|
158
|
+
slopeY,
|
|
159
|
+
timestampMs,
|
|
160
|
+
valid,
|
|
161
|
+
zernikeCoefficients,
|
|
162
|
+
statuses,
|
|
163
|
+
};
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
[[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/V1Filter.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# V1Filter
|
|
2
|
+
|
|
3
|
+
Represents a filter installed in a specific position of the filter wheel.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**position** | **number** | The slot position of this filter in the wheel as a zero-based index. | [default to undefined]
|
|
10
|
+
**type** | [**V1FilterType**](V1FilterType.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1Filter } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1Filter = {
|
|
18
|
+
position,
|
|
19
|
+
type,
|
|
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,61 @@
|
|
|
1
|
+
# V1FilterType
|
|
2
|
+
|
|
3
|
+
Enumeration of supported astronomical filter types. NONE indicates an empty slot. RGB filters (RED, BLUE, GREEN) are for color imaging. UV and IR are for ultraviolet and infrared. LUMINANCE captures broadband light. Narrowband filters (H_ALPHA, H_BETA, S_II, O_III) isolate specific emission lines. PHOTO_JOHNSON and PHOTO_COUSINS are standard photometric systems. PHOTO_SLOAN filters follow the SDSS photometric system. DUAL_BAND, TRIPLE_BAND, and QUAD_BAND are multi-narrowband filters. DARK blocks all light for calibration frames. OTHER covers non-standard filters.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `NONE` (value: `'NONE'`)
|
|
8
|
+
|
|
9
|
+
* `RED` (value: `'RED'`)
|
|
10
|
+
|
|
11
|
+
* `BLUE` (value: `'BLUE'`)
|
|
12
|
+
|
|
13
|
+
* `GREEN` (value: `'GREEN'`)
|
|
14
|
+
|
|
15
|
+
* `UV` (value: `'UV'`)
|
|
16
|
+
|
|
17
|
+
* `IR` (value: `'IR'`)
|
|
18
|
+
|
|
19
|
+
* `LUMINANCE` (value: `'LUMINANCE'`)
|
|
20
|
+
|
|
21
|
+
* `ENHANCED_LUMINANCE` (value: `'ENHANCED_LUMINANCE'`)
|
|
22
|
+
|
|
23
|
+
* `H_ALPHA` (value: `'H_ALPHA'`)
|
|
24
|
+
|
|
25
|
+
* `H_BETA` (value: `'H_BETA'`)
|
|
26
|
+
|
|
27
|
+
* `S_II` (value: `'S_II'`)
|
|
28
|
+
|
|
29
|
+
* `O_III` (value: `'O_III'`)
|
|
30
|
+
|
|
31
|
+
* `DUAL_BAND` (value: `'DUAL_BAND'`)
|
|
32
|
+
|
|
33
|
+
* `PHOTO_JOHNSON_U` (value: `'PHOTO_JOHNSON_U'`)
|
|
34
|
+
|
|
35
|
+
* `PHOTO_JOHNSON_B` (value: `'PHOTO_JOHNSON_B'`)
|
|
36
|
+
|
|
37
|
+
* `PHOTO_JOHNSON_V` (value: `'PHOTO_JOHNSON_V'`)
|
|
38
|
+
|
|
39
|
+
* `PHOTO_COUSINS_R` (value: `'PHOTO_COUSINS_R'`)
|
|
40
|
+
|
|
41
|
+
* `PHOTO_COUSINS_I` (value: `'PHOTO_COUSINS_I'`)
|
|
42
|
+
|
|
43
|
+
* `PHOTO_SLOAN_U` (value: `'PHOTO_SLOAN_U'`)
|
|
44
|
+
|
|
45
|
+
* `PHOTO_SLOAN_G` (value: `'PHOTO_SLOAN_G'`)
|
|
46
|
+
|
|
47
|
+
* `PHOTO_SLOAN_R` (value: `'PHOTO_SLOAN_R'`)
|
|
48
|
+
|
|
49
|
+
* `PHOTO_SLOAN_I` (value: `'PHOTO_SLOAN_I'`)
|
|
50
|
+
|
|
51
|
+
* `PHOTO_SLOAN_Z` (value: `'PHOTO_SLOAN_Z'`)
|
|
52
|
+
|
|
53
|
+
* `TRIPLE_BAND` (value: `'TRIPLE_BAND'`)
|
|
54
|
+
|
|
55
|
+
* `QUAD_BAND` (value: `'QUAD_BAND'`)
|
|
56
|
+
|
|
57
|
+
* `DARK` (value: `'DARK'`)
|
|
58
|
+
|
|
59
|
+
* `OTHER` (value: `'OTHER'`)
|
|
60
|
+
|
|
61
|
+
[[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
|
+
# V1FilterWheelStatus
|
|
2
|
+
|
|
3
|
+
Current status of the filter wheel including connection state, current position, and configuration of all filter slots.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**capacity** | **number** | Total number of filter slots available in the wheel. Positions range from 0 to (capacity - 1). | [default to undefined]
|
|
10
|
+
**connected** | **boolean** | Indicates whether communication with the filter wheel is active. When false, the filter wheel cannot be controlled and position data may be stale. | [default to undefined]
|
|
11
|
+
**filters** | [**Array<V1Filter>**](V1Filter.md) | Array of filter configurations for each slot in the wheel. May not include all positions if some slots have not been configured. | [optional] [default to undefined]
|
|
12
|
+
**id** | **string** | Unique identifier of the filter wheel within the system. | [optional] [default to undefined]
|
|
13
|
+
**position** | **number** | Current filter wheel position as a zero-based slot index. This indicates which filter is currently in the optical path. | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { V1FilterWheelStatus } from '@ourskyai/node_platform-api';
|
|
19
|
+
|
|
20
|
+
const instance: V1FilterWheelStatus = {
|
|
21
|
+
capacity,
|
|
22
|
+
connected,
|
|
23
|
+
filters,
|
|
24
|
+
id,
|
|
25
|
+
position,
|
|
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,21 @@
|
|
|
1
|
+
# V1FilterWheelStatuses
|
|
2
|
+
|
|
3
|
+
Container object holding the list of all filter wheel statuses.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**statuses** | [**Array<V1FilterWheelStatus>**](V1FilterWheelStatus.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1FilterWheelStatuses } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1FilterWheelStatuses = {
|
|
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
|
+
# V1FocuserLimit
|
|
2
|
+
|
|
3
|
+
Physical travel limits of the focuser discovered by the findLimit calibration routine.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**max** | **number** | Maximum focuser position in steps, representing the fully extended (outward) position. | [default to undefined]
|
|
10
|
+
**min** | **number** | Minimum focuser position in steps, representing the fully retracted (inward) position. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1FocuserLimit } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1FocuserLimit = {
|
|
18
|
+
max,
|
|
19
|
+
min,
|
|
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
|
+
# V1FocuserMotorSystemSettings
|
|
2
|
+
|
|
3
|
+
Configuration settings for a focuser motor including slew speed, acceleration, and negative and positive travel limits in microns.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**accelerationMicronsPerSecondSquared** | **number** | Maximum acceleration of the focuser motor in microns per second squared. Controls how quickly the focuser motor ramps up to slew speed. | [optional] [default to undefined]
|
|
10
|
+
**negativeLimitMicrons** | **number** | Negative travel limit of the focuser motor in microns. The motor should not move below this position. | [optional] [default to undefined]
|
|
11
|
+
**positiveLimitMicrons** | **number** | Positive travel limit of the focuser motor in microns. The motor should not move above this position. | [optional] [default to undefined]
|
|
12
|
+
**velocityMicronsPerSecond** | **number** | Maximum slew velocity of the focuser motor in microns per second. Higher values enable faster focus adjustments but may reduce positioning precision or increase wear. | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1FocuserMotorSystemSettings } from '@ourskyai/node_platform-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1FocuserMotorSystemSettings = {
|
|
20
|
+
accelerationMicronsPerSecondSquared,
|
|
21
|
+
negativeLimitMicrons,
|
|
22
|
+
positiveLimitMicrons,
|
|
23
|
+
velocityMicronsPerSecond,
|
|
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
|
+
# V1FocuserSelectorRequest
|
|
2
|
+
|
|
3
|
+
Optional focuser selector. If omitted, the default focuser is used.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**focuserId** | **string** | Unique identifier of the focuser to command. Obtain valid focuser IDs from the focuser statuses endpoint. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1FocuserSelectorRequest } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1FocuserSelectorRequest = {
|
|
17
|
+
focuserId,
|
|
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,31 @@
|
|
|
1
|
+
# V1FocuserStatus
|
|
2
|
+
|
|
3
|
+
Current status of the telescope focuser including connection state, movement status, and position information.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**canHome** | **boolean** | Indicates whether the focuser supports a homing operation. When false, the home command is unavailable for this device and the UI should not offer it. | [optional] [default to undefined]
|
|
10
|
+
**connected** | **boolean** | Indicates whether the focuser hardware is connected and communicating. A false value means the focuser cannot be controlled until connection is restored. | [default to undefined]
|
|
11
|
+
**hasHomed** | **boolean** | Indicates whether the focuser has successfully completed a homing procedure since power-on. When false, the mechanical reference position is not yet established and positions may be unreliable until the focuser is homed. | [optional] [default to undefined]
|
|
12
|
+
**id** | **string** | Unique identifier of the focuser within the system. | [optional] [default to undefined]
|
|
13
|
+
**moving** | **boolean** | Indicates whether the focuser is currently in motion. Wait for this to become false before capturing images or starting autofocus routines. | [default to undefined]
|
|
14
|
+
**position** | [**FocuserPosition**](FocuserPosition.md) | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { V1FocuserStatus } from '@ourskyai/node_platform-api';
|
|
20
|
+
|
|
21
|
+
const instance: V1FocuserStatus = {
|
|
22
|
+
canHome,
|
|
23
|
+
connected,
|
|
24
|
+
hasHomed,
|
|
25
|
+
id,
|
|
26
|
+
moving,
|
|
27
|
+
position,
|
|
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)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1FocuserStatuses
|
|
2
|
+
|
|
3
|
+
Container object holding the list of all focuser statuses.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**statuses** | [**Array<V1FocuserStatus>**](V1FocuserStatus.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1FocuserStatuses } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1FocuserStatuses = {
|
|
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
|
+
# V1FocuserSystemSettings
|
|
2
|
+
|
|
3
|
+
Configuration settings for focuser motors including slew speed, acceleration, and travel limits in microns.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**focuserA** | [**V1FocuserMotorSystemSettings**](V1FocuserMotorSystemSettings.md) | | [optional] [default to undefined]
|
|
10
|
+
**focuserB** | [**V1FocuserMotorSystemSettings**](V1FocuserMotorSystemSettings.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1FocuserSystemSettings } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1FocuserSystemSettings = {
|
|
18
|
+
focuserA,
|
|
19
|
+
focuserB,
|
|
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
|
+
# V1FollowTLERequest
|
|
2
|
+
|
|
3
|
+
Request to track a satellite using Two-Line Element (TLE) orbital data. The mount will continuously compute and follow the satellite trajectory.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**tleLine1** | **string** | First line of the TLE data set containing the satellite catalog number, classification, launch info, and epoch. Standard 69-character format from NORAD. | [default to undefined]
|
|
10
|
+
**tleLine2** | **string** | Second line of the TLE data set containing the orbital elements including inclination, eccentricity, and mean motion. Standard 69-character format from NORAD. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1FollowTLERequest } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1FollowTLERequest = {
|
|
18
|
+
tleLine1,
|
|
19
|
+
tleLine2,
|
|
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,43 @@
|
|
|
1
|
+
# V1GetComponentStatusResponse
|
|
2
|
+
|
|
3
|
+
DEPRECATED: Comprehensive status of all telescope hardware components. Use V1SystemStatus from system_query.yaml instead for improved structure and additional component support.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**cameraStatuses** | [**Array<V1CameraStatus>**](V1CameraStatus.md) | Array of status objects for all connected cameras including imaging and guide cameras. | [default to undefined]
|
|
10
|
+
**enclosureStatus** | [**V1EnclosureStatus**](V1EnclosureStatus.md) | | [optional] [default to undefined]
|
|
11
|
+
**enclosureWindowStatus** | [**V1EnclosureWindowStatus**](V1EnclosureWindowStatus.md) | | [optional] [default to undefined]
|
|
12
|
+
**filterWheelStatus** | [**V1FilterWheelStatus**](V1FilterWheelStatus.md) | | [default to undefined]
|
|
13
|
+
**focuserStatus** | [**V1FocuserStatus**](V1FocuserStatus.md) | | [default to undefined]
|
|
14
|
+
**mountStatus** | [**V1MountStatus**](V1MountStatus.md) | | [default to undefined]
|
|
15
|
+
**opticalTubeStatus** | [**OpticalTubeStatus**](OpticalTubeStatus.md) | | [default to undefined]
|
|
16
|
+
**relaysStatus** | [**RelaysStatus**](RelaysStatus.md) | | [default to undefined]
|
|
17
|
+
**roofStatus** | [**RoofStatus**](RoofStatus.md) | | [default to undefined]
|
|
18
|
+
**rotatorStatus** | [**V1RotatorStatus**](V1RotatorStatus.md) | | [optional] [default to undefined]
|
|
19
|
+
**safetyStatus** | [**V1SafetyStatus**](V1SafetyStatus.md) | | [default to undefined]
|
|
20
|
+
**weatherStationStatus** | [**V1WeatherStationStatus**](V1WeatherStationStatus.md) | | [default to undefined]
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { V1GetComponentStatusResponse } from '@ourskyai/node_platform-api';
|
|
26
|
+
|
|
27
|
+
const instance: V1GetComponentStatusResponse = {
|
|
28
|
+
cameraStatuses,
|
|
29
|
+
enclosureStatus,
|
|
30
|
+
enclosureWindowStatus,
|
|
31
|
+
filterWheelStatus,
|
|
32
|
+
focuserStatus,
|
|
33
|
+
mountStatus,
|
|
34
|
+
opticalTubeStatus,
|
|
35
|
+
relaysStatus,
|
|
36
|
+
roofStatus,
|
|
37
|
+
rotatorStatus,
|
|
38
|
+
safetyStatus,
|
|
39
|
+
weatherStationStatus,
|
|
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,33 @@
|
|
|
1
|
+
# V1GetHealthCheckResponse
|
|
2
|
+
|
|
3
|
+
Health status and version information for the edge controller. Used for monitoring system health and verifying firmware compatibility during integration.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**habitatFirmwareVersion** | **string** | Firmware version of the habitat controller subsystem. Should be compatible with the main software version. | [default to undefined]
|
|
10
|
+
**hardwareVersion** | **string** | Hardware revision identifier of the edge controller board. Important for hardware-specific feature support. | [default to undefined]
|
|
11
|
+
**healthy** | **boolean** | True if the edge controller is healthy and operating normally. False indicates a problem requiring attention. | [default to undefined]
|
|
12
|
+
**lineageId** | **string** | Unique identifier for the lineage or configuration version of this system. Used for tracking configuration changes. | [optional] [default to undefined]
|
|
13
|
+
**message** | **string** | Human-readable message providing additional context about the health status. Contains diagnostic details when healthy is false. | [default to undefined]
|
|
14
|
+
**serialNumber** | **string** | Hardware serial number of the edge controller unit. Useful for inventory tracking and support identification. | [optional] [default to undefined]
|
|
15
|
+
**version** | **string** | Semantic version string of the edge controller software. Use for compatibility checks and support requests. | [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { V1GetHealthCheckResponse } from '@ourskyai/node_platform-api';
|
|
21
|
+
|
|
22
|
+
const instance: V1GetHealthCheckResponse = {
|
|
23
|
+
habitatFirmwareVersion,
|
|
24
|
+
hardwareVersion,
|
|
25
|
+
healthy,
|
|
26
|
+
lineageId,
|
|
27
|
+
message,
|
|
28
|
+
serialNumber,
|
|
29
|
+
version,
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[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
|
+
# V1GetImageProcessingPluginLogsRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**pluginId** | **string** | | [default to undefined]
|
|
9
|
+
**since** | **string** | Only return logs after this timestamp (ISO 8601). | [optional] [default to undefined]
|
|
10
|
+
**tail** | **number** | Number of most recent log lines to return. Defaults to 100 if not specified. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1GetImageProcessingPluginLogsRequest } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1GetImageProcessingPluginLogsRequest = {
|
|
18
|
+
pluginId,
|
|
19
|
+
since,
|
|
20
|
+
tail,
|
|
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,20 @@
|
|
|
1
|
+
# V1GetImageProcessingPluginRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**pluginId** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { V1GetImageProcessingPluginRequest } from '@ourskyai/node_platform-api';
|
|
14
|
+
|
|
15
|
+
const instance: V1GetImageProcessingPluginRequest = {
|
|
16
|
+
pluginId,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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
|
+
# V1GetStorageStatusResponse
|
|
2
|
+
|
|
3
|
+
DEPRECATED: Storage utilization information for the edge controller filesystem. Use V1SystemStorageStatus from system_query.yaml instead.
|
|
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. | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1GetStorageStatusResponse } from '@ourskyai/node_platform-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1GetStorageStatusResponse = {
|
|
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,24 @@
|
|
|
1
|
+
# V1GnssPpsStatus
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**connected** | **boolean** | Whether a GNSS PPS source is connected and reachable | [default to undefined]
|
|
9
|
+
**sourceStatistics** | [**V1TimeSourceStatistics**](V1TimeSourceStatistics.md) | | [default to undefined]
|
|
10
|
+
**status** | [**V1GnssPpsStatusDetails**](V1GnssPpsStatusDetails.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1GnssPpsStatus } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1GnssPpsStatus = {
|
|
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)
|