@wandelbots/nova-api 25.9.0-dev.22 → 25.9.0-dev.24
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 +177 -177
- package/dist/v1/index.d.ts +177 -177
- package/dist/v2/index.d.cts +123 -123
- package/dist/v2/index.d.ts +123 -123
- package/package.json +1 -1
package/dist/v2/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as axios0 from "axios";
|
|
2
2
|
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
3
|
|
|
4
4
|
//#region v2/configuration.d.ts
|
|
@@ -5923,7 +5923,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
5923
5923
|
* @throws {RequiredError}
|
|
5924
5924
|
* @memberof ApplicationApi
|
|
5925
5925
|
*/
|
|
5926
|
-
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5926
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5927
5927
|
/**
|
|
5928
5928
|
* Delete all GUI applications from the cell.
|
|
5929
5929
|
* @summary Clear Applications
|
|
@@ -5933,7 +5933,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
5933
5933
|
* @throws {RequiredError}
|
|
5934
5934
|
* @memberof ApplicationApi
|
|
5935
5935
|
*/
|
|
5936
|
-
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5936
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5937
5937
|
/**
|
|
5938
5938
|
* Delete a GUI application from the cell.
|
|
5939
5939
|
* @summary Delete Application
|
|
@@ -5944,7 +5944,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
5944
5944
|
* @throws {RequiredError}
|
|
5945
5945
|
* @memberof ApplicationApi
|
|
5946
5946
|
*/
|
|
5947
|
-
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5947
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5948
5948
|
/**
|
|
5949
5949
|
* 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](updateApp).
|
|
5950
5950
|
* @summary Configuration
|
|
@@ -5954,7 +5954,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
5954
5954
|
* @throws {RequiredError}
|
|
5955
5955
|
* @memberof ApplicationApi
|
|
5956
5956
|
*/
|
|
5957
|
-
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<
|
|
5957
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
|
|
5958
5958
|
/**
|
|
5959
5959
|
* List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
|
|
5960
5960
|
* @summary List Applications
|
|
@@ -5963,7 +5963,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
5963
5963
|
* @throws {RequiredError}
|
|
5964
5964
|
* @memberof ApplicationApi
|
|
5965
5965
|
*/
|
|
5966
|
-
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5966
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
5967
5967
|
/**
|
|
5968
5968
|
* Update the configuration of a GUI application in the cell.
|
|
5969
5969
|
* @summary Update Configuration
|
|
@@ -5975,7 +5975,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
5975
5975
|
* @throws {RequiredError}
|
|
5976
5976
|
* @memberof ApplicationApi
|
|
5977
5977
|
*/
|
|
5978
|
-
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5978
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5979
5979
|
}
|
|
5980
5980
|
/**
|
|
5981
5981
|
* BUSInputsOutputsApi - axios parameter creator
|
|
@@ -6357,7 +6357,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6357
6357
|
* @throws {RequiredError}
|
|
6358
6358
|
* @memberof BUSInputsOutputsApi
|
|
6359
6359
|
*/
|
|
6360
|
-
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6360
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6361
6361
|
/**
|
|
6362
6362
|
* 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](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](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
|
|
6363
6363
|
* @summary Add PROFINET Input/Output
|
|
@@ -6368,7 +6368,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6368
6368
|
* @throws {RequiredError}
|
|
6369
6369
|
* @memberof BUSInputsOutputsApi
|
|
6370
6370
|
*/
|
|
6371
|
-
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<
|
|
6371
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6372
6372
|
/**
|
|
6373
6373
|
* Remove the BUS inputs/outputs service from the cell.
|
|
6374
6374
|
* @summary Clear Service
|
|
@@ -6378,7 +6378,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6378
6378
|
* @throws {RequiredError}
|
|
6379
6379
|
* @memberof BUSInputsOutputsApi
|
|
6380
6380
|
*/
|
|
6381
|
-
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6381
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6382
6382
|
/**
|
|
6383
6383
|
* Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
6384
6384
|
* @summary Remove PROFINET Input/Ouptut
|
|
@@ -6388,7 +6388,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6388
6388
|
* @throws {RequiredError}
|
|
6389
6389
|
* @memberof BUSInputsOutputsApi
|
|
6390
6390
|
*/
|
|
6391
|
-
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
6391
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6392
6392
|
/**
|
|
6393
6393
|
* Get deployed BUS inputs/outputs service.
|
|
6394
6394
|
* @summary Get Service
|
|
@@ -6397,7 +6397,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6397
6397
|
* @throws {RequiredError}
|
|
6398
6398
|
* @memberof BUSInputsOutputsApi
|
|
6399
6399
|
*/
|
|
6400
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6400
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOType, any>>;
|
|
6401
6401
|
/**
|
|
6402
6402
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
6403
6403
|
* @summary State
|
|
@@ -6406,7 +6406,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6406
6406
|
* @throws {RequiredError}
|
|
6407
6407
|
* @memberof BUSInputsOutputsApi
|
|
6408
6408
|
*/
|
|
6409
|
-
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6409
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOsState, any>>;
|
|
6410
6410
|
/**
|
|
6411
6411
|
* 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](listBusIODescriptions).
|
|
6412
6412
|
* @summary Get Input/Output Values
|
|
@@ -6416,7 +6416,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6416
6416
|
* @throws {RequiredError}
|
|
6417
6417
|
* @memberof BUSInputsOutputsApi
|
|
6418
6418
|
*/
|
|
6419
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
6419
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
6420
6420
|
/**
|
|
6421
6421
|
* Get description of NOVA as a PROFINET device.
|
|
6422
6422
|
* @summary Get PROFINET Description
|
|
@@ -6425,7 +6425,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6425
6425
|
* @throws {RequiredError}
|
|
6426
6426
|
* @memberof BUSInputsOutputsApi
|
|
6427
6427
|
*/
|
|
6428
|
-
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6428
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetDescription, any>>;
|
|
6429
6429
|
/**
|
|
6430
6430
|
* 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.
|
|
6431
6431
|
* @summary PROFINET Inputs/Outputs to File
|
|
@@ -6436,7 +6436,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6436
6436
|
* @throws {RequiredError}
|
|
6437
6437
|
* @memberof BUSInputsOutputsApi
|
|
6438
6438
|
*/
|
|
6439
|
-
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6439
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
6440
6440
|
/**
|
|
6441
6441
|
* 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.
|
|
6442
6442
|
* @summary List Descriptions
|
|
@@ -6445,7 +6445,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6445
6445
|
* @throws {RequiredError}
|
|
6446
6446
|
* @memberof BUSInputsOutputsApi
|
|
6447
6447
|
*/
|
|
6448
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6448
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription2[], any>>;
|
|
6449
6449
|
/**
|
|
6450
6450
|
* 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](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
|
|
6451
6451
|
* @summary List PROFINET Input/Output Configuration
|
|
@@ -6454,7 +6454,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6454
6454
|
* @throws {RequiredError}
|
|
6455
6455
|
* @memberof BUSInputsOutputsApi
|
|
6456
6456
|
*/
|
|
6457
|
-
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6457
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetIO[], any>>;
|
|
6458
6458
|
/**
|
|
6459
6459
|
* 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](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
6460
6460
|
* @summary Set Output Values
|
|
@@ -6464,7 +6464,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6464
6464
|
* @throws {RequiredError}
|
|
6465
6465
|
* @memberof BUSInputsOutputsApi
|
|
6466
6466
|
*/
|
|
6467
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
6467
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6468
6468
|
/**
|
|
6469
6469
|
* 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](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](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 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.
|
|
6470
6470
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
@@ -6474,7 +6474,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6474
6474
|
* @throws {RequiredError}
|
|
6475
6475
|
* @memberof BUSInputsOutputsApi
|
|
6476
6476
|
*/
|
|
6477
|
-
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<
|
|
6477
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6478
6478
|
}
|
|
6479
6479
|
/**
|
|
6480
6480
|
* CellApi - axios parameter creator
|
|
@@ -6690,7 +6690,7 @@ declare class CellApi extends BaseAPI {
|
|
|
6690
6690
|
* @throws {RequiredError}
|
|
6691
6691
|
* @memberof CellApi
|
|
6692
6692
|
*/
|
|
6693
|
-
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6693
|
+
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6694
6694
|
/**
|
|
6695
6695
|
* 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.
|
|
6696
6696
|
* @summary Add Cell
|
|
@@ -6700,7 +6700,7 @@ declare class CellApi extends BaseAPI {
|
|
|
6700
6700
|
* @throws {RequiredError}
|
|
6701
6701
|
* @memberof CellApi
|
|
6702
6702
|
*/
|
|
6703
|
-
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6703
|
+
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6704
6704
|
/**
|
|
6705
6705
|
* List all cell resources.
|
|
6706
6706
|
* @summary Configuration
|
|
@@ -6709,7 +6709,7 @@ declare class CellApi extends BaseAPI {
|
|
|
6709
6709
|
* @throws {RequiredError}
|
|
6710
6710
|
* @memberof CellApi
|
|
6711
6711
|
*/
|
|
6712
|
-
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6712
|
+
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Cell, any>>;
|
|
6713
6713
|
/**
|
|
6714
6714
|
* List the status of all cell resources.
|
|
6715
6715
|
* @summary Service Status
|
|
@@ -6718,7 +6718,7 @@ declare class CellApi extends BaseAPI {
|
|
|
6718
6718
|
* @throws {RequiredError}
|
|
6719
6719
|
* @memberof CellApi
|
|
6720
6720
|
*/
|
|
6721
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6721
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatusResponse, any>>;
|
|
6722
6722
|
/**
|
|
6723
6723
|
* List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
6724
6724
|
* @summary List Cells
|
|
@@ -6726,7 +6726,7 @@ declare class CellApi extends BaseAPI {
|
|
|
6726
6726
|
* @throws {RequiredError}
|
|
6727
6727
|
* @memberof CellApi
|
|
6728
6728
|
*/
|
|
6729
|
-
listCells(options?: RawAxiosRequestConfig): Promise<
|
|
6729
|
+
listCells(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6730
6730
|
/**
|
|
6731
6731
|
* Deactivate or activate the services of a cell.
|
|
6732
6732
|
* @summary Operating State
|
|
@@ -6736,7 +6736,7 @@ declare class CellApi extends BaseAPI {
|
|
|
6736
6736
|
* @throws {RequiredError}
|
|
6737
6737
|
* @memberof CellApi
|
|
6738
6738
|
*/
|
|
6739
|
-
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<
|
|
6739
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6740
6740
|
/**
|
|
6741
6741
|
* Update the definition of the entire Cell.
|
|
6742
6742
|
* @summary Update Configuration
|
|
@@ -6747,7 +6747,7 @@ declare class CellApi extends BaseAPI {
|
|
|
6747
6747
|
* @throws {RequiredError}
|
|
6748
6748
|
* @memberof CellApi
|
|
6749
6749
|
*/
|
|
6750
|
-
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6750
|
+
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6751
6751
|
}
|
|
6752
6752
|
/**
|
|
6753
6753
|
* ControllerApi - axios parameter creator
|
|
@@ -7192,7 +7192,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7192
7192
|
* @throws {RequiredError}
|
|
7193
7193
|
* @memberof ControllerApi
|
|
7194
7194
|
*/
|
|
7195
|
-
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7195
|
+
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7196
7196
|
/**
|
|
7197
7197
|
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
7198
7198
|
* @summary Clear Robot Controllers
|
|
@@ -7202,7 +7202,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7202
7202
|
* @throws {RequiredError}
|
|
7203
7203
|
* @memberof ControllerApi
|
|
7204
7204
|
*/
|
|
7205
|
-
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7205
|
+
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7206
7206
|
/**
|
|
7207
7207
|
* Delete a robot controller from the cell.
|
|
7208
7208
|
* @summary Delete Robot Controller
|
|
@@ -7213,7 +7213,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7213
7213
|
* @throws {RequiredError}
|
|
7214
7214
|
* @memberof ControllerApi
|
|
7215
7215
|
*/
|
|
7216
|
-
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7216
|
+
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7217
7217
|
/**
|
|
7218
7218
|
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
7219
7219
|
* @summary Description
|
|
@@ -7223,7 +7223,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7223
7223
|
* @throws {RequiredError}
|
|
7224
7224
|
* @memberof ControllerApi
|
|
7225
7225
|
*/
|
|
7226
|
-
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7226
|
+
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ControllerDescription, any>>;
|
|
7227
7227
|
/**
|
|
7228
7228
|
* 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.
|
|
7229
7229
|
* @summary Coordinate System
|
|
@@ -7235,7 +7235,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7235
7235
|
* @throws {RequiredError}
|
|
7236
7236
|
* @memberof ControllerApi
|
|
7237
7237
|
*/
|
|
7238
|
-
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
7238
|
+
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
7239
7239
|
/**
|
|
7240
7240
|
* Get the current state of a robot controller.
|
|
7241
7241
|
* @summary State
|
|
@@ -7245,7 +7245,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7245
7245
|
* @throws {RequiredError}
|
|
7246
7246
|
* @memberof ControllerApi
|
|
7247
7247
|
*/
|
|
7248
|
-
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7248
|
+
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
7249
7249
|
/**
|
|
7250
7250
|
* Get the configuration for a robot controller.
|
|
7251
7251
|
* @summary Robot Controller
|
|
@@ -7255,7 +7255,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7255
7255
|
* @throws {RequiredError}
|
|
7256
7256
|
* @memberof ControllerApi
|
|
7257
7257
|
*/
|
|
7258
|
-
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7258
|
+
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
|
|
7259
7259
|
/**
|
|
7260
7260
|
* 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](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.
|
|
7261
7261
|
* @summary Virtual Controller Configuration
|
|
@@ -7265,7 +7265,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7265
7265
|
* @throws {RequiredError}
|
|
7266
7266
|
* @memberof ControllerApi
|
|
7267
7267
|
*/
|
|
7268
|
-
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7268
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
7269
7269
|
/**
|
|
7270
7270
|
* 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.
|
|
7271
7271
|
* @summary List Coordinate Systems
|
|
@@ -7276,7 +7276,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7276
7276
|
* @throws {RequiredError}
|
|
7277
7277
|
* @memberof ControllerApi
|
|
7278
7278
|
*/
|
|
7279
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
7279
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
7280
7280
|
/**
|
|
7281
7281
|
* List the names of all deployed robot controllers.
|
|
7282
7282
|
* @summary List Robot Controllers
|
|
@@ -7285,7 +7285,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7285
7285
|
* @throws {RequiredError}
|
|
7286
7286
|
* @memberof ControllerApi
|
|
7287
7287
|
*/
|
|
7288
|
-
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7288
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
7289
7289
|
/**
|
|
7290
7290
|
* 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](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
7291
7291
|
* @summary Set Default Mode
|
|
@@ -7296,7 +7296,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7296
7296
|
* @throws {RequiredError}
|
|
7297
7297
|
* @memberof ControllerApi
|
|
7298
7298
|
*/
|
|
7299
|
-
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<
|
|
7299
|
+
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7300
7300
|
/**
|
|
7301
7301
|
* <!-- 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](listRobotControllers) to check if the robot controller supports free drive mode.
|
|
7302
7302
|
* @summary Stream Free Drive
|
|
@@ -7307,7 +7307,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7307
7307
|
* @throws {RequiredError}
|
|
7308
7308
|
* @memberof ControllerApi
|
|
7309
7309
|
*/
|
|
7310
|
-
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7310
|
+
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
7311
7311
|
/**
|
|
7312
7312
|
* <!-- 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](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
7313
7313
|
* @summary Stream State
|
|
@@ -7319,7 +7319,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7319
7319
|
* @throws {RequiredError}
|
|
7320
7320
|
* @memberof ControllerApi
|
|
7321
7321
|
*/
|
|
7322
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7322
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
7323
7323
|
/**
|
|
7324
7324
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller.
|
|
7325
7325
|
* @summary Update Robot Controller
|
|
@@ -7331,7 +7331,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7331
7331
|
* @throws {RequiredError}
|
|
7332
7332
|
* @memberof ControllerApi
|
|
7333
7333
|
*/
|
|
7334
|
-
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7334
|
+
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7335
7335
|
}
|
|
7336
7336
|
/**
|
|
7337
7337
|
* ControllerInputsOutputsApi - axios parameter creator
|
|
@@ -7530,7 +7530,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
7530
7530
|
* @throws {RequiredError}
|
|
7531
7531
|
* @memberof ControllerInputsOutputsApi
|
|
7532
7532
|
*/
|
|
7533
|
-
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
7533
|
+
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
7534
7534
|
/**
|
|
7535
7535
|
* 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](listIODescriptions).
|
|
7536
7536
|
* @summary Get Input/Output Values
|
|
@@ -7541,7 +7541,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
7541
7541
|
* @throws {RequiredError}
|
|
7542
7542
|
* @memberof ControllerInputsOutputsApi
|
|
7543
7543
|
*/
|
|
7544
|
-
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
7544
|
+
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
7545
7545
|
/**
|
|
7546
7546
|
* Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](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.
|
|
7547
7547
|
* @summary Set Output Values
|
|
@@ -7552,7 +7552,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
7552
7552
|
* @throws {RequiredError}
|
|
7553
7553
|
* @memberof ControllerInputsOutputsApi
|
|
7554
7554
|
*/
|
|
7555
|
-
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
7555
|
+
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7556
7556
|
/**
|
|
7557
7557
|
* <!-- 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.
|
|
7558
7558
|
* @summary Stream Input/Output Values
|
|
@@ -7563,7 +7563,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
7563
7563
|
* @throws {RequiredError}
|
|
7564
7564
|
* @memberof ControllerInputsOutputsApi
|
|
7565
7565
|
*/
|
|
7566
|
-
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
7566
|
+
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamIOValuesResponse, any>>;
|
|
7567
7567
|
/**
|
|
7568
7568
|
* 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](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 ```
|
|
7569
7569
|
* @summary Wait For
|
|
@@ -7574,7 +7574,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
7574
7574
|
* @throws {RequiredError}
|
|
7575
7575
|
* @memberof ControllerInputsOutputsApi
|
|
7576
7576
|
*/
|
|
7577
|
-
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7577
|
+
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<boolean, any>>;
|
|
7578
7578
|
}
|
|
7579
7579
|
/**
|
|
7580
7580
|
* JoggingApi - axios parameter creator
|
|
@@ -7641,7 +7641,7 @@ declare class JoggingApi extends BaseAPI {
|
|
|
7641
7641
|
* @throws {RequiredError}
|
|
7642
7642
|
* @memberof JoggingApi
|
|
7643
7643
|
*/
|
|
7644
|
-
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7644
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteJoggingResponse, any>>;
|
|
7645
7645
|
}
|
|
7646
7646
|
/**
|
|
7647
7647
|
* KinematicsApi - axios parameter creator
|
|
@@ -7731,7 +7731,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
7731
7731
|
* @throws {RequiredError}
|
|
7732
7732
|
* @memberof KinematicsApi
|
|
7733
7733
|
*/
|
|
7734
|
-
forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7734
|
+
forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ForwardKinematicsResponse, any>>;
|
|
7735
7735
|
/**
|
|
7736
7736
|
* Returns the reachable joint positions for a list of given poses.
|
|
7737
7737
|
* @summary Inverse kinematics
|
|
@@ -7741,7 +7741,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
7741
7741
|
* @throws {RequiredError}
|
|
7742
7742
|
* @memberof KinematicsApi
|
|
7743
7743
|
*/
|
|
7744
|
-
inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7744
|
+
inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<InverseKinematicsResponse, any>>;
|
|
7745
7745
|
}
|
|
7746
7746
|
/**
|
|
7747
7747
|
* LicenseApi - axios parameter creator
|
|
@@ -7863,7 +7863,7 @@ declare class LicenseApi extends BaseAPI {
|
|
|
7863
7863
|
* @throws {RequiredError}
|
|
7864
7864
|
* @memberof LicenseApi
|
|
7865
7865
|
*/
|
|
7866
|
-
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7866
|
+
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
7867
7867
|
/**
|
|
7868
7868
|
* Deactivates active license.
|
|
7869
7869
|
* @summary Deactivate license
|
|
@@ -7871,7 +7871,7 @@ declare class LicenseApi extends BaseAPI {
|
|
|
7871
7871
|
* @throws {RequiredError}
|
|
7872
7872
|
* @memberof LicenseApi
|
|
7873
7873
|
*/
|
|
7874
|
-
deactivateLicense(options?: RawAxiosRequestConfig): Promise<
|
|
7874
|
+
deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7875
7875
|
/**
|
|
7876
7876
|
* Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
|
|
7877
7877
|
* @summary Get license
|
|
@@ -7879,7 +7879,7 @@ declare class LicenseApi extends BaseAPI {
|
|
|
7879
7879
|
* @throws {RequiredError}
|
|
7880
7880
|
* @memberof LicenseApi
|
|
7881
7881
|
*/
|
|
7882
|
-
getLicense(options?: RawAxiosRequestConfig): Promise<
|
|
7882
|
+
getLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
7883
7883
|
/**
|
|
7884
7884
|
* 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.
|
|
7885
7885
|
* @summary Get license status
|
|
@@ -7887,7 +7887,7 @@ declare class LicenseApi extends BaseAPI {
|
|
|
7887
7887
|
* @throws {RequiredError}
|
|
7888
7888
|
* @memberof LicenseApi
|
|
7889
7889
|
*/
|
|
7890
|
-
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<
|
|
7890
|
+
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<LicenseStatus, any>>;
|
|
7891
7891
|
}
|
|
7892
7892
|
/**
|
|
7893
7893
|
* MotionGroupApi - axios parameter creator
|
|
@@ -8024,7 +8024,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
8024
8024
|
* @throws {RequiredError}
|
|
8025
8025
|
* @memberof MotionGroupApi
|
|
8026
8026
|
*/
|
|
8027
|
-
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
8027
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
8028
8028
|
/**
|
|
8029
8029
|
* 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.
|
|
8030
8030
|
* @summary Description
|
|
@@ -8035,7 +8035,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
8035
8035
|
* @throws {RequiredError}
|
|
8036
8036
|
* @memberof MotionGroupApi
|
|
8037
8037
|
*/
|
|
8038
|
-
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8038
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupDescription, any>>;
|
|
8039
8039
|
/**
|
|
8040
8040
|
* <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
8041
8041
|
* @summary Stream State
|
|
@@ -8048,7 +8048,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
8048
8048
|
* @throws {RequiredError}
|
|
8049
8049
|
* @memberof MotionGroupApi
|
|
8050
8050
|
*/
|
|
8051
|
-
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
8051
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
8052
8052
|
}
|
|
8053
8053
|
/**
|
|
8054
8054
|
* MotionGroupModelsApi - axios parameter creator
|
|
@@ -8139,7 +8139,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
8139
8139
|
* @throws {RequiredError}
|
|
8140
8140
|
* @memberof MotionGroupModelsApi
|
|
8141
8141
|
*/
|
|
8142
|
-
getMotionGroupCollisionModel(cell: string, motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
8142
|
+
getMotionGroupCollisionModel(cell: string, motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
8143
8143
|
[key: string]: Collider;
|
|
8144
8144
|
}[], any>>;
|
|
8145
8145
|
/**
|
|
@@ -8150,7 +8150,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
8150
8150
|
* @throws {RequiredError}
|
|
8151
8151
|
* @memberof MotionGroupModelsApi
|
|
8152
8152
|
*/
|
|
8153
|
-
getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8153
|
+
getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
8154
8154
|
}
|
|
8155
8155
|
/**
|
|
8156
8156
|
* ProgramApi - axios parameter creator
|
|
@@ -8294,7 +8294,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8294
8294
|
* @throws {RequiredError}
|
|
8295
8295
|
* @memberof ProgramApi
|
|
8296
8296
|
*/
|
|
8297
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
8297
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program, any>>;
|
|
8298
8298
|
/**
|
|
8299
8299
|
* List details of all existing programs.
|
|
8300
8300
|
* @summary List programs
|
|
@@ -8303,7 +8303,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8303
8303
|
* @throws {RequiredError}
|
|
8304
8304
|
* @memberof ProgramApi
|
|
8305
8305
|
*/
|
|
8306
|
-
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8306
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program[], any>>;
|
|
8307
8307
|
/**
|
|
8308
8308
|
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8309
8309
|
* @summary Start the program
|
|
@@ -8314,7 +8314,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8314
8314
|
* @throws {RequiredError}
|
|
8315
8315
|
* @memberof ProgramApi
|
|
8316
8316
|
*/
|
|
8317
|
-
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8317
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
|
|
8318
8318
|
/**
|
|
8319
8319
|
* Stop a specific program run.
|
|
8320
8320
|
* @summary Stop program run
|
|
@@ -8324,7 +8324,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8324
8324
|
* @throws {RequiredError}
|
|
8325
8325
|
* @memberof ProgramApi
|
|
8326
8326
|
*/
|
|
8327
|
-
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
8327
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8328
8328
|
}
|
|
8329
8329
|
/**
|
|
8330
8330
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
@@ -8732,7 +8732,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8732
8732
|
* @throws {RequiredError}
|
|
8733
8733
|
* @memberof StoreCollisionComponentsApi
|
|
8734
8734
|
*/
|
|
8735
|
-
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
8735
|
+
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8736
8736
|
/**
|
|
8737
8737
|
* Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8738
8738
|
* @summary Delete Link Chain
|
|
@@ -8742,7 +8742,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8742
8742
|
* @throws {RequiredError}
|
|
8743
8743
|
* @memberof StoreCollisionComponentsApi
|
|
8744
8744
|
*/
|
|
8745
|
-
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
8745
|
+
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8746
8746
|
/**
|
|
8747
8747
|
* Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
|
|
8748
8748
|
* @summary Delete Tool
|
|
@@ -8752,7 +8752,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8752
8752
|
* @throws {RequiredError}
|
|
8753
8753
|
* @memberof StoreCollisionComponentsApi
|
|
8754
8754
|
*/
|
|
8755
|
-
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
8755
|
+
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8756
8756
|
/**
|
|
8757
8757
|
* Returns the collider.
|
|
8758
8758
|
* @summary Get Collider
|
|
@@ -8762,7 +8762,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8762
8762
|
* @throws {RequiredError}
|
|
8763
8763
|
* @memberof StoreCollisionComponentsApi
|
|
8764
8764
|
*/
|
|
8765
|
-
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
8765
|
+
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
8766
8766
|
/**
|
|
8767
8767
|
* Returns the collision link chain.
|
|
8768
8768
|
* @summary Get Link Chain
|
|
@@ -8772,7 +8772,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8772
8772
|
* @throws {RequiredError}
|
|
8773
8773
|
* @memberof StoreCollisionComponentsApi
|
|
8774
8774
|
*/
|
|
8775
|
-
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
8775
|
+
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
8776
8776
|
[key: string]: Collider;
|
|
8777
8777
|
}[], any>>;
|
|
8778
8778
|
/**
|
|
@@ -8784,7 +8784,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8784
8784
|
* @throws {RequiredError}
|
|
8785
8785
|
* @memberof StoreCollisionComponentsApi
|
|
8786
8786
|
*/
|
|
8787
|
-
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
8787
|
+
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
8788
8788
|
[key: string]: Collider;
|
|
8789
8789
|
}, any>>;
|
|
8790
8790
|
/**
|
|
@@ -8795,7 +8795,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8795
8795
|
* @throws {RequiredError}
|
|
8796
8796
|
* @memberof StoreCollisionComponentsApi
|
|
8797
8797
|
*/
|
|
8798
|
-
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8798
|
+
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
8799
8799
|
[key: string]: {
|
|
8800
8800
|
[key: string]: Collider;
|
|
8801
8801
|
}[];
|
|
@@ -8808,7 +8808,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8808
8808
|
* @throws {RequiredError}
|
|
8809
8809
|
* @memberof StoreCollisionComponentsApi
|
|
8810
8810
|
*/
|
|
8811
|
-
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8811
|
+
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
8812
8812
|
[key: string]: Collider;
|
|
8813
8813
|
}, any>>;
|
|
8814
8814
|
/**
|
|
@@ -8819,7 +8819,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8819
8819
|
* @throws {RequiredError}
|
|
8820
8820
|
* @memberof StoreCollisionComponentsApi
|
|
8821
8821
|
*/
|
|
8822
|
-
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8822
|
+
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
8823
8823
|
[key: string]: {
|
|
8824
8824
|
[key: string]: Collider;
|
|
8825
8825
|
};
|
|
@@ -8834,7 +8834,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8834
8834
|
* @throws {RequiredError}
|
|
8835
8835
|
* @memberof StoreCollisionComponentsApi
|
|
8836
8836
|
*/
|
|
8837
|
-
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<
|
|
8837
|
+
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
8838
8838
|
/**
|
|
8839
8839
|
* Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
|
|
8840
8840
|
* @summary Store Link Chain
|
|
@@ -8847,7 +8847,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8847
8847
|
*/
|
|
8848
8848
|
storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{
|
|
8849
8849
|
[key: string]: Collider;
|
|
8850
|
-
}>, options?: RawAxiosRequestConfig): Promise<
|
|
8850
|
+
}>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
8851
8851
|
[key: string]: Collider;
|
|
8852
8852
|
}[], any>>;
|
|
8853
8853
|
/**
|
|
@@ -8862,7 +8862,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8862
8862
|
*/
|
|
8863
8863
|
storeCollisionTool(cell: string, tool: string, requestBody: {
|
|
8864
8864
|
[key: string]: Collider;
|
|
8865
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
8865
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
8866
8866
|
[key: string]: Collider;
|
|
8867
8867
|
}, any>>;
|
|
8868
8868
|
}
|
|
@@ -9012,7 +9012,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
9012
9012
|
* @throws {RequiredError}
|
|
9013
9013
|
* @memberof StoreCollisionSetupsApi
|
|
9014
9014
|
*/
|
|
9015
|
-
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
9015
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9016
9016
|
/**
|
|
9017
9017
|
* Returns the stored collision setup.
|
|
9018
9018
|
* @summary Get Collision Setup
|
|
@@ -9022,7 +9022,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
9022
9022
|
* @throws {RequiredError}
|
|
9023
9023
|
* @memberof StoreCollisionSetupsApi
|
|
9024
9024
|
*/
|
|
9025
|
-
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
9025
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
9026
9026
|
/**
|
|
9027
9027
|
* Returns a list of stored collision setups.
|
|
9028
9028
|
* @summary List Collision Setups
|
|
@@ -9031,7 +9031,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
9031
9031
|
* @throws {RequiredError}
|
|
9032
9032
|
* @memberof StoreCollisionSetupsApi
|
|
9033
9033
|
*/
|
|
9034
|
-
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9034
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9035
9035
|
[key: string]: CollisionSetup;
|
|
9036
9036
|
}, any>>;
|
|
9037
9037
|
/**
|
|
@@ -9044,7 +9044,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
9044
9044
|
* @throws {RequiredError}
|
|
9045
9045
|
* @memberof StoreCollisionSetupsApi
|
|
9046
9046
|
*/
|
|
9047
|
-
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<
|
|
9047
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
9048
9048
|
}
|
|
9049
9049
|
/**
|
|
9050
9050
|
* StoreObjectApi - axios parameter creator
|
|
@@ -9247,7 +9247,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
9247
9247
|
* @throws {RequiredError}
|
|
9248
9248
|
* @memberof StoreObjectApi
|
|
9249
9249
|
*/
|
|
9250
|
-
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9250
|
+
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9251
9251
|
/**
|
|
9252
9252
|
* Delete an object <!-- theme: danger --> > This will delete persistently stored data.
|
|
9253
9253
|
* @summary Delete Object
|
|
@@ -9257,7 +9257,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
9257
9257
|
* @throws {RequiredError}
|
|
9258
9258
|
* @memberof StoreObjectApi
|
|
9259
9259
|
*/
|
|
9260
|
-
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
9260
|
+
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9261
9261
|
/**
|
|
9262
9262
|
* Returns content and metadata of a stored object.
|
|
9263
9263
|
* @summary Get Object
|
|
@@ -9267,7 +9267,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
9267
9267
|
* @throws {RequiredError}
|
|
9268
9268
|
* @memberof StoreObjectApi
|
|
9269
9269
|
*/
|
|
9270
|
-
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
9270
|
+
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
9271
9271
|
/**
|
|
9272
9272
|
* Returns metadata. Object content is not returned.
|
|
9273
9273
|
* @summary Get Object Metadata
|
|
@@ -9277,7 +9277,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
9277
9277
|
* @throws {RequiredError}
|
|
9278
9278
|
* @memberof StoreObjectApi
|
|
9279
9279
|
*/
|
|
9280
|
-
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
9280
|
+
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9281
9281
|
/**
|
|
9282
9282
|
* List the keys for all objects.
|
|
9283
9283
|
* @summary List all Object Keys
|
|
@@ -9286,7 +9286,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
9286
9286
|
* @throws {RequiredError}
|
|
9287
9287
|
* @memberof StoreObjectApi
|
|
9288
9288
|
*/
|
|
9289
|
-
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9289
|
+
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
9290
9290
|
/**
|
|
9291
9291
|
* Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
|
|
9292
9292
|
* @summary Store Object
|
|
@@ -9300,7 +9300,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
9300
9300
|
*/
|
|
9301
9301
|
storeObject(cell: string, key: string, xMetadata?: {
|
|
9302
9302
|
[key: string]: string;
|
|
9303
|
-
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<
|
|
9303
|
+
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9304
9304
|
}
|
|
9305
9305
|
/**
|
|
9306
9306
|
* SystemApi - axios parameter creator
|
|
@@ -9554,7 +9554,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
9554
9554
|
*/
|
|
9555
9555
|
backupConfiguration(resources?: Array<string>, metadata?: {
|
|
9556
9556
|
[key: string]: string;
|
|
9557
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
9557
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
9558
9558
|
/**
|
|
9559
9559
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
9560
9560
|
* @summary Check update
|
|
@@ -9563,7 +9563,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
9563
9563
|
* @throws {RequiredError}
|
|
9564
9564
|
* @memberof SystemApi
|
|
9565
9565
|
*/
|
|
9566
|
-
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
9566
|
+
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
9567
9567
|
/**
|
|
9568
9568
|
* 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.
|
|
9569
9569
|
* @summary Retrieve Backup Status
|
|
@@ -9572,7 +9572,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
9572
9572
|
* @throws {RequiredError}
|
|
9573
9573
|
* @memberof SystemApi
|
|
9574
9574
|
*/
|
|
9575
|
-
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
9575
|
+
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationArchiveStatus, any>>;
|
|
9576
9576
|
/**
|
|
9577
9577
|
* 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.
|
|
9578
9578
|
* @summary Download Diagnosis Package
|
|
@@ -9580,7 +9580,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
9580
9580
|
* @throws {RequiredError}
|
|
9581
9581
|
* @memberof SystemApi
|
|
9582
9582
|
*/
|
|
9583
|
-
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<
|
|
9583
|
+
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
9584
9584
|
/**
|
|
9585
9585
|
* Get the status of all system services.
|
|
9586
9586
|
* @summary Wandelbots NOVA status
|
|
@@ -9588,7 +9588,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
9588
9588
|
* @throws {RequiredError}
|
|
9589
9589
|
* @memberof SystemApi
|
|
9590
9590
|
*/
|
|
9591
|
-
getSystemStatus(options?: RawAxiosRequestConfig): Promise<
|
|
9591
|
+
getSystemStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatus[], any>>;
|
|
9592
9592
|
/**
|
|
9593
9593
|
* Get the current Wandelbots NOVA version.
|
|
9594
9594
|
* @summary Wandelbots NOVA Version
|
|
@@ -9596,7 +9596,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
9596
9596
|
* @throws {RequiredError}
|
|
9597
9597
|
* @memberof SystemApi
|
|
9598
9598
|
*/
|
|
9599
|
-
getSystemVersion(options?: RawAxiosRequestConfig): Promise<
|
|
9599
|
+
getSystemVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
9600
9600
|
/**
|
|
9601
9601
|
* Retrieves a list of all available configuration resources for backup purposes.
|
|
9602
9602
|
* @summary List Configuration Resources
|
|
@@ -9604,7 +9604,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
9604
9604
|
* @throws {RequiredError}
|
|
9605
9605
|
* @memberof SystemApi
|
|
9606
9606
|
*/
|
|
9607
|
-
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<
|
|
9607
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationResource[], any>>;
|
|
9608
9608
|
/**
|
|
9609
9609
|
* Restores a previously backed up configuration.
|
|
9610
9610
|
* @summary Restore Configuration Backup
|
|
@@ -9614,7 +9614,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
9614
9614
|
* @throws {RequiredError}
|
|
9615
9615
|
* @memberof SystemApi
|
|
9616
9616
|
*/
|
|
9617
|
-
restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<
|
|
9617
|
+
restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9618
9618
|
/**
|
|
9619
9619
|
* 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.
|
|
9620
9620
|
* @summary Update Wandelbots NOVA version
|
|
@@ -9623,7 +9623,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
9623
9623
|
* @throws {RequiredError}
|
|
9624
9624
|
* @memberof SystemApi
|
|
9625
9625
|
*/
|
|
9626
|
-
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9626
|
+
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9627
9627
|
}
|
|
9628
9628
|
/**
|
|
9629
9629
|
* TrajectoryCachingApi - axios parameter creator
|
|
@@ -9804,7 +9804,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9804
9804
|
* @throws {RequiredError}
|
|
9805
9805
|
* @memberof TrajectoryCachingApi
|
|
9806
9806
|
*/
|
|
9807
|
-
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9807
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<AddTrajectoryResponse, any>>;
|
|
9808
9808
|
/**
|
|
9809
9809
|
* Clear the trajectory cache.
|
|
9810
9810
|
* @summary Clear Trajectories
|
|
@@ -9814,7 +9814,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9814
9814
|
* @throws {RequiredError}
|
|
9815
9815
|
* @memberof TrajectoryCachingApi
|
|
9816
9816
|
*/
|
|
9817
|
-
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
9817
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9818
9818
|
/**
|
|
9819
9819
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
9820
9820
|
* @summary Delete Trajectory
|
|
@@ -9825,7 +9825,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9825
9825
|
* @throws {RequiredError}
|
|
9826
9826
|
* @memberof TrajectoryCachingApi
|
|
9827
9827
|
*/
|
|
9828
|
-
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
9828
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9829
9829
|
/**
|
|
9830
9830
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
9831
9831
|
* @summary Get Trajectory
|
|
@@ -9836,7 +9836,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9836
9836
|
* @throws {RequiredError}
|
|
9837
9837
|
* @memberof TrajectoryCachingApi
|
|
9838
9838
|
*/
|
|
9839
|
-
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
9839
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
|
|
9840
9840
|
/**
|
|
9841
9841
|
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
9842
9842
|
* @summary List Trajectories
|
|
@@ -9846,7 +9846,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9846
9846
|
* @throws {RequiredError}
|
|
9847
9847
|
* @memberof TrajectoryCachingApi
|
|
9848
9848
|
*/
|
|
9849
|
-
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
9849
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListTrajectoriesResponse, any>>;
|
|
9850
9850
|
}
|
|
9851
9851
|
/**
|
|
9852
9852
|
* TrajectoryExecutionApi - axios parameter creator
|
|
@@ -9913,7 +9913,7 @@ declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
9913
9913
|
* @throws {RequiredError}
|
|
9914
9914
|
* @memberof TrajectoryExecutionApi
|
|
9915
9915
|
*/
|
|
9916
|
-
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9916
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
9917
9917
|
}
|
|
9918
9918
|
/**
|
|
9919
9919
|
* TrajectoryPlanningApi - axios parameter creator
|
|
@@ -10003,7 +10003,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
10003
10003
|
* @throws {RequiredError}
|
|
10004
10004
|
* @memberof TrajectoryPlanningApi
|
|
10005
10005
|
*/
|
|
10006
|
-
planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10006
|
+
planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
|
|
10007
10007
|
/**
|
|
10008
10008
|
* 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](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](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.
|
|
10009
10009
|
* @summary Plan Trajectory
|
|
@@ -10013,7 +10013,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
10013
10013
|
* @throws {RequiredError}
|
|
10014
10014
|
* @memberof TrajectoryPlanningApi
|
|
10015
10015
|
*/
|
|
10016
|
-
planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10016
|
+
planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
10017
10017
|
}
|
|
10018
10018
|
/**
|
|
10019
10019
|
* VirtualControllerApi - axios parameter creator
|
|
@@ -10510,7 +10510,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10510
10510
|
* @throws {RequiredError}
|
|
10511
10511
|
* @memberof VirtualControllerApi
|
|
10512
10512
|
*/
|
|
10513
|
-
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<
|
|
10513
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10514
10514
|
/**
|
|
10515
10515
|
* 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.
|
|
10516
10516
|
* @summary Add TCP
|
|
@@ -10523,7 +10523,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10523
10523
|
* @throws {RequiredError}
|
|
10524
10524
|
* @memberof VirtualControllerApi
|
|
10525
10525
|
*/
|
|
10526
|
-
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<
|
|
10526
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10527
10527
|
/**
|
|
10528
10528
|
* 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.
|
|
10529
10529
|
* @summary Delete Coordinate System
|
|
@@ -10535,7 +10535,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10535
10535
|
* @throws {RequiredError}
|
|
10536
10536
|
* @memberof VirtualControllerApi
|
|
10537
10537
|
*/
|
|
10538
|
-
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
10538
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10539
10539
|
/**
|
|
10540
10540
|
* 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.
|
|
10541
10541
|
* @summary Remove TCP
|
|
@@ -10547,7 +10547,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10547
10547
|
* @throws {RequiredError}
|
|
10548
10548
|
* @memberof VirtualControllerApi
|
|
10549
10549
|
*/
|
|
10550
|
-
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<
|
|
10550
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10551
10551
|
/**
|
|
10552
10552
|
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](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.
|
|
10553
10553
|
* @summary Get Emergency Stop State
|
|
@@ -10557,7 +10557,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10557
10557
|
* @throws {RequiredError}
|
|
10558
10558
|
* @memberof VirtualControllerApi
|
|
10559
10559
|
*/
|
|
10560
|
-
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10560
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Flag, any>>;
|
|
10561
10561
|
/**
|
|
10562
10562
|
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
10563
10563
|
* @summary Get Motion Group State
|
|
@@ -10568,7 +10568,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10568
10568
|
* @throws {RequiredError}
|
|
10569
10569
|
* @memberof VirtualControllerApi
|
|
10570
10570
|
*/
|
|
10571
|
-
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
10571
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupJoints, any>>;
|
|
10572
10572
|
/**
|
|
10573
10573
|
* Gets information on the motion group.
|
|
10574
10574
|
* @summary Motion Group Description
|
|
@@ -10578,7 +10578,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10578
10578
|
* @throws {RequiredError}
|
|
10579
10579
|
* @memberof VirtualControllerApi
|
|
10580
10580
|
*/
|
|
10581
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10581
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfo[], any>>;
|
|
10582
10582
|
/**
|
|
10583
10583
|
* Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
10584
10584
|
* @summary Get Operation Mode
|
|
@@ -10588,7 +10588,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10588
10588
|
* @throws {RequiredError}
|
|
10589
10589
|
* @memberof VirtualControllerApi
|
|
10590
10590
|
*/
|
|
10591
|
-
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10591
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<OpMode, any>>;
|
|
10592
10592
|
/**
|
|
10593
10593
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
10594
10594
|
* @summary Get Mounting
|
|
@@ -10599,7 +10599,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10599
10599
|
* @throws {RequiredError}
|
|
10600
10600
|
* @memberof VirtualControllerApi
|
|
10601
10601
|
*/
|
|
10602
|
-
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
10602
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
10603
10603
|
/**
|
|
10604
10604
|
* Lists all coordinate systems on the robot controller.
|
|
10605
10605
|
* @summary List Coordinate Systems
|
|
@@ -10609,7 +10609,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10609
10609
|
* @throws {RequiredError}
|
|
10610
10610
|
* @memberof VirtualControllerApi
|
|
10611
10611
|
*/
|
|
10612
|
-
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10612
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
10613
10613
|
/**
|
|
10614
10614
|
* Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
|
|
10615
10615
|
* @summary List TCPs
|
|
@@ -10620,7 +10620,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10620
10620
|
* @throws {RequiredError}
|
|
10621
10621
|
* @memberof VirtualControllerApi
|
|
10622
10622
|
*/
|
|
10623
|
-
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
10623
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp[], any>>;
|
|
10624
10624
|
/**
|
|
10625
10625
|
* 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](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.
|
|
10626
10626
|
* @summary Push or Release Emergency Stop
|
|
@@ -10631,7 +10631,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10631
10631
|
* @throws {RequiredError}
|
|
10632
10632
|
* @memberof VirtualControllerApi
|
|
10633
10633
|
*/
|
|
10634
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
10634
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10635
10635
|
/**
|
|
10636
10636
|
* 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.
|
|
10637
10637
|
* @summary Set Motion Group State
|
|
@@ -10643,7 +10643,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10643
10643
|
* @throws {RequiredError}
|
|
10644
10644
|
* @memberof VirtualControllerApi
|
|
10645
10645
|
*/
|
|
10646
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<
|
|
10646
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10647
10647
|
/**
|
|
10648
10648
|
* 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](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
10649
10649
|
* @summary Set Operation Mode
|
|
@@ -10654,7 +10654,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10654
10654
|
* @throws {RequiredError}
|
|
10655
10655
|
* @memberof VirtualControllerApi
|
|
10656
10656
|
*/
|
|
10657
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<
|
|
10657
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10658
10658
|
/**
|
|
10659
10659
|
* 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.
|
|
10660
10660
|
* @summary Set Mounting
|
|
@@ -10666,7 +10666,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10666
10666
|
* @throws {RequiredError}
|
|
10667
10667
|
* @memberof VirtualControllerApi
|
|
10668
10668
|
*/
|
|
10669
|
-
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
10669
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
10670
10670
|
}
|
|
10671
10671
|
/**
|
|
10672
10672
|
* VirtualControllerBehaviorApi - axios parameter creator
|
|
@@ -10817,7 +10817,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
10817
10817
|
* @throws {RequiredError}
|
|
10818
10818
|
* @memberof VirtualControllerBehaviorApi
|
|
10819
10819
|
*/
|
|
10820
|
-
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10820
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExternalJointStreamDatapoint[], any>>;
|
|
10821
10821
|
/**
|
|
10822
10822
|
* Get the cycle time of controller communication in [ms].
|
|
10823
10823
|
* @summary Get Cycle Time
|
|
@@ -10827,7 +10827,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
10827
10827
|
* @throws {RequiredError}
|
|
10828
10828
|
* @memberof VirtualControllerBehaviorApi
|
|
10829
10829
|
*/
|
|
10830
|
-
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10830
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
|
|
10831
10831
|
/**
|
|
10832
10832
|
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
10833
10833
|
* @summary Get Behavior
|
|
@@ -10837,7 +10837,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
10837
10837
|
* @throws {RequiredError}
|
|
10838
10838
|
* @memberof VirtualControllerBehaviorApi
|
|
10839
10839
|
*/
|
|
10840
|
-
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10840
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Behavior, any>>;
|
|
10841
10841
|
/**
|
|
10842
10842
|
* Set virtual controller behavior. See query parameters for details.
|
|
10843
10843
|
* @summary Set Behavior
|
|
@@ -10848,7 +10848,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
10848
10848
|
* @throws {RequiredError}
|
|
10849
10849
|
* @memberof VirtualControllerBehaviorApi
|
|
10850
10850
|
*/
|
|
10851
|
-
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<
|
|
10851
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10852
10852
|
}
|
|
10853
10853
|
/**
|
|
10854
10854
|
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
@@ -10984,7 +10984,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
10984
10984
|
* @throws {RequiredError}
|
|
10985
10985
|
* @memberof VirtualControllerInputsOutputsApi
|
|
10986
10986
|
*/
|
|
10987
|
-
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
10987
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
10988
10988
|
/**
|
|
10989
10989
|
* 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.
|
|
10990
10990
|
* @summary List Descriptions
|
|
@@ -10998,7 +10998,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
10998
10998
|
* @throws {RequiredError}
|
|
10999
10999
|
* @memberof VirtualControllerInputsOutputsApi
|
|
11000
11000
|
*/
|
|
11001
|
-
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
11001
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
11002
11002
|
/**
|
|
11003
11003
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
11004
11004
|
* @summary Set Input/Ouput Values
|
|
@@ -11009,7 +11009,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
11009
11009
|
* @throws {RequiredError}
|
|
11010
11010
|
* @memberof VirtualControllerInputsOutputsApi
|
|
11011
11011
|
*/
|
|
11012
|
-
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
11012
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
11013
11013
|
}
|
|
11014
11014
|
//#endregion
|
|
11015
11015
|
export { AbbController, AbbControllerEgmServer, AbbControllerKindEnum, ActivateLicenseRequest, AddTrajectoryError, AddTrajectoryErrorData, AddTrajectoryRequest, AddTrajectoryResponse, App, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAuto, BlendingAutoBlendingNameEnum, BlendingPosition, BlendingPositionBlendingNameEnum, BooleanValue, BooleanValueValueTypeEnum, Box, BoxBoxTypeEnum, BoxShapeTypeEnum, 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, 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, HTTPValidationError2, IOBooleanValue, IOBooleanValueValueTypeEnum, IODescription, IODescription2, IODescriptionMin, IODirection, IOFloatValue, IOFloatValueValueTypeEnum, IOIntegerValue, IOIntegerValueValueTypeEnum, IOOrigin, IOValue, IOValueType, ImageCredentials, InconsitentTrajectorySize, InconsitentTrajectorySizeInconsistentTrajectorySize, InitializeJoggingRequest, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponse, InitializeJoggingResponseKindEnum, InitializeMovementRequest, InitializeMovementRequestMessageTypeEnum, InitializeMovementRequestTrajectory, InitializeMovementResponse, InitializeMovementResponseKindEnum, IntegerValue, IntegerValueValueTypeEnum, InvalidDof, InvalidDofInvalidDof, InverseKinematics422Response, InverseKinematicsRequest, InverseKinematicsResponse, InverseKinematicsValidationError, InverseKinematicsValidationErrorAllOfData, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetails, JoggingDetailsKindEnum, JoggingDetailsState, JoggingPausedByUser, JoggingPausedByUserKindEnum, JoggingPausedNearCollision, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimit, JoggingPausedNearJointLimitKindEnum, JoggingPausedOnIO, JoggingPausedOnIOKindEnum, JoggingRunning, JoggingRunningKindEnum, JointLimitExceeded, JointLimits, JointTrajectory, JointVelocityRequest, JointVelocityRequestMessageTypeEnum, JointVelocityResponse, JointVelocityResponseKindEnum, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaController, KukaControllerKindEnum, KukaControllerRsiServer, License, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatus, LicenseStatusEnum, LimitRange, LimitSet, LimitsOverride, ListTrajectoriesResponse, Manufacturer, MidpointInsertionAlgorithm, MidpointInsertionAlgorithmAlgorithmNameEnum, ModelError, MotionCommand, MotionCommandBlending, MotionCommandPath, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupDescription, MotionGroupInfo, MotionGroupJoints, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MotionGroupSetup, MotionGroupState, MotionGroupStateJointLimitReached, MovementErrorResponse, MovementErrorResponseKindEnum, NanValue, NanValueNanValue, 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, 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, TcpRequired, TcpVelocityRequest, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponse, TcpVelocityResponseKindEnum, TorqueExceeded, TorqueExceededTorqueExceeded, 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, UpdateNovaVersionRequest, ValidationError, ValidationError2, ValidationErrorLocInner, VirtualController, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, VirtualControllerTypes, VirtualRobotConfiguration, WaitForIOEventRequest, YaskawaController, YaskawaControllerKindEnum, operationServerMap };
|