@wandelbots/nova-api 26.4.0-dev.2 → 26.4.0-dev.3
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 +178 -178
- package/dist/v2/index.d.ts +154 -154
- package/package.json +1 -1
package/dist/v2/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as axios176 from "axios";
|
|
2
2
|
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
3
|
|
|
4
4
|
//#region v2/configuration.d.ts
|
|
@@ -4552,7 +4552,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4552
4552
|
* @param {*} [options] Override http request option.
|
|
4553
4553
|
* @throws {RequiredError}
|
|
4554
4554
|
*/
|
|
4555
|
-
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4555
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4556
4556
|
/**
|
|
4557
4557
|
* **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___ Delete all GUI applications from the cell.
|
|
4558
4558
|
* @summary Clear Applications
|
|
@@ -4561,7 +4561,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4561
4561
|
* @param {*} [options] Override http request option.
|
|
4562
4562
|
* @throws {RequiredError}
|
|
4563
4563
|
*/
|
|
4564
|
-
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4564
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4565
4565
|
/**
|
|
4566
4566
|
* **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___ Delete a GUI application from the cell.
|
|
4567
4567
|
* @summary Delete Application
|
|
@@ -4571,7 +4571,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4571
4571
|
* @param {*} [options] Override http request option.
|
|
4572
4572
|
* @throws {RequiredError}
|
|
4573
4573
|
*/
|
|
4574
|
-
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4574
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4575
4575
|
/**
|
|
4576
4576
|
* **Required permissions:** `can_access_apps` - View application configurations ___ Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](#/operations/updateApp).
|
|
4577
4577
|
* @summary Configuration
|
|
@@ -4580,7 +4580,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4580
4580
|
* @param {*} [options] Override http request option.
|
|
4581
4581
|
* @throws {RequiredError}
|
|
4582
4582
|
*/
|
|
4583
|
-
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<
|
|
4583
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<App, any>>;
|
|
4584
4584
|
/**
|
|
4585
4585
|
* **Required permissions:** `can_access_apps` - View application configurations ___ List all GUI applications that have been added to a cell with [addApp](#/operations/addApp). If the cell does not contain GUI applications, the list is returned empty.
|
|
4586
4586
|
* @summary List Applications
|
|
@@ -4588,7 +4588,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4588
4588
|
* @param {*} [options] Override http request option.
|
|
4589
4589
|
* @throws {RequiredError}
|
|
4590
4590
|
*/
|
|
4591
|
-
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4591
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
4592
4592
|
/**
|
|
4593
4593
|
* **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___ Update the configuration of a GUI application in the cell.
|
|
4594
4594
|
* @summary Update Configuration
|
|
@@ -4599,7 +4599,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4599
4599
|
* @param {*} [options] Override http request option.
|
|
4600
4600
|
* @throws {RequiredError}
|
|
4601
4601
|
*/
|
|
4602
|
-
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4602
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4603
4603
|
}
|
|
4604
4604
|
/**
|
|
4605
4605
|
* BUSInputsOutputsApi - axios parameter creator
|
|
@@ -5127,7 +5127,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5127
5127
|
* @param {*} [options] Override http request option.
|
|
5128
5128
|
* @throws {RequiredError}
|
|
5129
5129
|
*/
|
|
5130
|
-
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5130
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5131
5131
|
/**
|
|
5132
5132
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](#/operations/listModbusIOs).
|
|
5133
5133
|
* @summary Add MODBUS Input/Output
|
|
@@ -5137,7 +5137,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5137
5137
|
* @param {*} [options] Override http request option.
|
|
5138
5138
|
* @throws {RequiredError}
|
|
5139
5139
|
*/
|
|
5140
|
-
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<
|
|
5140
|
+
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5141
5141
|
/**
|
|
5142
5142
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
|
|
5143
5143
|
* @summary Add PROFINET Input/Output
|
|
@@ -5147,7 +5147,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5147
5147
|
* @param {*} [options] Override http request option.
|
|
5148
5148
|
* @throws {RequiredError}
|
|
5149
5149
|
*/
|
|
5150
|
-
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<
|
|
5150
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5151
5151
|
/**
|
|
5152
5152
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ Remove the BUS inputs/outputs service from the cell.
|
|
5153
5153
|
* @summary Clear Service
|
|
@@ -5156,7 +5156,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5156
5156
|
* @param {*} [options] Override http request option.
|
|
5157
5157
|
* @throws {RequiredError}
|
|
5158
5158
|
*/
|
|
5159
|
-
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5159
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5160
5160
|
/**
|
|
5161
5161
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
5162
5162
|
* @summary Remove all MODBUS Input/Outputs
|
|
@@ -5164,7 +5164,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5164
5164
|
* @param {*} [options] Override http request option.
|
|
5165
5165
|
* @throws {RequiredError}
|
|
5166
5166
|
*/
|
|
5167
|
-
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5167
|
+
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5168
5168
|
/**
|
|
5169
5169
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
5170
5170
|
* @summary Remove all PROFINET Input/Outputs
|
|
@@ -5172,7 +5172,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5172
5172
|
* @param {*} [options] Override http request option.
|
|
5173
5173
|
* @throws {RequiredError}
|
|
5174
5174
|
*/
|
|
5175
|
-
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5175
|
+
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5176
5176
|
/**
|
|
5177
5177
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
5178
5178
|
* @summary Remove MODBUS Input/Output
|
|
@@ -5181,7 +5181,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5181
5181
|
* @param {*} [options] Override http request option.
|
|
5182
5182
|
* @throws {RequiredError}
|
|
5183
5183
|
*/
|
|
5184
|
-
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
5184
|
+
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5185
5185
|
/**
|
|
5186
5186
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
5187
5187
|
* @summary Remove PROFINET Input/Ouptut
|
|
@@ -5190,7 +5190,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5190
5190
|
* @param {*} [options] Override http request option.
|
|
5191
5191
|
* @throws {RequiredError}
|
|
5192
5192
|
*/
|
|
5193
|
-
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
5193
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5194
5194
|
/**
|
|
5195
5195
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Get deployed BUS inputs/outputs service.
|
|
5196
5196
|
* @summary Get Service
|
|
@@ -5198,7 +5198,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5198
5198
|
* @param {*} [options] Override http request option.
|
|
5199
5199
|
* @throws {RequiredError}
|
|
5200
5200
|
*/
|
|
5201
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5201
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<BusIOType, any>>;
|
|
5202
5202
|
/**
|
|
5203
5203
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Get the current state of the BUS Inputs/Outputs service.
|
|
5204
5204
|
* @summary State
|
|
@@ -5206,7 +5206,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5206
5206
|
* @param {*} [options] Override http request option.
|
|
5207
5207
|
* @throws {RequiredError}
|
|
5208
5208
|
*/
|
|
5209
|
-
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5209
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<BusIOsState, any>>;
|
|
5210
5210
|
/**
|
|
5211
5211
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](#/operations/listBusIODescriptions).
|
|
5212
5212
|
* @summary Get Input/Output Values
|
|
@@ -5215,7 +5215,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5215
5215
|
* @param {*} [options] Override http request option.
|
|
5216
5216
|
* @throws {RequiredError}
|
|
5217
5217
|
*/
|
|
5218
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5218
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<IOValue[], any>>;
|
|
5219
5219
|
/**
|
|
5220
5220
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Get description of NOVA as a PROFINET device.
|
|
5221
5221
|
* @summary Get PROFINET Description
|
|
@@ -5223,7 +5223,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5223
5223
|
* @param {*} [options] Override http request option.
|
|
5224
5224
|
* @throws {RequiredError}
|
|
5225
5225
|
*/
|
|
5226
|
-
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5226
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ProfinetDescription, any>>;
|
|
5227
5227
|
/**
|
|
5228
5228
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Returns the Generic Station Description Markup Language (GSDML) file for the PROFINET device. The GSDML file describes the PROFINET device configuration and capabilities, and can be imported into PROFINET engineering tools, e.g., TIA Portal, or other PLC programming environments. The returned GSDML file matches the current slot configuration of the PROFINET device.
|
|
5229
5229
|
* @summary Get PROFINET GSDML File
|
|
@@ -5231,7 +5231,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5231
5231
|
* @param {*} [options] Override http request option.
|
|
5232
5232
|
* @throws {RequiredError}
|
|
5233
5233
|
*/
|
|
5234
|
-
getProfinetGSDML(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5234
|
+
getProfinetGSDML(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string, any>>;
|
|
5235
5235
|
/**
|
|
5236
5236
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Get input/output variable configuration of the PROFINET device, e.g., NOVA\'s PROFINET service as file. You can specify byte offsets for 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.
|
|
5237
5237
|
* @summary PROFINET Inputs/Outputs to File
|
|
@@ -5241,7 +5241,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5241
5241
|
* @param {*} [options] Override http request option.
|
|
5242
5242
|
* @throws {RequiredError}
|
|
5243
5243
|
*/
|
|
5244
|
-
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5244
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string, any>>;
|
|
5245
5245
|
/**
|
|
5246
5246
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ List all input/output descriptions for configured BUS services. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the BUS service.
|
|
5247
5247
|
* @summary List Descriptions
|
|
@@ -5249,7 +5249,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5249
5249
|
* @param {*} [options] Override http request option.
|
|
5250
5250
|
* @throws {RequiredError}
|
|
5251
5251
|
*/
|
|
5252
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5252
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<BusIODescription[], any>>;
|
|
5253
5253
|
/**
|
|
5254
5254
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type, and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller, as well as NOVA\'s MODBUS service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](#/operations/addModbusIO).
|
|
5255
5255
|
* @summary List MODBUS Input/Output Configuration
|
|
@@ -5257,7 +5257,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5257
5257
|
* @param {*} [options] Override http request option.
|
|
5258
5258
|
* @throws {RequiredError}
|
|
5259
5259
|
*/
|
|
5260
|
-
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5260
|
+
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ModbusIO[], any>>;
|
|
5261
5261
|
/**
|
|
5262
5262
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type, and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](#/operations/addProfinetIO) and [setProfinetIOsFromFile](#/operations/setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
|
|
5263
5263
|
* @summary List PROFINET Input/Output Configuration
|
|
@@ -5265,7 +5265,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5265
5265
|
* @param {*} [options] Override http request option.
|
|
5266
5266
|
* @throws {RequiredError}
|
|
5267
5267
|
*/
|
|
5268
|
-
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5268
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ProfinetIO[], any>>;
|
|
5269
5269
|
/**
|
|
5270
5270
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](#/operations/listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
5271
5271
|
* @summary Set Output Values
|
|
@@ -5274,7 +5274,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5274
5274
|
* @param {*} [options] Override http request option.
|
|
5275
5275
|
* @throws {RequiredError}
|
|
5276
5276
|
*/
|
|
5277
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
5277
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5278
5278
|
/**
|
|
5279
5279
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as an XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
5280
5280
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
@@ -5283,7 +5283,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5283
5283
|
* @param {*} [options] Override http request option.
|
|
5284
5284
|
* @throws {RequiredError}
|
|
5285
5285
|
*/
|
|
5286
|
-
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<
|
|
5286
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5287
5287
|
}
|
|
5288
5288
|
/**
|
|
5289
5289
|
* CellApi - axios parameter creator
|
|
@@ -5546,7 +5546,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5546
5546
|
* @param {*} [options] Override http request option.
|
|
5547
5547
|
* @throws {RequiredError}
|
|
5548
5548
|
*/
|
|
5549
|
-
checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
5549
|
+
checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string, any>>;
|
|
5550
5550
|
/**
|
|
5551
5551
|
* **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___ Delete an entire cell.
|
|
5552
5552
|
* @summary Delete Cell
|
|
@@ -5555,7 +5555,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5555
5555
|
* @param {*} [options] Override http request option.
|
|
5556
5556
|
* @throws {RequiredError}
|
|
5557
5557
|
*/
|
|
5558
|
-
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5558
|
+
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5559
5559
|
/**
|
|
5560
5560
|
* **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___ 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.
|
|
5561
5561
|
* @summary Add Cell
|
|
@@ -5564,7 +5564,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5564
5564
|
* @param {*} [options] Override http request option.
|
|
5565
5565
|
* @throws {RequiredError}
|
|
5566
5566
|
*/
|
|
5567
|
-
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5567
|
+
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5568
5568
|
/**
|
|
5569
5569
|
* **Required permissions:** `can_access_cells` - View cell configurations and resources ___ List all cell resources.
|
|
5570
5570
|
* @summary Configuration
|
|
@@ -5572,7 +5572,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5572
5572
|
* @param {*} [options] Override http request option.
|
|
5573
5573
|
* @throws {RequiredError}
|
|
5574
5574
|
*/
|
|
5575
|
-
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5575
|
+
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Cell, any>>;
|
|
5576
5576
|
/**
|
|
5577
5577
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ List the status of all cell resources.
|
|
5578
5578
|
* @summary Service Status
|
|
@@ -5580,14 +5580,14 @@ declare class CellApi extends BaseAPI {
|
|
|
5580
5580
|
* @param {*} [options] Override http request option.
|
|
5581
5581
|
* @throws {RequiredError}
|
|
5582
5582
|
*/
|
|
5583
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5583
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ServiceStatusResponse, any>>;
|
|
5584
5584
|
/**
|
|
5585
5585
|
* **Required permissions:** `can_access_cells` - View cell configurations and resources ___ List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
5586
5586
|
* @summary List Cells
|
|
5587
5587
|
* @param {*} [options] Override http request option.
|
|
5588
5588
|
* @throws {RequiredError}
|
|
5589
5589
|
*/
|
|
5590
|
-
listCells(options?: RawAxiosRequestConfig): Promise<
|
|
5590
|
+
listCells(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
5591
5591
|
/**
|
|
5592
5592
|
* **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___ Deactivate or activate the services of a cell.
|
|
5593
5593
|
* @summary Operating State
|
|
@@ -5596,7 +5596,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5596
5596
|
* @param {*} [options] Override http request option.
|
|
5597
5597
|
* @throws {RequiredError}
|
|
5598
5598
|
*/
|
|
5599
|
-
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<
|
|
5599
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5600
5600
|
/**
|
|
5601
5601
|
* **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___ Update the definition of the entire cell. <!-- theme: info --> > **NOTE** > > This endpoint replaces the full cell configuration and is not a partial update. > To change only one field: > 1. Get the current configuration via [Cell > Configuration](#/operations/getCell). > 2. Send the full configuration with your intended changes via [Cell > Update Configuration](#/operations/updateCell). Omitting existing sections may reset or remove their current configuration.
|
|
5602
5602
|
* @summary Update Configuration
|
|
@@ -5606,7 +5606,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5606
5606
|
* @param {*} [options] Override http request option.
|
|
5607
5607
|
* @throws {RequiredError}
|
|
5608
5608
|
*/
|
|
5609
|
-
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5609
|
+
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5610
5610
|
/**
|
|
5611
5611
|
* **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___ Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
|
|
5612
5612
|
* @summary Update Cell Version
|
|
@@ -5615,7 +5615,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5615
5615
|
* @param {*} [options] Override http request option.
|
|
5616
5616
|
* @throws {RequiredError}
|
|
5617
5617
|
*/
|
|
5618
|
-
updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5618
|
+
updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5619
5619
|
}
|
|
5620
5620
|
/**
|
|
5621
5621
|
* ControllerApi - axios parameter creator
|
|
@@ -6053,7 +6053,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6053
6053
|
* @param {*} [options] Override http request option.
|
|
6054
6054
|
* @throws {RequiredError}
|
|
6055
6055
|
*/
|
|
6056
|
-
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6056
|
+
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
6057
6057
|
/**
|
|
6058
6058
|
* **Required permissions:** `can_manage_controllers` - Create, update, or delete robot controllers ___ Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
6059
6059
|
* @summary Clear Robot Controllers
|
|
@@ -6062,7 +6062,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6062
6062
|
* @param {*} [options] Override http request option.
|
|
6063
6063
|
* @throws {RequiredError}
|
|
6064
6064
|
*/
|
|
6065
|
-
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6065
|
+
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
6066
6066
|
/**
|
|
6067
6067
|
* **Required permissions:** `can_manage_controllers` - Create, update, or delete robot controllers ___ Delete a robot controller from the cell.
|
|
6068
6068
|
* @summary Delete Robot Controller
|
|
@@ -6072,7 +6072,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6072
6072
|
* @param {*} [options] Override http request option.
|
|
6073
6073
|
* @throws {RequiredError}
|
|
6074
6074
|
*/
|
|
6075
|
-
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6075
|
+
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
6076
6076
|
/**
|
|
6077
6077
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](#/operations/getMotionGroupDescription) to get more information about the motion group.
|
|
6078
6078
|
* @summary Description
|
|
@@ -6081,7 +6081,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6081
6081
|
* @param {*} [options] Override http request option.
|
|
6082
6082
|
* @throws {RequiredError}
|
|
6083
6083
|
*/
|
|
6084
|
-
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
6084
|
+
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ControllerDescription, any>>;
|
|
6085
6085
|
/**
|
|
6086
6086
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ 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.
|
|
6087
6087
|
* @summary Coordinate System
|
|
@@ -6092,7 +6092,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6092
6092
|
* @param {*} [options] Override http request option.
|
|
6093
6093
|
* @throws {RequiredError}
|
|
6094
6094
|
*/
|
|
6095
|
-
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
6095
|
+
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CoordinateSystem, any>>;
|
|
6096
6096
|
/**
|
|
6097
6097
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Get the current state of a robot controller.
|
|
6098
6098
|
* @summary State
|
|
@@ -6101,7 +6101,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6101
6101
|
* @param {*} [options] Override http request option.
|
|
6102
6102
|
* @throws {RequiredError}
|
|
6103
6103
|
*/
|
|
6104
|
-
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
6104
|
+
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<RobotControllerState, any>>;
|
|
6105
6105
|
/**
|
|
6106
6106
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Get the configuration for a robot controller.
|
|
6107
6107
|
* @summary Robot Controller
|
|
@@ -6110,7 +6110,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6110
6110
|
* @param {*} [options] Override http request option.
|
|
6111
6111
|
* @throws {RequiredError}
|
|
6112
6112
|
*/
|
|
6113
|
-
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
6113
|
+
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<RobotController, any>>;
|
|
6114
6114
|
/**
|
|
6115
6115
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](#/operations/addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration, which is not required when providing a complete configuration.
|
|
6116
6116
|
* @summary Virtual Controller Configuration
|
|
@@ -6119,7 +6119,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6119
6119
|
* @param {*} [options] Override http request option.
|
|
6120
6120
|
* @throws {RequiredError}
|
|
6121
6121
|
*/
|
|
6122
|
-
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
6122
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
6123
6123
|
/**
|
|
6124
6124
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ 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.
|
|
6125
6125
|
* @summary List Coordinate Systems
|
|
@@ -6129,7 +6129,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6129
6129
|
* @param {*} [options] Override http request option.
|
|
6130
6130
|
* @throws {RequiredError}
|
|
6131
6131
|
*/
|
|
6132
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
6132
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CoordinateSystem[], any>>;
|
|
6133
6133
|
/**
|
|
6134
6134
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ List the names of all deployed robot controllers.
|
|
6135
6135
|
* @summary List Robot Controllers
|
|
@@ -6137,7 +6137,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6137
6137
|
* @param {*} [options] Override http request option.
|
|
6138
6138
|
* @throws {RequiredError}
|
|
6139
6139
|
*/
|
|
6140
|
-
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6140
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
6141
6141
|
/**
|
|
6142
6142
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state `normal` or `reduced`. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](#/operations/getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
6143
6143
|
* @summary Set Default Mode
|
|
@@ -6147,7 +6147,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6147
6147
|
* @param {*} [options] Override http request option.
|
|
6148
6148
|
* @throws {RequiredError}
|
|
6149
6149
|
*/
|
|
6150
|
-
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<
|
|
6150
|
+
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
6151
6151
|
/**
|
|
6152
6152
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](#/operations/listRobotControllers) to check if the robot controller supports free drive mode.
|
|
6153
6153
|
* @summary Stream Free Drive
|
|
@@ -6157,7 +6157,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6157
6157
|
* @param {*} [options] Override http request option.
|
|
6158
6158
|
* @throws {RequiredError}
|
|
6159
6159
|
*/
|
|
6160
|
-
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6160
|
+
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<RobotControllerState, any>>;
|
|
6161
6161
|
/**
|
|
6162
6162
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](#/operations/addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
6163
6163
|
* @summary Stream State
|
|
@@ -6168,7 +6168,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6168
6168
|
* @param {*} [options] Override http request option.
|
|
6169
6169
|
* @throws {RequiredError}
|
|
6170
6170
|
*/
|
|
6171
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6171
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<RobotControllerState, any>>;
|
|
6172
6172
|
/**
|
|
6173
6173
|
* **Required permissions:** `can_manage_controllers` - Create, update, or delete robot controllers ___ Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](#/operations/getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](#/operations/deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](#/operations/addRobotController).
|
|
6174
6174
|
* @summary Update Robot Controller
|
|
@@ -6179,7 +6179,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6179
6179
|
* @param {*} [options] Override http request option.
|
|
6180
6180
|
* @throws {RequiredError}
|
|
6181
6181
|
*/
|
|
6182
|
-
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6182
|
+
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
6183
6183
|
}
|
|
6184
6184
|
/**
|
|
6185
6185
|
* ControllerInputsOutputsApi - axios parameter creator
|
|
@@ -6371,7 +6371,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
6371
6371
|
* @param {*} [options] Override http request option.
|
|
6372
6372
|
* @throws {RequiredError}
|
|
6373
6373
|
*/
|
|
6374
|
-
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
6374
|
+
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<IODescription[], any>>;
|
|
6375
6375
|
/**
|
|
6376
6376
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](#/operations/listIODescriptions).
|
|
6377
6377
|
* @summary Get Input/Output Values
|
|
@@ -6381,7 +6381,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
6381
6381
|
* @param {*} [options] Override http request option.
|
|
6382
6382
|
* @throws {RequiredError}
|
|
6383
6383
|
*/
|
|
6384
|
-
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
6384
|
+
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<IOValue[], any>>;
|
|
6385
6385
|
/**
|
|
6386
6386
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](#/operations/listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
|
|
6387
6387
|
* @summary Set Output Values
|
|
@@ -6391,7 +6391,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
6391
6391
|
* @param {*} [options] Override http request option.
|
|
6392
6392
|
* @throws {RequiredError}
|
|
6393
6393
|
*/
|
|
6394
|
-
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
6394
|
+
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
6395
6395
|
/**
|
|
6396
6396
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ <!-- 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.
|
|
6397
6397
|
* @summary Stream Input/Output Values
|
|
@@ -6401,7 +6401,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
6401
6401
|
* @param {*} [options] Override http request option.
|
|
6402
6402
|
* @throws {RequiredError}
|
|
6403
6403
|
*/
|
|
6404
|
-
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
6404
|
+
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<StreamIOValuesResponse, any>>;
|
|
6405
6405
|
/**
|
|
6406
6406
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](#/operations/listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
|
|
6407
6407
|
* @summary Wait For
|
|
@@ -6411,7 +6411,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
6411
6411
|
* @param {*} [options] Override http request option.
|
|
6412
6412
|
* @throws {RequiredError}
|
|
6413
6413
|
*/
|
|
6414
|
-
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6414
|
+
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<boolean, any>>;
|
|
6415
6415
|
}
|
|
6416
6416
|
/**
|
|
6417
6417
|
* JoggingApi - axios parameter creator
|
|
@@ -6471,7 +6471,7 @@ declare class JoggingApi extends BaseAPI {
|
|
|
6471
6471
|
* @param {*} [options] Override http request option.
|
|
6472
6472
|
* @throws {RequiredError}
|
|
6473
6473
|
*/
|
|
6474
|
-
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6474
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ExecuteJoggingResponse, any>>;
|
|
6475
6475
|
}
|
|
6476
6476
|
/**
|
|
6477
6477
|
* KinematicsApi - axios parameter creator
|
|
@@ -6554,7 +6554,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
6554
6554
|
* @param {*} [options] Override http request option.
|
|
6555
6555
|
* @throws {RequiredError}
|
|
6556
6556
|
*/
|
|
6557
|
-
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6557
|
+
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ForwardKinematicsResponse, any>>;
|
|
6558
6558
|
/**
|
|
6559
6559
|
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ Returns the reachable joint positions for a list of given poses.
|
|
6560
6560
|
* @summary Inverse kinematics
|
|
@@ -6563,7 +6563,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
6563
6563
|
* @param {*} [options] Override http request option.
|
|
6564
6564
|
* @throws {RequiredError}
|
|
6565
6565
|
*/
|
|
6566
|
-
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6566
|
+
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<InverseKinematicsResponse, any>>;
|
|
6567
6567
|
}
|
|
6568
6568
|
/**
|
|
6569
6569
|
* LicenseApi - axios parameter creator
|
|
@@ -6678,28 +6678,28 @@ declare class LicenseApi extends BaseAPI {
|
|
|
6678
6678
|
* @param {*} [options] Override http request option.
|
|
6679
6679
|
* @throws {RequiredError}
|
|
6680
6680
|
*/
|
|
6681
|
-
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6681
|
+
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<License, any>>;
|
|
6682
6682
|
/**
|
|
6683
6683
|
* **Required permissions:** `can_manage_license` - Manage license configuration ___ Deactivates active license.
|
|
6684
6684
|
* @summary Deactivate license
|
|
6685
6685
|
* @param {*} [options] Override http request option.
|
|
6686
6686
|
* @throws {RequiredError}
|
|
6687
6687
|
*/
|
|
6688
|
-
deactivateLicense(options?: RawAxiosRequestConfig): Promise<
|
|
6688
|
+
deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
6689
6689
|
/**
|
|
6690
6690
|
* **Required permissions:** `can_manage_license` - Manage license configuration ___ Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
|
|
6691
6691
|
* @summary Get license
|
|
6692
6692
|
* @param {*} [options] Override http request option.
|
|
6693
6693
|
* @throws {RequiredError}
|
|
6694
6694
|
*/
|
|
6695
|
-
getLicense(options?: RawAxiosRequestConfig): Promise<
|
|
6695
|
+
getLicense(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<License, any>>;
|
|
6696
6696
|
/**
|
|
6697
6697
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ 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.
|
|
6698
6698
|
* @summary Get license status
|
|
6699
6699
|
* @param {*} [options] Override http request option.
|
|
6700
6700
|
* @throws {RequiredError}
|
|
6701
6701
|
*/
|
|
6702
|
-
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<
|
|
6702
|
+
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<LicenseStatus, any>>;
|
|
6703
6703
|
}
|
|
6704
6704
|
/**
|
|
6705
6705
|
* MotionGroupApi - axios parameter creator
|
|
@@ -6829,7 +6829,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
6829
6829
|
* @param {*} [options] Override http request option.
|
|
6830
6830
|
* @throws {RequiredError}
|
|
6831
6831
|
*/
|
|
6832
|
-
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
6832
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<MotionGroupState, any>>;
|
|
6833
6833
|
/**
|
|
6834
6834
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ 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.
|
|
6835
6835
|
* @summary Description
|
|
@@ -6839,7 +6839,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
6839
6839
|
* @param {*} [options] Override http request option.
|
|
6840
6840
|
* @throws {RequiredError}
|
|
6841
6841
|
*/
|
|
6842
|
-
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
6842
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<MotionGroupDescription, any>>;
|
|
6843
6843
|
/**
|
|
6844
6844
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
6845
6845
|
* @summary Stream State
|
|
@@ -6851,7 +6851,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
6851
6851
|
* @param {*} [options] Override http request option.
|
|
6852
6852
|
* @throws {RequiredError}
|
|
6853
6853
|
*/
|
|
6854
|
-
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
6854
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<MotionGroupState, any>>;
|
|
6855
6855
|
}
|
|
6856
6856
|
/**
|
|
6857
6857
|
* MotionGroupModelsApi - axios parameter creator
|
|
@@ -7000,7 +7000,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7000
7000
|
* @param {*} [options] Override http request option.
|
|
7001
7001
|
* @throws {RequiredError}
|
|
7002
7002
|
*/
|
|
7003
|
-
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
7003
|
+
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
7004
7004
|
[key: string]: Collider;
|
|
7005
7005
|
}[], any>>;
|
|
7006
7006
|
/**
|
|
@@ -7010,7 +7010,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7010
7010
|
* @param {*} [options] Override http request option.
|
|
7011
7011
|
* @throws {RequiredError}
|
|
7012
7012
|
*/
|
|
7013
|
-
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
7013
|
+
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<File, any>>;
|
|
7014
7014
|
/**
|
|
7015
7015
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
7016
7016
|
* @summary Get Kinematics
|
|
@@ -7018,14 +7018,14 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7018
7018
|
* @param {*} [options] Override http request option.
|
|
7019
7019
|
* @throws {RequiredError}
|
|
7020
7020
|
*/
|
|
7021
|
-
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
7021
|
+
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<KinematicModel, any>>;
|
|
7022
7022
|
/**
|
|
7023
7023
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns the list of supported motion group models.
|
|
7024
7024
|
* @summary Motion Group Models
|
|
7025
7025
|
* @param {*} [options] Override http request option.
|
|
7026
7026
|
* @throws {RequiredError}
|
|
7027
7027
|
*/
|
|
7028
|
-
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<
|
|
7028
|
+
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
7029
7029
|
/**
|
|
7030
7030
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
7031
7031
|
* @summary Download USD Model
|
|
@@ -7033,7 +7033,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7033
7033
|
* @param {*} [options] Override http request option.
|
|
7034
7034
|
* @throws {RequiredError}
|
|
7035
7035
|
*/
|
|
7036
|
-
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
7036
|
+
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<File, any>>;
|
|
7037
7037
|
}
|
|
7038
7038
|
/**
|
|
7039
7039
|
* NOVACloudApi - axios parameter creator
|
|
@@ -7134,7 +7134,7 @@ declare class NOVACloudApi extends BaseAPI {
|
|
|
7134
7134
|
* @param {*} [options] Override http request option.
|
|
7135
7135
|
* @throws {RequiredError}
|
|
7136
7136
|
*/
|
|
7137
|
-
connectToNovaCloud(completionTimeout?: number, cloudConnectionRequest?: CloudConnectionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7137
|
+
connectToNovaCloud(completionTimeout?: number, cloudConnectionRequest?: CloudConnectionRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CloudRegistrationSuccessResponse, any>>;
|
|
7138
7138
|
/**
|
|
7139
7139
|
* **Required permissions:** `can_manage_cloud_connection` - Manage NOVA Cloud connection ___ <!-- theme: danger --> > **Experimental** Disconnects this instance from NOVA Cloud and removes the local NATS leafnode configuration.
|
|
7140
7140
|
* @summary Disconnect from NOVA Cloud
|
|
@@ -7142,14 +7142,14 @@ declare class NOVACloudApi extends BaseAPI {
|
|
|
7142
7142
|
* @param {*} [options] Override http request option.
|
|
7143
7143
|
* @throws {RequiredError}
|
|
7144
7144
|
*/
|
|
7145
|
-
disconnectFromNovaCloud(completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7145
|
+
disconnectFromNovaCloud(completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CloudDisconnectionStatusDisconnected, any>>;
|
|
7146
7146
|
/**
|
|
7147
7147
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ <!-- theme: danger --> > **Experimental** Get the current NOVA Cloud connection config for this instance.
|
|
7148
7148
|
* @summary Get Connection Config
|
|
7149
7149
|
* @param {*} [options] Override http request option.
|
|
7150
7150
|
* @throws {RequiredError}
|
|
7151
7151
|
*/
|
|
7152
|
-
getNovaCloudConfig(options?: RawAxiosRequestConfig): Promise<
|
|
7152
|
+
getNovaCloudConfig(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CloudConfigStatus, any>>;
|
|
7153
7153
|
}
|
|
7154
7154
|
/**
|
|
7155
7155
|
* ProgramApi - axios parameter creator
|
|
@@ -7286,7 +7286,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
7286
7286
|
* @param {*} [options] Override http request option.
|
|
7287
7287
|
* @throws {RequiredError}
|
|
7288
7288
|
*/
|
|
7289
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
7289
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Program, any>>;
|
|
7290
7290
|
/**
|
|
7291
7291
|
* **Required permissions:** `can_operate_programs` - Execute and monitor programs ___ <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
7292
7292
|
* @summary List programs
|
|
@@ -7294,7 +7294,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
7294
7294
|
* @param {*} [options] Override http request option.
|
|
7295
7295
|
* @throws {RequiredError}
|
|
7296
7296
|
*/
|
|
7297
|
-
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7297
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Program[], any>>;
|
|
7298
7298
|
/**
|
|
7299
7299
|
* **Required permissions:** `can_operate_programs` - Execute and monitor programs ___ <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
7300
7300
|
* @summary Start the program
|
|
@@ -7304,7 +7304,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
7304
7304
|
* @param {*} [options] Override http request option.
|
|
7305
7305
|
* @throws {RequiredError}
|
|
7306
7306
|
*/
|
|
7307
|
-
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7307
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ProgramRun, any>>;
|
|
7308
7308
|
/**
|
|
7309
7309
|
* **Required permissions:** `can_operate_programs` - Execute and monitor programs ___ <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
7310
7310
|
* @summary Stop program run
|
|
@@ -7313,7 +7313,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
7313
7313
|
* @param {*} [options] Override http request option.
|
|
7314
7314
|
* @throws {RequiredError}
|
|
7315
7315
|
*/
|
|
7316
|
-
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
7316
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
7317
7317
|
}
|
|
7318
7318
|
/**
|
|
7319
7319
|
* RobotConfigurationsApi - axios parameter creator
|
|
@@ -7386,14 +7386,14 @@ declare class RobotConfigurationsApi extends BaseAPI {
|
|
|
7386
7386
|
* @param {*} [options] Override http request option.
|
|
7387
7387
|
* @throws {RequiredError}
|
|
7388
7388
|
*/
|
|
7389
|
-
getControllerConfigFromArpScan(robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7389
|
+
getControllerConfigFromArpScan(robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<RobotController[], any>>;
|
|
7390
7390
|
/**
|
|
7391
7391
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns the identifiers of available robot configurations. A robot configuration represents a robot controller with one or more attached motion groups.
|
|
7392
7392
|
* @summary List Robot Configurations
|
|
7393
7393
|
* @param {*} [options] Override http request option.
|
|
7394
7394
|
* @throws {RequiredError}
|
|
7395
7395
|
*/
|
|
7396
|
-
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<
|
|
7396
|
+
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
7397
7397
|
}
|
|
7398
7398
|
/**
|
|
7399
7399
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
@@ -7866,7 +7866,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7866
7866
|
* @param {*} [options] Override http request option.
|
|
7867
7867
|
* @throws {RequiredError}
|
|
7868
7868
|
*/
|
|
7869
|
-
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
7869
|
+
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
7870
7870
|
/**
|
|
7871
7871
|
* **Required permissions:** `can_write_collision_world` - Write collision models and scenes ___ Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
|
|
7872
7872
|
* @summary Delete Link Chain
|
|
@@ -7875,7 +7875,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7875
7875
|
* @param {*} [options] Override http request option.
|
|
7876
7876
|
* @throws {RequiredError}
|
|
7877
7877
|
*/
|
|
7878
|
-
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
7878
|
+
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
7879
7879
|
/**
|
|
7880
7880
|
* **Required permissions:** `can_write_collision_world` - Write collision models and scenes ___ Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
|
|
7881
7881
|
* @summary Delete Tool
|
|
@@ -7884,7 +7884,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7884
7884
|
* @param {*} [options] Override http request option.
|
|
7885
7885
|
* @throws {RequiredError}
|
|
7886
7886
|
*/
|
|
7887
|
-
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
7887
|
+
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
7888
7888
|
/**
|
|
7889
7889
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns the collider.
|
|
7890
7890
|
* @summary Get Collider
|
|
@@ -7893,7 +7893,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7893
7893
|
* @param {*} [options] Override http request option.
|
|
7894
7894
|
* @throws {RequiredError}
|
|
7895
7895
|
*/
|
|
7896
|
-
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
7896
|
+
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Collider, any>>;
|
|
7897
7897
|
/**
|
|
7898
7898
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns the collision link chain.
|
|
7899
7899
|
* @summary Get Link Chain
|
|
@@ -7902,7 +7902,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7902
7902
|
* @param {*} [options] Override http request option.
|
|
7903
7903
|
* @throws {RequiredError}
|
|
7904
7904
|
*/
|
|
7905
|
-
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
7905
|
+
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
7906
7906
|
[key: string]: Collider;
|
|
7907
7907
|
}[], any>>;
|
|
7908
7908
|
/**
|
|
@@ -7913,7 +7913,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7913
7913
|
* @param {*} [options] Override http request option.
|
|
7914
7914
|
* @throws {RequiredError}
|
|
7915
7915
|
*/
|
|
7916
|
-
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
7916
|
+
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
7917
7917
|
[key: string]: Collider;
|
|
7918
7918
|
}, any>>;
|
|
7919
7919
|
/**
|
|
@@ -7923,7 +7923,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7923
7923
|
* @param {*} [options] Override http request option.
|
|
7924
7924
|
* @throws {RequiredError}
|
|
7925
7925
|
*/
|
|
7926
|
-
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7926
|
+
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
7927
7927
|
[key: string]: {
|
|
7928
7928
|
[key: string]: Collider;
|
|
7929
7929
|
}[];
|
|
@@ -7935,7 +7935,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7935
7935
|
* @param {*} [options] Override http request option.
|
|
7936
7936
|
* @throws {RequiredError}
|
|
7937
7937
|
*/
|
|
7938
|
-
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7938
|
+
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
7939
7939
|
/**
|
|
7940
7940
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns all stored colliders.
|
|
7941
7941
|
* @summary List Colliders
|
|
@@ -7943,7 +7943,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7943
7943
|
* @param {*} [options] Override http request option.
|
|
7944
7944
|
* @throws {RequiredError}
|
|
7945
7945
|
*/
|
|
7946
|
-
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7946
|
+
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
7947
7947
|
[key: string]: Collider;
|
|
7948
7948
|
}, any>>;
|
|
7949
7949
|
/**
|
|
@@ -7953,7 +7953,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7953
7953
|
* @param {*} [options] Override http request option.
|
|
7954
7954
|
* @throws {RequiredError}
|
|
7955
7955
|
*/
|
|
7956
|
-
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7956
|
+
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
7957
7957
|
/**
|
|
7958
7958
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns the list of stored tools.
|
|
7959
7959
|
* @summary List Tools
|
|
@@ -7961,7 +7961,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7961
7961
|
* @param {*} [options] Override http request option.
|
|
7962
7962
|
* @throws {RequiredError}
|
|
7963
7963
|
*/
|
|
7964
|
-
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7964
|
+
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
7965
7965
|
[key: string]: {
|
|
7966
7966
|
[key: string]: Collider;
|
|
7967
7967
|
};
|
|
@@ -7973,7 +7973,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7973
7973
|
* @param {*} [options] Override http request option.
|
|
7974
7974
|
* @throws {RequiredError}
|
|
7975
7975
|
*/
|
|
7976
|
-
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7976
|
+
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
7977
7977
|
/**
|
|
7978
7978
|
* **Required permissions:** `can_write_collision_world` - Write collision models and scenes ___ Stores collider. - If the collider does not exist, it will be created. - If the collider exists, it will be updated.
|
|
7979
7979
|
* @summary Store Collider
|
|
@@ -7983,7 +7983,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7983
7983
|
* @param {*} [options] Override http request option.
|
|
7984
7984
|
* @throws {RequiredError}
|
|
7985
7985
|
*/
|
|
7986
|
-
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<
|
|
7986
|
+
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Collider, any>>;
|
|
7987
7987
|
/**
|
|
7988
7988
|
* **Required permissions:** `can_write_collision_world` - Write collision models and scenes ___ Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
|
|
7989
7989
|
* @summary Store Link Chain
|
|
@@ -7995,7 +7995,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7995
7995
|
*/
|
|
7996
7996
|
storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{
|
|
7997
7997
|
[key: string]: Collider;
|
|
7998
|
-
}>, options?: RawAxiosRequestConfig): Promise<
|
|
7998
|
+
}>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
7999
7999
|
[key: string]: Collider;
|
|
8000
8000
|
}[], any>>;
|
|
8001
8001
|
/**
|
|
@@ -8009,7 +8009,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8009
8009
|
*/
|
|
8010
8010
|
storeCollisionTool(cell: string, tool: string, requestBody: {
|
|
8011
8011
|
[key: string]: Collider;
|
|
8012
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
8012
|
+
}, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
8013
8013
|
[key: string]: Collider;
|
|
8014
8014
|
}, any>>;
|
|
8015
8015
|
}
|
|
@@ -8176,7 +8176,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
8176
8176
|
* @param {*} [options] Override http request option.
|
|
8177
8177
|
* @throws {RequiredError}
|
|
8178
8178
|
*/
|
|
8179
|
-
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8179
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8180
8180
|
/**
|
|
8181
8181
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns the stored collision setup.
|
|
8182
8182
|
* @summary Get Collision Setup
|
|
@@ -8185,7 +8185,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
8185
8185
|
* @param {*} [options] Override http request option.
|
|
8186
8186
|
* @throws {RequiredError}
|
|
8187
8187
|
*/
|
|
8188
|
-
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8188
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CollisionSetup, any>>;
|
|
8189
8189
|
/**
|
|
8190
8190
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns a list of stored collision setups.
|
|
8191
8191
|
* @summary List Collision Setups
|
|
@@ -8193,7 +8193,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
8193
8193
|
* @param {*} [options] Override http request option.
|
|
8194
8194
|
* @throws {RequiredError}
|
|
8195
8195
|
*/
|
|
8196
|
-
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8196
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
8197
8197
|
[key: string]: CollisionSetup;
|
|
8198
8198
|
}, any>>;
|
|
8199
8199
|
/**
|
|
@@ -8203,7 +8203,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
8203
8203
|
* @param {*} [options] Override http request option.
|
|
8204
8204
|
* @throws {RequiredError}
|
|
8205
8205
|
*/
|
|
8206
|
-
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8206
|
+
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
8207
8207
|
/**
|
|
8208
8208
|
* **Required permissions:** `can_write_collision_world` - Write collision models and scenes ___ Stores collision setup. - If the collision setup does not exist, it will be created. - If the collision setup exists, it will be updated.
|
|
8209
8209
|
* @summary Store Collision Setup
|
|
@@ -8213,7 +8213,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
8213
8213
|
* @param {*} [options] Override http request option.
|
|
8214
8214
|
* @throws {RequiredError}
|
|
8215
8215
|
*/
|
|
8216
|
-
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<
|
|
8216
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CollisionSetup, any>>;
|
|
8217
8217
|
}
|
|
8218
8218
|
/**
|
|
8219
8219
|
* StoreObjectApi - axios parameter creator
|
|
@@ -8409,7 +8409,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
8409
8409
|
* @param {*} [options] Override http request option.
|
|
8410
8410
|
* @throws {RequiredError}
|
|
8411
8411
|
*/
|
|
8412
|
-
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8412
|
+
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8413
8413
|
/**
|
|
8414
8414
|
* **Required permissions:** `can_write_objects` - Write stored objects ___ Delete an object <!-- theme: danger --> > This will delete persistently stored data.
|
|
8415
8415
|
* @summary Delete Object
|
|
@@ -8418,7 +8418,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
8418
8418
|
* @param {*} [options] Override http request option.
|
|
8419
8419
|
* @throws {RequiredError}
|
|
8420
8420
|
*/
|
|
8421
|
-
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
8421
|
+
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8422
8422
|
/**
|
|
8423
8423
|
* **Required permissions:** `can_read_objects` - Read stored objects ___ Returns content and metadata of a stored object.
|
|
8424
8424
|
* @summary Get Object
|
|
@@ -8427,7 +8427,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
8427
8427
|
* @param {*} [options] Override http request option.
|
|
8428
8428
|
* @throws {RequiredError}
|
|
8429
8429
|
*/
|
|
8430
|
-
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
8430
|
+
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<File, any>>;
|
|
8431
8431
|
/**
|
|
8432
8432
|
* **Required permissions:** `can_read_objects` - Read stored objects ___ Returns metadata. Object content is not returned.
|
|
8433
8433
|
* @summary Get Object Metadata
|
|
@@ -8436,7 +8436,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
8436
8436
|
* @param {*} [options] Override http request option.
|
|
8437
8437
|
* @throws {RequiredError}
|
|
8438
8438
|
*/
|
|
8439
|
-
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
8439
|
+
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8440
8440
|
/**
|
|
8441
8441
|
* **Required permissions:** `can_read_objects` - Read stored objects ___ List the keys for all objects.
|
|
8442
8442
|
* @summary List all Object Keys
|
|
@@ -8444,7 +8444,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
8444
8444
|
* @param {*} [options] Override http request option.
|
|
8445
8445
|
* @throws {RequiredError}
|
|
8446
8446
|
*/
|
|
8447
|
-
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8447
|
+
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
8448
8448
|
/**
|
|
8449
8449
|
* **Required permissions:** `can_write_objects` - Write stored objects ___ Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](#/operations/getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
|
|
8450
8450
|
* @summary Store Object
|
|
@@ -8457,7 +8457,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
8457
8457
|
*/
|
|
8458
8458
|
storeObject(cell: string, key: string, xMetadata?: {
|
|
8459
8459
|
[key: string]: string;
|
|
8460
|
-
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<
|
|
8460
|
+
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8461
8461
|
}
|
|
8462
8462
|
/**
|
|
8463
8463
|
* SystemApi - axios parameter creator
|
|
@@ -8776,7 +8776,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
8776
8776
|
*/
|
|
8777
8777
|
backupConfiguration(resources?: Array<string>, metadata?: {
|
|
8778
8778
|
[key: string]: string;
|
|
8779
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
8779
|
+
}, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<File, any>>;
|
|
8780
8780
|
/**
|
|
8781
8781
|
* **Required permissions:** `can_update_system` - Update system versions and services ___ Check if a more recent Wandelbots NOVA Version is available.
|
|
8782
8782
|
* @summary Check update
|
|
@@ -8784,7 +8784,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
8784
8784
|
* @param {*} [options] Override http request option.
|
|
8785
8785
|
* @throws {RequiredError}
|
|
8786
8786
|
*/
|
|
8787
|
-
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
8787
|
+
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string, any>>;
|
|
8788
8788
|
/**
|
|
8789
8789
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ <!-- theme: danger --> > **Experimental** Performs an address resolution protocol (ARP) scan on the specified interface/classless inter-domain routing (CIDR) and returns all discovered devices on the network by CIDR notation.
|
|
8790
8790
|
* @summary Get ARP-Scan
|
|
@@ -8794,7 +8794,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
8794
8794
|
* @param {*} [options] Override http request option.
|
|
8795
8795
|
* @throws {RequiredError}
|
|
8796
8796
|
*/
|
|
8797
|
-
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8797
|
+
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<NetworkDevice[], any>>;
|
|
8798
8798
|
/**
|
|
8799
8799
|
* **Required permissions:** `can_backup_system` - Create system backups ___ 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.
|
|
8800
8800
|
* @summary Retrieve Backup Status
|
|
@@ -8802,49 +8802,49 @@ declare class SystemApi extends BaseAPI {
|
|
|
8802
8802
|
* @param {*} [options] Override http request option.
|
|
8803
8803
|
* @throws {RequiredError}
|
|
8804
8804
|
*/
|
|
8805
|
-
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
8805
|
+
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ConfigurationArchiveStatus, any>>;
|
|
8806
8806
|
/**
|
|
8807
8807
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ 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.
|
|
8808
8808
|
* @summary Download Diagnosis Package
|
|
8809
8809
|
* @param {*} [options] Override http request option.
|
|
8810
8810
|
* @throws {RequiredError}
|
|
8811
8811
|
*/
|
|
8812
|
-
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<
|
|
8812
|
+
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<File, any>>;
|
|
8813
8813
|
/**
|
|
8814
8814
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ <!-- theme: danger --> > **Experimental** Get the network interfaces of the system.
|
|
8815
8815
|
* @summary Network Interfaces
|
|
8816
8816
|
* @param {*} [options] Override http request option.
|
|
8817
8817
|
* @throws {RequiredError}
|
|
8818
8818
|
*/
|
|
8819
|
-
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<
|
|
8819
|
+
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<NetworkInterface[], any>>;
|
|
8820
8820
|
/**
|
|
8821
8821
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ <!-- theme: danger --> > **Experimental** Get the current state of the network.
|
|
8822
8822
|
* @summary Network State
|
|
8823
8823
|
* @param {*} [options] Override http request option.
|
|
8824
8824
|
* @throws {RequiredError}
|
|
8825
8825
|
*/
|
|
8826
|
-
getNetworkState(options?: RawAxiosRequestConfig): Promise<
|
|
8826
|
+
getNetworkState(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<NetworkState, any>>;
|
|
8827
8827
|
/**
|
|
8828
8828
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Get the status of all system services.
|
|
8829
8829
|
* @summary Wandelbots NOVA status
|
|
8830
8830
|
* @param {*} [options] Override http request option.
|
|
8831
8831
|
* @throws {RequiredError}
|
|
8832
8832
|
*/
|
|
8833
|
-
getSystemStatus(options?: RawAxiosRequestConfig): Promise<
|
|
8833
|
+
getSystemStatus(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ServiceStatus[], any>>;
|
|
8834
8834
|
/**
|
|
8835
8835
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Get the current Wandelbots NOVA version.
|
|
8836
8836
|
* @summary Wandelbots NOVA Version
|
|
8837
8837
|
* @param {*} [options] Override http request option.
|
|
8838
8838
|
* @throws {RequiredError}
|
|
8839
8839
|
*/
|
|
8840
|
-
getSystemVersion(options?: RawAxiosRequestConfig): Promise<
|
|
8840
|
+
getSystemVersion(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string, any>>;
|
|
8841
8841
|
/**
|
|
8842
8842
|
* **Required permissions:** `can_backup_system` - Create system backups ___ Retrieves a list of all available configuration resources for backup purposes.
|
|
8843
8843
|
* @summary List Configuration Resources
|
|
8844
8844
|
* @param {*} [options] Override http request option.
|
|
8845
8845
|
* @throws {RequiredError}
|
|
8846
8846
|
*/
|
|
8847
|
-
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<
|
|
8847
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ConfigurationResource[], any>>;
|
|
8848
8848
|
/**
|
|
8849
8849
|
* **Required permissions:** `can_restore_system` - Restore system backups ___ Restores a previously backed up configuration. If an empty array of resources is provided, all resources from the backup will be restored.
|
|
8850
8850
|
* @summary Restore Configuration Backup
|
|
@@ -8853,7 +8853,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
8853
8853
|
* @param {*} [options] Override http request option.
|
|
8854
8854
|
* @throws {RequiredError}
|
|
8855
8855
|
*/
|
|
8856
|
-
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
8856
|
+
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8857
8857
|
/**
|
|
8858
8858
|
* **Required permissions:** `can_update_system` - Update system versions and services ___ Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored. System updates only apply to cells without an explicit chart version. Pinned versions are always preserved; setting `update_cells=false` pins unversioned cells to the current system version before updating.
|
|
8859
8859
|
* @summary Update Wandelbots NOVA version
|
|
@@ -8861,7 +8861,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
8861
8861
|
* @param {*} [options] Override http request option.
|
|
8862
8862
|
* @throws {RequiredError}
|
|
8863
8863
|
*/
|
|
8864
|
-
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8864
|
+
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8865
8865
|
}
|
|
8866
8866
|
/**
|
|
8867
8867
|
* TrajectoryCachingApi - axios parameter creator
|
|
@@ -9035,7 +9035,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9035
9035
|
* @param {*} [options] Override http request option.
|
|
9036
9036
|
* @throws {RequiredError}
|
|
9037
9037
|
*/
|
|
9038
|
-
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9038
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<AddTrajectoryResponse, any>>;
|
|
9039
9039
|
/**
|
|
9040
9040
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Clear the trajectory cache.
|
|
9041
9041
|
* @summary Clear Trajectories
|
|
@@ -9044,7 +9044,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9044
9044
|
* @param {*} [options] Override http request option.
|
|
9045
9045
|
* @throws {RequiredError}
|
|
9046
9046
|
*/
|
|
9047
|
-
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
9047
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
9048
9048
|
/**
|
|
9049
9049
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Delete a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
9050
9050
|
* @summary Delete Trajectory
|
|
@@ -9054,7 +9054,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9054
9054
|
* @param {*} [options] Override http request option.
|
|
9055
9055
|
* @throws {RequiredError}
|
|
9056
9056
|
*/
|
|
9057
|
-
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
9057
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
9058
9058
|
/**
|
|
9059
9059
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
9060
9060
|
* @summary Get Trajectory
|
|
@@ -9064,7 +9064,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9064
9064
|
* @param {*} [options] Override http request option.
|
|
9065
9065
|
* @throws {RequiredError}
|
|
9066
9066
|
*/
|
|
9067
|
-
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
9067
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<GetTrajectoryResponse, any>>;
|
|
9068
9068
|
/**
|
|
9069
9069
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ List currently cached trajectories. Use [addTrajectory](#/operations/addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
9070
9070
|
* @summary List Trajectories
|
|
@@ -9073,7 +9073,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9073
9073
|
* @param {*} [options] Override http request option.
|
|
9074
9074
|
* @throws {RequiredError}
|
|
9075
9075
|
*/
|
|
9076
|
-
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
9076
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ListTrajectoriesResponse, any>>;
|
|
9077
9077
|
}
|
|
9078
9078
|
/**
|
|
9079
9079
|
* TrajectoryExecutionApi - axios parameter creator
|
|
@@ -9133,7 +9133,7 @@ declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
9133
9133
|
* @param {*} [options] Override http request option.
|
|
9134
9134
|
* @throws {RequiredError}
|
|
9135
9135
|
*/
|
|
9136
|
-
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9136
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
9137
9137
|
}
|
|
9138
9138
|
/**
|
|
9139
9139
|
* TrajectoryPlanningApi - axios parameter creator
|
|
@@ -9270,7 +9270,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
9270
9270
|
* @param {*} [options] Override http request option.
|
|
9271
9271
|
* @throws {RequiredError}
|
|
9272
9272
|
*/
|
|
9273
|
-
mergeTrajectories(cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9273
|
+
mergeTrajectories(cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<MergeTrajectoriesResponse, any>>;
|
|
9274
9274
|
/**
|
|
9275
9275
|
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
9276
9276
|
* @summary Plan Collision-Free Trajectory
|
|
@@ -9279,7 +9279,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
9279
9279
|
* @param {*} [options] Override http request option.
|
|
9280
9280
|
* @throws {RequiredError}
|
|
9281
9281
|
*/
|
|
9282
|
-
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9282
|
+
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<PlanCollisionFreeResponse, any>>;
|
|
9283
9283
|
/**
|
|
9284
9284
|
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
9285
9285
|
* @summary Plan Trajectory
|
|
@@ -9288,7 +9288,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
9288
9288
|
* @param {*} [options] Override http request option.
|
|
9289
9289
|
* @throws {RequiredError}
|
|
9290
9290
|
*/
|
|
9291
|
-
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9291
|
+
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
9292
9292
|
/**
|
|
9293
9293
|
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ <!-- theme: danger --> > **Experimental** Searches collision-free trajectories for multiple motion groups simultaneously within a cell. This is the multi-robot variant of collision-free path search — it coordinates paths so that several motion groups, e.g., multiple robot arms, can move from start to target positions without colliding with each other or with the environment. The caller provides per-motion-group setups (robot model, cycle time, mounting, TCP offset, limits, payload, collision geometry), per-motion-group point-to-point path definitions (start and target joint positions), optional cross-group collision setups defining which link-chain/tool colliders to consider between groups plus static environment colliders, and optional RRT-Connect algorithm settings (max iterations, step size, smoothing, blending). On success the response contains a time-synchronized trajectory with joint positions per motion group at shared timestamps so their motions are temporally coordinated. On failure it returns feedback indicating why planning failed, e.g., max iterations exceeded.
|
|
9294
9294
|
* @summary Search Collision-Free Trajectories for Multiple Motion Groups
|
|
@@ -9297,7 +9297,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
9297
9297
|
* @param {*} [options] Override http request option.
|
|
9298
9298
|
* @throws {RequiredError}
|
|
9299
9299
|
*/
|
|
9300
|
-
searchCollisionFreeMultiMotionGroup(cell: string, multiSearchCollisionFreeRequest: MultiSearchCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9300
|
+
searchCollisionFreeMultiMotionGroup(cell: string, multiSearchCollisionFreeRequest: MultiSearchCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<MultiSearchCollisionFreeResponse, any>>;
|
|
9301
9301
|
}
|
|
9302
9302
|
/**
|
|
9303
9303
|
* VersionApi - axios parameter creator
|
|
@@ -9345,7 +9345,7 @@ declare class VersionApi extends BaseAPI {
|
|
|
9345
9345
|
* @param {*} [options] Override http request option.
|
|
9346
9346
|
* @throws {RequiredError}
|
|
9347
9347
|
*/
|
|
9348
|
-
getApiVersion(options?: RawAxiosRequestConfig): Promise<
|
|
9348
|
+
getApiVersion(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ApiVersion, any>>;
|
|
9349
9349
|
}
|
|
9350
9350
|
/**
|
|
9351
9351
|
* VirtualControllerApi - axios parameter creator
|
|
@@ -9982,7 +9982,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
9982
9982
|
* @param {*} [options] Override http request option.
|
|
9983
9983
|
* @throws {RequiredError}
|
|
9984
9984
|
*/
|
|
9985
|
-
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<
|
|
9985
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
9986
9986
|
/**
|
|
9987
9987
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json_data** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json_data**: Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). - **extracted_motion_group_id** (required when using json_data): The motion group identifier to extract from the provided JSON configuration. - **motion_group**: Unique identifier for the motion group to be added. - **initial_joint_position**: Specifies the initial joint position for the added motion group. <!-- theme: info --> > #### NOTE > > When a motion group is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new motion group may not yet be available for use.
|
|
9988
9988
|
* @summary Add Motion Group
|
|
@@ -9992,7 +9992,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
9992
9992
|
* @param {*} [options] Override http request option.
|
|
9993
9993
|
* @throws {RequiredError}
|
|
9994
9994
|
*/
|
|
9995
|
-
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9995
|
+
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
9996
9996
|
/**
|
|
9997
9997
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Adds a new safety zone to the virtual robot controller. Safety zones define geometric boundaries that restrict or permit robot motion in 3D space. Each zone has a `geometry` that defines its shape, and two flags that control its behavior: - **`restricted: true`** the robot is not allowed to enter this zone. - **`inverted: true`** the zone applies to the **outside** of the shape, meaning the shape defines the *allowed* region; everything outside is the zone. Combined with `restricted: true`, the robot must stay **inside** the shape. Common combinations: | `restricted` | `inverted` | Effect | |---|---|---| | `true` | `false` | Keep-out zone, the robot cannot enter the shape, e.g., obstacle, table, wall | | `true` | `true` | Keep-in zone, the robot must stay inside the shape, e.g., workspace envelope / cell boundary | The `mg_uid` field specifies which motion group the safety zone is enforced for and must match an existing motion group UID on the controller. The `uid_ref_cs` field defines the coordinate system in which the geometry coordinates are expressed. The coordinate system must be defined on the controller beforehand. If empty (`\"\"`), the World coordinate system is used. Using an incorrect coordinate system places the safety zone in a different physical location. --- ## Geometry Shape Reference All coordinates are in **millimetres (mm)**. Choose the shape that best fits the physical boundary. --- ### Box A rectangular cuboid (box) defined by its **center point** and **three face centers** (`neighbour`). Each face center is the center of one of the three principal faces of the box and encodes both the size and orientation of the box. The distance from the center to each face center equals half the edge length along that axis. This format is used directly by robot controllers (FANUC, KUKA, etc.) and supports arbitrary orientations, including left-handed coordinate systems that parametric (size + quaternion) formats cannot represent. **When to use:** Cell workspace envelope, machine enclosure, table, rectangular obstacle, pallet zone. **How to define:** ``` center → geometric center of the box [x, y, z] neighbour = [ x1, y1, z1, ← center of the face along the first axis x2, y2, z2, ← center of the face along the second axis x3, y3, z3 ← center of the face along the third axis ] edge_length_i = 2 × ||neighbour_i − center|| ``` For an axis-aligned box with `center = [cx, cy, cz]` and half-sizes `[hx, hy, hz]`: ``` neighbour = [cx+hx, cy, cz, cx, cy+hy, cz, cx, cy, cz+hz] ``` --- ### Prism An extruded polygon is a 2D closed polygon (defined in the XY plane) extruded vertically between `bottom` and `top` Z coordinates. The polygon can be convex or concave. **When to use:** Irregular floor-plan areas (aisles, loading bays, L-shaped zones), conveyor corridors, or any zone with a non-rectangular footprint. **How to define:** ``` point = [x1, y1, x2, y2, x3, y3, ...] ← 2D vertices (XY), flattened, ≥ 3 points top = upper Z bound [mm] bottom = lower Z bound [mm] ``` Points must form a closed polygon; the last point implicitly connects to the first. --- ### Sphere A perfect sphere defined by its **center point** and **radius**. **When to use:** Protection zones around sensors, cameras, workpieces, point-like obstacles, singularity avoidance zones around the robot base. **How to define:** ``` center = [x, y, z] ← center of the sphere [mm] radius ← radius [mm] ``` --- ### Capsule A cylinder with hemispherical caps at each end, defined by two axis endpoints (`top`, `bottom`) and a **radius**. The axis can have any orientation. **When to use:** Pipes, cable trays, vertical columns, horizontal beams, or tube-shaped obstacles. **How to define:** ``` top = [x, y, z] ← center of the top hemisphere [mm] bottom = [x, y, z] ← center of the bottom hemisphere [mm] radius ← cylinder + hemisphere radius [mm] ``` The total length of the capsule is `||top − bottom|| + 2 × radius`. --- ### Lozenge A rounded rectangle (stadium/discorectangle shape) in a plane, defined by a **center pose**, two **dimensions**, and a **corner radius**. The plane orientation is defined by the quaternion in `center`. **When to use:** Conveyor belt surfaces, worktables with rounded edges, or flat rectangular zones in arbitrary orientations. **How to define:** ``` center.x/y/z ← position of the center [mm] center.qx/qy/qz/qw ← orientation as unit quaternion (identity = XY plane) x_dimension ← total length along local X axis [mm] y_dimension ← total width along local Y axis [mm] radius ← corner rounding radius [mm] ``` For a horizontal lozenge, use identity quaternion `(qx=0, qy=0, qz=0, qw=1)`. --- ### Plane A mathematical half-space plane defined by its **3D vertices**. All vertices must be coplanar. The plane is unbounded (infinite extent in all directions parallel to the surface). The points define the plane\'s orientation and position only. **When to use:** Floor boundaries, virtual walls, tilted surfaces, e.g., ramps, inclined conveyors, or flat custom barriers. **How to define:** ``` point = [x1, y1, z1, x2, y2, z2, x3, y3, z3, ...] ← 3D vertices, flattened, ≥ 3 points ``` Points must be coplanar and form a closed polygon. --- <!-- theme: info --> > #### NOTE > > When a safety zone is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - All connections to the virtual robot are closed and re-established, introducing a short delay before the system is fully operational again. > - The safety checksum is automatically updated to reflect the configuration change. > > The API call **does not wait until the restart and re-synchronization are complete**.
|
|
9998
9998
|
* @summary Add Safety Zone
|
|
@@ -10002,7 +10002,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10002
10002
|
* @param {*} [options] Override http request option.
|
|
10003
10003
|
* @throws {RequiredError}
|
|
10004
10004
|
*/
|
|
10005
|
-
addVirtualControllerSafetyZone(cell: string, controller: string, safetyZone: SafetyZone, options?: RawAxiosRequestConfig): Promise<
|
|
10005
|
+
addVirtualControllerSafetyZone(cell: string, controller: string, safetyZone: SafetyZone, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
10006
10006
|
/**
|
|
10007
10007
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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.
|
|
10008
10008
|
* @summary Add TCP
|
|
@@ -10014,7 +10014,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10014
10014
|
* @param {*} [options] Override http request option.
|
|
10015
10015
|
* @throws {RequiredError}
|
|
10016
10016
|
*/
|
|
10017
|
-
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<
|
|
10017
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
10018
10018
|
/**
|
|
10019
10019
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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.
|
|
10020
10020
|
* @summary Delete Coordinate System
|
|
@@ -10025,7 +10025,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10025
10025
|
* @param {*} [options] Override http request option.
|
|
10026
10026
|
* @throws {RequiredError}
|
|
10027
10027
|
*/
|
|
10028
|
-
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
10028
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
10029
10029
|
/**
|
|
10030
10030
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Removes a motion group configuration from the virtual controller. <!-- theme: info --> > #### NOTE > > When a motion group is removed, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**.
|
|
10031
10031
|
* @summary Delete Motion Group
|
|
@@ -10035,7 +10035,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10035
10035
|
* @param {*} [options] Override http request option.
|
|
10036
10036
|
* @throws {RequiredError}
|
|
10037
10037
|
*/
|
|
10038
|
-
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
10038
|
+
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
10039
10039
|
/**
|
|
10040
10040
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Removes a safety zone from the virtual robot controller. <!-- theme: info --> > #### NOTE > > When a safety zone is removed, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - All connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > - The safety checksum is automatically updated to reflect the configuration change. > > The API call itself **does not wait until the restart and re-synchronization are complete**.
|
|
10041
10041
|
* @summary Delete Safety Zone
|
|
@@ -10045,7 +10045,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10045
10045
|
* @param {*} [options] Override http request option.
|
|
10046
10046
|
* @throws {RequiredError}
|
|
10047
10047
|
*/
|
|
10048
|
-
deleteVirtualControllerSafetyZone(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<
|
|
10048
|
+
deleteVirtualControllerSafetyZone(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
10049
10049
|
/**
|
|
10050
10050
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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.
|
|
10051
10051
|
* @summary Remove TCP
|
|
@@ -10056,7 +10056,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10056
10056
|
* @param {*} [options] Override http request option.
|
|
10057
10057
|
* @throws {RequiredError}
|
|
10058
10058
|
*/
|
|
10059
|
-
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<
|
|
10059
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
10060
10060
|
/**
|
|
10061
10061
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
10062
10062
|
* @summary Get Emergency Stop State
|
|
@@ -10065,7 +10065,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10065
10065
|
* @param {*} [options] Override http request option.
|
|
10066
10066
|
* @throws {RequiredError}
|
|
10067
10067
|
*/
|
|
10068
|
-
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10068
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Flag, any>>;
|
|
10069
10069
|
/**
|
|
10070
10070
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
10071
10071
|
* @summary Get Motion Group State
|
|
@@ -10075,7 +10075,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10075
10075
|
* @param {*} [options] Override http request option.
|
|
10076
10076
|
* @throws {RequiredError}
|
|
10077
10077
|
*/
|
|
10078
|
-
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
10078
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<MotionGroupJoints, any>>;
|
|
10079
10079
|
/**
|
|
10080
10080
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Gets information on the motion group.
|
|
10081
10081
|
* @summary Motion Group Description
|
|
@@ -10084,7 +10084,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10084
10084
|
* @param {*} [options] Override http request option.
|
|
10085
10085
|
* @throws {RequiredError}
|
|
10086
10086
|
*/
|
|
10087
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10087
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<MotionGroupInfo[], any>>;
|
|
10088
10088
|
/**
|
|
10089
10089
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
10090
10090
|
* @summary Get Operation Mode
|
|
@@ -10093,7 +10093,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10093
10093
|
* @param {*} [options] Override http request option.
|
|
10094
10094
|
* @throws {RequiredError}
|
|
10095
10095
|
*/
|
|
10096
|
-
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10096
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<OpMode, any>>;
|
|
10097
10097
|
/**
|
|
10098
10098
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
10099
10099
|
* @summary Get Mounting
|
|
@@ -10103,7 +10103,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10103
10103
|
* @param {*} [options] Override http request option.
|
|
10104
10104
|
* @throws {RequiredError}
|
|
10105
10105
|
*/
|
|
10106
|
-
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
10106
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CoordinateSystem, any>>;
|
|
10107
10107
|
/**
|
|
10108
10108
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Gets all safety zones configured in the virtual robot controller. Safety zones define geometric boundaries that restrict robot motion or define protected areas in the workspace.
|
|
10109
10109
|
* @summary List Safety Zones
|
|
@@ -10112,7 +10112,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10112
10112
|
* @param {*} [options] Override http request option.
|
|
10113
10113
|
* @throws {RequiredError}
|
|
10114
10114
|
*/
|
|
10115
|
-
getVirtualControllerSafetyZones(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10115
|
+
getVirtualControllerSafetyZones(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<SafetyZones, any>>;
|
|
10116
10116
|
/**
|
|
10117
10117
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Lists all coordinate systems on the robot controller.
|
|
10118
10118
|
* @summary List Coordinate Systems
|
|
@@ -10121,7 +10121,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10121
10121
|
* @param {*} [options] Override http request option.
|
|
10122
10122
|
* @throws {RequiredError}
|
|
10123
10123
|
*/
|
|
10124
|
-
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10124
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CoordinateSystem[], any>>;
|
|
10125
10125
|
/**
|
|
10126
10126
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
|
|
10127
10127
|
* @summary List TCPs
|
|
@@ -10131,7 +10131,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10131
10131
|
* @param {*} [options] Override http request option.
|
|
10132
10132
|
* @throws {RequiredError}
|
|
10133
10133
|
*/
|
|
10134
|
-
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
10134
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<RobotTcp[], any>>;
|
|
10135
10135
|
/**
|
|
10136
10136
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
10137
10137
|
* @summary Push or Release Emergency Stop
|
|
@@ -10141,7 +10141,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10141
10141
|
* @param {*} [options] Override http request option.
|
|
10142
10142
|
* @throws {RequiredError}
|
|
10143
10143
|
*/
|
|
10144
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
10144
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
10145
10145
|
/**
|
|
10146
10146
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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.
|
|
10147
10147
|
* @summary Set Motion Group State
|
|
@@ -10152,7 +10152,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10152
10152
|
* @param {*} [options] Override http request option.
|
|
10153
10153
|
* @throws {RequiredError}
|
|
10154
10154
|
*/
|
|
10155
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<
|
|
10155
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
10156
10156
|
/**
|
|
10157
10157
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
10158
10158
|
* @summary Set Operation Mode
|
|
@@ -10162,7 +10162,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10162
10162
|
* @param {*} [options] Override http request option.
|
|
10163
10163
|
* @throws {RequiredError}
|
|
10164
10164
|
*/
|
|
10165
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<
|
|
10165
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
10166
10166
|
/**
|
|
10167
10167
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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.
|
|
10168
10168
|
* @summary Set Mounting
|
|
@@ -10173,7 +10173,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10173
10173
|
* @param {*} [options] Override http request option.
|
|
10174
10174
|
* @throws {RequiredError}
|
|
10175
10175
|
*/
|
|
10176
|
-
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
10176
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CoordinateSystem, any>>;
|
|
10177
10177
|
}
|
|
10178
10178
|
/**
|
|
10179
10179
|
* VirtualControllerBehaviorApi - axios parameter creator
|
|
@@ -10317,7 +10317,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
10317
10317
|
* @param {*} [options] Override http request option.
|
|
10318
10318
|
* @throws {RequiredError}
|
|
10319
10319
|
*/
|
|
10320
|
-
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10320
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ExternalJointStreamDatapoint[], any>>;
|
|
10321
10321
|
/**
|
|
10322
10322
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Get the cycle time of controller communication in [ms].
|
|
10323
10323
|
* @summary Get Cycle Time
|
|
@@ -10326,7 +10326,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
10326
10326
|
* @param {*} [options] Override http request option.
|
|
10327
10327
|
* @throws {RequiredError}
|
|
10328
10328
|
*/
|
|
10329
|
-
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10329
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CycleTime, any>>;
|
|
10330
10330
|
/**
|
|
10331
10331
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
10332
10332
|
* @summary Get Behavior
|
|
@@ -10335,7 +10335,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
10335
10335
|
* @param {*} [options] Override http request option.
|
|
10336
10336
|
* @throws {RequiredError}
|
|
10337
10337
|
*/
|
|
10338
|
-
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10338
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Behavior, any>>;
|
|
10339
10339
|
/**
|
|
10340
10340
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Set virtual controller behavior. See query parameters for details.
|
|
10341
10341
|
* @summary Set Behavior
|
|
@@ -10345,7 +10345,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
10345
10345
|
* @param {*} [options] Override http request option.
|
|
10346
10346
|
* @throws {RequiredError}
|
|
10347
10347
|
*/
|
|
10348
|
-
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<
|
|
10348
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
10349
10349
|
}
|
|
10350
10350
|
/**
|
|
10351
10351
|
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
@@ -10474,7 +10474,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
10474
10474
|
* @param {*} [options] Override http request option.
|
|
10475
10475
|
* @throws {RequiredError}
|
|
10476
10476
|
*/
|
|
10477
|
-
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
10477
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<IOValue[], any>>;
|
|
10478
10478
|
/**
|
|
10479
10479
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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.
|
|
10480
10480
|
* @summary List Descriptions
|
|
@@ -10487,7 +10487,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
10487
10487
|
* @param {*} [options] Override http request option.
|
|
10488
10488
|
* @throws {RequiredError}
|
|
10489
10489
|
*/
|
|
10490
|
-
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
10490
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<IODescription[], any>>;
|
|
10491
10491
|
/**
|
|
10492
10492
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Sets a list of values of a virtual controller inputs/outputs.
|
|
10493
10493
|
* @summary Set Input/Ouput Values
|
|
@@ -10497,7 +10497,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
10497
10497
|
* @param {*} [options] Override http request option.
|
|
10498
10498
|
* @throws {RequiredError}
|
|
10499
10499
|
*/
|
|
10500
|
-
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
10500
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
10501
10501
|
}
|
|
10502
10502
|
//#endregion
|
|
10503
10503
|
export { AbbController, AbbControllerEgmServer, AbbControllerKindEnum, ActivateLicenseRequest, AddTrajectoryError, AddTrajectoryErrorData, AddTrajectoryRequest, AddTrajectoryResponse, AddVirtualControllerMotionGroupRequest, ApiVersion, App, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAuto, BlendingAutoBlendingNameEnum, BlendingPosition, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValue, BooleanValueValueTypeEnum, Box, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIODescription, BusIOModbusClient, BusIOModbusClientBusTypeEnum, BusIOModbusServer, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClient, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServer, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtual, BusIOModbusVirtualBusTypeEnum, BusIOProfinet, BusIOProfinetBusTypeEnum, BusIOProfinetDefaultRoute, BusIOProfinetIpConfig, BusIOProfinetNetwork, BusIOProfinetSlot, BusIOProfinetVirtual, BusIOProfinetVirtualBusTypeEnum, BusIOType, BusIOsState, BusIOsStateEnum, COLLECTION_FORMATS, Capsule, CapsuleShapeTypeEnum, CartesianLimits, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, CloudConfigStatus, CloudConfigStatusConfigured, CloudConfigStatusConfiguredStatusEnum, CloudConfigStatusNotConfigured, CloudConfigStatusNotConfiguredStatusEnum, CloudConfiguration, CloudConnectionError, CloudConnectionErrorError, CloudConnectionErrorInvalidToken, CloudConnectionErrorInvalidTokenCodeEnum, CloudConnectionErrorInvalidTokenDetails, CloudConnectionErrorInvalidTokenDetailsCloudResponse, CloudConnectionErrorLeafnodeConnectionError, CloudConnectionErrorLeafnodeConnectionErrorCodeEnum, CloudConnectionErrorLeafnodeConnectionErrorDetails, CloudConnectionErrorLeafnodeConnectionTimeout, CloudConnectionErrorLeafnodeConnectionTimeoutCodeEnum, CloudConnectionErrorLeafnodeRestartTimeout, CloudConnectionErrorLeafnodeRestartTimeoutCodeEnum, CloudConnectionErrorNatsFailed, CloudConnectionErrorNatsFailedCodeEnum, CloudConnectionErrorNatsFailedDetails, CloudConnectionErrorUnexpectedResponse, CloudConnectionErrorUnexpectedResponseCodeEnum, CloudConnectionErrorUnexpectedResponseDetails, CloudConnectionErrorUnexpectedResponseDetailsCloudResponse, CloudConnectionRequest, CloudDisconnectionError, CloudDisconnectionStatusDisconnected, CloudDisconnectionStatusDisconnectedStatusEnum, CloudDisconnectionStatusDisconnecting, CloudDisconnectionStatusDisconnectingStatusEnum, CloudRegistrationSuccessResponse, Collider, ColliderShape, Collision, CollisionContact, CollisionError, CollisionErrorKindEnum, CollisionFreeAlgorithm, CollisionMotionGroup, CollisionSetup, Comparator, Configuration, ConfigurationArchiveStatus, ConfigurationArchiveStatusCreating, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusError, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccess, ConfigurationArchiveStatusSuccessStatusEnum, ConfigurationParameters, ConfigurationResource, ConstrainedPose, ContainerEnvironmentInner, ContainerImage, ContainerImageSecretsInner, ContainerResources, ContainerStorage, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerDescription, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHull, ConvexHullShapeTypeEnum, CoordinateSystem, CoordinateSystemData, CubicSplineParameter, CycleTime, Cylinder, CylinderShapeTypeEnum, DHParameter, Direction, DirectionConstraint, DirectionConstraintConstraintNameEnum, ErrorDirectionConstraintNotMet, ErrorDirectionConstraintNotMetErrorFeedbackNameEnum, ErrorDirectionConstraintNotNormalized, ErrorDirectionConstraintNotNormalizedErrorFeedbackNameEnum, ErrorInvalidJointCount, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceeded, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollision, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceeded, ErrorMaxIterationsExceededErrorFeedbackNameEnum, ErrorMotionGroupKeyMismatch, ErrorUnsupportedOperation, ErrorUnsupportedOperationErrorFeedbackNameEnum, Execute, ExecuteDetails, ExecuteJoggingRequest, ExecuteJoggingResponse, ExecuteTrajectoryRequest, ExecuteTrajectoryResponse, ExternalJointStreamDatapoint, ExternalJointStreamRequest, FanucController, FanucControllerKindEnum, FeedbackCollision, FeedbackCollisionErrorFeedbackNameEnum, FeedbackCommandsMissing, FeedbackCommandsMissingErrorFeedbackNameEnum, FeedbackCubicSplineIsNotIncreasing, FeedbackCubicSplineIsNotIncreasingErrorFeedbackNameEnum, FeedbackCubicSplineNotAtStartPose, FeedbackCubicSplineNotAtStartPoseErrorFeedbackNameEnum, FeedbackDirectionConstraintNoSolutionExists, FeedbackDirectionConstraintNoSolutionExistsErrorFeedbackNameEnum, FeedbackDirectionConstraintNotMet, FeedbackDirectionConstraintNotMetErrorFeedbackNameEnum, FeedbackDirectionConstraintNotNormalized, FeedbackDirectionConstraintNotNormalizedErrorFeedbackNameEnum, FeedbackInvalidDof, FeedbackInvalidDofErrorFeedbackNameEnum, FeedbackInvalidNanValue, FeedbackInvalidNanValueErrorFeedbackNameEnum, FeedbackInvalidSamplingTime, FeedbackInvalidSamplingTimeErrorFeedbackNameEnum, FeedbackJointLimitExceeded, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackNoSolutionInCurrentConfiguration, FeedbackNoSolutionInCurrentConfigurationErrorFeedbackNameEnum, FeedbackOutOfWorkspace, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularity, FeedbackSingularityErrorFeedbackNameEnum, FeedbackStartJointsMissing, FeedbackStartJointsMissingErrorFeedbackNameEnum, FeedbackTorqueExceeded, FeedbackTorqueExceededErrorFeedbackNameEnum, Flag, FlangePayload, FloatValue, FloatValueValueTypeEnum, ForwardKinematics422Response, ForwardKinematicsRequest, ForwardKinematicsResponse, ForwardKinematicsValidationError, GetTrajectoryResponse, HTTPValidationError, IOBooleanValue, IOBooleanValueValueTypeEnum, IOBoundary, IODescription, IODirection, IOFloatValue, IOFloatValueValueTypeEnum, IOIntegerValue, IOIntegerValueValueTypeEnum, IOOrigin, IOValue, IOValueType, ImageCredentials, InconsistentTrajectorySizeError, InconsistentTrajectorySizeErrorInconsistentTrajectorySize, InconsistentTrajectorySizeErrorKindEnum, InitializeJoggingRequest, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponse, InitializeJoggingResponseKindEnum, InitializeMovementRequest, InitializeMovementRequestMessageTypeEnum, InitializeMovementRequestTrajectory, InitializeMovementResponse, InitializeMovementResponseKindEnum, IntegerValue, IntegerValueValueTypeEnum, InvalidDofError, InvalidDofErrorInvalidDof, InvalidDofErrorKindEnum, InverseKinematics422Response, InverseKinematicsRequest, InverseKinematicsResponse, InverseKinematicsValidationError, InverseKinematicsValidationErrorAllOfData, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetails, JoggingDetailsKindEnum, JoggingDetailsState, JoggingPausedByUser, JoggingPausedByUserKindEnum, JoggingPausedNearCollision, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimit, JoggingPausedNearJointLimitKindEnum, JoggingPausedNearSingularity, JoggingPausedNearSingularityKindEnum, JoggingPausedOnIO, JoggingPausedOnIOKindEnum, JoggingRunning, JoggingRunningKindEnum, JointLimitExceededError, JointLimitExceededErrorKindEnum, JointLimits, JointPTPMotion, JointTrajectory, JointTypeEnum, JointVelocityRequest, JointVelocityRequestMessageTypeEnum, JointVelocityResponse, JointVelocityResponseKindEnum, KinematicModel, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaController, KukaControllerKindEnum, KukaControllerRsiServer, License, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatus, LicenseStatusEnum, LimitRange, LimitSet, LimitsOverride, ListTrajectoriesResponse, Manufacturer, MergeTrajectories422Response, MergeTrajectoriesError, MergeTrajectoriesErrorErrorFeedback, MergeTrajectoriesRequest, MergeTrajectoriesResponse, MergeTrajectoriesResponseFeedbackInner, MergeTrajectoriesSegment, MergeTrajectoriesValidationError, MidpointInsertionAlgorithm, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIO, ModbusIOArea, ModbusIOByteOrder, ModbusIOData, ModbusIOTypeEnum, ModelError, MotionCommand, MotionCommandBlending, MotionCommandPath, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupDescription, MotionGroupFromJson, MotionGroupFromType, MotionGroupInfo, MotionGroupJoints, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MotionGroupSetup, MotionGroupState, MotionGroupStateJointLimitReached, MovementErrorResponse, MovementErrorResponseKindEnum, MultiCollisionSetup, MultiErrorInvalidJointCount, MultiErrorJointLimitExceeded, MultiErrorJointPositionCollision, MultiJointTrajectory, MultiSearchCollisionFree422Response, MultiSearchCollisionFreeRequest, MultiSearchCollisionFreeResponse, MultiSearchCollisionFreeResponseResponse, MultiSearchCollisionFreeValidationError, MultiSearchCollisionFreeValidationErrorAllOfData, NOVACloudApi, NOVACloudApiAxiosParamCreator, NOVACloudApiFactory, NOVACloudApiFp, NanValueError, NanValueErrorKindEnum, NanValueErrorNanValue, NetworkDevice, NetworkInterface, NetworkState, NetworkStateConnectionTypeEnum, OpMode, OperatingState, OperationLimits, OperationMode, OrientationType, PathCartesianPTP, PathCartesianPTPPathDefinitionNameEnum, PathCircle, PathCirclePathDefinitionNameEnum, PathCubicSpline, PathCubicSplinePathDefinitionNameEnum, PathDirectionConstrainedCartesianPTP, PathDirectionConstrainedCartesianPTPPathDefinitionNameEnum, PathDirectionConstrainedJointPTP, PathDirectionConstrainedJointPTPPathDefinitionNameEnum, PathJointPTP, PathJointPTPPathDefinitionNameEnum, PathLine, PathLinePathDefinitionNameEnum, PauseJoggingRequest, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponse, PauseJoggingResponseKindEnum, PauseMovementRequest, PauseMovementRequestMessageTypeEnum, PauseMovementResponse, PauseMovementResponseKindEnum, PauseOnIO, Payload, Plan422Response, PlanCollisionFreeFailedResponse, PlanCollisionFreeRequest, PlanCollisionFreeResponse, PlanCollisionFreeResponseResponse, PlanTrajectoryFailedResponse, PlanTrajectoryFailedResponseErrorFeedback, PlanTrajectoryRequest, PlanTrajectoryResponse, PlanTrajectoryResponseResponse, PlanValidationError, PlanValidationErrorAllOfData, Plane, PlaneShapeTypeEnum, PlaybackSpeedRequest, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponse, PlaybackSpeedResponseKindEnum, Pose, ProfinetDescription, ProfinetIO, ProfinetIOData, ProfinetIODirection, ProfinetIOTypeEnum, ProfinetInputOutputConfig, ProfinetSlotDescription, ProfinetSubSlotDescription, Program, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRun, ProgramRunState, ProgramStartRequest, RRTConnectAlgorithm, RRTConnectAlgorithmAlgorithmNameEnum, Rectangle, RectangleShapeTypeEnum, RectangularCapsule, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequestArgs, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotController, RobotControllerConfiguration, RobotControllerConfigurationRequest, RobotControllerState, RobotSystemMode, RobotTcp, RobotTcpData, SafetyGeometry, SafetyGeometryBox, SafetyGeometryCapsule, SafetyGeometryLozenge, SafetyGeometryPlane, SafetyGeometryPrism, SafetyGeometrySphere, SafetyStateType, SafetyZone, SafetyZonePose, SafetyZones, ServiceGroup, ServiceStatus, ServiceStatusPhase, ServiceStatusResponse, ServiceStatusSeverity, ServiceStatusStatus, SetIO, SettableRobotSystemMode, SingularityTypeEnum, Sphere, SphereShapeTypeEnum, StartMovementRequest, StartMovementRequestMessageTypeEnum, StartMovementResponse, StartMovementResponseKindEnum, StartOnIO, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, StreamIOValuesResponse, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpOffset, TcpRequiredError, TcpRequiredErrorKindEnum, TcpVelocityRequest, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponse, TcpVelocityResponseKindEnum, TorqueExceededError, TorqueExceededErrorKindEnum, TorqueExceededErrorTorqueExceeded, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryData, TrajectoryDataMessageTypeEnum, TrajectoryDetails, TrajectoryDetailsKindEnum, TrajectoryDetailsState, TrajectoryEnded, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryId, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUser, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIO, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunning, TrajectoryRunningKindEnum, TrajectorySection, TrajectoryWaitForIO, TrajectoryWaitForIOKindEnum, UnitType, UniversalrobotsController, UniversalrobotsControllerKindEnum, UpdateCellVersionRequest, UpdateNovaVersionRequest, ValidationError, ValidationError2, ValidationErrorLocInner, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualController, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, VirtualRobotConfiguration, WaitForIOEventRequest, YaskawaController, YaskawaControllerKindEnum, ZodValidationError, ZodValidationErrorError, ZodValidationErrorErrorCodeEnum, ZodValidationErrorErrorDetailsInner, ZodValidationErrorErrorDetailsInnerPathInner, operationServerMap };
|