@ourskyai/node_platform-api 1.4.133 → 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 +13 -1
- package/README.md +25 -4
- package/api.ts +1099 -50
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +635 -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 +635 -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/V1MountModel.md +2 -0
- package/docs/V1MountModelErrors.md +31 -0
- package/docs/V1MountModelPoint.md +6 -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/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
|
*/
|
|
@@ -2946,11 +2992,41 @@ export interface V1MountModel {
|
|
|
2946
2992
|
* ISO 8601 timestamp indicating when this pointing model was created. Models may need rebuilding if mount mechanics change significantly.
|
|
2947
2993
|
*/
|
|
2948
2994
|
'createdAt': string;
|
|
2995
|
+
'errors'?: V1MountModelErrors;
|
|
2949
2996
|
/**
|
|
2950
2997
|
* Array of calibration points where plate solving determined the actual vs commanded position. More points generally yield better accuracy.
|
|
2951
2998
|
*/
|
|
2952
2999
|
'points': Array<V1MountModelPoint>;
|
|
2953
3000
|
}
|
|
3001
|
+
/**
|
|
3002
|
+
* Overall pointing-model fit-quality metrics computed from the calibration points. All error magnitudes are in arcseconds; lower values indicate a more accurate model.
|
|
3003
|
+
*/
|
|
3004
|
+
export interface V1MountModelErrors {
|
|
3005
|
+
/**
|
|
3006
|
+
* Largest single pointing residual in arcseconds over the points used in the fit.
|
|
3007
|
+
*/
|
|
3008
|
+
'maxErrorArcsec': number;
|
|
3009
|
+
/**
|
|
3010
|
+
* Number of calibration points currently in the pointing model.
|
|
3011
|
+
*/
|
|
3012
|
+
'numPoints': number;
|
|
3013
|
+
/**
|
|
3014
|
+
* Number of error-model terms actively fitted. More terms can model more mechanical effects but require enough points to stay well-conditioned.
|
|
3015
|
+
*/
|
|
3016
|
+
'numTermsInUse': number;
|
|
3017
|
+
/**
|
|
3018
|
+
* Polar/azimuth axis misalignment toward north in arcseconds, as estimated by the model.
|
|
3019
|
+
*/
|
|
3020
|
+
'polarErrorNorthArcsec': number;
|
|
3021
|
+
/**
|
|
3022
|
+
* Polar/azimuth axis misalignment toward west in arcseconds, as estimated by the model.
|
|
3023
|
+
*/
|
|
3024
|
+
'polarErrorWestArcsec': number;
|
|
3025
|
+
/**
|
|
3026
|
+
* RMS pointing residual in arcseconds over the points used in the fit. The headline accuracy figure for the model.
|
|
3027
|
+
*/
|
|
3028
|
+
'rmsErrorArcsec': number;
|
|
3029
|
+
}
|
|
2954
3030
|
/**
|
|
2955
3031
|
* A single calibration point in the pointing model recording the plate-solved position at a specific sky location.
|
|
2956
3032
|
*/
|
|
@@ -2967,10 +3043,22 @@ export interface V1MountModelPoint {
|
|
|
2967
3043
|
* Declination determined by plate solving at this point in degrees (J2000 epoch). Used to calculate pointing corrections.
|
|
2968
3044
|
*/
|
|
2969
3045
|
'decDegrees': number;
|
|
3046
|
+
/**
|
|
3047
|
+
* Declination component of this point\'s residual in arcseconds. Absent when the mount is unavailable.
|
|
3048
|
+
*/
|
|
3049
|
+
'decErrArcsec'?: number;
|
|
3050
|
+
/**
|
|
3051
|
+
* Total angular residual at this point in arcseconds: the distance between where the pointing model predicts the point and where plate solving measured it. Absent when the mount is unavailable. Lower is better.
|
|
3052
|
+
*/
|
|
3053
|
+
'distErrArcsec'?: number;
|
|
2970
3054
|
/**
|
|
2971
3055
|
* Right ascension determined by plate solving at this point in degrees (J2000 epoch). Used to calculate pointing corrections.
|
|
2972
3056
|
*/
|
|
2973
3057
|
'raDegrees': number;
|
|
3058
|
+
/**
|
|
3059
|
+
* Right-ascension component of this point\'s residual in arcseconds (sky error, corrected for declination). Absent when the mount is unavailable.
|
|
3060
|
+
*/
|
|
3061
|
+
'raErrArcsec'?: number;
|
|
2974
3062
|
}
|
|
2975
3063
|
/**
|
|
2976
3064
|
* Configuration settings for telescope mount motor motion control including slew speed, acceleration, and travel limits.
|
|
@@ -3231,13 +3319,68 @@ export interface V1OpticalPowerMeterStatus {
|
|
|
3231
3319
|
'connected': boolean;
|
|
3232
3320
|
}
|
|
3233
3321
|
/**
|
|
3234
|
-
*
|
|
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.
|
|
3235
3378
|
*/
|
|
3236
3379
|
export interface V1OpticalTubeCoverSelectorRequest {
|
|
3237
3380
|
/**
|
|
3238
|
-
* 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.
|
|
3239
3382
|
*/
|
|
3240
|
-
'
|
|
3383
|
+
'opticalTubeCoverId'?: string;
|
|
3241
3384
|
}
|
|
3242
3385
|
/**
|
|
3243
3386
|
* Current status of the optical tube dust cover including connection state and open/closed position.
|
|
@@ -3393,7 +3536,7 @@ export interface V1OpticalTubeStatus {
|
|
|
3393
3536
|
*/
|
|
3394
3537
|
'id'?: string | null;
|
|
3395
3538
|
'm3'?: V1OpticalTubeM3Status;
|
|
3396
|
-
'temperatureSensors'?:
|
|
3539
|
+
'temperatureSensors'?: V1OpticalTubeTemperatureSensorGroupStatus;
|
|
3397
3540
|
}
|
|
3398
3541
|
/**
|
|
3399
3542
|
* Collection of comprehensive optical tube statuses, one per optical tube.
|
|
@@ -3401,6 +3544,25 @@ export interface V1OpticalTubeStatus {
|
|
|
3401
3544
|
export interface V1OpticalTubeStatuses {
|
|
3402
3545
|
'statuses': Array<V1OpticalTubeStatus>;
|
|
3403
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
|
+
}
|
|
3404
3566
|
/**
|
|
3405
3567
|
* Identifies the temperature sensor location within the optical tube assembly.
|
|
3406
3568
|
*/
|
|
@@ -3421,15 +3583,6 @@ export interface V1OpticalTubeTemperatureSensorStatus {
|
|
|
3421
3583
|
*/
|
|
3422
3584
|
'temperatureCelsius': number;
|
|
3423
3585
|
}
|
|
3424
|
-
/**
|
|
3425
|
-
* Collection of temperature readings from sensors in the optical tube assembly.
|
|
3426
|
-
*/
|
|
3427
|
-
export interface V1OpticalTubeTemperatureSensorStatuses {
|
|
3428
|
-
/**
|
|
3429
|
-
* Array of temperature readings, one for each sensor in the optical tube assembly.
|
|
3430
|
-
*/
|
|
3431
|
-
'statuses': Array<V1OpticalTubeTemperatureSensorStatus>;
|
|
3432
|
-
}
|
|
3433
3586
|
/**
|
|
3434
3587
|
* Notify that a peer has changed status
|
|
3435
3588
|
*/
|
|
@@ -4232,9 +4385,9 @@ export interface V1SystemMetrics {
|
|
|
4232
4385
|
*/
|
|
4233
4386
|
export interface V1SystemMetricsCollection {
|
|
4234
4387
|
/**
|
|
4235
|
-
* 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.
|
|
4236
4389
|
*/
|
|
4237
|
-
'metrics': Array<Array<
|
|
4390
|
+
'metrics': Array<Array<number>>;
|
|
4238
4391
|
/**
|
|
4239
4392
|
* The metric identifier that describes what is being measured, such as cpu_temperature or mount_position_altitude.
|
|
4240
4393
|
*/
|
|
@@ -4401,13 +4554,14 @@ export interface V1Task {
|
|
|
4401
4554
|
'type': V1TaskType;
|
|
4402
4555
|
}
|
|
4403
4556
|
/**
|
|
4404
|
-
* 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
|
|
4405
4558
|
*/
|
|
4406
4559
|
export declare const V1TaskType: {
|
|
4407
4560
|
readonly CREATE_MOUNT_MODEL: "CREATE_MOUNT_MODEL";
|
|
4408
4561
|
readonly CREATE_ELEVATION_MASK: "CREATE_ELEVATION_MASK";
|
|
4409
4562
|
readonly CALIBRATE_ENCLOSURE_ROTATOR: "CALIBRATE_ENCLOSURE_ROTATOR";
|
|
4410
4563
|
readonly CALIBRATE_ENCLOSURE_WINDOW: "CALIBRATE_ENCLOSURE_WINDOW";
|
|
4564
|
+
readonly CALIBRATE_MOUNT_MOTOR_A_UNWINDER: "CALIBRATE_MOUNT_MOTOR_A_UNWINDER";
|
|
4411
4565
|
readonly RUN_AUTOFOCUS: "RUN_AUTOFOCUS";
|
|
4412
4566
|
readonly RUN_PERPETUAL_INSTRUCTION_LOOP: "RUN_PERPETUAL_INSTRUCTION_LOOP";
|
|
4413
4567
|
readonly STARTUP_WIZARD: "STARTUP_WIZARD";
|
|
@@ -4567,6 +4721,22 @@ export declare const V1UIOperationMode: {
|
|
|
4567
4721
|
readonly MANUAL: "MANUAL";
|
|
4568
4722
|
};
|
|
4569
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
|
+
}
|
|
4570
4740
|
/**
|
|
4571
4741
|
* Request payload for replacing the current elevation mask points stored for a node.
|
|
4572
4742
|
*/
|
|
@@ -4601,6 +4771,35 @@ export interface V1UpdateImageProcessingPluginRequest {
|
|
|
4601
4771
|
'name'?: string;
|
|
4602
4772
|
'pluginId': string;
|
|
4603
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
|
+
}
|
|
4604
4803
|
/**
|
|
4605
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.
|
|
4606
4805
|
*/
|
|
@@ -4834,6 +5033,8 @@ export declare const V2SystemEventType: {
|
|
|
4834
5033
|
readonly CAPTURE_IMAGES_CONTINUOUSLY: "CAPTURE_IMAGES_CONTINUOUSLY";
|
|
4835
5034
|
readonly CALIBRATE_ENCLOSURE_ROTATOR: "CALIBRATE_ENCLOSURE_ROTATOR";
|
|
4836
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";
|
|
4837
5038
|
readonly CLOSE_ENCLOSURE_SHUTTERS: "CLOSE_ENCLOSURE_SHUTTERS";
|
|
4838
5039
|
readonly CLOSE_OPTICAL_TUBE_COVER: "CLOSE_OPTICAL_TUBE_COVER";
|
|
4839
5040
|
readonly CREATE_ELEVATION_MASK: "CREATE_ELEVATION_MASK";
|
|
@@ -4937,6 +5138,20 @@ export interface V2SystemEvents {
|
|
|
4937
5138
|
*/
|
|
4938
5139
|
'systemEvents': Array<V2SystemEvent>;
|
|
4939
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
|
+
}
|
|
4940
5155
|
/**
|
|
4941
5156
|
* Request parameters for turning off a specific power relay. Specify which equipment function to power off.
|
|
4942
5157
|
*/
|
|
@@ -5145,13 +5360,16 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5145
5360
|
*/
|
|
5146
5361
|
v1AddMountModelPointHere: (v1AddMountModelPointHereRequest: V1AddMountModelPointHereRequest, lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5147
5362
|
/**
|
|
5148
|
-
* 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.
|
|
5149
5364
|
* @param {File} body
|
|
5150
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.
|
|
5151
5369
|
* @param {*} [options] Override http request option.
|
|
5152
5370
|
* @throws {RequiredError}
|
|
5153
5371
|
*/
|
|
5154
|
-
|
|
5372
|
+
v1AddMountModelPointUsingImage: (body: File, lineageId?: string, motorAEncoderPositionDegrees?: number, motorBEncoderPositionDegrees?: number, timestamp?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5155
5373
|
/**
|
|
5156
5374
|
* Updates the current custom path tracking session by appending control points. The trackingSessionId and frame must match the current session.
|
|
5157
5375
|
* @param {V1AppendMountTrackPathRequest} v1AppendMountTrackPathRequest
|
|
@@ -5218,6 +5436,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5218
5436
|
* @throws {RequiredError}
|
|
5219
5437
|
*/
|
|
5220
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>;
|
|
5221
5446
|
/**
|
|
5222
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.
|
|
5223
5448
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -5271,6 +5496,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5271
5496
|
* @throws {RequiredError}
|
|
5272
5497
|
*/
|
|
5273
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>;
|
|
5274
5507
|
/**
|
|
5275
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.
|
|
5276
5509
|
* @param {V1CycleRelaysRequest} v1CycleRelaysRequest
|
|
@@ -5296,6 +5529,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5296
5529
|
* @throws {RequiredError}
|
|
5297
5530
|
*/
|
|
5298
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>;
|
|
5299
5540
|
/**
|
|
5300
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.
|
|
5301
5542
|
* @param {V1DeleteVideoRequest} v1DeleteVideoRequest
|
|
@@ -5424,10 +5665,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5424
5665
|
/**
|
|
5425
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.
|
|
5426
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.
|
|
5427
5669
|
* @param {*} [options] Override http request option.
|
|
5428
5670
|
* @throws {RequiredError}
|
|
5429
5671
|
*/
|
|
5430
|
-
v1FindFocuserLimits: (lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5672
|
+
v1FindFocuserLimits: (lineageId?: string, id?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5431
5673
|
/**
|
|
5432
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.
|
|
5433
5675
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -5709,6 +5951,21 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5709
5951
|
* @throws {RequiredError}
|
|
5710
5952
|
*/
|
|
5711
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>;
|
|
5712
5969
|
/**
|
|
5713
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.
|
|
5714
5971
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -5784,6 +6041,21 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5784
6041
|
* @throws {RequiredError}
|
|
5785
6042
|
*/
|
|
5786
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>;
|
|
5787
6059
|
/**
|
|
5788
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.
|
|
5789
6061
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -5879,7 +6151,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5879
6151
|
*/
|
|
5880
6152
|
v1GetSystemMetricNames: (lineageId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5881
6153
|
/**
|
|
5882
|
-
* 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.
|
|
5883
6155
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
5884
6156
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
5885
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.
|
|
@@ -5889,7 +6161,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5889
6161
|
*/
|
|
5890
6162
|
v1GetSystemMetrics: (lineageId?: string, metricName?: string, after?: string, before?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5891
6163
|
/**
|
|
5892
|
-
* 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.
|
|
5893
6165
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
5894
6166
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
5895
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.
|
|
@@ -6527,6 +6799,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6527
6799
|
* @throws {RequiredError}
|
|
6528
6800
|
*/
|
|
6529
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>;
|
|
6530
6810
|
/**
|
|
6531
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.
|
|
6532
6812
|
* @param {V1SystemSettings} v1SystemSettings
|
|
@@ -6601,6 +6881,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6601
6881
|
* @throws {RequiredError}
|
|
6602
6882
|
*/
|
|
6603
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>;
|
|
6604
6891
|
/**
|
|
6605
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.
|
|
6606
6893
|
* @param {V2TurnOffRelayRequest} v2TurnOffRelayRequest
|
|
@@ -6631,13 +6918,16 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6631
6918
|
*/
|
|
6632
6919
|
v1AddMountModelPointHere(v1AddMountModelPointHereRequest: V1AddMountModelPointHereRequest, lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
6633
6920
|
/**
|
|
6634
|
-
* 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.
|
|
6635
6922
|
* @param {File} body
|
|
6636
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.
|
|
6637
6927
|
* @param {*} [options] Override http request option.
|
|
6638
6928
|
* @throws {RequiredError}
|
|
6639
6929
|
*/
|
|
6640
|
-
|
|
6930
|
+
v1AddMountModelPointUsingImage(body: File, lineageId?: string, motorAEncoderPositionDegrees?: number, motorBEncoderPositionDegrees?: number, timestamp?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
6641
6931
|
/**
|
|
6642
6932
|
* Updates the current custom path tracking session by appending control points. The trackingSessionId and frame must match the current session.
|
|
6643
6933
|
* @param {V1AppendMountTrackPathRequest} v1AppendMountTrackPathRequest
|
|
@@ -6704,6 +6994,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6704
6994
|
* @throws {RequiredError}
|
|
6705
6995
|
*/
|
|
6706
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>>;
|
|
6707
7004
|
/**
|
|
6708
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.
|
|
6709
7006
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -6757,6 +7054,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6757
7054
|
* @throws {RequiredError}
|
|
6758
7055
|
*/
|
|
6759
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>>;
|
|
6760
7065
|
/**
|
|
6761
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.
|
|
6762
7067
|
* @param {V1CycleRelaysRequest} v1CycleRelaysRequest
|
|
@@ -6782,6 +7087,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6782
7087
|
* @throws {RequiredError}
|
|
6783
7088
|
*/
|
|
6784
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>>;
|
|
6785
7098
|
/**
|
|
6786
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.
|
|
6787
7100
|
* @param {V1DeleteVideoRequest} v1DeleteVideoRequest
|
|
@@ -6910,10 +7223,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6910
7223
|
/**
|
|
6911
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.
|
|
6912
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.
|
|
6913
7227
|
* @param {*} [options] Override http request option.
|
|
6914
7228
|
* @throws {RequiredError}
|
|
6915
7229
|
*/
|
|
6916
|
-
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>>;
|
|
6917
7231
|
/**
|
|
6918
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.
|
|
6919
7233
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -7195,6 +7509,21 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7195
7509
|
* @throws {RequiredError}
|
|
7196
7510
|
*/
|
|
7197
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>>;
|
|
7198
7527
|
/**
|
|
7199
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.
|
|
7200
7529
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -7270,6 +7599,21 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7270
7599
|
* @throws {RequiredError}
|
|
7271
7600
|
*/
|
|
7272
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>>;
|
|
7273
7617
|
/**
|
|
7274
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.
|
|
7275
7619
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -7365,7 +7709,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7365
7709
|
*/
|
|
7366
7710
|
v1GetSystemMetricNames(lineageId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1SystemMetricNames>>;
|
|
7367
7711
|
/**
|
|
7368
|
-
* 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.
|
|
7369
7713
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7370
7714
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
7371
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.
|
|
@@ -7375,7 +7719,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7375
7719
|
*/
|
|
7376
7720
|
v1GetSystemMetrics(lineageId?: string, metricName?: string, after?: string, before?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1SystemMetrics>>;
|
|
7377
7721
|
/**
|
|
7378
|
-
* 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.
|
|
7379
7723
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7380
7724
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
7381
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.
|
|
@@ -8013,6 +8357,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
8013
8357
|
* @throws {RequiredError}
|
|
8014
8358
|
*/
|
|
8015
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>>;
|
|
8016
8368
|
/**
|
|
8017
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.
|
|
8018
8370
|
* @param {V1SystemSettings} v1SystemSettings
|
|
@@ -8087,6 +8439,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
8087
8439
|
* @throws {RequiredError}
|
|
8088
8440
|
*/
|
|
8089
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>>;
|
|
8090
8449
|
/**
|
|
8091
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.
|
|
8092
8451
|
* @param {V2TurnOffRelayRequest} v2TurnOffRelayRequest
|
|
@@ -8116,12 +8475,12 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8116
8475
|
*/
|
|
8117
8476
|
v1AddMountModelPointHere(requestParameters: DefaultApiV1AddMountModelPointHereRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
8118
8477
|
/**
|
|
8119
|
-
* 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
|
|
8120
|
-
* @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.
|
|
8121
8480
|
* @param {*} [options] Override http request option.
|
|
8122
8481
|
* @throws {RequiredError}
|
|
8123
8482
|
*/
|
|
8124
|
-
|
|
8483
|
+
v1AddMountModelPointUsingImage(requestParameters: DefaultApiV1AddMountModelPointUsingImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
8125
8484
|
/**
|
|
8126
8485
|
* Updates the current custom path tracking session by appending control points. The trackingSessionId and frame must match the current session.
|
|
8127
8486
|
* @param {DefaultApiV1AppendMountTrackPathRequest} requestParameters Request parameters.
|
|
@@ -8180,6 +8539,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8180
8539
|
* @throws {RequiredError}
|
|
8181
8540
|
*/
|
|
8182
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>;
|
|
8183
8549
|
/**
|
|
8184
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.
|
|
8185
8551
|
* @param {DefaultApiV1ClearMountModelRequest} requestParameters Request parameters.
|
|
@@ -8231,6 +8597,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8231
8597
|
* @throws {RequiredError}
|
|
8232
8598
|
*/
|
|
8233
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>;
|
|
8234
8607
|
/**
|
|
8235
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.
|
|
8236
8609
|
* @param {DefaultApiV1CycleRelaysRequest} requestParameters Request parameters.
|
|
@@ -8253,6 +8626,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8253
8626
|
* @throws {RequiredError}
|
|
8254
8627
|
*/
|
|
8255
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>;
|
|
8256
8636
|
/**
|
|
8257
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.
|
|
8258
8638
|
* @param {DefaultApiV1DeleteVideoRequest} requestParameters Request parameters.
|
|
@@ -8636,6 +9016,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8636
9016
|
* @throws {RequiredError}
|
|
8637
9017
|
*/
|
|
8638
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>;
|
|
8639
9033
|
/**
|
|
8640
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.
|
|
8641
9035
|
* @param {DefaultApiV1GetOpticalTubeCoverStatusRequest} requestParameters Request parameters.
|
|
@@ -8706,6 +9100,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8706
9100
|
* @throws {RequiredError}
|
|
8707
9101
|
*/
|
|
8708
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>;
|
|
8709
9117
|
/**
|
|
8710
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.
|
|
8711
9119
|
* @param {DefaultApiV1GetRelaysRequest} requestParameters Request parameters.
|
|
@@ -8794,14 +9202,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8794
9202
|
*/
|
|
8795
9203
|
v1GetSystemMetricNames(requestParameters?: DefaultApiV1GetSystemMetricNamesRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1SystemMetricNames>;
|
|
8796
9204
|
/**
|
|
8797
|
-
* 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.
|
|
8798
9206
|
* @param {DefaultApiV1GetSystemMetricsRequest} requestParameters Request parameters.
|
|
8799
9207
|
* @param {*} [options] Override http request option.
|
|
8800
9208
|
* @throws {RequiredError}
|
|
8801
9209
|
*/
|
|
8802
9210
|
v1GetSystemMetrics(requestParameters?: DefaultApiV1GetSystemMetricsRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1SystemMetrics>;
|
|
8803
9211
|
/**
|
|
8804
|
-
* 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.
|
|
8805
9213
|
* @param {DefaultApiV1GetSystemMetricsCollectionsRequest} requestParameters Request parameters.
|
|
8806
9214
|
* @param {*} [options] Override http request option.
|
|
8807
9215
|
* @throws {RequiredError}
|
|
@@ -9382,6 +9790,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
9382
9790
|
* @throws {RequiredError}
|
|
9383
9791
|
*/
|
|
9384
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>;
|
|
9385
9800
|
/**
|
|
9386
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.
|
|
9387
9802
|
* @param {DefaultApiV1UpdateSystemSettingsRequest} requestParameters Request parameters.
|
|
@@ -9445,6 +9860,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
9445
9860
|
* @throws {RequiredError}
|
|
9446
9861
|
*/
|
|
9447
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>;
|
|
9448
9870
|
/**
|
|
9449
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.
|
|
9450
9872
|
* @param {DefaultApiV2TurnOffRelayRequest} requestParameters Request parameters.
|
|
@@ -9471,14 +9893,26 @@ export interface DefaultApiV1AddMountModelPointHereRequest {
|
|
|
9471
9893
|
readonly lineageId?: string;
|
|
9472
9894
|
}
|
|
9473
9895
|
/**
|
|
9474
|
-
* Request parameters for
|
|
9896
|
+
* Request parameters for v1AddMountModelPointUsingImage operation in DefaultApi.
|
|
9475
9897
|
*/
|
|
9476
|
-
export interface
|
|
9898
|
+
export interface DefaultApiV1AddMountModelPointUsingImageRequest {
|
|
9477
9899
|
readonly body: File;
|
|
9478
9900
|
/**
|
|
9479
9901
|
* Lineage ID required when requesting data from the cloud platform
|
|
9480
9902
|
*/
|
|
9481
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;
|
|
9482
9916
|
}
|
|
9483
9917
|
/**
|
|
9484
9918
|
* Request parameters for v1AppendMountTrackPath operation in DefaultApi.
|
|
@@ -9560,6 +9994,15 @@ export interface DefaultApiV1CaptureImagesContinuouslyRequest {
|
|
|
9560
9994
|
*/
|
|
9561
9995
|
readonly lineageId?: string;
|
|
9562
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
|
+
}
|
|
9563
10006
|
/**
|
|
9564
10007
|
* Request parameters for v1ClearMountModel operation in DefaultApi.
|
|
9565
10008
|
*/
|
|
@@ -9625,6 +10068,16 @@ export interface DefaultApiV1CreateMountModelRequest {
|
|
|
9625
10068
|
*/
|
|
9626
10069
|
readonly lineageId?: string;
|
|
9627
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
|
+
}
|
|
9628
10081
|
/**
|
|
9629
10082
|
* Request parameters for v1CycleRelays operation in DefaultApi.
|
|
9630
10083
|
*/
|
|
@@ -9655,6 +10108,19 @@ export interface DefaultApiV1DeleteImageProcessingPluginRequest {
|
|
|
9655
10108
|
*/
|
|
9656
10109
|
readonly lineageId?: string;
|
|
9657
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
|
+
}
|
|
9658
10124
|
/**
|
|
9659
10125
|
* Request parameters for v1DeleteVideo operation in DefaultApi.
|
|
9660
10126
|
*/
|
|
@@ -9822,6 +10288,10 @@ export interface DefaultApiV1FindFocuserLimitsRequest {
|
|
|
9822
10288
|
* Lineage ID required when requesting data from the cloud platform
|
|
9823
10289
|
*/
|
|
9824
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;
|
|
9825
10295
|
}
|
|
9826
10296
|
/**
|
|
9827
10297
|
* Request parameters for v1GetActiveTasks operation in DefaultApi.
|
|
@@ -10234,6 +10704,28 @@ export interface DefaultApiV1GetNetworkInterfacesRequest {
|
|
|
10234
10704
|
*/
|
|
10235
10705
|
readonly lineageId?: string;
|
|
10236
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
|
+
}
|
|
10237
10729
|
/**
|
|
10238
10730
|
* Request parameters for v1GetOpticalTubeCoverStatus operation in DefaultApi.
|
|
10239
10731
|
*/
|
|
@@ -10344,6 +10836,28 @@ export interface DefaultApiV1GetOpticalTubeStatusesRequest {
|
|
|
10344
10836
|
*/
|
|
10345
10837
|
readonly lineageId?: string;
|
|
10346
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
|
+
}
|
|
10347
10861
|
/**
|
|
10348
10862
|
* Request parameters for v1GetRelays operation in DefaultApi.
|
|
10349
10863
|
*/
|
|
@@ -11320,6 +11834,16 @@ export interface DefaultApiV1UpdateImageProcessingPluginRequest {
|
|
|
11320
11834
|
*/
|
|
11321
11835
|
readonly lineageId?: string;
|
|
11322
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
|
+
}
|
|
11323
11847
|
/**
|
|
11324
11848
|
* Request parameters for v1UpdateSystemSettings operation in DefaultApi.
|
|
11325
11849
|
*/
|
|
@@ -11430,6 +11954,15 @@ export interface DefaultApiV2GetSystemEventsRequest {
|
|
|
11430
11954
|
*/
|
|
11431
11955
|
readonly limit?: number;
|
|
11432
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
|
+
}
|
|
11433
11966
|
/**
|
|
11434
11967
|
* Request parameters for v2TurnOffRelay operation in DefaultApi.
|
|
11435
11968
|
*/
|
|
@@ -11462,12 +11995,12 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11462
11995
|
*/
|
|
11463
11996
|
v1AddMountModelPointHere(requestParameters: DefaultApiV1AddMountModelPointHereRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any, {}>>;
|
|
11464
11997
|
/**
|
|
11465
|
-
* 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
|
|
11466
|
-
* @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.
|
|
11467
12000
|
* @param {*} [options] Override http request option.
|
|
11468
12001
|
* @throws {RequiredError}
|
|
11469
12002
|
*/
|
|
11470
|
-
|
|
12003
|
+
v1AddMountModelPointUsingImage(requestParameters: DefaultApiV1AddMountModelPointUsingImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any, {}>>;
|
|
11471
12004
|
/**
|
|
11472
12005
|
* Updates the current custom path tracking session by appending control points. The trackingSessionId and frame must match the current session.
|
|
11473
12006
|
* @param {DefaultApiV1AppendMountTrackPathRequest} requestParameters Request parameters.
|
|
@@ -11526,6 +12059,13 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11526
12059
|
* @throws {RequiredError}
|
|
11527
12060
|
*/
|
|
11528
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, {}>>;
|
|
11529
12069
|
/**
|
|
11530
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.
|
|
11531
12071
|
* @param {DefaultApiV1ClearMountModelRequest} requestParameters Request parameters.
|
|
@@ -11577,6 +12117,13 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11577
12117
|
* @throws {RequiredError}
|
|
11578
12118
|
*/
|
|
11579
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, {}>>;
|
|
11580
12127
|
/**
|
|
11581
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.
|
|
11582
12129
|
* @param {DefaultApiV1CycleRelaysRequest} requestParameters Request parameters.
|
|
@@ -11599,6 +12146,13 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11599
12146
|
* @throws {RequiredError}
|
|
11600
12147
|
*/
|
|
11601
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, {}>>;
|
|
11602
12156
|
/**
|
|
11603
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.
|
|
11604
12158
|
* @param {DefaultApiV1DeleteVideoRequest} requestParameters Request parameters.
|
|
@@ -11982,6 +12536,20 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11982
12536
|
* @throws {RequiredError}
|
|
11983
12537
|
*/
|
|
11984
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, {}>>;
|
|
11985
12553
|
/**
|
|
11986
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.
|
|
11987
12555
|
* @param {DefaultApiV1GetOpticalTubeCoverStatusRequest} requestParameters Request parameters.
|
|
@@ -12052,6 +12620,20 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12052
12620
|
* @throws {RequiredError}
|
|
12053
12621
|
*/
|
|
12054
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, {}>>;
|
|
12055
12637
|
/**
|
|
12056
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.
|
|
12057
12639
|
* @param {DefaultApiV1GetRelaysRequest} requestParameters Request parameters.
|
|
@@ -12140,14 +12722,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12140
12722
|
*/
|
|
12141
12723
|
v1GetSystemMetricNames(requestParameters?: DefaultApiV1GetSystemMetricNamesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SystemMetricNames, any, {}>>;
|
|
12142
12724
|
/**
|
|
12143
|
-
* 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.
|
|
12144
12726
|
* @param {DefaultApiV1GetSystemMetricsRequest} requestParameters Request parameters.
|
|
12145
12727
|
* @param {*} [options] Override http request option.
|
|
12146
12728
|
* @throws {RequiredError}
|
|
12147
12729
|
*/
|
|
12148
12730
|
v1GetSystemMetrics(requestParameters?: DefaultApiV1GetSystemMetricsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SystemMetrics, any, {}>>;
|
|
12149
12731
|
/**
|
|
12150
|
-
* 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.
|
|
12151
12733
|
* @param {DefaultApiV1GetSystemMetricsCollectionsRequest} requestParameters Request parameters.
|
|
12152
12734
|
* @param {*} [options] Override http request option.
|
|
12153
12735
|
* @throws {RequiredError}
|
|
@@ -12728,6 +13310,13 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12728
13310
|
* @throws {RequiredError}
|
|
12729
13311
|
*/
|
|
12730
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, {}>>;
|
|
12731
13320
|
/**
|
|
12732
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.
|
|
12733
13322
|
* @param {DefaultApiV1UpdateSystemSettingsRequest} requestParameters Request parameters.
|
|
@@ -12791,6 +13380,13 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
12791
13380
|
* @throws {RequiredError}
|
|
12792
13381
|
*/
|
|
12793
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, {}>>;
|
|
12794
13390
|
/**
|
|
12795
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.
|
|
12796
13392
|
* @param {DefaultApiV2TurnOffRelayRequest} requestParameters Request parameters.
|