@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
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.4.
|
|
5
|
+
* The version of the OpenAPI document: 1.4.188
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -975,6 +975,17 @@ export interface OpenEnclosureShuttersEventData {
|
|
|
975
975
|
export interface OperationStatusUpdated {
|
|
976
976
|
'operationStatus': V1SystemOperationStatus;
|
|
977
977
|
}
|
|
978
|
+
/**
|
|
979
|
+
* Type of optical train component.
|
|
980
|
+
*/
|
|
981
|
+
export declare const OpticalTrainComponentType: {
|
|
982
|
+
readonly CAMERA: "CAMERA";
|
|
983
|
+
readonly FOCUSER: "FOCUSER";
|
|
984
|
+
readonly ROTATOR: "ROTATOR";
|
|
985
|
+
readonly FILTER_WHEEL: "FILTER_WHEEL";
|
|
986
|
+
readonly OPTICAL_TUBE: "OPTICAL_TUBE";
|
|
987
|
+
};
|
|
988
|
+
export type OpticalTrainComponentType = typeof OpticalTrainComponentType[keyof typeof OpticalTrainComponentType];
|
|
978
989
|
/**
|
|
979
990
|
* Connection status of the optical tube assembly sensors.
|
|
980
991
|
*/
|
|
@@ -1327,10 +1338,12 @@ export interface SystemEventData {
|
|
|
1327
1338
|
'autofocusPointMeasured'?: AutofocusPointMeasuredEventData;
|
|
1328
1339
|
'calibrateEnclosureRotator'?: PlaceholderEventData;
|
|
1329
1340
|
'calibrateEnclosureWindow'?: PlaceholderEventData;
|
|
1341
|
+
'calibrateMountMotorAUnwinder'?: PlaceholderEventData;
|
|
1330
1342
|
'cancelAllTasks'?: CancelAllTasksEventData;
|
|
1331
1343
|
'cancelTask'?: CancelTaskEventData;
|
|
1332
1344
|
'captureImage'?: CaptureImageEventData;
|
|
1333
1345
|
'captureImagesContinuously'?: CaptureImagesContinuouslyEventData;
|
|
1346
|
+
'clearEnclosureRotatorMotorLockout'?: PlaceholderEventData;
|
|
1334
1347
|
'closeEnclosureShutters'?: PlaceholderEventData;
|
|
1335
1348
|
'closeOpticalTubeCover'?: PlaceholderEventData;
|
|
1336
1349
|
'createElevationMask'?: PlaceholderEventData;
|
|
@@ -1988,6 +2001,35 @@ export interface V1CreateMountModelRequest {
|
|
|
1988
2001
|
*/
|
|
1989
2002
|
'offset': number;
|
|
1990
2003
|
}
|
|
2004
|
+
/**
|
|
2005
|
+
* Request to create an optical train configuration.
|
|
2006
|
+
*/
|
|
2007
|
+
export interface V1CreateOpticalTrainRequest {
|
|
2008
|
+
/**
|
|
2009
|
+
* Unique identifier of the filter wheel to assign to this optical train.
|
|
2010
|
+
*/
|
|
2011
|
+
'filterWheelId'?: string | null;
|
|
2012
|
+
/**
|
|
2013
|
+
* Unique identifier of the focuser to assign to this optical train.
|
|
2014
|
+
*/
|
|
2015
|
+
'focuserId'?: string | null;
|
|
2016
|
+
/**
|
|
2017
|
+
* Human-readable label for the optical train.
|
|
2018
|
+
*/
|
|
2019
|
+
'label': string;
|
|
2020
|
+
/**
|
|
2021
|
+
* M3 port to assign to this optical train, when the optical tube has an M3 port selector.
|
|
2022
|
+
*/
|
|
2023
|
+
'm3Port'?: number | null;
|
|
2024
|
+
/**
|
|
2025
|
+
* Unique identifier of the optical tube to assign to this optical train.
|
|
2026
|
+
*/
|
|
2027
|
+
'opticalTubeId': string;
|
|
2028
|
+
/**
|
|
2029
|
+
* Unique identifier of the rotator to assign to this optical train.
|
|
2030
|
+
*/
|
|
2031
|
+
'rotatorId'?: string | null;
|
|
2032
|
+
}
|
|
1991
2033
|
/**
|
|
1992
2034
|
* Request parameters for power cycling one or more relay channels (deprecated). Specify which channels to cycle and the off-duration for the reset.
|
|
1993
2035
|
*/
|
|
@@ -2933,6 +2975,10 @@ export interface V1MotorStatus {
|
|
|
2933
2975
|
* Current measured angular velocity of the motor in degrees per second.
|
|
2934
2976
|
*/
|
|
2935
2977
|
'measuredVelocityDegreesPerSecond': number;
|
|
2978
|
+
/**
|
|
2979
|
+
* Indicates whether the motor controller is in a latched lockout state that prevents motion until the lockout is explicitly cleared.
|
|
2980
|
+
*/
|
|
2981
|
+
'motorLockoutActive'?: boolean;
|
|
2936
2982
|
/**
|
|
2937
2983
|
* Current angular position of the motor axis in degrees. This is the raw motor position before any corrections are applied.
|
|
2938
2984
|
*/
|
|
@@ -3273,13 +3319,68 @@ export interface V1OpticalPowerMeterStatus {
|
|
|
3273
3319
|
'connected': boolean;
|
|
3274
3320
|
}
|
|
3275
3321
|
/**
|
|
3276
|
-
*
|
|
3322
|
+
* Optical train configuration and assigned component identifiers.
|
|
3323
|
+
*/
|
|
3324
|
+
export interface V1OpticalTrain {
|
|
3325
|
+
/**
|
|
3326
|
+
* Unique identifier of the filter wheel assigned to this optical train.
|
|
3327
|
+
*/
|
|
3328
|
+
'filterWheelId'?: string | null;
|
|
3329
|
+
/**
|
|
3330
|
+
* Unique identifier of the focuser assigned to this optical train.
|
|
3331
|
+
*/
|
|
3332
|
+
'focuserId'?: string | null;
|
|
3333
|
+
/**
|
|
3334
|
+
* Human-readable label for this optical train.
|
|
3335
|
+
*/
|
|
3336
|
+
'label': string;
|
|
3337
|
+
/**
|
|
3338
|
+
* M3 port used by this optical train, when the optical tube has an M3 port selector.
|
|
3339
|
+
*/
|
|
3340
|
+
'm3Port'?: number | null;
|
|
3341
|
+
/**
|
|
3342
|
+
* Unique identifier of the optical tube assigned to this optical train.
|
|
3343
|
+
*/
|
|
3344
|
+
'opticalTubeId': string;
|
|
3345
|
+
/**
|
|
3346
|
+
* Unique identifier of the rotator assigned to this optical train.
|
|
3347
|
+
*/
|
|
3348
|
+
'rotatorId'?: string | null;
|
|
3349
|
+
}
|
|
3350
|
+
/**
|
|
3351
|
+
* Status of one optical train and the components currently associated with it.
|
|
3352
|
+
*/
|
|
3353
|
+
export interface V1OpticalTrainStatus {
|
|
3354
|
+
'camera'?: V1CameraStatus;
|
|
3355
|
+
'filterWheel'?: V1FilterWheelStatus;
|
|
3356
|
+
'focuser'?: V1FocuserStatus;
|
|
3357
|
+
/**
|
|
3358
|
+
* Human-readable label for this optical train.
|
|
3359
|
+
*/
|
|
3360
|
+
'label'?: string;
|
|
3361
|
+
'opticalTube'?: V1OpticalTubeStatus;
|
|
3362
|
+
'rotator'?: V1RotatorStatus;
|
|
3363
|
+
}
|
|
3364
|
+
/**
|
|
3365
|
+
* Container object holding the status of all configured optical trains.
|
|
3366
|
+
*/
|
|
3367
|
+
export interface V1OpticalTrainStatuses {
|
|
3368
|
+
'statuses': Array<V1OpticalTrainStatus>;
|
|
3369
|
+
}
|
|
3370
|
+
/**
|
|
3371
|
+
* Container object holding all configured optical trains.
|
|
3372
|
+
*/
|
|
3373
|
+
export interface V1OpticalTrains {
|
|
3374
|
+
'opticalTrains': Array<V1OpticalTrain>;
|
|
3375
|
+
}
|
|
3376
|
+
/**
|
|
3377
|
+
* Optional optical tube cover selector. If omitted, the default optical tube cover is used.
|
|
3277
3378
|
*/
|
|
3278
3379
|
export interface V1OpticalTubeCoverSelectorRequest {
|
|
3279
3380
|
/**
|
|
3280
|
-
* Unique identifier of the optical tube to command. Obtain valid optical tube IDs from the optical tube statuses endpoint.
|
|
3381
|
+
* Unique identifier of the optical tube cover to command. Obtain valid optical tube cover IDs from the optical tube cover statuses endpoint.
|
|
3281
3382
|
*/
|
|
3282
|
-
'
|
|
3383
|
+
'opticalTubeCoverId'?: string;
|
|
3283
3384
|
}
|
|
3284
3385
|
/**
|
|
3285
3386
|
* Current status of the optical tube dust cover including connection state and open/closed position.
|
|
@@ -3435,7 +3536,7 @@ export interface V1OpticalTubeStatus {
|
|
|
3435
3536
|
*/
|
|
3436
3537
|
'id'?: string | null;
|
|
3437
3538
|
'm3'?: V1OpticalTubeM3Status;
|
|
3438
|
-
'temperatureSensors'?:
|
|
3539
|
+
'temperatureSensors'?: V1OpticalTubeTemperatureSensorGroupStatus;
|
|
3439
3540
|
}
|
|
3440
3541
|
/**
|
|
3441
3542
|
* Collection of comprehensive optical tube statuses, one per optical tube.
|
|
@@ -3443,6 +3544,25 @@ export interface V1OpticalTubeStatus {
|
|
|
3443
3544
|
export interface V1OpticalTubeStatuses {
|
|
3444
3545
|
'statuses': Array<V1OpticalTubeStatus>;
|
|
3445
3546
|
}
|
|
3547
|
+
/**
|
|
3548
|
+
* Temperature sensor statuses for a specific optical tube.
|
|
3549
|
+
*/
|
|
3550
|
+
export interface V1OpticalTubeTemperatureSensorGroupStatus {
|
|
3551
|
+
/**
|
|
3552
|
+
* Unique identifier of the optical tube within the system. Null when the status source does not provide component IDs.
|
|
3553
|
+
*/
|
|
3554
|
+
'id'?: string | null;
|
|
3555
|
+
/**
|
|
3556
|
+
* Array of temperature readings, one for each sensor in the optical tube assembly.
|
|
3557
|
+
*/
|
|
3558
|
+
'statuses': Array<V1OpticalTubeTemperatureSensorStatus>;
|
|
3559
|
+
}
|
|
3560
|
+
/**
|
|
3561
|
+
* Collection of temperature sensor statuses grouped by optical tube.
|
|
3562
|
+
*/
|
|
3563
|
+
export interface V1OpticalTubeTemperatureSensorGroupStatuses {
|
|
3564
|
+
'statuses': Array<V1OpticalTubeTemperatureSensorGroupStatus>;
|
|
3565
|
+
}
|
|
3446
3566
|
/**
|
|
3447
3567
|
* Identifies the temperature sensor location within the optical tube assembly.
|
|
3448
3568
|
*/
|
|
@@ -3463,15 +3583,6 @@ export interface V1OpticalTubeTemperatureSensorStatus {
|
|
|
3463
3583
|
*/
|
|
3464
3584
|
'temperatureCelsius': number;
|
|
3465
3585
|
}
|
|
3466
|
-
/**
|
|
3467
|
-
* Collection of temperature readings from sensors in the optical tube assembly.
|
|
3468
|
-
*/
|
|
3469
|
-
export interface V1OpticalTubeTemperatureSensorStatuses {
|
|
3470
|
-
/**
|
|
3471
|
-
* Array of temperature readings, one for each sensor in the optical tube assembly.
|
|
3472
|
-
*/
|
|
3473
|
-
'statuses': Array<V1OpticalTubeTemperatureSensorStatus>;
|
|
3474
|
-
}
|
|
3475
3586
|
/**
|
|
3476
3587
|
* Notify that a peer has changed status
|
|
3477
3588
|
*/
|
|
@@ -4274,9 +4385,9 @@ export interface V1SystemMetrics {
|
|
|
4274
4385
|
*/
|
|
4275
4386
|
export interface V1SystemMetricsCollection {
|
|
4276
4387
|
/**
|
|
4277
|
-
* Measurements encoded as fixed two-item arrays. Index 0 is measuredAt as
|
|
4388
|
+
* 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.
|
|
4278
4389
|
*/
|
|
4279
|
-
'metrics': Array<Array<
|
|
4390
|
+
'metrics': Array<Array<number>>;
|
|
4280
4391
|
/**
|
|
4281
4392
|
* The metric identifier that describes what is being measured, such as cpu_temperature or mount_position_altitude.
|
|
4282
4393
|
*/
|
|
@@ -4443,13 +4554,14 @@ export interface V1Task {
|
|
|
4443
4554
|
'type': V1TaskType;
|
|
4444
4555
|
}
|
|
4445
4556
|
/**
|
|
4446
|
-
* 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
|
|
4557
|
+
* 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
|
|
4447
4558
|
*/
|
|
4448
4559
|
export declare const V1TaskType: {
|
|
4449
4560
|
readonly CREATE_MOUNT_MODEL: "CREATE_MOUNT_MODEL";
|
|
4450
4561
|
readonly CREATE_ELEVATION_MASK: "CREATE_ELEVATION_MASK";
|
|
4451
4562
|
readonly CALIBRATE_ENCLOSURE_ROTATOR: "CALIBRATE_ENCLOSURE_ROTATOR";
|
|
4452
4563
|
readonly CALIBRATE_ENCLOSURE_WINDOW: "CALIBRATE_ENCLOSURE_WINDOW";
|
|
4564
|
+
readonly CALIBRATE_MOUNT_MOTOR_A_UNWINDER: "CALIBRATE_MOUNT_MOTOR_A_UNWINDER";
|
|
4453
4565
|
readonly RUN_AUTOFOCUS: "RUN_AUTOFOCUS";
|
|
4454
4566
|
readonly RUN_PERPETUAL_INSTRUCTION_LOOP: "RUN_PERPETUAL_INSTRUCTION_LOOP";
|
|
4455
4567
|
readonly STARTUP_WIZARD: "STARTUP_WIZARD";
|
|
@@ -4609,6 +4721,22 @@ export declare const V1UIOperationMode: {
|
|
|
4609
4721
|
readonly MANUAL: "MANUAL";
|
|
4610
4722
|
};
|
|
4611
4723
|
export type V1UIOperationMode = typeof V1UIOperationMode[keyof typeof V1UIOperationMode];
|
|
4724
|
+
/**
|
|
4725
|
+
* Optical train component that is not currently attached to an optical train.
|
|
4726
|
+
*/
|
|
4727
|
+
export interface V1UnassociatedOpticalTrainComponent {
|
|
4728
|
+
/**
|
|
4729
|
+
* Unique identifier of the unassociated component.
|
|
4730
|
+
*/
|
|
4731
|
+
'id': string;
|
|
4732
|
+
'type': OpticalTrainComponentType;
|
|
4733
|
+
}
|
|
4734
|
+
/**
|
|
4735
|
+
* Container object holding optical train components that are not currently attached to an optical train.
|
|
4736
|
+
*/
|
|
4737
|
+
export interface V1UnassociatedOpticalTrainComponents {
|
|
4738
|
+
'statuses': Array<V1UnassociatedOpticalTrainComponent>;
|
|
4739
|
+
}
|
|
4612
4740
|
/**
|
|
4613
4741
|
* Request payload for replacing the current elevation mask points stored for a node.
|
|
4614
4742
|
*/
|
|
@@ -4643,6 +4771,35 @@ export interface V1UpdateImageProcessingPluginRequest {
|
|
|
4643
4771
|
'name'?: string;
|
|
4644
4772
|
'pluginId': string;
|
|
4645
4773
|
}
|
|
4774
|
+
/**
|
|
4775
|
+
* Request to update an optical train configuration.
|
|
4776
|
+
*/
|
|
4777
|
+
export interface V1UpdateOpticalTrainRequest {
|
|
4778
|
+
/**
|
|
4779
|
+
* Unique identifier of the filter wheel to assign to this optical train.
|
|
4780
|
+
*/
|
|
4781
|
+
'filterWheelId'?: string | null;
|
|
4782
|
+
/**
|
|
4783
|
+
* Unique identifier of the focuser to assign to this optical train.
|
|
4784
|
+
*/
|
|
4785
|
+
'focuserId'?: string | null;
|
|
4786
|
+
/**
|
|
4787
|
+
* Human-readable label of the optical train to update.
|
|
4788
|
+
*/
|
|
4789
|
+
'label': string;
|
|
4790
|
+
/**
|
|
4791
|
+
* M3 port to assign to this optical train, when the optical tube has an M3 port selector.
|
|
4792
|
+
*/
|
|
4793
|
+
'm3Port'?: number | null;
|
|
4794
|
+
/**
|
|
4795
|
+
* Unique identifier of the optical tube to assign to this optical train.
|
|
4796
|
+
*/
|
|
4797
|
+
'opticalTubeId': string;
|
|
4798
|
+
/**
|
|
4799
|
+
* Unique identifier of the rotator to assign to this optical train.
|
|
4800
|
+
*/
|
|
4801
|
+
'rotatorId'?: string | null;
|
|
4802
|
+
}
|
|
4646
4803
|
/**
|
|
4647
4804
|
* Complete metadata for a recorded video including capture settings, file information, codec details, and timing data. Use this object to understand the recording parameters and locate the video file.
|
|
4648
4805
|
*/
|
|
@@ -4876,6 +5033,8 @@ export declare const V2SystemEventType: {
|
|
|
4876
5033
|
readonly CAPTURE_IMAGES_CONTINUOUSLY: "CAPTURE_IMAGES_CONTINUOUSLY";
|
|
4877
5034
|
readonly CALIBRATE_ENCLOSURE_ROTATOR: "CALIBRATE_ENCLOSURE_ROTATOR";
|
|
4878
5035
|
readonly CALIBRATE_ENCLOSURE_WINDOW: "CALIBRATE_ENCLOSURE_WINDOW";
|
|
5036
|
+
readonly CALIBRATE_MOUNT_MOTOR_A_UNWINDER: "CALIBRATE_MOUNT_MOTOR_A_UNWINDER";
|
|
5037
|
+
readonly CLEAR_ENCLOSURE_ROTATOR_MOTOR_LOCKOUT: "CLEAR_ENCLOSURE_ROTATOR_MOTOR_LOCKOUT";
|
|
4879
5038
|
readonly CLOSE_ENCLOSURE_SHUTTERS: "CLOSE_ENCLOSURE_SHUTTERS";
|
|
4880
5039
|
readonly CLOSE_OPTICAL_TUBE_COVER: "CLOSE_OPTICAL_TUBE_COVER";
|
|
4881
5040
|
readonly CREATE_ELEVATION_MASK: "CREATE_ELEVATION_MASK";
|
|
@@ -4979,6 +5138,20 @@ export interface V2SystemEvents {
|
|
|
4979
5138
|
*/
|
|
4980
5139
|
'systemEvents': Array<V2SystemEvent>;
|
|
4981
5140
|
}
|
|
5141
|
+
/**
|
|
5142
|
+
* Comprehensive status snapshot of all hardware components in the telescope system. Provides a unified view for monitoring and diagnostics.
|
|
5143
|
+
*/
|
|
5144
|
+
export interface V2SystemStatus {
|
|
5145
|
+
'edfa'?: V1EdfaStatus;
|
|
5146
|
+
'enclosure'?: V2EnclosureStatus;
|
|
5147
|
+
'mount'?: V2MountStatus;
|
|
5148
|
+
'opticalPowerMeter'?: V1OpticalPowerMeterStatus;
|
|
5149
|
+
'opticalTrains'?: V1OpticalTrainStatuses;
|
|
5150
|
+
'relays'?: V2RelayStatuses;
|
|
5151
|
+
'safety'?: V1SafetyStatus;
|
|
5152
|
+
'unassociatedOpticalTrainComponents'?: V1UnassociatedOpticalTrainComponents;
|
|
5153
|
+
'weatherStation'?: V1WeatherStationStatus;
|
|
5154
|
+
}
|
|
4982
5155
|
/**
|
|
4983
5156
|
* Request parameters for turning off a specific power relay. Specify which equipment function to power off.
|
|
4984
5157
|
*/
|
|
@@ -5187,13 +5360,16 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5187
5360
|
*/
|
|
5188
5361
|
v1AddMountModelPointHere: (v1AddMountModelPointHereRequest: V1AddMountModelPointHereRequest, lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5189
5362
|
/**
|
|
5190
|
-
* Adds a single manual calibration point to the pointing model. The node will attempt to plate-solve the supplied image to determine J2000 right ascension and declination and pair it with the mount
|
|
5363
|
+
* Adds a single manual calibration point to the pointing model. The node will attempt to plate-solve the supplied image to determine J2000 right ascension and declination and pair it with the mount mechanical position to record a new correction point. Use this to refine the model with a known sky position without running a full automated survey. Returns an empty success response when the point is added.
|
|
5191
5364
|
* @param {File} body
|
|
5192
5365
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
5366
|
+
* @param {number} [motorAEncoderPositionDegrees] Motor A encoder position in degrees at the time the supplied image was captured.
|
|
5367
|
+
* @param {number} [motorBEncoderPositionDegrees] Motor B encoder position in degrees at the time the supplied image was captured.
|
|
5368
|
+
* @param {string} [timestamp] ISO 8601 timestamp when the supplied encoder positions were measured.
|
|
5193
5369
|
* @param {*} [options] Override http request option.
|
|
5194
5370
|
* @throws {RequiredError}
|
|
5195
5371
|
*/
|
|
5196
|
-
|
|
5372
|
+
v1AddMountModelPointUsingImage: (body: File, lineageId?: string, motorAEncoderPositionDegrees?: number, motorBEncoderPositionDegrees?: number, timestamp?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5197
5373
|
/**
|
|
5198
5374
|
* Updates the current custom path tracking session by appending control points. The trackingSessionId and frame must match the current session.
|
|
5199
5375
|
* @param {V1AppendMountTrackPathRequest} v1AppendMountTrackPathRequest
|
|
@@ -5260,6 +5436,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5260
5436
|
* @throws {RequiredError}
|
|
5261
5437
|
*/
|
|
5262
5438
|
v1CaptureImagesContinuously: (v1CaptureImagesContinuouslyRequest: V1CaptureImagesContinuouslyRequest, lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5439
|
+
/**
|
|
5440
|
+
* Clears a latched dome rotator motor lockout condition after the underlying cause has been investigated and it is safe to permit rotator motion again. To recover from the lockout zone, the edge controller temporarily disables the limiter, moves the enclosure rotator back into the valid range, and then re-enables the limiter. This operation is a no-op when no motor lockout is active.
|
|
5441
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
5442
|
+
* @param {*} [options] Override http request option.
|
|
5443
|
+
* @throws {RequiredError}
|
|
5444
|
+
*/
|
|
5445
|
+
v1ClearEnclosureRotatorMotorLockout: (lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5263
5446
|
/**
|
|
5264
5447
|
* Clears all calibration points from the current pointing model, removing every correction the mount applies to its raw mechanical positioning. Use this to discard an inaccurate model before building a new one, or to reset to uncorrected pointing. Returns an empty success response when the model is cleared.
|
|
5265
5448
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -5313,6 +5496,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5313
5496
|
* @throws {RequiredError}
|
|
5314
5497
|
*/
|
|
5315
5498
|
v1CreateMountModel: (v1CreateMountModelRequest: V1CreateMountModelRequest, lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5499
|
+
/**
|
|
5500
|
+
* Creates an optical train configuration by assigning optical train components to a human-readable label.
|
|
5501
|
+
* @param {V1CreateOpticalTrainRequest} v1CreateOpticalTrainRequest
|
|
5502
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
5503
|
+
* @param {*} [options] Override http request option.
|
|
5504
|
+
* @throws {RequiredError}
|
|
5505
|
+
*/
|
|
5506
|
+
v1CreateOpticalTrain: (v1CreateOpticalTrainRequest: V1CreateOpticalTrainRequest, lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5316
5507
|
/**
|
|
5317
5508
|
* DEPRECATED: Use [/node-platform/v2/relays/cycle](#tag/cycles/post/node-platform/v2/relays/cycle) instead. Power cycles the specified relay channels by turning them off and then back on after a specified duration. This legacy endpoint uses channel identifiers for relay selection. The newer endpoint provides the same functionality with improved relay function identification.
|
|
5318
5509
|
* @param {V1CycleRelaysRequest} v1CycleRelaysRequest
|
|
@@ -5338,6 +5529,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5338
5529
|
* @throws {RequiredError}
|
|
5339
5530
|
*/
|
|
5340
5531
|
v1DeleteImageProcessingPlugin: (v1GetImageProcessingPluginRequest: V1GetImageProcessingPluginRequest, lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5532
|
+
/**
|
|
5533
|
+
* Deletes one optical train configuration by label.
|
|
5534
|
+
* @param {string} label Human-readable label of the optical train to delete.
|
|
5535
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
5536
|
+
* @param {*} [options] Override http request option.
|
|
5537
|
+
* @throws {RequiredError}
|
|
5538
|
+
*/
|
|
5539
|
+
v1DeleteOpticalTrain: (label: string, lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5341
5540
|
/**
|
|
5342
5541
|
* Permanently deletes a video and its associated files from the system. Use this endpoint to manually remove unwanted videos and free up storage space. This action cannot be undone, so ensure you have downloaded or backed up any important files before deletion.
|
|
5343
5542
|
* @param {V1DeleteVideoRequest} v1DeleteVideoRequest
|
|
@@ -5466,10 +5665,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5466
5665
|
/**
|
|
5467
5666
|
* Discovers the physical travel limits of the focuser by moving it to both ends of its range. This calibration routine is essential after initial setup or if the focuser limits are unknown. The focuser will move to find the minimum and maximum positions, which are then used to prevent out-of-range movements. Returns the discovered limit values in focuser steps.
|
|
5468
5667
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
5668
|
+
* @param {string} [id] Optional focuser ID. If provided, finds limits for that focuser instead of the default focuser.
|
|
5469
5669
|
* @param {*} [options] Override http request option.
|
|
5470
5670
|
* @throws {RequiredError}
|
|
5471
5671
|
*/
|
|
5472
|
-
v1FindFocuserLimits: (lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5672
|
+
v1FindFocuserLimits: (lineageId?: string, id?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5473
5673
|
/**
|
|
5474
5674
|
* Retrieves all currently active and scheduled tasks running on the telescope system. Use this endpoint to monitor long-running operations such as autofocus routines, mount model creation, calibration frame acquisition, and automated observation sequences. Each task includes its type, scheduling time, and execution status to help track progress and identify potential conflicts.
|
|
5475
5675
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -5751,6 +5951,21 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5751
5951
|
* @throws {RequiredError}
|
|
5752
5952
|
*/
|
|
5753
5953
|
v1GetNetworkInterfaces: (lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5954
|
+
/**
|
|
5955
|
+
* Retrieves one optical train configuration by label.
|
|
5956
|
+
* @param {string} label Human-readable label of the optical train to retrieve.
|
|
5957
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
5958
|
+
* @param {*} [options] Override http request option.
|
|
5959
|
+
* @throws {RequiredError}
|
|
5960
|
+
*/
|
|
5961
|
+
v1GetOpticalTrain: (label: string, lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5962
|
+
/**
|
|
5963
|
+
* Retrieves all configured optical trains and the optical train components assigned to each train.
|
|
5964
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
5965
|
+
* @param {*} [options] Override http request option.
|
|
5966
|
+
* @throws {RequiredError}
|
|
5967
|
+
*/
|
|
5968
|
+
v1GetOpticalTrains: (lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5754
5969
|
/**
|
|
5755
5970
|
* Retrieves the current status of the optical tube dust cover that protects the primary mirror. The cover should be closed when the telescope is not in use to prevent dust accumulation on optical surfaces. Use this to verify cover state before imaging or to confirm the cover is closed during daytime. Returns V1OpticalTubeCoverStatus with connection and position information.
|
|
5756
5971
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -5826,6 +6041,21 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5826
6041
|
* @throws {RequiredError}
|
|
5827
6042
|
*/
|
|
5828
6043
|
v1GetOpticalTubeStatuses: (lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6044
|
+
/**
|
|
6045
|
+
* Retrieves the current temperature sensor status for an optical tube assembly. Returns V1OpticalTubeTemperatureSensorGroupStatus containing the temperature reading from each sensor.
|
|
6046
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
6047
|
+
* @param {string} [id] Optional optical tube ID. If provided, returns temperature sensor statuses for that optical tube instead of the default optical tube.
|
|
6048
|
+
* @param {*} [options] Override http request option.
|
|
6049
|
+
* @throws {RequiredError}
|
|
6050
|
+
*/
|
|
6051
|
+
v1GetOpticalTubeTemperatureSensorGroupStatus: (lineageId?: string, id?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6052
|
+
/**
|
|
6053
|
+
* Retrieves the current temperature sensor statuses grouped by optical tube. Use this endpoint to discover optical tube IDs and temperature readings before addressing a specific optical tube.
|
|
6054
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
6055
|
+
* @param {*} [options] Override http request option.
|
|
6056
|
+
* @throws {RequiredError}
|
|
6057
|
+
*/
|
|
6058
|
+
v1GetOpticalTubeTemperatureSensorGroupStatuses: (lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5829
6059
|
/**
|
|
5830
6060
|
* DEPRECATED: Use [/node-platform/v2/relays/status](#tag/status/get/node-platform/v2/relays/status) instead. Retrieves the current state of all power relays in the observatory. This legacy endpoint returns relay states by channel identifier. The newer endpoint provides the same information with improved relay function identification and additional connectivity details.
|
|
5831
6061
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -5921,7 +6151,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5921
6151
|
*/
|
|
5922
6152
|
v1GetSystemMetricNames: (lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5923
6153
|
/**
|
|
5924
|
-
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis. This endpoint returns telemetry data such as temperatures, positions, and operational statistics over a specified time range. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is
|
|
6154
|
+
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis. This endpoint returns telemetry data such as temperatures, positions, and operational statistics over a specified time range. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is dynamically calculated based on the requested time window and the number of metrics queried to ensure system stability and optimal network performance. Wider time windows or queries with many metrics will automatically apply a coarser roll-up resolution. **Default time window behavior:** - If neither `after` nor `before` is specified, the time window defaults to the last **24 hours**. - If only one bound is provided, the other bound is inferred to create a 24-hour window.
|
|
5925
6155
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
5926
6156
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
5927
6157
|
* @param {string} [after] Filter metrics to only include measurements taken after this timestamp. Use ISO 8601 date-time format. When combined with before, defines a time window for querying historical metrics.
|
|
@@ -5931,7 +6161,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5931
6161
|
*/
|
|
5932
6162
|
v1GetSystemMetrics: (lineageId?: string, metricName?: string, after?: string, before?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5933
6163
|
/**
|
|
5934
|
-
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis, grouped into compact metric collections to reduce response size over the wire. This endpoint returns the same metric data as `/node-platform/v1/system/metrics`, but each collection contains shared metric identity fields once (`name`, `type`, and `tags`) and stores measurements as compact `[measuredAt, value]` arrays. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is
|
|
6164
|
+
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis, grouped into compact metric collections to reduce response size over the wire. This endpoint returns the same metric data as `/node-platform/v1/system/metrics`, but each collection contains shared metric identity fields once (`name`, `type`, and `tags`) and stores measurements as compact `[measuredAt, value]` arrays. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is dynamically calculated based on the requested time window and the number of metrics queried to ensure system stability and optimal network performance. Wider time windows or queries with many metrics will automatically apply a coarser roll-up resolution. **Default time window behavior:** - If neither `after` nor `before` is specified, the time window defaults to the last **24 hours**. - If only one bound is provided, the other bound is inferred to create a 24-hour window.
|
|
5935
6165
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
5936
6166
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
5937
6167
|
* @param {string} [after] Filter metrics to only include measurements taken after this timestamp. Use ISO 8601 date-time format. When combined with before, defines a time window for querying historical metrics.
|
|
@@ -6569,6 +6799,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6569
6799
|
* @throws {RequiredError}
|
|
6570
6800
|
*/
|
|
6571
6801
|
v1UpdateImageProcessingPlugin: (v1UpdateImageProcessingPluginRequest: V1UpdateImageProcessingPluginRequest, lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6802
|
+
/**
|
|
6803
|
+
* Updates an optical train configuration by replacing the component assignments for the provided label.
|
|
6804
|
+
* @param {V1UpdateOpticalTrainRequest} v1UpdateOpticalTrainRequest
|
|
6805
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
6806
|
+
* @param {*} [options] Override http request option.
|
|
6807
|
+
* @throws {RequiredError}
|
|
6808
|
+
*/
|
|
6809
|
+
v1UpdateOpticalTrain: (v1UpdateOpticalTrainRequest: V1UpdateOpticalTrainRequest, lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6572
6810
|
/**
|
|
6573
6811
|
* Updates system settings with new configuration values. Use this endpoint to modify telescope behavior including mount motion parameters. Only include the settings you want to change in the request body. Changes take effect immediately and persist across system restarts.
|
|
6574
6812
|
* @param {V1SystemSettings} v1SystemSettings
|
|
@@ -6643,6 +6881,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6643
6881
|
* @throws {RequiredError}
|
|
6644
6882
|
*/
|
|
6645
6883
|
v2GetSystemEvents: (lineageId?: string, type?: V2SystemEventType, before?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6884
|
+
/**
|
|
6885
|
+
* Retrieves the comprehensive status of all connected hardware components in the telescope system, grouped by optical train and including optical train components that are not currently associated with an optical train.
|
|
6886
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
6887
|
+
* @param {*} [options] Override http request option.
|
|
6888
|
+
* @throws {RequiredError}
|
|
6889
|
+
*/
|
|
6890
|
+
v2GetSystemStatus: (lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6646
6891
|
/**
|
|
6647
6892
|
* Powers off a specific relay to disable the connected equipment. Use this endpoint to shut down observatory devices when observations are complete or during maintenance. Ensure proper shutdown procedures are followed for the equipment before removing power, such as parking the mount or stopping camera operations.
|
|
6648
6893
|
* @param {V2TurnOffRelayRequest} v2TurnOffRelayRequest
|
|
@@ -6673,13 +6918,16 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6673
6918
|
*/
|
|
6674
6919
|
v1AddMountModelPointHere(v1AddMountModelPointHereRequest: V1AddMountModelPointHereRequest, lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
6675
6920
|
/**
|
|
6676
|
-
* Adds a single manual calibration point to the pointing model. The node will attempt to plate-solve the supplied image to determine J2000 right ascension and declination and pair it with the mount
|
|
6921
|
+
* Adds a single manual calibration point to the pointing model. The node will attempt to plate-solve the supplied image to determine J2000 right ascension and declination and pair it with the mount mechanical position to record a new correction point. Use this to refine the model with a known sky position without running a full automated survey. Returns an empty success response when the point is added.
|
|
6677
6922
|
* @param {File} body
|
|
6678
6923
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
6924
|
+
* @param {number} [motorAEncoderPositionDegrees] Motor A encoder position in degrees at the time the supplied image was captured.
|
|
6925
|
+
* @param {number} [motorBEncoderPositionDegrees] Motor B encoder position in degrees at the time the supplied image was captured.
|
|
6926
|
+
* @param {string} [timestamp] ISO 8601 timestamp when the supplied encoder positions were measured.
|
|
6679
6927
|
* @param {*} [options] Override http request option.
|
|
6680
6928
|
* @throws {RequiredError}
|
|
6681
6929
|
*/
|
|
6682
|
-
|
|
6930
|
+
v1AddMountModelPointUsingImage(body: File, lineageId?: string, motorAEncoderPositionDegrees?: number, motorBEncoderPositionDegrees?: number, timestamp?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
6683
6931
|
/**
|
|
6684
6932
|
* Updates the current custom path tracking session by appending control points. The trackingSessionId and frame must match the current session.
|
|
6685
6933
|
* @param {V1AppendMountTrackPathRequest} v1AppendMountTrackPathRequest
|
|
@@ -6746,6 +6994,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6746
6994
|
* @throws {RequiredError}
|
|
6747
6995
|
*/
|
|
6748
6996
|
v1CaptureImagesContinuously(v1CaptureImagesContinuouslyRequest: V1CaptureImagesContinuouslyRequest, lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
6997
|
+
/**
|
|
6998
|
+
* Clears a latched dome rotator motor lockout condition after the underlying cause has been investigated and it is safe to permit rotator motion again. To recover from the lockout zone, the edge controller temporarily disables the limiter, moves the enclosure rotator back into the valid range, and then re-enables the limiter. This operation is a no-op when no motor lockout is active.
|
|
6999
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7000
|
+
* @param {*} [options] Override http request option.
|
|
7001
|
+
* @throws {RequiredError}
|
|
7002
|
+
*/
|
|
7003
|
+
v1ClearEnclosureRotatorMotorLockout(lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
6749
7004
|
/**
|
|
6750
7005
|
* Clears all calibration points from the current pointing model, removing every correction the mount applies to its raw mechanical positioning. Use this to discard an inaccurate model before building a new one, or to reset to uncorrected pointing. Returns an empty success response when the model is cleared.
|
|
6751
7006
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -6799,6 +7054,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6799
7054
|
* @throws {RequiredError}
|
|
6800
7055
|
*/
|
|
6801
7056
|
v1CreateMountModel(v1CreateMountModelRequest: V1CreateMountModelRequest, lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1Task>>;
|
|
7057
|
+
/**
|
|
7058
|
+
* Creates an optical train configuration by assigning optical train components to a human-readable label.
|
|
7059
|
+
* @param {V1CreateOpticalTrainRequest} v1CreateOpticalTrainRequest
|
|
7060
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7061
|
+
* @param {*} [options] Override http request option.
|
|
7062
|
+
* @throws {RequiredError}
|
|
7063
|
+
*/
|
|
7064
|
+
v1CreateOpticalTrain(v1CreateOpticalTrainRequest: V1CreateOpticalTrainRequest, lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OpticalTrain>>;
|
|
6802
7065
|
/**
|
|
6803
7066
|
* DEPRECATED: Use [/node-platform/v2/relays/cycle](#tag/cycles/post/node-platform/v2/relays/cycle) instead. Power cycles the specified relay channels by turning them off and then back on after a specified duration. This legacy endpoint uses channel identifiers for relay selection. The newer endpoint provides the same functionality with improved relay function identification.
|
|
6804
7067
|
* @param {V1CycleRelaysRequest} v1CycleRelaysRequest
|
|
@@ -6824,6 +7087,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6824
7087
|
* @throws {RequiredError}
|
|
6825
7088
|
*/
|
|
6826
7089
|
v1DeleteImageProcessingPlugin(v1GetImageProcessingPluginRequest: V1GetImageProcessingPluginRequest, lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
7090
|
+
/**
|
|
7091
|
+
* Deletes one optical train configuration by label.
|
|
7092
|
+
* @param {string} label Human-readable label of the optical train to delete.
|
|
7093
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7094
|
+
* @param {*} [options] Override http request option.
|
|
7095
|
+
* @throws {RequiredError}
|
|
7096
|
+
*/
|
|
7097
|
+
v1DeleteOpticalTrain(label: string, lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
6827
7098
|
/**
|
|
6828
7099
|
* Permanently deletes a video and its associated files from the system. Use this endpoint to manually remove unwanted videos and free up storage space. This action cannot be undone, so ensure you have downloaded or backed up any important files before deletion.
|
|
6829
7100
|
* @param {V1DeleteVideoRequest} v1DeleteVideoRequest
|
|
@@ -6952,10 +7223,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6952
7223
|
/**
|
|
6953
7224
|
* Discovers the physical travel limits of the focuser by moving it to both ends of its range. This calibration routine is essential after initial setup or if the focuser limits are unknown. The focuser will move to find the minimum and maximum positions, which are then used to prevent out-of-range movements. Returns the discovered limit values in focuser steps.
|
|
6954
7225
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7226
|
+
* @param {string} [id] Optional focuser ID. If provided, finds limits for that focuser instead of the default focuser.
|
|
6955
7227
|
* @param {*} [options] Override http request option.
|
|
6956
7228
|
* @throws {RequiredError}
|
|
6957
7229
|
*/
|
|
6958
|
-
v1FindFocuserLimits(lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1FocuserLimit>>;
|
|
7230
|
+
v1FindFocuserLimits(lineageId?: string, id?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1FocuserLimit>>;
|
|
6959
7231
|
/**
|
|
6960
7232
|
* Retrieves all currently active and scheduled tasks running on the telescope system. Use this endpoint to monitor long-running operations such as autofocus routines, mount model creation, calibration frame acquisition, and automated observation sequences. Each task includes its type, scheduling time, and execution status to help track progress and identify potential conflicts.
|
|
6961
7233
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -7237,6 +7509,21 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7237
7509
|
* @throws {RequiredError}
|
|
7238
7510
|
*/
|
|
7239
7511
|
v1GetNetworkInterfaces(lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SystemNetworkInterface>>>;
|
|
7512
|
+
/**
|
|
7513
|
+
* Retrieves one optical train configuration by label.
|
|
7514
|
+
* @param {string} label Human-readable label of the optical train to retrieve.
|
|
7515
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7516
|
+
* @param {*} [options] Override http request option.
|
|
7517
|
+
* @throws {RequiredError}
|
|
7518
|
+
*/
|
|
7519
|
+
v1GetOpticalTrain(label: string, lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OpticalTrain>>;
|
|
7520
|
+
/**
|
|
7521
|
+
* Retrieves all configured optical trains and the optical train components assigned to each train.
|
|
7522
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7523
|
+
* @param {*} [options] Override http request option.
|
|
7524
|
+
* @throws {RequiredError}
|
|
7525
|
+
*/
|
|
7526
|
+
v1GetOpticalTrains(lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OpticalTrains>>;
|
|
7240
7527
|
/**
|
|
7241
7528
|
* Retrieves the current status of the optical tube dust cover that protects the primary mirror. The cover should be closed when the telescope is not in use to prevent dust accumulation on optical surfaces. Use this to verify cover state before imaging or to confirm the cover is closed during daytime. Returns V1OpticalTubeCoverStatus with connection and position information.
|
|
7242
7529
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -7312,6 +7599,21 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7312
7599
|
* @throws {RequiredError}
|
|
7313
7600
|
*/
|
|
7314
7601
|
v1GetOpticalTubeStatuses(lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OpticalTubeStatuses>>;
|
|
7602
|
+
/**
|
|
7603
|
+
* Retrieves the current temperature sensor status for an optical tube assembly. Returns V1OpticalTubeTemperatureSensorGroupStatus containing the temperature reading from each sensor.
|
|
7604
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7605
|
+
* @param {string} [id] Optional optical tube ID. If provided, returns temperature sensor statuses for that optical tube instead of the default optical tube.
|
|
7606
|
+
* @param {*} [options] Override http request option.
|
|
7607
|
+
* @throws {RequiredError}
|
|
7608
|
+
*/
|
|
7609
|
+
v1GetOpticalTubeTemperatureSensorGroupStatus(lineageId?: string, id?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OpticalTubeTemperatureSensorGroupStatus>>;
|
|
7610
|
+
/**
|
|
7611
|
+
* Retrieves the current temperature sensor statuses grouped by optical tube. Use this endpoint to discover optical tube IDs and temperature readings before addressing a specific optical tube.
|
|
7612
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7613
|
+
* @param {*} [options] Override http request option.
|
|
7614
|
+
* @throws {RequiredError}
|
|
7615
|
+
*/
|
|
7616
|
+
v1GetOpticalTubeTemperatureSensorGroupStatuses(lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OpticalTubeTemperatureSensorGroupStatuses>>;
|
|
7315
7617
|
/**
|
|
7316
7618
|
* DEPRECATED: Use [/node-platform/v2/relays/status](#tag/status/get/node-platform/v2/relays/status) instead. Retrieves the current state of all power relays in the observatory. This legacy endpoint returns relay states by channel identifier. The newer endpoint provides the same information with improved relay function identification and additional connectivity details.
|
|
7317
7619
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -7407,7 +7709,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7407
7709
|
*/
|
|
7408
7710
|
v1GetSystemMetricNames(lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1SystemMetricNames>>;
|
|
7409
7711
|
/**
|
|
7410
|
-
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis. This endpoint returns telemetry data such as temperatures, positions, and operational statistics over a specified time range. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is
|
|
7712
|
+
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis. This endpoint returns telemetry data such as temperatures, positions, and operational statistics over a specified time range. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is dynamically calculated based on the requested time window and the number of metrics queried to ensure system stability and optimal network performance. Wider time windows or queries with many metrics will automatically apply a coarser roll-up resolution. **Default time window behavior:** - If neither `after` nor `before` is specified, the time window defaults to the last **24 hours**. - If only one bound is provided, the other bound is inferred to create a 24-hour window.
|
|
7411
7713
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7412
7714
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
7413
7715
|
* @param {string} [after] Filter metrics to only include measurements taken after this timestamp. Use ISO 8601 date-time format. When combined with before, defines a time window for querying historical metrics.
|
|
@@ -7417,7 +7719,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7417
7719
|
*/
|
|
7418
7720
|
v1GetSystemMetrics(lineageId?: string, metricName?: string, after?: string, before?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1SystemMetrics>>;
|
|
7419
7721
|
/**
|
|
7420
|
-
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis, grouped into compact metric collections to reduce response size over the wire. This endpoint returns the same metric data as `/node-platform/v1/system/metrics`, but each collection contains shared metric identity fields once (`name`, `type`, and `tags`) and stores measurements as compact `[measuredAt, value]` arrays. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is
|
|
7722
|
+
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis, grouped into compact metric collections to reduce response size over the wire. This endpoint returns the same metric data as `/node-platform/v1/system/metrics`, but each collection contains shared metric identity fields once (`name`, `type`, and `tags`) and stores measurements as compact `[measuredAt, value]` arrays. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is dynamically calculated based on the requested time window and the number of metrics queried to ensure system stability and optimal network performance. Wider time windows or queries with many metrics will automatically apply a coarser roll-up resolution. **Default time window behavior:** - If neither `after` nor `before` is specified, the time window defaults to the last **24 hours**. - If only one bound is provided, the other bound is inferred to create a 24-hour window.
|
|
7421
7723
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7422
7724
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
7423
7725
|
* @param {string} [after] Filter metrics to only include measurements taken after this timestamp. Use ISO 8601 date-time format. When combined with before, defines a time window for querying historical metrics.
|
|
@@ -8055,6 +8357,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
8055
8357
|
* @throws {RequiredError}
|
|
8056
8358
|
*/
|
|
8057
8359
|
v1UpdateImageProcessingPlugin(v1UpdateImageProcessingPluginRequest: V1UpdateImageProcessingPluginRequest, lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1ImageProcessingPlugin>>;
|
|
8360
|
+
/**
|
|
8361
|
+
* Updates an optical train configuration by replacing the component assignments for the provided label.
|
|
8362
|
+
* @param {V1UpdateOpticalTrainRequest} v1UpdateOpticalTrainRequest
|
|
8363
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
8364
|
+
* @param {*} [options] Override http request option.
|
|
8365
|
+
* @throws {RequiredError}
|
|
8366
|
+
*/
|
|
8367
|
+
v1UpdateOpticalTrain(v1UpdateOpticalTrainRequest: V1UpdateOpticalTrainRequest, lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OpticalTrain>>;
|
|
8058
8368
|
/**
|
|
8059
8369
|
* Updates system settings with new configuration values. Use this endpoint to modify telescope behavior including mount motion parameters. Only include the settings you want to change in the request body. Changes take effect immediately and persist across system restarts.
|
|
8060
8370
|
* @param {V1SystemSettings} v1SystemSettings
|
|
@@ -8129,6 +8439,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
8129
8439
|
* @throws {RequiredError}
|
|
8130
8440
|
*/
|
|
8131
8441
|
v2GetSystemEvents(lineageId?: string, type?: V2SystemEventType, before?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2SystemEvents>>;
|
|
8442
|
+
/**
|
|
8443
|
+
* Retrieves the comprehensive status of all connected hardware components in the telescope system, grouped by optical train and including optical train components that are not currently associated with an optical train.
|
|
8444
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
8445
|
+
* @param {*} [options] Override http request option.
|
|
8446
|
+
* @throws {RequiredError}
|
|
8447
|
+
*/
|
|
8448
|
+
v2GetSystemStatus(lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2SystemStatus>>;
|
|
8132
8449
|
/**
|
|
8133
8450
|
* Powers off a specific relay to disable the connected equipment. Use this endpoint to shut down observatory devices when observations are complete or during maintenance. Ensure proper shutdown procedures are followed for the equipment before removing power, such as parking the mount or stopping camera operations.
|
|
8134
8451
|
* @param {V2TurnOffRelayRequest} v2TurnOffRelayRequest
|
|
@@ -8158,12 +8475,12 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8158
8475
|
*/
|
|
8159
8476
|
v1AddMountModelPointHere(requestParameters: DefaultApiV1AddMountModelPointHereRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
8160
8477
|
/**
|
|
8161
|
-
* Adds a single manual calibration point to the pointing model. The node will attempt to plate-solve the supplied image to determine J2000 right ascension and declination and pair it with the mount
|
|
8162
|
-
* @param {
|
|
8478
|
+
* Adds a single manual calibration point to the pointing model. The node will attempt to plate-solve the supplied image to determine J2000 right ascension and declination and pair it with the mount mechanical position to record a new correction point. Use this to refine the model with a known sky position without running a full automated survey. Returns an empty success response when the point is added.
|
|
8479
|
+
* @param {DefaultApiV1AddMountModelPointUsingImageRequest} requestParameters Request parameters.
|
|
8163
8480
|
* @param {*} [options] Override http request option.
|
|
8164
8481
|
* @throws {RequiredError}
|
|
8165
8482
|
*/
|
|
8166
|
-
|
|
8483
|
+
v1AddMountModelPointUsingImage(requestParameters: DefaultApiV1AddMountModelPointUsingImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
8167
8484
|
/**
|
|
8168
8485
|
* Updates the current custom path tracking session by appending control points. The trackingSessionId and frame must match the current session.
|
|
8169
8486
|
* @param {DefaultApiV1AppendMountTrackPathRequest} requestParameters Request parameters.
|
|
@@ -8222,6 +8539,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8222
8539
|
* @throws {RequiredError}
|
|
8223
8540
|
*/
|
|
8224
8541
|
v1CaptureImagesContinuously(requestParameters: DefaultApiV1CaptureImagesContinuouslyRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
8542
|
+
/**
|
|
8543
|
+
* Clears a latched dome rotator motor lockout condition after the underlying cause has been investigated and it is safe to permit rotator motion again. To recover from the lockout zone, the edge controller temporarily disables the limiter, moves the enclosure rotator back into the valid range, and then re-enables the limiter. This operation is a no-op when no motor lockout is active.
|
|
8544
|
+
* @param {DefaultApiV1ClearEnclosureRotatorMotorLockoutRequest} requestParameters Request parameters.
|
|
8545
|
+
* @param {*} [options] Override http request option.
|
|
8546
|
+
* @throws {RequiredError}
|
|
8547
|
+
*/
|
|
8548
|
+
v1ClearEnclosureRotatorMotorLockout(requestParameters?: DefaultApiV1ClearEnclosureRotatorMotorLockoutRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
8225
8549
|
/**
|
|
8226
8550
|
* Clears all calibration points from the current pointing model, removing every correction the mount applies to its raw mechanical positioning. Use this to discard an inaccurate model before building a new one, or to reset to uncorrected pointing. Returns an empty success response when the model is cleared.
|
|
8227
8551
|
* @param {DefaultApiV1ClearMountModelRequest} requestParameters Request parameters.
|
|
@@ -8273,6 +8597,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8273
8597
|
* @throws {RequiredError}
|
|
8274
8598
|
*/
|
|
8275
8599
|
v1CreateMountModel(requestParameters: DefaultApiV1CreateMountModelRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1Task>;
|
|
8600
|
+
/**
|
|
8601
|
+
* Creates an optical train configuration by assigning optical train components to a human-readable label.
|
|
8602
|
+
* @param {DefaultApiV1CreateOpticalTrainRequest} requestParameters Request parameters.
|
|
8603
|
+
* @param {*} [options] Override http request option.
|
|
8604
|
+
* @throws {RequiredError}
|
|
8605
|
+
*/
|
|
8606
|
+
v1CreateOpticalTrain(requestParameters: DefaultApiV1CreateOpticalTrainRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1OpticalTrain>;
|
|
8276
8607
|
/**
|
|
8277
8608
|
* DEPRECATED: Use [/node-platform/v2/relays/cycle](#tag/cycles/post/node-platform/v2/relays/cycle) instead. Power cycles the specified relay channels by turning them off and then back on after a specified duration. This legacy endpoint uses channel identifiers for relay selection. The newer endpoint provides the same functionality with improved relay function identification.
|
|
8278
8609
|
* @param {DefaultApiV1CycleRelaysRequest} requestParameters Request parameters.
|
|
@@ -8295,6 +8626,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8295
8626
|
* @throws {RequiredError}
|
|
8296
8627
|
*/
|
|
8297
8628
|
v1DeleteImageProcessingPlugin(requestParameters: DefaultApiV1DeleteImageProcessingPluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
8629
|
+
/**
|
|
8630
|
+
* Deletes one optical train configuration by label.
|
|
8631
|
+
* @param {DefaultApiV1DeleteOpticalTrainRequest} requestParameters Request parameters.
|
|
8632
|
+
* @param {*} [options] Override http request option.
|
|
8633
|
+
* @throws {RequiredError}
|
|
8634
|
+
*/
|
|
8635
|
+
v1DeleteOpticalTrain(requestParameters: DefaultApiV1DeleteOpticalTrainRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
8298
8636
|
/**
|
|
8299
8637
|
* Permanently deletes a video and its associated files from the system. Use this endpoint to manually remove unwanted videos and free up storage space. This action cannot be undone, so ensure you have downloaded or backed up any important files before deletion.
|
|
8300
8638
|
* @param {DefaultApiV1DeleteVideoRequest} requestParameters Request parameters.
|
|
@@ -8678,6 +9016,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8678
9016
|
* @throws {RequiredError}
|
|
8679
9017
|
*/
|
|
8680
9018
|
v1GetNetworkInterfaces(requestParameters?: DefaultApiV1GetNetworkInterfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<V1SystemNetworkInterface>>;
|
|
9019
|
+
/**
|
|
9020
|
+
* Retrieves one optical train configuration by label.
|
|
9021
|
+
* @param {DefaultApiV1GetOpticalTrainRequest} requestParameters Request parameters.
|
|
9022
|
+
* @param {*} [options] Override http request option.
|
|
9023
|
+
* @throws {RequiredError}
|
|
9024
|
+
*/
|
|
9025
|
+
v1GetOpticalTrain(requestParameters: DefaultApiV1GetOpticalTrainRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1OpticalTrain>;
|
|
9026
|
+
/**
|
|
9027
|
+
* Retrieves all configured optical trains and the optical train components assigned to each train.
|
|
9028
|
+
* @param {DefaultApiV1GetOpticalTrainsRequest} requestParameters Request parameters.
|
|
9029
|
+
* @param {*} [options] Override http request option.
|
|
9030
|
+
* @throws {RequiredError}
|
|
9031
|
+
*/
|
|
9032
|
+
v1GetOpticalTrains(requestParameters?: DefaultApiV1GetOpticalTrainsRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1OpticalTrains>;
|
|
8681
9033
|
/**
|
|
8682
9034
|
* Retrieves the current status of the optical tube dust cover that protects the primary mirror. The cover should be closed when the telescope is not in use to prevent dust accumulation on optical surfaces. Use this to verify cover state before imaging or to confirm the cover is closed during daytime. Returns V1OpticalTubeCoverStatus with connection and position information.
|
|
8683
9035
|
* @param {DefaultApiV1GetOpticalTubeCoverStatusRequest} requestParameters Request parameters.
|
|
@@ -8748,6 +9100,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8748
9100
|
* @throws {RequiredError}
|
|
8749
9101
|
*/
|
|
8750
9102
|
v1GetOpticalTubeStatuses(requestParameters?: DefaultApiV1GetOpticalTubeStatusesRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1OpticalTubeStatuses>;
|
|
9103
|
+
/**
|
|
9104
|
+
* Retrieves the current temperature sensor status for an optical tube assembly. Returns V1OpticalTubeTemperatureSensorGroupStatus containing the temperature reading from each sensor.
|
|
9105
|
+
* @param {DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusRequest} requestParameters Request parameters.
|
|
9106
|
+
* @param {*} [options] Override http request option.
|
|
9107
|
+
* @throws {RequiredError}
|
|
9108
|
+
*/
|
|
9109
|
+
v1GetOpticalTubeTemperatureSensorGroupStatus(requestParameters?: DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1OpticalTubeTemperatureSensorGroupStatus>;
|
|
9110
|
+
/**
|
|
9111
|
+
* Retrieves the current temperature sensor statuses grouped by optical tube. Use this endpoint to discover optical tube IDs and temperature readings before addressing a specific optical tube.
|
|
9112
|
+
* @param {DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusesRequest} requestParameters Request parameters.
|
|
9113
|
+
* @param {*} [options] Override http request option.
|
|
9114
|
+
* @throws {RequiredError}
|
|
9115
|
+
*/
|
|
9116
|
+
v1GetOpticalTubeTemperatureSensorGroupStatuses(requestParameters?: DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusesRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1OpticalTubeTemperatureSensorGroupStatuses>;
|
|
8751
9117
|
/**
|
|
8752
9118
|
* DEPRECATED: Use [/node-platform/v2/relays/status](#tag/status/get/node-platform/v2/relays/status) instead. Retrieves the current state of all power relays in the observatory. This legacy endpoint returns relay states by channel identifier. The newer endpoint provides the same information with improved relay function identification and additional connectivity details.
|
|
8753
9119
|
* @param {DefaultApiV1GetRelaysRequest} requestParameters Request parameters.
|
|
@@ -8836,14 +9202,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8836
9202
|
*/
|
|
8837
9203
|
v1GetSystemMetricNames(requestParameters?: DefaultApiV1GetSystemMetricNamesRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1SystemMetricNames>;
|
|
8838
9204
|
/**
|
|
8839
|
-
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis. This endpoint returns telemetry data such as temperatures, positions, and operational statistics over a specified time range. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is
|
|
9205
|
+
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis. This endpoint returns telemetry data such as temperatures, positions, and operational statistics over a specified time range. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is dynamically calculated based on the requested time window and the number of metrics queried to ensure system stability and optimal network performance. Wider time windows or queries with many metrics will automatically apply a coarser roll-up resolution. **Default time window behavior:** - If neither `after` nor `before` is specified, the time window defaults to the last **24 hours**. - If only one bound is provided, the other bound is inferred to create a 24-hour window.
|
|
8840
9206
|
* @param {DefaultApiV1GetSystemMetricsRequest} requestParameters Request parameters.
|
|
8841
9207
|
* @param {*} [options] Override http request option.
|
|
8842
9208
|
* @throws {RequiredError}
|
|
8843
9209
|
*/
|
|
8844
9210
|
v1GetSystemMetrics(requestParameters?: DefaultApiV1GetSystemMetricsRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1SystemMetrics>;
|
|
8845
9211
|
/**
|
|
8846
|
-
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis, grouped into compact metric collections to reduce response size over the wire. This endpoint returns the same metric data as `/node-platform/v1/system/metrics`, but each collection contains shared metric identity fields once (`name`, `type`, and `tags`) and stores measurements as compact `[measuredAt, value]` arrays. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is
|
|
9212
|
+
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis, grouped into compact metric collections to reduce response size over the wire. This endpoint returns the same metric data as `/node-platform/v1/system/metrics`, but each collection contains shared metric identity fields once (`name`, `type`, and `tags`) and stores measurements as compact `[measuredAt, value]` arrays. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is dynamically calculated based on the requested time window and the number of metrics queried to ensure system stability and optimal network performance. Wider time windows or queries with many metrics will automatically apply a coarser roll-up resolution. **Default time window behavior:** - If neither `after` nor `before` is specified, the time window defaults to the last **24 hours**. - If only one bound is provided, the other bound is inferred to create a 24-hour window.
|
|
8847
9213
|
* @param {DefaultApiV1GetSystemMetricsCollectionsRequest} requestParameters Request parameters.
|
|
8848
9214
|
* @param {*} [options] Override http request option.
|
|
8849
9215
|
* @throws {RequiredError}
|
|
@@ -9424,6 +9790,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
9424
9790
|
* @throws {RequiredError}
|
|
9425
9791
|
*/
|
|
9426
9792
|
v1UpdateImageProcessingPlugin(requestParameters: DefaultApiV1UpdateImageProcessingPluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1ImageProcessingPlugin>;
|
|
9793
|
+
/**
|
|
9794
|
+
* Updates an optical train configuration by replacing the component assignments for the provided label.
|
|
9795
|
+
* @param {DefaultApiV1UpdateOpticalTrainRequest} requestParameters Request parameters.
|
|
9796
|
+
* @param {*} [options] Override http request option.
|
|
9797
|
+
* @throws {RequiredError}
|
|
9798
|
+
*/
|
|
9799
|
+
v1UpdateOpticalTrain(requestParameters: DefaultApiV1UpdateOpticalTrainRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1OpticalTrain>;
|
|
9427
9800
|
/**
|
|
9428
9801
|
* Updates system settings with new configuration values. Use this endpoint to modify telescope behavior including mount motion parameters. Only include the settings you want to change in the request body. Changes take effect immediately and persist across system restarts.
|
|
9429
9802
|
* @param {DefaultApiV1UpdateSystemSettingsRequest} requestParameters Request parameters.
|
|
@@ -9487,6 +9860,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
9487
9860
|
* @throws {RequiredError}
|
|
9488
9861
|
*/
|
|
9489
9862
|
v2GetSystemEvents(requestParameters?: DefaultApiV2GetSystemEventsRequest, options?: RawAxiosRequestConfig): AxiosPromise<V2SystemEvents>;
|
|
9863
|
+
/**
|
|
9864
|
+
* Retrieves the comprehensive status of all connected hardware components in the telescope system, grouped by optical train and including optical train components that are not currently associated with an optical train.
|
|
9865
|
+
* @param {DefaultApiV2GetSystemStatusRequest} requestParameters Request parameters.
|
|
9866
|
+
* @param {*} [options] Override http request option.
|
|
9867
|
+
* @throws {RequiredError}
|
|
9868
|
+
*/
|
|
9869
|
+
v2GetSystemStatus(requestParameters?: DefaultApiV2GetSystemStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<V2SystemStatus>;
|
|
9490
9870
|
/**
|
|
9491
9871
|
* Powers off a specific relay to disable the connected equipment. Use this endpoint to shut down observatory devices when observations are complete or during maintenance. Ensure proper shutdown procedures are followed for the equipment before removing power, such as parking the mount or stopping camera operations.
|
|
9492
9872
|
* @param {DefaultApiV2TurnOffRelayRequest} requestParameters Request parameters.
|
|
@@ -9513,14 +9893,26 @@ export interface DefaultApiV1AddMountModelPointHereRequest {
|
|
|
9513
9893
|
readonly lineageId?: string;
|
|
9514
9894
|
}
|
|
9515
9895
|
/**
|
|
9516
|
-
* Request parameters for
|
|
9896
|
+
* Request parameters for v1AddMountModelPointUsingImage operation in DefaultApi.
|
|
9517
9897
|
*/
|
|
9518
|
-
export interface
|
|
9898
|
+
export interface DefaultApiV1AddMountModelPointUsingImageRequest {
|
|
9519
9899
|
readonly body: File;
|
|
9520
9900
|
/**
|
|
9521
9901
|
* Lineage ID required when requesting data from the cloud platform
|
|
9522
9902
|
*/
|
|
9523
9903
|
readonly lineageId?: string;
|
|
9904
|
+
/**
|
|
9905
|
+
* Motor A encoder position in degrees at the time the supplied image was captured.
|
|
9906
|
+
*/
|
|
9907
|
+
readonly motorAEncoderPositionDegrees?: number;
|
|
9908
|
+
/**
|
|
9909
|
+
* Motor B encoder position in degrees at the time the supplied image was captured.
|
|
9910
|
+
*/
|
|
9911
|
+
readonly motorBEncoderPositionDegrees?: number;
|
|
9912
|
+
/**
|
|
9913
|
+
* ISO 8601 timestamp when the supplied encoder positions were measured.
|
|
9914
|
+
*/
|
|
9915
|
+
readonly timestamp?: string;
|
|
9524
9916
|
}
|
|
9525
9917
|
/**
|
|
9526
9918
|
* Request parameters for v1AppendMountTrackPath operation in DefaultApi.
|
|
@@ -9602,6 +9994,15 @@ export interface DefaultApiV1CaptureImagesContinuouslyRequest {
|
|
|
9602
9994
|
*/
|
|
9603
9995
|
readonly lineageId?: string;
|
|
9604
9996
|
}
|
|
9997
|
+
/**
|
|
9998
|
+
* Request parameters for v1ClearEnclosureRotatorMotorLockout operation in DefaultApi.
|
|
9999
|
+
*/
|
|
10000
|
+
export interface DefaultApiV1ClearEnclosureRotatorMotorLockoutRequest {
|
|
10001
|
+
/**
|
|
10002
|
+
* Lineage ID required when requesting data from the cloud platform
|
|
10003
|
+
*/
|
|
10004
|
+
readonly lineageId?: string;
|
|
10005
|
+
}
|
|
9605
10006
|
/**
|
|
9606
10007
|
* Request parameters for v1ClearMountModel operation in DefaultApi.
|
|
9607
10008
|
*/
|
|
@@ -9667,6 +10068,16 @@ export interface DefaultApiV1CreateMountModelRequest {
|
|
|
9667
10068
|
*/
|
|
9668
10069
|
readonly lineageId?: string;
|
|
9669
10070
|
}
|
|
10071
|
+
/**
|
|
10072
|
+
* Request parameters for v1CreateOpticalTrain operation in DefaultApi.
|
|
10073
|
+
*/
|
|
10074
|
+
export interface DefaultApiV1CreateOpticalTrainRequest {
|
|
10075
|
+
readonly v1CreateOpticalTrainRequest: V1CreateOpticalTrainRequest;
|
|
10076
|
+
/**
|
|
10077
|
+
* Lineage ID required when requesting data from the cloud platform
|
|
10078
|
+
*/
|
|
10079
|
+
readonly lineageId?: string;
|
|
10080
|
+
}
|
|
9670
10081
|
/**
|
|
9671
10082
|
* Request parameters for v1CycleRelays operation in DefaultApi.
|
|
9672
10083
|
*/
|
|
@@ -9697,6 +10108,19 @@ export interface DefaultApiV1DeleteImageProcessingPluginRequest {
|
|
|
9697
10108
|
*/
|
|
9698
10109
|
readonly lineageId?: string;
|
|
9699
10110
|
}
|
|
10111
|
+
/**
|
|
10112
|
+
* Request parameters for v1DeleteOpticalTrain operation in DefaultApi.
|
|
10113
|
+
*/
|
|
10114
|
+
export interface DefaultApiV1DeleteOpticalTrainRequest {
|
|
10115
|
+
/**
|
|
10116
|
+
* Human-readable label of the optical train to delete.
|
|
10117
|
+
*/
|
|
10118
|
+
readonly label: string;
|
|
10119
|
+
/**
|
|
10120
|
+
* Lineage ID required when requesting data from the cloud platform
|
|
10121
|
+
*/
|
|
10122
|
+
readonly lineageId?: string;
|
|
10123
|
+
}
|
|
9700
10124
|
/**
|
|
9701
10125
|
* Request parameters for v1DeleteVideo operation in DefaultApi.
|
|
9702
10126
|
*/
|
|
@@ -9864,6 +10288,10 @@ export interface DefaultApiV1FindFocuserLimitsRequest {
|
|
|
9864
10288
|
* Lineage ID required when requesting data from the cloud platform
|
|
9865
10289
|
*/
|
|
9866
10290
|
readonly lineageId?: string;
|
|
10291
|
+
/**
|
|
10292
|
+
* Optional focuser ID. If provided, finds limits for that focuser instead of the default focuser.
|
|
10293
|
+
*/
|
|
10294
|
+
readonly id?: string;
|
|
9867
10295
|
}
|
|
9868
10296
|
/**
|
|
9869
10297
|
* Request parameters for v1GetActiveTasks operation in DefaultApi.
|
|
@@ -10276,6 +10704,28 @@ export interface DefaultApiV1GetNetworkInterfacesRequest {
|
|
|
10276
10704
|
*/
|
|
10277
10705
|
readonly lineageId?: string;
|
|
10278
10706
|
}
|
|
10707
|
+
/**
|
|
10708
|
+
* Request parameters for v1GetOpticalTrain operation in DefaultApi.
|
|
10709
|
+
*/
|
|
10710
|
+
export interface DefaultApiV1GetOpticalTrainRequest {
|
|
10711
|
+
/**
|
|
10712
|
+
* Human-readable label of the optical train to retrieve.
|
|
10713
|
+
*/
|
|
10714
|
+
readonly label: string;
|
|
10715
|
+
/**
|
|
10716
|
+
* Lineage ID required when requesting data from the cloud platform
|
|
10717
|
+
*/
|
|
10718
|
+
readonly lineageId?: string;
|
|
10719
|
+
}
|
|
10720
|
+
/**
|
|
10721
|
+
* Request parameters for v1GetOpticalTrains operation in DefaultApi.
|
|
10722
|
+
*/
|
|
10723
|
+
export interface DefaultApiV1GetOpticalTrainsRequest {
|
|
10724
|
+
/**
|
|
10725
|
+
* Lineage ID required when requesting data from the cloud platform
|
|
10726
|
+
*/
|
|
10727
|
+
readonly lineageId?: string;
|
|
10728
|
+
}
|
|
10279
10729
|
/**
|
|
10280
10730
|
* Request parameters for v1GetOpticalTubeCoverStatus operation in DefaultApi.
|
|
10281
10731
|
*/
|
|
@@ -10386,6 +10836,28 @@ export interface DefaultApiV1GetOpticalTubeStatusesRequest {
|
|
|
10386
10836
|
*/
|
|
10387
10837
|
readonly lineageId?: string;
|
|
10388
10838
|
}
|
|
10839
|
+
/**
|
|
10840
|
+
* Request parameters for v1GetOpticalTubeTemperatureSensorGroupStatus operation in DefaultApi.
|
|
10841
|
+
*/
|
|
10842
|
+
export interface DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusRequest {
|
|
10843
|
+
/**
|
|
10844
|
+
* Lineage ID required when requesting data from the cloud platform
|
|
10845
|
+
*/
|
|
10846
|
+
readonly lineageId?: string;
|
|
10847
|
+
/**
|
|
10848
|
+
* Optional optical tube ID. If provided, returns temperature sensor statuses for that optical tube instead of the default optical tube.
|
|
10849
|
+
*/
|
|
10850
|
+
readonly id?: string;
|
|
10851
|
+
}
|
|
10852
|
+
/**
|
|
10853
|
+
* Request parameters for v1GetOpticalTubeTemperatureSensorGroupStatuses operation in DefaultApi.
|
|
10854
|
+
*/
|
|
10855
|
+
export interface DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusesRequest {
|
|
10856
|
+
/**
|
|
10857
|
+
* Lineage ID required when requesting data from the cloud platform
|
|
10858
|
+
*/
|
|
10859
|
+
readonly lineageId?: string;
|
|
10860
|
+
}
|
|
10389
10861
|
/**
|
|
10390
10862
|
* Request parameters for v1GetRelays operation in DefaultApi.
|
|
10391
10863
|
*/
|
|
@@ -11362,6 +11834,16 @@ export interface DefaultApiV1UpdateImageProcessingPluginRequest {
|
|
|
11362
11834
|
*/
|
|
11363
11835
|
readonly lineageId?: string;
|
|
11364
11836
|
}
|
|
11837
|
+
/**
|
|
11838
|
+
* Request parameters for v1UpdateOpticalTrain operation in DefaultApi.
|
|
11839
|
+
*/
|
|
11840
|
+
export interface DefaultApiV1UpdateOpticalTrainRequest {
|
|
11841
|
+
readonly v1UpdateOpticalTrainRequest: V1UpdateOpticalTrainRequest;
|
|
11842
|
+
/**
|
|
11843
|
+
* Lineage ID required when requesting data from the cloud platform
|
|
11844
|
+
*/
|
|
11845
|
+
readonly lineageId?: string;
|
|
11846
|
+
}
|
|
11365
11847
|
/**
|
|
11366
11848
|
* Request parameters for v1UpdateSystemSettings operation in DefaultApi.
|
|
11367
11849
|
*/
|
|
@@ -11472,6 +11954,15 @@ export interface DefaultApiV2GetSystemEventsRequest {
|
|
|
11472
11954
|
*/
|
|
11473
11955
|
readonly limit?: number;
|
|
11474
11956
|
}
|
|
11957
|
+
/**
|
|
11958
|
+
* Request parameters for v2GetSystemStatus operation in DefaultApi.
|
|
11959
|
+
*/
|
|
11960
|
+
export interface DefaultApiV2GetSystemStatusRequest {
|
|
11961
|
+
/**
|
|
11962
|
+
* Lineage ID required when requesting data from the cloud platform
|
|
11963
|
+
*/
|
|
11964
|
+
readonly lineageId?: string;
|
|
11965
|
+
}
|
|
11475
11966
|
/**
|
|
11476
11967
|
* Request parameters for v2TurnOffRelay operation in DefaultApi.
|
|
11477
11968
|
*/
|
|
@@ -11504,12 +11995,12 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11504
11995
|
*/
|
|
11505
11996
|
v1AddMountModelPointHere(requestParameters: DefaultApiV1AddMountModelPointHereRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any, {}>>;
|
|
11506
11997
|
/**
|
|
11507
|
-
* Adds a single manual calibration point to the pointing model. The node will attempt to plate-solve the supplied image to determine J2000 right ascension and declination and pair it with the mount
|
|
11508
|
-
* @param {
|
|
11998
|
+
* Adds a single manual calibration point to the pointing model. The node will attempt to plate-solve the supplied image to determine J2000 right ascension and declination and pair it with the mount mechanical position to record a new correction point. Use this to refine the model with a known sky position without running a full automated survey. Returns an empty success response when the point is added.
|
|
11999
|
+
* @param {DefaultApiV1AddMountModelPointUsingImageRequest} requestParameters Request parameters.
|
|
11509
12000
|
* @param {*} [options] Override http request option.
|
|
11510
12001
|
* @throws {RequiredError}
|
|
11511
12002
|
*/
|
|
11512
|
-
|
|
12003
|
+
v1AddMountModelPointUsingImage(requestParameters: DefaultApiV1AddMountModelPointUsingImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any, {}>>;
|
|
11513
12004
|
/**
|
|
11514
12005
|
* Updates the current custom path tracking session by appending control points. The trackingSessionId and frame must match the current session.
|
|
11515
12006
|
* @param {DefaultApiV1AppendMountTrackPathRequest} requestParameters Request parameters.
|
|
@@ -11568,6 +12059,13 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11568
12059
|
* @throws {RequiredError}
|
|
11569
12060
|
*/
|
|
11570
12061
|
v1CaptureImagesContinuously(requestParameters: DefaultApiV1CaptureImagesContinuouslyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any, {}>>;
|
|
12062
|
+
/**
|
|
12063
|
+
* Clears a latched dome rotator motor lockout condition after the underlying cause has been investigated and it is safe to permit rotator motion again. To recover from the lockout zone, the edge controller temporarily disables the limiter, moves the enclosure rotator back into the valid range, and then re-enables the limiter. This operation is a no-op when no motor lockout is active.
|
|
12064
|
+
* @param {DefaultApiV1ClearEnclosureRotatorMotorLockoutRequest} requestParameters Request parameters.
|
|
12065
|
+
* @param {*} [options] Override http request option.
|
|
12066
|
+
* @throws {RequiredError}
|
|
12067
|
+
*/
|
|
12068
|
+
v1ClearEnclosureRotatorMotorLockout(requestParameters?: DefaultApiV1ClearEnclosureRotatorMotorLockoutRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any, {}>>;
|
|
11571
12069
|
/**
|
|
11572
12070
|
* Clears all calibration points from the current pointing model, removing every correction the mount applies to its raw mechanical positioning. Use this to discard an inaccurate model before building a new one, or to reset to uncorrected pointing. Returns an empty success response when the model is cleared.
|
|
11573
12071
|
* @param {DefaultApiV1ClearMountModelRequest} requestParameters Request parameters.
|
|
@@ -11619,6 +12117,13 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11619
12117
|
* @throws {RequiredError}
|
|
11620
12118
|
*/
|
|
11621
12119
|
v1CreateMountModel(requestParameters: DefaultApiV1CreateMountModelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1Task, any, {}>>;
|
|
12120
|
+
/**
|
|
12121
|
+
* Creates an optical train configuration by assigning optical train components to a human-readable label.
|
|
12122
|
+
* @param {DefaultApiV1CreateOpticalTrainRequest} requestParameters Request parameters.
|
|
12123
|
+
* @param {*} [options] Override http request option.
|
|
12124
|
+
* @throws {RequiredError}
|
|
12125
|
+
*/
|
|
12126
|
+
v1CreateOpticalTrain(requestParameters: DefaultApiV1CreateOpticalTrainRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1OpticalTrain, any, {}>>;
|
|
11622
12127
|
/**
|
|
11623
12128
|
* DEPRECATED: Use [/node-platform/v2/relays/cycle](#tag/cycles/post/node-platform/v2/relays/cycle) instead. Power cycles the specified relay channels by turning them off and then back on after a specified duration. This legacy endpoint uses channel identifiers for relay selection. The newer endpoint provides the same functionality with improved relay function identification.
|
|
11624
12129
|
* @param {DefaultApiV1CycleRelaysRequest} requestParameters Request parameters.
|
|
@@ -11641,6 +12146,13 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11641
12146
|
* @throws {RequiredError}
|
|
11642
12147
|
*/
|
|
11643
12148
|
v1DeleteImageProcessingPlugin(requestParameters: DefaultApiV1DeleteImageProcessingPluginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any, {}>>;
|
|
12149
|
+
/**
|
|
12150
|
+
* Deletes one optical train configuration by label.
|
|
12151
|
+
* @param {DefaultApiV1DeleteOpticalTrainRequest} requestParameters Request parameters.
|
|
12152
|
+
* @param {*} [options] Override http request option.
|
|
12153
|
+
* @throws {RequiredError}
|
|
12154
|
+
*/
|
|
12155
|
+
v1DeleteOpticalTrain(requestParameters: DefaultApiV1DeleteOpticalTrainRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any, {}>>;
|
|
11644
12156
|
/**
|
|
11645
12157
|
* Permanently deletes a video and its associated files from the system. Use this endpoint to manually remove unwanted videos and free up storage space. This action cannot be undone, so ensure you have downloaded or backed up any important files before deletion.
|
|
11646
12158
|
* @param {DefaultApiV1DeleteVideoRequest} requestParameters Request parameters.
|
|
@@ -12024,6 +12536,20 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12024
12536
|
* @throws {RequiredError}
|
|
12025
12537
|
*/
|
|
12026
12538
|
v1GetNetworkInterfaces(requestParameters?: DefaultApiV1GetNetworkInterfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SystemNetworkInterface[], any, {}>>;
|
|
12539
|
+
/**
|
|
12540
|
+
* Retrieves one optical train configuration by label.
|
|
12541
|
+
* @param {DefaultApiV1GetOpticalTrainRequest} requestParameters Request parameters.
|
|
12542
|
+
* @param {*} [options] Override http request option.
|
|
12543
|
+
* @throws {RequiredError}
|
|
12544
|
+
*/
|
|
12545
|
+
v1GetOpticalTrain(requestParameters: DefaultApiV1GetOpticalTrainRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1OpticalTrain, any, {}>>;
|
|
12546
|
+
/**
|
|
12547
|
+
* Retrieves all configured optical trains and the optical train components assigned to each train.
|
|
12548
|
+
* @param {DefaultApiV1GetOpticalTrainsRequest} requestParameters Request parameters.
|
|
12549
|
+
* @param {*} [options] Override http request option.
|
|
12550
|
+
* @throws {RequiredError}
|
|
12551
|
+
*/
|
|
12552
|
+
v1GetOpticalTrains(requestParameters?: DefaultApiV1GetOpticalTrainsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1OpticalTrains, any, {}>>;
|
|
12027
12553
|
/**
|
|
12028
12554
|
* Retrieves the current status of the optical tube dust cover that protects the primary mirror. The cover should be closed when the telescope is not in use to prevent dust accumulation on optical surfaces. Use this to verify cover state before imaging or to confirm the cover is closed during daytime. Returns V1OpticalTubeCoverStatus with connection and position information.
|
|
12029
12555
|
* @param {DefaultApiV1GetOpticalTubeCoverStatusRequest} requestParameters Request parameters.
|
|
@@ -12094,6 +12620,20 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12094
12620
|
* @throws {RequiredError}
|
|
12095
12621
|
*/
|
|
12096
12622
|
v1GetOpticalTubeStatuses(requestParameters?: DefaultApiV1GetOpticalTubeStatusesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1OpticalTubeStatuses, any, {}>>;
|
|
12623
|
+
/**
|
|
12624
|
+
* Retrieves the current temperature sensor status for an optical tube assembly. Returns V1OpticalTubeTemperatureSensorGroupStatus containing the temperature reading from each sensor.
|
|
12625
|
+
* @param {DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusRequest} requestParameters Request parameters.
|
|
12626
|
+
* @param {*} [options] Override http request option.
|
|
12627
|
+
* @throws {RequiredError}
|
|
12628
|
+
*/
|
|
12629
|
+
v1GetOpticalTubeTemperatureSensorGroupStatus(requestParameters?: DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1OpticalTubeTemperatureSensorGroupStatus, any, {}>>;
|
|
12630
|
+
/**
|
|
12631
|
+
* Retrieves the current temperature sensor statuses grouped by optical tube. Use this endpoint to discover optical tube IDs and temperature readings before addressing a specific optical tube.
|
|
12632
|
+
* @param {DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusesRequest} requestParameters Request parameters.
|
|
12633
|
+
* @param {*} [options] Override http request option.
|
|
12634
|
+
* @throws {RequiredError}
|
|
12635
|
+
*/
|
|
12636
|
+
v1GetOpticalTubeTemperatureSensorGroupStatuses(requestParameters?: DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1OpticalTubeTemperatureSensorGroupStatuses, any, {}>>;
|
|
12097
12637
|
/**
|
|
12098
12638
|
* DEPRECATED: Use [/node-platform/v2/relays/status](#tag/status/get/node-platform/v2/relays/status) instead. Retrieves the current state of all power relays in the observatory. This legacy endpoint returns relay states by channel identifier. The newer endpoint provides the same information with improved relay function identification and additional connectivity details.
|
|
12099
12639
|
* @param {DefaultApiV1GetRelaysRequest} requestParameters Request parameters.
|
|
@@ -12182,14 +12722,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12182
12722
|
*/
|
|
12183
12723
|
v1GetSystemMetricNames(requestParameters?: DefaultApiV1GetSystemMetricNamesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SystemMetricNames, any, {}>>;
|
|
12184
12724
|
/**
|
|
12185
|
-
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis. This endpoint returns telemetry data such as temperatures, positions, and operational statistics over a specified time range. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is
|
|
12725
|
+
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis. This endpoint returns telemetry data such as temperatures, positions, and operational statistics over a specified time range. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is dynamically calculated based on the requested time window and the number of metrics queried to ensure system stability and optimal network performance. Wider time windows or queries with many metrics will automatically apply a coarser roll-up resolution. **Default time window behavior:** - If neither `after` nor `before` is specified, the time window defaults to the last **24 hours**. - If only one bound is provided, the other bound is inferred to create a 24-hour window.
|
|
12186
12726
|
* @param {DefaultApiV1GetSystemMetricsRequest} requestParameters Request parameters.
|
|
12187
12727
|
* @param {*} [options] Override http request option.
|
|
12188
12728
|
* @throws {RequiredError}
|
|
12189
12729
|
*/
|
|
12190
12730
|
v1GetSystemMetrics(requestParameters?: DefaultApiV1GetSystemMetricsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SystemMetrics, any, {}>>;
|
|
12191
12731
|
/**
|
|
12192
|
-
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis, grouped into compact metric collections to reduce response size over the wire. This endpoint returns the same metric data as `/node-platform/v1/system/metrics`, but each collection contains shared metric identity fields once (`name`, `type`, and `tags`) and stores measurements as compact `[measuredAt, value]` arrays. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is
|
|
12732
|
+
* Retrieves time-series metrics data from the telescope system for performance monitoring and analysis, grouped into compact metric collections to reduce response size over the wire. This endpoint returns the same metric data as `/node-platform/v1/system/metrics`, but each collection contains shared metric identity fields once (`name`, `type`, and `tags`) and stores measurements as compact `[measuredAt, value]` arrays. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is dynamically calculated based on the requested time window and the number of metrics queried to ensure system stability and optimal network performance. Wider time windows or queries with many metrics will automatically apply a coarser roll-up resolution. **Default time window behavior:** - If neither `after` nor `before` is specified, the time window defaults to the last **24 hours**. - If only one bound is provided, the other bound is inferred to create a 24-hour window.
|
|
12193
12733
|
* @param {DefaultApiV1GetSystemMetricsCollectionsRequest} requestParameters Request parameters.
|
|
12194
12734
|
* @param {*} [options] Override http request option.
|
|
12195
12735
|
* @throws {RequiredError}
|
|
@@ -12770,6 +13310,13 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12770
13310
|
* @throws {RequiredError}
|
|
12771
13311
|
*/
|
|
12772
13312
|
v1UpdateImageProcessingPlugin(requestParameters: DefaultApiV1UpdateImageProcessingPluginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ImageProcessingPlugin, any, {}>>;
|
|
13313
|
+
/**
|
|
13314
|
+
* Updates an optical train configuration by replacing the component assignments for the provided label.
|
|
13315
|
+
* @param {DefaultApiV1UpdateOpticalTrainRequest} requestParameters Request parameters.
|
|
13316
|
+
* @param {*} [options] Override http request option.
|
|
13317
|
+
* @throws {RequiredError}
|
|
13318
|
+
*/
|
|
13319
|
+
v1UpdateOpticalTrain(requestParameters: DefaultApiV1UpdateOpticalTrainRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1OpticalTrain, any, {}>>;
|
|
12773
13320
|
/**
|
|
12774
13321
|
* Updates system settings with new configuration values. Use this endpoint to modify telescope behavior including mount motion parameters. Only include the settings you want to change in the request body. Changes take effect immediately and persist across system restarts.
|
|
12775
13322
|
* @param {DefaultApiV1UpdateSystemSettingsRequest} requestParameters Request parameters.
|
|
@@ -12833,6 +13380,13 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12833
13380
|
* @throws {RequiredError}
|
|
12834
13381
|
*/
|
|
12835
13382
|
v2GetSystemEvents(requestParameters?: DefaultApiV2GetSystemEventsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V2SystemEvents, any, {}>>;
|
|
13383
|
+
/**
|
|
13384
|
+
* Retrieves the comprehensive status of all connected hardware components in the telescope system, grouped by optical train and including optical train components that are not currently associated with an optical train.
|
|
13385
|
+
* @param {DefaultApiV2GetSystemStatusRequest} requestParameters Request parameters.
|
|
13386
|
+
* @param {*} [options] Override http request option.
|
|
13387
|
+
* @throws {RequiredError}
|
|
13388
|
+
*/
|
|
13389
|
+
v2GetSystemStatus(requestParameters?: DefaultApiV2GetSystemStatusRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V2SystemStatus, any, {}>>;
|
|
12836
13390
|
/**
|
|
12837
13391
|
* Powers off a specific relay to disable the connected equipment. Use this endpoint to shut down observatory devices when observations are complete or during maintenance. Ensure proper shutdown procedures are followed for the equipment before removing power, such as parking the mount or stopping camera operations.
|
|
12838
13392
|
* @param {DefaultApiV2TurnOffRelayRequest} requestParameters Request parameters.
|