@ourskyai/node_platform-api 1.4.158 → 1.4.188
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +12 -1
- package/README.md +24 -4
- package/api.ts +1057 -50
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +593 -39
- package/dist/api.js +691 -31
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +593 -39
- package/dist/esm/api.js +690 -30
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/DefaultApi.md +506 -9
- package/docs/OpticalTrainComponentType.md +17 -0
- package/docs/SystemEventData.md +4 -0
- package/docs/V1CreateOpticalTrainRequest.md +31 -0
- package/docs/V1MotorStatus.md +2 -0
- package/docs/V1OpticalTrain.md +31 -0
- package/docs/V1OpticalTrainStatus.md +31 -0
- package/docs/V1OpticalTrainStatuses.md +21 -0
- package/docs/V1OpticalTrains.md +21 -0
- package/docs/V1OpticalTubeCoverSelectorRequest.md +3 -3
- package/docs/V1OpticalTubeStatus.md +1 -1
- package/docs/{V1OpticalTubeTemperatureSensorStatuses.md → V1OpticalTubeTemperatureSensorGroupStatus.md} +6 -4
- package/docs/V1OpticalTubeTemperatureSensorGroupStatuses.md +21 -0
- package/docs/V1SystemMetricsCollection.md +1 -1
- package/docs/V1TaskType.md +3 -1
- package/docs/V1UnassociatedOpticalTrainComponent.md +23 -0
- package/docs/V1UnassociatedOpticalTrainComponents.md +21 -0
- package/docs/V1UpdateOpticalTrainRequest.md +31 -0
- package/docs/V2SystemEventType.md +4 -0
- package/docs/V2SystemStatus.md +37 -0
- package/index.ts +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# OpticalTrainComponentType
|
|
2
|
+
|
|
3
|
+
Type of optical train component.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `CAMERA` (value: `'CAMERA'`)
|
|
8
|
+
|
|
9
|
+
* `FOCUSER` (value: `'FOCUSER'`)
|
|
10
|
+
|
|
11
|
+
* `ROTATOR` (value: `'ROTATOR'`)
|
|
12
|
+
|
|
13
|
+
* `FILTER_WHEEL` (value: `'FILTER_WHEEL'`)
|
|
14
|
+
|
|
15
|
+
* `OPTICAL_TUBE` (value: `'OPTICAL_TUBE'`)
|
|
16
|
+
|
|
17
|
+
[[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/SystemEventData.md
CHANGED
|
@@ -12,10 +12,12 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**autofocusPointMeasured** | [**AutofocusPointMeasuredEventData**](AutofocusPointMeasuredEventData.md) | | [optional] [default to undefined]
|
|
13
13
|
**calibrateEnclosureRotator** | [**PlaceholderEventData**](PlaceholderEventData.md) | | [optional] [default to undefined]
|
|
14
14
|
**calibrateEnclosureWindow** | [**PlaceholderEventData**](PlaceholderEventData.md) | | [optional] [default to undefined]
|
|
15
|
+
**calibrateMountMotorAUnwinder** | [**PlaceholderEventData**](PlaceholderEventData.md) | | [optional] [default to undefined]
|
|
15
16
|
**cancelAllTasks** | [**CancelAllTasksEventData**](CancelAllTasksEventData.md) | | [optional] [default to undefined]
|
|
16
17
|
**cancelTask** | [**CancelTaskEventData**](CancelTaskEventData.md) | | [optional] [default to undefined]
|
|
17
18
|
**captureImage** | [**CaptureImageEventData**](CaptureImageEventData.md) | | [optional] [default to undefined]
|
|
18
19
|
**captureImagesContinuously** | [**CaptureImagesContinuouslyEventData**](CaptureImagesContinuouslyEventData.md) | | [optional] [default to undefined]
|
|
20
|
+
**clearEnclosureRotatorMotorLockout** | [**PlaceholderEventData**](PlaceholderEventData.md) | | [optional] [default to undefined]
|
|
19
21
|
**closeEnclosureShutters** | [**PlaceholderEventData**](PlaceholderEventData.md) | | [optional] [default to undefined]
|
|
20
22
|
**closeOpticalTubeCover** | [**PlaceholderEventData**](PlaceholderEventData.md) | | [optional] [default to undefined]
|
|
21
23
|
**createElevationMask** | [**PlaceholderEventData**](PlaceholderEventData.md) | | [optional] [default to undefined]
|
|
@@ -118,10 +120,12 @@ const instance: SystemEventData = {
|
|
|
118
120
|
autofocusPointMeasured,
|
|
119
121
|
calibrateEnclosureRotator,
|
|
120
122
|
calibrateEnclosureWindow,
|
|
123
|
+
calibrateMountMotorAUnwinder,
|
|
121
124
|
cancelAllTasks,
|
|
122
125
|
cancelTask,
|
|
123
126
|
captureImage,
|
|
124
127
|
captureImagesContinuously,
|
|
128
|
+
clearEnclosureRotatorMotorLockout,
|
|
125
129
|
closeEnclosureShutters,
|
|
126
130
|
closeOpticalTubeCover,
|
|
127
131
|
createElevationMask,
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# V1CreateOpticalTrainRequest
|
|
2
|
+
|
|
3
|
+
Request to create an optical train configuration.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**filterWheelId** | **string** | Unique identifier of the filter wheel to assign to this optical train. | [optional] [default to undefined]
|
|
10
|
+
**focuserId** | **string** | Unique identifier of the focuser to assign to this optical train. | [optional] [default to undefined]
|
|
11
|
+
**label** | **string** | Human-readable label for the optical train. | [default to undefined]
|
|
12
|
+
**m3Port** | **number** | M3 port to assign to this optical train, when the optical tube has an M3 port selector. | [optional] [default to undefined]
|
|
13
|
+
**opticalTubeId** | **string** | Unique identifier of the optical tube to assign to this optical train. | [default to undefined]
|
|
14
|
+
**rotatorId** | **string** | Unique identifier of the rotator to assign to this optical train. | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { V1CreateOpticalTrainRequest } from '@ourskyai/node_platform-api';
|
|
20
|
+
|
|
21
|
+
const instance: V1CreateOpticalTrainRequest = {
|
|
22
|
+
filterWheelId,
|
|
23
|
+
focuserId,
|
|
24
|
+
label,
|
|
25
|
+
m3Port,
|
|
26
|
+
opticalTubeId,
|
|
27
|
+
rotatorId,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[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/V1MotorStatus.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**isEmergencyStopPressed** | **boolean** | Indicates whether the emergency stop signal is active for this motor. When true, the motor is inhibited from any movement. | [default to undefined]
|
|
15
15
|
**isEnabled** | **boolean** | Indicates whether the motor is enabled and ready to accept motion commands. Motors must be enabled before movement can occur. | [default to undefined]
|
|
16
16
|
**measuredVelocityDegreesPerSecond** | **number** | Current measured angular velocity of the motor in degrees per second. | [default to undefined]
|
|
17
|
+
**motorLockoutActive** | **boolean** | Indicates whether the motor controller is in a latched lockout state that prevents motion until the lockout is explicitly cleared. | [optional] [default to undefined]
|
|
17
18
|
**positionDegrees** | **number** | Current angular position of the motor axis in degrees. This is the raw motor position before any corrections are applied. | [default to undefined]
|
|
18
19
|
|
|
19
20
|
## Example
|
|
@@ -30,6 +31,7 @@ const instance: V1MotorStatus = {
|
|
|
30
31
|
isEmergencyStopPressed,
|
|
31
32
|
isEnabled,
|
|
32
33
|
measuredVelocityDegreesPerSecond,
|
|
34
|
+
motorLockoutActive,
|
|
33
35
|
positionDegrees,
|
|
34
36
|
};
|
|
35
37
|
```
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# V1OpticalTrain
|
|
2
|
+
|
|
3
|
+
Optical train configuration and assigned component identifiers.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**filterWheelId** | **string** | Unique identifier of the filter wheel assigned to this optical train. | [optional] [default to undefined]
|
|
10
|
+
**focuserId** | **string** | Unique identifier of the focuser assigned to this optical train. | [optional] [default to undefined]
|
|
11
|
+
**label** | **string** | Human-readable label for this optical train. | [default to undefined]
|
|
12
|
+
**m3Port** | **number** | M3 port used by this optical train, when the optical tube has an M3 port selector. | [optional] [default to undefined]
|
|
13
|
+
**opticalTubeId** | **string** | Unique identifier of the optical tube assigned to this optical train. | [default to undefined]
|
|
14
|
+
**rotatorId** | **string** | Unique identifier of the rotator assigned to this optical train. | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { V1OpticalTrain } from '@ourskyai/node_platform-api';
|
|
20
|
+
|
|
21
|
+
const instance: V1OpticalTrain = {
|
|
22
|
+
filterWheelId,
|
|
23
|
+
focuserId,
|
|
24
|
+
label,
|
|
25
|
+
m3Port,
|
|
26
|
+
opticalTubeId,
|
|
27
|
+
rotatorId,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# V1OpticalTrainStatus
|
|
2
|
+
|
|
3
|
+
Status of one optical train and the components currently associated with it.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**camera** | [**V1CameraStatus**](V1CameraStatus.md) | | [optional] [default to undefined]
|
|
10
|
+
**filterWheel** | [**V1FilterWheelStatus**](V1FilterWheelStatus.md) | | [optional] [default to undefined]
|
|
11
|
+
**focuser** | [**V1FocuserStatus**](V1FocuserStatus.md) | | [optional] [default to undefined]
|
|
12
|
+
**label** | **string** | Human-readable label for this optical train. | [optional] [default to undefined]
|
|
13
|
+
**opticalTube** | [**V1OpticalTubeStatus**](V1OpticalTubeStatus.md) | | [optional] [default to undefined]
|
|
14
|
+
**rotator** | [**V1RotatorStatus**](V1RotatorStatus.md) | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { V1OpticalTrainStatus } from '@ourskyai/node_platform-api';
|
|
20
|
+
|
|
21
|
+
const instance: V1OpticalTrainStatus = {
|
|
22
|
+
camera,
|
|
23
|
+
filterWheel,
|
|
24
|
+
focuser,
|
|
25
|
+
label,
|
|
26
|
+
opticalTube,
|
|
27
|
+
rotator,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1OpticalTrainStatuses
|
|
2
|
+
|
|
3
|
+
Container object holding the status of all configured optical trains.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**statuses** | [**Array<V1OpticalTrainStatus>**](V1OpticalTrainStatus.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpticalTrainStatuses } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpticalTrainStatuses = {
|
|
17
|
+
statuses,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1OpticalTrains
|
|
2
|
+
|
|
3
|
+
Container object holding all configured optical trains.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**opticalTrains** | [**Array<V1OpticalTrain>**](V1OpticalTrain.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpticalTrains } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpticalTrains = {
|
|
17
|
+
opticalTrains,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# V1OpticalTubeCoverSelectorRequest
|
|
2
2
|
|
|
3
|
-
Optional optical tube selector. If omitted, the default optical tube is used.
|
|
3
|
+
Optional optical tube cover selector. If omitted, the default optical tube cover is used.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**
|
|
9
|
+
**opticalTubeCoverId** | **string** | Unique identifier of the optical tube cover to command. Obtain valid optical tube cover IDs from the optical tube cover statuses endpoint. | [optional] [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
import { V1OpticalTubeCoverSelectorRequest } from '@ourskyai/node_platform-api';
|
|
15
15
|
|
|
16
16
|
const instance: V1OpticalTubeCoverSelectorRequest = {
|
|
17
|
-
|
|
17
|
+
opticalTubeCoverId,
|
|
18
18
|
};
|
|
19
19
|
```
|
|
20
20
|
|
|
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**heaters** | [**V1OpticalTubeHeaterGroupStatus**](V1OpticalTubeHeaterGroupStatus.md) | | [optional] [default to undefined]
|
|
12
12
|
**id** | **string** | Unique identifier of the optical tube within the system. | [optional] [default to undefined]
|
|
13
13
|
**m3** | [**V1OpticalTubeM3Status**](V1OpticalTubeM3Status.md) | | [optional] [default to undefined]
|
|
14
|
-
**temperatureSensors** | [**
|
|
14
|
+
**temperatureSensors** | [**V1OpticalTubeTemperatureSensorGroupStatus**](V1OpticalTubeTemperatureSensorGroupStatus.md) | | [optional] [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -1,19 +1,21 @@
|
|
|
1
|
-
#
|
|
1
|
+
# V1OpticalTubeTemperatureSensorGroupStatus
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Temperature sensor statuses for a specific optical tube.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique identifier of the optical tube within the system. Null when the status source does not provide component IDs. | [optional] [default to undefined]
|
|
9
10
|
**statuses** | [**Array<V1OpticalTubeTemperatureSensorStatus>**](V1OpticalTubeTemperatureSensorStatus.md) | Array of temperature readings, one for each sensor in the optical tube assembly. | [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
13
14
|
```typescript
|
|
14
|
-
import {
|
|
15
|
+
import { V1OpticalTubeTemperatureSensorGroupStatus } from '@ourskyai/node_platform-api';
|
|
15
16
|
|
|
16
|
-
const instance:
|
|
17
|
+
const instance: V1OpticalTubeTemperatureSensorGroupStatus = {
|
|
18
|
+
id,
|
|
17
19
|
statuses,
|
|
18
20
|
};
|
|
19
21
|
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1OpticalTubeTemperatureSensorGroupStatuses
|
|
2
|
+
|
|
3
|
+
Collection of temperature sensor statuses grouped by optical tube.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**statuses** | [**Array<V1OpticalTubeTemperatureSensorGroupStatus>**](V1OpticalTubeTemperatureSensorGroupStatus.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1OpticalTubeTemperatureSensorGroupStatuses } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1OpticalTubeTemperatureSensorGroupStatuses = {
|
|
17
|
+
statuses,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,7 +6,7 @@ A compact collection of measurements for a metric identity. Each measurement is
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**metrics** | **Array<Array<
|
|
9
|
+
**metrics** | **Array<Array<number>>** | Measurements encoded as fixed two-item numeric arrays. Index 0 is measuredAt as a Unix epoch millisecond timestamp; index 1 is the measurement value as a double. | [default to undefined]
|
|
10
10
|
**name** | **string** | The metric identifier that describes what is being measured, such as cpu_temperature or mount_position_altitude. | [default to undefined]
|
|
11
11
|
**tags** | [**Array<V1SystemMetricTag>**](V1SystemMetricTag.md) | Additional metadata tags that provide context for this metric, enabling filtering by component, sensor, or other dimensions. | [default to undefined]
|
|
12
12
|
**type** | [**V1SystemMetricType**](V1SystemMetricType.md) | | [default to undefined]
|
package/docs/V1TaskType.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# V1TaskType
|
|
2
2
|
|
|
3
|
-
Type classification for system tasks. CREATE_MOUNT_MODEL builds a pointing model by measuring and correcting for mount alignment errors. CREATE_ELEVATION_MASK generates a horizon obstruction map for the observatory location. CALIBRATE_ENCLOSURE_ROTATOR measures the enclosure rotator to mount azimuth relationship and persists the resulting mount offset. CALIBRATE_ENCLOSURE_WINDOW sweeps the enclosure window through its full motion range to derive and persist motor counts per revolution. RUN_AUTOFOCUS executes an automated focus optimization routine. RUN_PERPETUAL_INSTRUCTION_LOOP continuously executes observation sequences. STARTUP_WIZARD guides initial telescope setup and configuration. SET_CAMERA_TEMPERATURE manages camera cooling to target temperature. ENGAGE_ADHOC_DEPLOYMENT activates portable operation mode. RUN_SLEW_DEMO performs a demonstration slew sequence. TAKE_CALIBRATION_FRAMES captures bias, dark, or flat calibration images. RUN_LIVE_STACKING_SESSION runs a live stacking session. RUN_STARY_PARTY runs a star party
|
|
3
|
+
Type classification for system tasks. CREATE_MOUNT_MODEL builds a pointing model by measuring and correcting for mount alignment errors. CREATE_ELEVATION_MASK generates a horizon obstruction map for the observatory location. CALIBRATE_ENCLOSURE_ROTATOR measures the enclosure rotator to mount azimuth relationship and persists the resulting mount offset. CALIBRATE_ENCLOSURE_WINDOW sweeps the enclosure window through its full motion range to derive and persist motor counts per revolution. CALIBRATE_MOUNT_MOTOR_A_UNWINDER sweeps mount motor A to infer and persist the absolute encoder unwinder configuration. RUN_AUTOFOCUS executes an automated focus optimization routine. RUN_PERPETUAL_INSTRUCTION_LOOP continuously executes observation sequences. STARTUP_WIZARD guides initial telescope setup and configuration. SET_CAMERA_TEMPERATURE manages camera cooling to target temperature. ENGAGE_ADHOC_DEPLOYMENT activates portable operation mode. RUN_SLEW_DEMO performs a demonstration slew sequence. TAKE_CALIBRATION_FRAMES captures bias, dark, or flat calibration images. RUN_LIVE_STACKING_SESSION runs a live stacking session. RUN_STARY_PARTY runs a star party
|
|
4
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
|
@@ -12,6 +12,8 @@ Type classification for system tasks. CREATE_MOUNT_MODEL builds a pointing model
|
|
|
12
12
|
|
|
13
13
|
* `CALIBRATE_ENCLOSURE_WINDOW` (value: `'CALIBRATE_ENCLOSURE_WINDOW'`)
|
|
14
14
|
|
|
15
|
+
* `CALIBRATE_MOUNT_MOTOR_A_UNWINDER` (value: `'CALIBRATE_MOUNT_MOTOR_A_UNWINDER'`)
|
|
16
|
+
|
|
15
17
|
* `RUN_AUTOFOCUS` (value: `'RUN_AUTOFOCUS'`)
|
|
16
18
|
|
|
17
19
|
* `RUN_PERPETUAL_INSTRUCTION_LOOP` (value: `'RUN_PERPETUAL_INSTRUCTION_LOOP'`)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# V1UnassociatedOpticalTrainComponent
|
|
2
|
+
|
|
3
|
+
Optical train component that is not currently attached to an optical train.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique identifier of the unassociated component. | [default to undefined]
|
|
10
|
+
**type** | [**OpticalTrainComponentType**](OpticalTrainComponentType.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1UnassociatedOpticalTrainComponent } from '@ourskyai/node_platform-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1UnassociatedOpticalTrainComponent = {
|
|
18
|
+
id,
|
|
19
|
+
type,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# V1UnassociatedOpticalTrainComponents
|
|
2
|
+
|
|
3
|
+
Container object holding optical train components that are not currently attached to an optical train.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**statuses** | [**Array<V1UnassociatedOpticalTrainComponent>**](V1UnassociatedOpticalTrainComponent.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1UnassociatedOpticalTrainComponents } from '@ourskyai/node_platform-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1UnassociatedOpticalTrainComponents = {
|
|
17
|
+
statuses,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# V1UpdateOpticalTrainRequest
|
|
2
|
+
|
|
3
|
+
Request to update an optical train configuration.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**filterWheelId** | **string** | Unique identifier of the filter wheel to assign to this optical train. | [optional] [default to undefined]
|
|
10
|
+
**focuserId** | **string** | Unique identifier of the focuser to assign to this optical train. | [optional] [default to undefined]
|
|
11
|
+
**label** | **string** | Human-readable label of the optical train to update. | [default to undefined]
|
|
12
|
+
**m3Port** | **number** | M3 port to assign to this optical train, when the optical tube has an M3 port selector. | [optional] [default to undefined]
|
|
13
|
+
**opticalTubeId** | **string** | Unique identifier of the optical tube to assign to this optical train. | [default to undefined]
|
|
14
|
+
**rotatorId** | **string** | Unique identifier of the rotator to assign to this optical train. | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { V1UpdateOpticalTrainRequest } from '@ourskyai/node_platform-api';
|
|
20
|
+
|
|
21
|
+
const instance: V1UpdateOpticalTrainRequest = {
|
|
22
|
+
filterWheelId,
|
|
23
|
+
focuserId,
|
|
24
|
+
label,
|
|
25
|
+
m3Port,
|
|
26
|
+
opticalTubeId,
|
|
27
|
+
rotatorId,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -18,6 +18,10 @@ Enumeration of all possible system event types that can occur during telescope o
|
|
|
18
18
|
|
|
19
19
|
* `CALIBRATE_ENCLOSURE_WINDOW` (value: `'CALIBRATE_ENCLOSURE_WINDOW'`)
|
|
20
20
|
|
|
21
|
+
* `CALIBRATE_MOUNT_MOTOR_A_UNWINDER` (value: `'CALIBRATE_MOUNT_MOTOR_A_UNWINDER'`)
|
|
22
|
+
|
|
23
|
+
* `CLEAR_ENCLOSURE_ROTATOR_MOTOR_LOCKOUT` (value: `'CLEAR_ENCLOSURE_ROTATOR_MOTOR_LOCKOUT'`)
|
|
24
|
+
|
|
21
25
|
* `CLOSE_ENCLOSURE_SHUTTERS` (value: `'CLOSE_ENCLOSURE_SHUTTERS'`)
|
|
22
26
|
|
|
23
27
|
* `CLOSE_OPTICAL_TUBE_COVER` (value: `'CLOSE_OPTICAL_TUBE_COVER'`)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# V2SystemStatus
|
|
2
|
+
|
|
3
|
+
Comprehensive status snapshot of all hardware components in the telescope system. Provides a unified view for monitoring and diagnostics.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**edfa** | [**V1EdfaStatus**](V1EdfaStatus.md) | | [optional] [default to undefined]
|
|
10
|
+
**enclosure** | [**V2EnclosureStatus**](V2EnclosureStatus.md) | | [optional] [default to undefined]
|
|
11
|
+
**mount** | [**V2MountStatus**](V2MountStatus.md) | | [optional] [default to undefined]
|
|
12
|
+
**opticalPowerMeter** | [**V1OpticalPowerMeterStatus**](V1OpticalPowerMeterStatus.md) | | [optional] [default to undefined]
|
|
13
|
+
**opticalTrains** | [**V1OpticalTrainStatuses**](V1OpticalTrainStatuses.md) | | [optional] [default to undefined]
|
|
14
|
+
**relays** | [**V2RelayStatuses**](V2RelayStatuses.md) | | [optional] [default to undefined]
|
|
15
|
+
**safety** | [**V1SafetyStatus**](V1SafetyStatus.md) | | [optional] [default to undefined]
|
|
16
|
+
**unassociatedOpticalTrainComponents** | [**V1UnassociatedOpticalTrainComponents**](V1UnassociatedOpticalTrainComponents.md) | | [optional] [default to undefined]
|
|
17
|
+
**weatherStation** | [**V1WeatherStationStatus**](V1WeatherStationStatus.md) | | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { V2SystemStatus } from '@ourskyai/node_platform-api';
|
|
23
|
+
|
|
24
|
+
const instance: V2SystemStatus = {
|
|
25
|
+
edfa,
|
|
26
|
+
enclosure,
|
|
27
|
+
mount,
|
|
28
|
+
opticalPowerMeter,
|
|
29
|
+
opticalTrains,
|
|
30
|
+
relays,
|
|
31
|
+
safety,
|
|
32
|
+
unassociatedOpticalTrainComponents,
|
|
33
|
+
weatherStation,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[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/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky
|
|
5
5
|
* Node Platform API The Node Platform API enables a customer to directly command their ground station either directly via IP address, via the self hosted C2 platform, or routed transparently via the Observable Space cloud platform. Node Platform APIs offer every endpoint a customer might need in order to slew their scope, perform diagnostics, capture images, and much more. Are we missing a feature you need? Drop us a line at support@observable.space.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.4.
|
|
7
|
+
* The version of the OpenAPI document: 1.4.188
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|