@wandelbots/nova-api 25.9.0-dev.34 → 25.9.0-dev.36
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.ts +177 -177
- package/dist/v2/index.cjs +8 -4
- package/dist/v2/index.d.cts +32 -32
- package/dist/v2/index.d.ts +158 -158
- package/dist/v2/index.js +8 -4
- package/package.json +1 -1
package/dist/v2/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as axios0 from "axios";
|
|
2
2
|
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
3
|
|
|
4
4
|
//#region v2/configuration.d.ts
|
|
@@ -6181,7 +6181,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
6181
6181
|
* @throws {RequiredError}
|
|
6182
6182
|
* @memberof ApplicationApi
|
|
6183
6183
|
*/
|
|
6184
|
-
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6184
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6185
6185
|
/**
|
|
6186
6186
|
* Delete all GUI applications from the cell.
|
|
6187
6187
|
* @summary Clear Applications
|
|
@@ -6191,7 +6191,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
6191
6191
|
* @throws {RequiredError}
|
|
6192
6192
|
* @memberof ApplicationApi
|
|
6193
6193
|
*/
|
|
6194
|
-
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6194
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6195
6195
|
/**
|
|
6196
6196
|
* Delete a GUI application from the cell.
|
|
6197
6197
|
* @summary Delete Application
|
|
@@ -6202,7 +6202,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
6202
6202
|
* @throws {RequiredError}
|
|
6203
6203
|
* @memberof ApplicationApi
|
|
6204
6204
|
*/
|
|
6205
|
-
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6205
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6206
6206
|
/**
|
|
6207
6207
|
* 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).
|
|
6208
6208
|
* @summary Configuration
|
|
@@ -6212,7 +6212,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
6212
6212
|
* @throws {RequiredError}
|
|
6213
6213
|
* @memberof ApplicationApi
|
|
6214
6214
|
*/
|
|
6215
|
-
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<
|
|
6215
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
|
|
6216
6216
|
/**
|
|
6217
6217
|
* 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.
|
|
6218
6218
|
* @summary List Applications
|
|
@@ -6221,7 +6221,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
6221
6221
|
* @throws {RequiredError}
|
|
6222
6222
|
* @memberof ApplicationApi
|
|
6223
6223
|
*/
|
|
6224
|
-
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6224
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6225
6225
|
/**
|
|
6226
6226
|
* Update the configuration of a GUI application in the cell.
|
|
6227
6227
|
* @summary Update Configuration
|
|
@@ -6233,7 +6233,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
6233
6233
|
* @throws {RequiredError}
|
|
6234
6234
|
* @memberof ApplicationApi
|
|
6235
6235
|
*/
|
|
6236
|
-
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6236
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6237
6237
|
}
|
|
6238
6238
|
/**
|
|
6239
6239
|
* BUSInputsOutputsApi - axios parameter creator
|
|
@@ -6696,7 +6696,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6696
6696
|
* @throws {RequiredError}
|
|
6697
6697
|
* @memberof BUSInputsOutputsApi
|
|
6698
6698
|
*/
|
|
6699
|
-
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6699
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6700
6700
|
/**
|
|
6701
6701
|
* Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](listModbusIOs).
|
|
6702
6702
|
* @summary Add MODBUS Input/Output
|
|
@@ -6707,7 +6707,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6707
6707
|
* @throws {RequiredError}
|
|
6708
6708
|
* @memberof BUSInputsOutputsApi
|
|
6709
6709
|
*/
|
|
6710
|
-
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<
|
|
6710
|
+
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6711
6711
|
/**
|
|
6712
6712
|
* 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).
|
|
6713
6713
|
* @summary Add PROFINET Input/Output
|
|
@@ -6718,7 +6718,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6718
6718
|
* @throws {RequiredError}
|
|
6719
6719
|
* @memberof BUSInputsOutputsApi
|
|
6720
6720
|
*/
|
|
6721
|
-
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<
|
|
6721
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6722
6722
|
/**
|
|
6723
6723
|
* Remove the BUS inputs/outputs service from the cell.
|
|
6724
6724
|
* @summary Clear Service
|
|
@@ -6728,7 +6728,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6728
6728
|
* @throws {RequiredError}
|
|
6729
6729
|
* @memberof BUSInputsOutputsApi
|
|
6730
6730
|
*/
|
|
6731
|
-
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6731
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6732
6732
|
/**
|
|
6733
6733
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
6734
6734
|
* @summary Remove MODBUS Input/Ouptut
|
|
@@ -6738,7 +6738,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6738
6738
|
* @throws {RequiredError}
|
|
6739
6739
|
* @memberof BUSInputsOutputsApi
|
|
6740
6740
|
*/
|
|
6741
|
-
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
6741
|
+
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6742
6742
|
/**
|
|
6743
6743
|
* Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
6744
6744
|
* @summary Remove PROFINET Input/Ouptut
|
|
@@ -6748,7 +6748,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6748
6748
|
* @throws {RequiredError}
|
|
6749
6749
|
* @memberof BUSInputsOutputsApi
|
|
6750
6750
|
*/
|
|
6751
|
-
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
6751
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6752
6752
|
/**
|
|
6753
6753
|
* Get deployed BUS inputs/outputs service.
|
|
6754
6754
|
* @summary Get Service
|
|
@@ -6757,7 +6757,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6757
6757
|
* @throws {RequiredError}
|
|
6758
6758
|
* @memberof BUSInputsOutputsApi
|
|
6759
6759
|
*/
|
|
6760
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6760
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOType, any>>;
|
|
6761
6761
|
/**
|
|
6762
6762
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
6763
6763
|
* @summary State
|
|
@@ -6766,7 +6766,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6766
6766
|
* @throws {RequiredError}
|
|
6767
6767
|
* @memberof BUSInputsOutputsApi
|
|
6768
6768
|
*/
|
|
6769
|
-
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6769
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOsState, any>>;
|
|
6770
6770
|
/**
|
|
6771
6771
|
* 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).
|
|
6772
6772
|
* @summary Get Input/Output Values
|
|
@@ -6776,7 +6776,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6776
6776
|
* @throws {RequiredError}
|
|
6777
6777
|
* @memberof BUSInputsOutputsApi
|
|
6778
6778
|
*/
|
|
6779
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
6779
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
6780
6780
|
/**
|
|
6781
6781
|
* Get description of NOVA as a PROFINET device.
|
|
6782
6782
|
* @summary Get PROFINET Description
|
|
@@ -6785,7 +6785,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6785
6785
|
* @throws {RequiredError}
|
|
6786
6786
|
* @memberof BUSInputsOutputsApi
|
|
6787
6787
|
*/
|
|
6788
|
-
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6788
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetDescription, any>>;
|
|
6789
6789
|
/**
|
|
6790
6790
|
* 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.
|
|
6791
6791
|
* @summary PROFINET Inputs/Outputs to File
|
|
@@ -6796,7 +6796,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6796
6796
|
* @throws {RequiredError}
|
|
6797
6797
|
* @memberof BUSInputsOutputsApi
|
|
6798
6798
|
*/
|
|
6799
|
-
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6799
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
6800
6800
|
/**
|
|
6801
6801
|
* 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.
|
|
6802
6802
|
* @summary List Descriptions
|
|
@@ -6805,7 +6805,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6805
6805
|
* @throws {RequiredError}
|
|
6806
6806
|
* @memberof BUSInputsOutputsApi
|
|
6807
6807
|
*/
|
|
6808
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6808
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription2[], any>>;
|
|
6809
6809
|
/**
|
|
6810
6810
|
* List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller as well as NOVA\'s MODBUS service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](addModbusIO).
|
|
6811
6811
|
* @summary List MODBUS Input/Output Configuration
|
|
@@ -6814,7 +6814,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6814
6814
|
* @throws {RequiredError}
|
|
6815
6815
|
* @memberof BUSInputsOutputsApi
|
|
6816
6816
|
*/
|
|
6817
|
-
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6817
|
+
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ModbusIO[], any>>;
|
|
6818
6818
|
/**
|
|
6819
6819
|
* 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.
|
|
6820
6820
|
* @summary List PROFINET Input/Output Configuration
|
|
@@ -6823,7 +6823,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6823
6823
|
* @throws {RequiredError}
|
|
6824
6824
|
* @memberof BUSInputsOutputsApi
|
|
6825
6825
|
*/
|
|
6826
|
-
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6826
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetIO[], any>>;
|
|
6827
6827
|
/**
|
|
6828
6828
|
* 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.
|
|
6829
6829
|
* @summary Set Output Values
|
|
@@ -6833,7 +6833,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6833
6833
|
* @throws {RequiredError}
|
|
6834
6834
|
* @memberof BUSInputsOutputsApi
|
|
6835
6835
|
*/
|
|
6836
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
6836
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6837
6837
|
/**
|
|
6838
6838
|
* 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.
|
|
6839
6839
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
@@ -6843,7 +6843,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
6843
6843
|
* @throws {RequiredError}
|
|
6844
6844
|
* @memberof BUSInputsOutputsApi
|
|
6845
6845
|
*/
|
|
6846
|
-
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<
|
|
6846
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6847
6847
|
}
|
|
6848
6848
|
/**
|
|
6849
6849
|
* CellApi - axios parameter creator
|
|
@@ -7059,7 +7059,7 @@ declare class CellApi extends BaseAPI {
|
|
|
7059
7059
|
* @throws {RequiredError}
|
|
7060
7060
|
* @memberof CellApi
|
|
7061
7061
|
*/
|
|
7062
|
-
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7062
|
+
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7063
7063
|
/**
|
|
7064
7064
|
* 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.
|
|
7065
7065
|
* @summary Add Cell
|
|
@@ -7069,7 +7069,7 @@ declare class CellApi extends BaseAPI {
|
|
|
7069
7069
|
* @throws {RequiredError}
|
|
7070
7070
|
* @memberof CellApi
|
|
7071
7071
|
*/
|
|
7072
|
-
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7072
|
+
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7073
7073
|
/**
|
|
7074
7074
|
* List all cell resources.
|
|
7075
7075
|
* @summary Configuration
|
|
@@ -7078,7 +7078,7 @@ declare class CellApi extends BaseAPI {
|
|
|
7078
7078
|
* @throws {RequiredError}
|
|
7079
7079
|
* @memberof CellApi
|
|
7080
7080
|
*/
|
|
7081
|
-
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7081
|
+
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Cell, any>>;
|
|
7082
7082
|
/**
|
|
7083
7083
|
* List the status of all cell resources.
|
|
7084
7084
|
* @summary Service Status
|
|
@@ -7087,7 +7087,7 @@ declare class CellApi extends BaseAPI {
|
|
|
7087
7087
|
* @throws {RequiredError}
|
|
7088
7088
|
* @memberof CellApi
|
|
7089
7089
|
*/
|
|
7090
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7090
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatusResponse, any>>;
|
|
7091
7091
|
/**
|
|
7092
7092
|
* List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
7093
7093
|
* @summary List Cells
|
|
@@ -7095,7 +7095,7 @@ declare class CellApi extends BaseAPI {
|
|
|
7095
7095
|
* @throws {RequiredError}
|
|
7096
7096
|
* @memberof CellApi
|
|
7097
7097
|
*/
|
|
7098
|
-
listCells(options?: RawAxiosRequestConfig): Promise<
|
|
7098
|
+
listCells(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
7099
7099
|
/**
|
|
7100
7100
|
* Deactivate or activate the services of a cell.
|
|
7101
7101
|
* @summary Operating State
|
|
@@ -7105,7 +7105,7 @@ declare class CellApi extends BaseAPI {
|
|
|
7105
7105
|
* @throws {RequiredError}
|
|
7106
7106
|
* @memberof CellApi
|
|
7107
7107
|
*/
|
|
7108
|
-
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<
|
|
7108
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7109
7109
|
/**
|
|
7110
7110
|
* Update the definition of the entire Cell.
|
|
7111
7111
|
* @summary Update Configuration
|
|
@@ -7116,7 +7116,7 @@ declare class CellApi extends BaseAPI {
|
|
|
7116
7116
|
* @throws {RequiredError}
|
|
7117
7117
|
* @memberof CellApi
|
|
7118
7118
|
*/
|
|
7119
|
-
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7119
|
+
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7120
7120
|
}
|
|
7121
7121
|
/**
|
|
7122
7122
|
* ControllerApi - axios parameter creator
|
|
@@ -7561,7 +7561,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7561
7561
|
* @throws {RequiredError}
|
|
7562
7562
|
* @memberof ControllerApi
|
|
7563
7563
|
*/
|
|
7564
|
-
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7564
|
+
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7565
7565
|
/**
|
|
7566
7566
|
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
7567
7567
|
* @summary Clear Robot Controllers
|
|
@@ -7571,7 +7571,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7571
7571
|
* @throws {RequiredError}
|
|
7572
7572
|
* @memberof ControllerApi
|
|
7573
7573
|
*/
|
|
7574
|
-
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7574
|
+
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7575
7575
|
/**
|
|
7576
7576
|
* Delete a robot controller from the cell.
|
|
7577
7577
|
* @summary Delete Robot Controller
|
|
@@ -7582,7 +7582,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7582
7582
|
* @throws {RequiredError}
|
|
7583
7583
|
* @memberof ControllerApi
|
|
7584
7584
|
*/
|
|
7585
|
-
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7585
|
+
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7586
7586
|
/**
|
|
7587
7587
|
* 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.
|
|
7588
7588
|
* @summary Description
|
|
@@ -7592,7 +7592,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7592
7592
|
* @throws {RequiredError}
|
|
7593
7593
|
* @memberof ControllerApi
|
|
7594
7594
|
*/
|
|
7595
|
-
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7595
|
+
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ControllerDescription, any>>;
|
|
7596
7596
|
/**
|
|
7597
7597
|
* 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.
|
|
7598
7598
|
* @summary Coordinate System
|
|
@@ -7604,7 +7604,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7604
7604
|
* @throws {RequiredError}
|
|
7605
7605
|
* @memberof ControllerApi
|
|
7606
7606
|
*/
|
|
7607
|
-
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
7607
|
+
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
7608
7608
|
/**
|
|
7609
7609
|
* Get the current state of a robot controller.
|
|
7610
7610
|
* @summary State
|
|
@@ -7614,7 +7614,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7614
7614
|
* @throws {RequiredError}
|
|
7615
7615
|
* @memberof ControllerApi
|
|
7616
7616
|
*/
|
|
7617
|
-
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7617
|
+
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
7618
7618
|
/**
|
|
7619
7619
|
* Get the configuration for a robot controller.
|
|
7620
7620
|
* @summary Robot Controller
|
|
@@ -7624,7 +7624,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7624
7624
|
* @throws {RequiredError}
|
|
7625
7625
|
* @memberof ControllerApi
|
|
7626
7626
|
*/
|
|
7627
|
-
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7627
|
+
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
|
|
7628
7628
|
/**
|
|
7629
7629
|
* 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.
|
|
7630
7630
|
* @summary Virtual Controller Configuration
|
|
@@ -7634,7 +7634,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7634
7634
|
* @throws {RequiredError}
|
|
7635
7635
|
* @memberof ControllerApi
|
|
7636
7636
|
*/
|
|
7637
|
-
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7637
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
7638
7638
|
/**
|
|
7639
7639
|
* 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.
|
|
7640
7640
|
* @summary List Coordinate Systems
|
|
@@ -7645,7 +7645,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7645
7645
|
* @throws {RequiredError}
|
|
7646
7646
|
* @memberof ControllerApi
|
|
7647
7647
|
*/
|
|
7648
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
7648
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
7649
7649
|
/**
|
|
7650
7650
|
* List the names of all deployed robot controllers.
|
|
7651
7651
|
* @summary List Robot Controllers
|
|
@@ -7654,7 +7654,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7654
7654
|
* @throws {RequiredError}
|
|
7655
7655
|
* @memberof ControllerApi
|
|
7656
7656
|
*/
|
|
7657
|
-
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7657
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
7658
7658
|
/**
|
|
7659
7659
|
* 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.
|
|
7660
7660
|
* @summary Set Default Mode
|
|
@@ -7665,7 +7665,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7665
7665
|
* @throws {RequiredError}
|
|
7666
7666
|
* @memberof ControllerApi
|
|
7667
7667
|
*/
|
|
7668
|
-
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<
|
|
7668
|
+
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7669
7669
|
/**
|
|
7670
7670
|
* <!-- 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.
|
|
7671
7671
|
* @summary Stream Free Drive
|
|
@@ -7676,7 +7676,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7676
7676
|
* @throws {RequiredError}
|
|
7677
7677
|
* @memberof ControllerApi
|
|
7678
7678
|
*/
|
|
7679
|
-
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7679
|
+
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
7680
7680
|
/**
|
|
7681
7681
|
* <!-- 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.
|
|
7682
7682
|
* @summary Stream State
|
|
@@ -7688,7 +7688,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7688
7688
|
* @throws {RequiredError}
|
|
7689
7689
|
* @memberof ControllerApi
|
|
7690
7690
|
*/
|
|
7691
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7691
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
7692
7692
|
/**
|
|
7693
7693
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
|
|
7694
7694
|
* @summary Update Robot Controller
|
|
@@ -7700,7 +7700,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
7700
7700
|
* @throws {RequiredError}
|
|
7701
7701
|
* @memberof ControllerApi
|
|
7702
7702
|
*/
|
|
7703
|
-
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7703
|
+
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7704
7704
|
}
|
|
7705
7705
|
/**
|
|
7706
7706
|
* ControllerInputsOutputsApi - axios parameter creator
|
|
@@ -7899,7 +7899,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
7899
7899
|
* @throws {RequiredError}
|
|
7900
7900
|
* @memberof ControllerInputsOutputsApi
|
|
7901
7901
|
*/
|
|
7902
|
-
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
7902
|
+
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
7903
7903
|
/**
|
|
7904
7904
|
* 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).
|
|
7905
7905
|
* @summary Get Input/Output Values
|
|
@@ -7910,7 +7910,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
7910
7910
|
* @throws {RequiredError}
|
|
7911
7911
|
* @memberof ControllerInputsOutputsApi
|
|
7912
7912
|
*/
|
|
7913
|
-
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
7913
|
+
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
7914
7914
|
/**
|
|
7915
7915
|
* 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.
|
|
7916
7916
|
* @summary Set Output Values
|
|
@@ -7921,7 +7921,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
7921
7921
|
* @throws {RequiredError}
|
|
7922
7922
|
* @memberof ControllerInputsOutputsApi
|
|
7923
7923
|
*/
|
|
7924
|
-
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
7924
|
+
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7925
7925
|
/**
|
|
7926
7926
|
* <!-- 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.
|
|
7927
7927
|
* @summary Stream Input/Output Values
|
|
@@ -7932,7 +7932,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
7932
7932
|
* @throws {RequiredError}
|
|
7933
7933
|
* @memberof ControllerInputsOutputsApi
|
|
7934
7934
|
*/
|
|
7935
|
-
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
7935
|
+
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamIOValuesResponse, any>>;
|
|
7936
7936
|
/**
|
|
7937
7937
|
* 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 ```
|
|
7938
7938
|
* @summary Wait For
|
|
@@ -7943,7 +7943,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
7943
7943
|
* @throws {RequiredError}
|
|
7944
7944
|
* @memberof ControllerInputsOutputsApi
|
|
7945
7945
|
*/
|
|
7946
|
-
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7946
|
+
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<boolean, any>>;
|
|
7947
7947
|
}
|
|
7948
7948
|
/**
|
|
7949
7949
|
* JoggingApi - axios parameter creator
|
|
@@ -8010,7 +8010,7 @@ declare class JoggingApi extends BaseAPI {
|
|
|
8010
8010
|
* @throws {RequiredError}
|
|
8011
8011
|
* @memberof JoggingApi
|
|
8012
8012
|
*/
|
|
8013
|
-
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8013
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteJoggingResponse, any>>;
|
|
8014
8014
|
}
|
|
8015
8015
|
/**
|
|
8016
8016
|
* KinematicsApi - axios parameter creator
|
|
@@ -8021,20 +8021,20 @@ declare const KinematicsApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
8021
8021
|
* Returns the TCP poses for a list of given joint positions.
|
|
8022
8022
|
* @summary Forward kinematics
|
|
8023
8023
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8024
|
-
* @param {ForwardKinematicsRequest}
|
|
8024
|
+
* @param {ForwardKinematicsRequest} forwardKinematicsRequest
|
|
8025
8025
|
* @param {*} [options] Override http request option.
|
|
8026
8026
|
* @throws {RequiredError}
|
|
8027
8027
|
*/
|
|
8028
|
-
forwardKinematics: (cell: string, forwardKinematicsRequest
|
|
8028
|
+
forwardKinematics: (cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8029
8029
|
/**
|
|
8030
8030
|
* Returns the reachable joint positions for a list of given poses.
|
|
8031
8031
|
* @summary Inverse kinematics
|
|
8032
8032
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8033
|
-
* @param {InverseKinematicsRequest}
|
|
8033
|
+
* @param {InverseKinematicsRequest} inverseKinematicsRequest
|
|
8034
8034
|
* @param {*} [options] Override http request option.
|
|
8035
8035
|
* @throws {RequiredError}
|
|
8036
8036
|
*/
|
|
8037
|
-
inverseKinematics: (cell: string, inverseKinematicsRequest
|
|
8037
|
+
inverseKinematics: (cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8038
8038
|
};
|
|
8039
8039
|
/**
|
|
8040
8040
|
* KinematicsApi - functional programming interface
|
|
@@ -8045,20 +8045,20 @@ declare const KinematicsApiFp: (configuration?: Configuration) => {
|
|
|
8045
8045
|
* Returns the TCP poses for a list of given joint positions.
|
|
8046
8046
|
* @summary Forward kinematics
|
|
8047
8047
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8048
|
-
* @param {ForwardKinematicsRequest}
|
|
8048
|
+
* @param {ForwardKinematicsRequest} forwardKinematicsRequest
|
|
8049
8049
|
* @param {*} [options] Override http request option.
|
|
8050
8050
|
* @throws {RequiredError}
|
|
8051
8051
|
*/
|
|
8052
|
-
forwardKinematics(cell: string, forwardKinematicsRequest
|
|
8052
|
+
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForwardKinematicsResponse>>;
|
|
8053
8053
|
/**
|
|
8054
8054
|
* Returns the reachable joint positions for a list of given poses.
|
|
8055
8055
|
* @summary Inverse kinematics
|
|
8056
8056
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8057
|
-
* @param {InverseKinematicsRequest}
|
|
8057
|
+
* @param {InverseKinematicsRequest} inverseKinematicsRequest
|
|
8058
8058
|
* @param {*} [options] Override http request option.
|
|
8059
8059
|
* @throws {RequiredError}
|
|
8060
8060
|
*/
|
|
8061
|
-
inverseKinematics(cell: string, inverseKinematicsRequest
|
|
8061
|
+
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InverseKinematicsResponse>>;
|
|
8062
8062
|
};
|
|
8063
8063
|
/**
|
|
8064
8064
|
* KinematicsApi - factory interface
|
|
@@ -8069,20 +8069,20 @@ declare const KinematicsApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
8069
8069
|
* Returns the TCP poses for a list of given joint positions.
|
|
8070
8070
|
* @summary Forward kinematics
|
|
8071
8071
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8072
|
-
* @param {ForwardKinematicsRequest}
|
|
8072
|
+
* @param {ForwardKinematicsRequest} forwardKinematicsRequest
|
|
8073
8073
|
* @param {*} [options] Override http request option.
|
|
8074
8074
|
* @throws {RequiredError}
|
|
8075
8075
|
*/
|
|
8076
|
-
forwardKinematics(cell: string, forwardKinematicsRequest
|
|
8076
|
+
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForwardKinematicsResponse>;
|
|
8077
8077
|
/**
|
|
8078
8078
|
* Returns the reachable joint positions for a list of given poses.
|
|
8079
8079
|
* @summary Inverse kinematics
|
|
8080
8080
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8081
|
-
* @param {InverseKinematicsRequest}
|
|
8081
|
+
* @param {InverseKinematicsRequest} inverseKinematicsRequest
|
|
8082
8082
|
* @param {*} [options] Override http request option.
|
|
8083
8083
|
* @throws {RequiredError}
|
|
8084
8084
|
*/
|
|
8085
|
-
inverseKinematics(cell: string, inverseKinematicsRequest
|
|
8085
|
+
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InverseKinematicsResponse>;
|
|
8086
8086
|
};
|
|
8087
8087
|
/**
|
|
8088
8088
|
* KinematicsApi - object-oriented interface
|
|
@@ -8095,22 +8095,22 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
8095
8095
|
* Returns the TCP poses for a list of given joint positions.
|
|
8096
8096
|
* @summary Forward kinematics
|
|
8097
8097
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8098
|
-
* @param {ForwardKinematicsRequest}
|
|
8098
|
+
* @param {ForwardKinematicsRequest} forwardKinematicsRequest
|
|
8099
8099
|
* @param {*} [options] Override http request option.
|
|
8100
8100
|
* @throws {RequiredError}
|
|
8101
8101
|
* @memberof KinematicsApi
|
|
8102
8102
|
*/
|
|
8103
|
-
forwardKinematics(cell: string, forwardKinematicsRequest
|
|
8103
|
+
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ForwardKinematicsResponse, any>>;
|
|
8104
8104
|
/**
|
|
8105
8105
|
* Returns the reachable joint positions for a list of given poses.
|
|
8106
8106
|
* @summary Inverse kinematics
|
|
8107
8107
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8108
|
-
* @param {InverseKinematicsRequest}
|
|
8108
|
+
* @param {InverseKinematicsRequest} inverseKinematicsRequest
|
|
8109
8109
|
* @param {*} [options] Override http request option.
|
|
8110
8110
|
* @throws {RequiredError}
|
|
8111
8111
|
* @memberof KinematicsApi
|
|
8112
8112
|
*/
|
|
8113
|
-
inverseKinematics(cell: string, inverseKinematicsRequest
|
|
8113
|
+
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<InverseKinematicsResponse, any>>;
|
|
8114
8114
|
}
|
|
8115
8115
|
/**
|
|
8116
8116
|
* LicenseApi - axios parameter creator
|
|
@@ -8232,7 +8232,7 @@ declare class LicenseApi extends BaseAPI {
|
|
|
8232
8232
|
* @throws {RequiredError}
|
|
8233
8233
|
* @memberof LicenseApi
|
|
8234
8234
|
*/
|
|
8235
|
-
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8235
|
+
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
8236
8236
|
/**
|
|
8237
8237
|
* Deactivates active license.
|
|
8238
8238
|
* @summary Deactivate license
|
|
@@ -8240,7 +8240,7 @@ declare class LicenseApi extends BaseAPI {
|
|
|
8240
8240
|
* @throws {RequiredError}
|
|
8241
8241
|
* @memberof LicenseApi
|
|
8242
8242
|
*/
|
|
8243
|
-
deactivateLicense(options?: RawAxiosRequestConfig): Promise<
|
|
8243
|
+
deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8244
8244
|
/**
|
|
8245
8245
|
* Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
|
|
8246
8246
|
* @summary Get license
|
|
@@ -8248,7 +8248,7 @@ declare class LicenseApi extends BaseAPI {
|
|
|
8248
8248
|
* @throws {RequiredError}
|
|
8249
8249
|
* @memberof LicenseApi
|
|
8250
8250
|
*/
|
|
8251
|
-
getLicense(options?: RawAxiosRequestConfig): Promise<
|
|
8251
|
+
getLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
8252
8252
|
/**
|
|
8253
8253
|
* 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.
|
|
8254
8254
|
* @summary Get license status
|
|
@@ -8256,7 +8256,7 @@ declare class LicenseApi extends BaseAPI {
|
|
|
8256
8256
|
* @throws {RequiredError}
|
|
8257
8257
|
* @memberof LicenseApi
|
|
8258
8258
|
*/
|
|
8259
|
-
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<
|
|
8259
|
+
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<LicenseStatus, any>>;
|
|
8260
8260
|
}
|
|
8261
8261
|
/**
|
|
8262
8262
|
* MotionGroupApi - axios parameter creator
|
|
@@ -8393,7 +8393,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
8393
8393
|
* @throws {RequiredError}
|
|
8394
8394
|
* @memberof MotionGroupApi
|
|
8395
8395
|
*/
|
|
8396
|
-
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
8396
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
8397
8397
|
/**
|
|
8398
8398
|
* 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.
|
|
8399
8399
|
* @summary Description
|
|
@@ -8404,7 +8404,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
8404
8404
|
* @throws {RequiredError}
|
|
8405
8405
|
* @memberof MotionGroupApi
|
|
8406
8406
|
*/
|
|
8407
|
-
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8407
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupDescription, any>>;
|
|
8408
8408
|
/**
|
|
8409
8409
|
* <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
8410
8410
|
* @summary Stream State
|
|
@@ -8417,7 +8417,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
8417
8417
|
* @throws {RequiredError}
|
|
8418
8418
|
* @memberof MotionGroupApi
|
|
8419
8419
|
*/
|
|
8420
|
-
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
8420
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
8421
8421
|
}
|
|
8422
8422
|
/**
|
|
8423
8423
|
* MotionGroupModelsApi - axios parameter creator
|
|
@@ -8501,7 +8501,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
8501
8501
|
* @throws {RequiredError}
|
|
8502
8502
|
* @memberof MotionGroupModelsApi
|
|
8503
8503
|
*/
|
|
8504
|
-
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
8504
|
+
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
8505
8505
|
[key: string]: Collider;
|
|
8506
8506
|
}[], any>>;
|
|
8507
8507
|
/**
|
|
@@ -8511,7 +8511,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
8511
8511
|
* @throws {RequiredError}
|
|
8512
8512
|
* @memberof MotionGroupModelsApi
|
|
8513
8513
|
*/
|
|
8514
|
-
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<
|
|
8514
|
+
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
8515
8515
|
}
|
|
8516
8516
|
/**
|
|
8517
8517
|
* ProgramApi - axios parameter creator
|
|
@@ -8655,7 +8655,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8655
8655
|
* @throws {RequiredError}
|
|
8656
8656
|
* @memberof ProgramApi
|
|
8657
8657
|
*/
|
|
8658
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
8658
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program, any>>;
|
|
8659
8659
|
/**
|
|
8660
8660
|
* List details of all existing programs.
|
|
8661
8661
|
* @summary List programs
|
|
@@ -8664,7 +8664,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8664
8664
|
* @throws {RequiredError}
|
|
8665
8665
|
* @memberof ProgramApi
|
|
8666
8666
|
*/
|
|
8667
|
-
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8667
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program[], any>>;
|
|
8668
8668
|
/**
|
|
8669
8669
|
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
8670
8670
|
* @summary Start the program
|
|
@@ -8675,7 +8675,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8675
8675
|
* @throws {RequiredError}
|
|
8676
8676
|
* @memberof ProgramApi
|
|
8677
8677
|
*/
|
|
8678
|
-
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8678
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
|
|
8679
8679
|
/**
|
|
8680
8680
|
* Stop a specific program run.
|
|
8681
8681
|
* @summary Stop program run
|
|
@@ -8685,7 +8685,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8685
8685
|
* @throws {RequiredError}
|
|
8686
8686
|
* @memberof ProgramApi
|
|
8687
8687
|
*/
|
|
8688
|
-
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
8688
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8689
8689
|
}
|
|
8690
8690
|
/**
|
|
8691
8691
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
@@ -9165,7 +9165,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9165
9165
|
* @throws {RequiredError}
|
|
9166
9166
|
* @memberof StoreCollisionComponentsApi
|
|
9167
9167
|
*/
|
|
9168
|
-
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
9168
|
+
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9169
9169
|
/**
|
|
9170
9170
|
* Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
|
|
9171
9171
|
* @summary Delete Link Chain
|
|
@@ -9175,7 +9175,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9175
9175
|
* @throws {RequiredError}
|
|
9176
9176
|
* @memberof StoreCollisionComponentsApi
|
|
9177
9177
|
*/
|
|
9178
|
-
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
9178
|
+
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9179
9179
|
/**
|
|
9180
9180
|
* Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
|
|
9181
9181
|
* @summary Delete Tool
|
|
@@ -9185,7 +9185,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9185
9185
|
* @throws {RequiredError}
|
|
9186
9186
|
* @memberof StoreCollisionComponentsApi
|
|
9187
9187
|
*/
|
|
9188
|
-
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
9188
|
+
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9189
9189
|
/**
|
|
9190
9190
|
* Returns the collider.
|
|
9191
9191
|
* @summary Get Collider
|
|
@@ -9195,7 +9195,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9195
9195
|
* @throws {RequiredError}
|
|
9196
9196
|
* @memberof StoreCollisionComponentsApi
|
|
9197
9197
|
*/
|
|
9198
|
-
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
9198
|
+
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
9199
9199
|
/**
|
|
9200
9200
|
* Returns the collision link chain.
|
|
9201
9201
|
* @summary Get Link Chain
|
|
@@ -9205,7 +9205,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9205
9205
|
* @throws {RequiredError}
|
|
9206
9206
|
* @memberof StoreCollisionComponentsApi
|
|
9207
9207
|
*/
|
|
9208
|
-
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
9208
|
+
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9209
9209
|
[key: string]: Collider;
|
|
9210
9210
|
}[], any>>;
|
|
9211
9211
|
/**
|
|
@@ -9217,7 +9217,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9217
9217
|
* @throws {RequiredError}
|
|
9218
9218
|
* @memberof StoreCollisionComponentsApi
|
|
9219
9219
|
*/
|
|
9220
|
-
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
9220
|
+
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9221
9221
|
[key: string]: Collider;
|
|
9222
9222
|
}, any>>;
|
|
9223
9223
|
/**
|
|
@@ -9228,7 +9228,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9228
9228
|
* @throws {RequiredError}
|
|
9229
9229
|
* @memberof StoreCollisionComponentsApi
|
|
9230
9230
|
*/
|
|
9231
|
-
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9231
|
+
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9232
9232
|
[key: string]: {
|
|
9233
9233
|
[key: string]: Collider;
|
|
9234
9234
|
}[];
|
|
@@ -9241,7 +9241,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9241
9241
|
* @throws {RequiredError}
|
|
9242
9242
|
* @memberof StoreCollisionComponentsApi
|
|
9243
9243
|
*/
|
|
9244
|
-
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9244
|
+
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
9245
9245
|
/**
|
|
9246
9246
|
* Returns all stored colliders.
|
|
9247
9247
|
* @summary List Colliders
|
|
@@ -9250,7 +9250,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9250
9250
|
* @throws {RequiredError}
|
|
9251
9251
|
* @memberof StoreCollisionComponentsApi
|
|
9252
9252
|
*/
|
|
9253
|
-
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9253
|
+
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9254
9254
|
[key: string]: Collider;
|
|
9255
9255
|
}, any>>;
|
|
9256
9256
|
/**
|
|
@@ -9261,7 +9261,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9261
9261
|
* @throws {RequiredError}
|
|
9262
9262
|
* @memberof StoreCollisionComponentsApi
|
|
9263
9263
|
*/
|
|
9264
|
-
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9264
|
+
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
9265
9265
|
/**
|
|
9266
9266
|
* Returns the list of stored tools.
|
|
9267
9267
|
* @summary List Tools
|
|
@@ -9270,7 +9270,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9270
9270
|
* @throws {RequiredError}
|
|
9271
9271
|
* @memberof StoreCollisionComponentsApi
|
|
9272
9272
|
*/
|
|
9273
|
-
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9273
|
+
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9274
9274
|
[key: string]: {
|
|
9275
9275
|
[key: string]: Collider;
|
|
9276
9276
|
};
|
|
@@ -9283,7 +9283,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9283
9283
|
* @throws {RequiredError}
|
|
9284
9284
|
* @memberof StoreCollisionComponentsApi
|
|
9285
9285
|
*/
|
|
9286
|
-
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9286
|
+
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
9287
9287
|
/**
|
|
9288
9288
|
* Stores collider. - If the collider does not exist, it will be created. - If the collider exists, it will be updated.
|
|
9289
9289
|
* @summary Store Collider
|
|
@@ -9294,7 +9294,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9294
9294
|
* @throws {RequiredError}
|
|
9295
9295
|
* @memberof StoreCollisionComponentsApi
|
|
9296
9296
|
*/
|
|
9297
|
-
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<
|
|
9297
|
+
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
9298
9298
|
/**
|
|
9299
9299
|
* Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
|
|
9300
9300
|
* @summary Store Link Chain
|
|
@@ -9307,7 +9307,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9307
9307
|
*/
|
|
9308
9308
|
storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{
|
|
9309
9309
|
[key: string]: Collider;
|
|
9310
|
-
}>, options?: RawAxiosRequestConfig): Promise<
|
|
9310
|
+
}>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9311
9311
|
[key: string]: Collider;
|
|
9312
9312
|
}[], any>>;
|
|
9313
9313
|
/**
|
|
@@ -9322,7 +9322,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9322
9322
|
*/
|
|
9323
9323
|
storeCollisionTool(cell: string, tool: string, requestBody: {
|
|
9324
9324
|
[key: string]: Collider;
|
|
9325
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
9325
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9326
9326
|
[key: string]: Collider;
|
|
9327
9327
|
}, any>>;
|
|
9328
9328
|
}
|
|
@@ -9496,7 +9496,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
9496
9496
|
* @throws {RequiredError}
|
|
9497
9497
|
* @memberof StoreCollisionSetupsApi
|
|
9498
9498
|
*/
|
|
9499
|
-
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
9499
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9500
9500
|
/**
|
|
9501
9501
|
* Returns the stored collision setup.
|
|
9502
9502
|
* @summary Get Collision Setup
|
|
@@ -9506,7 +9506,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
9506
9506
|
* @throws {RequiredError}
|
|
9507
9507
|
* @memberof StoreCollisionSetupsApi
|
|
9508
9508
|
*/
|
|
9509
|
-
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
9509
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
9510
9510
|
/**
|
|
9511
9511
|
* Returns a list of stored collision setups.
|
|
9512
9512
|
* @summary List Collision Setups
|
|
@@ -9515,7 +9515,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
9515
9515
|
* @throws {RequiredError}
|
|
9516
9516
|
* @memberof StoreCollisionSetupsApi
|
|
9517
9517
|
*/
|
|
9518
|
-
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9518
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9519
9519
|
[key: string]: CollisionSetup;
|
|
9520
9520
|
}, any>>;
|
|
9521
9521
|
/**
|
|
@@ -9526,7 +9526,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
9526
9526
|
* @throws {RequiredError}
|
|
9527
9527
|
* @memberof StoreCollisionSetupsApi
|
|
9528
9528
|
*/
|
|
9529
|
-
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9529
|
+
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
9530
9530
|
/**
|
|
9531
9531
|
* Stores collision setup. - If the collision setup does not exist, it will be created. - If the collision setup exists, it will be updated.
|
|
9532
9532
|
* @summary Store Collision Setup
|
|
@@ -9537,7 +9537,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
9537
9537
|
* @throws {RequiredError}
|
|
9538
9538
|
* @memberof StoreCollisionSetupsApi
|
|
9539
9539
|
*/
|
|
9540
|
-
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<
|
|
9540
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
9541
9541
|
}
|
|
9542
9542
|
/**
|
|
9543
9543
|
* StoreObjectApi - axios parameter creator
|
|
@@ -9740,7 +9740,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
9740
9740
|
* @throws {RequiredError}
|
|
9741
9741
|
* @memberof StoreObjectApi
|
|
9742
9742
|
*/
|
|
9743
|
-
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9743
|
+
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9744
9744
|
/**
|
|
9745
9745
|
* Delete an object <!-- theme: danger --> > This will delete persistently stored data.
|
|
9746
9746
|
* @summary Delete Object
|
|
@@ -9750,7 +9750,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
9750
9750
|
* @throws {RequiredError}
|
|
9751
9751
|
* @memberof StoreObjectApi
|
|
9752
9752
|
*/
|
|
9753
|
-
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
9753
|
+
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9754
9754
|
/**
|
|
9755
9755
|
* Returns content and metadata of a stored object.
|
|
9756
9756
|
* @summary Get Object
|
|
@@ -9760,7 +9760,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
9760
9760
|
* @throws {RequiredError}
|
|
9761
9761
|
* @memberof StoreObjectApi
|
|
9762
9762
|
*/
|
|
9763
|
-
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
9763
|
+
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
9764
9764
|
/**
|
|
9765
9765
|
* Returns metadata. Object content is not returned.
|
|
9766
9766
|
* @summary Get Object Metadata
|
|
@@ -9770,7 +9770,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
9770
9770
|
* @throws {RequiredError}
|
|
9771
9771
|
* @memberof StoreObjectApi
|
|
9772
9772
|
*/
|
|
9773
|
-
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
9773
|
+
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9774
9774
|
/**
|
|
9775
9775
|
* List the keys for all objects.
|
|
9776
9776
|
* @summary List all Object Keys
|
|
@@ -9779,7 +9779,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
9779
9779
|
* @throws {RequiredError}
|
|
9780
9780
|
* @memberof StoreObjectApi
|
|
9781
9781
|
*/
|
|
9782
|
-
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9782
|
+
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
9783
9783
|
/**
|
|
9784
9784
|
* 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.
|
|
9785
9785
|
* @summary Store Object
|
|
@@ -9793,7 +9793,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
9793
9793
|
*/
|
|
9794
9794
|
storeObject(cell: string, key: string, xMetadata?: {
|
|
9795
9795
|
[key: string]: string;
|
|
9796
|
-
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<
|
|
9796
|
+
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9797
9797
|
}
|
|
9798
9798
|
/**
|
|
9799
9799
|
* SystemApi - axios parameter creator
|
|
@@ -10047,7 +10047,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
10047
10047
|
*/
|
|
10048
10048
|
backupConfiguration(resources?: Array<string>, metadata?: {
|
|
10049
10049
|
[key: string]: string;
|
|
10050
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
10050
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
10051
10051
|
/**
|
|
10052
10052
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
10053
10053
|
* @summary Check update
|
|
@@ -10056,7 +10056,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
10056
10056
|
* @throws {RequiredError}
|
|
10057
10057
|
* @memberof SystemApi
|
|
10058
10058
|
*/
|
|
10059
|
-
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
10059
|
+
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
10060
10060
|
/**
|
|
10061
10061
|
* 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.
|
|
10062
10062
|
* @summary Retrieve Backup Status
|
|
@@ -10065,7 +10065,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
10065
10065
|
* @throws {RequiredError}
|
|
10066
10066
|
* @memberof SystemApi
|
|
10067
10067
|
*/
|
|
10068
|
-
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
10068
|
+
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationArchiveStatus, any>>;
|
|
10069
10069
|
/**
|
|
10070
10070
|
* 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.
|
|
10071
10071
|
* @summary Download Diagnosis Package
|
|
@@ -10073,7 +10073,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
10073
10073
|
* @throws {RequiredError}
|
|
10074
10074
|
* @memberof SystemApi
|
|
10075
10075
|
*/
|
|
10076
|
-
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<
|
|
10076
|
+
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
10077
10077
|
/**
|
|
10078
10078
|
* Get the status of all system services.
|
|
10079
10079
|
* @summary Wandelbots NOVA status
|
|
@@ -10081,7 +10081,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
10081
10081
|
* @throws {RequiredError}
|
|
10082
10082
|
* @memberof SystemApi
|
|
10083
10083
|
*/
|
|
10084
|
-
getSystemStatus(options?: RawAxiosRequestConfig): Promise<
|
|
10084
|
+
getSystemStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatus[], any>>;
|
|
10085
10085
|
/**
|
|
10086
10086
|
* Get the current Wandelbots NOVA version.
|
|
10087
10087
|
* @summary Wandelbots NOVA Version
|
|
@@ -10089,7 +10089,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
10089
10089
|
* @throws {RequiredError}
|
|
10090
10090
|
* @memberof SystemApi
|
|
10091
10091
|
*/
|
|
10092
|
-
getSystemVersion(options?: RawAxiosRequestConfig): Promise<
|
|
10092
|
+
getSystemVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
10093
10093
|
/**
|
|
10094
10094
|
* Retrieves a list of all available configuration resources for backup purposes.
|
|
10095
10095
|
* @summary List Configuration Resources
|
|
@@ -10097,7 +10097,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
10097
10097
|
* @throws {RequiredError}
|
|
10098
10098
|
* @memberof SystemApi
|
|
10099
10099
|
*/
|
|
10100
|
-
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<
|
|
10100
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationResource[], any>>;
|
|
10101
10101
|
/**
|
|
10102
10102
|
* Restores a previously backed up configuration.
|
|
10103
10103
|
* @summary Restore Configuration Backup
|
|
@@ -10107,7 +10107,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
10107
10107
|
* @throws {RequiredError}
|
|
10108
10108
|
* @memberof SystemApi
|
|
10109
10109
|
*/
|
|
10110
|
-
restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<
|
|
10110
|
+
restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10111
10111
|
/**
|
|
10112
10112
|
* 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.
|
|
10113
10113
|
* @summary Update Wandelbots NOVA version
|
|
@@ -10116,7 +10116,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
10116
10116
|
* @throws {RequiredError}
|
|
10117
10117
|
* @memberof SystemApi
|
|
10118
10118
|
*/
|
|
10119
|
-
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10119
|
+
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10120
10120
|
}
|
|
10121
10121
|
/**
|
|
10122
10122
|
* TrajectoryCachingApi - axios parameter creator
|
|
@@ -10297,7 +10297,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
10297
10297
|
* @throws {RequiredError}
|
|
10298
10298
|
* @memberof TrajectoryCachingApi
|
|
10299
10299
|
*/
|
|
10300
|
-
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10300
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<AddTrajectoryResponse, any>>;
|
|
10301
10301
|
/**
|
|
10302
10302
|
* Clear the trajectory cache.
|
|
10303
10303
|
* @summary Clear Trajectories
|
|
@@ -10307,7 +10307,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
10307
10307
|
* @throws {RequiredError}
|
|
10308
10308
|
* @memberof TrajectoryCachingApi
|
|
10309
10309
|
*/
|
|
10310
|
-
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10310
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10311
10311
|
/**
|
|
10312
10312
|
* 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.
|
|
10313
10313
|
* @summary Delete Trajectory
|
|
@@ -10318,7 +10318,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
10318
10318
|
* @throws {RequiredError}
|
|
10319
10319
|
* @memberof TrajectoryCachingApi
|
|
10320
10320
|
*/
|
|
10321
|
-
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
10321
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10322
10322
|
/**
|
|
10323
10323
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
10324
10324
|
* @summary Get Trajectory
|
|
@@ -10329,7 +10329,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
10329
10329
|
* @throws {RequiredError}
|
|
10330
10330
|
* @memberof TrajectoryCachingApi
|
|
10331
10331
|
*/
|
|
10332
|
-
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
10332
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
|
|
10333
10333
|
/**
|
|
10334
10334
|
* 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.
|
|
10335
10335
|
* @summary List Trajectories
|
|
@@ -10339,7 +10339,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
10339
10339
|
* @throws {RequiredError}
|
|
10340
10340
|
* @memberof TrajectoryCachingApi
|
|
10341
10341
|
*/
|
|
10342
|
-
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10342
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListTrajectoriesResponse, any>>;
|
|
10343
10343
|
}
|
|
10344
10344
|
/**
|
|
10345
10345
|
* TrajectoryExecutionApi - axios parameter creator
|
|
@@ -10406,7 +10406,7 @@ declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
10406
10406
|
* @throws {RequiredError}
|
|
10407
10407
|
* @memberof TrajectoryExecutionApi
|
|
10408
10408
|
*/
|
|
10409
|
-
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10409
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
10410
10410
|
}
|
|
10411
10411
|
/**
|
|
10412
10412
|
* TrajectoryPlanningApi - axios parameter creator
|
|
@@ -10417,20 +10417,20 @@ declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configura
|
|
|
10417
10417
|
* Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
10418
10418
|
* @summary Plan Collision-Free Trajectory
|
|
10419
10419
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10420
|
-
* @param {PlanCollisionFreeRequest}
|
|
10420
|
+
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
10421
10421
|
* @param {*} [options] Override http request option.
|
|
10422
10422
|
* @throws {RequiredError}
|
|
10423
10423
|
*/
|
|
10424
|
-
planCollisionFree: (cell: string, planCollisionFreeRequest
|
|
10424
|
+
planCollisionFree: (cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10425
10425
|
/**
|
|
10426
10426
|
* 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.
|
|
10427
10427
|
* @summary Plan Trajectory
|
|
10428
10428
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10429
|
-
* @param {PlanTrajectoryRequest}
|
|
10429
|
+
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
10430
10430
|
* @param {*} [options] Override http request option.
|
|
10431
10431
|
* @throws {RequiredError}
|
|
10432
10432
|
*/
|
|
10433
|
-
planTrajectory: (cell: string, planTrajectoryRequest
|
|
10433
|
+
planTrajectory: (cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10434
10434
|
};
|
|
10435
10435
|
/**
|
|
10436
10436
|
* TrajectoryPlanningApi - functional programming interface
|
|
@@ -10441,20 +10441,20 @@ declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
|
|
|
10441
10441
|
* Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
10442
10442
|
* @summary Plan Collision-Free Trajectory
|
|
10443
10443
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10444
|
-
* @param {PlanCollisionFreeRequest}
|
|
10444
|
+
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
10445
10445
|
* @param {*} [options] Override http request option.
|
|
10446
10446
|
* @throws {RequiredError}
|
|
10447
10447
|
*/
|
|
10448
|
-
planCollisionFree(cell: string, planCollisionFreeRequest
|
|
10448
|
+
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
|
|
10449
10449
|
/**
|
|
10450
10450
|
* 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.
|
|
10451
10451
|
* @summary Plan Trajectory
|
|
10452
10452
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10453
|
-
* @param {PlanTrajectoryRequest}
|
|
10453
|
+
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
10454
10454
|
* @param {*} [options] Override http request option.
|
|
10455
10455
|
* @throws {RequiredError}
|
|
10456
10456
|
*/
|
|
10457
|
-
planTrajectory(cell: string, planTrajectoryRequest
|
|
10457
|
+
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanTrajectoryResponse>>;
|
|
10458
10458
|
};
|
|
10459
10459
|
/**
|
|
10460
10460
|
* TrajectoryPlanningApi - factory interface
|
|
@@ -10465,20 +10465,20 @@ declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, base
|
|
|
10465
10465
|
* Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
10466
10466
|
* @summary Plan Collision-Free Trajectory
|
|
10467
10467
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10468
|
-
* @param {PlanCollisionFreeRequest}
|
|
10468
|
+
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
10469
10469
|
* @param {*} [options] Override http request option.
|
|
10470
10470
|
* @throws {RequiredError}
|
|
10471
10471
|
*/
|
|
10472
|
-
planCollisionFree(cell: string, planCollisionFreeRequest
|
|
10472
|
+
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
|
|
10473
10473
|
/**
|
|
10474
10474
|
* 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.
|
|
10475
10475
|
* @summary Plan Trajectory
|
|
10476
10476
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10477
|
-
* @param {PlanTrajectoryRequest}
|
|
10477
|
+
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
10478
10478
|
* @param {*} [options] Override http request option.
|
|
10479
10479
|
* @throws {RequiredError}
|
|
10480
10480
|
*/
|
|
10481
|
-
planTrajectory(cell: string, planTrajectoryRequest
|
|
10481
|
+
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanTrajectoryResponse>;
|
|
10482
10482
|
};
|
|
10483
10483
|
/**
|
|
10484
10484
|
* TrajectoryPlanningApi - object-oriented interface
|
|
@@ -10491,22 +10491,22 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
10491
10491
|
* Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
10492
10492
|
* @summary Plan Collision-Free Trajectory
|
|
10493
10493
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10494
|
-
* @param {PlanCollisionFreeRequest}
|
|
10494
|
+
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
10495
10495
|
* @param {*} [options] Override http request option.
|
|
10496
10496
|
* @throws {RequiredError}
|
|
10497
10497
|
* @memberof TrajectoryPlanningApi
|
|
10498
10498
|
*/
|
|
10499
|
-
planCollisionFree(cell: string, planCollisionFreeRequest
|
|
10499
|
+
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
|
|
10500
10500
|
/**
|
|
10501
10501
|
* 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.
|
|
10502
10502
|
* @summary Plan Trajectory
|
|
10503
10503
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10504
|
-
* @param {PlanTrajectoryRequest}
|
|
10504
|
+
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
10505
10505
|
* @param {*} [options] Override http request option.
|
|
10506
10506
|
* @throws {RequiredError}
|
|
10507
10507
|
* @memberof TrajectoryPlanningApi
|
|
10508
10508
|
*/
|
|
10509
|
-
planTrajectory(cell: string, planTrajectoryRequest
|
|
10509
|
+
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
10510
10510
|
}
|
|
10511
10511
|
/**
|
|
10512
10512
|
* VirtualControllerApi - axios parameter creator
|
|
@@ -11003,7 +11003,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11003
11003
|
* @throws {RequiredError}
|
|
11004
11004
|
* @memberof VirtualControllerApi
|
|
11005
11005
|
*/
|
|
11006
|
-
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<
|
|
11006
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
11007
11007
|
/**
|
|
11008
11008
|
* 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.
|
|
11009
11009
|
* @summary Add TCP
|
|
@@ -11016,7 +11016,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11016
11016
|
* @throws {RequiredError}
|
|
11017
11017
|
* @memberof VirtualControllerApi
|
|
11018
11018
|
*/
|
|
11019
|
-
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<
|
|
11019
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
11020
11020
|
/**
|
|
11021
11021
|
* 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.
|
|
11022
11022
|
* @summary Delete Coordinate System
|
|
@@ -11028,7 +11028,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11028
11028
|
* @throws {RequiredError}
|
|
11029
11029
|
* @memberof VirtualControllerApi
|
|
11030
11030
|
*/
|
|
11031
|
-
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
11031
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
11032
11032
|
/**
|
|
11033
11033
|
* 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.
|
|
11034
11034
|
* @summary Remove TCP
|
|
@@ -11040,7 +11040,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11040
11040
|
* @throws {RequiredError}
|
|
11041
11041
|
* @memberof VirtualControllerApi
|
|
11042
11042
|
*/
|
|
11043
|
-
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<
|
|
11043
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
11044
11044
|
/**
|
|
11045
11045
|
* 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.
|
|
11046
11046
|
* @summary Get Emergency Stop State
|
|
@@ -11050,7 +11050,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11050
11050
|
* @throws {RequiredError}
|
|
11051
11051
|
* @memberof VirtualControllerApi
|
|
11052
11052
|
*/
|
|
11053
|
-
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
11053
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Flag, any>>;
|
|
11054
11054
|
/**
|
|
11055
11055
|
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
11056
11056
|
* @summary Get Motion Group State
|
|
@@ -11061,7 +11061,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11061
11061
|
* @throws {RequiredError}
|
|
11062
11062
|
* @memberof VirtualControllerApi
|
|
11063
11063
|
*/
|
|
11064
|
-
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
11064
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupJoints, any>>;
|
|
11065
11065
|
/**
|
|
11066
11066
|
* Gets information on the motion group.
|
|
11067
11067
|
* @summary Motion Group Description
|
|
@@ -11071,7 +11071,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11071
11071
|
* @throws {RequiredError}
|
|
11072
11072
|
* @memberof VirtualControllerApi
|
|
11073
11073
|
*/
|
|
11074
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
11074
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfo[], any>>;
|
|
11075
11075
|
/**
|
|
11076
11076
|
* 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.
|
|
11077
11077
|
* @summary Get Operation Mode
|
|
@@ -11081,7 +11081,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11081
11081
|
* @throws {RequiredError}
|
|
11082
11082
|
* @memberof VirtualControllerApi
|
|
11083
11083
|
*/
|
|
11084
|
-
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
11084
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<OpMode, any>>;
|
|
11085
11085
|
/**
|
|
11086
11086
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
11087
11087
|
* @summary Get Mounting
|
|
@@ -11092,7 +11092,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11092
11092
|
* @throws {RequiredError}
|
|
11093
11093
|
* @memberof VirtualControllerApi
|
|
11094
11094
|
*/
|
|
11095
|
-
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
11095
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
11096
11096
|
/**
|
|
11097
11097
|
* Lists all coordinate systems on the robot controller.
|
|
11098
11098
|
* @summary List Coordinate Systems
|
|
@@ -11102,7 +11102,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11102
11102
|
* @throws {RequiredError}
|
|
11103
11103
|
* @memberof VirtualControllerApi
|
|
11104
11104
|
*/
|
|
11105
|
-
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
11105
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
11106
11106
|
/**
|
|
11107
11107
|
* Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
|
|
11108
11108
|
* @summary List TCPs
|
|
@@ -11113,7 +11113,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11113
11113
|
* @throws {RequiredError}
|
|
11114
11114
|
* @memberof VirtualControllerApi
|
|
11115
11115
|
*/
|
|
11116
|
-
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
11116
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp[], any>>;
|
|
11117
11117
|
/**
|
|
11118
11118
|
* 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.
|
|
11119
11119
|
* @summary Push or Release Emergency Stop
|
|
@@ -11124,7 +11124,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11124
11124
|
* @throws {RequiredError}
|
|
11125
11125
|
* @memberof VirtualControllerApi
|
|
11126
11126
|
*/
|
|
11127
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
11127
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
11128
11128
|
/**
|
|
11129
11129
|
* 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.
|
|
11130
11130
|
* @summary Set Motion Group State
|
|
@@ -11136,7 +11136,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11136
11136
|
* @throws {RequiredError}
|
|
11137
11137
|
* @memberof VirtualControllerApi
|
|
11138
11138
|
*/
|
|
11139
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<
|
|
11139
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
11140
11140
|
/**
|
|
11141
11141
|
* 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.
|
|
11142
11142
|
* @summary Set Operation Mode
|
|
@@ -11147,7 +11147,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11147
11147
|
* @throws {RequiredError}
|
|
11148
11148
|
* @memberof VirtualControllerApi
|
|
11149
11149
|
*/
|
|
11150
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<
|
|
11150
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
11151
11151
|
/**
|
|
11152
11152
|
* 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.
|
|
11153
11153
|
* @summary Set Mounting
|
|
@@ -11159,7 +11159,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
11159
11159
|
* @throws {RequiredError}
|
|
11160
11160
|
* @memberof VirtualControllerApi
|
|
11161
11161
|
*/
|
|
11162
|
-
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
11162
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
11163
11163
|
}
|
|
11164
11164
|
/**
|
|
11165
11165
|
* VirtualControllerBehaviorApi - axios parameter creator
|
|
@@ -11310,7 +11310,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
11310
11310
|
* @throws {RequiredError}
|
|
11311
11311
|
* @memberof VirtualControllerBehaviorApi
|
|
11312
11312
|
*/
|
|
11313
|
-
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<
|
|
11313
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExternalJointStreamDatapoint[], any>>;
|
|
11314
11314
|
/**
|
|
11315
11315
|
* Get the cycle time of controller communication in [ms].
|
|
11316
11316
|
* @summary Get Cycle Time
|
|
@@ -11320,7 +11320,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
11320
11320
|
* @throws {RequiredError}
|
|
11321
11321
|
* @memberof VirtualControllerBehaviorApi
|
|
11322
11322
|
*/
|
|
11323
|
-
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
11323
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
|
|
11324
11324
|
/**
|
|
11325
11325
|
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
11326
11326
|
* @summary Get Behavior
|
|
@@ -11330,7 +11330,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
11330
11330
|
* @throws {RequiredError}
|
|
11331
11331
|
* @memberof VirtualControllerBehaviorApi
|
|
11332
11332
|
*/
|
|
11333
|
-
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
11333
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Behavior, any>>;
|
|
11334
11334
|
/**
|
|
11335
11335
|
* Set virtual controller behavior. See query parameters for details.
|
|
11336
11336
|
* @summary Set Behavior
|
|
@@ -11341,7 +11341,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
11341
11341
|
* @throws {RequiredError}
|
|
11342
11342
|
* @memberof VirtualControllerBehaviorApi
|
|
11343
11343
|
*/
|
|
11344
|
-
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<
|
|
11344
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
11345
11345
|
}
|
|
11346
11346
|
/**
|
|
11347
11347
|
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
@@ -11477,7 +11477,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
11477
11477
|
* @throws {RequiredError}
|
|
11478
11478
|
* @memberof VirtualControllerInputsOutputsApi
|
|
11479
11479
|
*/
|
|
11480
|
-
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
11480
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
11481
11481
|
/**
|
|
11482
11482
|
* 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.
|
|
11483
11483
|
* @summary List Descriptions
|
|
@@ -11491,7 +11491,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
11491
11491
|
* @throws {RequiredError}
|
|
11492
11492
|
* @memberof VirtualControllerInputsOutputsApi
|
|
11493
11493
|
*/
|
|
11494
|
-
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
11494
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
11495
11495
|
/**
|
|
11496
11496
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
11497
11497
|
* @summary Set Input/Ouput Values
|
|
@@ -11502,7 +11502,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
11502
11502
|
* @throws {RequiredError}
|
|
11503
11503
|
* @memberof VirtualControllerInputsOutputsApi
|
|
11504
11504
|
*/
|
|
11505
|
-
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
11505
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
11506
11506
|
}
|
|
11507
11507
|
//#endregion
|
|
11508
11508
|
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, BusIOModbusClient, BusIOModbusClientBusTypeEnum, BusIOModbusServer, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClient, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServer, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtual, BusIOModbusVirtualBusTypeEnum, BusIOProfinet, BusIOProfinetBusTypeEnum, BusIOProfinetDefaultRoute, BusIOProfinetIpConfig, BusIOProfinetNetwork, BusIOProfinetVirtual, BusIOProfinetVirtualBusTypeEnum, BusIOType, BusIOsState, BusIOsStateEnum, COLLECTION_FORMATS, Capsule, CapsuleShapeTypeEnum, CartesianLimits, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Collider, ColliderShape, Collision, CollisionContact, CollisionError, CollisionFreeAlgorithm, CollisionSetup, Comparator, Configuration, ConfigurationArchiveStatus, ConfigurationArchiveStatusCreating, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusError, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccess, ConfigurationArchiveStatusSuccessStatusEnum, ConfigurationParameters, ConfigurationResource, ContainerEnvironmentInner, ContainerImage, ContainerImageSecretsInner, ContainerResources, ContainerStorage, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerDescription, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHull, ConvexHullShapeTypeEnum, CoordinateSystem, CoordinateSystemData, CubicSplineParameter, CycleTime, Cylinder, CylinderShapeTypeEnum, DHParameter, Direction, ErrorInvalidJointCount, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceeded, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollision, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceeded, ErrorMaxIterationsExceededErrorFeedbackNameEnum, Execute, ExecuteDetails, ExecuteJoggingRequest, ExecuteJoggingResponse, ExecuteTrajectoryRequest, ExecuteTrajectoryResponse, ExternalJointStreamDatapoint, ExternalJointStreamRequest, FanucController, FanucControllerKindEnum, FeedbackCollision, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceeded, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspace, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularity, FeedbackSingularityErrorFeedbackNameEnum, Flag, FloatValue, FloatValueValueTypeEnum, ForwardKinematics422Response, ForwardKinematicsRequest, ForwardKinematicsResponse, ForwardKinematicsValidationError, GetTrajectoryResponse, HTTPValidationError, IOBooleanValue, IOBooleanValueValueTypeEnum, 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, ModbusIO, ModbusIOArea, ModbusIOByteOrder, ModbusIOData, ModbusIOTypeEnum, 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 };
|