@ourskyai/node_platform-api 1.4.123

package/docs/RelaysDiagnosisReport.md

@@ -0,0 +1,25 @@
+# RelaysDiagnosisReport
+
+Diagnostic results for the power relay controller used for equipment power management.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**canPowerCycleAstroCamera** | **boolean** | True if the relay can successfully cycle power to the astronomical camera for recovery purposes. | [optional] [default to undefined]
+**canPowerCycleMount** | **boolean** | True if the relay can successfully cycle power to the telescope mount for recovery purposes. | [optional] [default to undefined]
+**isConnected** | **boolean** | True if the relay controller board is connected and responding to commands. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RelaysDiagnosisReport } from '@ourskyai/node_platform-api';
+
+const instance: RelaysDiagnosisReport = {
+    canPowerCycleAstroCamera,
+    canPowerCycleMount,
+    isConnected,
+};
+```
+
+[[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/RelaysStatus.md

@@ -0,0 +1,21 @@
+# RelaysStatus
+
+Connection status of the relay controller board.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connected** | **boolean** | True if the relay controller is connected and responding to commands. | [default to undefined]
+
+## Example
+
+```typescript
+import { RelaysStatus } from '@ourskyai/node_platform-api';
+
+const instance: RelaysStatus = {
+    connected,
+};
+```
+
+[[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/RelaysUpdated.md

@@ -0,0 +1,23 @@
+# RelaysUpdated
+
+Event data for a change in relay controller state or individual relay states.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connectionStatus** | [**ConnectionStatus**](ConnectionStatus.md) |  | [default to undefined]
+**relays** | [**Array<V1Relay>**](V1Relay.md) | Array of all relay states showing the current on/off status of each controllable relay. | [default to undefined]
+
+## Example
+
+```typescript
+import { RelaysUpdated } from '@ourskyai/node_platform-api';
+
+const instance: RelaysUpdated = {
+    connectionStatus,
+    relays,
+};
+```
+
+[[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/ResetSystemSettingsToDefaultEventData.md

@@ -0,0 +1,20 @@
+# ResetSystemSettingsToDefaultEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameters** | [**V1ResetSystemSettingsToDefaultRequest**](V1ResetSystemSettingsToDefaultRequest.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ResetSystemSettingsToDefaultEventData } from '@ourskyai/node_platform-api';
+
+const instance: ResetSystemSettingsToDefaultEventData = {
+    parameters,
+};
+```
+
+[[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/RoofDiagnosisReport.md

@@ -0,0 +1,25 @@
+# RoofDiagnosisReport
+
+Diagnostic results for the roll-off roof or dome enclosure controller.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**canClose** | **boolean** | True if the roof or dome can successfully close to protect the telescope from weather. | [optional] [default to undefined]
+**canOpen** | **boolean** | True if the roof or dome can successfully open to expose the telescope to the sky. | [optional] [default to undefined]
+**isConnected** | **boolean** | True if the roof or dome controller is connected and responding to commands. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RoofDiagnosisReport } from '@ourskyai/node_platform-api';
+
+const instance: RoofDiagnosisReport = {
+    canClose,
+    canOpen,
+    isConnected,
+};
+```
+
+[[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/RoofState.md

@@ -0,0 +1,31 @@
+# RoofState
+
+Represents the current operational state of the roll-off roof system (deprecated, see EnclosureState). OPENED indicates the roof is fully retracted and the sky is accessible. CLOSED indicates the roof is fully closed and sealed. ROOF_ERROR indicates an error condition requiring investigation and resolution. PARKING_MOUNT indicates the mount is being parked before roof operation can proceed. UNKNOWN indicates the state cannot be determined, possibly due to communication issues. MOVING_OPEN_FRONT indicates the front panel is currently retracting. MOVING_CLOSE_FRONT indicates the front panel is currently closing. HOMING_FRONT indicates the front panel is performing a position calibration sequence. HOMING_REAR indicates the rear panel is performing a position calibration sequence. MOVING_OPEN_REAR indicates the rear panel is currently retracting. MOVING_CLOSE_REAR indicates the rear panel is currently closing. HALTED indicates all motion was stopped by a halt command. 
+
+## Enum
+
+* `OPENED` (value: `'OPENED'`)
+
+* `CLOSED` (value: `'CLOSED'`)
+
+* `ROOF_ERROR` (value: `'ROOF_ERROR'`)
+
+* `PARKING_MOUNT` (value: `'PARKING_MOUNT'`)
+
+* `UNKNOWN` (value: `'UNKNOWN'`)
+
+* `MOVING_OPEN_FRONT` (value: `'MOVING_OPEN_FRONT'`)
+
+* `MOVING_CLOSE_FRONT` (value: `'MOVING_CLOSE_FRONT'`)
+
+* `HOMING_FRONT` (value: `'HOMING_FRONT'`)
+
+* `HOMING_REAR` (value: `'HOMING_REAR'`)
+
+* `MOVING_OPEN_REAR` (value: `'MOVING_OPEN_REAR'`)
+
+* `MOVING_CLOSE_REAR` (value: `'MOVING_CLOSE_REAR'`)
+
+* `HALTED` (value: `'HALTED'`)
+
+[[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/RoofStatus.md

@@ -0,0 +1,21 @@
+# RoofStatus
+
+Connection status of the roll-off roof or dome controller.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connected** | **boolean** | True if the roof or dome controller is connected and responding to commands. | [default to undefined]
+
+## Example
+
+```typescript
+import { RoofStatus } from '@ourskyai/node_platform-api';
+
+const instance: RoofStatus = {
+    connected,
+};
+```
+
+[[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/RoofUpdated.md

@@ -0,0 +1,23 @@
+# RoofUpdated
+
+Event data for a change in roll-off roof or dome state.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connectionStatus** | [**ConnectionStatus**](ConnectionStatus.md) |  | [default to undefined]
+**roof** | [**V1RoofStatus**](V1RoofStatus.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RoofUpdated } from '@ourskyai/node_platform-api';
+
+const instance: RoofUpdated = {
+    connectionStatus,
+    roof,
+};
+```
+
+[[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/RotatorPosition.md

@@ -0,0 +1,23 @@
+# RotatorPosition
+
+Current rotator position expressed in both mechanical and sky coordinate frames for comprehensive position information.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mechanicalAngleDegrees** | **number** | Current physical rotator angle in degrees. This is the actual motor position independent of sky orientation. Typically ranges from 0 to 360 degrees. | [default to undefined]
+**skyAngleDegrees** | **number** | Current position angle relative to celestial north in degrees. This value changes as the telescope tracks across the sky even if the mechanical position is fixed. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RotatorPosition } from '@ourskyai/node_platform-api';
+
+const instance: RotatorPosition = {
+    mechanicalAngleDegrees,
+    skyAngleDegrees,
+};
+```
+
+[[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/RotatorStatusUpdated.md

@@ -0,0 +1,21 @@
+# RotatorStatusUpdated
+
+Event data for a rotator status change. Indicates the new connection state of the field rotator.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connectionStatus** | [**ConnectionStatus**](ConnectionStatus.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RotatorStatusUpdated } from '@ourskyai/node_platform-api';
+
+const instance: RotatorStatusUpdated = {
+    connectionStatus,
+};
+```
+
+[[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/RotatorTargetType.md

@@ -0,0 +1,11 @@
+# RotatorTargetType
+
+Specifies the coordinate frame for the rotator target position. MECHANICAL refers to the physical rotator position independent of sky orientation. SKY refers to the position angle relative to celestial north, which changes as the telescope tracks across the sky.
+
+## Enum
+
+* `MECHANICAL` (value: `'MECHANICAL'`)
+
+* `SKY` (value: `'SKY'`)
+
+[[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/RunAutofocusEventData.md

@@ -0,0 +1,20 @@
+# RunAutofocusEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameters** | [**V1RunAutofocusRequest**](V1RunAutofocusRequest.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RunAutofocusEventData } from '@ourskyai/node_platform-api';
+
+const instance: RunAutofocusEventData = {
+    parameters,
+};
+```
+
+[[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/SafetyStatusUpdated.md

@@ -0,0 +1,21 @@
+# SafetyStatusUpdated
+
+Event data for a change in the safety system status, possibly due to an alert condition or interlock state change.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**safetyStatus** | [**V1SafetyStatus**](V1SafetyStatus.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SafetyStatusUpdated } from '@ourskyai/node_platform-api';
+
+const instance: SafetyStatusUpdated = {
+    safetyStatus,
+};
+```
+
+[[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/SaveImageEventData.md

@@ -0,0 +1,20 @@
+# SaveImageEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameters** | [**V1SaveImageRequest**](V1SaveImageRequest.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SaveImageEventData } from '@ourskyai/node_platform-api';
+
+const instance: SaveImageEventData = {
+    parameters,
+};
+```
+
+[[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/SaveVideoEventData.md

@@ -0,0 +1,20 @@
+# SaveVideoEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameters** | [**V1SaveVideoRequest**](V1SaveVideoRequest.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SaveVideoEventData } from '@ourskyai/node_platform-api';
+
+const instance: SaveVideoEventData = {
+    parameters,
+};
+```
+
+[[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/SdpMessage.md

@@ -0,0 +1,22 @@
+# SdpMessage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sdp** | **string** | The SDP context | [default to undefined]
+**type** | **string** | Type of message | [default to undefined]
+
+## Example
+
+```typescript
+import { SdpMessage } from '@ourskyai/node_platform-api';
+
+const instance: SdpMessage = {
+    sdp,
+    type,
+};
+```
+
+[[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/SetEnclosureHvacFanSpeedEventData.md

@@ -0,0 +1,20 @@
+# SetEnclosureHvacFanSpeedEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameters** | [**V1SetEnclosureHvacFanSpeedRequest**](V1SetEnclosureHvacFanSpeedRequest.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SetEnclosureHvacFanSpeedEventData } from '@ourskyai/node_platform-api';
+
+const instance: SetEnclosureHvacFanSpeedEventData = {
+    parameters,
+};
+```
+
+[[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/SetEnclosureHvacModeEventData.md

@@ -0,0 +1,20 @@
+# SetEnclosureHvacModeEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameters** | [**V1SetEnclosureHvacModeRequest**](V1SetEnclosureHvacModeRequest.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SetEnclosureHvacModeEventData } from '@ourskyai/node_platform-api';
+
+const instance: SetEnclosureHvacModeEventData = {
+    parameters,
+};
+```
+
+[[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/SetEnclosureHvacTargetTemperatureEventData.md

@@ -0,0 +1,20 @@
+# SetEnclosureHvacTargetTemperatureEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameters** | [**V1SetEnclosureHvacTargetTemperatureRequest**](V1SetEnclosureHvacTargetTemperatureRequest.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SetEnclosureHvacTargetTemperatureEventData } from '@ourskyai/node_platform-api';
+
+const instance: SetEnclosureHvacTargetTemperatureEventData = {
+    parameters,
+};
+```
+
+[[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/SetMountParkPositionEventData.md

@@ -0,0 +1,20 @@
+# SetMountParkPositionEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameters** | [**V1SetMountParkPositionRequest**](V1SetMountParkPositionRequest.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SetMountParkPositionEventData } from '@ourskyai/node_platform-api';
+
+const instance: SetMountParkPositionEventData = {
+    parameters,
+};
+```
+
+[[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/SetOpticalTubeHeaterPowerEventData.md

@@ -0,0 +1,20 @@
+# SetOpticalTubeHeaterPowerEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameters** | [**V1SetOpticalTubeHeaterPowerRequest**](V1SetOpticalTubeHeaterPowerRequest.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SetOpticalTubeHeaterPowerEventData } from '@ourskyai/node_platform-api';
+
+const instance: SetOpticalTubeHeaterPowerEventData = {
+    parameters,
+};
+```
+
+[[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/SlewDemoEnabled.md

@@ -0,0 +1,21 @@
+# SlewDemoEnabled
+
+Event data for enabling or disabling slew demonstration mode.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **boolean** | True if slew demo mode was enabled, false if it was disabled. | [default to undefined]
+
+## Example
+
+```typescript
+import { SlewDemoEnabled } from '@ourskyai/node_platform-api';
+
+const instance: SlewDemoEnabled = {
+    enabled,
+};
+```
+
+[[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/StackedAstroImageGeneratedEventData.md

@@ -0,0 +1,20 @@
+# StackedAstroImageGeneratedEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stackedAstroImage** | [**V1StackedAstroImage**](V1StackedAstroImage.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { StackedAstroImageGeneratedEventData } from '@ourskyai/node_platform-api';
+
+const instance: StackedAstroImageGeneratedEventData = {
+    stackedAstroImage,
+};
+```
+
+[[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/StarMeasurementFailed.md

@@ -0,0 +1,21 @@
+# StarMeasurementFailed
+
+Event data for a failed star measurement operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Error message describing why the star measurement failed, such as no stars detected or poor image quality. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StarMeasurementFailed } from '@ourskyai/node_platform-api';
+
+const instance: StarMeasurementFailed = {
+    message,
+};
+```
+
+[[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/StarMeasurementStarted.md

@@ -0,0 +1,21 @@
+# StarMeasurementStarted
+
+Event data for the start of a star measurement operation to analyze image quality.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Optional message describing the measurement parameters or target. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StarMeasurementStarted } from '@ourskyai/node_platform-api';
+
+const instance: StarMeasurementStarted = {
+    message,
+};
+```
+
+[[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/StarsMeasured.md

@@ -0,0 +1,25 @@
+# StarsMeasured
+
+Event data for successful star measurements containing image quality metrics.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** | Number of stars detected and measured in the image. More stars generally provide more reliable statistics. | [default to undefined]
+**hfr** | **number** | Mean half-flux radius of measured stars in pixels. Lower values indicate better focus and seeing conditions. | [default to undefined]
+**hfrStdDev** | **number** | Standard deviation of HFR measurements in pixels. Lower values indicate more consistent star shapes across the image. | [default to undefined]
+
+## Example
+
+```typescript
+import { StarsMeasured } from '@ourskyai/node_platform-api';
+
+const instance: StarsMeasured = {
+    count,
+    hfr,
+    hfrStdDev,
+};
+```
+
+[[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/StartupWizardStep.md

@@ -0,0 +1,25 @@
+# StartupWizardStep
+
+Event data for progress through a startup wizard sequence.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**step** | **number** | The current step number in the startup wizard sequence. Starts at 1 and increments with each completed step. | [default to undefined]
+**taskId** | **string** | Unique identifier for the task associated with this wizard step. | [default to undefined]
+**type** | [**V1TaskType**](V1TaskType.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { StartupWizardStep } from '@ourskyai/node_platform-api';
+
+const instance: StartupWizardStep = {
+    step,
+    taskId,
+    type,
+};
+```
+
+[[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/StopCapturingImagesContinuouslyEventData.md

@@ -0,0 +1,20 @@
+# StopCapturingImagesContinuouslyEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameters** | [**V1StopCapturingImagesContinuouslyRequest**](V1StopCapturingImagesContinuouslyRequest.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { StopCapturingImagesContinuouslyEventData } from '@ourskyai/node_platform-api';
+
+const instance: StopCapturingImagesContinuouslyEventData = {
+    parameters,
+};
+```
+
+[[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/StopRecordingVideoEventData.md

@@ -0,0 +1,20 @@
+# StopRecordingVideoEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameters** | [**V1StopRecordingVideoRequest**](V1StopRecordingVideoRequest.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { StopRecordingVideoEventData } from '@ourskyai/node_platform-api';
+
+const instance: StopRecordingVideoEventData = {
+    parameters,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)