@ourskyai/node_platform-api 1.4.123

package/docs/AutofocusFailed.md

@@ -0,0 +1,21 @@
+# AutofocusFailed
+
+Event data for a failed autofocus routine.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Error message describing why the autofocus failed, such as insufficient stars, poor curve fit, or mechanical issues. | [default to undefined]
+
+## Example
+
+```typescript
+import { AutofocusFailed } from '@ourskyai/node_platform-api';
+
+const instance: AutofocusFailed = {
+    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/AutofocusFinished.md

@@ -0,0 +1,25 @@
+# AutofocusFinished
+
+Event data for the successful completion of an autofocus routine.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**focusPosition** | **number** | The optimal focus position determined by the autofocus routine, in focuser steps or encoder units. | [default to undefined]
+**pointsUsed** | **number** | Number of measurement points used in the final focus curve calculation. | [optional] [default to undefined]
+**rSquared** | **number** | The R-squared value of the focus curve fit, indicating how well the data fits the expected parabolic curve. Values closer to 1 indicate better fits. Null if not calculated. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AutofocusFinished } from '@ourskyai/node_platform-api';
+
+const instance: AutofocusFinished = {
+    focusPosition,
+    pointsUsed,
+    rSquared,
+};
+```
+
+[[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/AutofocusMethod.md

@@ -0,0 +1,13 @@
+# AutofocusMethod
+
+Algorithm used to measure focus quality during autofocus routines. FWHM (Full Width at Half Maximum) measures the diameter of star images at half their peak brightness - smaller values indicate sharper focus. HFR (Half Flux Radius) measures the radius containing half the star\'s total light - also minimized at best focus. CONTRAST measures image sharpness through edge detection - maximized at best focus. Use FWHM or HFR for point sources (stars), CONTRAST for extended objects. 
+
+## Enum
+
+* `FWHM` (value: `'FWHM'`)
+
+* `CONTRAST` (value: `'CONTRAST'`)
+
+* `HFR` (value: `'HFR'`)
+
+[[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/AutofocusPointAdded.md

@@ -0,0 +1,25 @@
+# AutofocusPointAdded
+
+Event data for an autofocus measurement point added during the focus optimization routine.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**focuserPosition** | **number** | Focuser position in steps or encoder units where this measurement was taken. | [default to undefined]
+**measurementMethod** | **string** | Method used to measure focus quality, such as HFR, FWHM, or contrast-based metrics. | [default to undefined]
+**measurementValue** | **number** | The measured focus quality value. Interpretation depends on the measurement method used. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AutofocusPointAdded } from '@ourskyai/node_platform-api';
+
+const instance: AutofocusPointAdded = {
+    focuserPosition,
+    measurementMethod,
+    measurementValue,
+};
+```
+
+[[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/AutofocusPointMeasuredEventData.md

@@ -0,0 +1,24 @@
+# AutofocusPointMeasuredEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**focuserPositionMicrons** | **number** |  | [default to undefined]
+**measurementMethod** | **string** |  | [default to undefined]
+**measurementValue** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AutofocusPointMeasuredEventData } from '@ourskyai/node_platform-api';
+
+const instance: AutofocusPointMeasuredEventData = {
+    focuserPositionMicrons,
+    measurementMethod,
+    measurementValue,
+};
+```
+
+[[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/AutofocusStarted.md

@@ -0,0 +1,29 @@
+# AutofocusStarted
+
+Event data for the start of an autofocus routine with configuration parameters.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**blind** | **boolean** | When true, performs a wide-range blind search for focus. When false, refines focus near the current position. | [default to undefined]
+**maxFocusPoints** | **number** | Maximum number of focus positions to sample during the autofocus routine. | [default to undefined]
+**method** | **string** | Focus measurement method being used, such as HFR, FWHM, or contrast-based analysis. | [default to undefined]
+**rSquaredThreshold** | **number** | Minimum R-squared value required for the focus curve fit to be considered successful. Range is 0 to 1. | [default to undefined]
+**stepMicrons** | **number** | Step size between focus measurement points in microns. Smaller steps provide finer resolution but require more time. | [default to undefined]
+
+## Example
+
+```typescript
+import { AutofocusStarted } from '@ourskyai/node_platform-api';
+
+const instance: AutofocusStarted = {
+    blind,
+    maxFocusPoints,
+    method,
+    rSquaredThreshold,
+    stepMicrons,
+};
+```
+
+[[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/CameraImageCaptured.md

@@ -0,0 +1,21 @@
+# CameraImageCaptured
+
+Event data for a completed image capture. Contains metadata about the captured image including storage location and capture parameters.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image** | [**V1Image**](V1Image.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CameraImageCaptured } from '@ourskyai/node_platform-api';
+
+const instance: CameraImageCaptured = {
+    image,
+};
+```
+
+[[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/CameraStatusUpdated.md

@@ -0,0 +1,25 @@
+# CameraStatusUpdated
+
+Event data for a camera status change. Indicates which camera changed state and its new connection status.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connectionStatus** | [**ConnectionStatus**](ConnectionStatus.md) |  | [default to undefined]
+**id** | **string** | Unique identifier for the camera that changed status. Used to distinguish between multiple cameras in the system. | [default to undefined]
+**name** | **string** | Human-readable name of the camera, such as the manufacturer and model or a user-assigned label. | [default to undefined]
+
+## Example
+
+```typescript
+import { CameraStatusUpdated } from '@ourskyai/node_platform-api';
+
+const instance: CameraStatusUpdated = {
+    connectionStatus,
+    id,
+    name,
+};
+```
+
+[[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/CameraTemperatureSet.md

@@ -0,0 +1,21 @@
+# CameraTemperatureSet
+
+Event data for a camera temperature setpoint change. Indicates the target temperature for the camera cooling system.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**celsius** | **number** | The new temperature setpoint in degrees Celsius. Negative values are common for cooled astronomical cameras to reduce thermal noise. | [default to undefined]
+
+## Example
+
+```typescript
+import { CameraTemperatureSet } from '@ourskyai/node_platform-api';
+
+const instance: CameraTemperatureSet = {
+    celsius,
+};
+```
+
+[[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/CancelAllTasksEventData.md

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

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

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

@@ -0,0 +1,29 @@
+# CaptureImageStarted
+
+Event data for the start of an image capture. Contains all exposure settings used for this capture.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**binning** | **number** | Pixel binning factor where adjacent pixels are combined. Higher binning reduces resolution but improves sensitivity and download speed. | [default to undefined]
+**exposure** | **number** | Exposure duration in seconds. Longer exposures collect more light but increase noise and trailing risk. | [default to undefined]
+**gain** | **number** | Camera gain setting controlling signal amplification. Higher values increase sensitivity but also increase noise. | [default to undefined]
+**gainMode** | **number** | Camera gain mode selection for cameras with multiple gain modes such as high dynamic range or low noise modes. | [default to undefined]
+**offset** | **number** | Camera offset or black level setting. Ensures the histogram does not clip at zero for proper calibration. | [default to undefined]
+
+## Example
+
+```typescript
+import { CaptureImageStarted } from '@ourskyai/node_platform-api';
+
+const instance: CaptureImageStarted = {
+    binning,
+    exposure,
+    gain,
+    gainMode,
+    offset,
+};
+```
+
+[[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/CaptureImagesContinuouslyEventData.md

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

@@ -0,0 +1,13 @@
+# ConnectionStatus
+
+Represents the connection state of a hardware component to the control system.
+
+## Enum
+
+* `CONNECTED` (value: `'CONNECTED'`)
+
+* `CONNECTING` (value: `'CONNECTING'`)
+
+* `NOT_CONNECTED` (value: `'NOT_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/CreateMountModelCompleted.md

@@ -0,0 +1,21 @@
+# CreateMountModelCompleted
+
+Event data for the successful completion of a pointing model calibration.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Optional message with calibration results such as the number of points used and accuracy achieved. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateMountModelCompleted } from '@ourskyai/node_platform-api';
+
+const instance: CreateMountModelCompleted = {
+    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/CreateMountModelFailed.md

@@ -0,0 +1,21 @@
+# CreateMountModelFailed
+
+Event data for a failed pointing model calibration sequence.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Error message describing why the calibration failed. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateMountModelFailed } from '@ourskyai/node_platform-api';
+
+const instance: CreateMountModelFailed = {
+    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/CreateMountModelStarted.md

@@ -0,0 +1,21 @@
+# CreateMountModelStarted
+
+Event data for the start of a pointing model calibration sequence.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Optional message describing the calibration parameters or configuration. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateMountModelStarted } from '@ourskyai/node_platform-api';
+
+const instance: CreateMountModelStarted = {
+    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/CycleRelaysEventData.md

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

@@ -0,0 +1,23 @@
+# DebugLogged
+
+Event data for a debug log entry useful for troubleshooting and diagnostics.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **string** | Full content of the debug message with detailed diagnostic information. | [default to undefined]
+**title** | **string** | Brief title or category of the debug message for quick identification. | [default to undefined]
+
+## Example
+
+```typescript
+import { DebugLogged } from '@ourskyai/node_platform-api';
+
+const instance: DebugLogged = {
+    body,
+    title,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)