@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
package/docs/V1Video.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# V1Video
|
|
2
|
+
|
|
3
|
+
Complete metadata for a recorded video including capture settings, file information, codec details, and timing data. Use this object to understand the recording parameters and locate the video file.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**binning** | **number** | Pixel binning factor that was used during recording. A value of 1 indicates full resolution capture. | [optional] [default to undefined]
|
|
10
|
+
**cameraId** | **string** | Identifier of the camera that recorded this video. Useful for filtering videos by camera source. | [default to undefined]
|
|
11
|
+
**captureEndedAt** | **string** | ISO 8601 timestamp indicating when video recording ended and the last frame was captured. | [default to undefined]
|
|
12
|
+
**captureStartedAt** | **string** | ISO 8601 timestamp indicating when video recording began and the first frame was captured. | [default to undefined]
|
|
13
|
+
**codec** | [**VideoCodec**](VideoCodec.md) | | [default to undefined]
|
|
14
|
+
**containerFormat** | [**VideoContainerFormat**](VideoContainerFormat.md) | | [default to undefined]
|
|
15
|
+
**createdAt** | **string** | ISO 8601 timestamp indicating when this video record was created in the database. Used for pagination with the before parameter. | [default to undefined]
|
|
16
|
+
**exposureCount** | **number** | Total number of individual frames or exposures contained in the video file. Useful for estimating total integration time. | [optional] [default to undefined]
|
|
17
|
+
**exposureSeconds** | **number** | Exposure duration in seconds for each individual frame in the video. Longer exposures capture more light per frame but reduce the effective frame rate. | [optional] [default to undefined]
|
|
18
|
+
**fileSizeMb** | **number** | Size of the video file in megabytes. Useful for estimating download times and managing storage space. | [default to undefined]
|
|
19
|
+
**frameSeconds** | **number** | Duration in seconds between the start of consecutive frames. This determines the effective capture rate and may differ from exposure time if there is readout overhead. | [optional] [default to undefined]
|
|
20
|
+
**gain** | **number** | Sensor gain setting that was applied during recording. Higher values indicate more signal amplification was used. | [optional] [default to undefined]
|
|
21
|
+
**id** | **string** | Unique identifier for this video recording. Use this ID for any video-specific operations such as download or deletion. | [default to undefined]
|
|
22
|
+
**offset** | **number** | Sensor offset or black level setting that was applied during recording. | [optional] [default to undefined]
|
|
23
|
+
**savedFromDeletion** | **boolean** | Indicates whether this video has been marked as saved to prevent automatic deletion. True means the video is protected from storage cleanup operations. | [default to undefined]
|
|
24
|
+
**updatedAt** | **string** | ISO 8601 timestamp indicating when this video record was last modified. | [default to undefined]
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { V1Video } from '@ourskyai/node_platform-api';
|
|
30
|
+
|
|
31
|
+
const instance: V1Video = {
|
|
32
|
+
binning,
|
|
33
|
+
cameraId,
|
|
34
|
+
captureEndedAt,
|
|
35
|
+
captureStartedAt,
|
|
36
|
+
codec,
|
|
37
|
+
containerFormat,
|
|
38
|
+
createdAt,
|
|
39
|
+
exposureCount,
|
|
40
|
+
exposureSeconds,
|
|
41
|
+
fileSizeMb,
|
|
42
|
+
frameSeconds,
|
|
43
|
+
gain,
|
|
44
|
+
id,
|
|
45
|
+
offset,
|
|
46
|
+
savedFromDeletion,
|
|
47
|
+
updatedAt,
|
|
48
|
+
};
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
[[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/V1Videos.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1Videos
|
|
2
|
+
|
|
3
|
+
Container object holding a paginated list of recorded videos. Use the before parameter with the last video\'s createdAt timestamp to retrieve the next page of results.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**videos** | [**Array<V1Video>**](V1Video.md) | Array of video metadata objects sorted by creation time in descending order (newest first). May be empty if no videos match the query criteria. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1Videos } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1Videos = {
|
|
17
|
+
videos,
|
|
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
|
+
# V1WeatherStationStatus
|
|
2
|
+
|
|
3
|
+
Status information for the local weather monitoring station. The weather station provides environmental data used for safety decisions and observation planning.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**connected** | **boolean** | Indicates whether the weather station is currently connected and reporting data. A false value means weather data is unavailable and safety decisions may be affected. When disconnected, the safety system may prevent roof operations as a precaution. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1WeatherStationStatus } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1WeatherStationStatus = {
|
|
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,39 @@
|
|
|
1
|
+
# V2CaptureImageRequest
|
|
2
|
+
|
|
3
|
+
Request object containing all parameters needed to capture a single image. Includes exposure settings, sensor configuration, and optional region of interest for sub-frame capture.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**binning** | **number** | Pixel binning factor that combines adjacent pixels to increase sensitivity at the cost of resolution. A value of 1 means no binning, 2 combines 2x2 pixels, etc. | [default to undefined]
|
|
10
|
+
**cameraId** | **string** | Unique identifier of the camera to use for capture. If omitted, the system will use the default or primary camera. Obtain valid camera IDs from the camera statuses endpoint. | [optional] [default to undefined]
|
|
11
|
+
**exposure** | **number** | Exposure duration in seconds. Longer exposures collect more light but increase the risk of star trailing without tracking. Typical values range from 0.001 seconds for planetary imaging to 300 seconds or more for deep sky objects. | [default to undefined]
|
|
12
|
+
**gain** | **number** | Sensor gain setting that controls signal amplification. Higher values increase sensitivity but also increase noise. The valid range depends on the specific camera model. | [default to undefined]
|
|
13
|
+
**gainMode** | **number** | Gain mode selector for cameras that support multiple gain modes such as high conversion gain (HCG) or dual gain modes. A value of 1 typically represents the default mode. | [default to 1]
|
|
14
|
+
**offset** | **number** | Sensor offset or black level setting that adjusts the baseline signal level. Used to prevent clipping of faint signals near the noise floor. The valid range depends on the camera model. | [default to undefined]
|
|
15
|
+
**roiHeight** | **number** | Height in pixels of the region of interest. When combined with roiStartY, defines the vertical extent of the sub-frame to capture. | [optional] [default to undefined]
|
|
16
|
+
**roiStartX** | **number** | Starting X coordinate in pixels for region of interest capture, measured from the left edge of the sensor. Used together with roiWidth to define a horizontal sub-region. | [optional] [default to undefined]
|
|
17
|
+
**roiStartY** | **number** | Starting Y coordinate in pixels for region of interest capture, measured from the top edge of the sensor. Used together with roiHeight to define a vertical sub-region. | [optional] [default to undefined]
|
|
18
|
+
**roiWidth** | **number** | Width in pixels of the region of interest. When combined with roiStartX, defines the horizontal extent of the sub-frame to capture. | [optional] [default to undefined]
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { V2CaptureImageRequest } from '@ourskyai/node_platform-api';
|
|
24
|
+
|
|
25
|
+
const instance: V2CaptureImageRequest = {
|
|
26
|
+
binning,
|
|
27
|
+
cameraId,
|
|
28
|
+
exposure,
|
|
29
|
+
gain,
|
|
30
|
+
gainMode,
|
|
31
|
+
offset,
|
|
32
|
+
roiHeight,
|
|
33
|
+
roiStartX,
|
|
34
|
+
roiStartY,
|
|
35
|
+
roiWidth,
|
|
36
|
+
};
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[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
|
+
# V2CycleRelaysRequest
|
|
2
|
+
|
|
3
|
+
Request parameters for power cycling one or more relays. Specify which equipment to cycle and how long to keep power off before restoring it.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**durationSeconds** | **number** | The duration in seconds to keep the relays powered off before restoring power. Typical values range from 5 to 30 seconds depending on equipment requirements. | [default to undefined]
|
|
10
|
+
**functions** | [**Array<RelayFunction>**](RelayFunction.md) | Array of relay functions to power cycle. All specified relays will be cycled simultaneously. Include only the equipment that needs to be reset. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V2CycleRelaysRequest } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V2CycleRelaysRequest = {
|
|
18
|
+
durationSeconds,
|
|
19
|
+
functions,
|
|
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,29 @@
|
|
|
1
|
+
# V2EnclosureStatus
|
|
2
|
+
|
|
3
|
+
Comprehensive status containing the state of all enclosure subsystems. This unified view includes shutter panels, dome rotator, observation window, and dome fans, providing everything needed for complete enclosure monitoring and control decisions.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**fans** | [**V1EnclosureFanStatuses**](V1EnclosureFanStatuses.md) | | [optional] [default to undefined]
|
|
10
|
+
**hvac** | [**V1EnclosureHvacStatus**](V1EnclosureHvacStatus.md) | | [optional] [default to undefined]
|
|
11
|
+
**rotator** | [**V1EnclosureRotatorStatus**](V1EnclosureRotatorStatus.md) | | [optional] [default to undefined]
|
|
12
|
+
**shutters** | [**V1EnclosureShutterStatuses**](V1EnclosureShutterStatuses.md) | | [optional] [default to undefined]
|
|
13
|
+
**window** | [**V1EnclosureWindowStatus**](V1EnclosureWindowStatus.md) | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { V2EnclosureStatus } from '@ourskyai/node_platform-api';
|
|
19
|
+
|
|
20
|
+
const instance: V2EnclosureStatus = {
|
|
21
|
+
fans,
|
|
22
|
+
hvac,
|
|
23
|
+
rotator,
|
|
24
|
+
shutters,
|
|
25
|
+
window,
|
|
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,37 @@
|
|
|
1
|
+
# V2MountStatus
|
|
2
|
+
|
|
3
|
+
Enhanced mount status including detailed motor telemetry for both axes. Provides more comprehensive diagnostic information than V1MountStatus.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**altitudeDegrees** | **number** | Current altitude (elevation) angle above the horizon in degrees. Range is 0 (horizon) to 90 (zenith) degrees. | [default to undefined]
|
|
10
|
+
**azimuthDegrees** | **number** | Current azimuth angle measured clockwise from north in degrees. Range is 0 to 360 degrees where 0/360 is north, 90 is east. | [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
|
+
**decJ2000Degrees** | **number** | Current declination coordinate of the telescope pointing in degrees (J2000 epoch). Range is -90 to +90 degrees. | [default to undefined]
|
|
13
|
+
**isSlewing** | **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]
|
|
14
|
+
**isTracking** | **boolean** | Indicates whether sidereal tracking is currently active. When true, the mount compensates for Earth rotation to keep objects centered. | [default to undefined]
|
|
15
|
+
**motorA** | [**V1MotorStatus**](V1MotorStatus.md) | | [default to undefined]
|
|
16
|
+
**motorB** | [**V1MotorStatus**](V1MotorStatus.md) | | [default to undefined]
|
|
17
|
+
**raJ2000Degrees** | **number** | Current right ascension coordinate of the telescope pointing in degrees (J2000 epoch). Range is 0 to 360 degrees. | [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { V2MountStatus } from '@ourskyai/node_platform-api';
|
|
23
|
+
|
|
24
|
+
const instance: V2MountStatus = {
|
|
25
|
+
altitudeDegrees,
|
|
26
|
+
azimuthDegrees,
|
|
27
|
+
connected,
|
|
28
|
+
decJ2000Degrees,
|
|
29
|
+
isSlewing,
|
|
30
|
+
isTracking,
|
|
31
|
+
motorA,
|
|
32
|
+
motorB,
|
|
33
|
+
raJ2000Degrees,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[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
|
+
# V2RelayStatus
|
|
2
|
+
|
|
3
|
+
Status information for a single power relay including its connected equipment function and current power state.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**connected** | **boolean** | Indicates whether the relay controller is currently connected and responding. A false value means this relay cannot be switched or its state monitored reliably. | [default to undefined]
|
|
10
|
+
**_function** | [**RelayFunction**](RelayFunction.md) | | [default to undefined]
|
|
11
|
+
**isOn** | **boolean** | The current power state of the relay. True indicates the relay is closed and power is flowing to the equipment. False indicates the relay is open and equipment is unpowered. | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V2RelayStatus } from '@ourskyai/node_platform-api';
|
|
17
|
+
|
|
18
|
+
const instance: V2RelayStatus = {
|
|
19
|
+
connected,
|
|
20
|
+
_function,
|
|
21
|
+
isOn,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V2RelayStatuses
|
|
2
|
+
|
|
3
|
+
Container object holding the status information for all power relays in the observatory system. This provides a complete view of equipment power states for monitoring and control decisions.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**statuses** | [**Array<V2RelayStatus>**](V2RelayStatus.md) | Array containing the status of each power relay in the system. The number of relays varies by observatory configuration. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V2RelayStatuses } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V2RelayStatuses = {
|
|
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,33 @@
|
|
|
1
|
+
# V2SystemEvent
|
|
2
|
+
|
|
3
|
+
Represents a single system event with its timestamp, type, and event-specific data payload.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**data** | [**SystemEventData**](SystemEventData.md) | | [default to undefined]
|
|
10
|
+
**id** | **string** | | [default to undefined]
|
|
11
|
+
**occurredAt** | **string** | ISO 8601 timestamp indicating when this event occurred. Used for ordering events and correlation with other logs. | [default to undefined]
|
|
12
|
+
**operation** | [**SystemEventOperation**](SystemEventOperation.md) | | [optional] [default to undefined]
|
|
13
|
+
**severity** | [**SystemEventSeverity**](SystemEventSeverity.md) | | [default to undefined]
|
|
14
|
+
**traceId** | **string** | | [default to undefined]
|
|
15
|
+
**type** | [**V2SystemEventType**](V2SystemEventType.md) | | [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { V2SystemEvent } from '@ourskyai/node_platform-api';
|
|
21
|
+
|
|
22
|
+
const instance: V2SystemEvent = {
|
|
23
|
+
data,
|
|
24
|
+
id,
|
|
25
|
+
occurredAt,
|
|
26
|
+
operation,
|
|
27
|
+
severity,
|
|
28
|
+
traceId,
|
|
29
|
+
type,
|
|
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,205 @@
|
|
|
1
|
+
# V2SystemEventType
|
|
2
|
+
|
|
3
|
+
Enumeration of all possible system event types that can occur during telescope operation. Use these values to filter events when querying the event log.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `CANCEL_ALL_TASKS` (value: `'CANCEL_ALL_TASKS'`)
|
|
8
|
+
|
|
9
|
+
* `CANCEL_TASK` (value: `'CANCEL_TASK'`)
|
|
10
|
+
|
|
11
|
+
* `CAPTURE_IMAGE` (value: `'CAPTURE_IMAGE'`)
|
|
12
|
+
|
|
13
|
+
* `CAPTURE_IMAGE_AND_PLATE_SOLVE` (value: `'CAPTURE_IMAGE_AND_PLATE_SOLVE'`)
|
|
14
|
+
|
|
15
|
+
* `CAPTURE_IMAGES_CONTINUOUSLY` (value: `'CAPTURE_IMAGES_CONTINUOUSLY'`)
|
|
16
|
+
|
|
17
|
+
* `CALIBRATE_ENCLOSURE_ROTATOR` (value: `'CALIBRATE_ENCLOSURE_ROTATOR'`)
|
|
18
|
+
|
|
19
|
+
* `CALIBRATE_ENCLOSURE_WINDOW` (value: `'CALIBRATE_ENCLOSURE_WINDOW'`)
|
|
20
|
+
|
|
21
|
+
* `CLOSE_ENCLOSURE_SHUTTERS` (value: `'CLOSE_ENCLOSURE_SHUTTERS'`)
|
|
22
|
+
|
|
23
|
+
* `CLOSE_OPTICAL_TUBE_COVER` (value: `'CLOSE_OPTICAL_TUBE_COVER'`)
|
|
24
|
+
|
|
25
|
+
* `CREATE_ELEVATION_MASK` (value: `'CREATE_ELEVATION_MASK'`)
|
|
26
|
+
|
|
27
|
+
* `CREATE_MOUNT_MODEL` (value: `'CREATE_MOUNT_MODEL'`)
|
|
28
|
+
|
|
29
|
+
* `CYCLE_RELAYS` (value: `'CYCLE_RELAYS'`)
|
|
30
|
+
|
|
31
|
+
* `DELETE_IMAGE` (value: `'DELETE_IMAGE'`)
|
|
32
|
+
|
|
33
|
+
* `DIAGNOSE_SYSTEM` (value: `'DIAGNOSE_SYSTEM'`)
|
|
34
|
+
|
|
35
|
+
* `DISABLE_DEROTATION_COMPENSATION` (value: `'DISABLE_DEROTATION_COMPENSATION'`)
|
|
36
|
+
|
|
37
|
+
* `DISABLE_MOUNT_MOTORS` (value: `'DISABLE_MOUNT_MOTORS'`)
|
|
38
|
+
|
|
39
|
+
* `DISABLE_MOUNT_TRACKING` (value: `'DISABLE_MOUNT_TRACKING'`)
|
|
40
|
+
|
|
41
|
+
* `DISABLE_SLEW_DEMO` (value: `'DISABLE_SLEW_DEMO'`)
|
|
42
|
+
|
|
43
|
+
* `DISENGAGE_ADHOC_DEPLOYMENT` (value: `'DISENGAGE_ADHOC_DEPLOYMENT'`)
|
|
44
|
+
|
|
45
|
+
* `ENABLE_ASSISTED_OPERATION` (value: `'ENABLE_ASSISTED_OPERATION'`)
|
|
46
|
+
|
|
47
|
+
* `ENABLE_AUTONOMOUS_OPERATION` (value: `'ENABLE_AUTONOMOUS_OPERATION'`)
|
|
48
|
+
|
|
49
|
+
* `ENABLE_DEROTATION_COMPENSATION` (value: `'ENABLE_DEROTATION_COMPENSATION'`)
|
|
50
|
+
|
|
51
|
+
* `ENABLE_MANUAL_OPERATION` (value: `'ENABLE_MANUAL_OPERATION'`)
|
|
52
|
+
|
|
53
|
+
* `ENABLE_MOUNT_MOTORS` (value: `'ENABLE_MOUNT_MOTORS'`)
|
|
54
|
+
|
|
55
|
+
* `ENABLE_MOUNT_TRACKING` (value: `'ENABLE_MOUNT_TRACKING'`)
|
|
56
|
+
|
|
57
|
+
* `ENABLE_SLEW_DEMO` (value: `'ENABLE_SLEW_DEMO'`)
|
|
58
|
+
|
|
59
|
+
* `ENGAGE_ADHOC_DEPLOYMENT` (value: `'ENGAGE_ADHOC_DEPLOYMENT'`)
|
|
60
|
+
|
|
61
|
+
* `FIND_FOCUSER_LIMITS` (value: `'FIND_FOCUSER_LIMITS'`)
|
|
62
|
+
|
|
63
|
+
* `GO_TO_FILTER_WHEEL_POSITION` (value: `'GO_TO_FILTER_WHEEL_POSITION'`)
|
|
64
|
+
|
|
65
|
+
* `GO_TO_FOCUSER_POSITION` (value: `'GO_TO_FOCUSER_POSITION'`)
|
|
66
|
+
|
|
67
|
+
* `GO_TO_OPTICAL_TUBE_M3_PORT` (value: `'GO_TO_OPTICAL_TUBE_M3_PORT'`)
|
|
68
|
+
|
|
69
|
+
* `GO_TO_MOUNT_COORDINATES` (value: `'GO_TO_MOUNT_COORDINATES'`)
|
|
70
|
+
|
|
71
|
+
* `GO_TO_ROTATOR_POSITION` (value: `'GO_TO_ROTATOR_POSITION'`)
|
|
72
|
+
|
|
73
|
+
* `HALT_ENCLOSURE_ROTATOR` (value: `'HALT_ENCLOSURE_ROTATOR'`)
|
|
74
|
+
|
|
75
|
+
* `HALT_ENCLOSURE_SHUTTERS` (value: `'HALT_ENCLOSURE_SHUTTERS'`)
|
|
76
|
+
|
|
77
|
+
* `HALT_ENCLOSURE_WINDOW` (value: `'HALT_ENCLOSURE_WINDOW'`)
|
|
78
|
+
|
|
79
|
+
* `HALT_FOCUSER` (value: `'HALT_FOCUSER'`)
|
|
80
|
+
|
|
81
|
+
* `HALT_OPTICAL_TUBE_M3` (value: `'HALT_OPTICAL_TUBE_M3'`)
|
|
82
|
+
|
|
83
|
+
* `HALT_MOUNT` (value: `'HALT_MOUNT'`)
|
|
84
|
+
|
|
85
|
+
* `HALT_OPTICAL_TUBE_COVER` (value: `'HALT_OPTICAL_TUBE_COVER'`)
|
|
86
|
+
|
|
87
|
+
* `HALT_ROTATOR` (value: `'HALT_ROTATOR'`)
|
|
88
|
+
|
|
89
|
+
* `HOME_ENCLOSURE_SHUTTERS` (value: `'HOME_ENCLOSURE_SHUTTERS'`)
|
|
90
|
+
|
|
91
|
+
* `HOME_MOUNT` (value: `'HOME_MOUNT'`)
|
|
92
|
+
|
|
93
|
+
* `JOG_ENCLOSURE_ROTATOR` (value: `'JOG_ENCLOSURE_ROTATOR'`)
|
|
94
|
+
|
|
95
|
+
* `JOG_ENCLOSURE_SHUTTERS` (value: `'JOG_ENCLOSURE_SHUTTERS'`)
|
|
96
|
+
|
|
97
|
+
* `JOG_ENCLOSURE_WINDOW` (value: `'JOG_ENCLOSURE_WINDOW'`)
|
|
98
|
+
|
|
99
|
+
* `JOG_MOUNT` (value: `'JOG_MOUNT'`)
|
|
100
|
+
|
|
101
|
+
* `MOUNT_FOLLOW_TLE` (value: `'MOUNT_FOLLOW_TLE'`)
|
|
102
|
+
|
|
103
|
+
* `OPEN_ENCLOSURE_SHUTTERS` (value: `'OPEN_ENCLOSURE_SHUTTERS'`)
|
|
104
|
+
|
|
105
|
+
* `OPEN_OPTICAL_TUBE_COVER` (value: `'OPEN_OPTICAL_TUBE_COVER'`)
|
|
106
|
+
|
|
107
|
+
* `PARK_MOUNT` (value: `'PARK_MOUNT'`)
|
|
108
|
+
|
|
109
|
+
* `PREPARE_SYSTEM_FOR_OPERATION` (value: `'PREPARE_SYSTEM_FOR_OPERATION'`)
|
|
110
|
+
|
|
111
|
+
* `PREPARE_SYSTEM_FOR_TRAVEL` (value: `'PREPARE_SYSTEM_FOR_TRAVEL'`)
|
|
112
|
+
|
|
113
|
+
* `REBOOT_SYSTEM` (value: `'REBOOT_SYSTEM'`)
|
|
114
|
+
|
|
115
|
+
* `RECORD_VIDEO` (value: `'RECORD_VIDEO'`)
|
|
116
|
+
|
|
117
|
+
* `RESET_ENCLOSURE_SHUTTER_WATCHDOG` (value: `'RESET_ENCLOSURE_SHUTTER_WATCHDOG'`)
|
|
118
|
+
|
|
119
|
+
* `RESET_SYSTEM_SETTINGS_TO_DEFAULT` (value: `'RESET_SYSTEM_SETTINGS_TO_DEFAULT'`)
|
|
120
|
+
|
|
121
|
+
* `RUN_AUTOFOCUS` (value: `'RUN_AUTOFOCUS'`)
|
|
122
|
+
|
|
123
|
+
* `SAVE_IMAGE` (value: `'SAVE_IMAGE'`)
|
|
124
|
+
|
|
125
|
+
* `SEND_FLARE` (value: `'SEND_FLARE'`)
|
|
126
|
+
|
|
127
|
+
* `SET_MOUNT_PARK_POSITION` (value: `'SET_MOUNT_PARK_POSITION'`)
|
|
128
|
+
|
|
129
|
+
* `SET_MOUNT_PARK_POSITION_HERE` (value: `'SET_MOUNT_PARK_POSITION_HERE'`)
|
|
130
|
+
|
|
131
|
+
* `SET_OPTICAL_TUBE_HEATER_POWER` (value: `'SET_OPTICAL_TUBE_HEATER_POWER'`)
|
|
132
|
+
|
|
133
|
+
* `STOP_CAPTURING_IMAGES_CONTINUOUSLY` (value: `'STOP_CAPTURING_IMAGES_CONTINUOUSLY'`)
|
|
134
|
+
|
|
135
|
+
* `STOP_RECORDING_VIDEO` (value: `'STOP_RECORDING_VIDEO'`)
|
|
136
|
+
|
|
137
|
+
* `SYNC_ENCLOSURE_ROTATOR_WITH_MOUNT` (value: `'SYNC_ENCLOSURE_ROTATOR_WITH_MOUNT'`)
|
|
138
|
+
|
|
139
|
+
* `SYNC_ENCLOSURE_WINDOW_WITH_MOUNT` (value: `'SYNC_ENCLOSURE_WINDOW_WITH_MOUNT'`)
|
|
140
|
+
|
|
141
|
+
* `TURN_OFF_OPTICAL_TUBE_FANS` (value: `'TURN_OFF_OPTICAL_TUBE_FANS'`)
|
|
142
|
+
|
|
143
|
+
* `TURN_OFF_RELAY` (value: `'TURN_OFF_RELAY'`)
|
|
144
|
+
|
|
145
|
+
* `TURN_ON_OPTICAL_TUBE_FANS` (value: `'TURN_ON_OPTICAL_TUBE_FANS'`)
|
|
146
|
+
|
|
147
|
+
* `TURN_ON_ENCLOSURE_HVAC` (value: `'TURN_ON_ENCLOSURE_HVAC'`)
|
|
148
|
+
|
|
149
|
+
* `TURN_OFF_ENCLOSURE_HVAC` (value: `'TURN_OFF_ENCLOSURE_HVAC'`)
|
|
150
|
+
|
|
151
|
+
* `SET_ENCLOSURE_HVAC_MODE` (value: `'SET_ENCLOSURE_HVAC_MODE'`)
|
|
152
|
+
|
|
153
|
+
* `SET_ENCLOSURE_HVAC_FAN_SPEED` (value: `'SET_ENCLOSURE_HVAC_FAN_SPEED'`)
|
|
154
|
+
|
|
155
|
+
* `SET_ENCLOSURE_HVAC_TARGET_TEMPERATURE` (value: `'SET_ENCLOSURE_HVAC_TARGET_TEMPERATURE'`)
|
|
156
|
+
|
|
157
|
+
* `TURN_ON_RELAY` (value: `'TURN_ON_RELAY'`)
|
|
158
|
+
|
|
159
|
+
* `UPDATE_FILTER` (value: `'UPDATE_FILTER'`)
|
|
160
|
+
|
|
161
|
+
* `UPDATE_SYSTEM_SETTINGS` (value: `'UPDATE_SYSTEM_SETTINGS'`)
|
|
162
|
+
|
|
163
|
+
* `ENCLOSURE_SHUTTER_WATCHDOG_TRIGGERED` (value: `'ENCLOSURE_SHUTTER_WATCHDOG_TRIGGERED'`)
|
|
164
|
+
|
|
165
|
+
* `GPS_DATA_UPDATED` (value: `'GPS_DATA_UPDATED'`)
|
|
166
|
+
|
|
167
|
+
* `WAVEFRONT_SENSOR_DATA_UPDATED` (value: `'WAVEFRONT_SENSOR_DATA_UPDATED'`)
|
|
168
|
+
|
|
169
|
+
* `MOTOR_FAULT_DETECTED` (value: `'MOTOR_FAULT_DETECTED'`)
|
|
170
|
+
|
|
171
|
+
* `MOTOR_FAULT_CLEARED` (value: `'MOTOR_FAULT_CLEARED'`)
|
|
172
|
+
|
|
173
|
+
* `SYSTEM_STATUS_CHANGED` (value: `'SYSTEM_STATUS_CHANGED'`)
|
|
174
|
+
|
|
175
|
+
* `ENCLOSURE_SHUTTER_STATUSES_CHANGED` (value: `'ENCLOSURE_SHUTTER_STATUSES_CHANGED'`)
|
|
176
|
+
|
|
177
|
+
* `KERNEL_LOG_ENTRY_DETECTED` (value: `'KERNEL_LOG_ENTRY_DETECTED'`)
|
|
178
|
+
|
|
179
|
+
* `ASTRO_IMAGE_CAPTURED` (value: `'ASTRO_IMAGE_CAPTURED'`)
|
|
180
|
+
|
|
181
|
+
* `STACKED_ASTRO_IMAGE_GENERATED` (value: `'STACKED_ASTRO_IMAGE_GENERATED'`)
|
|
182
|
+
|
|
183
|
+
* `ALL_SKY_IMAGE_CAPTURED` (value: `'ALL_SKY_IMAGE_CAPTURED'`)
|
|
184
|
+
|
|
185
|
+
* `ALL_SKY_KEOGRAM_GENERATED` (value: `'ALL_SKY_KEOGRAM_GENERATED'`)
|
|
186
|
+
|
|
187
|
+
* `ALL_SKY_TIMELAPSE_GENERATED` (value: `'ALL_SKY_TIMELAPSE_GENERATED'`)
|
|
188
|
+
|
|
189
|
+
* `GENERIC_EVENT` (value: `'GENERIC_EVENT'`)
|
|
190
|
+
|
|
191
|
+
* `MOUNT_MODEL_POINT_ADDED` (value: `'MOUNT_MODEL_POINT_ADDED'`)
|
|
192
|
+
|
|
193
|
+
* `ELEVATION_MASK_POINT_ADDED` (value: `'ELEVATION_MASK_POINT_ADDED'`)
|
|
194
|
+
|
|
195
|
+
* `AUTOFOCUS_POINT_MEASURED` (value: `'AUTOFOCUS_POINT_MEASURED'`)
|
|
196
|
+
|
|
197
|
+
* `PERFORM_PLATFORM_INSTRUCTION` (value: `'PERFORM_PLATFORM_INSTRUCTION'`)
|
|
198
|
+
|
|
199
|
+
* `PERFORM_RELEASE_UPDATE` (value: `'PERFORM_RELEASE_UPDATE'`)
|
|
200
|
+
|
|
201
|
+
* `HOME_ROTATOR` (value: `'HOME_ROTATOR'`)
|
|
202
|
+
|
|
203
|
+
* `HOME_FOCUSER` (value: `'HOME_FOCUSER'`)
|
|
204
|
+
|
|
205
|
+
[[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
|
+
# V2SystemEvents
|
|
2
|
+
|
|
3
|
+
Container for a list of system events returned from an event query. Events are ordered by timestamp from most recent to oldest.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**systemEvents** | [**Array<V2SystemEvent>**](V2SystemEvent.md) | Array of system event objects matching the query criteria. May be empty if no events match the filters. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V2SystemEvents } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V2SystemEvents = {
|
|
17
|
+
systemEvents,
|
|
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
|
+
# V2TurnOffRelayRequest
|
|
2
|
+
|
|
3
|
+
Request parameters for turning off a specific power relay. Specify which equipment function to power off.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**_function** | [**RelayFunction**](RelayFunction.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V2TurnOffRelayRequest } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V2TurnOffRelayRequest = {
|
|
17
|
+
_function,
|
|
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
|
+
# V2TurnOnRelayRequest
|
|
2
|
+
|
|
3
|
+
Request parameters for turning on a specific power relay. Specify which equipment function to power on.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**_function** | [**RelayFunction**](RelayFunction.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V2TurnOnRelayRequest } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V2TurnOnRelayRequest = {
|
|
17
|
+
_function,
|
|
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,57 @@
|
|
|
1
|
+
# WavefrontSensorDataUpdated
|
|
2
|
+
|
|
3
|
+
Pushed on every WFS frame while the loop is active. Contains two complementary representations: (1) a dense slope grid in row-major order [gridRows x gridCols] where cells with no detected dot have slopeX/Y = 0 and valid = false, and (2) sparse dot arrays with one entry per successfully tracked dot.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**dotCalibration** | [**Array<Point2D>**](Point2D.md) | Reference positions from calibration (pixels), one per tracked dot | [default to undefined]
|
|
10
|
+
**dotDisplacement** | **Array<number>** | Euclidean displacement per tracked dot (pixels) | [default to undefined]
|
|
11
|
+
**dotMeasured** | [**Array<Point2D>**](Point2D.md) | Measured positions this frame (pixels), one per tracked dot | [default to undefined]
|
|
12
|
+
**effectivePupilRadiusMm** | **number** | Effective pupil radius in mm | [optional] [default to undefined]
|
|
13
|
+
**focalLengthMm** | **number** | Lenslet array focal length in mm | [default to undefined]
|
|
14
|
+
**gridCols** | **number** | Number of lenslet grid columns | [default to undefined]
|
|
15
|
+
**gridRows** | **number** | Number of lenslet grid rows | [default to undefined]
|
|
16
|
+
**lensletPitchMm** | **number** | Lenslet pitch in mm (for client-side unit conversions) | [default to undefined]
|
|
17
|
+
**pixelSizeMm** | **number** | Sensor pixel size in mm | [default to undefined]
|
|
18
|
+
**pupilCenterX** | **number** | X coordinate of the detected pupil center (grid units) | [optional] [default to undefined]
|
|
19
|
+
**pupilCenterY** | **number** | Y coordinate of the detected pupil center (grid units) | [optional] [default to undefined]
|
|
20
|
+
**pvWavefrontErrorUm** | **number** | Peak-to-valley wavefront error in micrometers | [optional] [default to undefined]
|
|
21
|
+
**radiusOfCurvatureM** | **number** | Radius of curvature in meters | [optional] [default to undefined]
|
|
22
|
+
**rmsWavefrontErrorUm** | **number** | RMS wavefront error in micrometers | [optional] [default to undefined]
|
|
23
|
+
**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]
|
|
24
|
+
**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]
|
|
25
|
+
**timestampMs** | **number** | | [default to undefined]
|
|
26
|
+
**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]
|
|
27
|
+
**zernikeCoefficients** | **Array<number>** | Zernike coefficients (empty when not computed) | [default to undefined]
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
import { WavefrontSensorDataUpdated } from '@ourskyai/node_platform-api';
|
|
33
|
+
|
|
34
|
+
const instance: WavefrontSensorDataUpdated = {
|
|
35
|
+
dotCalibration,
|
|
36
|
+
dotDisplacement,
|
|
37
|
+
dotMeasured,
|
|
38
|
+
effectivePupilRadiusMm,
|
|
39
|
+
focalLengthMm,
|
|
40
|
+
gridCols,
|
|
41
|
+
gridRows,
|
|
42
|
+
lensletPitchMm,
|
|
43
|
+
pixelSizeMm,
|
|
44
|
+
pupilCenterX,
|
|
45
|
+
pupilCenterY,
|
|
46
|
+
pvWavefrontErrorUm,
|
|
47
|
+
radiusOfCurvatureM,
|
|
48
|
+
rmsWavefrontErrorUm,
|
|
49
|
+
slopeX,
|
|
50
|
+
slopeY,
|
|
51
|
+
timestampMs,
|
|
52
|
+
valid,
|
|
53
|
+
zernikeCoefficients,
|
|
54
|
+
};
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|