@ourskyai/node_platform-api 1.4.123

package/docs/V1AddMountModelPointHereRequest.md

@@ -0,0 +1,23 @@
+# V1AddMountModelPointHereRequest
+
+Request to manually add a calibration point to the pointing model. The node combines the supplied plate-solved J2000 coordinates with the mount current mechanical position to build the new point.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**decDegrees** | **number** | Plate-solved declination at the mount current mechanical position in degrees (J2000 epoch). Range is -90 to +90 degrees. | [default to undefined]
+**raDegrees** | **number** | Plate-solved right ascension at the mount current mechanical position in degrees (J2000 epoch). Range is 0 to 360 degrees. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1AddMountModelPointHereRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1AddMountModelPointHereRequest = {
+    decDegrees,
+    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/V1AllSkyClassification.md

@@ -0,0 +1,23 @@
+# V1AllSkyClassification
+
+Machine learning classification result for an all-sky image. Contains both the predicted sky condition label and a confidence score indicating how certain the model is about its prediction.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**confidence** | **number** | Model confidence score ranging from 0.0 to 1.0. Higher values indicate greater certainty in the classification. A score above 0.8 typically indicates a reliable prediction. | [default to undefined]
+**label** | [**V1AllSkyClassificationLabel**](V1AllSkyClassificationLabel.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1AllSkyClassification } from '@ourskyai/node_platform-api';
+
+const instance: V1AllSkyClassification = {
+    confidence,
+    label,
+};
+```
+
+[[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/V1AllSkyClassificationLabel.md

@@ -0,0 +1,17 @@
+# V1AllSkyClassificationLabel
+
+Machine learning classification label indicating the sky condition observed in an all-sky image. These labels are determined by analyzing the image for cloud coverage and precipitation indicators.
+
+## Enum
+
+* `CLEAR` (value: `'CLEAR'`)
+
+* `LIGHT_CLOUDS` (value: `'LIGHT_CLOUDS'`)
+
+* `HEAVY_CLOUDS` (value: `'HEAVY_CLOUDS'`)
+
+* `PRECIPITATION` (value: `'PRECIPITATION'`)
+
+* `UNKNOWN` (value: `'UNKNOWN'`)
+
+[[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/V1AllSkyImage.md

@@ -0,0 +1,29 @@
+# V1AllSkyImage
+
+An all-sky camera image combined with its weather classification. Provides both the standard image metadata and the machine learning analysis of sky conditions at the time of capture.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**classification** | [**V1AllSkyClassification**](V1AllSkyClassification.md) |  | [default to undefined]
+**createdAt** | **string** | ISO 8601 timestamp indicating when this all-sky image was generated. Used for pagination with the before parameter. | [default to undefined]
+**id** | **string** | Unique identifier for this all-sky image. Use this ID for any all-sky image specific operations or references. | [default to undefined]
+**image** | [**V1Image**](V1Image.md) |  | [default to undefined]
+**sourceType** | [**V1AllSkySourceType**](V1AllSkySourceType.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1AllSkyImage } from '@ourskyai/node_platform-api';
+
+const instance: V1AllSkyImage = {
+    classification,
+    createdAt,
+    id,
+    image,
+    sourceType,
+};
+```
+
+[[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/V1AllSkyImages.md

@@ -0,0 +1,21 @@
+# V1AllSkyImages
+
+Container object holding a paginated list of all-sky images with their weather classifications. Use the before parameter with the last image\'s createdAt timestamp to retrieve the next page.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**allSkyImages** | [**Array<V1AllSkyImage>**](V1AllSkyImage.md) | Array of all-sky image objects sorted by creation time in descending order (newest first). Each object includes both image metadata and weather classification results. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1AllSkyImages } from '@ourskyai/node_platform-api';
+
+const instance: V1AllSkyImages = {
+    allSkyImages,
+};
+```
+
+[[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/V1AllSkyKeogram.md

@@ -0,0 +1,31 @@
+# V1AllSkyKeogram
+
+Metadata for an all-sky keogram image. A keogram is a composite image created by extracting and stacking a vertical slice from each all-sky image over time, showing how sky conditions evolved throughout an observing period in a single image.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdAt** | **string** | ISO 8601 timestamp indicating when this keogram was generated. Used for pagination with the before parameter. | [default to undefined]
+**description** | **string** | Human-readable description of the keogram, typically including the date range and a summary of weather conditions observed. | [default to undefined]
+**endedAt** | **string** | ISO 8601 timestamp of the last all-sky image included in this keogram, representing the right edge of the composite. | [default to undefined]
+**id** | **string** | Unique identifier for this keogram image. Use this ID for any keogram-specific operations or references. | [default to undefined]
+**image** | [**V1Image**](V1Image.md) |  | [default to undefined]
+**startedAt** | **string** | ISO 8601 timestamp of the first all-sky image included in this keogram, representing the left edge of the composite. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1AllSkyKeogram } from '@ourskyai/node_platform-api';
+
+const instance: V1AllSkyKeogram = {
+    createdAt,
+    description,
+    endedAt,
+    id,
+    image,
+    startedAt,
+};
+```
+
+[[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/V1AllSkyKeograms.md

@@ -0,0 +1,21 @@
+# V1AllSkyKeograms
+
+Container object holding a paginated list of all-sky keogram images. Use the before parameter with the last keogram\'s createdAt timestamp to retrieve the next page.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**allSkyKeograms** | [**Array<V1AllSkyKeogram>**](V1AllSkyKeogram.md) | Array of keogram metadata objects sorted by creation time in descending order (newest first). | [default to undefined]
+
+## Example
+
+```typescript
+import { V1AllSkyKeograms } from '@ourskyai/node_platform-api';
+
+const instance: V1AllSkyKeograms = {
+    allSkyKeograms,
+};
+```
+
+[[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/V1AllSkySourceType.md

@@ -0,0 +1,11 @@
+# V1AllSkySourceType
+
+Indicates whether an all-sky image was captured by a visible-light or thermal camera.
+
+## Enum
+
+* `VISIBLE` (value: `'VISIBLE'`)
+
+* `THERMAL` (value: `'THERMAL'`)
+
+[[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/V1AllSkyTimelapse.md

@@ -0,0 +1,33 @@
+# V1AllSkyTimelapse
+
+Metadata for an all-sky timelapse video. Timelapses are compiled from sequential all-sky images and show sky conditions changing over time, useful for reviewing weather patterns and identifying observing windows.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdAt** | **string** | ISO 8601 timestamp indicating when this timelapse was generated. Used for pagination with the before parameter. | [default to undefined]
+**description** | **string** | Human-readable description of the timelapse, typically including the date range and any notable weather events observed. | [default to undefined]
+**endedAt** | **string** | ISO 8601 timestamp of the last all-sky image included in this timelapse sequence. | [default to undefined]
+**id** | **string** | Unique identifier for this timelapse video. Use this ID for any timelapse-specific operations or references. | [default to undefined]
+**sourceType** | [**V1AllSkySourceType**](V1AllSkySourceType.md) |  | [optional] [default to undefined]
+**startedAt** | **string** | ISO 8601 timestamp of the first all-sky image included in this timelapse sequence. | [default to undefined]
+**video** | [**V1Video**](V1Video.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1AllSkyTimelapse } from '@ourskyai/node_platform-api';
+
+const instance: V1AllSkyTimelapse = {
+    createdAt,
+    description,
+    endedAt,
+    id,
+    sourceType,
+    startedAt,
+    video,
+};
+```
+
+[[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/V1AllSkyTimelapses.md

@@ -0,0 +1,21 @@
+# V1AllSkyTimelapses
+
+Container object holding a paginated list of all-sky timelapse videos. Use the before parameter with the last timelapse\'s createdAt timestamp to retrieve the next page.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**allSkyTimelapses** | [**Array<V1AllSkyTimelapse>**](V1AllSkyTimelapse.md) | Array of timelapse video metadata objects sorted by creation time in descending order (newest first). | [default to undefined]
+
+## Example
+
+```typescript
+import { V1AllSkyTimelapses } from '@ourskyai/node_platform-api';
+
+const instance: V1AllSkyTimelapses = {
+    allSkyTimelapses,
+};
+```
+
+[[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/V1AppendMountTrackPathRequest.md

@@ -0,0 +1,29 @@
+# V1AppendMountTrackPathRequest
+
+Request to append control points to the current custom path tracking session. Provide exactly one sample array matching frame.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**altAzSamples** | [**Array<V1MountTrackPathAltAzSample>**](V1MountTrackPathAltAzSample.md) |  | [optional] [default to undefined]
+**enuSamples** | [**Array<V1MountTrackPathEnuSample>**](V1MountTrackPathEnuSample.md) |  | [optional] [default to undefined]
+**frame** | [**V1MountTrackPathFrame**](V1MountTrackPathFrame.md) |  | [default to undefined]
+**raDecSamples** | [**Array<V1MountTrackPathRaDecSample>**](V1MountTrackPathRaDecSample.md) |  | [optional] [default to undefined]
+**trackingSessionId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1AppendMountTrackPathRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1AppendMountTrackPathRequest = {
+    altAzSamples,
+    enuSamples,
+    frame,
+    raDecSamples,
+    trackingSessionId,
+};
+```
+
+[[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/V1AstroImage.md

@@ -0,0 +1,29 @@
+# V1AstroImage
+
+Complete metadata for a captured astro image including exposure settings, timing information, and plate solve results. Use this object to understand the capture parameters and retrieve associated image files.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdAt** | **string** | ISO 8601 timestamp indicating when this image record was created in the database. Used for pagination with the before parameter. | [default to undefined]
+**decJ2000Degrees** | **number** | Declination J2000 degrees of the image center in decimal degrees (-90 to +90), populated when plate solving succeeds. Represents the celestial latitude coordinate in the equatorial coordinate system. | [optional] [default to undefined]
+**id** | **string** | Unique identifier for this image. Use this ID with the file endpoint to download the actual image data or with other image-related operations. | [default to undefined]
+**image** | [**V1Image**](V1Image.md) |  | [default to undefined]
+**raJ2000Degrees** | **number** | Right Ascension J2000 degrees of the image center in decimal degrees (0-360), populated when plate solving succeeds. Represents the celestial longitude coordinate in the equatorial coordinate system. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1AstroImage } from '@ourskyai/node_platform-api';
+
+const instance: V1AstroImage = {
+    createdAt,
+    decJ2000Degrees,
+    id,
+    image,
+    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/V1AstroImages.md

@@ -0,0 +1,21 @@
+# V1AstroImages
+
+Container object holding a paginated list of astro images. Use the before parameter with the last image\'s createdAt timestamp to retrieve the next page of results.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**astroImages** | [**Array<V1AstroImage>**](V1AstroImage.md) | Array of image metadata objects sorted by creation time in descending order (newest first). May be empty if no images match the query criteria. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1AstroImages } from '@ourskyai/node_platform-api';
+
+const instance: V1AstroImages = {
+    astroImages,
+};
+```
+
+[[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/V1CameraFunction.md

@@ -0,0 +1,19 @@
+# V1CameraFunction
+
+The operational role assigned to a camera, determining how it is used within the system.
+
+## Enum
+
+* `ASTRO` (value: `'ASTRO'`)
+
+* `ALL_SKY` (value: `'ALL_SKY'`)
+
+* `WIDEFOV_MONITORING` (value: `'WIDEFOV_MONITORING'`)
+
+* `WAVEFRONT_SENSOR` (value: `'WAVEFRONT_SENSOR'`)
+
+* `STAR_TRACKER` (value: `'STAR_TRACKER'`)
+
+* `UNKNOWN` (value: `'UNKNOWN'`)
+
+[[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/V1CameraSelectorRequest.md

@@ -0,0 +1,21 @@
+# V1CameraSelectorRequest
+
+Optional camera selector. If omitted, the default camera is used.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cameraId** | **string** | Unique identifier of the camera to use. Obtain valid camera IDs from the camera statuses endpoint. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CameraSelectorRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1CameraSelectorRequest = {
+    cameraId,
+};
+```
+
+[[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/V1CameraStatus.md

@@ -0,0 +1,39 @@
+# V1CameraStatus
+
+Represents the current status and hardware specifications of a single camera. Contains both static properties like sensor dimensions and dynamic properties like connection state and temperature.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cameraFunction** | [**V1CameraFunction**](V1CameraFunction.md) |  | [optional] [default to undefined]
+**connected** | **boolean** | Indicates whether the camera is currently connected and communicating with the system. A value of false means the camera was previously detected but is now unavailable. | [default to undefined]
+**hasGps** | **boolean** | Indicates whether the camera has an integrated GPS receiver for automatic location and timestamp data. When true, captured images may include GPS metadata. | [default to undefined]
+**id** | **string** | Unique identifier for the camera within the system. Use this ID when specifying which camera to use for capture operations. | [default to undefined]
+**isCapturingImagesContinuously** | **boolean** | Is the camera currently capturing continuous frames? | [optional] [default to undefined]
+**name** | **string** | Human-readable name or model identifier of the camera as reported by the device driver. | [default to undefined]
+**pixelSizeMicrons** | **number** | Physical size of each pixel on the sensor in microns. Used for calculating image scale and field of view when combined with focal length. | [default to undefined]
+**sensorHeight** | **number** | Total height of the camera sensor in pixels. Represents the maximum vertical resolution available for imaging. | [default to undefined]
+**sensorWidth** | **number** | Total width of the camera sensor in pixels. Represents the maximum horizontal resolution available for imaging. | [default to undefined]
+**temperature** | **number** | Current temperature of the camera sensor in degrees Celsius. Monitor this value to ensure the sensor is operating within optimal thermal range. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CameraStatus } from '@ourskyai/node_platform-api';
+
+const instance: V1CameraStatus = {
+    cameraFunction,
+    connected,
+    hasGps,
+    id,
+    isCapturingImagesContinuously,
+    name,
+    pixelSizeMicrons,
+    sensorHeight,
+    sensorWidth,
+    temperature,
+};
+```
+
+[[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/V1CameraStatuses.md

@@ -0,0 +1,21 @@
+# V1CameraStatuses
+
+Container object holding the list of all camera statuses. Provides a complete snapshot of all cameras currently recognized by the system.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statuses** | [**Array<V1CameraStatus>**](V1CameraStatus.md) | Array of camera status objects, one for each camera connected to the node. May be empty if no cameras are detected. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CameraStatuses } from '@ourskyai/node_platform-api';
+
+const instance: V1CameraStatuses = {
+    statuses,
+};
+```
+
+[[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/V1CancelAllTasksRequest.md

@@ -0,0 +1,21 @@
+# V1CancelAllTasksRequest
+
+Request to cancel all active tasks with an optional graceful shutdown period.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**gracefulShutdownSeconds** | **number** | Number of seconds to wait for tasks to complete their current operations before forcefully terminating. A longer timeout allows tasks to finish cleanly. Defaults to immediate cancellation if not specified. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CancelAllTasksRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1CancelAllTasksRequest = {
+    gracefulShutdownSeconds,
+};
+```
+
+[[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/V1CancelTaskRequest.md

@@ -0,0 +1,23 @@
+# V1CancelTaskRequest
+
+Request to cancel a specific task by its identifier.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**gracefulShutdownSeconds** | **number** | Number of seconds to wait for the task to complete its current operation before forcefully terminating. Use a higher value for tasks that should complete their current step cleanly. Defaults to immediate cancellation if not specified. | [optional] [default to undefined]
+**taskId** | **string** | Unique identifier of the task to cancel. Obtain this ID from the tasks list endpoint or from the response when a task was created. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CancelTaskRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1CancelTaskRequest = {
+    gracefulShutdownSeconds,
+    taskId,
+};
+```
+
+[[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/V1CaptureImageRequest.md

@@ -0,0 +1,39 @@
+# V1CaptureImageRequest
+
+DEPRECATED request object for image capture. Use V2CaptureImageRequest instead for new integrations. Contains exposure settings and optional region of interest parameters.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**binning** | **number** | Pixel binning factor that combines adjacent pixels. A value of 1 means no binning, 2 combines 2x2 pixels, etc. | [default to undefined]
+**cameraId** | **string** | Unique identifier of the camera to use for capture. If omitted, the system uses the default or primary camera. | [optional] [default to undefined]
+**exposure** | **number** | Exposure duration in seconds. Longer exposures collect more light but increase the risk of star trailing without tracking. | [default to undefined]
+**gain** | **number** | Sensor gain setting that controls signal amplification. Higher values increase sensitivity but also increase noise. | [default to undefined]
+**gainMode** | **number** | Gain mode selector for cameras supporting multiple gain modes such as high conversion gain. Default value of 1 represents standard mode. | [default to 1]
+**offset** | **number** | Sensor offset or black level setting that adjusts the baseline signal level to prevent clipping of faint signals. | [default to undefined]
+**roiHeight** | **number** | Height in pixels of the region of interest for sub-frame capture. | [optional] [default to undefined]
+**roiStartX** | **number** | Starting X coordinate in pixels for region of interest capture, measured from the left edge of the sensor. | [optional] [default to undefined]
+**roiStartY** | **number** | Starting Y coordinate in pixels for region of interest capture, measured from the top edge of the sensor. | [optional] [default to undefined]
+**roiWidth** | **number** | Width in pixels of the region of interest for sub-frame capture. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CaptureImageRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1CaptureImageRequest = {
+    binning,
+    cameraId,
+    exposure,
+    gain,
+    gainMode,
+    offset,
+    roiHeight,
+    roiStartX,
+    roiStartY,
+    roiWidth,
+};
+```
+
+[[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/V1CaptureImagesContinuouslyRequest.md

@@ -0,0 +1,39 @@
+# V1CaptureImagesContinuouslyRequest
+
+Request object for starting a continuous image capture session. Contains exposure settings and optional region of interest parameters that will be applied to each frame in the sequence.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**binning** | **number** | Pixel binning factor for all frames. Higher binning reduces resolution but increases sensitivity and frame rate, which can be useful for focusing or preview. | [default to undefined]
+**cameraId** | **string** | Unique identifier of the camera to use for continuous capture. If omitted, the system uses the default camera. Only one continuous capture session can be active per camera. | [optional] [default to undefined]
+**exposure** | **number** | Exposure duration in seconds for each frame in the continuous capture sequence. Shorter exposures enable higher frame rates for live preview. The actual frame rate depends on this value plus sensor readout time. | [default to undefined]
+**gain** | **number** | Sensor gain setting applied to all frames in the continuous capture. Higher values increase sensitivity but also increase noise in each frame. | [default to undefined]
+**gainMode** | **number** | Gain mode selector for cameras supporting multiple gain modes. This setting remains constant throughout the continuous capture session. | [default to 1]
+**offset** | **number** | Sensor offset or black level setting applied to all frames in the sequence. Maintains consistent baseline levels throughout the capture session. | [default to undefined]
+**roiHeight** | **number** | Height in pixels of the region of interest. Reducing this value decreases data throughput and can increase achievable frame rate. | [optional] [default to undefined]
+**roiStartX** | **number** | Starting X coordinate in pixels for region of interest capture. Using a smaller ROI can significantly increase frame rate for continuous capture. | [optional] [default to undefined]
+**roiStartY** | **number** | Starting Y coordinate in pixels for region of interest capture. Combined with other ROI parameters to define the capture area. | [optional] [default to undefined]
+**roiWidth** | **number** | Width in pixels of the region of interest. Reducing this value decreases data throughput and can increase achievable frame rate. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CaptureImagesContinuouslyRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1CaptureImagesContinuouslyRequest = {
+    binning,
+    cameraId,
+    exposure,
+    gain,
+    gainMode,
+    offset,
+    roiHeight,
+    roiStartX,
+    roiStartY,
+    roiWidth,
+};
+```
+
+[[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/V1ConnectedCamera.md

@@ -0,0 +1,23 @@
+# V1ConnectedCamera
+
+DEPRECATED basic camera information object. Contains minimal identification data for a connected camera. For detailed camera specifications, use V1CameraStatus instead.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for the camera within the system. Use this ID when specifying which camera to use for capture operations. | [default to undefined]
+**name** | **string** | Human-readable name or model identifier of the camera as reported by the device driver. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1ConnectedCamera } from '@ourskyai/node_platform-api';
+
+const instance: V1ConnectedCamera = {
+    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/V1CreateMountModelRequest.md

@@ -0,0 +1,31 @@
+# V1CreateMountModelRequest
+
+Configuration parameters for creating a new pointing model. These settings control the camera exposure during plate solving at each calibration point. Number of points attempted is azimuth points * altitude points, with a minimum of 4 successful points required to save the mount model.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**altitudePoints** | **number** | Number of different altitude points to try between 30 and 90 degrees. Minimum 2, maximum 4 required if specified. | [optional] [default to undefined]
+**azimuthPoints** | **number** | Number of different azimuth points to try around 360 degree sphere. Minimum 2, maximum 8 if specified. | [optional] [default to undefined]
+**binning** | **number** | Camera binning factor (e.g., 1 for no binning, 2 for 2x2 binning). Higher binning reduces resolution but increases sensitivity and download speed. | [default to undefined]
+**exposure** | **number** | Camera exposure time in seconds for each plate solve image. Longer exposures capture more stars but increase model creation time. | [default to undefined]
+**gain** | **number** | Camera gain setting for plate solve images. Higher values increase sensitivity but also increase noise. Use values appropriate for your camera model. | [default to undefined]
+**offset** | **number** | Camera offset (bias) setting for plate solve images. Adjusts the black level to prevent clipping. Use values appropriate for your camera model. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateMountModelRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1CreateMountModelRequest = {
+    altitudePoints,
+    azimuthPoints,
+    binning,
+    exposure,
+    gain,
+    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/V1CycleRelaysRequest.md

@@ -0,0 +1,23 @@
+# V1CycleRelaysRequest
+
+Request parameters for power cycling one or more relay channels (deprecated). Specify which channels to cycle and the off-duration for the reset.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channels** | [**Array<RelayChannel>**](RelayChannel.md) | Array of relay channels to power cycle. All specified channels will be cycled simultaneously. Include only the equipment that needs to be reset. | [default to undefined]
+**durationSeconds** | **number** | The duration in seconds to keep the relays powered off before restoring power. Typical values range from 5 to 30 seconds depending on equipment boot requirements. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CycleRelaysRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1CycleRelaysRequest = {
+    channels,
+    durationSeconds,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)