@wandelbots/nova-api 26.2.0-dev.60 → 26.2.0-dev.61
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/v1/index.d.ts +178 -178
- package/dist/v2/index.d.cts +144 -144
- package/dist/v2/index.d.ts +144 -144
- package/package.json +1 -1
package/dist/v2/index.d.ts
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
|
|
@@ -3621,7 +3621,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3621
3621
|
* @param {*} [options] Override http request option.
|
|
3622
3622
|
* @throws {RequiredError}
|
|
3623
3623
|
*/
|
|
3624
|
-
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3624
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3625
3625
|
/**
|
|
3626
3626
|
* Delete all GUI applications from the cell.
|
|
3627
3627
|
* @summary Clear Applications
|
|
@@ -3630,7 +3630,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3630
3630
|
* @param {*} [options] Override http request option.
|
|
3631
3631
|
* @throws {RequiredError}
|
|
3632
3632
|
*/
|
|
3633
|
-
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3633
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3634
3634
|
/**
|
|
3635
3635
|
* Delete a GUI application from the cell.
|
|
3636
3636
|
* @summary Delete Application
|
|
@@ -3640,7 +3640,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3640
3640
|
* @param {*} [options] Override http request option.
|
|
3641
3641
|
* @throws {RequiredError}
|
|
3642
3642
|
*/
|
|
3643
|
-
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3643
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3644
3644
|
/**
|
|
3645
3645
|
* 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).
|
|
3646
3646
|
* @summary Configuration
|
|
@@ -3649,7 +3649,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3649
3649
|
* @param {*} [options] Override http request option.
|
|
3650
3650
|
* @throws {RequiredError}
|
|
3651
3651
|
*/
|
|
3652
|
-
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<
|
|
3652
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
|
|
3653
3653
|
/**
|
|
3654
3654
|
* 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.
|
|
3655
3655
|
* @summary List Applications
|
|
@@ -3657,7 +3657,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3657
3657
|
* @param {*} [options] Override http request option.
|
|
3658
3658
|
* @throws {RequiredError}
|
|
3659
3659
|
*/
|
|
3660
|
-
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
3660
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
3661
3661
|
/**
|
|
3662
3662
|
* Update the configuration of a GUI application in the cell.
|
|
3663
3663
|
* @summary Update Configuration
|
|
@@ -3668,7 +3668,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3668
3668
|
* @param {*} [options] Override http request option.
|
|
3669
3669
|
* @throws {RequiredError}
|
|
3670
3670
|
*/
|
|
3671
|
-
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3671
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3672
3672
|
}
|
|
3673
3673
|
/**
|
|
3674
3674
|
* BUSInputsOutputsApi - axios parameter creator
|
|
@@ -4172,7 +4172,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4172
4172
|
* @param {*} [options] Override http request option.
|
|
4173
4173
|
* @throws {RequiredError}
|
|
4174
4174
|
*/
|
|
4175
|
-
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4175
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4176
4176
|
/**
|
|
4177
4177
|
* 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).
|
|
4178
4178
|
* @summary Add MODBUS Input/Output
|
|
@@ -4182,7 +4182,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4182
4182
|
* @param {*} [options] Override http request option.
|
|
4183
4183
|
* @throws {RequiredError}
|
|
4184
4184
|
*/
|
|
4185
|
-
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<
|
|
4185
|
+
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4186
4186
|
/**
|
|
4187
4187
|
* 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).
|
|
4188
4188
|
* @summary Add PROFINET Input/Output
|
|
@@ -4192,7 +4192,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4192
4192
|
* @param {*} [options] Override http request option.
|
|
4193
4193
|
* @throws {RequiredError}
|
|
4194
4194
|
*/
|
|
4195
|
-
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<
|
|
4195
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4196
4196
|
/**
|
|
4197
4197
|
* Remove the BUS inputs/outputs service from the cell.
|
|
4198
4198
|
* @summary Clear Service
|
|
@@ -4201,7 +4201,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4201
4201
|
* @param {*} [options] Override http request option.
|
|
4202
4202
|
* @throws {RequiredError}
|
|
4203
4203
|
*/
|
|
4204
|
-
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4204
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4205
4205
|
/**
|
|
4206
4206
|
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4207
4207
|
* @summary Remove all MODBUS Input/Outputs
|
|
@@ -4209,7 +4209,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4209
4209
|
* @param {*} [options] Override http request option.
|
|
4210
4210
|
* @throws {RequiredError}
|
|
4211
4211
|
*/
|
|
4212
|
-
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4212
|
+
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4213
4213
|
/**
|
|
4214
4214
|
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
4215
4215
|
* @summary Remove all PROFINET Input/Outputs
|
|
@@ -4217,7 +4217,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4217
4217
|
* @param {*} [options] Override http request option.
|
|
4218
4218
|
* @throws {RequiredError}
|
|
4219
4219
|
*/
|
|
4220
|
-
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4220
|
+
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4221
4221
|
/**
|
|
4222
4222
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4223
4223
|
* @summary Remove MODBUS Input/Output
|
|
@@ -4226,7 +4226,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4226
4226
|
* @param {*} [options] Override http request option.
|
|
4227
4227
|
* @throws {RequiredError}
|
|
4228
4228
|
*/
|
|
4229
|
-
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
4229
|
+
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4230
4230
|
/**
|
|
4231
4231
|
* Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
4232
4232
|
* @summary Remove PROFINET Input/Ouptut
|
|
@@ -4235,7 +4235,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4235
4235
|
* @param {*} [options] Override http request option.
|
|
4236
4236
|
* @throws {RequiredError}
|
|
4237
4237
|
*/
|
|
4238
|
-
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
4238
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4239
4239
|
/**
|
|
4240
4240
|
* Get deployed BUS inputs/outputs service.
|
|
4241
4241
|
* @summary Get Service
|
|
@@ -4243,7 +4243,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4243
4243
|
* @param {*} [options] Override http request option.
|
|
4244
4244
|
* @throws {RequiredError}
|
|
4245
4245
|
*/
|
|
4246
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4246
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOType, any>>;
|
|
4247
4247
|
/**
|
|
4248
4248
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
4249
4249
|
* @summary State
|
|
@@ -4251,7 +4251,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4251
4251
|
* @param {*} [options] Override http request option.
|
|
4252
4252
|
* @throws {RequiredError}
|
|
4253
4253
|
*/
|
|
4254
|
-
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4254
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOsState, any>>;
|
|
4255
4255
|
/**
|
|
4256
4256
|
* 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).
|
|
4257
4257
|
* @summary Get Input/Output Values
|
|
@@ -4260,7 +4260,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4260
4260
|
* @param {*} [options] Override http request option.
|
|
4261
4261
|
* @throws {RequiredError}
|
|
4262
4262
|
*/
|
|
4263
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
4263
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
4264
4264
|
/**
|
|
4265
4265
|
* Get description of NOVA as a PROFINET device.
|
|
4266
4266
|
* @summary Get PROFINET Description
|
|
@@ -4268,7 +4268,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4268
4268
|
* @param {*} [options] Override http request option.
|
|
4269
4269
|
* @throws {RequiredError}
|
|
4270
4270
|
*/
|
|
4271
|
-
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4271
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetDescription, any>>;
|
|
4272
4272
|
/**
|
|
4273
4273
|
* 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.
|
|
4274
4274
|
* @summary PROFINET Inputs/Outputs to File
|
|
@@ -4278,7 +4278,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4278
4278
|
* @param {*} [options] Override http request option.
|
|
4279
4279
|
* @throws {RequiredError}
|
|
4280
4280
|
*/
|
|
4281
|
-
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4281
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
4282
4282
|
/**
|
|
4283
4283
|
* 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.
|
|
4284
4284
|
* @summary List Descriptions
|
|
@@ -4286,7 +4286,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4286
4286
|
* @param {*} [options] Override http request option.
|
|
4287
4287
|
* @throws {RequiredError}
|
|
4288
4288
|
*/
|
|
4289
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4289
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIODescription[], any>>;
|
|
4290
4290
|
/**
|
|
4291
4291
|
* 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).
|
|
4292
4292
|
* @summary List MODBUS Input/Output Configuration
|
|
@@ -4294,7 +4294,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4294
4294
|
* @param {*} [options] Override http request option.
|
|
4295
4295
|
* @throws {RequiredError}
|
|
4296
4296
|
*/
|
|
4297
|
-
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4297
|
+
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ModbusIO[], any>>;
|
|
4298
4298
|
/**
|
|
4299
4299
|
* 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.
|
|
4300
4300
|
* @summary List PROFINET Input/Output Configuration
|
|
@@ -4302,7 +4302,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4302
4302
|
* @param {*} [options] Override http request option.
|
|
4303
4303
|
* @throws {RequiredError}
|
|
4304
4304
|
*/
|
|
4305
|
-
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4305
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetIO[], any>>;
|
|
4306
4306
|
/**
|
|
4307
4307
|
* 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.
|
|
4308
4308
|
* @summary Set Output Values
|
|
@@ -4311,7 +4311,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4311
4311
|
* @param {*} [options] Override http request option.
|
|
4312
4312
|
* @throws {RequiredError}
|
|
4313
4313
|
*/
|
|
4314
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
4314
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4315
4315
|
/**
|
|
4316
4316
|
* 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.
|
|
4317
4317
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
@@ -4320,7 +4320,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4320
4320
|
* @param {*} [options] Override http request option.
|
|
4321
4321
|
* @throws {RequiredError}
|
|
4322
4322
|
*/
|
|
4323
|
-
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<
|
|
4323
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4324
4324
|
}
|
|
4325
4325
|
/**
|
|
4326
4326
|
* CellApi - axios parameter creator
|
|
@@ -4583,7 +4583,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4583
4583
|
* @param {*} [options] Override http request option.
|
|
4584
4584
|
* @throws {RequiredError}
|
|
4585
4585
|
*/
|
|
4586
|
-
checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
4586
|
+
checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
4587
4587
|
/**
|
|
4588
4588
|
* Delete an entire cell.
|
|
4589
4589
|
* @summary Delete Cell
|
|
@@ -4592,7 +4592,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4592
4592
|
* @param {*} [options] Override http request option.
|
|
4593
4593
|
* @throws {RequiredError}
|
|
4594
4594
|
*/
|
|
4595
|
-
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4595
|
+
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4596
4596
|
/**
|
|
4597
4597
|
* 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.
|
|
4598
4598
|
* @summary Add Cell
|
|
@@ -4601,7 +4601,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4601
4601
|
* @param {*} [options] Override http request option.
|
|
4602
4602
|
* @throws {RequiredError}
|
|
4603
4603
|
*/
|
|
4604
|
-
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4604
|
+
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4605
4605
|
/**
|
|
4606
4606
|
* List all cell resources.
|
|
4607
4607
|
* @summary Configuration
|
|
@@ -4609,7 +4609,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4609
4609
|
* @param {*} [options] Override http request option.
|
|
4610
4610
|
* @throws {RequiredError}
|
|
4611
4611
|
*/
|
|
4612
|
-
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4612
|
+
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Cell, any>>;
|
|
4613
4613
|
/**
|
|
4614
4614
|
* List the status of all cell resources.
|
|
4615
4615
|
* @summary Service Status
|
|
@@ -4617,14 +4617,14 @@ declare class CellApi extends BaseAPI {
|
|
|
4617
4617
|
* @param {*} [options] Override http request option.
|
|
4618
4618
|
* @throws {RequiredError}
|
|
4619
4619
|
*/
|
|
4620
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4620
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatusResponse, any>>;
|
|
4621
4621
|
/**
|
|
4622
4622
|
* List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
4623
4623
|
* @summary List Cells
|
|
4624
4624
|
* @param {*} [options] Override http request option.
|
|
4625
4625
|
* @throws {RequiredError}
|
|
4626
4626
|
*/
|
|
4627
|
-
listCells(options?: RawAxiosRequestConfig): Promise<
|
|
4627
|
+
listCells(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
4628
4628
|
/**
|
|
4629
4629
|
* Deactivate or activate the services of a cell.
|
|
4630
4630
|
* @summary Operating State
|
|
@@ -4633,7 +4633,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4633
4633
|
* @param {*} [options] Override http request option.
|
|
4634
4634
|
* @throws {RequiredError}
|
|
4635
4635
|
*/
|
|
4636
|
-
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<
|
|
4636
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4637
4637
|
/**
|
|
4638
4638
|
* Update the definition of the entire Cell.
|
|
4639
4639
|
* @summary Update Configuration
|
|
@@ -4643,7 +4643,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4643
4643
|
* @param {*} [options] Override http request option.
|
|
4644
4644
|
* @throws {RequiredError}
|
|
4645
4645
|
*/
|
|
4646
|
-
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4646
|
+
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4647
4647
|
/**
|
|
4648
4648
|
* Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
|
|
4649
4649
|
* @summary Update Cell Version
|
|
@@ -4652,7 +4652,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4652
4652
|
* @param {*} [options] Override http request option.
|
|
4653
4653
|
* @throws {RequiredError}
|
|
4654
4654
|
*/
|
|
4655
|
-
updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
4655
|
+
updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4656
4656
|
}
|
|
4657
4657
|
/**
|
|
4658
4658
|
* ControllerApi - axios parameter creator
|
|
@@ -5090,7 +5090,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5090
5090
|
* @param {*} [options] Override http request option.
|
|
5091
5091
|
* @throws {RequiredError}
|
|
5092
5092
|
*/
|
|
5093
|
-
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5093
|
+
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5094
5094
|
/**
|
|
5095
5095
|
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
5096
5096
|
* @summary Clear Robot Controllers
|
|
@@ -5099,7 +5099,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5099
5099
|
* @param {*} [options] Override http request option.
|
|
5100
5100
|
* @throws {RequiredError}
|
|
5101
5101
|
*/
|
|
5102
|
-
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5102
|
+
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5103
5103
|
/**
|
|
5104
5104
|
* Delete a robot controller from the cell.
|
|
5105
5105
|
* @summary Delete Robot Controller
|
|
@@ -5109,7 +5109,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5109
5109
|
* @param {*} [options] Override http request option.
|
|
5110
5110
|
* @throws {RequiredError}
|
|
5111
5111
|
*/
|
|
5112
|
-
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5112
|
+
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5113
5113
|
/**
|
|
5114
5114
|
* 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.
|
|
5115
5115
|
* @summary Description
|
|
@@ -5118,7 +5118,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5118
5118
|
* @param {*} [options] Override http request option.
|
|
5119
5119
|
* @throws {RequiredError}
|
|
5120
5120
|
*/
|
|
5121
|
-
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
5121
|
+
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ControllerDescription, any>>;
|
|
5122
5122
|
/**
|
|
5123
5123
|
* 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.
|
|
5124
5124
|
* @summary Coordinate System
|
|
@@ -5129,7 +5129,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5129
5129
|
* @param {*} [options] Override http request option.
|
|
5130
5130
|
* @throws {RequiredError}
|
|
5131
5131
|
*/
|
|
5132
|
-
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
5132
|
+
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
5133
5133
|
/**
|
|
5134
5134
|
* Get the current state of a robot controller.
|
|
5135
5135
|
* @summary State
|
|
@@ -5138,7 +5138,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5138
5138
|
* @param {*} [options] Override http request option.
|
|
5139
5139
|
* @throws {RequiredError}
|
|
5140
5140
|
*/
|
|
5141
|
-
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
5141
|
+
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
5142
5142
|
/**
|
|
5143
5143
|
* Get the configuration for a robot controller.
|
|
5144
5144
|
* @summary Robot Controller
|
|
@@ -5147,7 +5147,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5147
5147
|
* @param {*} [options] Override http request option.
|
|
5148
5148
|
* @throws {RequiredError}
|
|
5149
5149
|
*/
|
|
5150
|
-
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
5150
|
+
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
|
|
5151
5151
|
/**
|
|
5152
5152
|
* 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.
|
|
5153
5153
|
* @summary Virtual Controller Configuration
|
|
@@ -5156,7 +5156,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5156
5156
|
* @param {*} [options] Override http request option.
|
|
5157
5157
|
* @throws {RequiredError}
|
|
5158
5158
|
*/
|
|
5159
|
-
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
5159
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
5160
5160
|
/**
|
|
5161
5161
|
* 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.
|
|
5162
5162
|
* @summary List Coordinate Systems
|
|
@@ -5166,7 +5166,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5166
5166
|
* @param {*} [options] Override http request option.
|
|
5167
5167
|
* @throws {RequiredError}
|
|
5168
5168
|
*/
|
|
5169
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
5169
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
5170
5170
|
/**
|
|
5171
5171
|
* List the names of all deployed robot controllers.
|
|
5172
5172
|
* @summary List Robot Controllers
|
|
@@ -5174,7 +5174,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5174
5174
|
* @param {*} [options] Override http request option.
|
|
5175
5175
|
* @throws {RequiredError}
|
|
5176
5176
|
*/
|
|
5177
|
-
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5177
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
5178
5178
|
/**
|
|
5179
5179
|
* 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.
|
|
5180
5180
|
* @summary Set Default Mode
|
|
@@ -5184,7 +5184,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5184
5184
|
* @param {*} [options] Override http request option.
|
|
5185
5185
|
* @throws {RequiredError}
|
|
5186
5186
|
*/
|
|
5187
|
-
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<
|
|
5187
|
+
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5188
5188
|
/**
|
|
5189
5189
|
* <!-- 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.
|
|
5190
5190
|
* @summary Stream Free Drive
|
|
@@ -5194,7 +5194,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5194
5194
|
* @param {*} [options] Override http request option.
|
|
5195
5195
|
* @throws {RequiredError}
|
|
5196
5196
|
*/
|
|
5197
|
-
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5197
|
+
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
5198
5198
|
/**
|
|
5199
5199
|
* <!-- 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.
|
|
5200
5200
|
* @summary Stream State
|
|
@@ -5205,7 +5205,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5205
5205
|
* @param {*} [options] Override http request option.
|
|
5206
5206
|
* @throws {RequiredError}
|
|
5207
5207
|
*/
|
|
5208
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5208
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
5209
5209
|
/**
|
|
5210
5210
|
* 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).
|
|
5211
5211
|
* @summary Update Robot Controller
|
|
@@ -5216,7 +5216,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5216
5216
|
* @param {*} [options] Override http request option.
|
|
5217
5217
|
* @throws {RequiredError}
|
|
5218
5218
|
*/
|
|
5219
|
-
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5219
|
+
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5220
5220
|
}
|
|
5221
5221
|
/**
|
|
5222
5222
|
* ControllerInputsOutputsApi - axios parameter creator
|
|
@@ -5408,7 +5408,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5408
5408
|
* @param {*} [options] Override http request option.
|
|
5409
5409
|
* @throws {RequiredError}
|
|
5410
5410
|
*/
|
|
5411
|
-
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5411
|
+
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
5412
5412
|
/**
|
|
5413
5413
|
* 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).
|
|
5414
5414
|
* @summary Get Input/Output Values
|
|
@@ -5418,7 +5418,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5418
5418
|
* @param {*} [options] Override http request option.
|
|
5419
5419
|
* @throws {RequiredError}
|
|
5420
5420
|
*/
|
|
5421
|
-
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5421
|
+
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
5422
5422
|
/**
|
|
5423
5423
|
* 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.
|
|
5424
5424
|
* @summary Set Output Values
|
|
@@ -5428,7 +5428,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5428
5428
|
* @param {*} [options] Override http request option.
|
|
5429
5429
|
* @throws {RequiredError}
|
|
5430
5430
|
*/
|
|
5431
|
-
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
5431
|
+
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5432
5432
|
/**
|
|
5433
5433
|
* <!-- 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.
|
|
5434
5434
|
* @summary Stream Input/Output Values
|
|
@@ -5438,7 +5438,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5438
5438
|
* @param {*} [options] Override http request option.
|
|
5439
5439
|
* @throws {RequiredError}
|
|
5440
5440
|
*/
|
|
5441
|
-
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5441
|
+
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamIOValuesResponse, any>>;
|
|
5442
5442
|
/**
|
|
5443
5443
|
* 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 ```
|
|
5444
5444
|
* @summary Wait For
|
|
@@ -5448,7 +5448,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5448
5448
|
* @param {*} [options] Override http request option.
|
|
5449
5449
|
* @throws {RequiredError}
|
|
5450
5450
|
*/
|
|
5451
|
-
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5451
|
+
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<boolean, any>>;
|
|
5452
5452
|
}
|
|
5453
5453
|
/**
|
|
5454
5454
|
* JoggingApi - axios parameter creator
|
|
@@ -5508,7 +5508,7 @@ declare class JoggingApi extends BaseAPI {
|
|
|
5508
5508
|
* @param {*} [options] Override http request option.
|
|
5509
5509
|
* @throws {RequiredError}
|
|
5510
5510
|
*/
|
|
5511
|
-
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5511
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteJoggingResponse, any>>;
|
|
5512
5512
|
}
|
|
5513
5513
|
/**
|
|
5514
5514
|
* KinematicsApi - axios parameter creator
|
|
@@ -5591,7 +5591,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
5591
5591
|
* @param {*} [options] Override http request option.
|
|
5592
5592
|
* @throws {RequiredError}
|
|
5593
5593
|
*/
|
|
5594
|
-
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5594
|
+
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ForwardKinematicsResponse, any>>;
|
|
5595
5595
|
/**
|
|
5596
5596
|
* Returns the reachable joint positions for a list of given poses.
|
|
5597
5597
|
* @summary Inverse kinematics
|
|
@@ -5600,7 +5600,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
5600
5600
|
* @param {*} [options] Override http request option.
|
|
5601
5601
|
* @throws {RequiredError}
|
|
5602
5602
|
*/
|
|
5603
|
-
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5603
|
+
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<InverseKinematicsResponse, any>>;
|
|
5604
5604
|
}
|
|
5605
5605
|
/**
|
|
5606
5606
|
* LicenseApi - axios parameter creator
|
|
@@ -5715,28 +5715,28 @@ declare class LicenseApi extends BaseAPI {
|
|
|
5715
5715
|
* @param {*} [options] Override http request option.
|
|
5716
5716
|
* @throws {RequiredError}
|
|
5717
5717
|
*/
|
|
5718
|
-
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5718
|
+
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
5719
5719
|
/**
|
|
5720
5720
|
* Deactivates active license.
|
|
5721
5721
|
* @summary Deactivate license
|
|
5722
5722
|
* @param {*} [options] Override http request option.
|
|
5723
5723
|
* @throws {RequiredError}
|
|
5724
5724
|
*/
|
|
5725
|
-
deactivateLicense(options?: RawAxiosRequestConfig): Promise<
|
|
5725
|
+
deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5726
5726
|
/**
|
|
5727
5727
|
* Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
|
|
5728
5728
|
* @summary Get license
|
|
5729
5729
|
* @param {*} [options] Override http request option.
|
|
5730
5730
|
* @throws {RequiredError}
|
|
5731
5731
|
*/
|
|
5732
|
-
getLicense(options?: RawAxiosRequestConfig): Promise<
|
|
5732
|
+
getLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
5733
5733
|
/**
|
|
5734
5734
|
* 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.
|
|
5735
5735
|
* @summary Get license status
|
|
5736
5736
|
* @param {*} [options] Override http request option.
|
|
5737
5737
|
* @throws {RequiredError}
|
|
5738
5738
|
*/
|
|
5739
|
-
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<
|
|
5739
|
+
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<LicenseStatus, any>>;
|
|
5740
5740
|
}
|
|
5741
5741
|
/**
|
|
5742
5742
|
* MotionGroupApi - axios parameter creator
|
|
@@ -5866,7 +5866,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5866
5866
|
* @param {*} [options] Override http request option.
|
|
5867
5867
|
* @throws {RequiredError}
|
|
5868
5868
|
*/
|
|
5869
|
-
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5869
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
5870
5870
|
/**
|
|
5871
5871
|
* 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.
|
|
5872
5872
|
* @summary Description
|
|
@@ -5876,7 +5876,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5876
5876
|
* @param {*} [options] Override http request option.
|
|
5877
5877
|
* @throws {RequiredError}
|
|
5878
5878
|
*/
|
|
5879
|
-
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
5879
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupDescription, any>>;
|
|
5880
5880
|
/**
|
|
5881
5881
|
* <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
5882
5882
|
* @summary Stream State
|
|
@@ -5888,7 +5888,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5888
5888
|
* @param {*} [options] Override http request option.
|
|
5889
5889
|
* @throws {RequiredError}
|
|
5890
5890
|
*/
|
|
5891
|
-
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5891
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
5892
5892
|
}
|
|
5893
5893
|
/**
|
|
5894
5894
|
* MotionGroupModelsApi - axios parameter creator
|
|
@@ -6037,7 +6037,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
6037
6037
|
* @param {*} [options] Override http request option.
|
|
6038
6038
|
* @throws {RequiredError}
|
|
6039
6039
|
*/
|
|
6040
|
-
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
6040
|
+
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6041
6041
|
[key: string]: Collider;
|
|
6042
6042
|
}[], any>>;
|
|
6043
6043
|
/**
|
|
@@ -6047,7 +6047,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
6047
6047
|
* @param {*} [options] Override http request option.
|
|
6048
6048
|
* @throws {RequiredError}
|
|
6049
6049
|
*/
|
|
6050
|
-
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
6050
|
+
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
6051
6051
|
/**
|
|
6052
6052
|
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
6053
6053
|
* @summary Get Kinematics
|
|
@@ -6055,14 +6055,14 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
6055
6055
|
* @param {*} [options] Override http request option.
|
|
6056
6056
|
* @throws {RequiredError}
|
|
6057
6057
|
*/
|
|
6058
|
-
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
6058
|
+
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<KinematicModel, any>>;
|
|
6059
6059
|
/**
|
|
6060
6060
|
* Returns the list of supported motion group models.
|
|
6061
6061
|
* @summary Motion Group Models
|
|
6062
6062
|
* @param {*} [options] Override http request option.
|
|
6063
6063
|
* @throws {RequiredError}
|
|
6064
6064
|
*/
|
|
6065
|
-
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<
|
|
6065
|
+
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6066
6066
|
/**
|
|
6067
6067
|
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
6068
6068
|
* @summary Download USD Model
|
|
@@ -6070,7 +6070,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
6070
6070
|
* @param {*} [options] Override http request option.
|
|
6071
6071
|
* @throws {RequiredError}
|
|
6072
6072
|
*/
|
|
6073
|
-
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
6073
|
+
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
6074
6074
|
}
|
|
6075
6075
|
/**
|
|
6076
6076
|
* ProgramApi - axios parameter creator
|
|
@@ -6207,7 +6207,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6207
6207
|
* @param {*} [options] Override http request option.
|
|
6208
6208
|
* @throws {RequiredError}
|
|
6209
6209
|
*/
|
|
6210
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
6210
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program, any>>;
|
|
6211
6211
|
/**
|
|
6212
6212
|
* <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
6213
6213
|
* @summary List programs
|
|
@@ -6215,7 +6215,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6215
6215
|
* @param {*} [options] Override http request option.
|
|
6216
6216
|
* @throws {RequiredError}
|
|
6217
6217
|
*/
|
|
6218
|
-
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6218
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program[], any>>;
|
|
6219
6219
|
/**
|
|
6220
6220
|
* <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
6221
6221
|
* @summary Start the program
|
|
@@ -6225,7 +6225,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6225
6225
|
* @param {*} [options] Override http request option.
|
|
6226
6226
|
* @throws {RequiredError}
|
|
6227
6227
|
*/
|
|
6228
|
-
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6228
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
|
|
6229
6229
|
/**
|
|
6230
6230
|
* <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
6231
6231
|
* @summary Stop program run
|
|
@@ -6234,7 +6234,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6234
6234
|
* @param {*} [options] Override http request option.
|
|
6235
6235
|
* @throws {RequiredError}
|
|
6236
6236
|
*/
|
|
6237
|
-
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
6237
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6238
6238
|
}
|
|
6239
6239
|
/**
|
|
6240
6240
|
* RobotConfigurationsApi - axios parameter creator
|
|
@@ -6282,7 +6282,7 @@ declare class RobotConfigurationsApi extends BaseAPI {
|
|
|
6282
6282
|
* @param {*} [options] Override http request option.
|
|
6283
6283
|
* @throws {RequiredError}
|
|
6284
6284
|
*/
|
|
6285
|
-
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<
|
|
6285
|
+
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6286
6286
|
}
|
|
6287
6287
|
/**
|
|
6288
6288
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
@@ -6755,7 +6755,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6755
6755
|
* @param {*} [options] Override http request option.
|
|
6756
6756
|
* @throws {RequiredError}
|
|
6757
6757
|
*/
|
|
6758
|
-
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
6758
|
+
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6759
6759
|
/**
|
|
6760
6760
|
* Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6761
6761
|
* @summary Delete Link Chain
|
|
@@ -6764,7 +6764,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6764
6764
|
* @param {*} [options] Override http request option.
|
|
6765
6765
|
* @throws {RequiredError}
|
|
6766
6766
|
*/
|
|
6767
|
-
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
6767
|
+
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6768
6768
|
/**
|
|
6769
6769
|
* Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6770
6770
|
* @summary Delete Tool
|
|
@@ -6773,7 +6773,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6773
6773
|
* @param {*} [options] Override http request option.
|
|
6774
6774
|
* @throws {RequiredError}
|
|
6775
6775
|
*/
|
|
6776
|
-
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
6776
|
+
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6777
6777
|
/**
|
|
6778
6778
|
* Returns the collider.
|
|
6779
6779
|
* @summary Get Collider
|
|
@@ -6782,7 +6782,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6782
6782
|
* @param {*} [options] Override http request option.
|
|
6783
6783
|
* @throws {RequiredError}
|
|
6784
6784
|
*/
|
|
6785
|
-
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
6785
|
+
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
6786
6786
|
/**
|
|
6787
6787
|
* Returns the collision link chain.
|
|
6788
6788
|
* @summary Get Link Chain
|
|
@@ -6791,7 +6791,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6791
6791
|
* @param {*} [options] Override http request option.
|
|
6792
6792
|
* @throws {RequiredError}
|
|
6793
6793
|
*/
|
|
6794
|
-
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
6794
|
+
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6795
6795
|
[key: string]: Collider;
|
|
6796
6796
|
}[], any>>;
|
|
6797
6797
|
/**
|
|
@@ -6802,7 +6802,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6802
6802
|
* @param {*} [options] Override http request option.
|
|
6803
6803
|
* @throws {RequiredError}
|
|
6804
6804
|
*/
|
|
6805
|
-
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
6805
|
+
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6806
6806
|
[key: string]: Collider;
|
|
6807
6807
|
}, any>>;
|
|
6808
6808
|
/**
|
|
@@ -6812,7 +6812,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6812
6812
|
* @param {*} [options] Override http request option.
|
|
6813
6813
|
* @throws {RequiredError}
|
|
6814
6814
|
*/
|
|
6815
|
-
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6815
|
+
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6816
6816
|
[key: string]: {
|
|
6817
6817
|
[key: string]: Collider;
|
|
6818
6818
|
}[];
|
|
@@ -6824,7 +6824,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6824
6824
|
* @param {*} [options] Override http request option.
|
|
6825
6825
|
* @throws {RequiredError}
|
|
6826
6826
|
*/
|
|
6827
|
-
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6827
|
+
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6828
6828
|
/**
|
|
6829
6829
|
* Returns all stored colliders.
|
|
6830
6830
|
* @summary List Colliders
|
|
@@ -6832,7 +6832,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6832
6832
|
* @param {*} [options] Override http request option.
|
|
6833
6833
|
* @throws {RequiredError}
|
|
6834
6834
|
*/
|
|
6835
|
-
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6835
|
+
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6836
6836
|
[key: string]: Collider;
|
|
6837
6837
|
}, any>>;
|
|
6838
6838
|
/**
|
|
@@ -6842,7 +6842,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6842
6842
|
* @param {*} [options] Override http request option.
|
|
6843
6843
|
* @throws {RequiredError}
|
|
6844
6844
|
*/
|
|
6845
|
-
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6845
|
+
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6846
6846
|
/**
|
|
6847
6847
|
* Returns the list of stored tools.
|
|
6848
6848
|
* @summary List Tools
|
|
@@ -6850,7 +6850,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6850
6850
|
* @param {*} [options] Override http request option.
|
|
6851
6851
|
* @throws {RequiredError}
|
|
6852
6852
|
*/
|
|
6853
|
-
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6853
|
+
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6854
6854
|
[key: string]: {
|
|
6855
6855
|
[key: string]: Collider;
|
|
6856
6856
|
};
|
|
@@ -6862,7 +6862,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6862
6862
|
* @param {*} [options] Override http request option.
|
|
6863
6863
|
* @throws {RequiredError}
|
|
6864
6864
|
*/
|
|
6865
|
-
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6865
|
+
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6866
6866
|
/**
|
|
6867
6867
|
* Stores collider. - If the collider does not exist, it will be created. - If the collider exists, it will be updated.
|
|
6868
6868
|
* @summary Store Collider
|
|
@@ -6872,7 +6872,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6872
6872
|
* @param {*} [options] Override http request option.
|
|
6873
6873
|
* @throws {RequiredError}
|
|
6874
6874
|
*/
|
|
6875
|
-
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<
|
|
6875
|
+
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
6876
6876
|
/**
|
|
6877
6877
|
* Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
|
|
6878
6878
|
* @summary Store Link Chain
|
|
@@ -6884,7 +6884,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6884
6884
|
*/
|
|
6885
6885
|
storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{
|
|
6886
6886
|
[key: string]: Collider;
|
|
6887
|
-
}>, options?: RawAxiosRequestConfig): Promise<
|
|
6887
|
+
}>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6888
6888
|
[key: string]: Collider;
|
|
6889
6889
|
}[], any>>;
|
|
6890
6890
|
/**
|
|
@@ -6898,7 +6898,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6898
6898
|
*/
|
|
6899
6899
|
storeCollisionTool(cell: string, tool: string, requestBody: {
|
|
6900
6900
|
[key: string]: Collider;
|
|
6901
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
6901
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6902
6902
|
[key: string]: Collider;
|
|
6903
6903
|
}, any>>;
|
|
6904
6904
|
}
|
|
@@ -7065,7 +7065,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
7065
7065
|
* @param {*} [options] Override http request option.
|
|
7066
7066
|
* @throws {RequiredError}
|
|
7067
7067
|
*/
|
|
7068
|
-
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7068
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7069
7069
|
/**
|
|
7070
7070
|
* Returns the stored collision setup.
|
|
7071
7071
|
* @summary Get Collision Setup
|
|
@@ -7074,7 +7074,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
7074
7074
|
* @param {*} [options] Override http request option.
|
|
7075
7075
|
* @throws {RequiredError}
|
|
7076
7076
|
*/
|
|
7077
|
-
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7077
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
7078
7078
|
/**
|
|
7079
7079
|
* Returns a list of stored collision setups.
|
|
7080
7080
|
* @summary List Collision Setups
|
|
@@ -7082,7 +7082,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
7082
7082
|
* @param {*} [options] Override http request option.
|
|
7083
7083
|
* @throws {RequiredError}
|
|
7084
7084
|
*/
|
|
7085
|
-
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7085
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
7086
7086
|
[key: string]: CollisionSetup;
|
|
7087
7087
|
}, any>>;
|
|
7088
7088
|
/**
|
|
@@ -7092,7 +7092,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
7092
7092
|
* @param {*} [options] Override http request option.
|
|
7093
7093
|
* @throws {RequiredError}
|
|
7094
7094
|
*/
|
|
7095
|
-
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7095
|
+
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
7096
7096
|
/**
|
|
7097
7097
|
* Stores collision setup. - If the collision setup does not exist, it will be created. - If the collision setup exists, it will be updated.
|
|
7098
7098
|
* @summary Store Collision Setup
|
|
@@ -7102,7 +7102,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
7102
7102
|
* @param {*} [options] Override http request option.
|
|
7103
7103
|
* @throws {RequiredError}
|
|
7104
7104
|
*/
|
|
7105
|
-
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<
|
|
7105
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
7106
7106
|
}
|
|
7107
7107
|
/**
|
|
7108
7108
|
* StoreObjectApi - axios parameter creator
|
|
@@ -7298,7 +7298,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7298
7298
|
* @param {*} [options] Override http request option.
|
|
7299
7299
|
* @throws {RequiredError}
|
|
7300
7300
|
*/
|
|
7301
|
-
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7301
|
+
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7302
7302
|
/**
|
|
7303
7303
|
* Delete an object <!-- theme: danger --> > This will delete persistently stored data.
|
|
7304
7304
|
* @summary Delete Object
|
|
@@ -7307,7 +7307,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7307
7307
|
* @param {*} [options] Override http request option.
|
|
7308
7308
|
* @throws {RequiredError}
|
|
7309
7309
|
*/
|
|
7310
|
-
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7310
|
+
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7311
7311
|
/**
|
|
7312
7312
|
* Returns content and metadata of a stored object.
|
|
7313
7313
|
* @summary Get Object
|
|
@@ -7316,7 +7316,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7316
7316
|
* @param {*} [options] Override http request option.
|
|
7317
7317
|
* @throws {RequiredError}
|
|
7318
7318
|
*/
|
|
7319
|
-
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7319
|
+
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7320
7320
|
/**
|
|
7321
7321
|
* Returns metadata. Object content is not returned.
|
|
7322
7322
|
* @summary Get Object Metadata
|
|
@@ -7325,7 +7325,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7325
7325
|
* @param {*} [options] Override http request option.
|
|
7326
7326
|
* @throws {RequiredError}
|
|
7327
7327
|
*/
|
|
7328
|
-
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7328
|
+
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7329
7329
|
/**
|
|
7330
7330
|
* List the keys for all objects.
|
|
7331
7331
|
* @summary List all Object Keys
|
|
@@ -7333,7 +7333,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7333
7333
|
* @param {*} [options] Override http request option.
|
|
7334
7334
|
* @throws {RequiredError}
|
|
7335
7335
|
*/
|
|
7336
|
-
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7336
|
+
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
7337
7337
|
/**
|
|
7338
7338
|
* 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.
|
|
7339
7339
|
* @summary Store Object
|
|
@@ -7346,7 +7346,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7346
7346
|
*/
|
|
7347
7347
|
storeObject(cell: string, key: string, xMetadata?: {
|
|
7348
7348
|
[key: string]: string;
|
|
7349
|
-
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<
|
|
7349
|
+
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7350
7350
|
}
|
|
7351
7351
|
/**
|
|
7352
7352
|
* SystemApi - axios parameter creator
|
|
@@ -7665,7 +7665,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7665
7665
|
*/
|
|
7666
7666
|
backupConfiguration(resources?: Array<string>, metadata?: {
|
|
7667
7667
|
[key: string]: string;
|
|
7668
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
7668
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7669
7669
|
/**
|
|
7670
7670
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
7671
7671
|
* @summary Check update
|
|
@@ -7673,7 +7673,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7673
7673
|
* @param {*} [options] Override http request option.
|
|
7674
7674
|
* @throws {RequiredError}
|
|
7675
7675
|
*/
|
|
7676
|
-
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
7676
|
+
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
7677
7677
|
/**
|
|
7678
7678
|
* <!-- 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.
|
|
7679
7679
|
* @summary Get ARP-Scan
|
|
@@ -7683,7 +7683,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7683
7683
|
* @param {*} [options] Override http request option.
|
|
7684
7684
|
* @throws {RequiredError}
|
|
7685
7685
|
*/
|
|
7686
|
-
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7686
|
+
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<NetworkDevice[], any>>;
|
|
7687
7687
|
/**
|
|
7688
7688
|
* 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.
|
|
7689
7689
|
* @summary Retrieve Backup Status
|
|
@@ -7691,49 +7691,49 @@ declare class SystemApi extends BaseAPI {
|
|
|
7691
7691
|
* @param {*} [options] Override http request option.
|
|
7692
7692
|
* @throws {RequiredError}
|
|
7693
7693
|
*/
|
|
7694
|
-
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
7694
|
+
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationArchiveStatus, any>>;
|
|
7695
7695
|
/**
|
|
7696
7696
|
* 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.
|
|
7697
7697
|
* @summary Download Diagnosis Package
|
|
7698
7698
|
* @param {*} [options] Override http request option.
|
|
7699
7699
|
* @throws {RequiredError}
|
|
7700
7700
|
*/
|
|
7701
|
-
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<
|
|
7701
|
+
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7702
7702
|
/**
|
|
7703
7703
|
* <!-- theme: danger --> > **Experimental** Get the network interfaces of the system.
|
|
7704
7704
|
* @summary Network Interfaces
|
|
7705
7705
|
* @param {*} [options] Override http request option.
|
|
7706
7706
|
* @throws {RequiredError}
|
|
7707
7707
|
*/
|
|
7708
|
-
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<
|
|
7708
|
+
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<NetworkInterface[], any>>;
|
|
7709
7709
|
/**
|
|
7710
7710
|
* <!-- theme: danger --> > **Experimental** Get the current state of the network.
|
|
7711
7711
|
* @summary Network State
|
|
7712
7712
|
* @param {*} [options] Override http request option.
|
|
7713
7713
|
* @throws {RequiredError}
|
|
7714
7714
|
*/
|
|
7715
|
-
getNetworkState(options?: RawAxiosRequestConfig): Promise<
|
|
7715
|
+
getNetworkState(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<NetworkState, any>>;
|
|
7716
7716
|
/**
|
|
7717
7717
|
* Get the status of all system services.
|
|
7718
7718
|
* @summary Wandelbots NOVA status
|
|
7719
7719
|
* @param {*} [options] Override http request option.
|
|
7720
7720
|
* @throws {RequiredError}
|
|
7721
7721
|
*/
|
|
7722
|
-
getSystemStatus(options?: RawAxiosRequestConfig): Promise<
|
|
7722
|
+
getSystemStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatus[], any>>;
|
|
7723
7723
|
/**
|
|
7724
7724
|
* Get the current Wandelbots NOVA version.
|
|
7725
7725
|
* @summary Wandelbots NOVA Version
|
|
7726
7726
|
* @param {*} [options] Override http request option.
|
|
7727
7727
|
* @throws {RequiredError}
|
|
7728
7728
|
*/
|
|
7729
|
-
getSystemVersion(options?: RawAxiosRequestConfig): Promise<
|
|
7729
|
+
getSystemVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
7730
7730
|
/**
|
|
7731
7731
|
* Retrieves a list of all available configuration resources for backup purposes.
|
|
7732
7732
|
* @summary List Configuration Resources
|
|
7733
7733
|
* @param {*} [options] Override http request option.
|
|
7734
7734
|
* @throws {RequiredError}
|
|
7735
7735
|
*/
|
|
7736
|
-
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<
|
|
7736
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationResource[], any>>;
|
|
7737
7737
|
/**
|
|
7738
7738
|
* Restores a previously backed up configuration. If an empty array of resources is provided, all resources from the backup will be restored.
|
|
7739
7739
|
* @summary Restore Configuration Backup
|
|
@@ -7742,7 +7742,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7742
7742
|
* @param {*} [options] Override http request option.
|
|
7743
7743
|
* @throws {RequiredError}
|
|
7744
7744
|
*/
|
|
7745
|
-
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
7745
|
+
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7746
7746
|
/**
|
|
7747
7747
|
* 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.
|
|
7748
7748
|
* @summary Update Wandelbots NOVA version
|
|
@@ -7750,7 +7750,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7750
7750
|
* @param {*} [options] Override http request option.
|
|
7751
7751
|
* @throws {RequiredError}
|
|
7752
7752
|
*/
|
|
7753
|
-
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7753
|
+
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7754
7754
|
}
|
|
7755
7755
|
/**
|
|
7756
7756
|
* TrajectoryCachingApi - axios parameter creator
|
|
@@ -7924,7 +7924,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7924
7924
|
* @param {*} [options] Override http request option.
|
|
7925
7925
|
* @throws {RequiredError}
|
|
7926
7926
|
*/
|
|
7927
|
-
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7927
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<AddTrajectoryResponse, any>>;
|
|
7928
7928
|
/**
|
|
7929
7929
|
* Clear the trajectory cache.
|
|
7930
7930
|
* @summary Clear Trajectories
|
|
@@ -7933,7 +7933,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7933
7933
|
* @param {*} [options] Override http request option.
|
|
7934
7934
|
* @throws {RequiredError}
|
|
7935
7935
|
*/
|
|
7936
|
-
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7936
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7937
7937
|
/**
|
|
7938
7938
|
* 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.
|
|
7939
7939
|
* @summary Delete Trajectory
|
|
@@ -7943,7 +7943,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7943
7943
|
* @param {*} [options] Override http request option.
|
|
7944
7944
|
* @throws {RequiredError}
|
|
7945
7945
|
*/
|
|
7946
|
-
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
7946
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7947
7947
|
/**
|
|
7948
7948
|
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
7949
7949
|
* @summary Get Trajectory
|
|
@@ -7953,7 +7953,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7953
7953
|
* @param {*} [options] Override http request option.
|
|
7954
7954
|
* @throws {RequiredError}
|
|
7955
7955
|
*/
|
|
7956
|
-
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
7956
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
|
|
7957
7957
|
/**
|
|
7958
7958
|
* 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.
|
|
7959
7959
|
* @summary List Trajectories
|
|
@@ -7962,7 +7962,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7962
7962
|
* @param {*} [options] Override http request option.
|
|
7963
7963
|
* @throws {RequiredError}
|
|
7964
7964
|
*/
|
|
7965
|
-
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7965
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListTrajectoriesResponse, any>>;
|
|
7966
7966
|
}
|
|
7967
7967
|
/**
|
|
7968
7968
|
* TrajectoryExecutionApi - axios parameter creator
|
|
@@ -8022,7 +8022,7 @@ declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
8022
8022
|
* @param {*} [options] Override http request option.
|
|
8023
8023
|
* @throws {RequiredError}
|
|
8024
8024
|
*/
|
|
8025
|
-
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8025
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
8026
8026
|
}
|
|
8027
8027
|
/**
|
|
8028
8028
|
* TrajectoryPlanningApi - axios parameter creator
|
|
@@ -8105,7 +8105,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
8105
8105
|
* @param {*} [options] Override http request option.
|
|
8106
8106
|
* @throws {RequiredError}
|
|
8107
8107
|
*/
|
|
8108
|
-
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8108
|
+
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
|
|
8109
8109
|
/**
|
|
8110
8110
|
* 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.
|
|
8111
8111
|
* @summary Plan Trajectory
|
|
@@ -8114,7 +8114,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
8114
8114
|
* @param {*} [options] Override http request option.
|
|
8115
8115
|
* @throws {RequiredError}
|
|
8116
8116
|
*/
|
|
8117
|
-
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8117
|
+
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
8118
8118
|
}
|
|
8119
8119
|
/**
|
|
8120
8120
|
* VersionApi - axios parameter creator
|
|
@@ -8162,7 +8162,7 @@ declare class VersionApi extends BaseAPI {
|
|
|
8162
8162
|
* @param {*} [options] Override http request option.
|
|
8163
8163
|
* @throws {RequiredError}
|
|
8164
8164
|
*/
|
|
8165
|
-
getApiVersion(options?: RawAxiosRequestConfig): Promise<
|
|
8165
|
+
getApiVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ApiVersion, any>>;
|
|
8166
8166
|
}
|
|
8167
8167
|
/**
|
|
8168
8168
|
* VirtualControllerApi - axios parameter creator
|
|
@@ -8712,7 +8712,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8712
8712
|
* @param {*} [options] Override http request option.
|
|
8713
8713
|
* @throws {RequiredError}
|
|
8714
8714
|
*/
|
|
8715
|
-
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<
|
|
8715
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8716
8716
|
/**
|
|
8717
8717
|
* Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json**: 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): 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.
|
|
8718
8718
|
* @summary Add Motion Group
|
|
@@ -8722,7 +8722,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8722
8722
|
* @param {*} [options] Override http request option.
|
|
8723
8723
|
* @throws {RequiredError}
|
|
8724
8724
|
*/
|
|
8725
|
-
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8725
|
+
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8726
8726
|
/**
|
|
8727
8727
|
* 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.
|
|
8728
8728
|
* @summary Add TCP
|
|
@@ -8734,7 +8734,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8734
8734
|
* @param {*} [options] Override http request option.
|
|
8735
8735
|
* @throws {RequiredError}
|
|
8736
8736
|
*/
|
|
8737
|
-
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<
|
|
8737
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8738
8738
|
/**
|
|
8739
8739
|
* 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.
|
|
8740
8740
|
* @summary Delete Coordinate System
|
|
@@ -8745,7 +8745,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8745
8745
|
* @param {*} [options] Override http request option.
|
|
8746
8746
|
* @throws {RequiredError}
|
|
8747
8747
|
*/
|
|
8748
|
-
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
8748
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8749
8749
|
/**
|
|
8750
8750
|
* 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**.
|
|
8751
8751
|
* @summary Delete Motion Group
|
|
@@ -8755,7 +8755,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8755
8755
|
* @param {*} [options] Override http request option.
|
|
8756
8756
|
* @throws {RequiredError}
|
|
8757
8757
|
*/
|
|
8758
|
-
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8758
|
+
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8759
8759
|
/**
|
|
8760
8760
|
* 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.
|
|
8761
8761
|
* @summary Remove TCP
|
|
@@ -8766,7 +8766,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8766
8766
|
* @param {*} [options] Override http request option.
|
|
8767
8767
|
* @throws {RequiredError}
|
|
8768
8768
|
*/
|
|
8769
|
-
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<
|
|
8769
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8770
8770
|
/**
|
|
8771
8771
|
* 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.
|
|
8772
8772
|
* @summary Get Emergency Stop State
|
|
@@ -8775,7 +8775,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8775
8775
|
* @param {*} [options] Override http request option.
|
|
8776
8776
|
* @throws {RequiredError}
|
|
8777
8777
|
*/
|
|
8778
|
-
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8778
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Flag, any>>;
|
|
8779
8779
|
/**
|
|
8780
8780
|
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8781
8781
|
* @summary Get Motion Group State
|
|
@@ -8785,7 +8785,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8785
8785
|
* @param {*} [options] Override http request option.
|
|
8786
8786
|
* @throws {RequiredError}
|
|
8787
8787
|
*/
|
|
8788
|
-
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8788
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupJoints, any>>;
|
|
8789
8789
|
/**
|
|
8790
8790
|
* Gets information on the motion group.
|
|
8791
8791
|
* @summary Motion Group Description
|
|
@@ -8794,7 +8794,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8794
8794
|
* @param {*} [options] Override http request option.
|
|
8795
8795
|
* @throws {RequiredError}
|
|
8796
8796
|
*/
|
|
8797
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8797
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfo[], any>>;
|
|
8798
8798
|
/**
|
|
8799
8799
|
* 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.
|
|
8800
8800
|
* @summary Get Operation Mode
|
|
@@ -8803,7 +8803,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8803
8803
|
* @param {*} [options] Override http request option.
|
|
8804
8804
|
* @throws {RequiredError}
|
|
8805
8805
|
*/
|
|
8806
|
-
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8806
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<OpMode, any>>;
|
|
8807
8807
|
/**
|
|
8808
8808
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8809
8809
|
* @summary Get Mounting
|
|
@@ -8813,7 +8813,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8813
8813
|
* @param {*} [options] Override http request option.
|
|
8814
8814
|
* @throws {RequiredError}
|
|
8815
8815
|
*/
|
|
8816
|
-
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8816
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
8817
8817
|
/**
|
|
8818
8818
|
* Lists all coordinate systems on the robot controller.
|
|
8819
8819
|
* @summary List Coordinate Systems
|
|
@@ -8822,7 +8822,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8822
8822
|
* @param {*} [options] Override http request option.
|
|
8823
8823
|
* @throws {RequiredError}
|
|
8824
8824
|
*/
|
|
8825
|
-
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8825
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
8826
8826
|
/**
|
|
8827
8827
|
* Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
|
|
8828
8828
|
* @summary List TCPs
|
|
@@ -8832,7 +8832,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8832
8832
|
* @param {*} [options] Override http request option.
|
|
8833
8833
|
* @throws {RequiredError}
|
|
8834
8834
|
*/
|
|
8835
|
-
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8835
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp[], any>>;
|
|
8836
8836
|
/**
|
|
8837
8837
|
* 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.
|
|
8838
8838
|
* @summary Push or Release Emergency Stop
|
|
@@ -8842,7 +8842,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8842
8842
|
* @param {*} [options] Override http request option.
|
|
8843
8843
|
* @throws {RequiredError}
|
|
8844
8844
|
*/
|
|
8845
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
8845
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8846
8846
|
/**
|
|
8847
8847
|
* 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.
|
|
8848
8848
|
* @summary Set Motion Group State
|
|
@@ -8853,7 +8853,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8853
8853
|
* @param {*} [options] Override http request option.
|
|
8854
8854
|
* @throws {RequiredError}
|
|
8855
8855
|
*/
|
|
8856
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<
|
|
8856
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8857
8857
|
/**
|
|
8858
8858
|
* 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.
|
|
8859
8859
|
* @summary Set Operation Mode
|
|
@@ -8863,7 +8863,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8863
8863
|
* @param {*} [options] Override http request option.
|
|
8864
8864
|
* @throws {RequiredError}
|
|
8865
8865
|
*/
|
|
8866
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<
|
|
8866
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8867
8867
|
/**
|
|
8868
8868
|
* 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.
|
|
8869
8869
|
* @summary Set Mounting
|
|
@@ -8874,7 +8874,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8874
8874
|
* @param {*} [options] Override http request option.
|
|
8875
8875
|
* @throws {RequiredError}
|
|
8876
8876
|
*/
|
|
8877
|
-
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
8877
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
8878
8878
|
}
|
|
8879
8879
|
/**
|
|
8880
8880
|
* VirtualControllerBehaviorApi - axios parameter creator
|
|
@@ -9018,7 +9018,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
9018
9018
|
* @param {*} [options] Override http request option.
|
|
9019
9019
|
* @throws {RequiredError}
|
|
9020
9020
|
*/
|
|
9021
|
-
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9021
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExternalJointStreamDatapoint[], any>>;
|
|
9022
9022
|
/**
|
|
9023
9023
|
* Get the cycle time of controller communication in [ms].
|
|
9024
9024
|
* @summary Get Cycle Time
|
|
@@ -9027,7 +9027,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
9027
9027
|
* @param {*} [options] Override http request option.
|
|
9028
9028
|
* @throws {RequiredError}
|
|
9029
9029
|
*/
|
|
9030
|
-
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
9030
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
|
|
9031
9031
|
/**
|
|
9032
9032
|
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
9033
9033
|
* @summary Get Behavior
|
|
@@ -9036,7 +9036,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
9036
9036
|
* @param {*} [options] Override http request option.
|
|
9037
9037
|
* @throws {RequiredError}
|
|
9038
9038
|
*/
|
|
9039
|
-
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
9039
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Behavior, any>>;
|
|
9040
9040
|
/**
|
|
9041
9041
|
* Set virtual controller behavior. See query parameters for details.
|
|
9042
9042
|
* @summary Set Behavior
|
|
@@ -9046,7 +9046,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
9046
9046
|
* @param {*} [options] Override http request option.
|
|
9047
9047
|
* @throws {RequiredError}
|
|
9048
9048
|
*/
|
|
9049
|
-
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<
|
|
9049
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9050
9050
|
}
|
|
9051
9051
|
/**
|
|
9052
9052
|
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
@@ -9175,7 +9175,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
9175
9175
|
* @param {*} [options] Override http request option.
|
|
9176
9176
|
* @throws {RequiredError}
|
|
9177
9177
|
*/
|
|
9178
|
-
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
9178
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
9179
9179
|
/**
|
|
9180
9180
|
* 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.
|
|
9181
9181
|
* @summary List Descriptions
|
|
@@ -9188,7 +9188,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
9188
9188
|
* @param {*} [options] Override http request option.
|
|
9189
9189
|
* @throws {RequiredError}
|
|
9190
9190
|
*/
|
|
9191
|
-
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
9191
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
9192
9192
|
/**
|
|
9193
9193
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
9194
9194
|
* @summary Set Input/Ouput Values
|
|
@@ -9198,7 +9198,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
9198
9198
|
* @param {*} [options] Override http request option.
|
|
9199
9199
|
* @throws {RequiredError}
|
|
9200
9200
|
*/
|
|
9201
|
-
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
9201
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9202
9202
|
}
|
|
9203
9203
|
//#endregion
|
|
9204
9204
|
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, 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, 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, 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 };
|