@ourskyai/node_platform-api 1.4.133 → 1.4.188
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +13 -1
- package/README.md +25 -4
- package/api.ts +1099 -50
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +635 -39
- package/dist/api.js +691 -31
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +635 -39
- package/dist/esm/api.js +690 -30
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/DefaultApi.md +506 -9
- package/docs/OpticalTrainComponentType.md +17 -0
- package/docs/SystemEventData.md +4 -0
- package/docs/V1CreateOpticalTrainRequest.md +31 -0
- package/docs/V1MotorStatus.md +2 -0
- package/docs/V1MountModel.md +2 -0
- package/docs/V1MountModelErrors.md +31 -0
- package/docs/V1MountModelPoint.md +6 -0
- package/docs/V1OpticalTrain.md +31 -0
- package/docs/V1OpticalTrainStatus.md +31 -0
- package/docs/V1OpticalTrainStatuses.md +21 -0
- package/docs/V1OpticalTrains.md +21 -0
- package/docs/V1OpticalTubeCoverSelectorRequest.md +3 -3
- package/docs/V1OpticalTubeStatus.md +1 -1
- package/docs/{V1OpticalTubeTemperatureSensorStatuses.md → V1OpticalTubeTemperatureSensorGroupStatus.md} +6 -4
- package/docs/V1OpticalTubeTemperatureSensorGroupStatuses.md +21 -0
- package/docs/V1SystemMetricsCollection.md +1 -1
- package/docs/V1TaskType.md +3 -1
- package/docs/V1UnassociatedOpticalTrainComponent.md +23 -0
- package/docs/V1UnassociatedOpticalTrainComponents.md +21 -0
- package/docs/V1UpdateOpticalTrainRequest.md +31 -0
- package/docs/V2SystemEventType.md +4 -0
- package/docs/V2SystemStatus.md +37 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* OurSky
|
|
6
6
|
* 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.4.
|
|
8
|
+
* The version of the OpenAPI document: 1.4.188
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.VideoContainerFormat = exports.VideoCodec = exports.V2SystemEventType = exports.V1UIOperationMode = exports.V1TrackBodyRequestBodyEnum = exports.V1TimeSourceStatisticsStateEnum = exports.V1TimeSourceStatisticsModeEnum = exports.V1TimeSource = exports.V1TaskType = exports.V1SystemOperationMode = exports.V1SystemNetworkInterfaceTypeEnum = exports.V1SystemMetricType = exports.V1OpticalTubeTemperatureSensorRole = exports.V1OpticalTubeHeaterRole = exports.V1OpticalTubeFanRole = exports.V1MountTrackPathState = exports.V1MountTrackPathFrame = exports.V1MountTrackPathEndedReason = exports.V1MotorRole = exports.V1Motor = exports.V1FilterType = exports.V1EnclosureFanRole = exports.V1CameraFunction = exports.V1AllSkySourceType = exports.V1AllSkyClassificationLabel = exports.SystemEventType = exports.SystemEventSeverity = exports.SystemEventOperationStatus = exports.RotatorTargetType = exports.RoofState = exports.RelayFunction = exports.RelayChannel = exports.PeerRole = exports.MessageType = exports.ImageFileFormat = exports.FocusOperation = exports.EventType = exports.EnclosureState = exports.EnclosureShutterState = exports.EnclosureShutterLabel = exports.EnclosureHvacMode = exports.EnclosureHvacFanSpeed = exports.ConnectionStatus = exports.AutofocusMethod = void 0;
|
|
25
|
+
exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.VideoContainerFormat = exports.VideoCodec = exports.V2SystemEventType = exports.V1UIOperationMode = exports.V1TrackBodyRequestBodyEnum = exports.V1TimeSourceStatisticsStateEnum = exports.V1TimeSourceStatisticsModeEnum = exports.V1TimeSource = exports.V1TaskType = exports.V1SystemOperationMode = exports.V1SystemNetworkInterfaceTypeEnum = exports.V1SystemMetricType = exports.V1OpticalTubeTemperatureSensorRole = exports.V1OpticalTubeHeaterRole = exports.V1OpticalTubeFanRole = exports.V1MountTrackPathState = exports.V1MountTrackPathFrame = exports.V1MountTrackPathEndedReason = exports.V1MotorRole = exports.V1Motor = exports.V1FilterType = exports.V1EnclosureFanRole = exports.V1CameraFunction = exports.V1AllSkySourceType = exports.V1AllSkyClassificationLabel = exports.SystemEventType = exports.SystemEventSeverity = exports.SystemEventOperationStatus = exports.RotatorTargetType = exports.RoofState = exports.RelayFunction = exports.RelayChannel = exports.PeerRole = exports.OpticalTrainComponentType = exports.MessageType = exports.ImageFileFormat = exports.FocusOperation = exports.EventType = exports.EnclosureState = exports.EnclosureShutterState = exports.EnclosureShutterLabel = exports.EnclosureHvacMode = exports.EnclosureHvacFanSpeed = exports.ConnectionStatus = exports.AutofocusMethod = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -190,6 +190,16 @@ exports.MessageType = {
|
|
|
190
190
|
WELCOME: 'welcome',
|
|
191
191
|
ERROR: 'error'
|
|
192
192
|
};
|
|
193
|
+
/**
|
|
194
|
+
* Type of optical train component.
|
|
195
|
+
*/
|
|
196
|
+
exports.OpticalTrainComponentType = {
|
|
197
|
+
CAMERA: 'CAMERA',
|
|
198
|
+
FOCUSER: 'FOCUSER',
|
|
199
|
+
ROTATOR: 'ROTATOR',
|
|
200
|
+
FILTER_WHEEL: 'FILTER_WHEEL',
|
|
201
|
+
OPTICAL_TUBE: 'OPTICAL_TUBE'
|
|
202
|
+
};
|
|
193
203
|
exports.PeerRole = {
|
|
194
204
|
PRODUCER: 'PRODUCER',
|
|
195
205
|
LISTENER: 'LISTENER'
|
|
@@ -486,13 +496,14 @@ exports.V1SystemOperationMode = {
|
|
|
486
496
|
MANUAL: 'MANUAL'
|
|
487
497
|
};
|
|
488
498
|
/**
|
|
489
|
-
* 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
|
|
499
|
+
* 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
|
|
490
500
|
*/
|
|
491
501
|
exports.V1TaskType = {
|
|
492
502
|
CREATE_MOUNT_MODEL: 'CREATE_MOUNT_MODEL',
|
|
493
503
|
CREATE_ELEVATION_MASK: 'CREATE_ELEVATION_MASK',
|
|
494
504
|
CALIBRATE_ENCLOSURE_ROTATOR: 'CALIBRATE_ENCLOSURE_ROTATOR',
|
|
495
505
|
CALIBRATE_ENCLOSURE_WINDOW: 'CALIBRATE_ENCLOSURE_WINDOW',
|
|
506
|
+
CALIBRATE_MOUNT_MOTOR_A_UNWINDER: 'CALIBRATE_MOUNT_MOTOR_A_UNWINDER',
|
|
496
507
|
RUN_AUTOFOCUS: 'RUN_AUTOFOCUS',
|
|
497
508
|
RUN_PERPETUAL_INSTRUCTION_LOOP: 'RUN_PERPETUAL_INSTRUCTION_LOOP',
|
|
498
509
|
STARTUP_WIZARD: 'STARTUP_WIZARD',
|
|
@@ -556,6 +567,8 @@ exports.V2SystemEventType = {
|
|
|
556
567
|
CAPTURE_IMAGES_CONTINUOUSLY: 'CAPTURE_IMAGES_CONTINUOUSLY',
|
|
557
568
|
CALIBRATE_ENCLOSURE_ROTATOR: 'CALIBRATE_ENCLOSURE_ROTATOR',
|
|
558
569
|
CALIBRATE_ENCLOSURE_WINDOW: 'CALIBRATE_ENCLOSURE_WINDOW',
|
|
570
|
+
CALIBRATE_MOUNT_MOTOR_A_UNWINDER: 'CALIBRATE_MOUNT_MOTOR_A_UNWINDER',
|
|
571
|
+
CLEAR_ENCLOSURE_ROTATOR_MOTOR_LOCKOUT: 'CLEAR_ENCLOSURE_ROTATOR_MOTOR_LOCKOUT',
|
|
559
572
|
CLOSE_ENCLOSURE_SHUTTERS: 'CLOSE_ENCLOSURE_SHUTTERS',
|
|
560
573
|
CLOSE_OPTICAL_TUBE_COVER: 'CLOSE_OPTICAL_TUBE_COVER',
|
|
561
574
|
CREATE_ELEVATION_MASK: 'CREATE_ELEVATION_MASK',
|
|
@@ -699,15 +712,18 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
699
712
|
};
|
|
700
713
|
}),
|
|
701
714
|
/**
|
|
702
|
-
* 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
|
|
715
|
+
* 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.
|
|
703
716
|
* @param {File} body
|
|
704
717
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
718
|
+
* @param {number} [motorAEncoderPositionDegrees] Motor A encoder position in degrees at the time the supplied image was captured.
|
|
719
|
+
* @param {number} [motorBEncoderPositionDegrees] Motor B encoder position in degrees at the time the supplied image was captured.
|
|
720
|
+
* @param {string} [timestamp] ISO 8601 timestamp when the supplied encoder positions were measured.
|
|
705
721
|
* @param {*} [options] Override http request option.
|
|
706
722
|
* @throws {RequiredError}
|
|
707
723
|
*/
|
|
708
|
-
|
|
724
|
+
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 = {}) {
|
|
709
725
|
// verify required parameter 'body' is not null or undefined
|
|
710
|
-
(0, common_1.assertParamExists)('
|
|
726
|
+
(0, common_1.assertParamExists)('v1AddMountModelPointUsingImage', 'body', body);
|
|
711
727
|
const localVarPath = `/node-platform/v1/mount/model/add-point-using-image`;
|
|
712
728
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
713
729
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -725,6 +741,17 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
725
741
|
if (lineageId !== undefined) {
|
|
726
742
|
localVarQueryParameter['lineageId'] = lineageId;
|
|
727
743
|
}
|
|
744
|
+
if (motorAEncoderPositionDegrees !== undefined) {
|
|
745
|
+
localVarQueryParameter['motorAEncoderPositionDegrees'] = motorAEncoderPositionDegrees;
|
|
746
|
+
}
|
|
747
|
+
if (motorBEncoderPositionDegrees !== undefined) {
|
|
748
|
+
localVarQueryParameter['motorBEncoderPositionDegrees'] = motorBEncoderPositionDegrees;
|
|
749
|
+
}
|
|
750
|
+
if (timestamp !== undefined) {
|
|
751
|
+
localVarQueryParameter['timestamp'] = (timestamp instanceof Date) ?
|
|
752
|
+
timestamp.toISOString() :
|
|
753
|
+
timestamp;
|
|
754
|
+
}
|
|
728
755
|
localVarHeaderParameter['Content-Type'] = 'application/octet-stream';
|
|
729
756
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
730
757
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1038,6 +1065,39 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1038
1065
|
options: localVarRequestOptions,
|
|
1039
1066
|
};
|
|
1040
1067
|
}),
|
|
1068
|
+
/**
|
|
1069
|
+
* 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.
|
|
1070
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
1071
|
+
* @param {*} [options] Override http request option.
|
|
1072
|
+
* @throws {RequiredError}
|
|
1073
|
+
*/
|
|
1074
|
+
v1ClearEnclosureRotatorMotorLockout: (lineageId_1, ...args_1) => __awaiter(this, [lineageId_1, ...args_1], void 0, function* (lineageId, options = {}) {
|
|
1075
|
+
const localVarPath = `/node-platform/v1/enclosure/rotator/clear-motor-lockout`;
|
|
1076
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1077
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1078
|
+
let baseOptions;
|
|
1079
|
+
if (configuration) {
|
|
1080
|
+
baseOptions = configuration.baseOptions;
|
|
1081
|
+
}
|
|
1082
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1083
|
+
const localVarHeaderParameter = {};
|
|
1084
|
+
const localVarQueryParameter = {};
|
|
1085
|
+
// authentication Roles required
|
|
1086
|
+
// authentication BearerToken required
|
|
1087
|
+
// http bearer authentication required
|
|
1088
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1089
|
+
if (lineageId !== undefined) {
|
|
1090
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
1091
|
+
}
|
|
1092
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1093
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1094
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1095
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1096
|
+
return {
|
|
1097
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1098
|
+
options: localVarRequestOptions,
|
|
1099
|
+
};
|
|
1100
|
+
}),
|
|
1041
1101
|
/**
|
|
1042
1102
|
* 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.
|
|
1043
1103
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -1279,6 +1339,44 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1279
1339
|
options: localVarRequestOptions,
|
|
1280
1340
|
};
|
|
1281
1341
|
}),
|
|
1342
|
+
/**
|
|
1343
|
+
* Creates an optical train configuration by assigning optical train components to a human-readable label.
|
|
1344
|
+
* @param {V1CreateOpticalTrainRequest} v1CreateOpticalTrainRequest
|
|
1345
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
1346
|
+
* @param {*} [options] Override http request option.
|
|
1347
|
+
* @throws {RequiredError}
|
|
1348
|
+
*/
|
|
1349
|
+
v1CreateOpticalTrain: (v1CreateOpticalTrainRequest_1, lineageId_1, ...args_1) => __awaiter(this, [v1CreateOpticalTrainRequest_1, lineageId_1, ...args_1], void 0, function* (v1CreateOpticalTrainRequest, lineageId, options = {}) {
|
|
1350
|
+
// verify required parameter 'v1CreateOpticalTrainRequest' is not null or undefined
|
|
1351
|
+
(0, common_1.assertParamExists)('v1CreateOpticalTrain', 'v1CreateOpticalTrainRequest', v1CreateOpticalTrainRequest);
|
|
1352
|
+
const localVarPath = `/node-platform/v1/optical-trains`;
|
|
1353
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1354
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1355
|
+
let baseOptions;
|
|
1356
|
+
if (configuration) {
|
|
1357
|
+
baseOptions = configuration.baseOptions;
|
|
1358
|
+
}
|
|
1359
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1360
|
+
const localVarHeaderParameter = {};
|
|
1361
|
+
const localVarQueryParameter = {};
|
|
1362
|
+
// authentication Roles required
|
|
1363
|
+
// authentication BearerToken required
|
|
1364
|
+
// http bearer authentication required
|
|
1365
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1366
|
+
if (lineageId !== undefined) {
|
|
1367
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
1368
|
+
}
|
|
1369
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1370
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1371
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1372
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1373
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1374
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1CreateOpticalTrainRequest, localVarRequestOptions, configuration);
|
|
1375
|
+
return {
|
|
1376
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1377
|
+
options: localVarRequestOptions,
|
|
1378
|
+
};
|
|
1379
|
+
}),
|
|
1282
1380
|
/**
|
|
1283
1381
|
* 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.
|
|
1284
1382
|
* @param {V1CycleRelaysRequest} v1CycleRelaysRequest
|
|
@@ -1394,6 +1492,45 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1394
1492
|
options: localVarRequestOptions,
|
|
1395
1493
|
};
|
|
1396
1494
|
}),
|
|
1495
|
+
/**
|
|
1496
|
+
* Deletes one optical train configuration by label.
|
|
1497
|
+
* @param {string} label Human-readable label of the optical train to delete.
|
|
1498
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
1499
|
+
* @param {*} [options] Override http request option.
|
|
1500
|
+
* @throws {RequiredError}
|
|
1501
|
+
*/
|
|
1502
|
+
v1DeleteOpticalTrain: (label_1, lineageId_1, ...args_1) => __awaiter(this, [label_1, lineageId_1, ...args_1], void 0, function* (label, lineageId, options = {}) {
|
|
1503
|
+
// verify required parameter 'label' is not null or undefined
|
|
1504
|
+
(0, common_1.assertParamExists)('v1DeleteOpticalTrain', 'label', label);
|
|
1505
|
+
const localVarPath = `/node-platform/v1/optical-train`;
|
|
1506
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1507
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1508
|
+
let baseOptions;
|
|
1509
|
+
if (configuration) {
|
|
1510
|
+
baseOptions = configuration.baseOptions;
|
|
1511
|
+
}
|
|
1512
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
1513
|
+
const localVarHeaderParameter = {};
|
|
1514
|
+
const localVarQueryParameter = {};
|
|
1515
|
+
// authentication Roles required
|
|
1516
|
+
// authentication BearerToken required
|
|
1517
|
+
// http bearer authentication required
|
|
1518
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1519
|
+
if (lineageId !== undefined) {
|
|
1520
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
1521
|
+
}
|
|
1522
|
+
if (label !== undefined) {
|
|
1523
|
+
localVarQueryParameter['label'] = label;
|
|
1524
|
+
}
|
|
1525
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1526
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1527
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1528
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1529
|
+
return {
|
|
1530
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1531
|
+
options: localVarRequestOptions,
|
|
1532
|
+
};
|
|
1533
|
+
}),
|
|
1397
1534
|
/**
|
|
1398
1535
|
* 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.
|
|
1399
1536
|
* @param {V1DeleteVideoRequest} v1DeleteVideoRequest
|
|
@@ -1984,10 +2121,11 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1984
2121
|
/**
|
|
1985
2122
|
* 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.
|
|
1986
2123
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
2124
|
+
* @param {string} [id] Optional focuser ID. If provided, finds limits for that focuser instead of the default focuser.
|
|
1987
2125
|
* @param {*} [options] Override http request option.
|
|
1988
2126
|
* @throws {RequiredError}
|
|
1989
2127
|
*/
|
|
1990
|
-
v1FindFocuserLimits: (lineageId_1, ...args_1) => __awaiter(this, [lineageId_1, ...args_1], void 0, function* (lineageId, options = {}) {
|
|
2128
|
+
v1FindFocuserLimits: (lineageId_1, id_1, ...args_1) => __awaiter(this, [lineageId_1, id_1, ...args_1], void 0, function* (lineageId, id, options = {}) {
|
|
1991
2129
|
const localVarPath = `/node-platform/v1/focuser/find-limit`;
|
|
1992
2130
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1993
2131
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -2005,6 +2143,9 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
2005
2143
|
if (lineageId !== undefined) {
|
|
2006
2144
|
localVarQueryParameter['lineageId'] = lineageId;
|
|
2007
2145
|
}
|
|
2146
|
+
if (id !== undefined) {
|
|
2147
|
+
localVarQueryParameter['id'] = id;
|
|
2148
|
+
}
|
|
2008
2149
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2009
2150
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2010
2151
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3327,6 +3468,78 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
3327
3468
|
options: localVarRequestOptions,
|
|
3328
3469
|
};
|
|
3329
3470
|
}),
|
|
3471
|
+
/**
|
|
3472
|
+
* Retrieves one optical train configuration by label.
|
|
3473
|
+
* @param {string} label Human-readable label of the optical train to retrieve.
|
|
3474
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
3475
|
+
* @param {*} [options] Override http request option.
|
|
3476
|
+
* @throws {RequiredError}
|
|
3477
|
+
*/
|
|
3478
|
+
v1GetOpticalTrain: (label_1, lineageId_1, ...args_1) => __awaiter(this, [label_1, lineageId_1, ...args_1], void 0, function* (label, lineageId, options = {}) {
|
|
3479
|
+
// verify required parameter 'label' is not null or undefined
|
|
3480
|
+
(0, common_1.assertParamExists)('v1GetOpticalTrain', 'label', label);
|
|
3481
|
+
const localVarPath = `/node-platform/v1/optical-train`;
|
|
3482
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3483
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
3484
|
+
let baseOptions;
|
|
3485
|
+
if (configuration) {
|
|
3486
|
+
baseOptions = configuration.baseOptions;
|
|
3487
|
+
}
|
|
3488
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
3489
|
+
const localVarHeaderParameter = {};
|
|
3490
|
+
const localVarQueryParameter = {};
|
|
3491
|
+
// authentication Roles required
|
|
3492
|
+
// authentication BearerToken required
|
|
3493
|
+
// http bearer authentication required
|
|
3494
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
3495
|
+
if (lineageId !== undefined) {
|
|
3496
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
3497
|
+
}
|
|
3498
|
+
if (label !== undefined) {
|
|
3499
|
+
localVarQueryParameter['label'] = label;
|
|
3500
|
+
}
|
|
3501
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3502
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
3503
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3504
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
3505
|
+
return {
|
|
3506
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
3507
|
+
options: localVarRequestOptions,
|
|
3508
|
+
};
|
|
3509
|
+
}),
|
|
3510
|
+
/**
|
|
3511
|
+
* Retrieves all configured optical trains and the optical train components assigned to each train.
|
|
3512
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
3513
|
+
* @param {*} [options] Override http request option.
|
|
3514
|
+
* @throws {RequiredError}
|
|
3515
|
+
*/
|
|
3516
|
+
v1GetOpticalTrains: (lineageId_1, ...args_1) => __awaiter(this, [lineageId_1, ...args_1], void 0, function* (lineageId, options = {}) {
|
|
3517
|
+
const localVarPath = `/node-platform/v1/optical-trains`;
|
|
3518
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3519
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
3520
|
+
let baseOptions;
|
|
3521
|
+
if (configuration) {
|
|
3522
|
+
baseOptions = configuration.baseOptions;
|
|
3523
|
+
}
|
|
3524
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
3525
|
+
const localVarHeaderParameter = {};
|
|
3526
|
+
const localVarQueryParameter = {};
|
|
3527
|
+
// authentication Roles required
|
|
3528
|
+
// authentication BearerToken required
|
|
3529
|
+
// http bearer authentication required
|
|
3530
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
3531
|
+
if (lineageId !== undefined) {
|
|
3532
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
3533
|
+
}
|
|
3534
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3535
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
3536
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3537
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
3538
|
+
return {
|
|
3539
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
3540
|
+
options: localVarRequestOptions,
|
|
3541
|
+
};
|
|
3542
|
+
}),
|
|
3330
3543
|
/**
|
|
3331
3544
|
* 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.
|
|
3332
3545
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -3677,6 +3890,76 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
3677
3890
|
options: localVarRequestOptions,
|
|
3678
3891
|
};
|
|
3679
3892
|
}),
|
|
3893
|
+
/**
|
|
3894
|
+
* Retrieves the current temperature sensor status for an optical tube assembly. Returns V1OpticalTubeTemperatureSensorGroupStatus containing the temperature reading from each sensor.
|
|
3895
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
3896
|
+
* @param {string} [id] Optional optical tube ID. If provided, returns temperature sensor statuses for that optical tube instead of the default optical tube.
|
|
3897
|
+
* @param {*} [options] Override http request option.
|
|
3898
|
+
* @throws {RequiredError}
|
|
3899
|
+
*/
|
|
3900
|
+
v1GetOpticalTubeTemperatureSensorGroupStatus: (lineageId_1, id_1, ...args_1) => __awaiter(this, [lineageId_1, id_1, ...args_1], void 0, function* (lineageId, id, options = {}) {
|
|
3901
|
+
const localVarPath = `/node-platform/v1/optical-tube/temperature-sensors/status`;
|
|
3902
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3903
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
3904
|
+
let baseOptions;
|
|
3905
|
+
if (configuration) {
|
|
3906
|
+
baseOptions = configuration.baseOptions;
|
|
3907
|
+
}
|
|
3908
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
3909
|
+
const localVarHeaderParameter = {};
|
|
3910
|
+
const localVarQueryParameter = {};
|
|
3911
|
+
// authentication Roles required
|
|
3912
|
+
// authentication BearerToken required
|
|
3913
|
+
// http bearer authentication required
|
|
3914
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
3915
|
+
if (lineageId !== undefined) {
|
|
3916
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
3917
|
+
}
|
|
3918
|
+
if (id !== undefined) {
|
|
3919
|
+
localVarQueryParameter['id'] = id;
|
|
3920
|
+
}
|
|
3921
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3922
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
3923
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3924
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
3925
|
+
return {
|
|
3926
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
3927
|
+
options: localVarRequestOptions,
|
|
3928
|
+
};
|
|
3929
|
+
}),
|
|
3930
|
+
/**
|
|
3931
|
+
* 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.
|
|
3932
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
3933
|
+
* @param {*} [options] Override http request option.
|
|
3934
|
+
* @throws {RequiredError}
|
|
3935
|
+
*/
|
|
3936
|
+
v1GetOpticalTubeTemperatureSensorGroupStatuses: (lineageId_1, ...args_1) => __awaiter(this, [lineageId_1, ...args_1], void 0, function* (lineageId, options = {}) {
|
|
3937
|
+
const localVarPath = `/node-platform/v1/optical-tubes/temperature-sensors/status`;
|
|
3938
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3939
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
3940
|
+
let baseOptions;
|
|
3941
|
+
if (configuration) {
|
|
3942
|
+
baseOptions = configuration.baseOptions;
|
|
3943
|
+
}
|
|
3944
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
3945
|
+
const localVarHeaderParameter = {};
|
|
3946
|
+
const localVarQueryParameter = {};
|
|
3947
|
+
// authentication Roles required
|
|
3948
|
+
// authentication BearerToken required
|
|
3949
|
+
// http bearer authentication required
|
|
3950
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
3951
|
+
if (lineageId !== undefined) {
|
|
3952
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
3953
|
+
}
|
|
3954
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3955
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
3956
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3957
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
3958
|
+
return {
|
|
3959
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
3960
|
+
options: localVarRequestOptions,
|
|
3961
|
+
};
|
|
3962
|
+
}),
|
|
3680
3963
|
/**
|
|
3681
3964
|
* 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.
|
|
3682
3965
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -4111,7 +4394,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
4111
4394
|
};
|
|
4112
4395
|
}),
|
|
4113
4396
|
/**
|
|
4114
|
-
* 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
|
|
4397
|
+
* 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.
|
|
4115
4398
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
4116
4399
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
4117
4400
|
* @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.
|
|
@@ -4160,7 +4443,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
4160
4443
|
};
|
|
4161
4444
|
}),
|
|
4162
4445
|
/**
|
|
4163
|
-
* 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
|
|
4446
|
+
* 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.
|
|
4164
4447
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
4165
4448
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
4166
4449
|
* @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.
|
|
@@ -7143,6 +7426,44 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
7143
7426
|
options: localVarRequestOptions,
|
|
7144
7427
|
};
|
|
7145
7428
|
}),
|
|
7429
|
+
/**
|
|
7430
|
+
* Updates an optical train configuration by replacing the component assignments for the provided label.
|
|
7431
|
+
* @param {V1UpdateOpticalTrainRequest} v1UpdateOpticalTrainRequest
|
|
7432
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7433
|
+
* @param {*} [options] Override http request option.
|
|
7434
|
+
* @throws {RequiredError}
|
|
7435
|
+
*/
|
|
7436
|
+
v1UpdateOpticalTrain: (v1UpdateOpticalTrainRequest_1, lineageId_1, ...args_1) => __awaiter(this, [v1UpdateOpticalTrainRequest_1, lineageId_1, ...args_1], void 0, function* (v1UpdateOpticalTrainRequest, lineageId, options = {}) {
|
|
7437
|
+
// verify required parameter 'v1UpdateOpticalTrainRequest' is not null or undefined
|
|
7438
|
+
(0, common_1.assertParamExists)('v1UpdateOpticalTrain', 'v1UpdateOpticalTrainRequest', v1UpdateOpticalTrainRequest);
|
|
7439
|
+
const localVarPath = `/node-platform/v1/optical-train`;
|
|
7440
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7441
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
7442
|
+
let baseOptions;
|
|
7443
|
+
if (configuration) {
|
|
7444
|
+
baseOptions = configuration.baseOptions;
|
|
7445
|
+
}
|
|
7446
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
7447
|
+
const localVarHeaderParameter = {};
|
|
7448
|
+
const localVarQueryParameter = {};
|
|
7449
|
+
// authentication Roles required
|
|
7450
|
+
// authentication BearerToken required
|
|
7451
|
+
// http bearer authentication required
|
|
7452
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
7453
|
+
if (lineageId !== undefined) {
|
|
7454
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
7455
|
+
}
|
|
7456
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7457
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
7458
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
7459
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7460
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
7461
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1UpdateOpticalTrainRequest, localVarRequestOptions, configuration);
|
|
7462
|
+
return {
|
|
7463
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
7464
|
+
options: localVarRequestOptions,
|
|
7465
|
+
};
|
|
7466
|
+
}),
|
|
7146
7467
|
/**
|
|
7147
7468
|
* 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.
|
|
7148
7469
|
* @param {V1SystemSettings} v1SystemSettings
|
|
@@ -7497,6 +7818,39 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
7497
7818
|
options: localVarRequestOptions,
|
|
7498
7819
|
};
|
|
7499
7820
|
}),
|
|
7821
|
+
/**
|
|
7822
|
+
* 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.
|
|
7823
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7824
|
+
* @param {*} [options] Override http request option.
|
|
7825
|
+
* @throws {RequiredError}
|
|
7826
|
+
*/
|
|
7827
|
+
v2GetSystemStatus: (lineageId_1, ...args_1) => __awaiter(this, [lineageId_1, ...args_1], void 0, function* (lineageId, options = {}) {
|
|
7828
|
+
const localVarPath = `/node-platform/v2/system/status`;
|
|
7829
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7830
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
7831
|
+
let baseOptions;
|
|
7832
|
+
if (configuration) {
|
|
7833
|
+
baseOptions = configuration.baseOptions;
|
|
7834
|
+
}
|
|
7835
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
7836
|
+
const localVarHeaderParameter = {};
|
|
7837
|
+
const localVarQueryParameter = {};
|
|
7838
|
+
// authentication Roles required
|
|
7839
|
+
// authentication BearerToken required
|
|
7840
|
+
// http bearer authentication required
|
|
7841
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
7842
|
+
if (lineageId !== undefined) {
|
|
7843
|
+
localVarQueryParameter['lineageId'] = lineageId;
|
|
7844
|
+
}
|
|
7845
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
7846
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
7847
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7848
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
7849
|
+
return {
|
|
7850
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
7851
|
+
options: localVarRequestOptions,
|
|
7852
|
+
};
|
|
7853
|
+
}),
|
|
7500
7854
|
/**
|
|
7501
7855
|
* 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.
|
|
7502
7856
|
* @param {V2TurnOffRelayRequest} v2TurnOffRelayRequest
|
|
@@ -7599,18 +7953,21 @@ const DefaultApiFp = function (configuration) {
|
|
|
7599
7953
|
});
|
|
7600
7954
|
},
|
|
7601
7955
|
/**
|
|
7602
|
-
* 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
|
|
7956
|
+
* 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.
|
|
7603
7957
|
* @param {File} body
|
|
7604
7958
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
7959
|
+
* @param {number} [motorAEncoderPositionDegrees] Motor A encoder position in degrees at the time the supplied image was captured.
|
|
7960
|
+
* @param {number} [motorBEncoderPositionDegrees] Motor B encoder position in degrees at the time the supplied image was captured.
|
|
7961
|
+
* @param {string} [timestamp] ISO 8601 timestamp when the supplied encoder positions were measured.
|
|
7605
7962
|
* @param {*} [options] Override http request option.
|
|
7606
7963
|
* @throws {RequiredError}
|
|
7607
7964
|
*/
|
|
7608
|
-
|
|
7965
|
+
v1AddMountModelPointUsingImage(body, lineageId, motorAEncoderPositionDegrees, motorBEncoderPositionDegrees, timestamp, options) {
|
|
7609
7966
|
return __awaiter(this, void 0, void 0, function* () {
|
|
7610
7967
|
var _a, _b, _c;
|
|
7611
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
7968
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AddMountModelPointUsingImage(body, lineageId, motorAEncoderPositionDegrees, motorBEncoderPositionDegrees, timestamp, options);
|
|
7612
7969
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
7613
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.
|
|
7970
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.v1AddMountModelPointUsingImage']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
7614
7971
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7615
7972
|
});
|
|
7616
7973
|
},
|
|
@@ -7744,6 +8101,21 @@ const DefaultApiFp = function (configuration) {
|
|
|
7744
8101
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7745
8102
|
});
|
|
7746
8103
|
},
|
|
8104
|
+
/**
|
|
8105
|
+
* 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.
|
|
8106
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
8107
|
+
* @param {*} [options] Override http request option.
|
|
8108
|
+
* @throws {RequiredError}
|
|
8109
|
+
*/
|
|
8110
|
+
v1ClearEnclosureRotatorMotorLockout(lineageId, options) {
|
|
8111
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8112
|
+
var _a, _b, _c;
|
|
8113
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1ClearEnclosureRotatorMotorLockout(lineageId, options);
|
|
8114
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8115
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.v1ClearEnclosureRotatorMotorLockout']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8116
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8117
|
+
});
|
|
8118
|
+
},
|
|
7747
8119
|
/**
|
|
7748
8120
|
* 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.
|
|
7749
8121
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -7853,6 +8225,22 @@ const DefaultApiFp = function (configuration) {
|
|
|
7853
8225
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7854
8226
|
});
|
|
7855
8227
|
},
|
|
8228
|
+
/**
|
|
8229
|
+
* Creates an optical train configuration by assigning optical train components to a human-readable label.
|
|
8230
|
+
* @param {V1CreateOpticalTrainRequest} v1CreateOpticalTrainRequest
|
|
8231
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
8232
|
+
* @param {*} [options] Override http request option.
|
|
8233
|
+
* @throws {RequiredError}
|
|
8234
|
+
*/
|
|
8235
|
+
v1CreateOpticalTrain(v1CreateOpticalTrainRequest, lineageId, options) {
|
|
8236
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8237
|
+
var _a, _b, _c;
|
|
8238
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateOpticalTrain(v1CreateOpticalTrainRequest, lineageId, options);
|
|
8239
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8240
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.v1CreateOpticalTrain']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8241
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8242
|
+
});
|
|
8243
|
+
},
|
|
7856
8244
|
/**
|
|
7857
8245
|
* 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.
|
|
7858
8246
|
* @param {V1CycleRelaysRequest} v1CycleRelaysRequest
|
|
@@ -7902,6 +8290,22 @@ const DefaultApiFp = function (configuration) {
|
|
|
7902
8290
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7903
8291
|
});
|
|
7904
8292
|
},
|
|
8293
|
+
/**
|
|
8294
|
+
* Deletes one optical train configuration by label.
|
|
8295
|
+
* @param {string} label Human-readable label of the optical train to delete.
|
|
8296
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
8297
|
+
* @param {*} [options] Override http request option.
|
|
8298
|
+
* @throws {RequiredError}
|
|
8299
|
+
*/
|
|
8300
|
+
v1DeleteOpticalTrain(label, lineageId, options) {
|
|
8301
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8302
|
+
var _a, _b, _c;
|
|
8303
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DeleteOpticalTrain(label, lineageId, options);
|
|
8304
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8305
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.v1DeleteOpticalTrain']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8306
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8307
|
+
});
|
|
8308
|
+
},
|
|
7905
8309
|
/**
|
|
7906
8310
|
* 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.
|
|
7907
8311
|
* @param {V1DeleteVideoRequest} v1DeleteVideoRequest
|
|
@@ -8166,13 +8570,14 @@ const DefaultApiFp = function (configuration) {
|
|
|
8166
8570
|
/**
|
|
8167
8571
|
* 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.
|
|
8168
8572
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
8573
|
+
* @param {string} [id] Optional focuser ID. If provided, finds limits for that focuser instead of the default focuser.
|
|
8169
8574
|
* @param {*} [options] Override http request option.
|
|
8170
8575
|
* @throws {RequiredError}
|
|
8171
8576
|
*/
|
|
8172
|
-
v1FindFocuserLimits(lineageId, options) {
|
|
8577
|
+
v1FindFocuserLimits(lineageId, id, options) {
|
|
8173
8578
|
return __awaiter(this, void 0, void 0, function* () {
|
|
8174
8579
|
var _a, _b, _c;
|
|
8175
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1FindFocuserLimits(lineageId, options);
|
|
8580
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1FindFocuserLimits(lineageId, id, options);
|
|
8176
8581
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8177
8582
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.v1FindFocuserLimits']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8178
8583
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -8747,6 +9152,37 @@ const DefaultApiFp = function (configuration) {
|
|
|
8747
9152
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8748
9153
|
});
|
|
8749
9154
|
},
|
|
9155
|
+
/**
|
|
9156
|
+
* Retrieves one optical train configuration by label.
|
|
9157
|
+
* @param {string} label Human-readable label of the optical train to retrieve.
|
|
9158
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
9159
|
+
* @param {*} [options] Override http request option.
|
|
9160
|
+
* @throws {RequiredError}
|
|
9161
|
+
*/
|
|
9162
|
+
v1GetOpticalTrain(label, lineageId, options) {
|
|
9163
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9164
|
+
var _a, _b, _c;
|
|
9165
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetOpticalTrain(label, lineageId, options);
|
|
9166
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
9167
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.v1GetOpticalTrain']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
9168
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9169
|
+
});
|
|
9170
|
+
},
|
|
9171
|
+
/**
|
|
9172
|
+
* Retrieves all configured optical trains and the optical train components assigned to each train.
|
|
9173
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
9174
|
+
* @param {*} [options] Override http request option.
|
|
9175
|
+
* @throws {RequiredError}
|
|
9176
|
+
*/
|
|
9177
|
+
v1GetOpticalTrains(lineageId, options) {
|
|
9178
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9179
|
+
var _a, _b, _c;
|
|
9180
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetOpticalTrains(lineageId, options);
|
|
9181
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
9182
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.v1GetOpticalTrains']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
9183
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9184
|
+
});
|
|
9185
|
+
},
|
|
8750
9186
|
/**
|
|
8751
9187
|
* 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.
|
|
8752
9188
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -8902,6 +9338,37 @@ const DefaultApiFp = function (configuration) {
|
|
|
8902
9338
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8903
9339
|
});
|
|
8904
9340
|
},
|
|
9341
|
+
/**
|
|
9342
|
+
* Retrieves the current temperature sensor status for an optical tube assembly. Returns V1OpticalTubeTemperatureSensorGroupStatus containing the temperature reading from each sensor.
|
|
9343
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
9344
|
+
* @param {string} [id] Optional optical tube ID. If provided, returns temperature sensor statuses for that optical tube instead of the default optical tube.
|
|
9345
|
+
* @param {*} [options] Override http request option.
|
|
9346
|
+
* @throws {RequiredError}
|
|
9347
|
+
*/
|
|
9348
|
+
v1GetOpticalTubeTemperatureSensorGroupStatus(lineageId, id, options) {
|
|
9349
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9350
|
+
var _a, _b, _c;
|
|
9351
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetOpticalTubeTemperatureSensorGroupStatus(lineageId, id, options);
|
|
9352
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
9353
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.v1GetOpticalTubeTemperatureSensorGroupStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
9354
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9355
|
+
});
|
|
9356
|
+
},
|
|
9357
|
+
/**
|
|
9358
|
+
* 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.
|
|
9359
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
9360
|
+
* @param {*} [options] Override http request option.
|
|
9361
|
+
* @throws {RequiredError}
|
|
9362
|
+
*/
|
|
9363
|
+
v1GetOpticalTubeTemperatureSensorGroupStatuses(lineageId, options) {
|
|
9364
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9365
|
+
var _a, _b, _c;
|
|
9366
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetOpticalTubeTemperatureSensorGroupStatuses(lineageId, options);
|
|
9367
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
9368
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.v1GetOpticalTubeTemperatureSensorGroupStatuses']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
9369
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9370
|
+
});
|
|
9371
|
+
},
|
|
8905
9372
|
/**
|
|
8906
9373
|
* 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.
|
|
8907
9374
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
@@ -9093,7 +9560,7 @@ const DefaultApiFp = function (configuration) {
|
|
|
9093
9560
|
});
|
|
9094
9561
|
},
|
|
9095
9562
|
/**
|
|
9096
|
-
* 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
|
|
9563
|
+
* 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.
|
|
9097
9564
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
9098
9565
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
9099
9566
|
* @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.
|
|
@@ -9111,7 +9578,7 @@ const DefaultApiFp = function (configuration) {
|
|
|
9111
9578
|
});
|
|
9112
9579
|
},
|
|
9113
9580
|
/**
|
|
9114
|
-
* 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
|
|
9581
|
+
* 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.
|
|
9115
9582
|
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
9116
9583
|
* @param {string} [metricName] Metric name to query. If omitted, all metrics in the time window are returned.
|
|
9117
9584
|
* @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.
|
|
@@ -10405,6 +10872,22 @@ const DefaultApiFp = function (configuration) {
|
|
|
10405
10872
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10406
10873
|
});
|
|
10407
10874
|
},
|
|
10875
|
+
/**
|
|
10876
|
+
* Updates an optical train configuration by replacing the component assignments for the provided label.
|
|
10877
|
+
* @param {V1UpdateOpticalTrainRequest} v1UpdateOpticalTrainRequest
|
|
10878
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
10879
|
+
* @param {*} [options] Override http request option.
|
|
10880
|
+
* @throws {RequiredError}
|
|
10881
|
+
*/
|
|
10882
|
+
v1UpdateOpticalTrain(v1UpdateOpticalTrainRequest, lineageId, options) {
|
|
10883
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
10884
|
+
var _a, _b, _c;
|
|
10885
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1UpdateOpticalTrain(v1UpdateOpticalTrainRequest, lineageId, options);
|
|
10886
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
10887
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.v1UpdateOpticalTrain']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
10888
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10889
|
+
});
|
|
10890
|
+
},
|
|
10408
10891
|
/**
|
|
10409
10892
|
* 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.
|
|
10410
10893
|
* @param {V1SystemSettings} v1SystemSettings
|
|
@@ -10551,6 +11034,21 @@ const DefaultApiFp = function (configuration) {
|
|
|
10551
11034
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10552
11035
|
});
|
|
10553
11036
|
},
|
|
11037
|
+
/**
|
|
11038
|
+
* 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.
|
|
11039
|
+
* @param {string} [lineageId] Lineage ID required when requesting data from the cloud platform
|
|
11040
|
+
* @param {*} [options] Override http request option.
|
|
11041
|
+
* @throws {RequiredError}
|
|
11042
|
+
*/
|
|
11043
|
+
v2GetSystemStatus(lineageId, options) {
|
|
11044
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
11045
|
+
var _a, _b, _c;
|
|
11046
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v2GetSystemStatus(lineageId, options);
|
|
11047
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
11048
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.v2GetSystemStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11049
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11050
|
+
});
|
|
11051
|
+
},
|
|
10554
11052
|
/**
|
|
10555
11053
|
* 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.
|
|
10556
11054
|
* @param {V2TurnOffRelayRequest} v2TurnOffRelayRequest
|
|
@@ -10602,13 +11100,13 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
10602
11100
|
return localVarFp.v1AddMountModelPointHere(requestParameters.v1AddMountModelPointHereRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
10603
11101
|
},
|
|
10604
11102
|
/**
|
|
10605
|
-
* 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
|
|
10606
|
-
* @param {
|
|
11103
|
+
* 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.
|
|
11104
|
+
* @param {DefaultApiV1AddMountModelPointUsingImageRequest} requestParameters Request parameters.
|
|
10607
11105
|
* @param {*} [options] Override http request option.
|
|
10608
11106
|
* @throws {RequiredError}
|
|
10609
11107
|
*/
|
|
10610
|
-
|
|
10611
|
-
return localVarFp.
|
|
11108
|
+
v1AddMountModelPointUsingImage(requestParameters, options) {
|
|
11109
|
+
return localVarFp.v1AddMountModelPointUsingImage(requestParameters.body, requestParameters.lineageId, requestParameters.motorAEncoderPositionDegrees, requestParameters.motorBEncoderPositionDegrees, requestParameters.timestamp, options).then((request) => request(axios, basePath));
|
|
10612
11110
|
},
|
|
10613
11111
|
/**
|
|
10614
11112
|
* Updates the current custom path tracking session by appending control points. The trackingSessionId and frame must match the current session.
|
|
@@ -10684,6 +11182,15 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
10684
11182
|
v1CaptureImagesContinuously(requestParameters, options) {
|
|
10685
11183
|
return localVarFp.v1CaptureImagesContinuously(requestParameters.v1CaptureImagesContinuouslyRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
10686
11184
|
},
|
|
11185
|
+
/**
|
|
11186
|
+
* 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.
|
|
11187
|
+
* @param {DefaultApiV1ClearEnclosureRotatorMotorLockoutRequest} requestParameters Request parameters.
|
|
11188
|
+
* @param {*} [options] Override http request option.
|
|
11189
|
+
* @throws {RequiredError}
|
|
11190
|
+
*/
|
|
11191
|
+
v1ClearEnclosureRotatorMotorLockout(requestParameters = {}, options) {
|
|
11192
|
+
return localVarFp.v1ClearEnclosureRotatorMotorLockout(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11193
|
+
},
|
|
10687
11194
|
/**
|
|
10688
11195
|
* 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.
|
|
10689
11196
|
* @param {DefaultApiV1ClearMountModelRequest} requestParameters Request parameters.
|
|
@@ -10749,6 +11256,15 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
10749
11256
|
v1CreateMountModel(requestParameters, options) {
|
|
10750
11257
|
return localVarFp.v1CreateMountModel(requestParameters.v1CreateMountModelRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
10751
11258
|
},
|
|
11259
|
+
/**
|
|
11260
|
+
* Creates an optical train configuration by assigning optical train components to a human-readable label.
|
|
11261
|
+
* @param {DefaultApiV1CreateOpticalTrainRequest} requestParameters Request parameters.
|
|
11262
|
+
* @param {*} [options] Override http request option.
|
|
11263
|
+
* @throws {RequiredError}
|
|
11264
|
+
*/
|
|
11265
|
+
v1CreateOpticalTrain(requestParameters, options) {
|
|
11266
|
+
return localVarFp.v1CreateOpticalTrain(requestParameters.v1CreateOpticalTrainRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11267
|
+
},
|
|
10752
11268
|
/**
|
|
10753
11269
|
* 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.
|
|
10754
11270
|
* @param {DefaultApiV1CycleRelaysRequest} requestParameters Request parameters.
|
|
@@ -10777,6 +11293,15 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
10777
11293
|
v1DeleteImageProcessingPlugin(requestParameters, options) {
|
|
10778
11294
|
return localVarFp.v1DeleteImageProcessingPlugin(requestParameters.v1GetImageProcessingPluginRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
10779
11295
|
},
|
|
11296
|
+
/**
|
|
11297
|
+
* Deletes one optical train configuration by label.
|
|
11298
|
+
* @param {DefaultApiV1DeleteOpticalTrainRequest} requestParameters Request parameters.
|
|
11299
|
+
* @param {*} [options] Override http request option.
|
|
11300
|
+
* @throws {RequiredError}
|
|
11301
|
+
*/
|
|
11302
|
+
v1DeleteOpticalTrain(requestParameters, options) {
|
|
11303
|
+
return localVarFp.v1DeleteOpticalTrain(requestParameters.label, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11304
|
+
},
|
|
10780
11305
|
/**
|
|
10781
11306
|
* 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.
|
|
10782
11307
|
* @param {DefaultApiV1DeleteVideoRequest} requestParameters Request parameters.
|
|
@@ -10937,7 +11462,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
10937
11462
|
* @throws {RequiredError}
|
|
10938
11463
|
*/
|
|
10939
11464
|
v1FindFocuserLimits(requestParameters = {}, options) {
|
|
10940
|
-
return localVarFp.v1FindFocuserLimits(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11465
|
+
return localVarFp.v1FindFocuserLimits(requestParameters.lineageId, requestParameters.id, options).then((request) => request(axios, basePath));
|
|
10941
11466
|
},
|
|
10942
11467
|
/**
|
|
10943
11468
|
* 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.
|
|
@@ -11268,6 +11793,24 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
11268
11793
|
v1GetNetworkInterfaces(requestParameters = {}, options) {
|
|
11269
11794
|
return localVarFp.v1GetNetworkInterfaces(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11270
11795
|
},
|
|
11796
|
+
/**
|
|
11797
|
+
* Retrieves one optical train configuration by label.
|
|
11798
|
+
* @param {DefaultApiV1GetOpticalTrainRequest} requestParameters Request parameters.
|
|
11799
|
+
* @param {*} [options] Override http request option.
|
|
11800
|
+
* @throws {RequiredError}
|
|
11801
|
+
*/
|
|
11802
|
+
v1GetOpticalTrain(requestParameters, options) {
|
|
11803
|
+
return localVarFp.v1GetOpticalTrain(requestParameters.label, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11804
|
+
},
|
|
11805
|
+
/**
|
|
11806
|
+
* Retrieves all configured optical trains and the optical train components assigned to each train.
|
|
11807
|
+
* @param {DefaultApiV1GetOpticalTrainsRequest} requestParameters Request parameters.
|
|
11808
|
+
* @param {*} [options] Override http request option.
|
|
11809
|
+
* @throws {RequiredError}
|
|
11810
|
+
*/
|
|
11811
|
+
v1GetOpticalTrains(requestParameters = {}, options) {
|
|
11812
|
+
return localVarFp.v1GetOpticalTrains(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11813
|
+
},
|
|
11271
11814
|
/**
|
|
11272
11815
|
* 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.
|
|
11273
11816
|
* @param {DefaultApiV1GetOpticalTubeCoverStatusRequest} requestParameters Request parameters.
|
|
@@ -11358,6 +11901,24 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
11358
11901
|
v1GetOpticalTubeStatuses(requestParameters = {}, options) {
|
|
11359
11902
|
return localVarFp.v1GetOpticalTubeStatuses(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11360
11903
|
},
|
|
11904
|
+
/**
|
|
11905
|
+
* Retrieves the current temperature sensor status for an optical tube assembly. Returns V1OpticalTubeTemperatureSensorGroupStatus containing the temperature reading from each sensor.
|
|
11906
|
+
* @param {DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusRequest} requestParameters Request parameters.
|
|
11907
|
+
* @param {*} [options] Override http request option.
|
|
11908
|
+
* @throws {RequiredError}
|
|
11909
|
+
*/
|
|
11910
|
+
v1GetOpticalTubeTemperatureSensorGroupStatus(requestParameters = {}, options) {
|
|
11911
|
+
return localVarFp.v1GetOpticalTubeTemperatureSensorGroupStatus(requestParameters.lineageId, requestParameters.id, options).then((request) => request(axios, basePath));
|
|
11912
|
+
},
|
|
11913
|
+
/**
|
|
11914
|
+
* 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.
|
|
11915
|
+
* @param {DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusesRequest} requestParameters Request parameters.
|
|
11916
|
+
* @param {*} [options] Override http request option.
|
|
11917
|
+
* @throws {RequiredError}
|
|
11918
|
+
*/
|
|
11919
|
+
v1GetOpticalTubeTemperatureSensorGroupStatuses(requestParameters = {}, options) {
|
|
11920
|
+
return localVarFp.v1GetOpticalTubeTemperatureSensorGroupStatuses(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11921
|
+
},
|
|
11361
11922
|
/**
|
|
11362
11923
|
* 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.
|
|
11363
11924
|
* @param {DefaultApiV1GetRelaysRequest} requestParameters Request parameters.
|
|
@@ -11470,7 +12031,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
11470
12031
|
return localVarFp.v1GetSystemMetricNames(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
11471
12032
|
},
|
|
11472
12033
|
/**
|
|
11473
|
-
* 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
|
|
12034
|
+
* 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.
|
|
11474
12035
|
* @param {DefaultApiV1GetSystemMetricsRequest} requestParameters Request parameters.
|
|
11475
12036
|
* @param {*} [options] Override http request option.
|
|
11476
12037
|
* @throws {RequiredError}
|
|
@@ -11479,7 +12040,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
11479
12040
|
return localVarFp.v1GetSystemMetrics(requestParameters.lineageId, requestParameters.metricName, requestParameters.after, requestParameters.before, options).then((request) => request(axios, basePath));
|
|
11480
12041
|
},
|
|
11481
12042
|
/**
|
|
11482
|
-
* 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
|
|
12043
|
+
* 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.
|
|
11483
12044
|
* @param {DefaultApiV1GetSystemMetricsCollectionsRequest} requestParameters Request parameters.
|
|
11484
12045
|
* @param {*} [options] Override http request option.
|
|
11485
12046
|
* @throws {RequiredError}
|
|
@@ -12224,6 +12785,15 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
12224
12785
|
v1UpdateImageProcessingPlugin(requestParameters, options) {
|
|
12225
12786
|
return localVarFp.v1UpdateImageProcessingPlugin(requestParameters.v1UpdateImageProcessingPluginRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
12226
12787
|
},
|
|
12788
|
+
/**
|
|
12789
|
+
* Updates an optical train configuration by replacing the component assignments for the provided label.
|
|
12790
|
+
* @param {DefaultApiV1UpdateOpticalTrainRequest} requestParameters Request parameters.
|
|
12791
|
+
* @param {*} [options] Override http request option.
|
|
12792
|
+
* @throws {RequiredError}
|
|
12793
|
+
*/
|
|
12794
|
+
v1UpdateOpticalTrain(requestParameters, options) {
|
|
12795
|
+
return localVarFp.v1UpdateOpticalTrain(requestParameters.v1UpdateOpticalTrainRequest, requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
12796
|
+
},
|
|
12227
12797
|
/**
|
|
12228
12798
|
* 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.
|
|
12229
12799
|
* @param {DefaultApiV1UpdateSystemSettingsRequest} requestParameters Request parameters.
|
|
@@ -12305,6 +12875,15 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
12305
12875
|
v2GetSystemEvents(requestParameters = {}, options) {
|
|
12306
12876
|
return localVarFp.v2GetSystemEvents(requestParameters.lineageId, requestParameters.type, requestParameters.before, requestParameters.limit, options).then((request) => request(axios, basePath));
|
|
12307
12877
|
},
|
|
12878
|
+
/**
|
|
12879
|
+
* 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.
|
|
12880
|
+
* @param {DefaultApiV2GetSystemStatusRequest} requestParameters Request parameters.
|
|
12881
|
+
* @param {*} [options] Override http request option.
|
|
12882
|
+
* @throws {RequiredError}
|
|
12883
|
+
*/
|
|
12884
|
+
v2GetSystemStatus(requestParameters = {}, options) {
|
|
12885
|
+
return localVarFp.v2GetSystemStatus(requestParameters.lineageId, options).then((request) => request(axios, basePath));
|
|
12886
|
+
},
|
|
12308
12887
|
/**
|
|
12309
12888
|
* 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.
|
|
12310
12889
|
* @param {DefaultApiV2TurnOffRelayRequest} requestParameters Request parameters.
|
|
@@ -12340,13 +12919,13 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
12340
12919
|
return (0, exports.DefaultApiFp)(this.configuration).v1AddMountModelPointHere(requestParameters.v1AddMountModelPointHereRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
12341
12920
|
}
|
|
12342
12921
|
/**
|
|
12343
|
-
* 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
|
|
12344
|
-
* @param {
|
|
12922
|
+
* 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.
|
|
12923
|
+
* @param {DefaultApiV1AddMountModelPointUsingImageRequest} requestParameters Request parameters.
|
|
12345
12924
|
* @param {*} [options] Override http request option.
|
|
12346
12925
|
* @throws {RequiredError}
|
|
12347
12926
|
*/
|
|
12348
|
-
|
|
12349
|
-
return (0, exports.DefaultApiFp)(this.configuration).
|
|
12927
|
+
v1AddMountModelPointUsingImage(requestParameters, options) {
|
|
12928
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1AddMountModelPointUsingImage(requestParameters.body, requestParameters.lineageId, requestParameters.motorAEncoderPositionDegrees, requestParameters.motorBEncoderPositionDegrees, requestParameters.timestamp, options).then((request) => request(this.axios, this.basePath));
|
|
12350
12929
|
}
|
|
12351
12930
|
/**
|
|
12352
12931
|
* Updates the current custom path tracking session by appending control points. The trackingSessionId and frame must match the current session.
|
|
@@ -12422,6 +13001,15 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
12422
13001
|
v1CaptureImagesContinuously(requestParameters, options) {
|
|
12423
13002
|
return (0, exports.DefaultApiFp)(this.configuration).v1CaptureImagesContinuously(requestParameters.v1CaptureImagesContinuouslyRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
12424
13003
|
}
|
|
13004
|
+
/**
|
|
13005
|
+
* 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.
|
|
13006
|
+
* @param {DefaultApiV1ClearEnclosureRotatorMotorLockoutRequest} requestParameters Request parameters.
|
|
13007
|
+
* @param {*} [options] Override http request option.
|
|
13008
|
+
* @throws {RequiredError}
|
|
13009
|
+
*/
|
|
13010
|
+
v1ClearEnclosureRotatorMotorLockout(requestParameters = {}, options) {
|
|
13011
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1ClearEnclosureRotatorMotorLockout(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13012
|
+
}
|
|
12425
13013
|
/**
|
|
12426
13014
|
* 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.
|
|
12427
13015
|
* @param {DefaultApiV1ClearMountModelRequest} requestParameters Request parameters.
|
|
@@ -12487,6 +13075,15 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
12487
13075
|
v1CreateMountModel(requestParameters, options) {
|
|
12488
13076
|
return (0, exports.DefaultApiFp)(this.configuration).v1CreateMountModel(requestParameters.v1CreateMountModelRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
12489
13077
|
}
|
|
13078
|
+
/**
|
|
13079
|
+
* Creates an optical train configuration by assigning optical train components to a human-readable label.
|
|
13080
|
+
* @param {DefaultApiV1CreateOpticalTrainRequest} requestParameters Request parameters.
|
|
13081
|
+
* @param {*} [options] Override http request option.
|
|
13082
|
+
* @throws {RequiredError}
|
|
13083
|
+
*/
|
|
13084
|
+
v1CreateOpticalTrain(requestParameters, options) {
|
|
13085
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1CreateOpticalTrain(requestParameters.v1CreateOpticalTrainRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13086
|
+
}
|
|
12490
13087
|
/**
|
|
12491
13088
|
* 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.
|
|
12492
13089
|
* @param {DefaultApiV1CycleRelaysRequest} requestParameters Request parameters.
|
|
@@ -12515,6 +13112,15 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
12515
13112
|
v1DeleteImageProcessingPlugin(requestParameters, options) {
|
|
12516
13113
|
return (0, exports.DefaultApiFp)(this.configuration).v1DeleteImageProcessingPlugin(requestParameters.v1GetImageProcessingPluginRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
12517
13114
|
}
|
|
13115
|
+
/**
|
|
13116
|
+
* Deletes one optical train configuration by label.
|
|
13117
|
+
* @param {DefaultApiV1DeleteOpticalTrainRequest} requestParameters Request parameters.
|
|
13118
|
+
* @param {*} [options] Override http request option.
|
|
13119
|
+
* @throws {RequiredError}
|
|
13120
|
+
*/
|
|
13121
|
+
v1DeleteOpticalTrain(requestParameters, options) {
|
|
13122
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1DeleteOpticalTrain(requestParameters.label, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13123
|
+
}
|
|
12518
13124
|
/**
|
|
12519
13125
|
* 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.
|
|
12520
13126
|
* @param {DefaultApiV1DeleteVideoRequest} requestParameters Request parameters.
|
|
@@ -12675,7 +13281,7 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
12675
13281
|
* @throws {RequiredError}
|
|
12676
13282
|
*/
|
|
12677
13283
|
v1FindFocuserLimits(requestParameters = {}, options) {
|
|
12678
|
-
return (0, exports.DefaultApiFp)(this.configuration).v1FindFocuserLimits(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13284
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1FindFocuserLimits(requestParameters.lineageId, requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
12679
13285
|
}
|
|
12680
13286
|
/**
|
|
12681
13287
|
* 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.
|
|
@@ -13006,6 +13612,24 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
13006
13612
|
v1GetNetworkInterfaces(requestParameters = {}, options) {
|
|
13007
13613
|
return (0, exports.DefaultApiFp)(this.configuration).v1GetNetworkInterfaces(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13008
13614
|
}
|
|
13615
|
+
/**
|
|
13616
|
+
* Retrieves one optical train configuration by label.
|
|
13617
|
+
* @param {DefaultApiV1GetOpticalTrainRequest} requestParameters Request parameters.
|
|
13618
|
+
* @param {*} [options] Override http request option.
|
|
13619
|
+
* @throws {RequiredError}
|
|
13620
|
+
*/
|
|
13621
|
+
v1GetOpticalTrain(requestParameters, options) {
|
|
13622
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetOpticalTrain(requestParameters.label, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13623
|
+
}
|
|
13624
|
+
/**
|
|
13625
|
+
* Retrieves all configured optical trains and the optical train components assigned to each train.
|
|
13626
|
+
* @param {DefaultApiV1GetOpticalTrainsRequest} requestParameters Request parameters.
|
|
13627
|
+
* @param {*} [options] Override http request option.
|
|
13628
|
+
* @throws {RequiredError}
|
|
13629
|
+
*/
|
|
13630
|
+
v1GetOpticalTrains(requestParameters = {}, options) {
|
|
13631
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetOpticalTrains(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13632
|
+
}
|
|
13009
13633
|
/**
|
|
13010
13634
|
* 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.
|
|
13011
13635
|
* @param {DefaultApiV1GetOpticalTubeCoverStatusRequest} requestParameters Request parameters.
|
|
@@ -13096,6 +13720,24 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
13096
13720
|
v1GetOpticalTubeStatuses(requestParameters = {}, options) {
|
|
13097
13721
|
return (0, exports.DefaultApiFp)(this.configuration).v1GetOpticalTubeStatuses(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13098
13722
|
}
|
|
13723
|
+
/**
|
|
13724
|
+
* Retrieves the current temperature sensor status for an optical tube assembly. Returns V1OpticalTubeTemperatureSensorGroupStatus containing the temperature reading from each sensor.
|
|
13725
|
+
* @param {DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusRequest} requestParameters Request parameters.
|
|
13726
|
+
* @param {*} [options] Override http request option.
|
|
13727
|
+
* @throws {RequiredError}
|
|
13728
|
+
*/
|
|
13729
|
+
v1GetOpticalTubeTemperatureSensorGroupStatus(requestParameters = {}, options) {
|
|
13730
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetOpticalTubeTemperatureSensorGroupStatus(requestParameters.lineageId, requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
13731
|
+
}
|
|
13732
|
+
/**
|
|
13733
|
+
* 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.
|
|
13734
|
+
* @param {DefaultApiV1GetOpticalTubeTemperatureSensorGroupStatusesRequest} requestParameters Request parameters.
|
|
13735
|
+
* @param {*} [options] Override http request option.
|
|
13736
|
+
* @throws {RequiredError}
|
|
13737
|
+
*/
|
|
13738
|
+
v1GetOpticalTubeTemperatureSensorGroupStatuses(requestParameters = {}, options) {
|
|
13739
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetOpticalTubeTemperatureSensorGroupStatuses(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13740
|
+
}
|
|
13099
13741
|
/**
|
|
13100
13742
|
* 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.
|
|
13101
13743
|
* @param {DefaultApiV1GetRelaysRequest} requestParameters Request parameters.
|
|
@@ -13208,7 +13850,7 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
13208
13850
|
return (0, exports.DefaultApiFp)(this.configuration).v1GetSystemMetricNames(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13209
13851
|
}
|
|
13210
13852
|
/**
|
|
13211
|
-
* 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
|
|
13853
|
+
* 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.
|
|
13212
13854
|
* @param {DefaultApiV1GetSystemMetricsRequest} requestParameters Request parameters.
|
|
13213
13855
|
* @param {*} [options] Override http request option.
|
|
13214
13856
|
* @throws {RequiredError}
|
|
@@ -13217,7 +13859,7 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
13217
13859
|
return (0, exports.DefaultApiFp)(this.configuration).v1GetSystemMetrics(requestParameters.lineageId, requestParameters.metricName, requestParameters.after, requestParameters.before, options).then((request) => request(this.axios, this.basePath));
|
|
13218
13860
|
}
|
|
13219
13861
|
/**
|
|
13220
|
-
* 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
|
|
13862
|
+
* 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.
|
|
13221
13863
|
* @param {DefaultApiV1GetSystemMetricsCollectionsRequest} requestParameters Request parameters.
|
|
13222
13864
|
* @param {*} [options] Override http request option.
|
|
13223
13865
|
* @throws {RequiredError}
|
|
@@ -13962,6 +14604,15 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
13962
14604
|
v1UpdateImageProcessingPlugin(requestParameters, options) {
|
|
13963
14605
|
return (0, exports.DefaultApiFp)(this.configuration).v1UpdateImageProcessingPlugin(requestParameters.v1UpdateImageProcessingPluginRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
13964
14606
|
}
|
|
14607
|
+
/**
|
|
14608
|
+
* Updates an optical train configuration by replacing the component assignments for the provided label.
|
|
14609
|
+
* @param {DefaultApiV1UpdateOpticalTrainRequest} requestParameters Request parameters.
|
|
14610
|
+
* @param {*} [options] Override http request option.
|
|
14611
|
+
* @throws {RequiredError}
|
|
14612
|
+
*/
|
|
14613
|
+
v1UpdateOpticalTrain(requestParameters, options) {
|
|
14614
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1UpdateOpticalTrain(requestParameters.v1UpdateOpticalTrainRequest, requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
14615
|
+
}
|
|
13965
14616
|
/**
|
|
13966
14617
|
* 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.
|
|
13967
14618
|
* @param {DefaultApiV1UpdateSystemSettingsRequest} requestParameters Request parameters.
|
|
@@ -14043,6 +14694,15 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
14043
14694
|
v2GetSystemEvents(requestParameters = {}, options) {
|
|
14044
14695
|
return (0, exports.DefaultApiFp)(this.configuration).v2GetSystemEvents(requestParameters.lineageId, requestParameters.type, requestParameters.before, requestParameters.limit, options).then((request) => request(this.axios, this.basePath));
|
|
14045
14696
|
}
|
|
14697
|
+
/**
|
|
14698
|
+
* 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.
|
|
14699
|
+
* @param {DefaultApiV2GetSystemStatusRequest} requestParameters Request parameters.
|
|
14700
|
+
* @param {*} [options] Override http request option.
|
|
14701
|
+
* @throws {RequiredError}
|
|
14702
|
+
*/
|
|
14703
|
+
v2GetSystemStatus(requestParameters = {}, options) {
|
|
14704
|
+
return (0, exports.DefaultApiFp)(this.configuration).v2GetSystemStatus(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
|
|
14705
|
+
}
|
|
14046
14706
|
/**
|
|
14047
14707
|
* 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.
|
|
14048
14708
|
* @param {DefaultApiV2TurnOffRelayRequest} requestParameters Request parameters.
|