@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.
Files changed (417) hide show
  1. package/.openapi-generator/FILES +397 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +646 -0
  5. package/api.ts +22146 -0
  6. package/base.ts +62 -0
  7. package/common.ts +126 -0
  8. package/configuration.ts +121 -0
  9. package/dist/api.d.ts +12807 -0
  10. package/dist/api.js +14064 -0
  11. package/dist/base.d.ts +42 -0
  12. package/dist/base.js +46 -0
  13. package/dist/common.d.ts +34 -0
  14. package/dist/common.js +138 -0
  15. package/dist/configuration.d.ts +98 -0
  16. package/dist/configuration.js +44 -0
  17. package/dist/esm/api.d.ts +12807 -0
  18. package/dist/esm/api.js +14057 -0
  19. package/dist/esm/base.d.ts +42 -0
  20. package/dist/esm/base.js +41 -0
  21. package/dist/esm/common.d.ts +34 -0
  22. package/dist/esm/common.js +125 -0
  23. package/dist/esm/configuration.d.ts +98 -0
  24. package/dist/esm/configuration.js +40 -0
  25. package/dist/esm/index.d.ts +13 -0
  26. package/dist/esm/index.js +15 -0
  27. package/dist/index.d.ts +13 -0
  28. package/dist/index.js +31 -0
  29. package/docs/AllSkyCameraDiagnosisReport.md +23 -0
  30. package/docs/AllSkyImageCapturedEventData.md +20 -0
  31. package/docs/AllSkyKeogramGeneratedEventData.md +20 -0
  32. package/docs/AllSkyTimelapseGeneratedEventData.md +20 -0
  33. package/docs/AstroCameraDiagnosisReport.md +29 -0
  34. package/docs/AstroImageCapturedEventData.md +20 -0
  35. package/docs/AutoStretchImageCompleted.md +21 -0
  36. package/docs/AutoStretchImageStarted.md +21 -0
  37. package/docs/AutofocusFailed.md +21 -0
  38. package/docs/AutofocusFinished.md +25 -0
  39. package/docs/AutofocusMethod.md +13 -0
  40. package/docs/AutofocusPointAdded.md +25 -0
  41. package/docs/AutofocusPointMeasuredEventData.md +24 -0
  42. package/docs/AutofocusStarted.md +29 -0
  43. package/docs/CameraImageCaptured.md +21 -0
  44. package/docs/CameraStatusUpdated.md +25 -0
  45. package/docs/CameraTemperatureSet.md +21 -0
  46. package/docs/CancelAllTasksEventData.md +20 -0
  47. package/docs/CancelTaskEventData.md +20 -0
  48. package/docs/CaptureImageEventData.md +20 -0
  49. package/docs/CaptureImageStarted.md +29 -0
  50. package/docs/CaptureImagesContinuouslyEventData.md +20 -0
  51. package/docs/ConnectionStatus.md +13 -0
  52. package/docs/CreateMountModelCompleted.md +21 -0
  53. package/docs/CreateMountModelFailed.md +21 -0
  54. package/docs/CreateMountModelStarted.md +21 -0
  55. package/docs/CycleRelaysEventData.md +20 -0
  56. package/docs/DebugLogged.md +23 -0
  57. package/docs/DefaultApi.md +10356 -0
  58. package/docs/DeleteImageEventData.md +20 -0
  59. package/docs/DeleteVideoEventData.md +20 -0
  60. package/docs/DiagnoseSystemEventData.md +20 -0
  61. package/docs/ElevationMaskDiagnosticCompleted.md +21 -0
  62. package/docs/ElevationMaskDiagnosticFailed.md +21 -0
  63. package/docs/ElevationMaskDiagnosticStarted.md +21 -0
  64. package/docs/ElevationMaskPointAdded.md +25 -0
  65. package/docs/ElevationMaskPointAddedEventData.md +24 -0
  66. package/docs/EmptySuccess.md +20 -0
  67. package/docs/EnclosureHvacError.md +25 -0
  68. package/docs/EnclosureHvacFanSpeed.md +19 -0
  69. package/docs/EnclosureHvacMode.md +17 -0
  70. package/docs/EnclosureHvacTemperatureLimits.md +31 -0
  71. package/docs/EnclosureShutterLabel.md +11 -0
  72. package/docs/EnclosureShutterState.md +23 -0
  73. package/docs/EnclosureShutterStatusesChangedEventData.md +20 -0
  74. package/docs/EnclosureShutterStatusesUpdated.md +21 -0
  75. package/docs/EnclosureShutterWatchdogTriggeredEventData.md +24 -0
  76. package/docs/EnclosureState.md +31 -0
  77. package/docs/EventType.md +118 -0
  78. package/docs/FitsHeader.md +23 -0
  79. package/docs/FocusOperation.md +17 -0
  80. package/docs/FocuserDiagnosisReport.md +23 -0
  81. package/docs/FocuserPosition.md +31 -0
  82. package/docs/FocuserStatusUpdated.md +21 -0
  83. package/docs/GenericEventData.md +22 -0
  84. package/docs/GoToAltitudeAzimuthCompleted.md +23 -0
  85. package/docs/GoToAltitudeAzimuthFailed.md +23 -0
  86. package/docs/GoToAltitudeAzimuthStarted.md +23 -0
  87. package/docs/GoToFilterWheelPositionEventData.md +20 -0
  88. package/docs/GoToFocuserPositionEventData.md +20 -0
  89. package/docs/GoToHomeCompleted.md +21 -0
  90. package/docs/GoToHomeFailed.md +21 -0
  91. package/docs/GoToHomeStarted.md +21 -0
  92. package/docs/GoToMechanicalCoordinatesCompleted.md +23 -0
  93. package/docs/GoToMechanicalCoordinatesFailed.md +23 -0
  94. package/docs/GoToMechanicalCoordinatesStarted.md +23 -0
  95. package/docs/GoToMountCoordinatesEventData.md +20 -0
  96. package/docs/GoToOpticalTubeM3PortEventData.md +20 -0
  97. package/docs/GoToRaDecCompleted.md +23 -0
  98. package/docs/GoToRaDecFailed.md +23 -0
  99. package/docs/GoToRaDecStarted.md +23 -0
  100. package/docs/GoToRotatorPositionEventData.md +20 -0
  101. package/docs/GpsDataUpdated.md +33 -0
  102. package/docs/GpsDataUpdatedEventData.md +32 -0
  103. package/docs/HardwareDaemonLogged.md +21 -0
  104. package/docs/IceMessage.md +26 -0
  105. package/docs/ImageFileFormat.md +15 -0
  106. package/docs/JogEnclosureRotatorEventData.md +20 -0
  107. package/docs/JogEnclosureShuttersEventData.md +20 -0
  108. package/docs/JogEnclosureWindowEventData.md +20 -0
  109. package/docs/JogMountEventData.md +20 -0
  110. package/docs/KernelLogEntryDetectedEventData.md +22 -0
  111. package/docs/MessageType.md +22 -0
  112. package/docs/MessageTypeWrapper.md +20 -0
  113. package/docs/MotorFaultClearedEventData.md +20 -0
  114. package/docs/MotorFaultDetectedEventData.md +24 -0
  115. package/docs/MotorFaulted.md +25 -0
  116. package/docs/MotorFaultsCleared.md +21 -0
  117. package/docs/MountDiagnosisReport.md +27 -0
  118. package/docs/MountFollowTLEEventData.md +20 -0
  119. package/docs/MountModelPointAdded.md +27 -0
  120. package/docs/MountModelPointAddedEventData.md +26 -0
  121. package/docs/MountModelPointFailed.md +23 -0
  122. package/docs/MountStatusUpdated.md +21 -0
  123. package/docs/OpenEnclosureShuttersEventData.md +20 -0
  124. package/docs/OperationStatusUpdated.md +21 -0
  125. package/docs/OpticalTubeStatus.md +21 -0
  126. package/docs/OpticalTubeStatusUpdated.md +21 -0
  127. package/docs/Peer.md +24 -0
  128. package/docs/PeerRole.md +10 -0
  129. package/docs/PlaceholderEventData.md +20 -0
  130. package/docs/PlateSolveCompleted.md +25 -0
  131. package/docs/PlateSolveFailed.md +21 -0
  132. package/docs/PlateSolveStarted.md +21 -0
  133. package/docs/PlatformConnectionDiagnosisReport.md +21 -0
  134. package/docs/Point2D.md +22 -0
  135. package/docs/RecordVideoEventData.md +20 -0
  136. package/docs/RelayChannel.md +21 -0
  137. package/docs/RelayFunction.md +29 -0
  138. package/docs/RelaysDiagnosisReport.md +25 -0
  139. package/docs/RelaysStatus.md +21 -0
  140. package/docs/RelaysUpdated.md +23 -0
  141. package/docs/ResetSystemSettingsToDefaultEventData.md +20 -0
  142. package/docs/RoofDiagnosisReport.md +25 -0
  143. package/docs/RoofState.md +31 -0
  144. package/docs/RoofStatus.md +21 -0
  145. package/docs/RoofUpdated.md +23 -0
  146. package/docs/RotatorPosition.md +23 -0
  147. package/docs/RotatorStatusUpdated.md +21 -0
  148. package/docs/RotatorTargetType.md +11 -0
  149. package/docs/RunAutofocusEventData.md +20 -0
  150. package/docs/SafetyStatusUpdated.md +21 -0
  151. package/docs/SaveImageEventData.md +20 -0
  152. package/docs/SaveVideoEventData.md +20 -0
  153. package/docs/SdpMessage.md +22 -0
  154. package/docs/SetEnclosureHvacFanSpeedEventData.md +20 -0
  155. package/docs/SetEnclosureHvacModeEventData.md +20 -0
  156. package/docs/SetEnclosureHvacTargetTemperatureEventData.md +20 -0
  157. package/docs/SetMountParkPositionEventData.md +20 -0
  158. package/docs/SetOpticalTubeHeaterPowerEventData.md +20 -0
  159. package/docs/SlewDemoEnabled.md +21 -0
  160. package/docs/StackedAstroImageGeneratedEventData.md +20 -0
  161. package/docs/StarMeasurementFailed.md +21 -0
  162. package/docs/StarMeasurementStarted.md +21 -0
  163. package/docs/StarsMeasured.md +25 -0
  164. package/docs/StartupWizardStep.md +25 -0
  165. package/docs/StopCapturingImagesContinuouslyEventData.md +20 -0
  166. package/docs/StopRecordingVideoEventData.md +20 -0
  167. package/docs/SystemEventData.md +216 -0
  168. package/docs/SystemEventOperation.md +24 -0
  169. package/docs/SystemEventOperationStatus.md +12 -0
  170. package/docs/SystemEventSeverity.md +14 -0
  171. package/docs/SystemEventType.md +123 -0
  172. package/docs/SystemStatusChangedEventData.md +20 -0
  173. package/docs/TaskCancelled.md +27 -0
  174. package/docs/TaskCompleted.md +25 -0
  175. package/docs/TaskScheduled.md +25 -0
  176. package/docs/TaskStarted.md +25 -0
  177. package/docs/TurnOffOpticalTubeFansEventData.md +20 -0
  178. package/docs/TurnOffRelayEventData.md +20 -0
  179. package/docs/TurnOnOpticalTubeFansEventData.md +20 -0
  180. package/docs/TurnOnRelayEventData.md +20 -0
  181. package/docs/UpdateFilterEventData.md +20 -0
  182. package/docs/UpdateSystemSettingsEventData.md +20 -0
  183. package/docs/V1AddMountModelPointHereRequest.md +23 -0
  184. package/docs/V1AllSkyClassification.md +23 -0
  185. package/docs/V1AllSkyClassificationLabel.md +17 -0
  186. package/docs/V1AllSkyImage.md +29 -0
  187. package/docs/V1AllSkyImages.md +21 -0
  188. package/docs/V1AllSkyKeogram.md +31 -0
  189. package/docs/V1AllSkyKeograms.md +21 -0
  190. package/docs/V1AllSkySourceType.md +11 -0
  191. package/docs/V1AllSkyTimelapse.md +33 -0
  192. package/docs/V1AllSkyTimelapses.md +21 -0
  193. package/docs/V1AppendMountTrackPathRequest.md +29 -0
  194. package/docs/V1AstroImage.md +29 -0
  195. package/docs/V1AstroImages.md +21 -0
  196. package/docs/V1CameraFunction.md +19 -0
  197. package/docs/V1CameraSelectorRequest.md +21 -0
  198. package/docs/V1CameraStatus.md +39 -0
  199. package/docs/V1CameraStatuses.md +21 -0
  200. package/docs/V1CancelAllTasksRequest.md +21 -0
  201. package/docs/V1CancelTaskRequest.md +23 -0
  202. package/docs/V1CaptureImageRequest.md +39 -0
  203. package/docs/V1CaptureImagesContinuouslyRequest.md +39 -0
  204. package/docs/V1ConnectedCamera.md +23 -0
  205. package/docs/V1CreateMountModelRequest.md +31 -0
  206. package/docs/V1CycleRelaysRequest.md +23 -0
  207. package/docs/V1DeleteImageRequest.md +21 -0
  208. package/docs/V1DeleteVideoRequest.md +21 -0
  209. package/docs/V1DiagnoseSystemRequest.md +35 -0
  210. package/docs/V1DisableLiveVideoRequest.md +21 -0
  211. package/docs/V1EdfaStatus.md +22 -0
  212. package/docs/V1EdfaStatusDetails.md +26 -0
  213. package/docs/V1ElevationMask.md +23 -0
  214. package/docs/V1ElevationMaskPoint.md +25 -0
  215. package/docs/V1EnableLiveVideoRequest.md +31 -0
  216. package/docs/V1EnclosureFanRole.md +9 -0
  217. package/docs/V1EnclosureFanStatus.md +25 -0
  218. package/docs/V1EnclosureFanStatuses.md +21 -0
  219. package/docs/V1EnclosureHvacStatus.md +23 -0
  220. package/docs/V1EnclosureHvacStatusDetails.md +33 -0
  221. package/docs/V1EnclosureMotorSystemSettings.md +27 -0
  222. package/docs/V1EnclosureRotatorStatus.md +27 -0
  223. package/docs/V1EnclosureShutterStatus.md +29 -0
  224. package/docs/V1EnclosureShutterStatuses.md +21 -0
  225. package/docs/V1EnclosureStatus.md +27 -0
  226. package/docs/V1EnclosureSystemSettings.md +25 -0
  227. package/docs/V1EnclosureWindowStatus.md +27 -0
  228. package/docs/V1EndSessionRequest.md +23 -0
  229. package/docs/V1Event.md +24 -0
  230. package/docs/V1EventData.md +166 -0
  231. package/docs/V1Filter.md +23 -0
  232. package/docs/V1FilterType.md +61 -0
  233. package/docs/V1FilterWheelStatus.md +29 -0
  234. package/docs/V1FilterWheelStatuses.md +21 -0
  235. package/docs/V1FocuserLimit.md +23 -0
  236. package/docs/V1FocuserMotorSystemSettings.md +27 -0
  237. package/docs/V1FocuserSelectorRequest.md +21 -0
  238. package/docs/V1FocuserStatus.md +31 -0
  239. package/docs/V1FocuserStatuses.md +21 -0
  240. package/docs/V1FocuserSystemSettings.md +23 -0
  241. package/docs/V1FollowTLERequest.md +23 -0
  242. package/docs/V1GetComponentStatusResponse.md +43 -0
  243. package/docs/V1GetHealthCheckResponse.md +33 -0
  244. package/docs/V1GetImageProcessingPluginLogsRequest.md +24 -0
  245. package/docs/V1GetImageProcessingPluginRequest.md +20 -0
  246. package/docs/V1GetStorageStatusResponse.md +25 -0
  247. package/docs/V1GnssPpsStatus.md +24 -0
  248. package/docs/V1GnssPpsStatusDetails.md +27 -0
  249. package/docs/V1GoToFilterWheelPositionRequest.md +23 -0
  250. package/docs/V1GoToFocuserPositionRequest.md +24 -0
  251. package/docs/V1GoToMountCoordinatesRequest.md +27 -0
  252. package/docs/V1GoToMountMechanicalCoordinatesRequest.md +23 -0
  253. package/docs/V1GoToOpticalTubeM3PortRequest.md +23 -0
  254. package/docs/V1GoToRotatorPositionRequest.md +25 -0
  255. package/docs/V1Image.md +43 -0
  256. package/docs/V1ImageProcessingPlugin.md +30 -0
  257. package/docs/V1ImageProcessingPluginList.md +22 -0
  258. package/docs/V1ImageProcessingPluginLogEntry.md +22 -0
  259. package/docs/V1ImageProcessingPluginLogList.md +22 -0
  260. package/docs/V1Images.md +21 -0
  261. package/docs/V1JogEnclosureRotatorRequest.md +23 -0
  262. package/docs/V1JogEnclosureShutterRequest.md +25 -0
  263. package/docs/V1JogEnclosureShuttersRequest.md +21 -0
  264. package/docs/V1JogEnclosureWindowRequest.md +23 -0
  265. package/docs/V1JogMountRequest.md +25 -0
  266. package/docs/V1ListProducersRequest.md +23 -0
  267. package/docs/V1ListProducersResponse.md +23 -0
  268. package/docs/V1Motor.md +23 -0
  269. package/docs/V1MotorRole.md +22 -0
  270. package/docs/V1MotorStatus.md +37 -0
  271. package/docs/V1MountModel.md +23 -0
  272. package/docs/V1MountModelPoint.md +27 -0
  273. package/docs/V1MountMotorSystemSettings.md +27 -0
  274. package/docs/V1MountStatus.md +43 -0
  275. package/docs/V1MountSystemSettings.md +23 -0
  276. package/docs/V1MountTrackPathAltAzSample.md +27 -0
  277. package/docs/V1MountTrackPathEndedReason.md +13 -0
  278. package/docs/V1MountTrackPathEnuSample.md +29 -0
  279. package/docs/V1MountTrackPathFrame.md +15 -0
  280. package/docs/V1MountTrackPathRaDecSample.md +27 -0
  281. package/docs/V1MountTrackPathState.md +17 -0
  282. package/docs/V1MountTrackPathStatus.md +49 -0
  283. package/docs/V1MoveFocuserPositionRequest.md +23 -0
  284. package/docs/V1MoveFocuserResponse.md +23 -0
  285. package/docs/V1MoveFocuserStepsRequest.md +23 -0
  286. package/docs/V1NtpStatus.md +24 -0
  287. package/docs/V1NtpStatusDetails.md +23 -0
  288. package/docs/V1OpenEnclosureShuttersRequest.md +21 -0
  289. package/docs/V1OpenRoofRequest.md +21 -0
  290. package/docs/V1OpticalPowerMeterStatus.md +21 -0
  291. package/docs/V1OpticalTubeCoverSelectorRequest.md +21 -0
  292. package/docs/V1OpticalTubeCoverStatus.md +27 -0
  293. package/docs/V1OpticalTubeCoverStatuses.md +21 -0
  294. package/docs/V1OpticalTubeFanGroupStatus.md +23 -0
  295. package/docs/V1OpticalTubeFanGroupStatuses.md +21 -0
  296. package/docs/V1OpticalTubeFanRole.md +23 -0
  297. package/docs/V1OpticalTubeFanStatus.md +25 -0
  298. package/docs/V1OpticalTubeHeaterGroupStatus.md +23 -0
  299. package/docs/V1OpticalTubeHeaterGroupStatuses.md +21 -0
  300. package/docs/V1OpticalTubeHeaterRole.md +13 -0
  301. package/docs/V1OpticalTubeHeaterStatus.md +25 -0
  302. package/docs/V1OpticalTubeM3SelectorRequest.md +21 -0
  303. package/docs/V1OpticalTubeM3Status.md +25 -0
  304. package/docs/V1OpticalTubeM3Statuses.md +21 -0
  305. package/docs/V1OpticalTubeStatus.md +31 -0
  306. package/docs/V1OpticalTubeStatuses.md +21 -0
  307. package/docs/V1OpticalTubeTemperatureSensorRole.md +15 -0
  308. package/docs/V1OpticalTubeTemperatureSensorStatus.md +23 -0
  309. package/docs/V1OpticalTubeTemperatureSensorStatuses.md +21 -0
  310. package/docs/V1PeerStatusChangedRequest.md +27 -0
  311. package/docs/V1PtpDataSet.md +25 -0
  312. package/docs/V1PtpPortProperties.md +27 -0
  313. package/docs/V1PtpStatus.md +24 -0
  314. package/docs/V1PtpStatusDetails.md +25 -0
  315. package/docs/V1PtpTimeStatus.md +35 -0
  316. package/docs/V1RecordVideoRequest.md +21 -0
  317. package/docs/V1Relay.md +23 -0
  318. package/docs/V1ResetEnclosureMotorSystemSettingsToDefaultRequest.md +27 -0
  319. package/docs/V1ResetEnclosureSystemSettingsToDefaultRequest.md +25 -0
  320. package/docs/V1ResetFocuserMotorSystemSettingsToDefaultRequest.md +27 -0
  321. package/docs/V1ResetFocuserSystemSettingsToDefaultRequest.md +23 -0
  322. package/docs/V1ResetMountMotorSystemSettingsToDefaultRequest.md +27 -0
  323. package/docs/V1ResetMountSystemSettingsToDefaultRequest.md +23 -0
  324. package/docs/V1ResetRotatorMotorSystemSettingsToDefaultRequest.md +27 -0
  325. package/docs/V1ResetRotatorSystemSettingsToDefaultRequest.md +23 -0
  326. package/docs/V1ResetSystemSettingsToDefaultRequest.md +27 -0
  327. package/docs/V1RoofStatus.md +27 -0
  328. package/docs/V1RotatorMotorSystemSettings.md +27 -0
  329. package/docs/V1RotatorSelectorRequest.md +21 -0
  330. package/docs/V1RotatorStatus.md +33 -0
  331. package/docs/V1RotatorStatuses.md +21 -0
  332. package/docs/V1RotatorSystemSettings.md +23 -0
  333. package/docs/V1RunAutofocusRequest.md +32 -0
  334. package/docs/V1RunBlindAutofocusRequest.md +24 -0
  335. package/docs/V1SafetyStatus.md +33 -0
  336. package/docs/V1SaveImageRequest.md +21 -0
  337. package/docs/V1SaveVideoRequest.md +21 -0
  338. package/docs/V1SetEnclosureHvacFanSpeedRequest.md +21 -0
  339. package/docs/V1SetEnclosureHvacModeRequest.md +21 -0
  340. package/docs/V1SetEnclosureHvacTargetTemperatureRequest.md +21 -0
  341. package/docs/V1SetMountParkPositionRequest.md +23 -0
  342. package/docs/V1SetOpticalTubeHeaterPowerRequest.md +25 -0
  343. package/docs/V1SetPeerStatusRequest.md +29 -0
  344. package/docs/V1SetRelayStateRequest.md +23 -0
  345. package/docs/V1SignalMessageRequest.md +27 -0
  346. package/docs/V1SignallingRequest.md +40 -0
  347. package/docs/V1StackedAstroImage.md +25 -0
  348. package/docs/V1StackedAstroImages.md +21 -0
  349. package/docs/V1StartLiveStackingSessionRequest.md +20 -0
  350. package/docs/V1StartLiveStackingSessionResponse.md +20 -0
  351. package/docs/V1StartMountTrackPathRequest.md +27 -0
  352. package/docs/V1StartSessionRequest.md +27 -0
  353. package/docs/V1StopCapturingImagesContinuouslyRequest.md +21 -0
  354. package/docs/V1StopLiveStackingSessionRequest.md +20 -0
  355. package/docs/V1StopRecordingVideoRequest.md +21 -0
  356. package/docs/V1SystemDiagnosisReport.md +35 -0
  357. package/docs/V1SystemEvent.md +25 -0
  358. package/docs/V1SystemEventData.md +173 -0
  359. package/docs/V1SystemEvents.md +21 -0
  360. package/docs/V1SystemHealthCheck.md +33 -0
  361. package/docs/V1SystemLocation.md +29 -0
  362. package/docs/V1SystemLocationGpsDetails.md +27 -0
  363. package/docs/V1SystemMetric.md +29 -0
  364. package/docs/V1SystemMetricNames.md +21 -0
  365. package/docs/V1SystemMetricTag.md +23 -0
  366. package/docs/V1SystemMetricType.md +11 -0
  367. package/docs/V1SystemMetrics.md +21 -0
  368. package/docs/V1SystemMetricsCollection.md +27 -0
  369. package/docs/V1SystemMetricsCollections.md +21 -0
  370. package/docs/V1SystemNetworkInterface.md +25 -0
  371. package/docs/V1SystemNetworkInterfaceInfo.md +25 -0
  372. package/docs/V1SystemNetworkInterfaces.md +21 -0
  373. package/docs/V1SystemOperationMode.md +13 -0
  374. package/docs/V1SystemOperationStatus.md +23 -0
  375. package/docs/V1SystemSettings.md +27 -0
  376. package/docs/V1SystemStatus.md +43 -0
  377. package/docs/V1SystemStorageStatus.md +25 -0
  378. package/docs/V1SystemTime.md +31 -0
  379. package/docs/V1Task.md +29 -0
  380. package/docs/V1TaskType.md +31 -0
  381. package/docs/V1TimeSource.md +15 -0
  382. package/docs/V1TimeSourceLastSample.md +25 -0
  383. package/docs/V1TimeSourceStatistics.md +35 -0
  384. package/docs/V1TrackBodyRequest.md +21 -0
  385. package/docs/V1TurnOffEnclosureFansRequest.md +21 -0
  386. package/docs/V1TurnOffOpticalTubeFansRequest.md +23 -0
  387. package/docs/V1TurnOnEnclosureFansRequest.md +21 -0
  388. package/docs/V1TurnOnOpticalTubeFansRequest.md +23 -0
  389. package/docs/V1UIOperationMode.md +11 -0
  390. package/docs/V1UpdateElevationMaskRequest.md +21 -0
  391. package/docs/V1UpdateFilterRequest.md +25 -0
  392. package/docs/V1UpdateImageProcessingPluginRequest.md +24 -0
  393. package/docs/V1Video.md +51 -0
  394. package/docs/V1Videos.md +21 -0
  395. package/docs/V1WeatherStationStatus.md +21 -0
  396. package/docs/V2CaptureImageRequest.md +39 -0
  397. package/docs/V2CycleRelaysRequest.md +23 -0
  398. package/docs/V2EnclosureStatus.md +29 -0
  399. package/docs/V2MountStatus.md +37 -0
  400. package/docs/V2RelayStatus.md +25 -0
  401. package/docs/V2RelayStatuses.md +21 -0
  402. package/docs/V2SystemEvent.md +33 -0
  403. package/docs/V2SystemEventType.md +205 -0
  404. package/docs/V2SystemEvents.md +21 -0
  405. package/docs/V2TurnOffRelayRequest.md +21 -0
  406. package/docs/V2TurnOnRelayRequest.md +21 -0
  407. package/docs/VideoCodec.md +8 -0
  408. package/docs/VideoContainerFormat.md +8 -0
  409. package/docs/WavefrontSensorDataUpdated.md +57 -0
  410. package/docs/WavefrontSensorDataUpdatedEventData.md +57 -0
  411. package/docs/WeatherStationDiagnosisReport.md +23 -0
  412. package/docs/WeatherStationStatusUpdated.md +21 -0
  413. package/git_push.sh +57 -0
  414. package/index.ts +18 -0
  415. package/package.json +33 -0
  416. package/tsconfig.esm.json +7 -0
  417. package/tsconfig.json +18 -0
