@ourskyai/node_platform-api 1.4.123

package/docs/FocuserStatusUpdated.md

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

@@ -0,0 +1,22 @@
+# GenericEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GenericEventData } from '@ourskyai/node_platform-api';
+
+const instance: GenericEventData = {
+    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)

package/docs/GoToAltitudeAzimuthCompleted.md

@@ -0,0 +1,23 @@
+# GoToAltitudeAzimuthCompleted
+
+Event data for the successful completion of a slew to horizontal coordinates.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**altitude** | **number** | Achieved altitude angle above the horizon in degrees. | [default to undefined]
+**azimuth** | **number** | Achieved azimuth angle measured from north through east in degrees. | [default to undefined]
+
+## Example
+
+```typescript
+import { GoToAltitudeAzimuthCompleted } from '@ourskyai/node_platform-api';
+
+const instance: GoToAltitudeAzimuthCompleted = {
+    altitude,
+    azimuth,
+};
+```
+
+[[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/GoToAltitudeAzimuthFailed.md

@@ -0,0 +1,23 @@
+# GoToAltitudeAzimuthFailed
+
+Event data for a failed slew to horizontal coordinates. The mount did not reach the target position.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**altitude** | **number** | Target altitude that was not reached, in degrees. | [default to undefined]
+**azimuth** | **number** | Target azimuth that was not reached, in degrees. | [default to undefined]
+
+## Example
+
+```typescript
+import { GoToAltitudeAzimuthFailed } from '@ourskyai/node_platform-api';
+
+const instance: GoToAltitudeAzimuthFailed = {
+    altitude,
+    azimuth,
+};
+```
+
+[[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/GoToAltitudeAzimuthStarted.md

@@ -0,0 +1,23 @@
+# GoToAltitudeAzimuthStarted
+
+Event data for the start of a slew to horizontal coordinates.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**altitude** | **number** | Target altitude angle above the horizon in degrees. Range is 0 to 90 degrees. | [default to undefined]
+**azimuth** | **number** | Target azimuth angle measured from north through east in degrees. Range is 0 to 360 degrees. | [default to undefined]
+
+## Example
+
+```typescript
+import { GoToAltitudeAzimuthStarted } from '@ourskyai/node_platform-api';
+
+const instance: GoToAltitudeAzimuthStarted = {
+    altitude,
+    azimuth,
+};
+```
+
+[[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/GoToFilterWheelPositionEventData.md

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

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

@@ -0,0 +1,21 @@
+# GoToHomeCompleted
+
+Event data for the successful completion of a mount homing operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Optional message confirming successful homing completion. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GoToHomeCompleted } from '@ourskyai/node_platform-api';
+
+const instance: GoToHomeCompleted = {
+    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/GoToHomeFailed.md

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

@@ -0,0 +1,21 @@
+# GoToHomeStarted
+
+Event data for the start of a mount homing operation to find the reference position.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Optional message providing details about the homing operation being initiated. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GoToHomeStarted } from '@ourskyai/node_platform-api';
+
+const instance: GoToHomeStarted = {
+    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/GoToMechanicalCoordinatesCompleted.md

@@ -0,0 +1,23 @@
+# GoToMechanicalCoordinatesCompleted
+
+Event data for the successful completion of a move to mechanical encoder positions.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**altitude** | **number** | Achieved mechanical altitude encoder position in degrees. | [default to undefined]
+**azimuth** | **number** | Achieved mechanical azimuth encoder position in degrees. | [default to undefined]
+
+## Example
+
+```typescript
+import { GoToMechanicalCoordinatesCompleted } from '@ourskyai/node_platform-api';
+
+const instance: GoToMechanicalCoordinatesCompleted = {
+    altitude,
+    azimuth,
+};
+```
+
+[[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/GoToMechanicalCoordinatesFailed.md

@@ -0,0 +1,23 @@
+# GoToMechanicalCoordinatesFailed
+
+Event data for a failed move to mechanical encoder positions.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**altitude** | **number** | Target mechanical altitude position that was not reached, in degrees. | [default to undefined]
+**azimuth** | **number** | Target mechanical azimuth position that was not reached, in degrees. | [default to undefined]
+
+## Example
+
+```typescript
+import { GoToMechanicalCoordinatesFailed } from '@ourskyai/node_platform-api';
+
+const instance: GoToMechanicalCoordinatesFailed = {
+    altitude,
+    azimuth,
+};
+```
+
+[[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/GoToMechanicalCoordinatesStarted.md

@@ -0,0 +1,23 @@
+# GoToMechanicalCoordinatesStarted
+
+Event data for the start of a move to raw mechanical encoder positions, bypassing coordinate transformations.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**altitude** | **number** | Target mechanical altitude encoder position in degrees. | [default to undefined]
+**azimuth** | **number** | Target mechanical azimuth encoder position in degrees. | [default to undefined]
+
+## Example
+
+```typescript
+import { GoToMechanicalCoordinatesStarted } from '@ourskyai/node_platform-api';
+
+const instance: GoToMechanicalCoordinatesStarted = {
+    altitude,
+    azimuth,
+};
+```
+
+[[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/GoToMountCoordinatesEventData.md

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

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

@@ -0,0 +1,23 @@
+# GoToRaDecCompleted
+
+Event data for the successful completion of a slew to equatorial coordinates.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dec** | **number** | Achieved declination in decimal degrees. May differ slightly from target due to pointing model corrections. | [default to undefined]
+**ra** | **number** | Achieved right ascension in decimal degrees. May differ slightly from target due to pointing model corrections. | [default to undefined]
+
+## Example
+
+```typescript
+import { GoToRaDecCompleted } from '@ourskyai/node_platform-api';
+
+const instance: GoToRaDecCompleted = {
+    dec,
+    ra,
+};
+```
+
+[[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/GoToRaDecFailed.md

@@ -0,0 +1,23 @@
+# GoToRaDecFailed
+
+Event data for a failed slew to equatorial coordinates. The mount did not reach the target position.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dec** | **number** | Target declination that was not reached, in decimal degrees. | [default to undefined]
+**ra** | **number** | Target right ascension that was not reached, in decimal degrees. | [default to undefined]
+
+## Example
+
+```typescript
+import { GoToRaDecFailed } from '@ourskyai/node_platform-api';
+
+const instance: GoToRaDecFailed = {
+    dec,
+    ra,
+};
+```
+
+[[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/GoToRaDecStarted.md

@@ -0,0 +1,23 @@
+# GoToRaDecStarted
+
+Event data for the start of a slew to equatorial coordinates.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dec** | **number** | Target declination in decimal degrees. Range is -90 to +90 degrees. | [default to undefined]
+**ra** | **number** | Target right ascension in decimal degrees. Range is 0 to 360 degrees. | [default to undefined]
+
+## Example
+
+```typescript
+import { GoToRaDecStarted } from '@ourskyai/node_platform-api';
+
+const instance: GoToRaDecStarted = {
+    dec,
+    ra,
+};
+```
+
+[[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/GoToRotatorPositionEventData.md

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

@@ -0,0 +1,33 @@
+# GpsDataUpdated
+
+Event data for updated GPS location and timing information from the receiver.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**altitude** | **number** | Altitude above mean sea level in meters. | [default to undefined]
+**fix** | **number** | GPS fix quality indicator. 0 means no fix, 1 means 2D fix, 2 means 3D fix. Higher values indicate better positioning. | [default to undefined]
+**latitude** | **number** | Geographic latitude in decimal degrees. Positive values are North, negative are South. | [default to undefined]
+**longitude** | **number** | Geographic longitude in decimal degrees. Positive values are East, negative are West. | [default to undefined]
+**positionError** | **number** | Estimated horizontal position error in meters. Lower values indicate more accurate positioning. | [default to undefined]
+**satellitesUsed** | **number** | Number of satellites used in the position calculation. | [default to undefined]
+**satellitesVisible** | **number** | Total number of satellites visible to the GPS receiver. | [default to undefined]
+
+## Example
+
+```typescript
+import { GpsDataUpdated } from '@ourskyai/node_platform-api';
+
+const instance: GpsDataUpdated = {
+    altitude,
+    fix,
+    latitude,
+    longitude,
+    positionError,
+    satellitesUsed,
+    satellitesVisible,
+};
+```
+
+[[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/GpsDataUpdatedEventData.md

@@ -0,0 +1,32 @@
+# GpsDataUpdatedEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fix** | **number** |  | [default to undefined]
+**heightMeters** | **number** |  | [default to undefined]
+**latitudeDegrees** | **number** |  | [default to undefined]
+**longitudeDegrees** | **number** |  | [default to undefined]
+**positionErrorMeters** | **number** |  | [default to undefined]
+**satellitesUsed** | **number** |  | [default to undefined]
+**satellitesVisible** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GpsDataUpdatedEventData } from '@ourskyai/node_platform-api';
+
+const instance: GpsDataUpdatedEventData = {
+    fix,
+    heightMeters,
+    latitudeDegrees,
+    longitudeDegrees,
+    positionErrorMeters,
+    satellitesUsed,
+    satellitesVisible,
+};
+```
+
+[[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/HardwareDaemonLogged.md

@@ -0,0 +1,21 @@
+# HardwareDaemonLogged
+
+Event data for a log message from the hardware daemon. May contain diagnostic information, errors, or status updates from low-level hardware communication.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**log** | **string** | The log message content from the hardware daemon. May contain technical details useful for debugging hardware communication issues. | [default to undefined]
+
+## Example
+
+```typescript
+import { HardwareDaemonLogged } from '@ourskyai/node_platform-api';
+
+const instance: HardwareDaemonLogged = {
+    log,
+};
+```
+
+[[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/IceMessage.md

@@ -0,0 +1,26 @@
+# IceMessage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**candidate** | **string** | The ICE candidate | [default to undefined]
+**sdpMLineIndex** | **number** | Index of the media line | [default to undefined]
+**sdpMid** | **string** | Media stream ID | [optional] [default to undefined]
+**usernameFragment** | **string** | ICE username fragment | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { IceMessage } from '@ourskyai/node_platform-api';
+
+const instance: IceMessage = {
+    candidate,
+    sdpMLineIndex,
+    sdpMid,
+    usernameFragment,
+};
+```
+
+[[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/ImageFileFormat.md

@@ -0,0 +1,15 @@
+# ImageFileFormat
+
+Specifies the desired output format when downloading an image file. Each format serves different use cases from quick preview to full scientific analysis.
+
+## Enum
+
+* `JPEG` (value: `'JPEG'`)
+
+* `FITS` (value: `'FITS'`)
+
+* `RAW` (value: `'RAW'`)
+
+* `THUMBNAIL` (value: `'THUMBNAIL'`)
+
+[[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/JogEnclosureRotatorEventData.md

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

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

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

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