@wandelbots/nova-api 26.6.0-dev.4 → 26.6.0-dev.41
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/dist/v1/index.cjs +1 -1
- package/dist/v1/index.d.cts +5 -5
- package/dist/v1/index.d.ts +5 -5
- package/dist/v1/index.js +1 -1
- package/dist/v2/index.cjs +271 -224
- package/dist/v2/index.d.cts +148 -32
- package/dist/v2/index.d.ts +148 -32
- package/dist/v2/index.js +60 -13
- package/package.json +1 -1
package/dist/v2/index.js
CHANGED
|
@@ -1304,7 +1304,7 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1304
1304
|
options: localVarRequestOptions
|
|
1305
1305
|
};
|
|
1306
1306
|
},
|
|
1307
|
-
getProfinetIOsFromFile: async (cell, inputOffset, outputOffset, options = {}) => {
|
|
1307
|
+
getProfinetIOsFromFile: async (cell, offsets, inputOffset, outputOffset, options = {}) => {
|
|
1308
1308
|
assertParamExists("getProfinetIOsFromFile", "cell", cell);
|
|
1309
1309
|
const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1310
1310
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1318,6 +1318,7 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1318
1318
|
const localVarHeaderParameter = {};
|
|
1319
1319
|
const localVarQueryParameter = {};
|
|
1320
1320
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1321
|
+
if (offsets) localVarQueryParameter["offsets"] = offsets.join(COLLECTION_FORMATS.csv);
|
|
1321
1322
|
if (inputOffset !== void 0) localVarQueryParameter["input_offset"] = inputOffset;
|
|
1322
1323
|
if (outputOffset !== void 0) localVarQueryParameter["output_offset"] = outputOffset;
|
|
1323
1324
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1598,8 +1599,8 @@ const BUSInputsOutputsApiFp = function(configuration) {
|
|
|
1598
1599
|
const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.getProfinetGSDML"]?.[localVarOperationServerIndex]?.url;
|
|
1599
1600
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1600
1601
|
},
|
|
1601
|
-
async getProfinetIOsFromFile(cell, inputOffset, outputOffset, options) {
|
|
1602
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options);
|
|
1602
|
+
async getProfinetIOsFromFile(cell, offsets, inputOffset, outputOffset, options) {
|
|
1603
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetIOsFromFile(cell, offsets, inputOffset, outputOffset, options);
|
|
1603
1604
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1604
1605
|
const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.getProfinetIOsFromFile"]?.[localVarOperationServerIndex]?.url;
|
|
1605
1606
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1696,8 +1697,8 @@ const BUSInputsOutputsApiFactory = function(configuration, basePath, axios) {
|
|
|
1696
1697
|
getProfinetGSDML(cell, options) {
|
|
1697
1698
|
return localVarFp.getProfinetGSDML(cell, options).then((request) => request(axios, basePath));
|
|
1698
1699
|
},
|
|
1699
|
-
getProfinetIOsFromFile(cell, inputOffset, outputOffset, options) {
|
|
1700
|
-
return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
|
|
1700
|
+
getProfinetIOsFromFile(cell, offsets, inputOffset, outputOffset, options) {
|
|
1701
|
+
return localVarFp.getProfinetIOsFromFile(cell, offsets, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
|
|
1701
1702
|
},
|
|
1702
1703
|
listBusIODescriptions(cell, options) {
|
|
1703
1704
|
return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
|
|
@@ -1897,16 +1898,17 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1897
1898
|
return BUSInputsOutputsApiFp(this.configuration).getProfinetGSDML(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1898
1899
|
}
|
|
1899
1900
|
/**
|
|
1900
|
-
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Get input/output variable configuration of the PROFINET device, e.g., NOVA\'s PROFINET service as file. You can specify byte offsets for
|
|
1901
|
+
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Get input/output variable configuration of the PROFINET device, e.g., NOVA\'s PROFINET service as file. You can specify per-slot byte offsets for input and output variable addresses to get an XML tag map that is ready for pasting to third party software, e.g., TIA portal. For backward compatibility, the legacy `input_offset` and `output_offset` query parameters remain available, but deprecated.
|
|
1901
1902
|
* @summary PROFINET Inputs/Outputs to File
|
|
1902
1903
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1904
|
+
* @param {Array<ProfinetSlotOffset>} [offsets] Per-slot offsets used to convert device-local byte addresses to controller byte addresses for export. If this parameter is provided, it is preferred over the deprecated `input_offset` and `output_offset` query parameters.
|
|
1903
1905
|
* @param {number} [inputOffset]
|
|
1904
1906
|
* @param {number} [outputOffset]
|
|
1905
1907
|
* @param {*} [options] Override http request option.
|
|
1906
1908
|
* @throws {RequiredError}
|
|
1907
1909
|
*/
|
|
1908
|
-
getProfinetIOsFromFile(cell, inputOffset, outputOffset, options) {
|
|
1909
|
-
return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
|
|
1910
|
+
getProfinetIOsFromFile(cell, offsets, inputOffset, outputOffset, options) {
|
|
1911
|
+
return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, offsets, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
|
|
1910
1912
|
}
|
|
1911
1913
|
/**
|
|
1912
1914
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ List all input/output descriptions for configured BUS services. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the BUS service.
|
|
@@ -2359,7 +2361,7 @@ var CellApi = class extends BaseAPI {
|
|
|
2359
2361
|
return CellApiFp(this.configuration).deployCell(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2360
2362
|
}
|
|
2361
2363
|
/**
|
|
2362
|
-
* **Required permissions:** `
|
|
2364
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ List all cell resources.
|
|
2363
2365
|
* @summary Configuration
|
|
2364
2366
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2365
2367
|
* @param {*} [options] Override http request option.
|
|
@@ -4208,7 +4210,7 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
4208
4210
|
copyMotionGroupModel: async (motionGroupModel, copyMotionGroupModelRequest, options = {}) => {
|
|
4209
4211
|
assertParamExists("copyMotionGroupModel", "motionGroupModel", motionGroupModel);
|
|
4210
4212
|
assertParamExists("copyMotionGroupModel", "copyMotionGroupModelRequest", copyMotionGroupModelRequest);
|
|
4211
|
-
const localVarPath = `/experimental/motion-group-models/{motion-group-model}`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4213
|
+
const localVarPath = `/experimental/motion-group-models/{motion-group-model}/archive`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4212
4214
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4213
4215
|
let baseOptions;
|
|
4214
4216
|
if (configuration) baseOptions = configuration.baseOptions;
|
|
@@ -4236,7 +4238,7 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
4236
4238
|
},
|
|
4237
4239
|
deleteExperimentalMotionGroupModel: async (motionGroupModel, options = {}) => {
|
|
4238
4240
|
assertParamExists("deleteExperimentalMotionGroupModel", "motionGroupModel", motionGroupModel);
|
|
4239
|
-
const localVarPath = `/experimental/motion-group-models/{motion-group-model}`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4241
|
+
const localVarPath = `/experimental/motion-group-models/{motion-group-model}/archive`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4240
4242
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4241
4243
|
let baseOptions;
|
|
4242
4244
|
if (configuration) baseOptions = configuration.baseOptions;
|
|
@@ -4262,7 +4264,33 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
4262
4264
|
},
|
|
4263
4265
|
exportMotionGroupModel: async (motionGroupModel, options = {}) => {
|
|
4264
4266
|
assertParamExists("exportMotionGroupModel", "motionGroupModel", motionGroupModel);
|
|
4265
|
-
const localVarPath = `/experimental/motion-group-models/{motion-group-model}`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4267
|
+
const localVarPath = `/experimental/motion-group-models/{motion-group-model}/archive`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4268
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4269
|
+
let baseOptions;
|
|
4270
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
4271
|
+
const localVarRequestOptions = {
|
|
4272
|
+
method: "GET",
|
|
4273
|
+
...baseOptions,
|
|
4274
|
+
...options
|
|
4275
|
+
};
|
|
4276
|
+
const localVarHeaderParameter = {};
|
|
4277
|
+
const localVarQueryParameter = {};
|
|
4278
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4279
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4280
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4281
|
+
localVarRequestOptions.headers = {
|
|
4282
|
+
...localVarHeaderParameter,
|
|
4283
|
+
...headersFromBaseOptions,
|
|
4284
|
+
...options.headers
|
|
4285
|
+
};
|
|
4286
|
+
return {
|
|
4287
|
+
url: toPathString(localVarUrlObj),
|
|
4288
|
+
options: localVarRequestOptions
|
|
4289
|
+
};
|
|
4290
|
+
},
|
|
4291
|
+
getConfigurationForMotionGroup: async (motionGroupModel, options = {}) => {
|
|
4292
|
+
assertParamExists("getConfigurationForMotionGroup", "motionGroupModel", motionGroupModel);
|
|
4293
|
+
const localVarPath = `/motion-group-models/{motion-group-model}/configuration`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4266
4294
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4267
4295
|
let baseOptions;
|
|
4268
4296
|
if (configuration) baseOptions = configuration.baseOptions;
|
|
@@ -4545,6 +4573,12 @@ const MotionGroupModelsApiFp = function(configuration) {
|
|
|
4545
4573
|
const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.exportMotionGroupModel"]?.[localVarOperationServerIndex]?.url;
|
|
4546
4574
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4547
4575
|
},
|
|
4576
|
+
async getConfigurationForMotionGroup(motionGroupModel, options) {
|
|
4577
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getConfigurationForMotionGroup(motionGroupModel, options);
|
|
4578
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4579
|
+
const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.getConfigurationForMotionGroup"]?.[localVarOperationServerIndex]?.url;
|
|
4580
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4581
|
+
},
|
|
4548
4582
|
async getMotionGroupCollisionModel(motionGroupModel, options) {
|
|
4549
4583
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupCollisionModel(motionGroupModel, options);
|
|
4550
4584
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -4616,6 +4650,9 @@ const MotionGroupModelsApiFactory = function(configuration, basePath, axios) {
|
|
|
4616
4650
|
exportMotionGroupModel(motionGroupModel, options) {
|
|
4617
4651
|
return localVarFp.exportMotionGroupModel(motionGroupModel, options).then((request) => request(axios, basePath));
|
|
4618
4652
|
},
|
|
4653
|
+
getConfigurationForMotionGroup(motionGroupModel, options) {
|
|
4654
|
+
return localVarFp.getConfigurationForMotionGroup(motionGroupModel, options).then((request) => request(axios, basePath));
|
|
4655
|
+
},
|
|
4619
4656
|
getMotionGroupCollisionModel(motionGroupModel, options) {
|
|
4620
4657
|
return localVarFp.getMotionGroupCollisionModel(motionGroupModel, options).then((request) => request(axios, basePath));
|
|
4621
4658
|
},
|
|
@@ -4661,7 +4698,7 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
4661
4698
|
return MotionGroupModelsApiFp(this.configuration).copyMotionGroupModel(motionGroupModel, copyMotionGroupModelRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4662
4699
|
}
|
|
4663
4700
|
/**
|
|
4664
|
-
* **Required permissions:** `can_access_system` - View system status and metadata ___ Deletes a custom motion group model. Only custom models
|
|
4701
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ Deletes a custom motion group model. Only custom models, where `is_custom` is `true`, can be deleted. Built-in base models cannot be removed.
|
|
4665
4702
|
* @summary Delete Motion Group Model
|
|
4666
4703
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
4667
4704
|
* @param {*} [options] Override http request option.
|
|
@@ -4681,6 +4718,16 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
4681
4718
|
return MotionGroupModelsApiFp(this.configuration).exportMotionGroupModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
4682
4719
|
}
|
|
4683
4720
|
/**
|
|
4721
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ Get a robot configuration containing the specified motion group model. This endpoint is designed for Virtual Robot to dynamically add motion groups by model name without needing to know the robot configuration name. Returns the full GCI transcript along with the motion group UID that corresponds to the requested motion group model.
|
|
4722
|
+
* @summary Get Configuration for Motion Group
|
|
4723
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
4724
|
+
* @param {*} [options] Override http request option.
|
|
4725
|
+
* @throws {RequiredError}
|
|
4726
|
+
*/
|
|
4727
|
+
getConfigurationForMotionGroup(motionGroupModel, options) {
|
|
4728
|
+
return MotionGroupModelsApiFp(this.configuration).getConfigurationForMotionGroup(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
4729
|
+
}
|
|
4730
|
+
/**
|
|
4684
4731
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
4685
4732
|
* @summary Get Collision Model
|
|
4686
4733
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|