@@ -0,0 +1,21 @@
1
+ # V1DeleteImageRequest
2
+
3
+ Request object to permanently delete an image and its associated files. This action cannot be undone.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | Unique identifier of the image to delete. The image and all associated files including FITS, JPEG, and RAW versions will be permanently removed. | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { V1DeleteImageRequest } from '@ourskyai/node_platform-api';
15
+
16
+ const instance: V1DeleteImageRequest = {
17
+ id,
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
+ # V1DeleteVideoRequest
2
+
3
+ Request object to permanently delete a video and its associated files. This action cannot be undone.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | Unique identifier of the video to delete. The video and all associated files will be permanently removed. | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { V1DeleteVideoRequest } from '@ourskyai/node_platform-api';
15
+
16
+ const instance: V1DeleteVideoRequest = {
17
+ id,
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,35 @@
1
+ # V1DiagnoseSystemRequest
2
+
3
+ Request parameters specifying which hardware components should be included in the diagnostic test. Set each flag to true to test that component.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **diagnoseAllSkyCamera** | **boolean** | When true, tests the all-sky camera for connectivity and continuous image capture capability. | [default to undefined]
10
+ **diagnoseAstroCamera** | **boolean** | When true, tests the main astronomical camera for connectivity, image capture, GPS timestamping, and temperature control capabilities. | [default to undefined]
11
+ **diagnoseFocuser** | **boolean** | When true, tests the focuser for connectivity and movement capability. | [default to undefined]
12
+ **diagnoseMount** | **boolean** | When true, tests the telescope mount for connectivity and basic motion capabilities including homing, slewing, and parking. | [default to undefined]
13
+ **diagnosePlatformConnection** | **boolean** | When true, tests the network connection to the cloud platform backend to verify API communication. | [default to undefined]
14
+ **diagnoseRelays** | **boolean** | When true, tests the relay controller for connectivity and power cycling capability for mount and camera components. | [default to undefined]
15
+ **diagnoseRoof** | **boolean** | When true, tests the roll-off roof or dome controller for connectivity and open/close capability. | [default to undefined]
16
+ **diagnoseWeatherStation** | **boolean** | When true, tests the weather station for connectivity and sensor reading capability. | [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { V1DiagnoseSystemRequest } from '@ourskyai/node_platform-api';
22
+
23
+ const instance: V1DiagnoseSystemRequest = {
24
+ diagnoseAllSkyCamera,
25
+ diagnoseAstroCamera,
26
+ diagnoseFocuser,
27
+ diagnoseMount,
28
+ diagnosePlatformConnection,
29
+ diagnoseRelays,
30
+ diagnoseRoof,
31
+ diagnoseWeatherStation,
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
+ # V1DisableLiveVideoRequest
2
+
3
+ Disable Live Video
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **cameraId** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { V1DisableLiveVideoRequest } from '@ourskyai/node_platform-api';
15
+
16
+ const instance: V1DisableLiveVideoRequest = {
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)
@@ -0,0 +1,22 @@
1
+ # V1EdfaStatus
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **connected** | **boolean** | Whether the EDFA is connected and responding. | [default to undefined]
9
+ **details** | [**V1EdfaStatusDetails**](V1EdfaStatusDetails.md) | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { V1EdfaStatus } from '@ourskyai/node_platform-api';
15
+
16
+ const instance: V1EdfaStatus = {
17
+ connected,
18
+ details,
19
+ };
20
+ ```
21
+
22
+ [[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,26 @@
1
+ # V1EdfaStatusDetails
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **isPumpActive** | **boolean** | Whether the EDFA pump is actively lasing. | [optional] [default to undefined]
9
+ **isPumpOn** | **boolean** | Whether the EDFA pump is currently enabled. | [default to undefined]
10
+ **mainOutputChannel** | **number** | Active main output channel reported by the EDFA. | [optional] [default to undefined]
11
+ **warningWord** | **number** | Raw EDFA warning bitfield. | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { V1EdfaStatusDetails } from '@ourskyai/node_platform-api';
17
+
18
+ const instance: V1EdfaStatusDetails = {
19
+ isPumpActive,
20
+ isPumpOn,
21
+ mainOutputChannel,
22
+ warningWord,
23
+ };
24
+ ```
25
+
26
+ [[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
+ # V1ElevationMask
2
+
3
+ Defines the observable sky boundaries accounting for local obstructions at each azimuth angle. Used for observation planning and scheduling.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **createdAt** | **string** | ISO 8601 timestamp indicating when this elevation mask was created. Use this to determine if the mask needs updating after site changes. | [default to undefined]
10
+ **points** | [**Array<V1ElevationMaskPoint>**](V1ElevationMaskPoint.md) | Array of elevation mask points defining the observable altitude range at various azimuth positions around the horizon. | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { V1ElevationMask } from '@ourskyai/node_platform-api';
16
+
17
+ const instance: V1ElevationMask = {
18
+ createdAt,
19
+ points,
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,25 @@
1
+ # V1ElevationMaskPoint
2
+
3
+ A single point in the elevation mask defining the observable altitude range at a specific azimuth.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **azimuthDegrees** | **number** | Azimuth angle in degrees where this mask point applies. Measured clockwise from north (0-360 degrees). | [default to undefined]
10
+ **maxAltitudeDegrees** | **number** | Maximum observable altitude in degrees at this azimuth. May be less than 90 degrees if overhead obstructions exist. | [default to undefined]
11
+ **minAltitudeDegrees** | **number** | Minimum observable altitude in degrees at this azimuth due to local obstructions like buildings, trees, or terrain. | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { V1ElevationMaskPoint } from '@ourskyai/node_platform-api';
17
+
18
+ const instance: V1ElevationMaskPoint = {
19
+ azimuthDegrees,
20
+ maxAltitudeDegrees,
21
+ minAltitudeDegrees,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,31 @@
1
+ # V1EnableLiveVideoRequest
2
+
3
+ Enable Live Video
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **binning** | **number** | | [optional] [default to undefined]
10
+ **cameraId** | **string** | | [default to undefined]
11
+ **exposure** | **number** | Exposure duration in seconds | [optional] [default to undefined]
12
+ **gain** | **number** | | [optional] [default to undefined]
13
+ **gainMode** | **number** | | [optional] [default to 1]
14
+ **offset** | **number** | | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { V1EnableLiveVideoRequest } from '@ourskyai/node_platform-api';
20
+
21
+ const instance: V1EnableLiveVideoRequest = {
22
+ binning,
23
+ cameraId,
24
+ exposure,
25
+ gain,
26
+ gainMode,
27
+ offset,
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,9 @@
1
+ # V1EnclosureFanRole
2
+
3
+ Identifies the specific fan location and purpose within the dome enclosure.
4
+
5
+ ## Enum
6
+
7
+ * `PRIMARY_EXHAUST_FANS` (value: `'PRIMARY_EXHAUST_FANS'`)
8
+
9
+ [[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
+ # V1EnclosureFanStatus
2
+
3
+ Status information for a single fan in the dome enclosure.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **connected** | **boolean** | Indicates whether communication with the enclosure fan controller is active. When false, the fan cannot be controlled and its state may be unknown. | [default to undefined]
10
+ **isOn** | **boolean** | Indicates whether this fan is currently running. | [default to undefined]
11
+ **role** | [**V1EnclosureFanRole**](V1EnclosureFanRole.md) | | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { V1EnclosureFanStatus } from '@ourskyai/node_platform-api';
17
+
18
+ const instance: V1EnclosureFanStatus = {
19
+ connected,
20
+ isOn,
21
+ role,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,21 @@
1
+ # V1EnclosureFanStatuses
2
+
3
+ Collection of status information for all fans in the dome enclosure. Provides a complete view of the fan subsystem state.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **statuses** | [**Array<V1EnclosureFanStatus>**](V1EnclosureFanStatus.md) | Array of individual fan status objects, one for each fan in the enclosure. | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { V1EnclosureFanStatuses } from '@ourskyai/node_platform-api';
15
+
16
+ const instance: V1EnclosureFanStatuses = {
17
+ statuses,
18
+ };
19
+ ```
20
+
21
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # V1EnclosureHvacStatus
2
+
3
+ Current status of the HVAC system.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **connected** | **boolean** | Whether the HVAC unit is connected and communicating. | [default to undefined]
10
+ **details** | [**V1EnclosureHvacStatusDetails**](V1EnclosureHvacStatusDetails.md) | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { V1EnclosureHvacStatus } from '@ourskyai/node_platform-api';
16
+
17
+ const instance: V1EnclosureHvacStatus = {
18
+ connected,
19
+ details,
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,33 @@
1
+ # V1EnclosureHvacStatusDetails
2
+
3
+ Detailed HVAC status. Only present when connected.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **error** | [**EnclosureHvacError**](EnclosureHvacError.md) | | [optional] [default to undefined]
10
+ **fanSpeed** | [**EnclosureHvacFanSpeed**](EnclosureHvacFanSpeed.md) | | [default to undefined]
11
+ **isOn** | **boolean** | Whether the HVAC unit is currently on. | [default to undefined]
12
+ **mode** | [**EnclosureHvacMode**](EnclosureHvacMode.md) | | [default to undefined]
13
+ **targetTemperatureCelsius** | **number** | Current temperature setpoint in degrees Celsius. | [default to undefined]
14
+ **temperatureCelsius** | **number** | Current temperature reading in degrees Celsius. | [default to undefined]
15
+ **temperatureLimits** | [**EnclosureHvacTemperatureLimits**](EnclosureHvacTemperatureLimits.md) | | [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { V1EnclosureHvacStatusDetails } from '@ourskyai/node_platform-api';
21
+
22
+ const instance: V1EnclosureHvacStatusDetails = {
23
+ error,
24
+ fanSpeed,
25
+ isOn,
26
+ mode,
27
+ targetTemperatureCelsius,
28
+ temperatureCelsius,
29
+ temperatureLimits,
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,27 @@
1
+ # V1EnclosureMotorSystemSettings
2
+
3
+ Configuration settings for enclosure motor motion control including slew speed, acceleration, and travel limits.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **accelerationDegreesPerSecondSquared** | **number** | Maximum acceleration of the enclosure motor in degrees per second squared. Controls how quickly the enclosure motor ramps up to slew speed. Higher values reduce slew time but may cause vibration or tracking errors. Typical values range from 0.5 to 5 degrees per second squared. | [optional] [default to undefined]
10
+ **negativeLimitDegrees** | **number** | Negative travel limit of the enclosure motor in degrees. The motor should not move below this position. | [optional] [default to undefined]
11
+ **positiveLimitDegrees** | **number** | Positive travel limit of the enclosure motor in degrees. The motor should not move above this position. | [optional] [default to undefined]
12
+ **velocityDegreesPerSecond** | **number** | Maximum slew velocity of the enclosure motor in degrees per second. Higher values enable faster slewing between targets but may reduce pointing accuracy or cause mechanical stress. Typical values range from 1 to 10 degrees per second. | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { V1EnclosureMotorSystemSettings } from '@ourskyai/node_platform-api';
18
+
19
+ const instance: V1EnclosureMotorSystemSettings = {
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,27 @@
1
+ # V1EnclosureRotatorStatus
2
+
3
+ Comprehensive status information for the dome rotator mechanism including connectivity, current azimuth position, and mount tracking state. Use this to verify proper dome alignment before and during observations.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **azimuthDegrees** | **number** | The current rotational position of the dome in degrees from north. Values range from 0 to 360, where 0/360 is north, 90 is east, 180 is south, and 270 is west. | [default to undefined]
10
+ **connected** | **boolean** | Indicates whether the rotator controller is currently connected and responding to commands. A false value means the dome cannot be rotated or its position monitored. | [default to undefined]
11
+ **isSyncedWithMount** | **boolean** | Indicates whether the dome is actively tracking the telescope mount position. When true, the dome automatically rotates to keep the aperture aligned with telescope pointing. | [default to undefined]
12
+ **motor** | [**V1MotorStatus**](V1MotorStatus.md) | | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { V1EnclosureRotatorStatus } from '@ourskyai/node_platform-api';
18
+
19
+ const instance: V1EnclosureRotatorStatus = {
20
+ azimuthDegrees,
21
+ connected,
22
+ isSyncedWithMount,
23
+ motor,
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,29 @@
1
+ # V1EnclosureShutterStatus
2
+
3
+ Detailed status information for a single shutter panel including its identification, connectivity, operational state, and current position. Use this to monitor individual panel behavior during operations.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **connected** | **boolean** | Indicates whether the shutter controller is currently connected and responding. A false value means this shutter cannot be commanded or monitored reliably. | [default to undefined]
10
+ **label** | [**EnclosureShutterLabel**](EnclosureShutterLabel.md) | | [default to undefined]
11
+ **motor** | [**V1MotorStatus**](V1MotorStatus.md) | | [optional] [default to undefined]
12
+ **positionPercent** | **number** | The current position of the shutter as a percentage from 0 to 100. A value of 0 indicates fully closed, 100 indicates fully open. Intermediate values show partial opening during movement or after a halt. | [default to undefined]
13
+ **state** | [**EnclosureShutterState**](EnclosureShutterState.md) | | [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { V1EnclosureShutterStatus } from '@ourskyai/node_platform-api';
19
+
20
+ const instance: V1EnclosureShutterStatus = {
21
+ connected,
22
+ label,
23
+ motor,
24
+ positionPercent,
25
+ state,
26
+ };
27
+ ```
28
+
29
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,21 @@
1
+ # V1EnclosureShutterStatuses
2
+
3
+ Container object holding the status information for all shutter panels in the enclosure system. This provides a complete view of shutter states for monitoring and control decisions.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **statuses** | [**Array<V1EnclosureShutterStatus>**](V1EnclosureShutterStatus.md) | Array containing the status of each shutter panel in the enclosure. Typically contains entries for shutters A and B, though the number may vary by enclosure configuration. | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { V1EnclosureShutterStatuses } from '@ourskyai/node_platform-api';
15
+
16
+ const instance: V1EnclosureShutterStatuses = {
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
+ # V1EnclosureStatus
2
+
3
+ Contains the complete status information for the observatory enclosure including connectivity, operational state, and panel positions. This object provides all necessary information to determine if the enclosure is ready for observations.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **connected** | **boolean** | Indicates whether the enclosure controller is currently connected and communicating. A false value means commands cannot be sent to the enclosure system. | [default to undefined]
10
+ **frontPosition** | **number** | The current position of the front roof panel as encoder counts. Higher values indicate more open positions. Use this to track movement progress during open/close operations. | [default to undefined]
11
+ **rearPosition** | **number** | The current position of the rear roof panel as encoder counts. Higher values indicate more open positions. Use this to track movement progress during open/close operations. | [default to undefined]
12
+ **state** | [**EnclosureState**](EnclosureState.md) | | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { V1EnclosureStatus } from '@ourskyai/node_platform-api';
18
+
19
+ const instance: V1EnclosureStatus = {
20
+ connected,
21
+ frontPosition,
22
+ rearPosition,
23
+ state,
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
+ # V1EnclosureSystemSettings
2
+
3
+ Configuration settings for enclosure motion control including motor specific slew speed and acceleration limits.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **motorRotator** | [**V1EnclosureMotorSystemSettings**](V1EnclosureMotorSystemSettings.md) | | [optional] [default to undefined]
10
+ **motorShutter** | [**V1EnclosureMotorSystemSettings**](V1EnclosureMotorSystemSettings.md) | | [optional] [default to undefined]
11
+ **motorWindow** | [**V1EnclosureMotorSystemSettings**](V1EnclosureMotorSystemSettings.md) | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { V1EnclosureSystemSettings } from '@ourskyai/node_platform-api';
17
+
18
+ const instance: V1EnclosureSystemSettings = {
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
+ # V1EnclosureWindowStatus
2
+
3
+ Comprehensive status information for the observation window including connectivity, current angle position, and mount tracking state. Use this to verify proper window alignment for the current telescope elevation.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **connected** | **boolean** | Indicates whether the window controller is currently connected and responding to commands. A false value means the window cannot be moved or its position monitored. | [default to undefined]
10
+ **isSyncedWithMount** | **boolean** | Indicates whether the window is actively tracking the telescope mount elevation. When true, the window automatically adjusts to maintain optimal alignment with the telescope optical path. | [optional] [default to false]
11
+ **motor** | [**V1MotorStatus**](V1MotorStatus.md) | | [optional] [default to undefined]
12
+ **positionDegrees** | **number** | The current angular position of the observation window in degrees. This value corresponds to the elevation angle the window is optimized for, typically ranging from 0 (horizon) to 90 (zenith). | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { V1EnclosureWindowStatus } from '@ourskyai/node_platform-api';
18
+
19
+ const instance: V1EnclosureWindowStatus = {
20
+ connected,
21
+ isSyncedWithMount,
22
+ motor,
23
+ positionDegrees,
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
+ # V1EndSessionRequest
2
+
3
+ End a WebRTC Session
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **sessionId** | **string** | session ID | [default to undefined]
10
+ **type** | **string** | Type of message | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { V1EndSessionRequest } from '@ourskyai/node_platform-api';
16
+
17
+ const instance: V1EndSessionRequest = {
18
+ sessionId,
19
+ type,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # V1Event
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **data** | [**V1EventData**](V1EventData.md) | | [default to undefined]
9
+ **timestamp** | **string** | | [default to undefined]
10
+ **type** | [**EventType**](EventType.md) | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { V1Event } from '@ourskyai/node_platform-api';
16
+
17
+ const instance: V1Event = {
18
+ data,
19
+ timestamp,
20
+ type,
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)