@wandelbots/nova-api 26.3.0-dev.12 → 26.3.0-dev.13
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.d.cts +178 -178
- package/dist/v2/index.d.cts +146 -146
- package/package.json +1 -1
package/dist/v2/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as axios0 from "axios";
|
|
2
2
|
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
3
|
|
|
4
4
|
//#region v2/configuration.d.ts
|
|
@@ -3712,7 +3712,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3712
3712
|
* @param {*} [options] Override http request option.
|
|
3713
3713
|
* @throws {RequiredError}
|
|
3714
3714
|
*/
|
|
3715
|
-
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3715
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3716
3716
|
/**
|
|
3717
3717
|
* Delete all GUI applications from the cell.
|
|
3718
3718
|
* @summary Clear Applications
|
|
@@ -3721,7 +3721,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3721
3721
|
* @param {*} [options] Override http request option.
|
|
3722
3722
|
* @throws {RequiredError}
|
|
3723
3723
|
*/
|
|
3724
|
-
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3724
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3725
3725
|
/**
|
|
3726
3726
|
* Delete a GUI application from the cell.
|
|
3727
3727
|
* @summary Delete Application
|
|
@@ -3731,7 +3731,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3731
3731
|
* @param {*} [options] Override http request option.
|
|
3732
3732
|
* @throws {RequiredError}
|
|
3733
3733
|
*/
|
|
3734
|
-
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3734
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3735
3735
|
/**
|
|
3736
3736
|
* Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](#/operations/updateApp).
|
|
3737
3737
|
* @summary Configuration
|
|
@@ -3740,7 +3740,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3740
3740
|
* @param {*} [options] Override http request option.
|
|
3741
3741
|
* @throws {RequiredError}
|
|
3742
3742
|
*/
|
|
3743
|
-
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<
|
|
3743
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
|
|
3744
3744
|
/**
|
|
3745
3745
|
* List all GUI applications that have been added to a cell with [addApp](#/operations/addApp). If the cell does not contain GUI applications, the list is returned empty.
|
|
3746
3746
|
* @summary List Applications
|
|
@@ -3748,7 +3748,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3748
3748
|
* @param {*} [options] Override http request option.
|
|
3749
3749
|
* @throws {RequiredError}
|
|
3750
3750
|
*/
|
|
3751
|
-
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
3751
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
3752
3752
|
/**
|
|
3753
3753
|
* Update the configuration of a GUI application in the cell.
|
|
3754
3754
|
* @summary Update Configuration
|
|
@@ -3759,7 +3759,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3759
3759
|
* @param {*} [options] Override http request option.
|
|
3760
3760
|
* @throws {RequiredError}
|
|
3761
3761
|
*/
|
|
3762
|
-
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3762
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3763
3763
|
}
|
|
3764
3764
|
/**
|
|
3765
3765
|
* BUSInputsOutputsApi - axios parameter creator
|
|
@@ -4263,7 +4263,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4263
4263
|
* @param {*} [options] Override http request option.
|
|
4264
4264
|
* @throws {RequiredError}
|
|
4265
4265
|
*/
|
|
4266
|
-
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4266
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4267
4267
|
/**
|
|
4268
4268
|
* Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](#/operations/listModbusIOs).
|
|
4269
4269
|
* @summary Add MODBUS Input/Output
|
|
@@ -4273,7 +4273,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4273
4273
|
* @param {*} [options] Override http request option.
|
|
4274
4274
|
* @throws {RequiredError}
|
|
4275
4275
|
*/
|
|
4276
|
-
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<
|
|
4276
|
+
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4277
4277
|
/**
|
|
4278
4278
|
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
|
|
4279
4279
|
* @summary Add PROFINET Input/Output
|
|
@@ -4283,7 +4283,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4283
4283
|
* @param {*} [options] Override http request option.
|
|
4284
4284
|
* @throws {RequiredError}
|
|
4285
4285
|
*/
|
|
4286
|
-
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<
|
|
4286
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4287
4287
|
/**
|
|
4288
4288
|
* Remove the BUS inputs/outputs service from the cell.
|
|
4289
4289
|
* @summary Clear Service
|
|
@@ -4292,7 +4292,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4292
4292
|
* @param {*} [options] Override http request option.
|
|
4293
4293
|
* @throws {RequiredError}
|
|
4294
4294
|
*/
|
|
4295
|
-
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4295
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4296
4296
|
/**
|
|
4297
4297
|
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4298
4298
|
* @summary Remove all MODBUS Input/Outputs
|
|
@@ -4300,7 +4300,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4300
4300
|
* @param {*} [options] Override http request option.
|
|
4301
4301
|
* @throws {RequiredError}
|
|
4302
4302
|
*/
|
|
4303
|
-
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4303
|
+
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4304
4304
|
/**
|
|
4305
4305
|
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
4306
4306
|
* @summary Remove all PROFINET Input/Outputs
|
|
@@ -4308,7 +4308,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4308
4308
|
* @param {*} [options] Override http request option.
|
|
4309
4309
|
* @throws {RequiredError}
|
|
4310
4310
|
*/
|
|
4311
|
-
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4311
|
+
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4312
4312
|
/**
|
|
4313
4313
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4314
4314
|
* @summary Remove MODBUS Input/Output
|
|
@@ -4317,7 +4317,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4317
4317
|
* @param {*} [options] Override http request option.
|
|
4318
4318
|
* @throws {RequiredError}
|
|
4319
4319
|
*/
|
|
4320
|
-
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
4320
|
+
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4321
4321
|
/**
|
|
4322
4322
|
* Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
4323
4323
|
* @summary Remove PROFINET Input/Ouptut
|
|
@@ -4326,7 +4326,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4326
4326
|
* @param {*} [options] Override http request option.
|
|
4327
4327
|
* @throws {RequiredError}
|
|
4328
4328
|
*/
|
|
4329
|
-
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
4329
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4330
4330
|
/**
|
|
4331
4331
|
* Get deployed BUS inputs/outputs service.
|
|
4332
4332
|
* @summary Get Service
|
|
@@ -4334,7 +4334,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4334
4334
|
* @param {*} [options] Override http request option.
|
|
4335
4335
|
* @throws {RequiredError}
|
|
4336
4336
|
*/
|
|
4337
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4337
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOType, any>>;
|
|
4338
4338
|
/**
|
|
4339
4339
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
4340
4340
|
* @summary State
|
|
@@ -4342,7 +4342,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4342
4342
|
* @param {*} [options] Override http request option.
|
|
4343
4343
|
* @throws {RequiredError}
|
|
4344
4344
|
*/
|
|
4345
|
-
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4345
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOsState, any>>;
|
|
4346
4346
|
/**
|
|
4347
4347
|
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](#/operations/listBusIODescriptions).
|
|
4348
4348
|
* @summary Get Input/Output Values
|
|
@@ -4351,7 +4351,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4351
4351
|
* @param {*} [options] Override http request option.
|
|
4352
4352
|
* @throws {RequiredError}
|
|
4353
4353
|
*/
|
|
4354
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
4354
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
4355
4355
|
/**
|
|
4356
4356
|
* Get description of NOVA as a PROFINET device.
|
|
4357
4357
|
* @summary Get PROFINET Description
|
|
@@ -4359,7 +4359,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4359
4359
|
* @param {*} [options] Override http request option.
|
|
4360
4360
|
* @throws {RequiredError}
|
|
4361
4361
|
*/
|
|
4362
|
-
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4362
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetDescription, any>>;
|
|
4363
4363
|
/**
|
|
4364
4364
|
* Get input/output variable configuration of the PROFINET device, e.g., NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g., TIA portal.
|
|
4365
4365
|
* @summary PROFINET Inputs/Outputs to File
|
|
@@ -4369,7 +4369,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4369
4369
|
* @param {*} [options] Override http request option.
|
|
4370
4370
|
* @throws {RequiredError}
|
|
4371
4371
|
*/
|
|
4372
|
-
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4372
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
4373
4373
|
/**
|
|
4374
4374
|
* 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.
|
|
4375
4375
|
* @summary List Descriptions
|
|
@@ -4377,7 +4377,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4377
4377
|
* @param {*} [options] Override http request option.
|
|
4378
4378
|
* @throws {RequiredError}
|
|
4379
4379
|
*/
|
|
4380
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4380
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIODescription[], any>>;
|
|
4381
4381
|
/**
|
|
4382
4382
|
* List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type, and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller, as well as NOVA\'s MODBUS service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](#/operations/addModbusIO).
|
|
4383
4383
|
* @summary List MODBUS Input/Output Configuration
|
|
@@ -4385,7 +4385,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4385
4385
|
* @param {*} [options] Override http request option.
|
|
4386
4386
|
* @throws {RequiredError}
|
|
4387
4387
|
*/
|
|
4388
|
-
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4388
|
+
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ModbusIO[], any>>;
|
|
4389
4389
|
/**
|
|
4390
4390
|
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type, and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](#/operations/addProfinetIO) and [setProfinetIOsFromFile](#/operations/setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
|
|
4391
4391
|
* @summary List PROFINET Input/Output Configuration
|
|
@@ -4393,7 +4393,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4393
4393
|
* @param {*} [options] Override http request option.
|
|
4394
4394
|
* @throws {RequiredError}
|
|
4395
4395
|
*/
|
|
4396
|
-
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4396
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetIO[], any>>;
|
|
4397
4397
|
/**
|
|
4398
4398
|
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](#/operations/listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
4399
4399
|
* @summary Set Output Values
|
|
@@ -4402,7 +4402,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4402
4402
|
* @param {*} [options] Override http request option.
|
|
4403
4403
|
* @throws {RequiredError}
|
|
4404
4404
|
*/
|
|
4405
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
4405
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4406
4406
|
/**
|
|
4407
4407
|
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as an XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
4408
4408
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
@@ -4411,7 +4411,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4411
4411
|
* @param {*} [options] Override http request option.
|
|
4412
4412
|
* @throws {RequiredError}
|
|
4413
4413
|
*/
|
|
4414
|
-
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<
|
|
4414
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4415
4415
|
}
|
|
4416
4416
|
/**
|
|
4417
4417
|
* CellApi - axios parameter creator
|
|
@@ -4674,7 +4674,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4674
4674
|
* @param {*} [options] Override http request option.
|
|
4675
4675
|
* @throws {RequiredError}
|
|
4676
4676
|
*/
|
|
4677
|
-
checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
4677
|
+
checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
4678
4678
|
/**
|
|
4679
4679
|
* Delete an entire cell.
|
|
4680
4680
|
* @summary Delete Cell
|
|
@@ -4683,7 +4683,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4683
4683
|
* @param {*} [options] Override http request option.
|
|
4684
4684
|
* @throws {RequiredError}
|
|
4685
4685
|
*/
|
|
4686
|
-
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4686
|
+
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4687
4687
|
/**
|
|
4688
4688
|
* Deploy an entire cell with all its resources. A cell can be used to deploy a robot controller, one or more robots, as well as custom applications. Refer to the [Wandelbots NOVA documentation](https://docs.wandelbots.io/latest/setup-cell) for more information.
|
|
4689
4689
|
* @summary Add Cell
|
|
@@ -4692,7 +4692,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4692
4692
|
* @param {*} [options] Override http request option.
|
|
4693
4693
|
* @throws {RequiredError}
|
|
4694
4694
|
*/
|
|
4695
|
-
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4695
|
+
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4696
4696
|
/**
|
|
4697
4697
|
* List all cell resources.
|
|
4698
4698
|
* @summary Configuration
|
|
@@ -4700,7 +4700,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4700
4700
|
* @param {*} [options] Override http request option.
|
|
4701
4701
|
* @throws {RequiredError}
|
|
4702
4702
|
*/
|
|
4703
|
-
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4703
|
+
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Cell, any>>;
|
|
4704
4704
|
/**
|
|
4705
4705
|
* List the status of all cell resources.
|
|
4706
4706
|
* @summary Service Status
|
|
@@ -4708,14 +4708,14 @@ declare class CellApi extends BaseAPI {
|
|
|
4708
4708
|
* @param {*} [options] Override http request option.
|
|
4709
4709
|
* @throws {RequiredError}
|
|
4710
4710
|
*/
|
|
4711
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4711
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatusResponse, any>>;
|
|
4712
4712
|
/**
|
|
4713
4713
|
* List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
4714
4714
|
* @summary List Cells
|
|
4715
4715
|
* @param {*} [options] Override http request option.
|
|
4716
4716
|
* @throws {RequiredError}
|
|
4717
4717
|
*/
|
|
4718
|
-
listCells(options?: RawAxiosRequestConfig): Promise<
|
|
4718
|
+
listCells(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
4719
4719
|
/**
|
|
4720
4720
|
* Deactivate or activate the services of a cell.
|
|
4721
4721
|
* @summary Operating State
|
|
@@ -4724,7 +4724,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4724
4724
|
* @param {*} [options] Override http request option.
|
|
4725
4725
|
* @throws {RequiredError}
|
|
4726
4726
|
*/
|
|
4727
|
-
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<
|
|
4727
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4728
4728
|
/**
|
|
4729
4729
|
* Update the definition of the entire Cell.
|
|
4730
4730
|
* @summary Update Configuration
|
|
@@ -4734,7 +4734,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4734
4734
|
* @param {*} [options] Override http request option.
|
|
4735
4735
|
* @throws {RequiredError}
|
|
4736
4736
|
*/
|
|
4737
|
-
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4737
|
+
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4738
4738
|
/**
|
|
4739
4739
|
* Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
|
|
4740
4740
|
* @summary Update Cell Version
|
|
@@ -4743,7 +4743,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4743
4743
|
* @param {*} [options] Override http request option.
|
|
4744
4744
|
* @throws {RequiredError}
|
|
4745
4745
|
*/
|
|
4746
|
-
updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
4746
|
+
updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4747
4747
|
}
|
|
4748
4748
|
/**
|
|
4749
4749
|
* ControllerApi - axios parameter creator
|
|
@@ -5181,7 +5181,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5181
5181
|
* @param {*} [options] Override http request option.
|
|
5182
5182
|
* @throws {RequiredError}
|
|
5183
5183
|
*/
|
|
5184
|
-
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5184
|
+
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5185
5185
|
/**
|
|
5186
5186
|
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
5187
5187
|
* @summary Clear Robot Controllers
|
|
@@ -5190,7 +5190,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5190
5190
|
* @param {*} [options] Override http request option.
|
|
5191
5191
|
* @throws {RequiredError}
|
|
5192
5192
|
*/
|
|
5193
|
-
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5193
|
+
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5194
5194
|
/**
|
|
5195
5195
|
* Delete a robot controller from the cell.
|
|
5196
5196
|
* @summary Delete Robot Controller
|
|
@@ -5200,7 +5200,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5200
5200
|
* @param {*} [options] Override http request option.
|
|
5201
5201
|
* @throws {RequiredError}
|
|
5202
5202
|
*/
|
|
5203
|
-
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5203
|
+
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5204
5204
|
/**
|
|
5205
5205
|
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](#/operations/getMotionGroupDescription) to get more information about the motion group.
|
|
5206
5206
|
* @summary Description
|
|
@@ -5209,7 +5209,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5209
5209
|
* @param {*} [options] Override http request option.
|
|
5210
5210
|
* @throws {RequiredError}
|
|
5211
5211
|
*/
|
|
5212
|
-
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
5212
|
+
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ControllerDescription, any>>;
|
|
5213
5213
|
/**
|
|
5214
5214
|
* Request a coordinate system specification for a given identifier. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with `On` + the unique identifier of the robot controller.
|
|
5215
5215
|
* @summary Coordinate System
|
|
@@ -5220,7 +5220,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5220
5220
|
* @param {*} [options] Override http request option.
|
|
5221
5221
|
* @throws {RequiredError}
|
|
5222
5222
|
*/
|
|
5223
|
-
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
5223
|
+
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
5224
5224
|
/**
|
|
5225
5225
|
* Get the current state of a robot controller.
|
|
5226
5226
|
* @summary State
|
|
@@ -5229,7 +5229,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5229
5229
|
* @param {*} [options] Override http request option.
|
|
5230
5230
|
* @throws {RequiredError}
|
|
5231
5231
|
*/
|
|
5232
|
-
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
5232
|
+
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
5233
5233
|
/**
|
|
5234
5234
|
* Get the configuration for a robot controller.
|
|
5235
5235
|
* @summary Robot Controller
|
|
@@ -5238,7 +5238,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5238
5238
|
* @param {*} [options] Override http request option.
|
|
5239
5239
|
* @throws {RequiredError}
|
|
5240
5240
|
*/
|
|
5241
|
-
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
5241
|
+
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
|
|
5242
5242
|
/**
|
|
5243
5243
|
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](#/operations/addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration, which is not required when providing a complete configuration.
|
|
5244
5244
|
* @summary Virtual Controller Configuration
|
|
@@ -5247,7 +5247,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5247
5247
|
* @param {*} [options] Override http request option.
|
|
5248
5248
|
* @throws {RequiredError}
|
|
5249
5249
|
*/
|
|
5250
|
-
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
5250
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
5251
5251
|
/**
|
|
5252
5252
|
* Lists all specifications of coordinate systems from robot controllers. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with `On` + the unique identifier of the robot controller.
|
|
5253
5253
|
* @summary List Coordinate Systems
|
|
@@ -5257,7 +5257,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5257
5257
|
* @param {*} [options] Override http request option.
|
|
5258
5258
|
* @throws {RequiredError}
|
|
5259
5259
|
*/
|
|
5260
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
5260
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
5261
5261
|
/**
|
|
5262
5262
|
* List the names of all deployed robot controllers.
|
|
5263
5263
|
* @summary List Robot Controllers
|
|
@@ -5265,7 +5265,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5265
5265
|
* @param {*} [options] Override http request option.
|
|
5266
5266
|
* @throws {RequiredError}
|
|
5267
5267
|
*/
|
|
5268
|
-
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5268
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
5269
5269
|
/**
|
|
5270
5270
|
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state `normal` or `reduced`. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](#/operations/getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
5271
5271
|
* @summary Set Default Mode
|
|
@@ -5275,7 +5275,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5275
5275
|
* @param {*} [options] Override http request option.
|
|
5276
5276
|
* @throws {RequiredError}
|
|
5277
5277
|
*/
|
|
5278
|
-
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<
|
|
5278
|
+
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5279
5279
|
/**
|
|
5280
5280
|
* <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](#/operations/listRobotControllers) to check if the robot controller supports free drive mode.
|
|
5281
5281
|
* @summary Stream Free Drive
|
|
@@ -5285,7 +5285,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5285
5285
|
* @param {*} [options] Override http request option.
|
|
5286
5286
|
* @throws {RequiredError}
|
|
5287
5287
|
*/
|
|
5288
|
-
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5288
|
+
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
5289
5289
|
/**
|
|
5290
5290
|
* <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](#/operations/addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
5291
5291
|
* @summary Stream State
|
|
@@ -5296,7 +5296,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5296
5296
|
* @param {*} [options] Override http request option.
|
|
5297
5297
|
* @throws {RequiredError}
|
|
5298
5298
|
*/
|
|
5299
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5299
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
5300
5300
|
/**
|
|
5301
5301
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](#/operations/getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](#/operations/deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](#/operations/addRobotController).
|
|
5302
5302
|
* @summary Update Robot Controller
|
|
@@ -5307,7 +5307,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5307
5307
|
* @param {*} [options] Override http request option.
|
|
5308
5308
|
* @throws {RequiredError}
|
|
5309
5309
|
*/
|
|
5310
|
-
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5310
|
+
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5311
5311
|
}
|
|
5312
5312
|
/**
|
|
5313
5313
|
* ControllerInputsOutputsApi - axios parameter creator
|
|
@@ -5499,7 +5499,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5499
5499
|
* @param {*} [options] Override http request option.
|
|
5500
5500
|
* @throws {RequiredError}
|
|
5501
5501
|
*/
|
|
5502
|
-
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5502
|
+
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
5503
5503
|
/**
|
|
5504
5504
|
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](#/operations/listIODescriptions).
|
|
5505
5505
|
* @summary Get Input/Output Values
|
|
@@ -5509,7 +5509,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5509
5509
|
* @param {*} [options] Override http request option.
|
|
5510
5510
|
* @throws {RequiredError}
|
|
5511
5511
|
*/
|
|
5512
|
-
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5512
|
+
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
5513
5513
|
/**
|
|
5514
5514
|
* Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](#/operations/listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
|
|
5515
5515
|
* @summary Set Output Values
|
|
@@ -5519,7 +5519,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5519
5519
|
* @param {*} [options] Override http request option.
|
|
5520
5520
|
* @throws {RequiredError}
|
|
5521
5521
|
*/
|
|
5522
|
-
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
5522
|
+
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5523
5523
|
/**
|
|
5524
5524
|
* <!-- theme: success --> > Websocket endpoint Continuously receive updates of input/output values via websocket. Updates are sent in the update rate of the controller. > **NOTE** > > If you request many values simultaneously, the request is likely to fail. The amount of values that can be streamed simultaneously depends on the specific robot controller. > **NOTE** > > The inputs and outputs are sent in the update rate of the controller to prevent losing any values. This can lead to a high amount of data transmitted.
|
|
5525
5525
|
* @summary Stream Input/Output Values
|
|
@@ -5529,7 +5529,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5529
5529
|
* @param {*} [options] Override http request option.
|
|
5530
5530
|
* @throws {RequiredError}
|
|
5531
5531
|
*/
|
|
5532
|
-
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5532
|
+
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamIOValuesResponse, any>>;
|
|
5533
5533
|
/**
|
|
5534
5534
|
* Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](#/operations/listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
|
|
5535
5535
|
* @summary Wait For
|
|
@@ -5539,7 +5539,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5539
5539
|
* @param {*} [options] Override http request option.
|
|
5540
5540
|
* @throws {RequiredError}
|
|
5541
5541
|
*/
|
|
5542
|
-
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5542
|
+
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<boolean, any>>;
|
|
5543
5543
|
}
|
|
5544
5544
|
/**
|
|
5545
5545
|
* JoggingApi - axios parameter creator
|
|
@@ -5599,7 +5599,7 @@ declare class JoggingApi extends BaseAPI {
|
|
|
5599
5599
|
* @param {*} [options] Override http request option.
|
|
5600
5600
|
* @throws {RequiredError}
|
|
5601
5601
|
*/
|
|
5602
|
-
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5602
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteJoggingResponse, any>>;
|
|
5603
5603
|
}
|
|
5604
5604
|
/**
|
|
5605
5605
|
* KinematicsApi - axios parameter creator
|
|
@@ -5682,7 +5682,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
5682
5682
|
* @param {*} [options] Override http request option.
|
|
5683
5683
|
* @throws {RequiredError}
|
|
5684
5684
|
*/
|
|
5685
|
-
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5685
|
+
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ForwardKinematicsResponse, any>>;
|
|
5686
5686
|
/**
|
|
5687
5687
|
* Returns the reachable joint positions for a list of given poses.
|
|
5688
5688
|
* @summary Inverse kinematics
|
|
@@ -5691,7 +5691,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
5691
5691
|
* @param {*} [options] Override http request option.
|
|
5692
5692
|
* @throws {RequiredError}
|
|
5693
5693
|
*/
|
|
5694
|
-
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5694
|
+
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<InverseKinematicsResponse, any>>;
|
|
5695
5695
|
}
|
|
5696
5696
|
/**
|
|
5697
5697
|
* LicenseApi - axios parameter creator
|
|
@@ -5806,28 +5806,28 @@ declare class LicenseApi extends BaseAPI {
|
|
|
5806
5806
|
* @param {*} [options] Override http request option.
|
|
5807
5807
|
* @throws {RequiredError}
|
|
5808
5808
|
*/
|
|
5809
|
-
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5809
|
+
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
5810
5810
|
/**
|
|
5811
5811
|
* Deactivates active license.
|
|
5812
5812
|
* @summary Deactivate license
|
|
5813
5813
|
* @param {*} [options] Override http request option.
|
|
5814
5814
|
* @throws {RequiredError}
|
|
5815
5815
|
*/
|
|
5816
|
-
deactivateLicense(options?: RawAxiosRequestConfig): Promise<
|
|
5816
|
+
deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5817
5817
|
/**
|
|
5818
5818
|
* Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
|
|
5819
5819
|
* @summary Get license
|
|
5820
5820
|
* @param {*} [options] Override http request option.
|
|
5821
5821
|
* @throws {RequiredError}
|
|
5822
5822
|
*/
|
|
5823
|
-
getLicense(options?: RawAxiosRequestConfig): Promise<
|
|
5823
|
+
getLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
5824
5824
|
/**
|
|
5825
5825
|
* Get the license status. - If `valid`, Wandelbots NOVA can be used. - If `expired`, the license has to be renewed in order to use Wandelbots NOVA.
|
|
5826
5826
|
* @summary Get license status
|
|
5827
5827
|
* @param {*} [options] Override http request option.
|
|
5828
5828
|
* @throws {RequiredError}
|
|
5829
5829
|
*/
|
|
5830
|
-
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<
|
|
5830
|
+
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<LicenseStatus, any>>;
|
|
5831
5831
|
}
|
|
5832
5832
|
/**
|
|
5833
5833
|
* MotionGroupApi - axios parameter creator
|
|
@@ -5957,7 +5957,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5957
5957
|
* @param {*} [options] Override http request option.
|
|
5958
5958
|
* @throws {RequiredError}
|
|
5959
5959
|
*/
|
|
5960
|
-
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5960
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
5961
5961
|
/**
|
|
5962
5962
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data can change upon connection to the robot.
|
|
5963
5963
|
* @summary Description
|
|
@@ -5967,7 +5967,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5967
5967
|
* @param {*} [options] Override http request option.
|
|
5968
5968
|
* @throws {RequiredError}
|
|
5969
5969
|
*/
|
|
5970
|
-
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
5970
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupDescription, any>>;
|
|
5971
5971
|
/**
|
|
5972
5972
|
* <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
5973
5973
|
* @summary Stream State
|
|
@@ -5979,7 +5979,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5979
5979
|
* @param {*} [options] Override http request option.
|
|
5980
5980
|
* @throws {RequiredError}
|
|
5981
5981
|
*/
|
|
5982
|
-
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5982
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
5983
5983
|
}
|
|
5984
5984
|
/**
|
|
5985
5985
|
* MotionGroupModelsApi - axios parameter creator
|
|
@@ -6128,7 +6128,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
6128
6128
|
* @param {*} [options] Override http request option.
|
|
6129
6129
|
* @throws {RequiredError}
|
|
6130
6130
|
*/
|
|
6131
|
-
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
6131
|
+
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6132
6132
|
[key: string]: Collider;
|
|
6133
6133
|
}[], any>>;
|
|
6134
6134
|
/**
|
|
@@ -6138,7 +6138,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
6138
6138
|
* @param {*} [options] Override http request option.
|
|
6139
6139
|
* @throws {RequiredError}
|
|
6140
6140
|
*/
|
|
6141
|
-
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
6141
|
+
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
6142
6142
|
/**
|
|
6143
6143
|
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
6144
6144
|
* @summary Get Kinematics
|
|
@@ -6146,14 +6146,14 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
6146
6146
|
* @param {*} [options] Override http request option.
|
|
6147
6147
|
* @throws {RequiredError}
|
|
6148
6148
|
*/
|
|
6149
|
-
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
6149
|
+
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<KinematicModel, any>>;
|
|
6150
6150
|
/**
|
|
6151
6151
|
* Returns the list of supported motion group models.
|
|
6152
6152
|
* @summary Motion Group Models
|
|
6153
6153
|
* @param {*} [options] Override http request option.
|
|
6154
6154
|
* @throws {RequiredError}
|
|
6155
6155
|
*/
|
|
6156
|
-
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<
|
|
6156
|
+
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6157
6157
|
/**
|
|
6158
6158
|
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
6159
6159
|
* @summary Download USD Model
|
|
@@ -6161,7 +6161,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
6161
6161
|
* @param {*} [options] Override http request option.
|
|
6162
6162
|
* @throws {RequiredError}
|
|
6163
6163
|
*/
|
|
6164
|
-
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
6164
|
+
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
6165
6165
|
}
|
|
6166
6166
|
/**
|
|
6167
6167
|
* ProgramApi - axios parameter creator
|
|
@@ -6298,7 +6298,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6298
6298
|
* @param {*} [options] Override http request option.
|
|
6299
6299
|
* @throws {RequiredError}
|
|
6300
6300
|
*/
|
|
6301
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
6301
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program, any>>;
|
|
6302
6302
|
/**
|
|
6303
6303
|
* <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
6304
6304
|
* @summary List programs
|
|
@@ -6306,7 +6306,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6306
6306
|
* @param {*} [options] Override http request option.
|
|
6307
6307
|
* @throws {RequiredError}
|
|
6308
6308
|
*/
|
|
6309
|
-
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6309
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program[], any>>;
|
|
6310
6310
|
/**
|
|
6311
6311
|
* <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
6312
6312
|
* @summary Start the program
|
|
@@ -6316,7 +6316,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6316
6316
|
* @param {*} [options] Override http request option.
|
|
6317
6317
|
* @throws {RequiredError}
|
|
6318
6318
|
*/
|
|
6319
|
-
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6319
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
|
|
6320
6320
|
/**
|
|
6321
6321
|
* <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
6322
6322
|
* @summary Stop program run
|
|
@@ -6325,7 +6325,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6325
6325
|
* @param {*} [options] Override http request option.
|
|
6326
6326
|
* @throws {RequiredError}
|
|
6327
6327
|
*/
|
|
6328
|
-
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
6328
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6329
6329
|
}
|
|
6330
6330
|
/**
|
|
6331
6331
|
* RobotConfigurationsApi - axios parameter creator
|
|
@@ -6398,14 +6398,14 @@ declare class RobotConfigurationsApi extends BaseAPI {
|
|
|
6398
6398
|
* @param {*} [options] Override http request option.
|
|
6399
6399
|
* @throws {RequiredError}
|
|
6400
6400
|
*/
|
|
6401
|
-
getControllerConfigFromArpScan(robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6401
|
+
getControllerConfigFromArpScan(robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController[], any>>;
|
|
6402
6402
|
/**
|
|
6403
6403
|
* Returns the identifiers of available robot configurations. A robot configuration represents a robot controller with one or more attached motion groups.
|
|
6404
6404
|
* @summary List Robot Configurations
|
|
6405
6405
|
* @param {*} [options] Override http request option.
|
|
6406
6406
|
* @throws {RequiredError}
|
|
6407
6407
|
*/
|
|
6408
|
-
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<
|
|
6408
|
+
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6409
6409
|
}
|
|
6410
6410
|
/**
|
|
6411
6411
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
@@ -6878,7 +6878,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6878
6878
|
* @param {*} [options] Override http request option.
|
|
6879
6879
|
* @throws {RequiredError}
|
|
6880
6880
|
*/
|
|
6881
|
-
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
6881
|
+
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6882
6882
|
/**
|
|
6883
6883
|
* Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6884
6884
|
* @summary Delete Link Chain
|
|
@@ -6887,7 +6887,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6887
6887
|
* @param {*} [options] Override http request option.
|
|
6888
6888
|
* @throws {RequiredError}
|
|
6889
6889
|
*/
|
|
6890
|
-
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
6890
|
+
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6891
6891
|
/**
|
|
6892
6892
|
* Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6893
6893
|
* @summary Delete Tool
|
|
@@ -6896,7 +6896,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6896
6896
|
* @param {*} [options] Override http request option.
|
|
6897
6897
|
* @throws {RequiredError}
|
|
6898
6898
|
*/
|
|
6899
|
-
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
6899
|
+
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6900
6900
|
/**
|
|
6901
6901
|
* Returns the collider.
|
|
6902
6902
|
* @summary Get Collider
|
|
@@ -6905,7 +6905,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6905
6905
|
* @param {*} [options] Override http request option.
|
|
6906
6906
|
* @throws {RequiredError}
|
|
6907
6907
|
*/
|
|
6908
|
-
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
6908
|
+
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
6909
6909
|
/**
|
|
6910
6910
|
* Returns the collision link chain.
|
|
6911
6911
|
* @summary Get Link Chain
|
|
@@ -6914,7 +6914,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6914
6914
|
* @param {*} [options] Override http request option.
|
|
6915
6915
|
* @throws {RequiredError}
|
|
6916
6916
|
*/
|
|
6917
|
-
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
6917
|
+
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6918
6918
|
[key: string]: Collider;
|
|
6919
6919
|
}[], any>>;
|
|
6920
6920
|
/**
|
|
@@ -6925,7 +6925,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6925
6925
|
* @param {*} [options] Override http request option.
|
|
6926
6926
|
* @throws {RequiredError}
|
|
6927
6927
|
*/
|
|
6928
|
-
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
6928
|
+
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6929
6929
|
[key: string]: Collider;
|
|
6930
6930
|
}, any>>;
|
|
6931
6931
|
/**
|
|
@@ -6935,7 +6935,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6935
6935
|
* @param {*} [options] Override http request option.
|
|
6936
6936
|
* @throws {RequiredError}
|
|
6937
6937
|
*/
|
|
6938
|
-
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6938
|
+
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6939
6939
|
[key: string]: {
|
|
6940
6940
|
[key: string]: Collider;
|
|
6941
6941
|
}[];
|
|
@@ -6947,7 +6947,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6947
6947
|
* @param {*} [options] Override http request option.
|
|
6948
6948
|
* @throws {RequiredError}
|
|
6949
6949
|
*/
|
|
6950
|
-
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6950
|
+
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6951
6951
|
/**
|
|
6952
6952
|
* Returns all stored colliders.
|
|
6953
6953
|
* @summary List Colliders
|
|
@@ -6955,7 +6955,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6955
6955
|
* @param {*} [options] Override http request option.
|
|
6956
6956
|
* @throws {RequiredError}
|
|
6957
6957
|
*/
|
|
6958
|
-
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6958
|
+
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6959
6959
|
[key: string]: Collider;
|
|
6960
6960
|
}, any>>;
|
|
6961
6961
|
/**
|
|
@@ -6965,7 +6965,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6965
6965
|
* @param {*} [options] Override http request option.
|
|
6966
6966
|
* @throws {RequiredError}
|
|
6967
6967
|
*/
|
|
6968
|
-
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6968
|
+
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6969
6969
|
/**
|
|
6970
6970
|
* Returns the list of stored tools.
|
|
6971
6971
|
* @summary List Tools
|
|
@@ -6973,7 +6973,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6973
6973
|
* @param {*} [options] Override http request option.
|
|
6974
6974
|
* @throws {RequiredError}
|
|
6975
6975
|
*/
|
|
6976
|
-
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6976
|
+
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6977
6977
|
[key: string]: {
|
|
6978
6978
|
[key: string]: Collider;
|
|
6979
6979
|
};
|
|
@@ -6985,7 +6985,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6985
6985
|
* @param {*} [options] Override http request option.
|
|
6986
6986
|
* @throws {RequiredError}
|
|
6987
6987
|
*/
|
|
6988
|
-
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6988
|
+
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6989
6989
|
/**
|
|
6990
6990
|
* Stores collider. - If the collider does not exist, it will be created. - If the collider exists, it will be updated.
|
|
6991
6991
|
* @summary Store Collider
|
|
@@ -6995,7 +6995,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6995
6995
|
* @param {*} [options] Override http request option.
|
|
6996
6996
|
* @throws {RequiredError}
|
|
6997
6997
|
*/
|
|
6998
|
-
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<
|
|
6998
|
+
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
6999
6999
|
/**
|
|
7000
7000
|
* Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
|
|
7001
7001
|
* @summary Store Link Chain
|
|
@@ -7007,7 +7007,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7007
7007
|
*/
|
|
7008
7008
|
storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{
|
|
7009
7009
|
[key: string]: Collider;
|
|
7010
|
-
}>, options?: RawAxiosRequestConfig): Promise<
|
|
7010
|
+
}>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
7011
7011
|
[key: string]: Collider;
|
|
7012
7012
|
}[], any>>;
|
|
7013
7013
|
/**
|
|
@@ -7021,7 +7021,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7021
7021
|
*/
|
|
7022
7022
|
storeCollisionTool(cell: string, tool: string, requestBody: {
|
|
7023
7023
|
[key: string]: Collider;
|
|
7024
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
7024
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
7025
7025
|
[key: string]: Collider;
|
|
7026
7026
|
}, any>>;
|
|
7027
7027
|
}
|
|
@@ -7188,7 +7188,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
7188
7188
|
* @param {*} [options] Override http request option.
|
|
7189
7189
|
* @throws {RequiredError}
|
|
7190
7190
|
*/
|
|
7191
|
-
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7191
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7192
7192
|
/**
|
|
7193
7193
|
* Returns the stored collision setup.
|
|
7194
7194
|
* @summary Get Collision Setup
|
|
@@ -7197,7 +7197,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
7197
7197
|
* @param {*} [options] Override http request option.
|
|
7198
7198
|
* @throws {RequiredError}
|
|
7199
7199
|
*/
|
|
7200
|
-
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7200
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
7201
7201
|
/**
|
|
7202
7202
|
* Returns a list of stored collision setups.
|
|
7203
7203
|
* @summary List Collision Setups
|
|
@@ -7205,7 +7205,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
7205
7205
|
* @param {*} [options] Override http request option.
|
|
7206
7206
|
* @throws {RequiredError}
|
|
7207
7207
|
*/
|
|
7208
|
-
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7208
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
7209
7209
|
[key: string]: CollisionSetup;
|
|
7210
7210
|
}, any>>;
|
|
7211
7211
|
/**
|
|
@@ -7215,7 +7215,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
7215
7215
|
* @param {*} [options] Override http request option.
|
|
7216
7216
|
* @throws {RequiredError}
|
|
7217
7217
|
*/
|
|
7218
|
-
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7218
|
+
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
7219
7219
|
/**
|
|
7220
7220
|
* Stores collision setup. - If the collision setup does not exist, it will be created. - If the collision setup exists, it will be updated.
|
|
7221
7221
|
* @summary Store Collision Setup
|
|
@@ -7225,7 +7225,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
7225
7225
|
* @param {*} [options] Override http request option.
|
|
7226
7226
|
* @throws {RequiredError}
|
|
7227
7227
|
*/
|
|
7228
|
-
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<
|
|
7228
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
7229
7229
|
}
|
|
7230
7230
|
/**
|
|
7231
7231
|
* StoreObjectApi - axios parameter creator
|
|
@@ -7421,7 +7421,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7421
7421
|
* @param {*} [options] Override http request option.
|
|
7422
7422
|
* @throws {RequiredError}
|
|
7423
7423
|
*/
|
|
7424
|
-
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7424
|
+
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7425
7425
|
/**
|
|
7426
7426
|
* Delete an object <!-- theme: danger --> > This will delete persistently stored data.
|
|
7427
7427
|
* @summary Delete Object
|
|
@@ -7430,7 +7430,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7430
7430
|
* @param {*} [options] Override http request option.
|
|
7431
7431
|
* @throws {RequiredError}
|
|
7432
7432
|
*/
|
|
7433
|
-
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7433
|
+
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7434
7434
|
/**
|
|
7435
7435
|
* Returns content and metadata of a stored object.
|
|
7436
7436
|
* @summary Get Object
|
|
@@ -7439,7 +7439,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7439
7439
|
* @param {*} [options] Override http request option.
|
|
7440
7440
|
* @throws {RequiredError}
|
|
7441
7441
|
*/
|
|
7442
|
-
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7442
|
+
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7443
7443
|
/**
|
|
7444
7444
|
* Returns metadata. Object content is not returned.
|
|
7445
7445
|
* @summary Get Object Metadata
|
|
@@ -7448,7 +7448,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7448
7448
|
* @param {*} [options] Override http request option.
|
|
7449
7449
|
* @throws {RequiredError}
|
|
7450
7450
|
*/
|
|
7451
|
-
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7451
|
+
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7452
7452
|
/**
|
|
7453
7453
|
* List the keys for all objects.
|
|
7454
7454
|
* @summary List all Object Keys
|
|
@@ -7456,7 +7456,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7456
7456
|
* @param {*} [options] Override http request option.
|
|
7457
7457
|
* @throws {RequiredError}
|
|
7458
7458
|
*/
|
|
7459
|
-
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7459
|
+
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
7460
7460
|
/**
|
|
7461
7461
|
* Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](#/operations/getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
|
|
7462
7462
|
* @summary Store Object
|
|
@@ -7469,7 +7469,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7469
7469
|
*/
|
|
7470
7470
|
storeObject(cell: string, key: string, xMetadata?: {
|
|
7471
7471
|
[key: string]: string;
|
|
7472
|
-
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<
|
|
7472
|
+
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7473
7473
|
}
|
|
7474
7474
|
/**
|
|
7475
7475
|
* SystemApi - axios parameter creator
|
|
@@ -7788,7 +7788,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7788
7788
|
*/
|
|
7789
7789
|
backupConfiguration(resources?: Array<string>, metadata?: {
|
|
7790
7790
|
[key: string]: string;
|
|
7791
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
7791
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7792
7792
|
/**
|
|
7793
7793
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
7794
7794
|
* @summary Check update
|
|
@@ -7796,7 +7796,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7796
7796
|
* @param {*} [options] Override http request option.
|
|
7797
7797
|
* @throws {RequiredError}
|
|
7798
7798
|
*/
|
|
7799
|
-
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
7799
|
+
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
7800
7800
|
/**
|
|
7801
7801
|
* <!-- theme: danger --> > **Experimental** Performs an address resolution protocol (ARP) scan on the specified interface/classless inter-domain routing (CIDR) and returns all discovered devices on the network by CIDR notation.
|
|
7802
7802
|
* @summary Get ARP-Scan
|
|
@@ -7806,7 +7806,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7806
7806
|
* @param {*} [options] Override http request option.
|
|
7807
7807
|
* @throws {RequiredError}
|
|
7808
7808
|
*/
|
|
7809
|
-
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7809
|
+
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<NetworkDevice[], any>>;
|
|
7810
7810
|
/**
|
|
7811
7811
|
* Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
|
|
7812
7812
|
* @summary Retrieve Backup Status
|
|
@@ -7814,49 +7814,49 @@ declare class SystemApi extends BaseAPI {
|
|
|
7814
7814
|
* @param {*} [options] Override http request option.
|
|
7815
7815
|
* @throws {RequiredError}
|
|
7816
7816
|
*/
|
|
7817
|
-
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
7817
|
+
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationArchiveStatus, any>>;
|
|
7818
7818
|
/**
|
|
7819
7819
|
* Collects information on the current status of all NOVA services and exports them as a .zip file. Includes information on all cells on the instance such as the service logs and virtual robot controllers. From each cell the logs of all services are included, as well as the configuration of each connected controller to start virtual robots.
|
|
7820
7820
|
* @summary Download Diagnosis Package
|
|
7821
7821
|
* @param {*} [options] Override http request option.
|
|
7822
7822
|
* @throws {RequiredError}
|
|
7823
7823
|
*/
|
|
7824
|
-
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<
|
|
7824
|
+
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7825
7825
|
/**
|
|
7826
7826
|
* <!-- theme: danger --> > **Experimental** Get the network interfaces of the system.
|
|
7827
7827
|
* @summary Network Interfaces
|
|
7828
7828
|
* @param {*} [options] Override http request option.
|
|
7829
7829
|
* @throws {RequiredError}
|
|
7830
7830
|
*/
|
|
7831
|
-
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<
|
|
7831
|
+
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<NetworkInterface[], any>>;
|
|
7832
7832
|
/**
|
|
7833
7833
|
* <!-- theme: danger --> > **Experimental** Get the current state of the network.
|
|
7834
7834
|
* @summary Network State
|
|
7835
7835
|
* @param {*} [options] Override http request option.
|
|
7836
7836
|
* @throws {RequiredError}
|
|
7837
7837
|
*/
|
|
7838
|
-
getNetworkState(options?: RawAxiosRequestConfig): Promise<
|
|
7838
|
+
getNetworkState(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<NetworkState, any>>;
|
|
7839
7839
|
/**
|
|
7840
7840
|
* Get the status of all system services.
|
|
7841
7841
|
* @summary Wandelbots NOVA status
|
|
7842
7842
|
* @param {*} [options] Override http request option.
|
|
7843
7843
|
* @throws {RequiredError}
|
|
7844
7844
|
*/
|
|
7845
|
-
getSystemStatus(options?: RawAxiosRequestConfig): Promise<
|
|
7845
|
+
getSystemStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatus[], any>>;
|
|
7846
7846
|
/**
|
|
7847
7847
|
* Get the current Wandelbots NOVA version.
|
|
7848
7848
|
* @summary Wandelbots NOVA Version
|
|
7849
7849
|
* @param {*} [options] Override http request option.
|
|
7850
7850
|
* @throws {RequiredError}
|
|
7851
7851
|
*/
|
|
7852
|
-
getSystemVersion(options?: RawAxiosRequestConfig): Promise<
|
|
7852
|
+
getSystemVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
7853
7853
|
/**
|
|
7854
7854
|
* Retrieves a list of all available configuration resources for backup purposes.
|
|
7855
7855
|
* @summary List Configuration Resources
|
|
7856
7856
|
* @param {*} [options] Override http request option.
|
|
7857
7857
|
* @throws {RequiredError}
|
|
7858
7858
|
*/
|
|
7859
|
-
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<
|
|
7859
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationResource[], any>>;
|
|
7860
7860
|
/**
|
|
7861
7861
|
* Restores a previously backed up configuration. If an empty array of resources is provided, all resources from the backup will be restored.
|
|
7862
7862
|
* @summary Restore Configuration Backup
|
|
@@ -7865,7 +7865,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7865
7865
|
* @param {*} [options] Override http request option.
|
|
7866
7866
|
* @throws {RequiredError}
|
|
7867
7867
|
*/
|
|
7868
|
-
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
7868
|
+
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7869
7869
|
/**
|
|
7870
7870
|
* Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored. System updates only apply to cells without an explicit chart version. Pinned versions are always preserved; setting `update_cells=false` pins unversioned cells to the current system version before updating.
|
|
7871
7871
|
* @summary Update Wandelbots NOVA version
|
|
@@ -7873,7 +7873,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7873
7873
|
* @param {*} [options] Override http request option.
|
|
7874
7874
|
* @throws {RequiredError}
|
|
7875
7875
|
*/
|
|
7876
|
-
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7876
|
+
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7877
7877
|
}
|
|
7878
7878
|
/**
|
|
7879
7879
|
* TrajectoryCachingApi - axios parameter creator
|
|
@@ -8047,7 +8047,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
8047
8047
|
* @param {*} [options] Override http request option.
|
|
8048
8048
|
* @throws {RequiredError}
|
|
8049
8049
|
*/
|
|
8050
|
-
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8050
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<AddTrajectoryResponse, any>>;
|
|
8051
8051
|
/**
|
|
8052
8052
|
* Clear the trajectory cache.
|
|
8053
8053
|
* @summary Clear Trajectories
|
|
@@ -8056,7 +8056,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
8056
8056
|
* @param {*} [options] Override http request option.
|
|
8057
8057
|
* @throws {RequiredError}
|
|
8058
8058
|
*/
|
|
8059
|
-
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8059
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8060
8060
|
/**
|
|
8061
8061
|
* Delete a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
8062
8062
|
* @summary Delete Trajectory
|
|
@@ -8066,7 +8066,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
8066
8066
|
* @param {*} [options] Override http request option.
|
|
8067
8067
|
* @throws {RequiredError}
|
|
8068
8068
|
*/
|
|
8069
|
-
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
8069
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8070
8070
|
/**
|
|
8071
8071
|
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
8072
8072
|
* @summary Get Trajectory
|
|
@@ -8076,7 +8076,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
8076
8076
|
* @param {*} [options] Override http request option.
|
|
8077
8077
|
* @throws {RequiredError}
|
|
8078
8078
|
*/
|
|
8079
|
-
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
8079
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
|
|
8080
8080
|
/**
|
|
8081
8081
|
* List currently cached trajectories. Use [addTrajectory](#/operations/addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
8082
8082
|
* @summary List Trajectories
|
|
@@ -8085,7 +8085,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
8085
8085
|
* @param {*} [options] Override http request option.
|
|
8086
8086
|
* @throws {RequiredError}
|
|
8087
8087
|
*/
|
|
8088
|
-
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8088
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListTrajectoriesResponse, any>>;
|
|
8089
8089
|
}
|
|
8090
8090
|
/**
|
|
8091
8091
|
* TrajectoryExecutionApi - axios parameter creator
|
|
@@ -8145,7 +8145,7 @@ declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
8145
8145
|
* @param {*} [options] Override http request option.
|
|
8146
8146
|
* @throws {RequiredError}
|
|
8147
8147
|
*/
|
|
8148
|
-
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8148
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
8149
8149
|
}
|
|
8150
8150
|
/**
|
|
8151
8151
|
* TrajectoryPlanningApi - axios parameter creator
|
|
@@ -8255,7 +8255,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
8255
8255
|
* @param {*} [options] Override http request option.
|
|
8256
8256
|
* @throws {RequiredError}
|
|
8257
8257
|
*/
|
|
8258
|
-
mergeTrajectories(cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8258
|
+
mergeTrajectories(cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MergeTrajectoriesResponse, any>>;
|
|
8259
8259
|
/**
|
|
8260
8260
|
* Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
8261
8261
|
* @summary Plan Collision-Free Trajectory
|
|
@@ -8264,7 +8264,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
8264
8264
|
* @param {*} [options] Override http request option.
|
|
8265
8265
|
* @throws {RequiredError}
|
|
8266
8266
|
*/
|
|
8267
|
-
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8267
|
+
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
|
|
8268
8268
|
/**
|
|
8269
8269
|
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
8270
8270
|
* @summary Plan Trajectory
|
|
@@ -8273,7 +8273,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
8273
8273
|
* @param {*} [options] Override http request option.
|
|
8274
8274
|
* @throws {RequiredError}
|
|
8275
8275
|
*/
|
|
8276
|
-
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8276
|
+
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
8277
8277
|
}
|
|
8278
8278
|
/**
|
|
8279
8279
|
* VersionApi - axios parameter creator
|
|
@@ -8321,7 +8321,7 @@ declare class VersionApi extends BaseAPI {
|
|
|
8321
8321
|
* @param {*} [options] Override http request option.
|
|
8322
8322
|
* @throws {RequiredError}
|
|
8323
8323
|
*/
|
|
8324
|
-
getApiVersion(options?: RawAxiosRequestConfig): Promise<
|
|
8324
|
+
getApiVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ApiVersion, any>>;
|
|
8325
8325
|
}
|
|
8326
8326
|
/**
|
|
8327
8327
|
* VirtualControllerApi - axios parameter creator
|
|
@@ -8871,7 +8871,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8871
8871
|
* @param {*} [options] Override http request option.
|
|
8872
8872
|
* @throws {RequiredError}
|
|
8873
8873
|
*/
|
|
8874
|
-
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<
|
|
8874
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8875
8875
|
/**
|
|
8876
8876
|
* Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json_data** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json_data**: Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). - **extracted_motion_group_id** (required when using json_data): The motion group identifier to extract from the provided JSON configuration. - **motion_group**: Unique identifier for the motion group to be added. - **initial_joint_position**: Specifies the initial joint position for the added motion group. <!-- theme: info --> > #### NOTE > > When a motion group is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new motion group may not yet be available for use.
|
|
8877
8877
|
* @summary Add Motion Group
|
|
@@ -8881,7 +8881,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8881
8881
|
* @param {*} [options] Override http request option.
|
|
8882
8882
|
* @throws {RequiredError}
|
|
8883
8883
|
*/
|
|
8884
|
-
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8884
|
+
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8885
8885
|
/**
|
|
8886
8886
|
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. <!-- theme: info --> > #### NOTE > > When adding or updating a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the TCP is available for operation. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the TCP may not yet be visible nor usable.
|
|
8887
8887
|
* @summary Add TCP
|
|
@@ -8893,7 +8893,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8893
8893
|
* @param {*} [options] Override http request option.
|
|
8894
8894
|
* @throws {RequiredError}
|
|
8895
8895
|
*/
|
|
8896
|
-
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<
|
|
8896
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8897
8897
|
/**
|
|
8898
8898
|
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. <!-- theme: info --> > #### NOTE > > When a new coordinate system is removed, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
|
|
8899
8899
|
* @summary Delete Coordinate System
|
|
@@ -8904,7 +8904,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8904
8904
|
* @param {*} [options] Override http request option.
|
|
8905
8905
|
* @throws {RequiredError}
|
|
8906
8906
|
*/
|
|
8907
|
-
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
8907
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8908
8908
|
/**
|
|
8909
8909
|
* Removes a motion group configuration from the virtual controller. <!-- theme: info --> > #### NOTE > > When a motion group is removed, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**.
|
|
8910
8910
|
* @summary Delete Motion Group
|
|
@@ -8914,7 +8914,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8914
8914
|
* @param {*} [options] Override http request option.
|
|
8915
8915
|
* @throws {RequiredError}
|
|
8916
8916
|
*/
|
|
8917
|
-
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8917
|
+
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8918
8918
|
/**
|
|
8919
8919
|
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. <!-- theme: info --> > #### NOTE > > When removing a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The removal of the TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the then used TCP may not yet be visible nor usable.
|
|
8920
8920
|
* @summary Remove TCP
|
|
@@ -8925,7 +8925,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8925
8925
|
* @param {*} [options] Override http request option.
|
|
8926
8926
|
* @throws {RequiredError}
|
|
8927
8927
|
*/
|
|
8928
|
-
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<
|
|
8928
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8929
8929
|
/**
|
|
8930
8930
|
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
8931
8931
|
* @summary Get Emergency Stop State
|
|
@@ -8934,7 +8934,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8934
8934
|
* @param {*} [options] Override http request option.
|
|
8935
8935
|
* @throws {RequiredError}
|
|
8936
8936
|
*/
|
|
8937
|
-
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8937
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Flag, any>>;
|
|
8938
8938
|
/**
|
|
8939
8939
|
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8940
8940
|
* @summary Get Motion Group State
|
|
@@ -8944,7 +8944,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8944
8944
|
* @param {*} [options] Override http request option.
|
|
8945
8945
|
* @throws {RequiredError}
|
|
8946
8946
|
*/
|
|
8947
|
-
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8947
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupJoints, any>>;
|
|
8948
8948
|
/**
|
|
8949
8949
|
* Gets information on the motion group.
|
|
8950
8950
|
* @summary Motion Group Description
|
|
@@ -8953,7 +8953,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8953
8953
|
* @param {*} [options] Override http request option.
|
|
8954
8954
|
* @throws {RequiredError}
|
|
8955
8955
|
*/
|
|
8956
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8956
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfo[], any>>;
|
|
8957
8957
|
/**
|
|
8958
8958
|
* Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
8959
8959
|
* @summary Get Operation Mode
|
|
@@ -8962,7 +8962,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8962
8962
|
* @param {*} [options] Override http request option.
|
|
8963
8963
|
* @throws {RequiredError}
|
|
8964
8964
|
*/
|
|
8965
|
-
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8965
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<OpMode, any>>;
|
|
8966
8966
|
/**
|
|
8967
8967
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8968
8968
|
* @summary Get Mounting
|
|
@@ -8972,7 +8972,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8972
8972
|
* @param {*} [options] Override http request option.
|
|
8973
8973
|
* @throws {RequiredError}
|
|
8974
8974
|
*/
|
|
8975
|
-
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8975
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
8976
8976
|
/**
|
|
8977
8977
|
* Lists all coordinate systems on the robot controller.
|
|
8978
8978
|
* @summary List Coordinate Systems
|
|
@@ -8981,7 +8981,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8981
8981
|
* @param {*} [options] Override http request option.
|
|
8982
8982
|
* @throws {RequiredError}
|
|
8983
8983
|
*/
|
|
8984
|
-
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8984
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
8985
8985
|
/**
|
|
8986
8986
|
* Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
|
|
8987
8987
|
* @summary List TCPs
|
|
@@ -8991,7 +8991,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8991
8991
|
* @param {*} [options] Override http request option.
|
|
8992
8992
|
* @throws {RequiredError}
|
|
8993
8993
|
*/
|
|
8994
|
-
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8994
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp[], any>>;
|
|
8995
8995
|
/**
|
|
8996
8996
|
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
8997
8997
|
* @summary Push or Release Emergency Stop
|
|
@@ -9001,7 +9001,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
9001
9001
|
* @param {*} [options] Override http request option.
|
|
9002
9002
|
* @throws {RequiredError}
|
|
9003
9003
|
*/
|
|
9004
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
9004
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9005
9005
|
/**
|
|
9006
9006
|
* Sets the values for joint position, joint velocity or joint acceleration of a motion group state. The values are immediately applied to the joints of the motion group. <!-- theme: info --> > #### NOTE > > Only use the endpoint when the motion group is in monitor mode. If the motion group is controlled, currently jogging or planning motions, > the values are overridden by the controller or an error may occur.
|
|
9007
9007
|
* @summary Set Motion Group State
|
|
@@ -9012,7 +9012,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
9012
9012
|
* @param {*} [options] Override http request option.
|
|
9013
9013
|
* @throws {RequiredError}
|
|
9014
9014
|
*/
|
|
9015
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<
|
|
9015
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9016
9016
|
/**
|
|
9017
9017
|
* Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
9018
9018
|
* @summary Set Operation Mode
|
|
@@ -9022,7 +9022,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
9022
9022
|
* @param {*} [options] Override http request option.
|
|
9023
9023
|
* @throws {RequiredError}
|
|
9024
9024
|
*/
|
|
9025
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<
|
|
9025
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9026
9026
|
/**
|
|
9027
9027
|
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. <!-- theme: info --> > #### Changing the mounting configuration is considered a setup change > > When the mounting is set to a new coordinate system, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or not reflect the new mounting immediately. > - Motion group state and coordinate system alignment may not be immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
|
|
9028
9028
|
* @summary Set Mounting
|
|
@@ -9033,7 +9033,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
9033
9033
|
* @param {*} [options] Override http request option.
|
|
9034
9034
|
* @throws {RequiredError}
|
|
9035
9035
|
*/
|
|
9036
|
-
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
9036
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
9037
9037
|
}
|
|
9038
9038
|
/**
|
|
9039
9039
|
* VirtualControllerBehaviorApi - axios parameter creator
|
|
@@ -9177,7 +9177,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
9177
9177
|
* @param {*} [options] Override http request option.
|
|
9178
9178
|
* @throws {RequiredError}
|
|
9179
9179
|
*/
|
|
9180
|
-
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9180
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExternalJointStreamDatapoint[], any>>;
|
|
9181
9181
|
/**
|
|
9182
9182
|
* Get the cycle time of controller communication in [ms].
|
|
9183
9183
|
* @summary Get Cycle Time
|
|
@@ -9186,7 +9186,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
9186
9186
|
* @param {*} [options] Override http request option.
|
|
9187
9187
|
* @throws {RequiredError}
|
|
9188
9188
|
*/
|
|
9189
|
-
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
9189
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
|
|
9190
9190
|
/**
|
|
9191
9191
|
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
9192
9192
|
* @summary Get Behavior
|
|
@@ -9195,7 +9195,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
9195
9195
|
* @param {*} [options] Override http request option.
|
|
9196
9196
|
* @throws {RequiredError}
|
|
9197
9197
|
*/
|
|
9198
|
-
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
9198
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Behavior, any>>;
|
|
9199
9199
|
/**
|
|
9200
9200
|
* Set virtual controller behavior. See query parameters for details.
|
|
9201
9201
|
* @summary Set Behavior
|
|
@@ -9205,7 +9205,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
9205
9205
|
* @param {*} [options] Override http request option.
|
|
9206
9206
|
* @throws {RequiredError}
|
|
9207
9207
|
*/
|
|
9208
|
-
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<
|
|
9208
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9209
9209
|
}
|
|
9210
9210
|
/**
|
|
9211
9211
|
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
@@ -9334,7 +9334,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
9334
9334
|
* @param {*} [options] Override http request option.
|
|
9335
9335
|
* @throws {RequiredError}
|
|
9336
9336
|
*/
|
|
9337
|
-
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
9337
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
9338
9338
|
/**
|
|
9339
9339
|
* Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit.\\ Available inputs/outputs are defined by the virtual robot controller.\\ Each input/output has a unique identifier. - If no identifiers and no filters are specified in the request, all available inputs/outputs are retrieved by this endpoint. - If a filter, e.g., `direction`, `value_type`, `group` is applied, only matching inputs/outputs are returned.
|
|
9340
9340
|
* @summary List Descriptions
|
|
@@ -9347,7 +9347,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
9347
9347
|
* @param {*} [options] Override http request option.
|
|
9348
9348
|
* @throws {RequiredError}
|
|
9349
9349
|
*/
|
|
9350
|
-
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
9350
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
9351
9351
|
/**
|
|
9352
9352
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
9353
9353
|
* @summary Set Input/Ouput Values
|
|
@@ -9357,7 +9357,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
9357
9357
|
* @param {*} [options] Override http request option.
|
|
9358
9358
|
* @throws {RequiredError}
|
|
9359
9359
|
*/
|
|
9360
|
-
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
9360
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9361
9361
|
}
|
|
9362
9362
|
//#endregion
|
|
9363
9363
|
export { AbbController, AbbControllerEgmServer, AbbControllerKindEnum, ActivateLicenseRequest, AddTrajectoryError, AddTrajectoryErrorData, AddTrajectoryRequest, AddTrajectoryResponse, AddVirtualControllerMotionGroupRequest, ApiVersion, App, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAuto, BlendingAutoBlendingNameEnum, BlendingPosition, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValue, BooleanValueValueTypeEnum, Box, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIODescription, BusIOModbusClient, BusIOModbusClientBusTypeEnum, BusIOModbusServer, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClient, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServer, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtual, BusIOModbusVirtualBusTypeEnum, BusIOProfinet, BusIOProfinetBusTypeEnum, BusIOProfinetDefaultRoute, BusIOProfinetIpConfig, BusIOProfinetNetwork, BusIOProfinetVirtual, BusIOProfinetVirtualBusTypeEnum, BusIOType, BusIOsState, BusIOsStateEnum, COLLECTION_FORMATS, Capsule, CapsuleShapeTypeEnum, CartesianLimits, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Collider, ColliderShape, Collision, CollisionContact, CollisionError, CollisionErrorKindEnum, CollisionFreeAlgorithm, CollisionSetup, Comparator, Configuration, ConfigurationArchiveStatus, ConfigurationArchiveStatusCreating, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusError, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccess, ConfigurationArchiveStatusSuccessStatusEnum, ConfigurationParameters, ConfigurationResource, ContainerEnvironmentInner, ContainerImage, ContainerImageSecretsInner, ContainerResources, ContainerStorage, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerDescription, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHull, ConvexHullShapeTypeEnum, CoordinateSystem, CoordinateSystemData, CubicSplineParameter, CycleTime, Cylinder, CylinderShapeTypeEnum, DHParameter, Direction, ErrorInvalidJointCount, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceeded, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollision, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceeded, ErrorMaxIterationsExceededErrorFeedbackNameEnum, Execute, ExecuteDetails, ExecuteJoggingRequest, ExecuteJoggingResponse, ExecuteTrajectoryRequest, ExecuteTrajectoryResponse, ExternalJointStreamDatapoint, ExternalJointStreamRequest, FanucController, FanucControllerKindEnum, FeedbackCollision, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceeded, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspace, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularity, FeedbackSingularityErrorFeedbackNameEnum, Flag, FloatValue, FloatValueValueTypeEnum, ForwardKinematics422Response, ForwardKinematicsRequest, ForwardKinematicsResponse, ForwardKinematicsValidationError, GetTrajectoryResponse, HTTPValidationError, IOBooleanValue, IOBooleanValueValueTypeEnum, IOBoundary, IODescription, IODirection, IOFloatValue, IOFloatValueValueTypeEnum, IOIntegerValue, IOIntegerValueValueTypeEnum, IOOrigin, IOValue, IOValueType, ImageCredentials, InconsistentTrajectorySizeError, InconsistentTrajectorySizeErrorInconsistentTrajectorySize, InconsistentTrajectorySizeErrorKindEnum, InitializeJoggingRequest, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponse, InitializeJoggingResponseKindEnum, InitializeMovementRequest, InitializeMovementRequestMessageTypeEnum, InitializeMovementRequestTrajectory, InitializeMovementResponse, InitializeMovementResponseKindEnum, IntegerValue, IntegerValueValueTypeEnum, InvalidDofError, InvalidDofErrorInvalidDof, InvalidDofErrorKindEnum, InverseKinematics422Response, InverseKinematicsRequest, InverseKinematicsResponse, InverseKinematicsValidationError, InverseKinematicsValidationErrorAllOfData, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetails, JoggingDetailsKindEnum, JoggingDetailsState, JoggingPausedByUser, JoggingPausedByUserKindEnum, JoggingPausedNearCollision, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimit, JoggingPausedNearJointLimitKindEnum, JoggingPausedOnIO, JoggingPausedOnIOKindEnum, JoggingRunning, JoggingRunningKindEnum, JointLimitExceededError, JointLimitExceededErrorKindEnum, JointLimits, JointTrajectory, JointTypeEnum, JointVelocityRequest, JointVelocityRequestMessageTypeEnum, JointVelocityResponse, JointVelocityResponseKindEnum, KinematicModel, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaController, KukaControllerKindEnum, KukaControllerRsiServer, License, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatus, LicenseStatusEnum, LimitRange, LimitSet, LimitsOverride, ListTrajectoriesResponse, Manufacturer, MergeTrajectories422Response, MergeTrajectoriesError, MergeTrajectoriesRequest, MergeTrajectoriesResponse, MergeTrajectoriesResponseFeedbackInner, MergeTrajectoriesSegment, MergeTrajectoriesValidationError, MidpointInsertionAlgorithm, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIO, ModbusIOArea, ModbusIOByteOrder, ModbusIOData, ModbusIOTypeEnum, ModelError, MotionCommand, MotionCommandBlending, MotionCommandPath, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupDescription, MotionGroupFromJson, MotionGroupFromType, MotionGroupInfo, MotionGroupJoints, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MotionGroupSetup, MotionGroupState, MotionGroupStateJointLimitReached, MovementErrorResponse, MovementErrorResponseKindEnum, NanValueError, NanValueErrorKindEnum, NanValueErrorNanValue, NetworkDevice, NetworkInterface, NetworkState, NetworkStateConnectionTypeEnum, OpMode, OperatingState, OperationLimits, OperationMode, OrientationType, PathCartesianPTP, PathCartesianPTPPathDefinitionNameEnum, PathCircle, PathCirclePathDefinitionNameEnum, PathCubicSpline, PathCubicSplinePathDefinitionNameEnum, PathJointPTP, PathJointPTPPathDefinitionNameEnum, PathLine, PathLinePathDefinitionNameEnum, PauseJoggingRequest, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponse, PauseJoggingResponseKindEnum, PauseMovementRequest, PauseMovementRequestMessageTypeEnum, PauseMovementResponse, PauseMovementResponseKindEnum, PauseOnIO, Payload, Plan422Response, PlanCollisionFreeFailedResponse, PlanCollisionFreeRequest, PlanCollisionFreeResponse, PlanCollisionFreeResponseResponse, PlanTrajectoryFailedResponse, PlanTrajectoryFailedResponseErrorFeedback, PlanTrajectoryRequest, PlanTrajectoryResponse, PlanTrajectoryResponseResponse, PlanValidationError, PlanValidationErrorAllOfData, Plane, PlaneShapeTypeEnum, PlaybackSpeedRequest, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponse, PlaybackSpeedResponseKindEnum, Pose, ProfinetDescription, ProfinetIO, ProfinetIOData, ProfinetIODirection, ProfinetIOTypeEnum, ProfinetInputOutputConfig, ProfinetSlotDescription, ProfinetSubSlotDescription, Program, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRun, ProgramRunState, ProgramStartRequest, RRTConnectAlgorithm, RRTConnectAlgorithmAlgorithmNameEnum, Rectangle, RectangleShapeTypeEnum, RectangularCapsule, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequestArgs, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotController, RobotControllerConfiguration, RobotControllerConfigurationRequest, RobotControllerState, RobotSystemMode, RobotTcp, RobotTcpData, SafetyStateType, ServiceGroup, ServiceStatus, ServiceStatusPhase, ServiceStatusResponse, ServiceStatusSeverity, ServiceStatusStatus, SetIO, SettableRobotSystemMode, SingularityTypeEnum, Sphere, SphereShapeTypeEnum, StartMovementRequest, StartMovementRequestMessageTypeEnum, StartMovementResponse, StartMovementResponseKindEnum, StartOnIO, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, StreamIOValuesResponse, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpOffset, TcpRequiredError, TcpRequiredErrorKindEnum, TcpVelocityRequest, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponse, TcpVelocityResponseKindEnum, TorqueExceededError, TorqueExceededErrorKindEnum, TorqueExceededErrorTorqueExceeded, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryData, TrajectoryDataMessageTypeEnum, TrajectoryDetails, TrajectoryDetailsKindEnum, TrajectoryDetailsState, TrajectoryEnded, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryId, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUser, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIO, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunning, TrajectoryRunningKindEnum, TrajectorySection, TrajectoryWaitForIO, TrajectoryWaitForIOKindEnum, UnitType, UniversalrobotsController, UniversalrobotsControllerKindEnum, UpdateCellVersionRequest, UpdateNovaVersionRequest, ValidationError, ValidationError2, ValidationErrorLocInner, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualController, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, VirtualRobotConfiguration, WaitForIOEventRequest, YaskawaController, YaskawaControllerKindEnum, operationServerMap };
|