@ourskyai/node_platform-api 1.4.123

package/docs/KernelLogEntryDetectedEventData.md

@@ -0,0 +1,22 @@
+# KernelLogEntryDetectedEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to undefined]
+**priority** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { KernelLogEntryDetectedEventData } from '@ourskyai/node_platform-api';
+
+const instance: KernelLogEntryDetectedEventData = {
+    message,
+    priority,
+};
+```
+
+[[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/MessageType.md

@@ -0,0 +1,22 @@
+# MessageType
+
+
+## Enum
+
+* `LIST` (value: `'list'`)
+
+* `PEER` (value: `'peer'`)
+
+* `SET_PEER_STATUS` (value: `'setPeerStatus'`)
+
+* `SESSION_STARTED` (value: `'sessionStarted'`)
+
+* `END_SESSION` (value: `'endSession'`)
+
+* `PEER_STATUS_CHANGED` (value: `'peerStatusChanged'`)
+
+* `WELCOME` (value: `'welcome'`)
+
+* `ERROR` (value: `'error'`)
+
+[[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/MessageTypeWrapper.md

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

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

@@ -0,0 +1,24 @@
+# MotorFaultDetectedEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**faultCode** | **string** |  | [default to undefined]
+**faultMessage** | **string** |  | [default to undefined]
+**motorRole** | [**V1MotorRole**](V1MotorRole.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MotorFaultDetectedEventData } from '@ourskyai/node_platform-api';
+
+const instance: MotorFaultDetectedEventData = {
+    faultCode,
+    faultMessage,
+    motorRole,
+};
+```
+
+[[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/MotorFaulted.md

@@ -0,0 +1,25 @@
+# MotorFaulted
+
+Event data for a motor fault condition requiring attention. Motors in fault state will not respond to commands until the fault is cleared.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**faultCode** | **string** | Stable machine-readable fault identifier for programmatic handling. Use this code for automated fault response logic. | [default to undefined]
+**faultMessage** | **string** | Human-readable diagnostic message explaining the fault condition and potential remediation steps. | [default to undefined]
+**motor** | [**V1Motor**](V1Motor.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MotorFaulted } from '@ourskyai/node_platform-api';
+
+const instance: MotorFaulted = {
+    faultCode,
+    faultMessage,
+    motor,
+};
+```
+
+[[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/MotorFaultsCleared.md

@@ -0,0 +1,21 @@
+# MotorFaultsCleared
+
+Event data indicating motor faults have been cleared and the motor can resume normal operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**motor** | [**V1Motor**](V1Motor.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MotorFaultsCleared } from '@ourskyai/node_platform-api';
+
+const instance: MotorFaultsCleared = {
+    motor,
+};
+```
+
+[[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/MountDiagnosisReport.md

@@ -0,0 +1,27 @@
+# MountDiagnosisReport
+
+Diagnostic results for the telescope mount including connectivity and motion capability tests.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**canHome** | **boolean** | True if the mount can successfully execute a homing operation to find its reference position. | [optional] [default to undefined]
+**canPark** | **boolean** | True if the mount can successfully move to and engage its parked position for safe storage. | [optional] [default to undefined]
+**canSlew** | **boolean** | True if the mount can successfully perform slew movements to target coordinates. | [optional] [default to undefined]
+**isConnected** | **boolean** | True if the mount is connected and responding to commands. This is the prerequisite for all other mount tests. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MountDiagnosisReport } from '@ourskyai/node_platform-api';
+
+const instance: MountDiagnosisReport = {
+    canHome,
+    canPark,
+    canSlew,
+    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/MountFollowTLEEventData.md

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

@@ -0,0 +1,27 @@
+# MountModelPointAdded
+
+Event data for a successfully added calibration point in the pointing model.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**altitude** | **number** | Altitude coordinate of the calibration point in degrees. | [default to undefined]
+**azimuth** | **number** | Azimuth coordinate of the calibration point in degrees. | [default to undefined]
+**dec** | **number** | Solved declination of the calibration point in decimal degrees. | [default to undefined]
+**ra** | **number** | Solved right ascension of the calibration point in decimal degrees. | [default to undefined]
+
+## Example
+
+```typescript
+import { MountModelPointAdded } from '@ourskyai/node_platform-api';
+
+const instance: MountModelPointAdded = {
+    altitude,
+    azimuth,
+    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/MountModelPointAddedEventData.md

@@ -0,0 +1,26 @@
+# MountModelPointAddedEventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**altitudeDegrees** | **number** |  | [default to undefined]
+**azimuthDegrees** | **number** |  | [default to undefined]
+**decJ2000Degrees** | **number** |  | [optional] [default to undefined]
+**raJ2000Degrees** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MountModelPointAddedEventData } from '@ourskyai/node_platform-api';
+
+const instance: MountModelPointAddedEventData = {
+    altitudeDegrees,
+    azimuthDegrees,
+    decJ2000Degrees,
+    raJ2000Degrees,
+};
+```
+
+[[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/MountModelPointFailed.md

@@ -0,0 +1,23 @@
+# MountModelPointFailed
+
+Event data for a failed calibration point that could not be added to the pointing model.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**altitude** | **number** | Altitude coordinate where the calibration point was attempted, in degrees. | [optional] [default to undefined]
+**azimuth** | **number** | Azimuth coordinate where the calibration point was attempted, in degrees. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MountModelPointFailed } from '@ourskyai/node_platform-api';
+
+const instance: MountModelPointFailed = {
+    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/MountStatusUpdated.md

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

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

@@ -0,0 +1,21 @@
+# OperationStatusUpdated
+
+Event data for a change in the system operation mode such as switching between autonomous, assisted, and manual modes.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operationStatus** | [**V1SystemOperationStatus**](V1SystemOperationStatus.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { OperationStatusUpdated } from '@ourskyai/node_platform-api';
+
+const instance: OperationStatusUpdated = {
+    operationStatus,
+};
+```
+
+[[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/OpticalTubeStatus.md

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

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

@@ -0,0 +1,24 @@
+# Peer
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cameraId** | **string** | Optional camera identifier for multi-camera nodes | [optional] [default to undefined]
+**id** | **string** | peer ID | [optional] [default to undefined]
+**meta** | **{ [key: string]: string; }** | Optional metadata map | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Peer } from '@ourskyai/node_platform-api';
+
+const instance: Peer = {
+    cameraId,
+    id,
+    meta,
+};
+```
+
+[[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/PeerRole.md

@@ -0,0 +1,10 @@
+# PeerRole
+
+
+## Enum
+
+* `PRODUCER` (value: `'PRODUCER'`)
+
+* `LISTENER` (value: `'LISTENER'`)
+
+[[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/PlaceholderEventData.md

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

@@ -0,0 +1,25 @@
+# PlateSolveCompleted
+
+Event data for a successful astrometric plate solve. Contains the determined celestial coordinates and optical parameters.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**decDegrees** | **number** | Declination of the image center in decimal degrees. Range is -90 to +90 degrees. | [default to undefined]
+**focalLength** | **number** | Calculated effective focal length of the optical system in millimeters based on the plate scale. | [default to undefined]
+**raDegrees** | **number** | Right ascension of the image center in decimal degrees. Range is 0 to 360 degrees. | [default to undefined]
+
+## Example
+
+```typescript
+import { PlateSolveCompleted } from '@ourskyai/node_platform-api';
+
+const instance: PlateSolveCompleted = {
+    decDegrees,
+    focalLength,
+    raDegrees,
+};
+```
+
+[[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/PlateSolveFailed.md

@@ -0,0 +1,21 @@
+# PlateSolveFailed
+
+Event data for a failed plate solve operation where no astrometric solution was found.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ignoreCoordinates** | **boolean** | Indicates whether the failed solve attempt ignored mount coordinates. If false and the solve failed, a blind solve retry may succeed. | [default to undefined]
+
+## Example
+
+```typescript
+import { PlateSolveFailed } from '@ourskyai/node_platform-api';
+
+const instance: PlateSolveFailed = {
+    ignoreCoordinates,
+};
+```
+
+[[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/PlateSolveStarted.md

@@ -0,0 +1,21 @@
+# PlateSolveStarted
+
+Event data for the start of an astrometric plate solve operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ignoreCoordinates** | **boolean** | When true, the plate solver performs a blind solve without using mount coordinates as a hint. This is slower but works even if the mount pointing is significantly off. | [default to undefined]
+
+## Example
+
+```typescript
+import { PlateSolveStarted } from '@ourskyai/node_platform-api';
+
+const instance: PlateSolveStarted = {
+    ignoreCoordinates,
+};
+```
+
+[[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/PlatformConnectionDiagnosisReport.md

@@ -0,0 +1,21 @@
+# PlatformConnectionDiagnosisReport
+
+Diagnostic results for the network connection to the cloud platform backend.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**canGetNode** | **boolean** | True if the edge controller can successfully communicate with the platform API and retrieve node information. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlatformConnectionDiagnosisReport } from '@ourskyai/node_platform-api';
+
+const instance: PlatformConnectionDiagnosisReport = {
+    canGetNode,
+};
+```
+
+[[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/Point2D.md

@@ -0,0 +1,22 @@
+# Point2D
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**x** | **number** |  | [default to undefined]
+**y** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Point2D } from '@ourskyai/node_platform-api';
+
+const instance: Point2D = {
+    x,
+    y,
+};
+```
+
+[[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/RecordVideoEventData.md

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

@@ -0,0 +1,21 @@
+# RelayChannel
+
+Legacy identifier for relay channels controlling observatory equipment (deprecated, see RelayFunction). MOUNT controls power to the telescope mount for tracking and slewing operations. UNIFI controls power to UniFi networking equipment such as switches and access points. PRIMARY_CAMERA controls power to the main imaging camera used for astronomical observations. UNIFI_PROTECT controls power to UniFi Protect security camera systems. WEATHER_STATION controls power to the local weather monitoring station. NODE_CONTROLLER controls power to the observatory node controller. FOCUSER controls power to the telescope focuser mechanism. 
+
+## Enum
+
+* `MOUNT` (value: `'MOUNT'`)
+
+* `UNIFI` (value: `'UNIFI'`)
+
+* `PRIMARY_CAMERA` (value: `'PRIMARY_CAMERA'`)
+
+* `UNIFI_PROTECT` (value: `'UNIFI_PROTECT'`)
+
+* `WEATHER_STATION` (value: `'WEATHER_STATION'`)
+
+* `NODE_CONTROLLER` (value: `'NODE_CONTROLLER'`)
+
+* `FOCUSER` (value: `'FOCUSER'`)
+
+[[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/RelayFunction.md

@@ -0,0 +1,29 @@
+# RelayFunction
+
+Identifies the equipment function controlled by each power relay. MOUNT controls power to the telescope mount for tracking and slewing. NETWORK controls power to networking equipment such as switches and routers. PRIMARY_CAMERA controls power to the main imaging camera used for observations. SECURITY_CAMERA controls power to security and monitoring cameras. WEATHER_STATION controls power to the local weather monitoring station. EDGE_CONTROLLER controls power to the edge computing controller. FOCUSER controls power to the telescope focuser mechanism. ENCLOSURE controls power to the enclosure motors and controller. DEHUMIDIFIER controls power to the integrated dehumidifier in an enclosure (if applicable) HVAC controls power to the integrated HVAC system in an enclosure (if applicable) CUSTOMER_ELECTRONICS controls power to a switch from which _all_ customer electronics are powered (if applicable) 
+
+## Enum
+
+* `MOUNT` (value: `'MOUNT'`)
+
+* `NETWORK` (value: `'NETWORK'`)
+
+* `PRIMARY_CAMERA` (value: `'PRIMARY_CAMERA'`)
+
+* `SECURITY_CAMERA` (value: `'SECURITY_CAMERA'`)
+
+* `WEATHER_STATION` (value: `'WEATHER_STATION'`)
+
+* `EDGE_CONTROLLER` (value: `'EDGE_CONTROLLER'`)
+
+* `FOCUSER` (value: `'FOCUSER'`)
+
+* `ENCLOSURE` (value: `'ENCLOSURE'`)
+
+* `DEHUMIDIFIER` (value: `'DEHUMIDIFIER'`)
+
+* `HVAC` (value: `'HVAC'`)
+
+* `CUSTOMER_ELECTRONICS` (value: `'CUSTOMER_ELECTRONICS'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)