@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,23 @@
|
|
|
1
|
+
# V1OpticalTubeHeaterGroupStatus
|
|
2
|
+
|
|
3
|
+
Heater statuses for a specific optical tube.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique identifier of the optical tube within the system. Null when the status source does not provide component IDs. | [optional] [default to undefined]
|
|
10
|
+
**statuses** | [**Array<V1OpticalTubeHeaterStatus>**](V1OpticalTubeHeaterStatus.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1OpticalTubeHeaterGroupStatus } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1OpticalTubeHeaterGroupStatus = {
|
|
18
|
+
id,
|
|
19
|
+
statuses,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1OpticalTubeHeaterGroupStatuses
|
|
2
|
+
|
|
3
|
+
Collection of heater statuses grouped by optical tube.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**statuses** | [**Array<V1OpticalTubeHeaterGroupStatus>**](V1OpticalTubeHeaterGroupStatus.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpticalTubeHeaterGroupStatuses } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpticalTubeHeaterGroupStatuses = {
|
|
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,13 @@
|
|
|
1
|
+
# V1OpticalTubeHeaterRole
|
|
2
|
+
|
|
3
|
+
Identifies the mirror associated with a specific dew heater. M1 is the primary mirror, M2 is the secondary mirror, and M3 is the tertiary mirror. Each heater is designed to prevent dew formation on its associated optical surface.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `M1` (value: `'M1'`)
|
|
8
|
+
|
|
9
|
+
* `M2` (value: `'M2'`)
|
|
10
|
+
|
|
11
|
+
* `M3` (value: `'M3'`)
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# V1OpticalTubeHeaterStatus
|
|
2
|
+
|
|
3
|
+
Status information for a single dew heater in the optical tube assembly including connection state and current power level.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**connected** | **boolean** | Indicates whether communication with this heater controller is active. When false, the heater cannot be controlled and its state may be unknown. | [default to undefined]
|
|
10
|
+
**power** | **number** | Current heater power level as a percentage from 0 (off) to 100 (full power). Higher values provide more heat to prevent dew formation. | [default to undefined]
|
|
11
|
+
**role** | [**V1OpticalTubeHeaterRole**](V1OpticalTubeHeaterRole.md) | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1OpticalTubeHeaterStatus } from '@ourskyai/node_platform-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1OpticalTubeHeaterStatus = {
|
|
19
|
+
connected,
|
|
20
|
+
power,
|
|
21
|
+
role,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1OpticalTubeM3SelectorRequest
|
|
2
|
+
|
|
3
|
+
Optional optical tube selector. If omitted, the default optical tube is used.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**opticalTubeId** | **string** | Unique identifier of the optical tube to command. Obtain valid optical tube IDs from the optical tube statuses endpoint. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpticalTubeM3SelectorRequest } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpticalTubeM3SelectorRequest = {
|
|
17
|
+
opticalTubeId,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# V1OpticalTubeM3Status
|
|
2
|
+
|
|
3
|
+
Current status of the M3 tertiary mirror port selector including connection state and active port position.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**connected** | **boolean** | Indicates whether communication with the M3 mechanism is active. When false, the M3 mirror cannot be controlled and port position may be unknown. | [default to undefined]
|
|
10
|
+
**id** | **string** | Unique identifier of the optical tube within the system. | [optional] [default to undefined]
|
|
11
|
+
**port** | **number** | Current port position indicating which instrument port the M3 mirror is directing light to. Use this to verify the active instrument before imaging. | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1OpticalTubeM3Status } from '@ourskyai/node_platform-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1OpticalTubeM3Status = {
|
|
19
|
+
connected,
|
|
20
|
+
id,
|
|
21
|
+
port,
|
|
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
|
+
# V1OpticalTubeM3Statuses
|
|
2
|
+
|
|
3
|
+
Collection of M3 statuses, one per optical tube.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**statuses** | [**Array<V1OpticalTubeM3Status>**](V1OpticalTubeM3Status.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpticalTubeM3Statuses } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpticalTubeM3Statuses = {
|
|
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,31 @@
|
|
|
1
|
+
# V1OpticalTubeStatus
|
|
2
|
+
|
|
3
|
+
Comprehensive status of all optical tube assembly environmental control systems including cooling fans, protective cover, and dew heaters.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**cover** | [**V1OpticalTubeCoverStatus**](V1OpticalTubeCoverStatus.md) | | [optional] [default to undefined]
|
|
10
|
+
**fans** | [**V1OpticalTubeFanGroupStatus**](V1OpticalTubeFanGroupStatus.md) | | [optional] [default to undefined]
|
|
11
|
+
**heaters** | [**V1OpticalTubeHeaterGroupStatus**](V1OpticalTubeHeaterGroupStatus.md) | | [optional] [default to undefined]
|
|
12
|
+
**id** | **string** | Unique identifier of the optical tube within the system. | [optional] [default to undefined]
|
|
13
|
+
**m3** | [**V1OpticalTubeM3Status**](V1OpticalTubeM3Status.md) | | [optional] [default to undefined]
|
|
14
|
+
**temperatureSensors** | [**V1OpticalTubeTemperatureSensorStatuses**](V1OpticalTubeTemperatureSensorStatuses.md) | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { V1OpticalTubeStatus } from '@ourskyai/node_platform-api';
|
|
20
|
+
|
|
21
|
+
const instance: V1OpticalTubeStatus = {
|
|
22
|
+
cover,
|
|
23
|
+
fans,
|
|
24
|
+
heaters,
|
|
25
|
+
id,
|
|
26
|
+
m3,
|
|
27
|
+
temperatureSensors,
|
|
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
|
+
# V1OpticalTubeStatuses
|
|
2
|
+
|
|
3
|
+
Collection of comprehensive optical tube statuses, one per optical tube.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**statuses** | [**Array<V1OpticalTubeStatus>**](V1OpticalTubeStatus.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpticalTubeStatuses } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpticalTubeStatuses = {
|
|
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,15 @@
|
|
|
1
|
+
# V1OpticalTubeTemperatureSensorRole
|
|
2
|
+
|
|
3
|
+
Identifies the temperature sensor location within the optical tube assembly.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `M1` (value: `'M1'`)
|
|
8
|
+
|
|
9
|
+
* `M2` (value: `'M2'`)
|
|
10
|
+
|
|
11
|
+
* `M3` (value: `'M3'`)
|
|
12
|
+
|
|
13
|
+
* `AMBIENT` (value: `'AMBIENT'`)
|
|
14
|
+
|
|
15
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# V1OpticalTubeTemperatureSensorStatus
|
|
2
|
+
|
|
3
|
+
Temperature reading from a single sensor in the optical tube assembly.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**role** | [**V1OpticalTubeTemperatureSensorRole**](V1OpticalTubeTemperatureSensorRole.md) | | [default to undefined]
|
|
10
|
+
**temperatureCelsius** | **number** | Temperature reading in degrees Celsius. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1OpticalTubeTemperatureSensorStatus } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1OpticalTubeTemperatureSensorStatus = {
|
|
18
|
+
role,
|
|
19
|
+
temperatureCelsius,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1OpticalTubeTemperatureSensorStatuses
|
|
2
|
+
|
|
3
|
+
Collection of temperature readings from sensors in the optical tube assembly.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**statuses** | [**Array<V1OpticalTubeTemperatureSensorStatus>**](V1OpticalTubeTemperatureSensorStatus.md) | Array of temperature readings, one for each sensor in the optical tube assembly. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpticalTubeTemperatureSensorStatuses } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpticalTubeTemperatureSensorStatuses = {
|
|
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,27 @@
|
|
|
1
|
+
# V1PeerStatusChangedRequest
|
|
2
|
+
|
|
3
|
+
Notify that a peer has changed status
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**cameraId** | **string** | Optional camera identifier for multi-camera nodes | [optional] [default to undefined]
|
|
10
|
+
**meta** | **{ [key: string]: string; }** | Optional metadata map | [optional] [default to undefined]
|
|
11
|
+
**peerId** | **string** | the peer\'s ID | [default to undefined]
|
|
12
|
+
**roles** | [**Array<PeerRole>**](PeerRole.md) | List of roles for the peer | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1PeerStatusChangedRequest } from '@ourskyai/node_platform-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1PeerStatusChangedRequest = {
|
|
20
|
+
cameraId,
|
|
21
|
+
meta,
|
|
22
|
+
peerId,
|
|
23
|
+
roles,
|
|
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,25 @@
|
|
|
1
|
+
# V1PtpDataSet
|
|
2
|
+
|
|
3
|
+
PTP current data set from CURRENT_DATA_SET
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**meanPathDelay** | **number** | Mean path delay in nanoseconds | [optional] [default to undefined]
|
|
10
|
+
**offsetFromMaster** | **number** | Current offset from master clock in nanoseconds | [optional] [default to undefined]
|
|
11
|
+
**stepsRemoved** | **number** | Number of communication paths between local clock and grandmaster | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1PtpDataSet } from '@ourskyai/node_platform-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1PtpDataSet = {
|
|
19
|
+
meanPathDelay,
|
|
20
|
+
offsetFromMaster,
|
|
21
|
+
stepsRemoved,
|
|
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,27 @@
|
|
|
1
|
+
# V1PtpPortProperties
|
|
2
|
+
|
|
3
|
+
PTP port properties from PORT_PROPERTIES_NP
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**_interface** | **string** | Network interface name | [optional] [default to undefined]
|
|
10
|
+
**portIdentity** | **string** | Identity of the PTP port | [optional] [default to undefined]
|
|
11
|
+
**portState** | **string** | Current state of the port (e.g., SLAVE, MASTER, LISTENING) | [optional] [default to undefined]
|
|
12
|
+
**timestamping** | **string** | Timestamping mode (e.g., HARDWARE, SOFTWARE) | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1PtpPortProperties } from '@ourskyai/node_platform-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1PtpPortProperties = {
|
|
20
|
+
_interface,
|
|
21
|
+
portIdentity,
|
|
22
|
+
portState,
|
|
23
|
+
timestamping,
|
|
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,24 @@
|
|
|
1
|
+
# V1PtpStatus
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**connected** | **boolean** | Whether a PTP source is connected and reachable | [default to undefined]
|
|
9
|
+
**sourceStatistics** | [**V1TimeSourceStatistics**](V1TimeSourceStatistics.md) | | [default to undefined]
|
|
10
|
+
**status** | [**V1PtpStatusDetails**](V1PtpStatusDetails.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1PtpStatus } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1PtpStatus = {
|
|
18
|
+
connected,
|
|
19
|
+
sourceStatistics,
|
|
20
|
+
status,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# V1PtpStatusDetails
|
|
2
|
+
|
|
3
|
+
Detailed PTP status information
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**dataSet** | [**V1PtpDataSet**](V1PtpDataSet.md) | | [optional] [default to undefined]
|
|
10
|
+
**portProperties** | [**V1PtpPortProperties**](V1PtpPortProperties.md) | | [optional] [default to undefined]
|
|
11
|
+
**timeStatus** | [**V1PtpTimeStatus**](V1PtpTimeStatus.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1PtpStatusDetails } from '@ourskyai/node_platform-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1PtpStatusDetails = {
|
|
19
|
+
dataSet,
|
|
20
|
+
portProperties,
|
|
21
|
+
timeStatus,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# V1PtpTimeStatus
|
|
2
|
+
|
|
3
|
+
PTP time status from TIME_STATUS_NP
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**cumulativeScaledRateOffset** | **number** | Cumulative scaled rate offset | [optional] [default to undefined]
|
|
10
|
+
**gmIdentity** | **string** | Identity of the grandmaster clock | [optional] [default to undefined]
|
|
11
|
+
**gmPresent** | **boolean** | Whether a grandmaster is present | [optional] [default to undefined]
|
|
12
|
+
**gmTimeBaseIndicator** | **number** | Grandmaster time base indicator | [optional] [default to undefined]
|
|
13
|
+
**ingressTime** | **number** | Ingress time in nanoseconds | [optional] [default to undefined]
|
|
14
|
+
**lastGmPhaseChange** | **string** | Last grandmaster phase change value | [optional] [default to undefined]
|
|
15
|
+
**masterOffset** | **number** | Offset from master clock in nanoseconds | [optional] [default to undefined]
|
|
16
|
+
**scaledLastGmPhaseChange** | **number** | Scaled last grandmaster phase change | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { V1PtpTimeStatus } from '@ourskyai/node_platform-api';
|
|
22
|
+
|
|
23
|
+
const instance: V1PtpTimeStatus = {
|
|
24
|
+
cumulativeScaledRateOffset,
|
|
25
|
+
gmIdentity,
|
|
26
|
+
gmPresent,
|
|
27
|
+
gmTimeBaseIndicator,
|
|
28
|
+
ingressTime,
|
|
29
|
+
lastGmPhaseChange,
|
|
30
|
+
masterOffset,
|
|
31
|
+
scaledLastGmPhaseChange,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1RecordVideoRequest
|
|
2
|
+
|
|
3
|
+
Request object to initiate video recording from a camera. The video will be recorded using the camera\'s current settings until explicitly stopped.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**cameraId** | **string** | Unique identifier of the camera to start recording from. The camera must be connected and not already recording. Obtain valid camera IDs from the camera statuses endpoint. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1RecordVideoRequest } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1RecordVideoRequest = {
|
|
17
|
+
cameraId,
|
|
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)
|
package/docs/V1Relay.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# V1Relay
|
|
2
|
+
|
|
3
|
+
Represents the current state of a single relay channel (deprecated, see V2RelayStatus). Contains the channel identifier and its power state.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**channel** | [**RelayChannel**](RelayChannel.md) | | [default to undefined]
|
|
10
|
+
**relayOn** | **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]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1Relay } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1Relay = {
|
|
18
|
+
channel,
|
|
19
|
+
relayOn,
|
|
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
|
+
# V1ResetEnclosureMotorSystemSettingsToDefaultRequest
|
|
2
|
+
|
|
3
|
+
Specifies which enclosure settings should be reset to their factory default values. Set each flag to true to reset that particular setting.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**accelerationDegreesPerSecondSquared** | **boolean** | When true, resets the enclosure acceleration setting for the specific motor to its factory default value. | [optional] [default to undefined]
|
|
10
|
+
**negativeLimitDegrees** | **boolean** | When true, resets the negative travel limit setting for the specific enclosure motor to its factory default value. | [optional] [default to undefined]
|
|
11
|
+
**positiveLimitDegrees** | **boolean** | When true, resets the positive travel limit setting for the specific enclosure motor to its factory default value. | [optional] [default to undefined]
|
|
12
|
+
**velocityDegreesPerSecond** | **boolean** | When true, resets the enclosure slew velocity setting for the specific motor to its factory default value. | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1ResetEnclosureMotorSystemSettingsToDefaultRequest } from '@ourskyai/node_platform-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1ResetEnclosureMotorSystemSettingsToDefaultRequest = {
|
|
20
|
+
accelerationDegreesPerSecondSquared,
|
|
21
|
+
negativeLimitDegrees,
|
|
22
|
+
positiveLimitDegrees,
|
|
23
|
+
velocityDegreesPerSecond,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# V1ResetEnclosureSystemSettingsToDefaultRequest
|
|
2
|
+
|
|
3
|
+
Specifies which mount settings should be reset to their factory default values. Set each flag to true to reset that particular setting.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**motorRotator** | [**V1ResetEnclosureMotorSystemSettingsToDefaultRequest**](V1ResetEnclosureMotorSystemSettingsToDefaultRequest.md) | | [optional] [default to undefined]
|
|
10
|
+
**motorShutter** | [**V1ResetEnclosureMotorSystemSettingsToDefaultRequest**](V1ResetEnclosureMotorSystemSettingsToDefaultRequest.md) | | [optional] [default to undefined]
|
|
11
|
+
**motorWindow** | [**V1ResetEnclosureMotorSystemSettingsToDefaultRequest**](V1ResetEnclosureMotorSystemSettingsToDefaultRequest.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1ResetEnclosureSystemSettingsToDefaultRequest } from '@ourskyai/node_platform-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1ResetEnclosureSystemSettingsToDefaultRequest = {
|
|
19
|
+
motorRotator,
|
|
20
|
+
motorShutter,
|
|
21
|
+
motorWindow,
|
|
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,27 @@
|
|
|
1
|
+
# V1ResetFocuserMotorSystemSettingsToDefaultRequest
|
|
2
|
+
|
|
3
|
+
Specifies which focuser motor settings should be reset to their factory default values. Set each flag to true to reset that particular setting.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**accelerationMicronsPerSecondSquared** | **boolean** | When true, resets the acceleration setting for the specific focuser motor to its factory default value. | [optional] [default to undefined]
|
|
10
|
+
**negativeLimitMicrons** | **boolean** | When true, resets the negative travel limit setting for the specific focuser motor to its factory default value. | [optional] [default to undefined]
|
|
11
|
+
**positiveLimitMicrons** | **boolean** | When true, resets the positive travel limit setting for the specific focuser motor to its factory default value. | [optional] [default to undefined]
|
|
12
|
+
**velocityMicronsPerSecond** | **boolean** | When true, resets the slew velocity setting for the specific focuser motor to its factory default value. | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1ResetFocuserMotorSystemSettingsToDefaultRequest } from '@ourskyai/node_platform-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1ResetFocuserMotorSystemSettingsToDefaultRequest = {
|
|
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,23 @@
|
|
|
1
|
+
# V1ResetFocuserSystemSettingsToDefaultRequest
|
|
2
|
+
|
|
3
|
+
Specifies which focuser settings should be reset to their factory default values. Set each flag to true to reset that particular setting.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**focuserA** | [**V1ResetFocuserMotorSystemSettingsToDefaultRequest**](V1ResetFocuserMotorSystemSettingsToDefaultRequest.md) | | [optional] [default to undefined]
|
|
10
|
+
**focuserB** | [**V1ResetFocuserMotorSystemSettingsToDefaultRequest**](V1ResetFocuserMotorSystemSettingsToDefaultRequest.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1ResetFocuserSystemSettingsToDefaultRequest } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1ResetFocuserSystemSettingsToDefaultRequest = {
|
|
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,27 @@
|
|
|
1
|
+
# V1ResetMountMotorSystemSettingsToDefaultRequest
|
|
2
|
+
|
|
3
|
+
Specifies which mount settings should be reset to their factory default values. Set each flag to true to reset that particular setting.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**accelerationDegreesPerSecondSquared** | **boolean** | When true, resets the mount acceleration setting for the specific motor to its factory default value. | [optional] [default to undefined]
|
|
10
|
+
**negativeLimitDegrees** | **boolean** | When true, resets the negative travel limit setting for the specific motor to its factory default value. | [optional] [default to undefined]
|
|
11
|
+
**positiveLimitDegrees** | **boolean** | When true, resets the positive travel limit setting for the specific motor to its factory default value. | [optional] [default to undefined]
|
|
12
|
+
**velocityDegreesPerSecond** | **boolean** | When true, resets the mount slew velocity setting for the specific motor to its factory default value. | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1ResetMountMotorSystemSettingsToDefaultRequest } from '@ourskyai/node_platform-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1ResetMountMotorSystemSettingsToDefaultRequest = {
|
|
20
|
+
accelerationDegreesPerSecondSquared,
|
|
21
|
+
negativeLimitDegrees,
|
|
22
|
+
positiveLimitDegrees,
|
|
23
|
+
velocityDegreesPerSecond,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# V1ResetMountSystemSettingsToDefaultRequest
|
|
2
|
+
|
|
3
|
+
Specifies which mount settings should be reset to their factory default values. Set each flag to true to reset that particular setting.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**motorA** | [**V1ResetMountMotorSystemSettingsToDefaultRequest**](V1ResetMountMotorSystemSettingsToDefaultRequest.md) | | [optional] [default to undefined]
|
|
10
|
+
**motorB** | [**V1ResetMountMotorSystemSettingsToDefaultRequest**](V1ResetMountMotorSystemSettingsToDefaultRequest.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1ResetMountSystemSettingsToDefaultRequest } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1ResetMountSystemSettingsToDefaultRequest = {
|
|
18
|
+
motorA,
|
|
19
|
+
motorB,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|