@ourskyai/node_platform-api 1.4.158 → 1.4.188
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +12 -1
- package/README.md +24 -4
- package/api.ts +1057 -50
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +593 -39
- package/dist/api.js +691 -31
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +593 -39
- package/dist/esm/api.js +690 -30
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/DefaultApi.md +506 -9
- package/docs/OpticalTrainComponentType.md +17 -0
- package/docs/SystemEventData.md +4 -0
- package/docs/V1CreateOpticalTrainRequest.md +31 -0
- package/docs/V1MotorStatus.md +2 -0
- package/docs/V1OpticalTrain.md +31 -0
- package/docs/V1OpticalTrainStatus.md +31 -0
- package/docs/V1OpticalTrainStatuses.md +21 -0
- package/docs/V1OpticalTrains.md +21 -0
- package/docs/V1OpticalTubeCoverSelectorRequest.md +3 -3
- package/docs/V1OpticalTubeStatus.md +1 -1
- package/docs/{V1OpticalTubeTemperatureSensorStatuses.md → V1OpticalTubeTemperatureSensorGroupStatus.md} +6 -4
- package/docs/V1OpticalTubeTemperatureSensorGroupStatuses.md +21 -0
- package/docs/V1SystemMetricsCollection.md +1 -1
- package/docs/V1TaskType.md +3 -1
- package/docs/V1UnassociatedOpticalTrainComponent.md +23 -0
- package/docs/V1UnassociatedOpticalTrainComponents.md +21 -0
- package/docs/V1UpdateOpticalTrainRequest.md +31 -0
- package/docs/V2SystemEventType.md +4 -0
- package/docs/V2SystemStatus.md +37 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky
|
|
5
5
|
* Node Platform API The Node Platform API enables a customer to directly command their ground station either directly via IP address, via the self hosted C2 platform, or routed transparently via the Observable Space cloud platform. Node Platform APIs offer every endpoint a customer might need in order to slew their scope, perform diagnostics, capture images, and much more. Are we missing a feature you need? Drop us a line at support@observable.space.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.4.
|
|
7
|
+
* The version of the OpenAPI document: 1.4.188
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -187,6 +187,16 @@ export const MessageType = {
|
|
|
187
187
|
WELCOME: 'welcome',
|
|
188
188
|
ERROR: 'error'
|
|
189
189
|
};
|
|
190
|
+
/**
|
|
191
|
+
* Type of optical train component.
|
|
192
|
+
*/
|
|
193
|
+
export const OpticalTrainComponentType = {
|
|
194
|
+
CAMERA: 'CAMERA',
|
|
195
|
+
FOCUSER: 'FOCUSER',
|
|
196
|
+
ROTATOR: 'ROTATOR',
|
|
197
|
+
FILTER_WHEEL: 'FILTER_WHEEL',
|
|
198
|
+
OPTICAL_TUBE: 'OPTICAL_TUBE'
|
|
199
|
+
};
|
|
190
200
|
export const PeerRole = {
|
|
191
201
|
PRODUCER: 'PRODUCER',
|
|
192
202
|
LISTENER: 'LISTENER'
|
|
@@ -483,13 +493,14 @@ export const V1SystemOperationMode = {
|
|
|
483
493
|
MANUAL: 'MANUAL'
|
|
484
494
|
};
|
|
485
495
|
/**
|
|
486
|
-
* 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
|
|
496
|
+
* 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
|
|
487
497
|
*/
|
|
488
498
|
export const V1TaskType = {
|
|
489
499
|
CREATE_MOUNT_MODEL: 'CREATE_MOUNT_MODEL',
|
|
490
500
|
CREATE_ELEVATION_MASK: 'CREATE_ELEVATION_MASK',
|
|
491
501
|
CALIBRATE_ENCLOSURE_ROTATOR: 'CALIBRATE_ENCLOSURE_ROTATOR',
|
|
492
502
|
CALIBRATE_ENCLOSURE_WINDOW: 'CALIBRATE_ENCLOSURE_WINDOW',
|
|
503
|
+
CALIBRATE_MOUNT_MOTOR_A_UNWINDER: 'CALIBRATE_MOUNT_MOTOR_A_UNWINDER',
|
|
493
504
|
RUN_AUTOFOCUS: 'RUN_AUTOFOCUS',
|
|
494
505
|
RUN_PERPETUAL_INSTRUCTION_LOOP: 'RUN_PERPETUAL_INSTRUCTION_LOOP',
|
|
495
506
|
STARTUP_WIZARD: 'STARTUP_WIZARD',
|
|
@@ -553,6 +564,8 @@ export const V2SystemEventType = {
|
|
|
553
564
|
CAPTURE_IMAGES_CONTINUOUSLY: 'CAPTURE_IMAGES_CONTINUOUSLY',
|
|
554
565
|
CALIBRATE_ENCLOSURE_ROTATOR: 'CALIBRATE_ENCLOSURE_ROTATOR',
|
|
555
566
|
CALIBRATE_ENCLOSURE_WINDOW: 'CALIBRATE_ENCLOSURE_WINDOW',
|
|
567
|
+
CALIBRATE_MOUNT_MOTOR_A_UNWINDER: 'CALIBRATE_MOUNT_MOTOR_A_UNWINDER',
|
|
568
|
+
CLEAR_ENCLOSURE_ROTATOR_MOTOR_LOCKOUT: 'CLEAR_ENCLOSURE_ROTATOR_MOTOR_LOCKOUT',
|
|
556
569
|
CLOSE_ENCLOSURE_SHUTTERS: 'CLOSE_ENCLOSURE_SHUTTERS',
|
|
557
570
|
CLOSE_OPTICAL_TUBE_COVER: 'CLOSE_OPTICAL_TUBE_COVER',
|
|
558
571
|
CREATE_ELEVATION_MASK: 'CREATE_ELEVATION_MASK',
|
|
@@ -696,15 +709,18 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
696
709
|
};
|
|
697
710
|
}),
|
|
698
711
|
/**
|
|
699
|
-
* 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
|
|
712
|
+
* 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.
|
|
700
713
|
* @param {File} body
|
|
701
714
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
715
|
+
* @param {number} [motorAEncoderPositionDegrees] Motor A encoder position in degrees at the time the supplied image was captured.
|
|
716
|
+
* @param {number} [motorBEncoderPositionDegrees] Motor B encoder position in degrees at the time the supplied image was captured.
|
|
717
|
+
* @param {string} [timestamp] ISO 8601 timestamp when the supplied encoder positions were measured.
|
|
702
718
|
* @param {*} [options] Override http request option.
|
|
703
719
|
* @throws {RequiredError}
|
|
704
720
|
*/
|
|
705
|
-
|
|
721
|
+
v1AddMountModelPointUsingImage: (body_1, lineageId_1, motorAEncoderPositionDegrees_1, motorBEncoderPositionDegrees_1, timestamp_1, ...args_1) => __awaiter(this, [body_1, lineageId_1, motorAEncoderPositionDegrees_1, motorBEncoderPositionDegrees_1, timestamp_1, ...args_1], void 0, function* (body, lineageId, motorAEncoderPositionDegrees, motorBEncoderPositionDegrees, timestamp, options = {}) {
|
|
706
722
|
// verify required parameter 'body' is not null or undefined
|
|
707
|
-
assertParamExists('
|
|
723
|
+
assertParamExists('v1AddMountModelPointUsingImage', 'body', body);
|
|
708
724
|
const localVarPath = `/node-platform/v1/mount/model/add-point-using-image`;
|
|
709
725
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
710
726
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -722,6 +738,17 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
722
738
|
if (lineageId !== undefined) {
|
|
723
739
|
localVarQueryParameter['lineageId'] = lineageId;
|
|
724
740
|
}
|
|
741
|
+
if (motorAEncoderPositionDegrees !== undefined) {
|
|
742
|
+
localVarQueryParameter['motorAEncoderPositionDegrees'] = motorAEncoderPositionDegrees;
|
|
743
|
+
}
|
|
744
|
+
if (motorBEncoderPositionDegrees !== undefined) {
|
|
745
|
+
localVarQueryParameter['motorBEncoderPositionDegrees'] = motorBEncoderPositionDegrees;
|
|
746
|
+
}
|
|
747
|
+
if (timestamp !== undefined) {
|
|
748
|
+
localVarQueryParameter['timestamp'] = (timestamp instanceof Date) ?
|
|
749
|
+
timestamp.toISOString() :
|
|
750
|
+
timestamp;
|
|
751
|
+
}
|
|
725
752
|
localVarHeaderParameter['Content-Type'] = 'application/octet-stream';
|
|
726
753
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
727
754
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1035,6 +1062,39 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1035
1062
|
options: localVarRequestOptions,
|
|
1036
1063
|
};
|
|
1037
1064
|
}),
|
|
1065
|
+
/**
|
|
1066
|
+
* 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.
|
|
1067
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
1068
|
+
* @param {*} [options] Override http request option.
|
|
1069
|
+
* @throws {RequiredError}
|
|
1070
|
+
*/
|
|
1071
|
+
v1ClearEnclosureRotatorMotorLockout: (lineageId_1, ...args_1) => __awaiter(this, [lineageId_1, ...args_1], void 0, function* (lineageId, options = {}) {
|
|
1072
|
+
const localVarPath = `/node-platform/v1/enclosure/rotator/clear-motor-lockout`;
|
|
1073
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1074
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1075
|
+
let baseOptions;
|
|
1076
|
+
if (configuration) {
|
|
1077
|
+
baseOptions = configuration.baseOptions;
|
|
1078
|
+
}
|
|
1079
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1080
|
+
const localVarHeaderParameter = {};
|
|
1081
|
+
const localVarQueryParameter = {};
|
|
1082
|
+
// authentication Roles required
|
|
1083
|
+
// authentication BearerToken required
|
|
1084
|
+
// http bearer authentication required
|
|
1085
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1086
|
+
if (lineageId !== undefined) {
|
|
1087
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
1088
|
+
}
|
|
1089
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1090
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1091
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1092
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1093
|
+
return {
|
|
1094
|
+
url: toPathString(localVarUrlObj),
|
|
1095
|
+
options: localVarRequestOptions,
|
|
1096
|
+
};
|
|
1097
|
+
}),
|
|
1038
1098
|
/**
|
|
1039
1099
|
* 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.
|
|
1040
1100
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -1276,6 +1336,44 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1276
1336
|
options: localVarRequestOptions,
|
|
1277
1337
|
};
|
|
1278
1338
|
}),
|
|
1339
|
+
/**
|
|
1340
|
+
* Creates an optical train configuration by assigning optical train components to a human-readable label.
|
|
1341
|
+
* @param {V1CreateOpticalTrainRequest} v1CreateOpticalTrainRequest
|
|
1342
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
1343
|
+
* @param {*} [options] Override http request option.
|
|
1344
|
+
* @throws {RequiredError}
|
|
1345
|
+
*/
|
|
1346
|
+
v1CreateOpticalTrain: (v1CreateOpticalTrainRequest_1, lineageId_1, ...args_1) => __awaiter(this, [v1CreateOpticalTrainRequest_1, lineageId_1, ...args_1], void 0, function* (v1CreateOpticalTrainRequest, lineageId, options = {}) {
|
|
1347
|
+
// verify required parameter 'v1CreateOpticalTrainRequest' is not null or undefined
|
|
1348
|
+
assertParamExists('v1CreateOpticalTrain', 'v1CreateOpticalTrainRequest', v1CreateOpticalTrainRequest);
|
|
1349
|
+
const localVarPath = `/node-platform/v1/optical-trains`;
|
|
1350
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1351
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1352
|
+
let baseOptions;
|
|
1353
|
+
if (configuration) {
|
|
1354
|
+
baseOptions = configuration.baseOptions;
|
|
1355
|
+
}
|
|
1356
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1357
|
+
const localVarHeaderParameter = {};
|
|
1358
|
+
const localVarQueryParameter = {};
|
|
1359
|
+
// authentication Roles required
|
|
1360
|
+
// authentication BearerToken required
|
|
1361
|
+
// http bearer authentication required
|
|
1362
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1363
|
+
if (lineageId !== undefined) {
|
|
1364
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
1365
|
+
}
|
|
1366
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1367
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1368
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1369
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1370
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1371
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1CreateOpticalTrainRequest, localVarRequestOptions, configuration);
|
|
1372
|
+
return {
|
|
1373
|
+
url: toPathString(localVarUrlObj),
|
|
1374
|
+
options: localVarRequestOptions,
|
|
1375
|
+
};
|
|
1376
|
+
}),
|
|
1279
1377
|
/**
|
|
1280
1378
|
* 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.
|
|
1281
1379
|
* @param {V1CycleRelaysRequest} v1CycleRelaysRequest
|
|
@@ -1391,6 +1489,45 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1391
1489
|
options: localVarRequestOptions,
|
|
1392
1490
|
};
|
|
1393
1491
|
}),
|
|
1492
|
+
/**
|
|
1493
|
+
* Deletes one optical train configuration by label.
|
|
1494
|
+
* @param {string} label Human-readable label of the optical train to delete.
|
|
1495
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
1496
|
+
* @param {*} [options] Override http request option.
|
|
1497
|
+
* @throws {RequiredError}
|
|
1498
|
+
*/
|
|
1499
|
+
v1DeleteOpticalTrain: (label_1, lineageId_1, ...args_1) => __awaiter(this, [label_1, lineageId_1, ...args_1], void 0, function* (label, lineageId, options = {}) {
|
|
1500
|
+
// verify required parameter 'label' is not null or undefined
|
|
1501
|
+
assertParamExists('v1DeleteOpticalTrain', 'label', label);
|
|
1502
|
+
const localVarPath = `/node-platform/v1/optical-train`;
|
|
1503
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1504
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1505
|
+
let baseOptions;
|
|
1506
|
+
if (configuration) {
|
|
1507
|
+
baseOptions = configuration.baseOptions;
|
|
1508
|
+
}
|
|
1509
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
1510
|
+
const localVarHeaderParameter = {};
|
|
1511
|
+
const localVarQueryParameter = {};
|
|
1512
|
+
// authentication Roles required
|
|
1513
|
+
// authentication BearerToken required
|
|
1514
|
+
// http bearer authentication required
|
|
1515
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1516
|
+
if (lineageId !== undefined) {
|
|
1517
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
1518
|
+
}
|
|
1519
|
+
if (label !== undefined) {
|
|
1520
|
+
localVarQueryParameter['label'] = label;
|
|
1521
|
+
}
|
|
1522
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1523
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1524
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1525
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1526
|
+
return {
|
|
1527
|
+
url: toPathString(localVarUrlObj),
|
|
1528
|
+
options: localVarRequestOptions,
|
|
1529
|
+
};
|
|
1530
|
+
}),
|
|
1394
1531
|
/**
|
|
1395
1532
|
* 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.
|
|
1396
1533
|
* @param {V1DeleteVideoRequest} v1DeleteVideoRequest
|
|
@@ -1981,10 +2118,11 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1981
2118
|
/**
|
|
1982
2119
|
* 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.
|
|
1983
2120
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
2121
|
+
* @param {string} [id] Optional focuser ID. If provided, finds limits for that focuser instead of the default focuser.
|
|
1984
2122
|
* @param {*} [options] Override http request option.
|
|
1985
2123
|
* @throws {RequiredError}
|
|
1986
2124
|
*/
|
|
1987
|
-
v1FindFocuserLimits: (lineageId_1, ...args_1) => __awaiter(this, [lineageId_1, ...args_1], void 0, function* (lineageId, options = {}) {
|
|
2125
|
+
v1FindFocuserLimits: (lineageId_1, id_1, ...args_1) => __awaiter(this, [lineageId_1, id_1, ...args_1], void 0, function* (lineageId, id, options = {}) {
|
|
1988
2126
|
const localVarPath = `/node-platform/v1/focuser/find-limit`;
|
|
1989
2127
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1990
2128
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -2002,6 +2140,9 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
2002
2140
|
if (lineageId !== undefined) {
|
|
2003
2141
|
localVarQueryParameter['lineageId'] = lineageId;
|
|
2004
2142
|
}
|
|
2143
|
+
if (id !== undefined) {
|
|
2144
|
+
localVarQueryParameter['id'] = id;
|
|
2145
|
+
}
|
|
2005
2146
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2006
2147
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2007
2148
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3324,6 +3465,78 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
3324
3465
|
options: localVarRequestOptions,
|
|
3325
3466
|
};
|
|
3326
3467
|
}),
|
|
3468
|
+
/**
|
|
3469
|
+
* Retrieves one optical train configuration by label.
|
|
3470
|
+
* @param {string} label Human-readable label of the optical train to retrieve.
|
|
3471
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
3472
|
+
* @param {*} [options] Override http request option.
|
|
3473
|
+
* @throws {RequiredError}
|
|
3474
|
+
*/
|
|
3475
|
+
v1GetOpticalTrain: (label_1, lineageId_1, ...args_1) => __awaiter(this, [label_1, lineageId_1, ...args_1], void 0, function* (label, lineageId, options = {}) {
|
|
3476
|
+
// verify required parameter 'label' is not null or undefined
|
|
3477
|
+
assertParamExists('v1GetOpticalTrain', 'label', label);
|
|
3478
|
+
const localVarPath = `/node-platform/v1/optical-train`;
|
|
3479
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3480
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3481
|
+
let baseOptions;
|
|
3482
|
+
if (configuration) {
|
|
3483
|
+
baseOptions = configuration.baseOptions;
|
|
3484
|
+
}
|
|
3485
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
3486
|
+
const localVarHeaderParameter = {};
|
|
3487
|
+
const localVarQueryParameter = {};
|
|
3488
|
+
// authentication Roles required
|
|
3489
|
+
// authentication BearerToken required
|
|
3490
|
+
// http bearer authentication required
|
|
3491
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3492
|
+
if (lineageId !== undefined) {
|
|
3493
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
3494
|
+
}
|
|
3495
|
+
if (label !== undefined) {
|
|
3496
|
+
localVarQueryParameter['label'] = label;
|
|
3497
|
+
}
|
|
3498
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3499
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3500
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3501
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
3502
|
+
return {
|
|
3503
|
+
url: toPathString(localVarUrlObj),
|
|
3504
|
+
options: localVarRequestOptions,
|
|
3505
|
+
};
|
|
3506
|
+
}),
|
|
3507
|
+
/**
|
|
3508
|
+
* Retrieves all configured optical trains and the optical train components assigned to each train.
|
|
3509
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
3510
|
+
* @param {*} [options] Override http request option.
|
|
3511
|
+
* @throws {RequiredError}
|
|
3512
|
+
*/
|
|
3513
|
+
v1GetOpticalTrains: (lineageId_1, ...args_1) => __awaiter(this, [lineageId_1, ...args_1], void 0, function* (lineageId, options = {}) {
|
|
3514
|
+
const localVarPath = `/node-platform/v1/optical-trains`;
|
|
3515
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3516
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3517
|
+
let baseOptions;
|
|
3518
|
+
if (configuration) {
|
|
3519
|
+
baseOptions = configuration.baseOptions;
|
|
3520
|
+
}
|
|
3521
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
3522
|
+
const localVarHeaderParameter = {};
|
|
3523
|
+
const localVarQueryParameter = {};
|
|
3524
|
+
// authentication Roles required
|
|
3525
|
+
// authentication BearerToken required
|
|
3526
|
+
// http bearer authentication required
|
|
3527
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3528
|
+
if (lineageId !== undefined) {
|
|
3529
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
3530
|
+
}
|
|
3531
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3532
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3533
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3534
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
3535
|
+
return {
|
|
3536
|
+
url: toPathString(localVarUrlObj),
|
|
3537
|
+
options: localVarRequestOptions,
|
|
3538
|
+
};
|
|
3539
|
+
}),
|
|
3327
3540
|
/**
|
|
3328
3541
|
* 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.
|
|
3329
3542
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -3674,6 +3887,76 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
3674
3887
|
options: localVarRequestOptions,
|
|
3675
3888
|
};
|
|
3676
3889
|
}),
|
|
3890
|
+
/**
|
|
3891
|
+
* Retrieves the current temperature sensor status for an optical tube assembly. Returns V1OpticalTubeTemperatureSensorGroupStatus containing the temperature reading from each sensor.
|
|
3892
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
3893
|
+
* @param {string} [id] Optional optical tube ID. If provided, returns temperature sensor statuses for that optical tube instead of the default optical tube.
|
|
3894
|
+
* @param {*} [options] Override http request option.
|
|
3895
|
+
* @throws {RequiredError}
|
|
3896
|
+
*/
|
|
3897
|
+
v1GetOpticalTubeTemperatureSensorGroupStatus: (lineageId_1, id_1, ...args_1) => __awaiter(this, [lineageId_1, id_1, ...args_1], void 0, function* (lineageId, id, options = {}) {
|
|
3898
|
+
const localVarPath = `/node-platform/v1/optical-tube/temperature-sensors/status`;
|
|
3899
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3900
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3901
|
+
let baseOptions;
|
|
3902
|
+
if (configuration) {
|
|
3903
|
+
baseOptions = configuration.baseOptions;
|
|
3904
|
+
}
|
|
3905
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
3906
|
+
const localVarHeaderParameter = {};
|
|
3907
|
+
const localVarQueryParameter = {};
|
|
3908
|
+
// authentication Roles required
|
|
3909
|
+
// authentication BearerToken required
|
|
3910
|
+
// http bearer authentication required
|
|
3911
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3912
|
+
if (lineageId !== undefined) {
|
|
3913
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
3914
|
+
}
|
|
3915
|
+
if (id !== undefined) {
|
|
3916
|
+
localVarQueryParameter['id'] = id;
|
|
3917
|
+
}
|
|
3918
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3919
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3920
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3921
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
3922
|
+
return {
|
|
3923
|
+
url: toPathString(localVarUrlObj),
|
|
3924
|
+
options: localVarRequestOptions,
|
|
3925
|
+
};
|
|
3926
|
+
}),
|
|
3927
|
+
/**
|
|
3928
|
+
* 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.
|
|
3929
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
3930
|
+
* @param {*} [options] Override http request option.
|
|
3931
|
+
* @throws {RequiredError}
|
|
3932
|
+
*/
|
|
3933
|
+
v1GetOpticalTubeTemperatureSensorGroupStatuses: (lineageId_1, ...args_1) => __awaiter(this, [lineageId_1, ...args_1], void 0, function* (lineageId, options = {}) {
|
|
3934
|
+
const localVarPath = `/node-platform/v1/optical-tubes/temperature-sensors/status`;
|
|
3935
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3936
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3937
|
+
let baseOptions;
|
|
3938
|
+
if (configuration) {
|
|
3939
|
+
baseOptions = configuration.baseOptions;
|
|
3940
|
+
}
|
|
3941
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
3942
|
+
const localVarHeaderParameter = {};
|
|
3943
|
+
const localVarQueryParameter = {};
|
|
3944
|
+
// authentication Roles required
|
|
3945
|
+
// authentication BearerToken required
|
|
3946
|
+
// http bearer authentication required
|
|
3947
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3948
|
+
if (lineageId !== undefined) {
|
|
3949
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
3950
|
+
}
|
|
3951
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3952
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3953
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3954
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
3955
|
+
return {
|
|
3956
|
+
url: toPathString(localVarUrlObj),
|
|
3957
|
+
options: localVarRequestOptions,
|
|
3958
|
+
};
|
|
3959
|
+
}),
|
|
3677
3960
|
/**
|
|
3678
3961
|
* 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.
|
|
3679
3962
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -4108,7 +4391,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
4108
4391
|
};
|
|
4109
4392
|
}),
|
|
4110
4393
|
/**
|
|
4111
|
-
* 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
|
|
4394
|
+
* 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.
|
|
4112
4395
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
4113
4396
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
4114
4397
|
* @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.
|
|
@@ -4157,7 +4440,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
4157
4440
|
};
|
|
4158
4441
|
}),
|
|
4159
4442
|
/**
|
|
4160
|
-
* 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
|
|
4443
|
+
* 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.
|
|
4161
4444
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
4162
4445
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
4163
4446
|
* @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.
|
|
@@ -7140,6 +7423,44 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
7140
7423
|
options: localVarRequestOptions,
|
|
7141
7424
|
};
|
|
7142
7425
|
}),
|
|
7426
|
+
/**
|
|
7427
|
+
* Updates an optical train configuration by replacing the component assignments for the provided label.
|
|
7428
|
+
* @param {V1UpdateOpticalTrainRequest} v1UpdateOpticalTrainRequest
|
|
7429
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7430
|
+
* @param {*} [options] Override http request option.
|
|
7431
|
+
* @throws {RequiredError}
|
|
7432
|
+
*/
|
|
7433
|
+
v1UpdateOpticalTrain: (v1UpdateOpticalTrainRequest_1, lineageId_1, ...args_1) => __awaiter(this, [v1UpdateOpticalTrainRequest_1, lineageId_1, ...args_1], void 0, function* (v1UpdateOpticalTrainRequest, lineageId, options = {}) {
|
|
7434
|
+
// verify required parameter 'v1UpdateOpticalTrainRequest' is not null or undefined
|
|
7435
|
+
assertParamExists('v1UpdateOpticalTrain', 'v1UpdateOpticalTrainRequest', v1UpdateOpticalTrainRequest);
|
|
7436
|
+
const localVarPath = `/node-platform/v1/optical-train`;
|
|
7437
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7438
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7439
|
+
let baseOptions;
|
|
7440
|
+
if (configuration) {
|
|
7441
|
+
baseOptions = configuration.baseOptions;
|
|
7442
|
+
}
|
|
7443
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
7444
|
+
const localVarHeaderParameter = {};
|
|
7445
|
+
const localVarQueryParameter = {};
|
|
7446
|
+
// authentication Roles required
|
|
7447
|
+
// authentication BearerToken required
|
|
7448
|
+
// http bearer authentication required
|
|
7449
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7450
|
+
if (lineageId !== undefined) {
|
|
7451
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
7452
|
+
}
|
|
7453
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7454
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
7455
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7456
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7457
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
7458
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1UpdateOpticalTrainRequest, localVarRequestOptions, configuration);
|
|
7459
|
+
return {
|
|
7460
|
+
url: toPathString(localVarUrlObj),
|
|
7461
|
+
options: localVarRequestOptions,
|
|
7462
|
+
};
|
|
7463
|
+
}),
|
|
7143
7464
|
/**
|
|
7144
7465
|
* 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.
|
|
7145
7466
|
* @param {V1SystemSettings} v1SystemSettings
|
|
@@ -7494,6 +7815,39 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
7494
7815
|
options: localVarRequestOptions,
|
|
7495
7816
|
};
|
|
7496
7817
|
}),
|
|
7818
|
+
/**
|
|
7819
|
+
* 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.
|
|
7820
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7821
|
+
* @param {*} [options] Override http request option.
|
|
7822
|
+
* @throws {RequiredError}
|
|
7823
|
+
*/
|
|
7824
|
+
v2GetSystemStatus: (lineageId_1, ...args_1) => __awaiter(this, [lineageId_1, ...args_1], void 0, function* (lineageId, options = {}) {
|
|
7825
|
+
const localVarPath = `/node-platform/v2/system/status`;
|
|
7826
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7827
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7828
|
+
let baseOptions;
|
|
7829
|
+
if (configuration) {
|
|
7830
|
+
baseOptions = configuration.baseOptions;
|
|
7831
|
+
}
|
|
7832
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
7833
|
+
const localVarHeaderParameter = {};
|
|
7834
|
+
const localVarQueryParameter = {};
|
|
7835
|
+
// authentication Roles required
|
|
7836
|
+
// authentication BearerToken required
|
|
7837
|
+
// http bearer authentication required
|
|
7838
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7839
|
+
if (lineageId !== undefined) {
|
|
7840
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
7841
|
+
}
|
|
7842
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
7843
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7844
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7845
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
7846
|
+
return {
|
|
7847
|
+
url: toPathString(localVarUrlObj),
|
|
7848
|
+
options: localVarRequestOptions,
|
|
7849
|
+
};
|
|
7850
|
+
}),
|
|
7497
7851
|
/**
|
|
7498
7852
|
* 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.
|
|
7499
7853
|
* @param {V2TurnOffRelayRequest} v2TurnOffRelayRequest
|
|
@@ -7595,18 +7949,21 @@ export const DefaultApiFp = function (configuration) {
|
|
|
7595
7949
|
});
|
|
7596
7950
|
},
|
|
7597
7951
|
/**
|
|
7598
|
-
* 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
|
|
7952
|
+
* 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.
|
|
7599
7953
|
* @param {File} body
|
|
7600
7954
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7955
|
+
* @param {number} [motorAEncoderPositionDegrees] Motor A encoder position in degrees at the time the supplied image was captured.
|
|
7956
|
+
* @param {number} [motorBEncoderPositionDegrees] Motor B encoder position in degrees at the time the supplied image was captured.
|
|
7957
|
+
* @param {string} [timestamp] ISO 8601 timestamp when the supplied encoder positions were measured.
|
|
7601
7958
|
* @param {*} [options] Override http request option.
|
|
7602
7959
|
* @throws {RequiredError}
|
|
7603
7960
|
*/
|
|
7604
|
-
|
|
7961
|
+
v1AddMountModelPointUsingImage(body, lineageId, motorAEncoderPositionDegrees, motorBEncoderPositionDegrees, timestamp, options) {
|
|
7605
7962
|
return __awaiter(this, void 0, void 0, function* () {
|
|
7606
7963
|
var _a, _b, _c;
|
|
7607
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
7964
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AddMountModelPointUsingImage(body, lineageId, motorAEncoderPositionDegrees, motorBEncoderPositionDegrees, timestamp, options);
|
|
7608
7965
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
7609
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.
|
|
7966
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.v1AddMountModelPointUsingImage']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
7610
7967
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7611
7968
|
});
|
|
7612
7969
|
},
|
|
@@ -7740,6 +8097,21 @@ export const DefaultApiFp = function (configuration) {
|
|
|
7740
8097
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7741
8098
|
});
|
|
7742
8099
|
},
|
|
8100
|
+
/**
|
|
8101
|
+
* 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.
|
|
8102
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
8103
|
+
* @param {*} [options] Override http request option.
|
|
8104
|
+
* @throws {RequiredError}
|
|
8105
|
+
*/
|
|
8106
|
+
v1ClearEnclosureRotatorMotorLockout(lineageId, options) {
|
|
8107
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8108
|
+
var _a, _b, _c;
|
|
8109
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1ClearEnclosureRotatorMotorLockout(lineageId, options);
|
|
8110
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8111
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.v1ClearEnclosureRotatorMotorLockout']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8112
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8113
|
+
});
|
|
8114
|
+
},
|
|
7743
8115
|
/**
|
|
7744
8116
|
* 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.
|
|
7745
8117
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -7849,6 +8221,22 @@ export const DefaultApiFp = function (configuration) {
|
|
|
7849
8221
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7850
8222
|
});
|
|
7851
8223
|
},
|
|
8224
|
+
/**
|
|
8225
|
+
* Creates an optical train configuration by assigning optical train components to a human-readable label.
|
|
8226
|
+
* @param {V1CreateOpticalTrainRequest} v1CreateOpticalTrainRequest
|
|
8227
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
8228
|
+
* @param {*} [options] Override http request option.
|
|
8229
|
+
* @throws {RequiredError}
|
|
8230
|
+
*/
|
|
8231
|
+
v1CreateOpticalTrain(v1CreateOpticalTrainRequest, lineageId, options) {
|
|
8232
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8233
|
+
var _a, _b, _c;
|
|
8234
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateOpticalTrain(v1CreateOpticalTrainRequest, lineageId, options);
|
|
8235
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8236
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.v1CreateOpticalTrain']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8237
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8238
|
+
});
|
|
8239
|
+
},
|
|
7852
8240
|
/**
|
|
7853
8241
|
* 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.
|
|
7854
8242
|
* @param {V1CycleRelaysRequest} v1CycleRelaysRequest
|
|
@@ -7898,6 +8286,22 @@ export const DefaultApiFp = function (configuration) {
|
|
|
7898
8286
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7899
8287
|
});
|
|
7900
8288
|
},
|
|
8289
|
+
/**
|
|
8290
|
+
* Deletes one optical train configuration by label.
|
|
8291
|
+
* @param {string} label Human-readable label of the optical train to delete.
|
|
8292
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
8293
|
+
* @param {*} [options] Override http request option.
|
|
8294
|
+
* @throws {RequiredError}
|
|
8295
|
+
*/
|
|
8296
|
+
v1DeleteOpticalTrain(label, lineageId, options) {
|
|
8297
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8298
|
+
var _a, _b, _c;
|
|
8299
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DeleteOpticalTrain(label, lineageId, options);
|
|
8300
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8301
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.v1DeleteOpticalTrain']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8302
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8303
|
+
});
|
|
8304
|
+
},
|
|
7901
8305
|
/**
|
|
7902
8306
|
* 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.
|
|
7903
8307
|
* @param {V1DeleteVideoRequest} v1DeleteVideoRequest
|
|
@@ -8162,13 +8566,14 @@ export const DefaultApiFp = function (configuration) {
|
|
|
8162
8566
|
/**
|
|
8163
8567
|
* 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.
|
|
8164
8568
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
8569
|
+
* @param {string} [id] Optional focuser ID. If provided, finds limits for that focuser instead of the default focuser.
|
|
8165
8570
|
* @param {*} [options] Override http request option.
|
|
8166
8571
|
* @throws {RequiredError}
|
|
8167
8572
|
*/
|
|
8168
|
-
v1FindFocuserLimits(lineageId, options) {
|
|
8573
|
+
v1FindFocuserLimits(lineageId, id, options) {
|
|
8169
8574
|
return __awaiter(this, void 0, void 0, function* () {
|
|
8170
8575
|
var _a, _b, _c;
|
|
8171
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1FindFocuserLimits(lineageId, options);
|
|
8576
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1FindFocuserLimits(lineageId, id, options);
|
|
8172
8577
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8173
8578
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.v1FindFocuserLimits']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8174
8579
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -8743,6 +9148,37 @@ export const DefaultApiFp = function (configuration) {
|
|
|
8743
9148
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8744
9149
|
});
|
|
8745
9150
|
},
|
|
9151
|
+
/**
|
|
9152
|
+
* Retrieves one optical train configuration by label.
|
|
9153
|
+
* @param {string} label Human-readable label of the optical train to retrieve.
|
|
9154
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
9155
|
+
* @param {*} [options] Override http request option.
|
|
9156
|
+
* @throws {RequiredError}
|
|
9157
|
+
*/
|
|
9158
|
+
v1GetOpticalTrain(label, lineageId, options) {
|
|
9159
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9160
|
+
var _a, _b, _c;
|
|
9161
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetOpticalTrain(label, lineageId, options);
|
|
9162
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
9163
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.v1GetOpticalTrain']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
9164
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9165
|
+
});
|
|
9166
|
+
},
|
|
9167
|
+
/**
|
|
9168
|
+
* Retrieves all configured optical trains and the optical train components assigned to each train.
|
|
9169
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
9170
|
+
* @param {*} [options] Override http request option.
|
|
9171
|
+
* @throws {RequiredError}
|
|
9172
|
+
*/
|
|
9173
|
+
v1GetOpticalTrains(lineageId, options) {
|
|
9174
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9175
|
+
var _a, _b, _c;
|
|
9176
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetOpticalTrains(lineageId, options);
|
|
9177
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
9178
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.v1GetOpticalTrains']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
9179
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9180
|
+
});
|
|
9181
|
+
},
|
|
8746
9182
|
/**
|
|
8747
9183
|
* 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.
|
|
8748
9184
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -8898,6 +9334,37 @@ export const DefaultApiFp = function (configuration) {
|
|
|
8898
9334
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8899
9335
|
});
|
|
8900
9336
|
},
|
|
9337
|
+
/**
|
|
9338
|
+
* Retrieves the current temperature sensor status for an optical tube assembly. Returns V1OpticalTubeTemperatureSensorGroupStatus containing the temperature reading from each sensor.
|
|
9339
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
9340
|
+
* @param {string} [id] Optional optical tube ID. If provided, returns temperature sensor statuses for that optical tube instead of the default optical tube.
|
|
9341
|
+
* @param {*} [options] Override http request option.
|
|
9342
|
+
* @throws {RequiredError}
|
|
9343
|
+
*/
|
|
9344
|
+
v1GetOpticalTubeTemperatureSensorGroupStatus(lineageId, id, options) {
|
|
9345
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9346
|
+
var _a, _b, _c;
|
|
9347
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetOpticalTubeTemperatureSensorGroupStatus(lineageId, id, options);
|
|
9348
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
9349
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.v1GetOpticalTubeTemperatureSensorGroupStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
9350
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9351
|
+
});
|
|
9352
|
+
},
|
|
9353
|
+
/**
|
|
9354
|
+
* 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.
|
|
9355
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
9356
|
+
* @param {*} [options] Override http request option.
|
|
9357
|
+
* @throws {RequiredError}
|
|
9358
|
+
*/
|
|
9359
|
+
v1GetOpticalTubeTemperatureSensorGroupStatuses(lineageId, options) {
|
|
9360
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9361
|
+
var _a, _b, _c;
|
|
9362
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetOpticalTubeTemperatureSensorGroupStatuses(lineageId, options);
|
|
9363
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
9364
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.v1GetOpticalTubeTemperatureSensorGroupStatuses']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
9365
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9366
|
+
});
|
|
9367
|
+
},
|
|
8901
9368
|
/**
|
|
8902
9369
|
* 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.
|
|
8903
9370
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -9089,7 +9556,7 @@ export const DefaultApiFp = function (configuration) {
|
|
|
9089
9556
|
});
|
|
9090
9557
|
},
|
|
9091
9558
|
/**
|
|
9092
|
-
* 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
|
|
9559
|
+
* 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.
|
|
9093
9560
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
9094
9561
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
9095
9562
|
* @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.
|
|
@@ -9107,7 +9574,7 @@ export const DefaultApiFp = function (configuration) {
|
|
|
9107
9574
|
});
|
|
9108
9575
|
},
|
|
9109
9576
|
/**
|
|
9110
|
-
* 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
|
|
9577
|
+
* 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.
|
|
9111
9578
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
9112
9579
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
9113
9580
|
* @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.
|
|
@@ -10401,6 +10868,22 @@ export const DefaultApiFp = function (configuration) {
|
|
|
10401
10868
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10402
10869
|
});
|
|
10403
10870
|
},
|
|
10871
|
+
/**
|
|
10872
|
+
* Updates an optical train configuration by replacing the component assignments for the provided label.
|
|
10873
|
+
* @param {V1UpdateOpticalTrainRequest} v1UpdateOpticalTrainRequest
|
|
10874
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
10875
|
+
* @param {*} [options] Override http request option.
|
|
10876
|
+
* @throws {RequiredError}
|
|
10877
|
+
*/
|
|
10878
|
+
v1UpdateOpticalTrain(v1UpdateOpticalTrainRequest, lineageId, options) {
|
|
10879
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
10880
|
+
var _a, _b, _c;
|
|
10881
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1UpdateOpticalTrain(v1UpdateOpticalTrainRequest, lineageId, options);
|
|
10882
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
10883
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.v1UpdateOpticalTrain']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
10884
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10885
|
+
});
|
|
10886
|
+
},
|
|
10404
10887
|
/**
|
|
10405
10888
|
* 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.
|
|
10406
10889
|
* @param {V1SystemSettings} v1SystemSettings
|
|
@@ -10547,6 +11030,21 @@ export const DefaultApiFp = function (configuration) {
|
|
|
10547
11030
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10548
11031
|
});
|
|
10549
11032
|
},
|
|
11033
|
+
/**
|
|
11034
|
+
* 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.
|
|
11035
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
11036
|
+
* @param {*} [options] Override http request option.
|
|
11037
|
+
* @throws {RequiredError}
|
|
11038
|
+
*/
|
|
11039
|
+
v2GetSystemStatus(lineageId, options) {
|
|
11040
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
11041
|
+
var _a, _b, _c;
|
|
11042
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v2GetSystemStatus(lineageId, options);
|
|
11043
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
11044
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.v2GetSystemStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11045
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11046
|
+
});
|
|
11047
|
+
},
|
|
10550
11048
|
/**
|
|
10551
11049
|
* 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.
|
|
10552
11050
|
* @param {V2TurnOffRelayRequest} v2TurnOffRelayRequest
|
|
@@ -10597,13 +11095,13 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
10597
11095
|
return localVarFp.v1AddMountModelPointHere(requestParameters.v1AddMountModelPointHereRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
10598
11096
|
},
|
|
10599
11097
|
/**
|
|
10600
|
-
* 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
|
|
10601
|
-
* @param {
|
|
11098
|
+
* 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.
|
|
11099
|
+
* @param {DefaultApiV1AddMountModelPointUsingImageRequest} requestParameters Request parameters.
|
|
10602
11100
|
* @param {*} [options] Override http request option.
|
|
10603
11101
|
* @throws {RequiredError}
|
|
10604
11102
|
*/
|
|
10605
|
-
|
|
10606
|
-
return localVarFp.
|
|
11103
|
+
v1AddMountModelPointUsingImage(requestParameters, options) {
|
|
11104
|
+
return localVarFp.v1AddMountModelPointUsingImage(requestParameters.body, requestParameters.lineageId, requestParameters.motorAEncoderPositionDegrees, requestParameters.motorBEncoderPositionDegrees, requestParameters.timestamp, options).then((request) => request(axios, basePath));
|
|
10607
11105
|
},
|
|
10608
11106
|
/**
|
|
10609
11107
|
* Updates the current custom path tracking session by appending control points. The trackingSessionId and frame must match the current session.
|
|
@@ -10679,6 +11177,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
10679
11177
|
v1CaptureImagesContinuously(requestParameters, options) {
|
|
10680
11178
|
return localVarFp.v1CaptureImagesContinuously(requestParameters.v1CaptureImagesContinuouslyRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
10681
11179
|
},
|
|
11180
|
+
/**
|
|
11181
|
+
* 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.
|
|
11182
|
+
* @param {DefaultApiV1ClearEnclosureRotatorMotorLockoutRequest} requestParameters Request parameters.
|
|
11183
|
+
* @param {*} [options] Override http request option.
|
|
11184
|
+
* @throws {RequiredError}
|
|
11185
|
+
*/
|
|
11186
|
+
v1ClearEnclosureRotatorMotorLockout(requestParameters = {}, options) {
|
|
11187
|
+
return localVarFp.v1ClearEnclosureRotatorMotorLockout(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11188
|
+
},
|
|
10682
11189
|
/**
|
|
10683
11190
|
* 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.
|
|
10684
11191
|
* @param {DefaultApiV1ClearMountModelRequest} requestParameters Request parameters.
|
|
@@ -10744,6 +11251,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
10744
11251
|
v1CreateMountModel(requestParameters, options) {
|
|
10745
11252
|
return localVarFp.v1CreateMountModel(requestParameters.v1CreateMountModelRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
10746
11253
|
},
|
|
11254
|
+
/**
|
|
11255
|
+
* Creates an optical train configuration by assigning optical train components to a human-readable label.
|
|
11256
|
+
* @param {DefaultApiV1CreateOpticalTrainRequest} requestParameters Request parameters.
|
|
11257
|
+
* @param {*} [options] Override http request option.
|
|
11258
|
+
* @throws {RequiredError}
|
|
11259
|
+
*/
|
|
11260
|
+
v1CreateOpticalTrain(requestParameters, options) {
|
|
11261
|
+
return localVarFp.v1CreateOpticalTrain(requestParameters.v1CreateOpticalTrainRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11262
|
+
},
|
|
10747
11263
|
/**
|
|
10748
11264
|
* 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.
|
|
10749
11265
|
* @param {DefaultApiV1CycleRelaysRequest} requestParameters Request parameters.
|
|
@@ -10772,6 +11288,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
10772
11288
|
v1DeleteImageProcessingPlugin(requestParameters, options) {
|
|
10773
11289
|
return localVarFp.v1DeleteImageProcessingPlugin(requestParameters.v1GetImageProcessingPluginRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
10774
11290
|
},
|
|
11291
|
+
/**
|
|
11292
|
+
* Deletes one optical train configuration by label.
|
|
11293
|
+
* @param {DefaultApiV1DeleteOpticalTrainRequest} requestParameters Request parameters.
|
|
11294
|
+
* @param {*} [options] Override http request option.
|
|
11295
|
+
* @throws {RequiredError}
|
|
11296
|
+
*/
|
|
11297
|
+
v1DeleteOpticalTrain(requestParameters, options) {
|
|
11298
|
+
return localVarFp.v1DeleteOpticalTrain(requestParameters.label, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11299
|
+
},
|
|
10775
11300
|
/**
|
|
10776
11301
|
* 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.
|
|
10777
11302
|
* @param {DefaultApiV1DeleteVideoRequest} requestParameters Request parameters.
|
|
@@ -10932,7 +11457,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
10932
11457
|
* @throws {RequiredError}
|
|
10933
11458
|
*/
|
|
10934
11459
|
v1FindFocuserLimits(requestParameters = {}, options) {
|
|
10935
|
-
return localVarFp.v1FindFocuserLimits(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11460
|
+
return localVarFp.v1FindFocuserLimits(requestParameters.lineageId, requestParameters.id, options).then((request) => request(axios, basePath));
|
|
10936
11461
|
},
|
|
10937
11462
|
/**
|
|
10938
11463
|
* 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.
|
|
@@ -11263,6 +11788,24 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
11263
11788
|
v1GetNetworkInterfaces(requestParameters = {}, options) {
|
|
11264
11789
|
return localVarFp.v1GetNetworkInterfaces(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11265
11790
|
},
|
|
11791
|
+
/**
|
|
11792
|
+
* Retrieves one optical train configuration by label.
|
|
11793
|
+
* @param {DefaultApiV1GetOpticalTrainRequest} requestParameters Request parameters.
|
|
11794
|
+
* @param {*} [options] Override http request option.
|
|
11795
|
+
* @throws {RequiredError}
|
|
11796
|
+
*/
|
|
11797
|
+
v1GetOpticalTrain(requestParameters, options) {
|
|
11798
|
+
return localVarFp.v1GetOpticalTrain(requestParameters.label, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11799
|
+
},
|
|
11800
|
+
/**
|
|
11801
|
+
* Retrieves all configured optical trains and the optical train components assigned to each train.
|
|
11802
|
+
* @param {DefaultApiV1GetOpticalTrainsRequest} requestParameters Request parameters.
|
|
11803
|
+
* @param {*} [options] Override http request option.
|
|
11804
|
+
* @throws {RequiredError}
|
|
11805
|
+
*/
|
|
11806
|
+
v1GetOpticalTrains(requestParameters = {}, options) {
|
|
11807
|
+
return localVarFp.v1GetOpticalTrains(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11808
|
+
},
|
|
11266
11809
|
/**
|
|
11267
11810
|
* 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.
|
|
11268
11811
|
* @param {DefaultApiV1GetOpticalTubeCoverStatusRequest} requestParameters Request parameters.
|
|
@@ -11353,6 +11896,24 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
11353
11896
|
v1GetOpticalTubeStatuses(requestParameters = {}, options) {
|
|
11354
11897
|
return localVarFp.v1GetOpticalTubeStatuses(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11355
11898
|
},
|
|
11899
|
+
/**
|
|
11900
|
+
* Retrieves the current temperature sensor status for an optical tube assembly. Returns V1OpticalTubeTemperatureSensorGroupStatus containing the temperature reading from each sensor.
|
|
11901
|
+
* @param {DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusRequest} requestParameters Request parameters.
|
|
11902
|
+
* @param {*} [options] Override http request option.
|
|
11903
|
+
* @throws {RequiredError}
|
|
11904
|
+
*/
|
|
11905
|
+
v1GetOpticalTubeTemperatureSensorGroupStatus(requestParameters = {}, options) {
|
|
11906
|
+
return localVarFp.v1GetOpticalTubeTemperatureSensorGroupStatus(requestParameters.lineageId, requestParameters.id, options).then((request) => request(axios, basePath));
|
|
11907
|
+
},
|
|
11908
|
+
/**
|
|
11909
|
+
* 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.
|
|
11910
|
+
* @param {DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusesRequest} requestParameters Request parameters.
|
|
11911
|
+
* @param {*} [options] Override http request option.
|
|
11912
|
+
* @throws {RequiredError}
|
|
11913
|
+
*/
|
|
11914
|
+
v1GetOpticalTubeTemperatureSensorGroupStatuses(requestParameters = {}, options) {
|
|
11915
|
+
return localVarFp.v1GetOpticalTubeTemperatureSensorGroupStatuses(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11916
|
+
},
|
|
11356
11917
|
/**
|
|
11357
11918
|
* 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.
|
|
11358
11919
|
* @param {DefaultApiV1GetRelaysRequest} requestParameters Request parameters.
|
|
@@ -11465,7 +12026,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
11465
12026
|
return localVarFp.v1GetSystemMetricNames(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11466
12027
|
},
|
|
11467
12028
|
/**
|
|
11468
|
-
* 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
|
|
12029
|
+
* 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.
|
|
11469
12030
|
* @param {DefaultApiV1GetSystemMetricsRequest} requestParameters Request parameters.
|
|
11470
12031
|
* @param {*} [options] Override http request option.
|
|
11471
12032
|
* @throws {RequiredError}
|
|
@@ -11474,7 +12035,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
11474
12035
|
return localVarFp.v1GetSystemMetrics(requestParameters.lineageId, requestParameters.metricName, requestParameters.after, requestParameters.before, options).then((request) => request(axios, basePath));
|
|
11475
12036
|
},
|
|
11476
12037
|
/**
|
|
11477
|
-
* 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
|
|
12038
|
+
* 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.
|
|
11478
12039
|
* @param {DefaultApiV1GetSystemMetricsCollectionsRequest} requestParameters Request parameters.
|
|
11479
12040
|
* @param {*} [options] Override http request option.
|
|
11480
12041
|
* @throws {RequiredError}
|
|
@@ -12219,6 +12780,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
12219
12780
|
v1UpdateImageProcessingPlugin(requestParameters, options) {
|
|
12220
12781
|
return localVarFp.v1UpdateImageProcessingPlugin(requestParameters.v1UpdateImageProcessingPluginRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
12221
12782
|
},
|
|
12783
|
+
/**
|
|
12784
|
+
* Updates an optical train configuration by replacing the component assignments for the provided label.
|
|
12785
|
+
* @param {DefaultApiV1UpdateOpticalTrainRequest} requestParameters Request parameters.
|
|
12786
|
+
* @param {*} [options] Override http request option.
|
|
12787
|
+
* @throws {RequiredError}
|
|
12788
|
+
*/
|
|
12789
|
+
v1UpdateOpticalTrain(requestParameters, options) {
|
|
12790
|
+
return localVarFp.v1UpdateOpticalTrain(requestParameters.v1UpdateOpticalTrainRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
12791
|
+
},
|
|
12222
12792
|
/**
|
|
12223
12793
|
* 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.
|
|
12224
12794
|
* @param {DefaultApiV1UpdateSystemSettingsRequest} requestParameters Request parameters.
|
|
@@ -12300,6 +12870,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
12300
12870
|
v2GetSystemEvents(requestParameters = {}, options) {
|
|
12301
12871
|
return localVarFp.v2GetSystemEvents(requestParameters.lineageId, requestParameters.type, requestParameters.before, requestParameters.limit, options).then((request) => request(axios, basePath));
|
|
12302
12872
|
},
|
|
12873
|
+
/**
|
|
12874
|
+
* 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.
|
|
12875
|
+
* @param {DefaultApiV2GetSystemStatusRequest} requestParameters Request parameters.
|
|
12876
|
+
* @param {*} [options] Override http request option.
|
|
12877
|
+
* @throws {RequiredError}
|
|
12878
|
+
*/
|
|
12879
|
+
v2GetSystemStatus(requestParameters = {}, options) {
|
|
12880
|
+
return localVarFp.v2GetSystemStatus(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
12881
|
+
},
|
|
12303
12882
|
/**
|
|
12304
12883
|
* 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.
|
|
12305
12884
|
* @param {DefaultApiV2TurnOffRelayRequest} requestParameters Request parameters.
|
|
@@ -12334,13 +12913,13 @@ export class DefaultApi extends BaseAPI {
|
|
|
12334
12913
|
return DefaultApiFp(this.configuration).v1AddMountModelPointHere(requestParameters.v1AddMountModelPointHereRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
12335
12914
|
}
|
|
12336
12915
|
/**
|
|
12337
|
-
* 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
|
|
12338
|
-
* @param {
|
|
12916
|
+
* 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.
|
|
12917
|
+
* @param {DefaultApiV1AddMountModelPointUsingImageRequest} requestParameters Request parameters.
|
|
12339
12918
|
* @param {*} [options] Override http request option.
|
|
12340
12919
|
* @throws {RequiredError}
|
|
12341
12920
|
*/
|
|
12342
|
-
|
|
12343
|
-
return DefaultApiFp(this.configuration).
|
|
12921
|
+
v1AddMountModelPointUsingImage(requestParameters, options) {
|
|
12922
|
+
return DefaultApiFp(this.configuration).v1AddMountModelPointUsingImage(requestParameters.body, requestParameters.lineageId, requestParameters.motorAEncoderPositionDegrees, requestParameters.motorBEncoderPositionDegrees, requestParameters.timestamp, options).then((request) => request(this.axios, this.basePath));
|
|
12344
12923
|
}
|
|
12345
12924
|
/**
|
|
12346
12925
|
* Updates the current custom path tracking session by appending control points. The trackingSessionId and frame must match the current session.
|
|
@@ -12416,6 +12995,15 @@ export class DefaultApi extends BaseAPI {
|
|
|
12416
12995
|
v1CaptureImagesContinuously(requestParameters, options) {
|
|
12417
12996
|
return DefaultApiFp(this.configuration).v1CaptureImagesContinuously(requestParameters.v1CaptureImagesContinuouslyRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
12418
12997
|
}
|
|
12998
|
+
/**
|
|
12999
|
+
* 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.
|
|
13000
|
+
* @param {DefaultApiV1ClearEnclosureRotatorMotorLockoutRequest} requestParameters Request parameters.
|
|
13001
|
+
* @param {*} [options] Override http request option.
|
|
13002
|
+
* @throws {RequiredError}
|
|
13003
|
+
*/
|
|
13004
|
+
v1ClearEnclosureRotatorMotorLockout(requestParameters = {}, options) {
|
|
13005
|
+
return DefaultApiFp(this.configuration).v1ClearEnclosureRotatorMotorLockout(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13006
|
+
}
|
|
12419
13007
|
/**
|
|
12420
13008
|
* 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.
|
|
12421
13009
|
* @param {DefaultApiV1ClearMountModelRequest} requestParameters Request parameters.
|
|
@@ -12481,6 +13069,15 @@ export class DefaultApi extends BaseAPI {
|
|
|
12481
13069
|
v1CreateMountModel(requestParameters, options) {
|
|
12482
13070
|
return DefaultApiFp(this.configuration).v1CreateMountModel(requestParameters.v1CreateMountModelRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
12483
13071
|
}
|
|
13072
|
+
/**
|
|
13073
|
+
* Creates an optical train configuration by assigning optical train components to a human-readable label.
|
|
13074
|
+
* @param {DefaultApiV1CreateOpticalTrainRequest} requestParameters Request parameters.
|
|
13075
|
+
* @param {*} [options] Override http request option.
|
|
13076
|
+
* @throws {RequiredError}
|
|
13077
|
+
*/
|
|
13078
|
+
v1CreateOpticalTrain(requestParameters, options) {
|
|
13079
|
+
return DefaultApiFp(this.configuration).v1CreateOpticalTrain(requestParameters.v1CreateOpticalTrainRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13080
|
+
}
|
|
12484
13081
|
/**
|
|
12485
13082
|
* 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.
|
|
12486
13083
|
* @param {DefaultApiV1CycleRelaysRequest} requestParameters Request parameters.
|
|
@@ -12509,6 +13106,15 @@ export class DefaultApi extends BaseAPI {
|
|
|
12509
13106
|
v1DeleteImageProcessingPlugin(requestParameters, options) {
|
|
12510
13107
|
return DefaultApiFp(this.configuration).v1DeleteImageProcessingPlugin(requestParameters.v1GetImageProcessingPluginRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
12511
13108
|
}
|
|
13109
|
+
/**
|
|
13110
|
+
* Deletes one optical train configuration by label.
|
|
13111
|
+
* @param {DefaultApiV1DeleteOpticalTrainRequest} requestParameters Request parameters.
|
|
13112
|
+
* @param {*} [options] Override http request option.
|
|
13113
|
+
* @throws {RequiredError}
|
|
13114
|
+
*/
|
|
13115
|
+
v1DeleteOpticalTrain(requestParameters, options) {
|
|
13116
|
+
return DefaultApiFp(this.configuration).v1DeleteOpticalTrain(requestParameters.label, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13117
|
+
}
|
|
12512
13118
|
/**
|
|
12513
13119
|
* 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.
|
|
12514
13120
|
* @param {DefaultApiV1DeleteVideoRequest} requestParameters Request parameters.
|
|
@@ -12669,7 +13275,7 @@ export class DefaultApi extends BaseAPI {
|
|
|
12669
13275
|
* @throws {RequiredError}
|
|
12670
13276
|
*/
|
|
12671
13277
|
v1FindFocuserLimits(requestParameters = {}, options) {
|
|
12672
|
-
return DefaultApiFp(this.configuration).v1FindFocuserLimits(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13278
|
+
return DefaultApiFp(this.configuration).v1FindFocuserLimits(requestParameters.lineageId, requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
12673
13279
|
}
|
|
12674
13280
|
/**
|
|
12675
13281
|
* 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.
|
|
@@ -13000,6 +13606,24 @@ export class DefaultApi extends BaseAPI {
|
|
|
13000
13606
|
v1GetNetworkInterfaces(requestParameters = {}, options) {
|
|
13001
13607
|
return DefaultApiFp(this.configuration).v1GetNetworkInterfaces(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13002
13608
|
}
|
|
13609
|
+
/**
|
|
13610
|
+
* Retrieves one optical train configuration by label.
|
|
13611
|
+
* @param {DefaultApiV1GetOpticalTrainRequest} requestParameters Request parameters.
|
|
13612
|
+
* @param {*} [options] Override http request option.
|
|
13613
|
+
* @throws {RequiredError}
|
|
13614
|
+
*/
|
|
13615
|
+
v1GetOpticalTrain(requestParameters, options) {
|
|
13616
|
+
return DefaultApiFp(this.configuration).v1GetOpticalTrain(requestParameters.label, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13617
|
+
}
|
|
13618
|
+
/**
|
|
13619
|
+
* Retrieves all configured optical trains and the optical train components assigned to each train.
|
|
13620
|
+
* @param {DefaultApiV1GetOpticalTrainsRequest} requestParameters Request parameters.
|
|
13621
|
+
* @param {*} [options] Override http request option.
|
|
13622
|
+
* @throws {RequiredError}
|
|
13623
|
+
*/
|
|
13624
|
+
v1GetOpticalTrains(requestParameters = {}, options) {
|
|
13625
|
+
return DefaultApiFp(this.configuration).v1GetOpticalTrains(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13626
|
+
}
|
|
13003
13627
|
/**
|
|
13004
13628
|
* 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.
|
|
13005
13629
|
* @param {DefaultApiV1GetOpticalTubeCoverStatusRequest} requestParameters Request parameters.
|
|
@@ -13090,6 +13714,24 @@ export class DefaultApi extends BaseAPI {
|
|
|
13090
13714
|
v1GetOpticalTubeStatuses(requestParameters = {}, options) {
|
|
13091
13715
|
return DefaultApiFp(this.configuration).v1GetOpticalTubeStatuses(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13092
13716
|
}
|
|
13717
|
+
/**
|
|
13718
|
+
* Retrieves the current temperature sensor status for an optical tube assembly. Returns V1OpticalTubeTemperatureSensorGroupStatus containing the temperature reading from each sensor.
|
|
13719
|
+
* @param {DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusRequest} requestParameters Request parameters.
|
|
13720
|
+
* @param {*} [options] Override http request option.
|
|
13721
|
+
* @throws {RequiredError}
|
|
13722
|
+
*/
|
|
13723
|
+
v1GetOpticalTubeTemperatureSensorGroupStatus(requestParameters = {}, options) {
|
|
13724
|
+
return DefaultApiFp(this.configuration).v1GetOpticalTubeTemperatureSensorGroupStatus(requestParameters.lineageId, requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
13725
|
+
}
|
|
13726
|
+
/**
|
|
13727
|
+
* 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.
|
|
13728
|
+
* @param {DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusesRequest} requestParameters Request parameters.
|
|
13729
|
+
* @param {*} [options] Override http request option.
|
|
13730
|
+
* @throws {RequiredError}
|
|
13731
|
+
*/
|
|
13732
|
+
v1GetOpticalTubeTemperatureSensorGroupStatuses(requestParameters = {}, options) {
|
|
13733
|
+
return DefaultApiFp(this.configuration).v1GetOpticalTubeTemperatureSensorGroupStatuses(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13734
|
+
}
|
|
13093
13735
|
/**
|
|
13094
13736
|
* 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.
|
|
13095
13737
|
* @param {DefaultApiV1GetRelaysRequest} requestParameters Request parameters.
|
|
@@ -13202,7 +13844,7 @@ export class DefaultApi extends BaseAPI {
|
|
|
13202
13844
|
return DefaultApiFp(this.configuration).v1GetSystemMetricNames(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13203
13845
|
}
|
|
13204
13846
|
/**
|
|
13205
|
-
* 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
|
|
13847
|
+
* 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.
|
|
13206
13848
|
* @param {DefaultApiV1GetSystemMetricsRequest} requestParameters Request parameters.
|
|
13207
13849
|
* @param {*} [options] Override http request option.
|
|
13208
13850
|
* @throws {RequiredError}
|
|
@@ -13211,7 +13853,7 @@ export class DefaultApi extends BaseAPI {
|
|
|
13211
13853
|
return DefaultApiFp(this.configuration).v1GetSystemMetrics(requestParameters.lineageId, requestParameters.metricName, requestParameters.after, requestParameters.before, options).then((request) => request(this.axios, this.basePath));
|
|
13212
13854
|
}
|
|
13213
13855
|
/**
|
|
13214
|
-
* 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
|
|
13856
|
+
* 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.
|
|
13215
13857
|
* @param {DefaultApiV1GetSystemMetricsCollectionsRequest} requestParameters Request parameters.
|
|
13216
13858
|
* @param {*} [options] Override http request option.
|
|
13217
13859
|
* @throws {RequiredError}
|
|
@@ -13956,6 +14598,15 @@ export class DefaultApi extends BaseAPI {
|
|
|
13956
14598
|
v1UpdateImageProcessingPlugin(requestParameters, options) {
|
|
13957
14599
|
return DefaultApiFp(this.configuration).v1UpdateImageProcessingPlugin(requestParameters.v1UpdateImageProcessingPluginRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13958
14600
|
}
|
|
14601
|
+
/**
|
|
14602
|
+
* Updates an optical train configuration by replacing the component assignments for the provided label.
|
|
14603
|
+
* @param {DefaultApiV1UpdateOpticalTrainRequest} requestParameters Request parameters.
|
|
14604
|
+
* @param {*} [options] Override http request option.
|
|
14605
|
+
* @throws {RequiredError}
|
|
14606
|
+
*/
|
|
14607
|
+
v1UpdateOpticalTrain(requestParameters, options) {
|
|
14608
|
+
return DefaultApiFp(this.configuration).v1UpdateOpticalTrain(requestParameters.v1UpdateOpticalTrainRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
14609
|
+
}
|
|
13959
14610
|
/**
|
|
13960
14611
|
* 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.
|
|
13961
14612
|
* @param {DefaultApiV1UpdateSystemSettingsRequest} requestParameters Request parameters.
|
|
@@ -14037,6 +14688,15 @@ export class DefaultApi extends BaseAPI {
|
|
|
14037
14688
|
v2GetSystemEvents(requestParameters = {}, options) {
|
|
14038
14689
|
return DefaultApiFp(this.configuration).v2GetSystemEvents(requestParameters.lineageId, requestParameters.type, requestParameters.before, requestParameters.limit, options).then((request) => request(this.axios, this.basePath));
|
|
14039
14690
|
}
|
|
14691
|
+
/**
|
|
14692
|
+
* 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.
|
|
14693
|
+
* @param {DefaultApiV2GetSystemStatusRequest} requestParameters Request parameters.
|
|
14694
|
+
* @param {*} [options] Override http request option.
|
|
14695
|
+
* @throws {RequiredError}
|
|
14696
|
+
*/
|
|
14697
|
+
v2GetSystemStatus(requestParameters = {}, options) {
|
|
14698
|
+
return DefaultApiFp(this.configuration).v2GetSystemStatus(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
14699
|
+
}
|
|
14040
14700
|
/**
|
|
14041
14701
|
* 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.
|
|
14042
14702
|
* @param {DefaultApiV2TurnOffRelayRequest} requestParameters Request parameters.
|