@wandelbots/nova-api 25.11.0-dev.25 → 25.11.0-dev.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/v1/index.d.cts +178 -178
- package/dist/v1/index.d.ts +178 -178
- package/dist/v2/index.cjs +92 -0
- package/dist/v2/index.d.cts +195 -131
- package/dist/v2/index.d.ts +195 -131
- package/dist/v2/index.js +92 -0
- package/package.json +1 -1
package/dist/v2/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as axios0 from "axios";
|
|
2
2
|
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
3
|
|
|
4
4
|
//#region v2/configuration.d.ts
|
|
@@ -3518,7 +3518,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3518
3518
|
* @param {*} [options] Override http request option.
|
|
3519
3519
|
* @throws {RequiredError}
|
|
3520
3520
|
*/
|
|
3521
|
-
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3521
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3522
3522
|
/**
|
|
3523
3523
|
* Delete all GUI applications from the cell.
|
|
3524
3524
|
* @summary Clear Applications
|
|
@@ -3527,7 +3527,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3527
3527
|
* @param {*} [options] Override http request option.
|
|
3528
3528
|
* @throws {RequiredError}
|
|
3529
3529
|
*/
|
|
3530
|
-
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3530
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3531
3531
|
/**
|
|
3532
3532
|
* Delete a GUI application from the cell.
|
|
3533
3533
|
* @summary Delete Application
|
|
@@ -3537,7 +3537,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3537
3537
|
* @param {*} [options] Override http request option.
|
|
3538
3538
|
* @throws {RequiredError}
|
|
3539
3539
|
*/
|
|
3540
|
-
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3540
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3541
3541
|
/**
|
|
3542
3542
|
* Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](updateApp).
|
|
3543
3543
|
* @summary Configuration
|
|
@@ -3546,7 +3546,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3546
3546
|
* @param {*} [options] Override http request option.
|
|
3547
3547
|
* @throws {RequiredError}
|
|
3548
3548
|
*/
|
|
3549
|
-
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<
|
|
3549
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
|
|
3550
3550
|
/**
|
|
3551
3551
|
* List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
|
|
3552
3552
|
* @summary List Applications
|
|
@@ -3554,7 +3554,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3554
3554
|
* @param {*} [options] Override http request option.
|
|
3555
3555
|
* @throws {RequiredError}
|
|
3556
3556
|
*/
|
|
3557
|
-
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
3557
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
3558
3558
|
/**
|
|
3559
3559
|
* Update the configuration of a GUI application in the cell.
|
|
3560
3560
|
* @summary Update Configuration
|
|
@@ -3565,7 +3565,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3565
3565
|
* @param {*} [options] Override http request option.
|
|
3566
3566
|
* @throws {RequiredError}
|
|
3567
3567
|
*/
|
|
3568
|
-
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3568
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3569
3569
|
}
|
|
3570
3570
|
/**
|
|
3571
3571
|
* BUSInputsOutputsApi - axios parameter creator
|
|
@@ -3610,6 +3610,22 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3610
3610
|
* @throws {RequiredError}
|
|
3611
3611
|
*/
|
|
3612
3612
|
clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3613
|
+
/**
|
|
3614
|
+
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3615
|
+
* @summary Remove all MODBUS Input/Outputs
|
|
3616
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3617
|
+
* @param {*} [options] Override http request option.
|
|
3618
|
+
* @throws {RequiredError}
|
|
3619
|
+
*/
|
|
3620
|
+
deleteAllModbusIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3621
|
+
/**
|
|
3622
|
+
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
3623
|
+
* @summary Remove all PROFINET Input/Outputs
|
|
3624
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3625
|
+
* @param {*} [options] Override http request option.
|
|
3626
|
+
* @throws {RequiredError}
|
|
3627
|
+
*/
|
|
3628
|
+
deleteAllProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3613
3629
|
/**
|
|
3614
3630
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3615
3631
|
* @summary Remove MODBUS Input/Ouptut
|
|
@@ -3757,6 +3773,22 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3757
3773
|
* @throws {RequiredError}
|
|
3758
3774
|
*/
|
|
3759
3775
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3776
|
+
/**
|
|
3777
|
+
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3778
|
+
* @summary Remove all MODBUS Input/Outputs
|
|
3779
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3780
|
+
* @param {*} [options] Override http request option.
|
|
3781
|
+
* @throws {RequiredError}
|
|
3782
|
+
*/
|
|
3783
|
+
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3784
|
+
/**
|
|
3785
|
+
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
3786
|
+
* @summary Remove all PROFINET Input/Outputs
|
|
3787
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3788
|
+
* @param {*} [options] Override http request option.
|
|
3789
|
+
* @throws {RequiredError}
|
|
3790
|
+
*/
|
|
3791
|
+
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3760
3792
|
/**
|
|
3761
3793
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3762
3794
|
* @summary Remove MODBUS Input/Ouptut
|
|
@@ -3904,6 +3936,22 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
3904
3936
|
* @throws {RequiredError}
|
|
3905
3937
|
*/
|
|
3906
3938
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3939
|
+
/**
|
|
3940
|
+
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3941
|
+
* @summary Remove all MODBUS Input/Outputs
|
|
3942
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3943
|
+
* @param {*} [options] Override http request option.
|
|
3944
|
+
* @throws {RequiredError}
|
|
3945
|
+
*/
|
|
3946
|
+
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3947
|
+
/**
|
|
3948
|
+
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
3949
|
+
* @summary Remove all PROFINET Input/Outputs
|
|
3950
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3951
|
+
* @param {*} [options] Override http request option.
|
|
3952
|
+
* @throws {RequiredError}
|
|
3953
|
+
*/
|
|
3954
|
+
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3907
3955
|
/**
|
|
3908
3956
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3909
3957
|
* @summary Remove MODBUS Input/Ouptut
|
|
@@ -4021,7 +4069,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4021
4069
|
* @param {*} [options] Override http request option.
|
|
4022
4070
|
* @throws {RequiredError}
|
|
4023
4071
|
*/
|
|
4024
|
-
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4072
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4025
4073
|
/**
|
|
4026
4074
|
* Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](listModbusIOs).
|
|
4027
4075
|
* @summary Add MODBUS Input/Output
|
|
@@ -4031,7 +4079,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4031
4079
|
* @param {*} [options] Override http request option.
|
|
4032
4080
|
* @throws {RequiredError}
|
|
4033
4081
|
*/
|
|
4034
|
-
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<
|
|
4082
|
+
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4035
4083
|
/**
|
|
4036
4084
|
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
|
|
4037
4085
|
* @summary Add PROFINET Input/Output
|
|
@@ -4041,7 +4089,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4041
4089
|
* @param {*} [options] Override http request option.
|
|
4042
4090
|
* @throws {RequiredError}
|
|
4043
4091
|
*/
|
|
4044
|
-
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<
|
|
4092
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4045
4093
|
/**
|
|
4046
4094
|
* Remove the BUS inputs/outputs service from the cell.
|
|
4047
4095
|
* @summary Clear Service
|
|
@@ -4050,7 +4098,23 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4050
4098
|
* @param {*} [options] Override http request option.
|
|
4051
4099
|
* @throws {RequiredError}
|
|
4052
4100
|
*/
|
|
4053
|
-
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4101
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4102
|
+
/**
|
|
4103
|
+
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4104
|
+
* @summary Remove all MODBUS Input/Outputs
|
|
4105
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4106
|
+
* @param {*} [options] Override http request option.
|
|
4107
|
+
* @throws {RequiredError}
|
|
4108
|
+
*/
|
|
4109
|
+
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4110
|
+
/**
|
|
4111
|
+
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
4112
|
+
* @summary Remove all PROFINET Input/Outputs
|
|
4113
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4114
|
+
* @param {*} [options] Override http request option.
|
|
4115
|
+
* @throws {RequiredError}
|
|
4116
|
+
*/
|
|
4117
|
+
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4054
4118
|
/**
|
|
4055
4119
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4056
4120
|
* @summary Remove MODBUS Input/Ouptut
|
|
@@ -4059,7 +4123,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4059
4123
|
* @param {*} [options] Override http request option.
|
|
4060
4124
|
* @throws {RequiredError}
|
|
4061
4125
|
*/
|
|
4062
|
-
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
4126
|
+
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4063
4127
|
/**
|
|
4064
4128
|
* Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
4065
4129
|
* @summary Remove PROFINET Input/Ouptut
|
|
@@ -4068,7 +4132,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4068
4132
|
* @param {*} [options] Override http request option.
|
|
4069
4133
|
* @throws {RequiredError}
|
|
4070
4134
|
*/
|
|
4071
|
-
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
4135
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4072
4136
|
/**
|
|
4073
4137
|
* Get deployed BUS inputs/outputs service.
|
|
4074
4138
|
* @summary Get Service
|
|
@@ -4076,7 +4140,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4076
4140
|
* @param {*} [options] Override http request option.
|
|
4077
4141
|
* @throws {RequiredError}
|
|
4078
4142
|
*/
|
|
4079
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4143
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOType, any>>;
|
|
4080
4144
|
/**
|
|
4081
4145
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
4082
4146
|
* @summary State
|
|
@@ -4084,7 +4148,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4084
4148
|
* @param {*} [options] Override http request option.
|
|
4085
4149
|
* @throws {RequiredError}
|
|
4086
4150
|
*/
|
|
4087
|
-
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4151
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOsState, any>>;
|
|
4088
4152
|
/**
|
|
4089
4153
|
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
4090
4154
|
* @summary Get Input/Output Values
|
|
@@ -4093,7 +4157,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4093
4157
|
* @param {*} [options] Override http request option.
|
|
4094
4158
|
* @throws {RequiredError}
|
|
4095
4159
|
*/
|
|
4096
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
4160
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
4097
4161
|
/**
|
|
4098
4162
|
* Get description of NOVA as a PROFINET device.
|
|
4099
4163
|
* @summary Get PROFINET Description
|
|
@@ -4101,7 +4165,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4101
4165
|
* @param {*} [options] Override http request option.
|
|
4102
4166
|
* @throws {RequiredError}
|
|
4103
4167
|
*/
|
|
4104
|
-
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4168
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetDescription, any>>;
|
|
4105
4169
|
/**
|
|
4106
4170
|
* 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.
|
|
4107
4171
|
* @summary PROFINET Inputs/Outputs to File
|
|
@@ -4111,7 +4175,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4111
4175
|
* @param {*} [options] Override http request option.
|
|
4112
4176
|
* @throws {RequiredError}
|
|
4113
4177
|
*/
|
|
4114
|
-
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4178
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
4115
4179
|
/**
|
|
4116
4180
|
* 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.
|
|
4117
4181
|
* @summary List Descriptions
|
|
@@ -4119,7 +4183,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4119
4183
|
* @param {*} [options] Override http request option.
|
|
4120
4184
|
* @throws {RequiredError}
|
|
4121
4185
|
*/
|
|
4122
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4186
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIODescription[], any>>;
|
|
4123
4187
|
/**
|
|
4124
4188
|
* List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller as well as NOVA\'s MODBUS service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](addModbusIO).
|
|
4125
4189
|
* @summary List MODBUS Input/Output Configuration
|
|
@@ -4127,7 +4191,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4127
4191
|
* @param {*} [options] Override http request option.
|
|
4128
4192
|
* @throws {RequiredError}
|
|
4129
4193
|
*/
|
|
4130
|
-
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4194
|
+
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ModbusIO[], any>>;
|
|
4131
4195
|
/**
|
|
4132
4196
|
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
|
|
4133
4197
|
* @summary List PROFINET Input/Output Configuration
|
|
@@ -4135,7 +4199,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4135
4199
|
* @param {*} [options] Override http request option.
|
|
4136
4200
|
* @throws {RequiredError}
|
|
4137
4201
|
*/
|
|
4138
|
-
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4202
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetIO[], any>>;
|
|
4139
4203
|
/**
|
|
4140
4204
|
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
4141
4205
|
* @summary Set Output Values
|
|
@@ -4144,7 +4208,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4144
4208
|
* @param {*} [options] Override http request option.
|
|
4145
4209
|
* @throws {RequiredError}
|
|
4146
4210
|
*/
|
|
4147
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
4211
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4148
4212
|
/**
|
|
4149
4213
|
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
4150
4214
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
@@ -4153,7 +4217,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4153
4217
|
* @param {*} [options] Override http request option.
|
|
4154
4218
|
* @throws {RequiredError}
|
|
4155
4219
|
*/
|
|
4156
|
-
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<
|
|
4220
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4157
4221
|
}
|
|
4158
4222
|
/**
|
|
4159
4223
|
* CellApi - axios parameter creator
|
|
@@ -4362,7 +4426,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4362
4426
|
* @param {*} [options] Override http request option.
|
|
4363
4427
|
* @throws {RequiredError}
|
|
4364
4428
|
*/
|
|
4365
|
-
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4429
|
+
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4366
4430
|
/**
|
|
4367
4431
|
* 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.
|
|
4368
4432
|
* @summary Add Cell
|
|
@@ -4371,7 +4435,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4371
4435
|
* @param {*} [options] Override http request option.
|
|
4372
4436
|
* @throws {RequiredError}
|
|
4373
4437
|
*/
|
|
4374
|
-
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4438
|
+
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4375
4439
|
/**
|
|
4376
4440
|
* List all cell resources.
|
|
4377
4441
|
* @summary Configuration
|
|
@@ -4379,7 +4443,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4379
4443
|
* @param {*} [options] Override http request option.
|
|
4380
4444
|
* @throws {RequiredError}
|
|
4381
4445
|
*/
|
|
4382
|
-
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4446
|
+
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Cell, any>>;
|
|
4383
4447
|
/**
|
|
4384
4448
|
* List the status of all cell resources.
|
|
4385
4449
|
* @summary Service Status
|
|
@@ -4387,14 +4451,14 @@ declare class CellApi extends BaseAPI {
|
|
|
4387
4451
|
* @param {*} [options] Override http request option.
|
|
4388
4452
|
* @throws {RequiredError}
|
|
4389
4453
|
*/
|
|
4390
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4454
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatusResponse, any>>;
|
|
4391
4455
|
/**
|
|
4392
4456
|
* List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
4393
4457
|
* @summary List Cells
|
|
4394
4458
|
* @param {*} [options] Override http request option.
|
|
4395
4459
|
* @throws {RequiredError}
|
|
4396
4460
|
*/
|
|
4397
|
-
listCells(options?: RawAxiosRequestConfig): Promise<
|
|
4461
|
+
listCells(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
4398
4462
|
/**
|
|
4399
4463
|
* Deactivate or activate the services of a cell.
|
|
4400
4464
|
* @summary Operating State
|
|
@@ -4403,7 +4467,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4403
4467
|
* @param {*} [options] Override http request option.
|
|
4404
4468
|
* @throws {RequiredError}
|
|
4405
4469
|
*/
|
|
4406
|
-
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<
|
|
4470
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4407
4471
|
/**
|
|
4408
4472
|
* Update the definition of the entire Cell.
|
|
4409
4473
|
* @summary Update Configuration
|
|
@@ -4413,7 +4477,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4413
4477
|
* @param {*} [options] Override http request option.
|
|
4414
4478
|
* @throws {RequiredError}
|
|
4415
4479
|
*/
|
|
4416
|
-
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4480
|
+
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4417
4481
|
}
|
|
4418
4482
|
/**
|
|
4419
4483
|
* ControllerApi - axios parameter creator
|
|
@@ -4851,7 +4915,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4851
4915
|
* @param {*} [options] Override http request option.
|
|
4852
4916
|
* @throws {RequiredError}
|
|
4853
4917
|
*/
|
|
4854
|
-
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4918
|
+
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4855
4919
|
/**
|
|
4856
4920
|
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
4857
4921
|
* @summary Clear Robot Controllers
|
|
@@ -4860,7 +4924,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4860
4924
|
* @param {*} [options] Override http request option.
|
|
4861
4925
|
* @throws {RequiredError}
|
|
4862
4926
|
*/
|
|
4863
|
-
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4927
|
+
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4864
4928
|
/**
|
|
4865
4929
|
* Delete a robot controller from the cell.
|
|
4866
4930
|
* @summary Delete Robot Controller
|
|
@@ -4870,7 +4934,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4870
4934
|
* @param {*} [options] Override http request option.
|
|
4871
4935
|
* @throws {RequiredError}
|
|
4872
4936
|
*/
|
|
4873
|
-
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4937
|
+
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4874
4938
|
/**
|
|
4875
4939
|
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
4876
4940
|
* @summary Description
|
|
@@ -4879,7 +4943,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4879
4943
|
* @param {*} [options] Override http request option.
|
|
4880
4944
|
* @throws {RequiredError}
|
|
4881
4945
|
*/
|
|
4882
|
-
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4946
|
+
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ControllerDescription, any>>;
|
|
4883
4947
|
/**
|
|
4884
4948
|
* 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.
|
|
4885
4949
|
* @summary Coordinate System
|
|
@@ -4890,7 +4954,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4890
4954
|
* @param {*} [options] Override http request option.
|
|
4891
4955
|
* @throws {RequiredError}
|
|
4892
4956
|
*/
|
|
4893
|
-
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
4957
|
+
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
4894
4958
|
/**
|
|
4895
4959
|
* Get the current state of a robot controller.
|
|
4896
4960
|
* @summary State
|
|
@@ -4899,7 +4963,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4899
4963
|
* @param {*} [options] Override http request option.
|
|
4900
4964
|
* @throws {RequiredError}
|
|
4901
4965
|
*/
|
|
4902
|
-
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4966
|
+
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
4903
4967
|
/**
|
|
4904
4968
|
* Get the configuration for a robot controller.
|
|
4905
4969
|
* @summary Robot Controller
|
|
@@ -4908,7 +4972,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4908
4972
|
* @param {*} [options] Override http request option.
|
|
4909
4973
|
* @throws {RequiredError}
|
|
4910
4974
|
*/
|
|
4911
|
-
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4975
|
+
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
|
|
4912
4976
|
/**
|
|
4913
4977
|
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.
|
|
4914
4978
|
* @summary Virtual Controller Configuration
|
|
@@ -4917,7 +4981,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4917
4981
|
* @param {*} [options] Override http request option.
|
|
4918
4982
|
* @throws {RequiredError}
|
|
4919
4983
|
*/
|
|
4920
|
-
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4984
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
4921
4985
|
/**
|
|
4922
4986
|
* 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.
|
|
4923
4987
|
* @summary List Coordinate Systems
|
|
@@ -4927,7 +4991,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4927
4991
|
* @param {*} [options] Override http request option.
|
|
4928
4992
|
* @throws {RequiredError}
|
|
4929
4993
|
*/
|
|
4930
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
4994
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
4931
4995
|
/**
|
|
4932
4996
|
* List the names of all deployed robot controllers.
|
|
4933
4997
|
* @summary List Robot Controllers
|
|
@@ -4935,7 +4999,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4935
4999
|
* @param {*} [options] Override http request option.
|
|
4936
5000
|
* @throws {RequiredError}
|
|
4937
5001
|
*/
|
|
4938
|
-
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5002
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
4939
5003
|
/**
|
|
4940
5004
|
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state `normal` or `reduced`. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
4941
5005
|
* @summary Set Default Mode
|
|
@@ -4945,7 +5009,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4945
5009
|
* @param {*} [options] Override http request option.
|
|
4946
5010
|
* @throws {RequiredError}
|
|
4947
5011
|
*/
|
|
4948
|
-
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<
|
|
5012
|
+
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4949
5013
|
/**
|
|
4950
5014
|
* <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](listRobotControllers) to check if the robot controller supports free drive mode.
|
|
4951
5015
|
* @summary Stream Free Drive
|
|
@@ -4955,7 +5019,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4955
5019
|
* @param {*} [options] Override http request option.
|
|
4956
5020
|
* @throws {RequiredError}
|
|
4957
5021
|
*/
|
|
4958
|
-
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5022
|
+
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
4959
5023
|
/**
|
|
4960
5024
|
* <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
4961
5025
|
* @summary Stream State
|
|
@@ -4966,7 +5030,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4966
5030
|
* @param {*} [options] Override http request option.
|
|
4967
5031
|
* @throws {RequiredError}
|
|
4968
5032
|
*/
|
|
4969
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5033
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
4970
5034
|
/**
|
|
4971
5035
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
|
|
4972
5036
|
* @summary Update Robot Controller
|
|
@@ -4977,7 +5041,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4977
5041
|
* @param {*} [options] Override http request option.
|
|
4978
5042
|
* @throws {RequiredError}
|
|
4979
5043
|
*/
|
|
4980
|
-
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5044
|
+
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4981
5045
|
}
|
|
4982
5046
|
/**
|
|
4983
5047
|
* ControllerInputsOutputsApi - axios parameter creator
|
|
@@ -5169,7 +5233,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5169
5233
|
* @param {*} [options] Override http request option.
|
|
5170
5234
|
* @throws {RequiredError}
|
|
5171
5235
|
*/
|
|
5172
|
-
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5236
|
+
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
5173
5237
|
/**
|
|
5174
5238
|
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](listIODescriptions).
|
|
5175
5239
|
* @summary Get Input/Output Values
|
|
@@ -5179,7 +5243,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5179
5243
|
* @param {*} [options] Override http request option.
|
|
5180
5244
|
* @throws {RequiredError}
|
|
5181
5245
|
*/
|
|
5182
|
-
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5246
|
+
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
5183
5247
|
/**
|
|
5184
5248
|
* Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
|
|
5185
5249
|
* @summary Set Output Values
|
|
@@ -5189,7 +5253,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5189
5253
|
* @param {*} [options] Override http request option.
|
|
5190
5254
|
* @throws {RequiredError}
|
|
5191
5255
|
*/
|
|
5192
|
-
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
5256
|
+
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5193
5257
|
/**
|
|
5194
5258
|
* <!-- 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.
|
|
5195
5259
|
* @summary Stream Input/Output Values
|
|
@@ -5199,7 +5263,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5199
5263
|
* @param {*} [options] Override http request option.
|
|
5200
5264
|
* @throws {RequiredError}
|
|
5201
5265
|
*/
|
|
5202
|
-
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5266
|
+
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamIOValuesResponse, any>>;
|
|
5203
5267
|
/**
|
|
5204
5268
|
* Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
|
|
5205
5269
|
* @summary Wait For
|
|
@@ -5209,7 +5273,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5209
5273
|
* @param {*} [options] Override http request option.
|
|
5210
5274
|
* @throws {RequiredError}
|
|
5211
5275
|
*/
|
|
5212
|
-
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5276
|
+
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<boolean, any>>;
|
|
5213
5277
|
}
|
|
5214
5278
|
/**
|
|
5215
5279
|
* JoggingApi - axios parameter creator
|
|
@@ -5269,7 +5333,7 @@ declare class JoggingApi extends BaseAPI {
|
|
|
5269
5333
|
* @param {*} [options] Override http request option.
|
|
5270
5334
|
* @throws {RequiredError}
|
|
5271
5335
|
*/
|
|
5272
|
-
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5336
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteJoggingResponse, any>>;
|
|
5273
5337
|
}
|
|
5274
5338
|
/**
|
|
5275
5339
|
* KinematicsApi - axios parameter creator
|
|
@@ -5352,7 +5416,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
5352
5416
|
* @param {*} [options] Override http request option.
|
|
5353
5417
|
* @throws {RequiredError}
|
|
5354
5418
|
*/
|
|
5355
|
-
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5419
|
+
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ForwardKinematicsResponse, any>>;
|
|
5356
5420
|
/**
|
|
5357
5421
|
* Returns the reachable joint positions for a list of given poses.
|
|
5358
5422
|
* @summary Inverse kinematics
|
|
@@ -5361,7 +5425,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
5361
5425
|
* @param {*} [options] Override http request option.
|
|
5362
5426
|
* @throws {RequiredError}
|
|
5363
5427
|
*/
|
|
5364
|
-
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5428
|
+
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<InverseKinematicsResponse, any>>;
|
|
5365
5429
|
}
|
|
5366
5430
|
/**
|
|
5367
5431
|
* LicenseApi - axios parameter creator
|
|
@@ -5476,28 +5540,28 @@ declare class LicenseApi extends BaseAPI {
|
|
|
5476
5540
|
* @param {*} [options] Override http request option.
|
|
5477
5541
|
* @throws {RequiredError}
|
|
5478
5542
|
*/
|
|
5479
|
-
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5543
|
+
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
5480
5544
|
/**
|
|
5481
5545
|
* Deactivates active license.
|
|
5482
5546
|
* @summary Deactivate license
|
|
5483
5547
|
* @param {*} [options] Override http request option.
|
|
5484
5548
|
* @throws {RequiredError}
|
|
5485
5549
|
*/
|
|
5486
|
-
deactivateLicense(options?: RawAxiosRequestConfig): Promise<
|
|
5550
|
+
deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5487
5551
|
/**
|
|
5488
5552
|
* Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
|
|
5489
5553
|
* @summary Get license
|
|
5490
5554
|
* @param {*} [options] Override http request option.
|
|
5491
5555
|
* @throws {RequiredError}
|
|
5492
5556
|
*/
|
|
5493
|
-
getLicense(options?: RawAxiosRequestConfig): Promise<
|
|
5557
|
+
getLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
5494
5558
|
/**
|
|
5495
5559
|
* 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.
|
|
5496
5560
|
* @summary Get license status
|
|
5497
5561
|
* @param {*} [options] Override http request option.
|
|
5498
5562
|
* @throws {RequiredError}
|
|
5499
5563
|
*/
|
|
5500
|
-
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<
|
|
5564
|
+
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<LicenseStatus, any>>;
|
|
5501
5565
|
}
|
|
5502
5566
|
/**
|
|
5503
5567
|
* MotionGroupApi - axios parameter creator
|
|
@@ -5627,7 +5691,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5627
5691
|
* @param {*} [options] Override http request option.
|
|
5628
5692
|
* @throws {RequiredError}
|
|
5629
5693
|
*/
|
|
5630
|
-
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5694
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
5631
5695
|
/**
|
|
5632
5696
|
* 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.
|
|
5633
5697
|
* @summary Description
|
|
@@ -5637,7 +5701,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5637
5701
|
* @param {*} [options] Override http request option.
|
|
5638
5702
|
* @throws {RequiredError}
|
|
5639
5703
|
*/
|
|
5640
|
-
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
5704
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupDescription, any>>;
|
|
5641
5705
|
/**
|
|
5642
5706
|
* <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
5643
5707
|
* @summary Stream State
|
|
@@ -5649,7 +5713,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5649
5713
|
* @param {*} [options] Override http request option.
|
|
5650
5714
|
* @throws {RequiredError}
|
|
5651
5715
|
*/
|
|
5652
|
-
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5716
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
5653
5717
|
}
|
|
5654
5718
|
/**
|
|
5655
5719
|
* MotionGroupModelsApi - axios parameter creator
|
|
@@ -5726,7 +5790,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
5726
5790
|
* @param {*} [options] Override http request option.
|
|
5727
5791
|
* @throws {RequiredError}
|
|
5728
5792
|
*/
|
|
5729
|
-
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
5793
|
+
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
5730
5794
|
[key: string]: Collider;
|
|
5731
5795
|
}[], any>>;
|
|
5732
5796
|
/**
|
|
@@ -5735,7 +5799,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
5735
5799
|
* @param {*} [options] Override http request option.
|
|
5736
5800
|
* @throws {RequiredError}
|
|
5737
5801
|
*/
|
|
5738
|
-
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<
|
|
5802
|
+
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
5739
5803
|
}
|
|
5740
5804
|
/**
|
|
5741
5805
|
* ProgramApi - axios parameter creator
|
|
@@ -5872,7 +5936,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
5872
5936
|
* @param {*} [options] Override http request option.
|
|
5873
5937
|
* @throws {RequiredError}
|
|
5874
5938
|
*/
|
|
5875
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
5939
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program, any>>;
|
|
5876
5940
|
/**
|
|
5877
5941
|
* <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
5878
5942
|
* @summary List programs
|
|
@@ -5880,7 +5944,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
5880
5944
|
* @param {*} [options] Override http request option.
|
|
5881
5945
|
* @throws {RequiredError}
|
|
5882
5946
|
*/
|
|
5883
|
-
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5947
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program[], any>>;
|
|
5884
5948
|
/**
|
|
5885
5949
|
* <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5886
5950
|
* @summary Start the program
|
|
@@ -5890,7 +5954,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
5890
5954
|
* @param {*} [options] Override http request option.
|
|
5891
5955
|
* @throws {RequiredError}
|
|
5892
5956
|
*/
|
|
5893
|
-
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5957
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
|
|
5894
5958
|
/**
|
|
5895
5959
|
* <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
5896
5960
|
* @summary Stop program run
|
|
@@ -5899,7 +5963,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
5899
5963
|
* @param {*} [options] Override http request option.
|
|
5900
5964
|
* @throws {RequiredError}
|
|
5901
5965
|
*/
|
|
5902
|
-
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
5966
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5903
5967
|
}
|
|
5904
5968
|
/**
|
|
5905
5969
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
@@ -6372,7 +6436,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6372
6436
|
* @param {*} [options] Override http request option.
|
|
6373
6437
|
* @throws {RequiredError}
|
|
6374
6438
|
*/
|
|
6375
|
-
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
6439
|
+
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6376
6440
|
/**
|
|
6377
6441
|
* Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6378
6442
|
* @summary Delete Link Chain
|
|
@@ -6381,7 +6445,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6381
6445
|
* @param {*} [options] Override http request option.
|
|
6382
6446
|
* @throws {RequiredError}
|
|
6383
6447
|
*/
|
|
6384
|
-
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
6448
|
+
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6385
6449
|
/**
|
|
6386
6450
|
* Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6387
6451
|
* @summary Delete Tool
|
|
@@ -6390,7 +6454,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6390
6454
|
* @param {*} [options] Override http request option.
|
|
6391
6455
|
* @throws {RequiredError}
|
|
6392
6456
|
*/
|
|
6393
|
-
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
6457
|
+
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6394
6458
|
/**
|
|
6395
6459
|
* Returns the collider.
|
|
6396
6460
|
* @summary Get Collider
|
|
@@ -6399,7 +6463,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6399
6463
|
* @param {*} [options] Override http request option.
|
|
6400
6464
|
* @throws {RequiredError}
|
|
6401
6465
|
*/
|
|
6402
|
-
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
6466
|
+
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
6403
6467
|
/**
|
|
6404
6468
|
* Returns the collision link chain.
|
|
6405
6469
|
* @summary Get Link Chain
|
|
@@ -6408,7 +6472,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6408
6472
|
* @param {*} [options] Override http request option.
|
|
6409
6473
|
* @throws {RequiredError}
|
|
6410
6474
|
*/
|
|
6411
|
-
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
6475
|
+
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6412
6476
|
[key: string]: Collider;
|
|
6413
6477
|
}[], any>>;
|
|
6414
6478
|
/**
|
|
@@ -6419,7 +6483,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6419
6483
|
* @param {*} [options] Override http request option.
|
|
6420
6484
|
* @throws {RequiredError}
|
|
6421
6485
|
*/
|
|
6422
|
-
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
6486
|
+
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6423
6487
|
[key: string]: Collider;
|
|
6424
6488
|
}, any>>;
|
|
6425
6489
|
/**
|
|
@@ -6429,7 +6493,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6429
6493
|
* @param {*} [options] Override http request option.
|
|
6430
6494
|
* @throws {RequiredError}
|
|
6431
6495
|
*/
|
|
6432
|
-
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6496
|
+
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6433
6497
|
[key: string]: {
|
|
6434
6498
|
[key: string]: Collider;
|
|
6435
6499
|
}[];
|
|
@@ -6441,7 +6505,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6441
6505
|
* @param {*} [options] Override http request option.
|
|
6442
6506
|
* @throws {RequiredError}
|
|
6443
6507
|
*/
|
|
6444
|
-
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6508
|
+
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6445
6509
|
/**
|
|
6446
6510
|
* Returns all stored colliders.
|
|
6447
6511
|
* @summary List Colliders
|
|
@@ -6449,7 +6513,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6449
6513
|
* @param {*} [options] Override http request option.
|
|
6450
6514
|
* @throws {RequiredError}
|
|
6451
6515
|
*/
|
|
6452
|
-
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6516
|
+
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6453
6517
|
[key: string]: Collider;
|
|
6454
6518
|
}, any>>;
|
|
6455
6519
|
/**
|
|
@@ -6459,7 +6523,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6459
6523
|
* @param {*} [options] Override http request option.
|
|
6460
6524
|
* @throws {RequiredError}
|
|
6461
6525
|
*/
|
|
6462
|
-
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6526
|
+
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6463
6527
|
/**
|
|
6464
6528
|
* Returns the list of stored tools.
|
|
6465
6529
|
* @summary List Tools
|
|
@@ -6467,7 +6531,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6467
6531
|
* @param {*} [options] Override http request option.
|
|
6468
6532
|
* @throws {RequiredError}
|
|
6469
6533
|
*/
|
|
6470
|
-
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6534
|
+
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6471
6535
|
[key: string]: {
|
|
6472
6536
|
[key: string]: Collider;
|
|
6473
6537
|
};
|
|
@@ -6479,7 +6543,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6479
6543
|
* @param {*} [options] Override http request option.
|
|
6480
6544
|
* @throws {RequiredError}
|
|
6481
6545
|
*/
|
|
6482
|
-
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6546
|
+
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6483
6547
|
/**
|
|
6484
6548
|
* Stores collider. - If the collider does not exist, it will be created. - If the collider exists, it will be updated.
|
|
6485
6549
|
* @summary Store Collider
|
|
@@ -6489,7 +6553,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6489
6553
|
* @param {*} [options] Override http request option.
|
|
6490
6554
|
* @throws {RequiredError}
|
|
6491
6555
|
*/
|
|
6492
|
-
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<
|
|
6556
|
+
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
6493
6557
|
/**
|
|
6494
6558
|
* Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
|
|
6495
6559
|
* @summary Store Link Chain
|
|
@@ -6501,7 +6565,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6501
6565
|
*/
|
|
6502
6566
|
storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{
|
|
6503
6567
|
[key: string]: Collider;
|
|
6504
|
-
}>, options?: RawAxiosRequestConfig): Promise<
|
|
6568
|
+
}>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6505
6569
|
[key: string]: Collider;
|
|
6506
6570
|
}[], any>>;
|
|
6507
6571
|
/**
|
|
@@ -6515,7 +6579,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6515
6579
|
*/
|
|
6516
6580
|
storeCollisionTool(cell: string, tool: string, requestBody: {
|
|
6517
6581
|
[key: string]: Collider;
|
|
6518
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
6582
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6519
6583
|
[key: string]: Collider;
|
|
6520
6584
|
}, any>>;
|
|
6521
6585
|
}
|
|
@@ -6682,7 +6746,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6682
6746
|
* @param {*} [options] Override http request option.
|
|
6683
6747
|
* @throws {RequiredError}
|
|
6684
6748
|
*/
|
|
6685
|
-
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
6749
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6686
6750
|
/**
|
|
6687
6751
|
* Returns the stored collision setup.
|
|
6688
6752
|
* @summary Get Collision Setup
|
|
@@ -6691,7 +6755,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6691
6755
|
* @param {*} [options] Override http request option.
|
|
6692
6756
|
* @throws {RequiredError}
|
|
6693
6757
|
*/
|
|
6694
|
-
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
6758
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
6695
6759
|
/**
|
|
6696
6760
|
* Returns a list of stored collision setups.
|
|
6697
6761
|
* @summary List Collision Setups
|
|
@@ -6699,7 +6763,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6699
6763
|
* @param {*} [options] Override http request option.
|
|
6700
6764
|
* @throws {RequiredError}
|
|
6701
6765
|
*/
|
|
6702
|
-
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6766
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6703
6767
|
[key: string]: CollisionSetup;
|
|
6704
6768
|
}, any>>;
|
|
6705
6769
|
/**
|
|
@@ -6709,7 +6773,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6709
6773
|
* @param {*} [options] Override http request option.
|
|
6710
6774
|
* @throws {RequiredError}
|
|
6711
6775
|
*/
|
|
6712
|
-
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6776
|
+
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6713
6777
|
/**
|
|
6714
6778
|
* Stores collision setup. - If the collision setup does not exist, it will be created. - If the collision setup exists, it will be updated.
|
|
6715
6779
|
* @summary Store Collision Setup
|
|
@@ -6719,7 +6783,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6719
6783
|
* @param {*} [options] Override http request option.
|
|
6720
6784
|
* @throws {RequiredError}
|
|
6721
6785
|
*/
|
|
6722
|
-
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<
|
|
6786
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
6723
6787
|
}
|
|
6724
6788
|
/**
|
|
6725
6789
|
* StoreObjectApi - axios parameter creator
|
|
@@ -6915,7 +6979,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
6915
6979
|
* @param {*} [options] Override http request option.
|
|
6916
6980
|
* @throws {RequiredError}
|
|
6917
6981
|
*/
|
|
6918
|
-
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6982
|
+
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6919
6983
|
/**
|
|
6920
6984
|
* Delete an object <!-- theme: danger --> > This will delete persistently stored data.
|
|
6921
6985
|
* @summary Delete Object
|
|
@@ -6924,7 +6988,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
6924
6988
|
* @param {*} [options] Override http request option.
|
|
6925
6989
|
* @throws {RequiredError}
|
|
6926
6990
|
*/
|
|
6927
|
-
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
6991
|
+
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6928
6992
|
/**
|
|
6929
6993
|
* Returns content and metadata of a stored object.
|
|
6930
6994
|
* @summary Get Object
|
|
@@ -6933,7 +6997,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
6933
6997
|
* @param {*} [options] Override http request option.
|
|
6934
6998
|
* @throws {RequiredError}
|
|
6935
6999
|
*/
|
|
6936
|
-
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7000
|
+
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
6937
7001
|
/**
|
|
6938
7002
|
* Returns metadata. Object content is not returned.
|
|
6939
7003
|
* @summary Get Object Metadata
|
|
@@ -6942,7 +7006,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
6942
7006
|
* @param {*} [options] Override http request option.
|
|
6943
7007
|
* @throws {RequiredError}
|
|
6944
7008
|
*/
|
|
6945
|
-
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7009
|
+
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6946
7010
|
/**
|
|
6947
7011
|
* List the keys for all objects.
|
|
6948
7012
|
* @summary List all Object Keys
|
|
@@ -6950,7 +7014,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
6950
7014
|
* @param {*} [options] Override http request option.
|
|
6951
7015
|
* @throws {RequiredError}
|
|
6952
7016
|
*/
|
|
6953
|
-
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7017
|
+
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6954
7018
|
/**
|
|
6955
7019
|
* Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
|
|
6956
7020
|
* @summary Store Object
|
|
@@ -6963,7 +7027,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
6963
7027
|
*/
|
|
6964
7028
|
storeObject(cell: string, key: string, xMetadata?: {
|
|
6965
7029
|
[key: string]: string;
|
|
6966
|
-
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<
|
|
7030
|
+
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6967
7031
|
}
|
|
6968
7032
|
/**
|
|
6969
7033
|
* SystemApi - axios parameter creator
|
|
@@ -7210,7 +7274,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7210
7274
|
*/
|
|
7211
7275
|
backupConfiguration(resources?: Array<string>, metadata?: {
|
|
7212
7276
|
[key: string]: string;
|
|
7213
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
7277
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7214
7278
|
/**
|
|
7215
7279
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
7216
7280
|
* @summary Check update
|
|
@@ -7218,7 +7282,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7218
7282
|
* @param {*} [options] Override http request option.
|
|
7219
7283
|
* @throws {RequiredError}
|
|
7220
7284
|
*/
|
|
7221
|
-
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
7285
|
+
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
7222
7286
|
/**
|
|
7223
7287
|
* 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.
|
|
7224
7288
|
* @summary Retrieve Backup Status
|
|
@@ -7226,35 +7290,35 @@ declare class SystemApi extends BaseAPI {
|
|
|
7226
7290
|
* @param {*} [options] Override http request option.
|
|
7227
7291
|
* @throws {RequiredError}
|
|
7228
7292
|
*/
|
|
7229
|
-
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
7293
|
+
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationArchiveStatus, any>>;
|
|
7230
7294
|
/**
|
|
7231
7295
|
* 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.
|
|
7232
7296
|
* @summary Download Diagnosis Package
|
|
7233
7297
|
* @param {*} [options] Override http request option.
|
|
7234
7298
|
* @throws {RequiredError}
|
|
7235
7299
|
*/
|
|
7236
|
-
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<
|
|
7300
|
+
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7237
7301
|
/**
|
|
7238
7302
|
* Get the status of all system services.
|
|
7239
7303
|
* @summary Wandelbots NOVA status
|
|
7240
7304
|
* @param {*} [options] Override http request option.
|
|
7241
7305
|
* @throws {RequiredError}
|
|
7242
7306
|
*/
|
|
7243
|
-
getSystemStatus(options?: RawAxiosRequestConfig): Promise<
|
|
7307
|
+
getSystemStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatus[], any>>;
|
|
7244
7308
|
/**
|
|
7245
7309
|
* Get the current Wandelbots NOVA version.
|
|
7246
7310
|
* @summary Wandelbots NOVA Version
|
|
7247
7311
|
* @param {*} [options] Override http request option.
|
|
7248
7312
|
* @throws {RequiredError}
|
|
7249
7313
|
*/
|
|
7250
|
-
getSystemVersion(options?: RawAxiosRequestConfig): Promise<
|
|
7314
|
+
getSystemVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
7251
7315
|
/**
|
|
7252
7316
|
* Retrieves a list of all available configuration resources for backup purposes.
|
|
7253
7317
|
* @summary List Configuration Resources
|
|
7254
7318
|
* @param {*} [options] Override http request option.
|
|
7255
7319
|
* @throws {RequiredError}
|
|
7256
7320
|
*/
|
|
7257
|
-
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<
|
|
7321
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationResource[], any>>;
|
|
7258
7322
|
/**
|
|
7259
7323
|
* Restores a previously backed up configuration.
|
|
7260
7324
|
* @summary Restore Configuration Backup
|
|
@@ -7263,7 +7327,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7263
7327
|
* @param {*} [options] Override http request option.
|
|
7264
7328
|
* @throws {RequiredError}
|
|
7265
7329
|
*/
|
|
7266
|
-
restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<
|
|
7330
|
+
restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7267
7331
|
/**
|
|
7268
7332
|
* 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.
|
|
7269
7333
|
* @summary Update Wandelbots NOVA version
|
|
@@ -7271,7 +7335,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7271
7335
|
* @param {*} [options] Override http request option.
|
|
7272
7336
|
* @throws {RequiredError}
|
|
7273
7337
|
*/
|
|
7274
|
-
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7338
|
+
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7275
7339
|
}
|
|
7276
7340
|
/**
|
|
7277
7341
|
* TrajectoryCachingApi - axios parameter creator
|
|
@@ -7445,7 +7509,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7445
7509
|
* @param {*} [options] Override http request option.
|
|
7446
7510
|
* @throws {RequiredError}
|
|
7447
7511
|
*/
|
|
7448
|
-
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7512
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<AddTrajectoryResponse, any>>;
|
|
7449
7513
|
/**
|
|
7450
7514
|
* Clear the trajectory cache.
|
|
7451
7515
|
* @summary Clear Trajectories
|
|
@@ -7454,7 +7518,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7454
7518
|
* @param {*} [options] Override http request option.
|
|
7455
7519
|
* @throws {RequiredError}
|
|
7456
7520
|
*/
|
|
7457
|
-
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7521
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7458
7522
|
/**
|
|
7459
7523
|
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
7460
7524
|
* @summary Delete Trajectory
|
|
@@ -7464,7 +7528,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7464
7528
|
* @param {*} [options] Override http request option.
|
|
7465
7529
|
* @throws {RequiredError}
|
|
7466
7530
|
*/
|
|
7467
|
-
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
7531
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7468
7532
|
/**
|
|
7469
7533
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7470
7534
|
* @summary Get Trajectory
|
|
@@ -7474,7 +7538,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7474
7538
|
* @param {*} [options] Override http request option.
|
|
7475
7539
|
* @throws {RequiredError}
|
|
7476
7540
|
*/
|
|
7477
|
-
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
7541
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
|
|
7478
7542
|
/**
|
|
7479
7543
|
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
7480
7544
|
* @summary List Trajectories
|
|
@@ -7483,7 +7547,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7483
7547
|
* @param {*} [options] Override http request option.
|
|
7484
7548
|
* @throws {RequiredError}
|
|
7485
7549
|
*/
|
|
7486
|
-
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7550
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListTrajectoriesResponse, any>>;
|
|
7487
7551
|
}
|
|
7488
7552
|
/**
|
|
7489
7553
|
* TrajectoryExecutionApi - axios parameter creator
|
|
@@ -7543,7 +7607,7 @@ declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
7543
7607
|
* @param {*} [options] Override http request option.
|
|
7544
7608
|
* @throws {RequiredError}
|
|
7545
7609
|
*/
|
|
7546
|
-
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7610
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
7547
7611
|
}
|
|
7548
7612
|
/**
|
|
7549
7613
|
* TrajectoryPlanningApi - axios parameter creator
|
|
@@ -7626,7 +7690,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
7626
7690
|
* @param {*} [options] Override http request option.
|
|
7627
7691
|
* @throws {RequiredError}
|
|
7628
7692
|
*/
|
|
7629
|
-
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7693
|
+
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
|
|
7630
7694
|
/**
|
|
7631
7695
|
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
7632
7696
|
* @summary Plan Trajectory
|
|
@@ -7635,7 +7699,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
7635
7699
|
* @param {*} [options] Override http request option.
|
|
7636
7700
|
* @throws {RequiredError}
|
|
7637
7701
|
*/
|
|
7638
|
-
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7702
|
+
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
7639
7703
|
}
|
|
7640
7704
|
/**
|
|
7641
7705
|
* VersionApi - axios parameter creator
|
|
@@ -7683,7 +7747,7 @@ declare class VersionApi extends BaseAPI {
|
|
|
7683
7747
|
* @param {*} [options] Override http request option.
|
|
7684
7748
|
* @throws {RequiredError}
|
|
7685
7749
|
*/
|
|
7686
|
-
getApiVersion(options?: RawAxiosRequestConfig): Promise<
|
|
7750
|
+
getApiVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ApiVersion, any>>;
|
|
7687
7751
|
}
|
|
7688
7752
|
/**
|
|
7689
7753
|
* VirtualControllerApi - axios parameter creator
|
|
@@ -8173,7 +8237,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8173
8237
|
* @param {*} [options] Override http request option.
|
|
8174
8238
|
* @throws {RequiredError}
|
|
8175
8239
|
*/
|
|
8176
|
-
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<
|
|
8240
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8177
8241
|
/**
|
|
8178
8242
|
* 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.
|
|
8179
8243
|
* @summary Add TCP
|
|
@@ -8185,7 +8249,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8185
8249
|
* @param {*} [options] Override http request option.
|
|
8186
8250
|
* @throws {RequiredError}
|
|
8187
8251
|
*/
|
|
8188
|
-
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<
|
|
8252
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8189
8253
|
/**
|
|
8190
8254
|
* 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.
|
|
8191
8255
|
* @summary Delete Coordinate System
|
|
@@ -8196,7 +8260,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8196
8260
|
* @param {*} [options] Override http request option.
|
|
8197
8261
|
* @throws {RequiredError}
|
|
8198
8262
|
*/
|
|
8199
|
-
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
8263
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8200
8264
|
/**
|
|
8201
8265
|
* 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.
|
|
8202
8266
|
* @summary Remove TCP
|
|
@@ -8207,7 +8271,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8207
8271
|
* @param {*} [options] Override http request option.
|
|
8208
8272
|
* @throws {RequiredError}
|
|
8209
8273
|
*/
|
|
8210
|
-
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<
|
|
8274
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8211
8275
|
/**
|
|
8212
8276
|
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
8213
8277
|
* @summary Get Emergency Stop State
|
|
@@ -8216,7 +8280,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8216
8280
|
* @param {*} [options] Override http request option.
|
|
8217
8281
|
* @throws {RequiredError}
|
|
8218
8282
|
*/
|
|
8219
|
-
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8283
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Flag, any>>;
|
|
8220
8284
|
/**
|
|
8221
8285
|
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8222
8286
|
* @summary Get Motion Group State
|
|
@@ -8226,7 +8290,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8226
8290
|
* @param {*} [options] Override http request option.
|
|
8227
8291
|
* @throws {RequiredError}
|
|
8228
8292
|
*/
|
|
8229
|
-
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8293
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupJoints, any>>;
|
|
8230
8294
|
/**
|
|
8231
8295
|
* Gets information on the motion group.
|
|
8232
8296
|
* @summary Motion Group Description
|
|
@@ -8235,7 +8299,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8235
8299
|
* @param {*} [options] Override http request option.
|
|
8236
8300
|
* @throws {RequiredError}
|
|
8237
8301
|
*/
|
|
8238
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8302
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfo[], any>>;
|
|
8239
8303
|
/**
|
|
8240
8304
|
* Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
8241
8305
|
* @summary Get Operation Mode
|
|
@@ -8244,7 +8308,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8244
8308
|
* @param {*} [options] Override http request option.
|
|
8245
8309
|
* @throws {RequiredError}
|
|
8246
8310
|
*/
|
|
8247
|
-
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8311
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<OpMode, any>>;
|
|
8248
8312
|
/**
|
|
8249
8313
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8250
8314
|
* @summary Get Mounting
|
|
@@ -8254,7 +8318,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8254
8318
|
* @param {*} [options] Override http request option.
|
|
8255
8319
|
* @throws {RequiredError}
|
|
8256
8320
|
*/
|
|
8257
|
-
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8321
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
8258
8322
|
/**
|
|
8259
8323
|
* Lists all coordinate systems on the robot controller.
|
|
8260
8324
|
* @summary List Coordinate Systems
|
|
@@ -8263,7 +8327,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8263
8327
|
* @param {*} [options] Override http request option.
|
|
8264
8328
|
* @throws {RequiredError}
|
|
8265
8329
|
*/
|
|
8266
|
-
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8330
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
8267
8331
|
/**
|
|
8268
8332
|
* Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
|
|
8269
8333
|
* @summary List TCPs
|
|
@@ -8273,7 +8337,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8273
8337
|
* @param {*} [options] Override http request option.
|
|
8274
8338
|
* @throws {RequiredError}
|
|
8275
8339
|
*/
|
|
8276
|
-
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8340
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp[], any>>;
|
|
8277
8341
|
/**
|
|
8278
8342
|
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
8279
8343
|
* @summary Push or Release Emergency Stop
|
|
@@ -8283,7 +8347,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8283
8347
|
* @param {*} [options] Override http request option.
|
|
8284
8348
|
* @throws {RequiredError}
|
|
8285
8349
|
*/
|
|
8286
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
8350
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8287
8351
|
/**
|
|
8288
8352
|
* 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.
|
|
8289
8353
|
* @summary Set Motion Group State
|
|
@@ -8294,7 +8358,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8294
8358
|
* @param {*} [options] Override http request option.
|
|
8295
8359
|
* @throws {RequiredError}
|
|
8296
8360
|
*/
|
|
8297
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<
|
|
8361
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8298
8362
|
/**
|
|
8299
8363
|
* Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
8300
8364
|
* @summary Set Operation Mode
|
|
@@ -8304,7 +8368,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8304
8368
|
* @param {*} [options] Override http request option.
|
|
8305
8369
|
* @throws {RequiredError}
|
|
8306
8370
|
*/
|
|
8307
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<
|
|
8371
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8308
8372
|
/**
|
|
8309
8373
|
* 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.
|
|
8310
8374
|
* @summary Set Mounting
|
|
@@ -8315,7 +8379,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8315
8379
|
* @param {*} [options] Override http request option.
|
|
8316
8380
|
* @throws {RequiredError}
|
|
8317
8381
|
*/
|
|
8318
|
-
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
8382
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
8319
8383
|
}
|
|
8320
8384
|
/**
|
|
8321
8385
|
* VirtualControllerBehaviorApi - axios parameter creator
|
|
@@ -8459,7 +8523,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8459
8523
|
* @param {*} [options] Override http request option.
|
|
8460
8524
|
* @throws {RequiredError}
|
|
8461
8525
|
*/
|
|
8462
|
-
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8526
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExternalJointStreamDatapoint[], any>>;
|
|
8463
8527
|
/**
|
|
8464
8528
|
* Get the cycle time of controller communication in [ms].
|
|
8465
8529
|
* @summary Get Cycle Time
|
|
@@ -8468,7 +8532,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8468
8532
|
* @param {*} [options] Override http request option.
|
|
8469
8533
|
* @throws {RequiredError}
|
|
8470
8534
|
*/
|
|
8471
|
-
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8535
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
|
|
8472
8536
|
/**
|
|
8473
8537
|
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
8474
8538
|
* @summary Get Behavior
|
|
@@ -8477,7 +8541,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8477
8541
|
* @param {*} [options] Override http request option.
|
|
8478
8542
|
* @throws {RequiredError}
|
|
8479
8543
|
*/
|
|
8480
|
-
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8544
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Behavior, any>>;
|
|
8481
8545
|
/**
|
|
8482
8546
|
* Set virtual controller behavior. See query parameters for details.
|
|
8483
8547
|
* @summary Set Behavior
|
|
@@ -8487,7 +8551,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8487
8551
|
* @param {*} [options] Override http request option.
|
|
8488
8552
|
* @throws {RequiredError}
|
|
8489
8553
|
*/
|
|
8490
|
-
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<
|
|
8554
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8491
8555
|
}
|
|
8492
8556
|
/**
|
|
8493
8557
|
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
@@ -8616,7 +8680,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
8616
8680
|
* @param {*} [options] Override http request option.
|
|
8617
8681
|
* @throws {RequiredError}
|
|
8618
8682
|
*/
|
|
8619
|
-
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
8683
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
8620
8684
|
/**
|
|
8621
8685
|
* 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.
|
|
8622
8686
|
* @summary List Descriptions
|
|
@@ -8629,7 +8693,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
8629
8693
|
* @param {*} [options] Override http request option.
|
|
8630
8694
|
* @throws {RequiredError}
|
|
8631
8695
|
*/
|
|
8632
|
-
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
8696
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
8633
8697
|
/**
|
|
8634
8698
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
8635
8699
|
* @summary Set Input/Ouput Values
|
|
@@ -8639,7 +8703,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
8639
8703
|
* @param {*} [options] Override http request option.
|
|
8640
8704
|
* @throws {RequiredError}
|
|
8641
8705
|
*/
|
|
8642
|
-
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
8706
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8643
8707
|
}
|
|
8644
8708
|
//#endregion
|
|
8645
8709
|
export { AbbController, AbbControllerEgmServer, AbbControllerKindEnum, ActivateLicenseRequest, AddTrajectoryError, AddTrajectoryErrorData, AddTrajectoryRequest, AddTrajectoryResponse, ApiVersion, App, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAuto, BlendingAutoBlendingNameEnum, BlendingPosition, BlendingPositionBlendingNameEnum, BooleanValue, BooleanValueValueTypeEnum, Box, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIODescription, BusIOModbusClient, BusIOModbusClientBusTypeEnum, BusIOModbusServer, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClient, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServer, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtual, BusIOModbusVirtualBusTypeEnum, BusIOProfinet, BusIOProfinetBusTypeEnum, BusIOProfinetDefaultRoute, BusIOProfinetIpConfig, BusIOProfinetNetwork, BusIOProfinetVirtual, BusIOProfinetVirtualBusTypeEnum, BusIOType, BusIOsState, BusIOsStateEnum, COLLECTION_FORMATS, Capsule, CapsuleShapeTypeEnum, CartesianLimits, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Collider, ColliderShape, Collision, CollisionContact, CollisionError, CollisionFreeAlgorithm, CollisionSetup, Comparator, Configuration, ConfigurationArchiveStatus, ConfigurationArchiveStatusCreating, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusError, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccess, ConfigurationArchiveStatusSuccessStatusEnum, ConfigurationParameters, ConfigurationResource, ContainerEnvironmentInner, ContainerImage, ContainerImageSecretsInner, ContainerResources, ContainerStorage, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerDescription, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHull, ConvexHullShapeTypeEnum, CoordinateSystem, CoordinateSystemData, CubicSplineParameter, CycleTime, Cylinder, CylinderShapeTypeEnum, DHParameter, Direction, ErrorInvalidJointCount, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceeded, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollision, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceeded, ErrorMaxIterationsExceededErrorFeedbackNameEnum, Execute, ExecuteDetails, ExecuteJoggingRequest, ExecuteJoggingResponse, ExecuteTrajectoryRequest, ExecuteTrajectoryResponse, ExternalJointStreamDatapoint, ExternalJointStreamRequest, FanucController, FanucControllerKindEnum, FeedbackCollision, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceeded, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspace, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularity, FeedbackSingularityErrorFeedbackNameEnum, Flag, FloatValue, FloatValueValueTypeEnum, ForwardKinematics422Response, ForwardKinematicsRequest, ForwardKinematicsResponse, ForwardKinematicsValidationError, GetTrajectoryResponse, HTTPValidationError, IOBooleanValue, IOBooleanValueValueTypeEnum, IOBoundary, IODescription, IODirection, IOFloatValue, IOFloatValueValueTypeEnum, IOIntegerValue, IOIntegerValueValueTypeEnum, IOOrigin, IOValue, IOValueType, ImageCredentials, InconsistentTrajectorySizeError, InconsistentTrajectorySizeErrorInconsistentTrajectorySize, InitializeJoggingRequest, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponse, InitializeJoggingResponseKindEnum, InitializeMovementRequest, InitializeMovementRequestMessageTypeEnum, InitializeMovementRequestTrajectory, InitializeMovementResponse, InitializeMovementResponseKindEnum, IntegerValue, IntegerValueValueTypeEnum, InvalidDofError, InvalidDofErrorInvalidDof, InverseKinematics422Response, InverseKinematicsRequest, InverseKinematicsResponse, InverseKinematicsValidationError, InverseKinematicsValidationErrorAllOfData, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetails, JoggingDetailsKindEnum, JoggingDetailsState, JoggingPausedByUser, JoggingPausedByUserKindEnum, JoggingPausedNearCollision, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimit, JoggingPausedNearJointLimitKindEnum, JoggingPausedOnIO, JoggingPausedOnIOKindEnum, JoggingRunning, JoggingRunningKindEnum, JointLimitExceededError, JointLimits, JointTrajectory, JointVelocityRequest, JointVelocityRequestMessageTypeEnum, JointVelocityResponse, JointVelocityResponseKindEnum, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaController, KukaControllerKindEnum, KukaControllerRsiServer, License, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatus, LicenseStatusEnum, LimitRange, LimitSet, LimitsOverride, ListTrajectoriesResponse, Manufacturer, MidpointInsertionAlgorithm, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIO, ModbusIOArea, ModbusIOByteOrder, ModbusIOData, ModbusIOTypeEnum, ModelError, MotionCommand, MotionCommandBlending, MotionCommandPath, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupDescription, MotionGroupInfo, MotionGroupJoints, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MotionGroupSetup, MotionGroupState, MotionGroupStateJointLimitReached, MovementErrorResponse, MovementErrorResponseKindEnum, NanValueError, NanValueErrorNanValue, OpMode, OperatingState, OperationLimits, OperationMode, OrientationType, PathCartesianPTP, PathCartesianPTPPathDefinitionNameEnum, PathCircle, PathCirclePathDefinitionNameEnum, PathCubicSpline, PathCubicSplinePathDefinitionNameEnum, PathJointPTP, PathJointPTPPathDefinitionNameEnum, PathLine, PathLinePathDefinitionNameEnum, PauseJoggingRequest, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponse, PauseJoggingResponseKindEnum, PauseMovementRequest, PauseMovementRequestMessageTypeEnum, PauseMovementResponse, PauseMovementResponseKindEnum, PauseOnIO, Payload, Plan422Response, PlanCollisionFreeFailedResponse, PlanCollisionFreeRequest, PlanCollisionFreeResponse, PlanCollisionFreeResponseResponse, PlanTrajectoryFailedResponse, PlanTrajectoryFailedResponseErrorFeedback, PlanTrajectoryRequest, PlanTrajectoryResponse, PlanTrajectoryResponseResponse, PlanValidationError, PlanValidationErrorAllOfData, Plane, PlaneShapeTypeEnum, PlaybackSpeedRequest, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponse, PlaybackSpeedResponseKindEnum, Pose, ProfinetDescription, ProfinetIO, ProfinetIOData, ProfinetIODirection, ProfinetIOTypeEnum, ProfinetInputOutputConfig, ProfinetSlotDescription, ProfinetSubSlotDescription, Program, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRun, ProgramRunState, ProgramStartRequest, RRTConnectAlgorithm, RRTConnectAlgorithmAlgorithmNameEnum, Rectangle, RectangleShapeTypeEnum, RectangularCapsule, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequestArgs, RequiredError, RobotController, RobotControllerConfiguration, RobotControllerState, RobotSystemMode, RobotTcp, RobotTcpData, SafetyStateType, ServiceGroup, ServiceStatus, ServiceStatusPhase, ServiceStatusResponse, ServiceStatusSeverity, ServiceStatusStatus, SetIO, SettableRobotSystemMode, SingularityTypeEnum, Sphere, SphereShapeTypeEnum, StartMovementRequest, StartMovementRequestMessageTypeEnum, StartMovementResponse, StartMovementResponseKindEnum, StartOnIO, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, StreamIOValuesResponse, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpOffset, TcpRequiredError, TcpVelocityRequest, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponse, TcpVelocityResponseKindEnum, TorqueExceededError, TorqueExceededErrorTorqueExceeded, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryData, TrajectoryDataMessageTypeEnum, TrajectoryDetails, TrajectoryDetailsKindEnum, TrajectoryDetailsState, TrajectoryEnded, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryId, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUser, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIO, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunning, TrajectoryRunningKindEnum, TrajectoryWaitForIO, TrajectoryWaitForIOKindEnum, UnitType, UniversalrobotsController, UniversalrobotsControllerKindEnum, UpdateNovaVersionRequest, ValidationError, ValidationError2, ValidationErrorLocInner, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualController, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, VirtualControllerTypes, VirtualRobotConfiguration, WaitForIOEventRequest, YaskawaController, YaskawaControllerKindEnum, operationServerMap };
|