@wandelbots/nova-api 26.1.0-dev.62 → 26.1.0-dev.64
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 +143 -0
- package/dist/v2/index.d.cts +163 -1
- package/dist/v2/index.d.ts +300 -138
- package/dist/v2/index.js +143 -1
- package/package.json +1 -1
package/dist/v2/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as axios0 from "axios";
|
|
2
2
|
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
3
|
|
|
4
4
|
//#region v2/configuration.d.ts
|
|
@@ -2048,6 +2048,72 @@ interface NanValueErrorNanValue {
|
|
|
2048
2048
|
*/
|
|
2049
2049
|
'joint_position'?: Array<number>;
|
|
2050
2050
|
}
|
|
2051
|
+
interface NetworkDevice {
|
|
2052
|
+
/**
|
|
2053
|
+
* The IPv4 address assigned to the network device.
|
|
2054
|
+
*/
|
|
2055
|
+
'ip': string;
|
|
2056
|
+
/**
|
|
2057
|
+
* The MAC address of the network device.
|
|
2058
|
+
*/
|
|
2059
|
+
'mac': string;
|
|
2060
|
+
/**
|
|
2061
|
+
* The vendor of the network device.
|
|
2062
|
+
*/
|
|
2063
|
+
'vendor'?: string;
|
|
2064
|
+
}
|
|
2065
|
+
interface NetworkInterface {
|
|
2066
|
+
/**
|
|
2067
|
+
* The name of the network interface.
|
|
2068
|
+
*/
|
|
2069
|
+
'name': string;
|
|
2070
|
+
/**
|
|
2071
|
+
* The IPv4 address assigned to the network interface.
|
|
2072
|
+
*/
|
|
2073
|
+
'ip': string;
|
|
2074
|
+
/**
|
|
2075
|
+
* The MAC address of the network interface.
|
|
2076
|
+
*/
|
|
2077
|
+
'mac': string;
|
|
2078
|
+
/**
|
|
2079
|
+
* The CIDR notation of the network interface. Example: \"192.168.1.0/24\"
|
|
2080
|
+
*/
|
|
2081
|
+
'cidr': string;
|
|
2082
|
+
}
|
|
2083
|
+
interface NetworkState {
|
|
2084
|
+
/**
|
|
2085
|
+
* Indicates whether the system is connected to the internet.
|
|
2086
|
+
*/
|
|
2087
|
+
'internet_connected': boolean;
|
|
2088
|
+
/**
|
|
2089
|
+
* Type of the active network link (e.g., ethernet, wifi, cellular, vpn, unknown).
|
|
2090
|
+
*/
|
|
2091
|
+
'connection_type'?: NetworkStateConnectionTypeEnum;
|
|
2092
|
+
/**
|
|
2093
|
+
* Received signal strength in dBm for wireless interfaces; negative values indicate weaker signals.
|
|
2094
|
+
*/
|
|
2095
|
+
'signal_strength'?: number;
|
|
2096
|
+
/**
|
|
2097
|
+
* Normalized link quality metric from 0 (poor) to 1 (excellent) when provided by the interface.
|
|
2098
|
+
*/
|
|
2099
|
+
'link_quality'?: number;
|
|
2100
|
+
/**
|
|
2101
|
+
* Round-trip latency to the probe endpoint measured in milliseconds.
|
|
2102
|
+
*/
|
|
2103
|
+
'latency_ms'?: number;
|
|
2104
|
+
/**
|
|
2105
|
+
* Estimated downstream bandwidth in megabits per second based on the probe.
|
|
2106
|
+
*/
|
|
2107
|
+
'bandwidth_mbps'?: number;
|
|
2108
|
+
}
|
|
2109
|
+
declare const NetworkStateConnectionTypeEnum: {
|
|
2110
|
+
readonly Ethernet: "ethernet";
|
|
2111
|
+
readonly Wifi: "wifi";
|
|
2112
|
+
readonly Cellular: "cellular";
|
|
2113
|
+
readonly Vpn: "vpn";
|
|
2114
|
+
readonly Unknown: "unknown";
|
|
2115
|
+
};
|
|
2116
|
+
type NetworkStateConnectionTypeEnum = typeof NetworkStateConnectionTypeEnum[keyof typeof NetworkStateConnectionTypeEnum];
|
|
2051
2117
|
/**
|
|
2052
2118
|
* Controllers have two operating modes: AUTOMATIC and MANUAL. MANUAL mode is mainly used for teaching a robot application. To ensure safe operation the velocity of the robot is limited to 250 mm/s. Running the finished application is done in AUTOMATIC operating mode without the limited velocity of the MANUAL mode.
|
|
2053
2119
|
*/
|
|
@@ -3436,7 +3502,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3436
3502
|
* @param {*} [options] Override http request option.
|
|
3437
3503
|
* @throws {RequiredError}
|
|
3438
3504
|
*/
|
|
3439
|
-
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3505
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3440
3506
|
/**
|
|
3441
3507
|
* Delete all GUI applications from the cell.
|
|
3442
3508
|
* @summary Clear Applications
|
|
@@ -3445,7 +3511,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3445
3511
|
* @param {*} [options] Override http request option.
|
|
3446
3512
|
* @throws {RequiredError}
|
|
3447
3513
|
*/
|
|
3448
|
-
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3514
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3449
3515
|
/**
|
|
3450
3516
|
* Delete a GUI application from the cell.
|
|
3451
3517
|
* @summary Delete Application
|
|
@@ -3455,7 +3521,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3455
3521
|
* @param {*} [options] Override http request option.
|
|
3456
3522
|
* @throws {RequiredError}
|
|
3457
3523
|
*/
|
|
3458
|
-
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3524
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3459
3525
|
/**
|
|
3460
3526
|
* 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).
|
|
3461
3527
|
* @summary Configuration
|
|
@@ -3464,7 +3530,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3464
3530
|
* @param {*} [options] Override http request option.
|
|
3465
3531
|
* @throws {RequiredError}
|
|
3466
3532
|
*/
|
|
3467
|
-
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<
|
|
3533
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
|
|
3468
3534
|
/**
|
|
3469
3535
|
* 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.
|
|
3470
3536
|
* @summary List Applications
|
|
@@ -3472,7 +3538,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3472
3538
|
* @param {*} [options] Override http request option.
|
|
3473
3539
|
* @throws {RequiredError}
|
|
3474
3540
|
*/
|
|
3475
|
-
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
3541
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
3476
3542
|
/**
|
|
3477
3543
|
* Update the configuration of a GUI application in the cell.
|
|
3478
3544
|
* @summary Update Configuration
|
|
@@ -3483,7 +3549,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3483
3549
|
* @param {*} [options] Override http request option.
|
|
3484
3550
|
* @throws {RequiredError}
|
|
3485
3551
|
*/
|
|
3486
|
-
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3552
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3487
3553
|
}
|
|
3488
3554
|
/**
|
|
3489
3555
|
* BUSInputsOutputsApi - axios parameter creator
|
|
@@ -3987,7 +4053,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
3987
4053
|
* @param {*} [options] Override http request option.
|
|
3988
4054
|
* @throws {RequiredError}
|
|
3989
4055
|
*/
|
|
3990
|
-
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4056
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3991
4057
|
/**
|
|
3992
4058
|
* 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).
|
|
3993
4059
|
* @summary Add MODBUS Input/Output
|
|
@@ -3997,7 +4063,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
3997
4063
|
* @param {*} [options] Override http request option.
|
|
3998
4064
|
* @throws {RequiredError}
|
|
3999
4065
|
*/
|
|
4000
|
-
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<
|
|
4066
|
+
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4001
4067
|
/**
|
|
4002
4068
|
* 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).
|
|
4003
4069
|
* @summary Add PROFINET Input/Output
|
|
@@ -4007,7 +4073,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4007
4073
|
* @param {*} [options] Override http request option.
|
|
4008
4074
|
* @throws {RequiredError}
|
|
4009
4075
|
*/
|
|
4010
|
-
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<
|
|
4076
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4011
4077
|
/**
|
|
4012
4078
|
* Remove the BUS inputs/outputs service from the cell.
|
|
4013
4079
|
* @summary Clear Service
|
|
@@ -4016,7 +4082,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4016
4082
|
* @param {*} [options] Override http request option.
|
|
4017
4083
|
* @throws {RequiredError}
|
|
4018
4084
|
*/
|
|
4019
|
-
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4085
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4020
4086
|
/**
|
|
4021
4087
|
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4022
4088
|
* @summary Remove all MODBUS Input/Outputs
|
|
@@ -4024,7 +4090,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4024
4090
|
* @param {*} [options] Override http request option.
|
|
4025
4091
|
* @throws {RequiredError}
|
|
4026
4092
|
*/
|
|
4027
|
-
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4093
|
+
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4028
4094
|
/**
|
|
4029
4095
|
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
4030
4096
|
* @summary Remove all PROFINET Input/Outputs
|
|
@@ -4032,7 +4098,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4032
4098
|
* @param {*} [options] Override http request option.
|
|
4033
4099
|
* @throws {RequiredError}
|
|
4034
4100
|
*/
|
|
4035
|
-
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4101
|
+
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4036
4102
|
/**
|
|
4037
4103
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4038
4104
|
* @summary Remove MODBUS Input/Ouptut
|
|
@@ -4041,7 +4107,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4041
4107
|
* @param {*} [options] Override http request option.
|
|
4042
4108
|
* @throws {RequiredError}
|
|
4043
4109
|
*/
|
|
4044
|
-
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
4110
|
+
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4045
4111
|
/**
|
|
4046
4112
|
* Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
4047
4113
|
* @summary Remove PROFINET Input/Ouptut
|
|
@@ -4050,7 +4116,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4050
4116
|
* @param {*} [options] Override http request option.
|
|
4051
4117
|
* @throws {RequiredError}
|
|
4052
4118
|
*/
|
|
4053
|
-
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
4119
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4054
4120
|
/**
|
|
4055
4121
|
* Get deployed BUS inputs/outputs service.
|
|
4056
4122
|
* @summary Get Service
|
|
@@ -4058,7 +4124,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4058
4124
|
* @param {*} [options] Override http request option.
|
|
4059
4125
|
* @throws {RequiredError}
|
|
4060
4126
|
*/
|
|
4061
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4127
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOType, any>>;
|
|
4062
4128
|
/**
|
|
4063
4129
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
4064
4130
|
* @summary State
|
|
@@ -4066,7 +4132,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4066
4132
|
* @param {*} [options] Override http request option.
|
|
4067
4133
|
* @throws {RequiredError}
|
|
4068
4134
|
*/
|
|
4069
|
-
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4135
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOsState, any>>;
|
|
4070
4136
|
/**
|
|
4071
4137
|
* 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).
|
|
4072
4138
|
* @summary Get Input/Output Values
|
|
@@ -4075,7 +4141,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4075
4141
|
* @param {*} [options] Override http request option.
|
|
4076
4142
|
* @throws {RequiredError}
|
|
4077
4143
|
*/
|
|
4078
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
4144
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
4079
4145
|
/**
|
|
4080
4146
|
* Get description of NOVA as a PROFINET device.
|
|
4081
4147
|
* @summary Get PROFINET Description
|
|
@@ -4083,7 +4149,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4083
4149
|
* @param {*} [options] Override http request option.
|
|
4084
4150
|
* @throws {RequiredError}
|
|
4085
4151
|
*/
|
|
4086
|
-
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4152
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetDescription, any>>;
|
|
4087
4153
|
/**
|
|
4088
4154
|
* 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.
|
|
4089
4155
|
* @summary PROFINET Inputs/Outputs to File
|
|
@@ -4093,7 +4159,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4093
4159
|
* @param {*} [options] Override http request option.
|
|
4094
4160
|
* @throws {RequiredError}
|
|
4095
4161
|
*/
|
|
4096
|
-
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4162
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
4097
4163
|
/**
|
|
4098
4164
|
* 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.
|
|
4099
4165
|
* @summary List Descriptions
|
|
@@ -4101,7 +4167,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4101
4167
|
* @param {*} [options] Override http request option.
|
|
4102
4168
|
* @throws {RequiredError}
|
|
4103
4169
|
*/
|
|
4104
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4170
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIODescription[], any>>;
|
|
4105
4171
|
/**
|
|
4106
4172
|
* 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).
|
|
4107
4173
|
* @summary List MODBUS Input/Output Configuration
|
|
@@ -4109,7 +4175,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4109
4175
|
* @param {*} [options] Override http request option.
|
|
4110
4176
|
* @throws {RequiredError}
|
|
4111
4177
|
*/
|
|
4112
|
-
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4178
|
+
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ModbusIO[], any>>;
|
|
4113
4179
|
/**
|
|
4114
4180
|
* 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.
|
|
4115
4181
|
* @summary List PROFINET Input/Output Configuration
|
|
@@ -4117,7 +4183,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4117
4183
|
* @param {*} [options] Override http request option.
|
|
4118
4184
|
* @throws {RequiredError}
|
|
4119
4185
|
*/
|
|
4120
|
-
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4186
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetIO[], any>>;
|
|
4121
4187
|
/**
|
|
4122
4188
|
* 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.
|
|
4123
4189
|
* @summary Set Output Values
|
|
@@ -4126,7 +4192,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4126
4192
|
* @param {*} [options] Override http request option.
|
|
4127
4193
|
* @throws {RequiredError}
|
|
4128
4194
|
*/
|
|
4129
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
4195
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4130
4196
|
/**
|
|
4131
4197
|
* 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.
|
|
4132
4198
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
@@ -4135,7 +4201,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4135
4201
|
* @param {*} [options] Override http request option.
|
|
4136
4202
|
* @throws {RequiredError}
|
|
4137
4203
|
*/
|
|
4138
|
-
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<
|
|
4204
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4139
4205
|
}
|
|
4140
4206
|
/**
|
|
4141
4207
|
* CellApi - axios parameter creator
|
|
@@ -4344,7 +4410,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4344
4410
|
* @param {*} [options] Override http request option.
|
|
4345
4411
|
* @throws {RequiredError}
|
|
4346
4412
|
*/
|
|
4347
|
-
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4413
|
+
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4348
4414
|
/**
|
|
4349
4415
|
* 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.
|
|
4350
4416
|
* @summary Add Cell
|
|
@@ -4353,7 +4419,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4353
4419
|
* @param {*} [options] Override http request option.
|
|
4354
4420
|
* @throws {RequiredError}
|
|
4355
4421
|
*/
|
|
4356
|
-
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4422
|
+
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4357
4423
|
/**
|
|
4358
4424
|
* List all cell resources.
|
|
4359
4425
|
* @summary Configuration
|
|
@@ -4361,7 +4427,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4361
4427
|
* @param {*} [options] Override http request option.
|
|
4362
4428
|
* @throws {RequiredError}
|
|
4363
4429
|
*/
|
|
4364
|
-
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4430
|
+
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Cell, any>>;
|
|
4365
4431
|
/**
|
|
4366
4432
|
* List the status of all cell resources.
|
|
4367
4433
|
* @summary Service Status
|
|
@@ -4369,14 +4435,14 @@ declare class CellApi extends BaseAPI {
|
|
|
4369
4435
|
* @param {*} [options] Override http request option.
|
|
4370
4436
|
* @throws {RequiredError}
|
|
4371
4437
|
*/
|
|
4372
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4438
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatusResponse, any>>;
|
|
4373
4439
|
/**
|
|
4374
4440
|
* List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
4375
4441
|
* @summary List Cells
|
|
4376
4442
|
* @param {*} [options] Override http request option.
|
|
4377
4443
|
* @throws {RequiredError}
|
|
4378
4444
|
*/
|
|
4379
|
-
listCells(options?: RawAxiosRequestConfig): Promise<
|
|
4445
|
+
listCells(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
4380
4446
|
/**
|
|
4381
4447
|
* Deactivate or activate the services of a cell.
|
|
4382
4448
|
* @summary Operating State
|
|
@@ -4385,7 +4451,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4385
4451
|
* @param {*} [options] Override http request option.
|
|
4386
4452
|
* @throws {RequiredError}
|
|
4387
4453
|
*/
|
|
4388
|
-
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<
|
|
4454
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4389
4455
|
/**
|
|
4390
4456
|
* Update the definition of the entire Cell.
|
|
4391
4457
|
* @summary Update Configuration
|
|
@@ -4395,7 +4461,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4395
4461
|
* @param {*} [options] Override http request option.
|
|
4396
4462
|
* @throws {RequiredError}
|
|
4397
4463
|
*/
|
|
4398
|
-
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4464
|
+
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4399
4465
|
}
|
|
4400
4466
|
/**
|
|
4401
4467
|
* ControllerApi - axios parameter creator
|
|
@@ -4833,7 +4899,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4833
4899
|
* @param {*} [options] Override http request option.
|
|
4834
4900
|
* @throws {RequiredError}
|
|
4835
4901
|
*/
|
|
4836
|
-
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4902
|
+
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4837
4903
|
/**
|
|
4838
4904
|
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
4839
4905
|
* @summary Clear Robot Controllers
|
|
@@ -4842,7 +4908,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4842
4908
|
* @param {*} [options] Override http request option.
|
|
4843
4909
|
* @throws {RequiredError}
|
|
4844
4910
|
*/
|
|
4845
|
-
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4911
|
+
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4846
4912
|
/**
|
|
4847
4913
|
* Delete a robot controller from the cell.
|
|
4848
4914
|
* @summary Delete Robot Controller
|
|
@@ -4852,7 +4918,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4852
4918
|
* @param {*} [options] Override http request option.
|
|
4853
4919
|
* @throws {RequiredError}
|
|
4854
4920
|
*/
|
|
4855
|
-
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4921
|
+
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4856
4922
|
/**
|
|
4857
4923
|
* 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.
|
|
4858
4924
|
* @summary Description
|
|
@@ -4861,7 +4927,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4861
4927
|
* @param {*} [options] Override http request option.
|
|
4862
4928
|
* @throws {RequiredError}
|
|
4863
4929
|
*/
|
|
4864
|
-
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4930
|
+
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ControllerDescription, any>>;
|
|
4865
4931
|
/**
|
|
4866
4932
|
* 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.
|
|
4867
4933
|
* @summary Coordinate System
|
|
@@ -4872,7 +4938,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4872
4938
|
* @param {*} [options] Override http request option.
|
|
4873
4939
|
* @throws {RequiredError}
|
|
4874
4940
|
*/
|
|
4875
|
-
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
4941
|
+
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
4876
4942
|
/**
|
|
4877
4943
|
* Get the current state of a robot controller.
|
|
4878
4944
|
* @summary State
|
|
@@ -4881,7 +4947,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4881
4947
|
* @param {*} [options] Override http request option.
|
|
4882
4948
|
* @throws {RequiredError}
|
|
4883
4949
|
*/
|
|
4884
|
-
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4950
|
+
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
4885
4951
|
/**
|
|
4886
4952
|
* Get the configuration for a robot controller.
|
|
4887
4953
|
* @summary Robot Controller
|
|
@@ -4890,7 +4956,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4890
4956
|
* @param {*} [options] Override http request option.
|
|
4891
4957
|
* @throws {RequiredError}
|
|
4892
4958
|
*/
|
|
4893
|
-
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4959
|
+
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
|
|
4894
4960
|
/**
|
|
4895
4961
|
* 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.
|
|
4896
4962
|
* @summary Virtual Controller Configuration
|
|
@@ -4899,7 +4965,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4899
4965
|
* @param {*} [options] Override http request option.
|
|
4900
4966
|
* @throws {RequiredError}
|
|
4901
4967
|
*/
|
|
4902
|
-
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4968
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
4903
4969
|
/**
|
|
4904
4970
|
* 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.
|
|
4905
4971
|
* @summary List Coordinate Systems
|
|
@@ -4909,7 +4975,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4909
4975
|
* @param {*} [options] Override http request option.
|
|
4910
4976
|
* @throws {RequiredError}
|
|
4911
4977
|
*/
|
|
4912
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
4978
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
4913
4979
|
/**
|
|
4914
4980
|
* List the names of all deployed robot controllers.
|
|
4915
4981
|
* @summary List Robot Controllers
|
|
@@ -4917,7 +4983,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4917
4983
|
* @param {*} [options] Override http request option.
|
|
4918
4984
|
* @throws {RequiredError}
|
|
4919
4985
|
*/
|
|
4920
|
-
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4986
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
4921
4987
|
/**
|
|
4922
4988
|
* 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.
|
|
4923
4989
|
* @summary Set Default Mode
|
|
@@ -4927,7 +4993,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4927
4993
|
* @param {*} [options] Override http request option.
|
|
4928
4994
|
* @throws {RequiredError}
|
|
4929
4995
|
*/
|
|
4930
|
-
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<
|
|
4996
|
+
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4931
4997
|
/**
|
|
4932
4998
|
* <!-- 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.
|
|
4933
4999
|
* @summary Stream Free Drive
|
|
@@ -4937,7 +5003,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4937
5003
|
* @param {*} [options] Override http request option.
|
|
4938
5004
|
* @throws {RequiredError}
|
|
4939
5005
|
*/
|
|
4940
|
-
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5006
|
+
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
4941
5007
|
/**
|
|
4942
5008
|
* <!-- 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.
|
|
4943
5009
|
* @summary Stream State
|
|
@@ -4948,7 +5014,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4948
5014
|
* @param {*} [options] Override http request option.
|
|
4949
5015
|
* @throws {RequiredError}
|
|
4950
5016
|
*/
|
|
4951
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5017
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
4952
5018
|
/**
|
|
4953
5019
|
* 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).
|
|
4954
5020
|
* @summary Update Robot Controller
|
|
@@ -4959,7 +5025,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4959
5025
|
* @param {*} [options] Override http request option.
|
|
4960
5026
|
* @throws {RequiredError}
|
|
4961
5027
|
*/
|
|
4962
|
-
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5028
|
+
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4963
5029
|
}
|
|
4964
5030
|
/**
|
|
4965
5031
|
* ControllerInputsOutputsApi - axios parameter creator
|
|
@@ -5151,7 +5217,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5151
5217
|
* @param {*} [options] Override http request option.
|
|
5152
5218
|
* @throws {RequiredError}
|
|
5153
5219
|
*/
|
|
5154
|
-
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5220
|
+
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
5155
5221
|
/**
|
|
5156
5222
|
* 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).
|
|
5157
5223
|
* @summary Get Input/Output Values
|
|
@@ -5161,7 +5227,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5161
5227
|
* @param {*} [options] Override http request option.
|
|
5162
5228
|
* @throws {RequiredError}
|
|
5163
5229
|
*/
|
|
5164
|
-
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5230
|
+
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
5165
5231
|
/**
|
|
5166
5232
|
* 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.
|
|
5167
5233
|
* @summary Set Output Values
|
|
@@ -5171,7 +5237,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5171
5237
|
* @param {*} [options] Override http request option.
|
|
5172
5238
|
* @throws {RequiredError}
|
|
5173
5239
|
*/
|
|
5174
|
-
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
5240
|
+
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5175
5241
|
/**
|
|
5176
5242
|
* <!-- 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.
|
|
5177
5243
|
* @summary Stream Input/Output Values
|
|
@@ -5181,7 +5247,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5181
5247
|
* @param {*} [options] Override http request option.
|
|
5182
5248
|
* @throws {RequiredError}
|
|
5183
5249
|
*/
|
|
5184
|
-
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5250
|
+
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamIOValuesResponse, any>>;
|
|
5185
5251
|
/**
|
|
5186
5252
|
* 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 ```
|
|
5187
5253
|
* @summary Wait For
|
|
@@ -5191,7 +5257,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5191
5257
|
* @param {*} [options] Override http request option.
|
|
5192
5258
|
* @throws {RequiredError}
|
|
5193
5259
|
*/
|
|
5194
|
-
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5260
|
+
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<boolean, any>>;
|
|
5195
5261
|
}
|
|
5196
5262
|
/**
|
|
5197
5263
|
* JoggingApi - axios parameter creator
|
|
@@ -5251,7 +5317,7 @@ declare class JoggingApi extends BaseAPI {
|
|
|
5251
5317
|
* @param {*} [options] Override http request option.
|
|
5252
5318
|
* @throws {RequiredError}
|
|
5253
5319
|
*/
|
|
5254
|
-
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5320
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteJoggingResponse, any>>;
|
|
5255
5321
|
}
|
|
5256
5322
|
/**
|
|
5257
5323
|
* KinematicsApi - axios parameter creator
|
|
@@ -5334,7 +5400,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
5334
5400
|
* @param {*} [options] Override http request option.
|
|
5335
5401
|
* @throws {RequiredError}
|
|
5336
5402
|
*/
|
|
5337
|
-
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5403
|
+
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ForwardKinematicsResponse, any>>;
|
|
5338
5404
|
/**
|
|
5339
5405
|
* Returns the reachable joint positions for a list of given poses.
|
|
5340
5406
|
* @summary Inverse kinematics
|
|
@@ -5343,7 +5409,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
5343
5409
|
* @param {*} [options] Override http request option.
|
|
5344
5410
|
* @throws {RequiredError}
|
|
5345
5411
|
*/
|
|
5346
|
-
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5412
|
+
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<InverseKinematicsResponse, any>>;
|
|
5347
5413
|
}
|
|
5348
5414
|
/**
|
|
5349
5415
|
* LicenseApi - axios parameter creator
|
|
@@ -5458,28 +5524,28 @@ declare class LicenseApi extends BaseAPI {
|
|
|
5458
5524
|
* @param {*} [options] Override http request option.
|
|
5459
5525
|
* @throws {RequiredError}
|
|
5460
5526
|
*/
|
|
5461
|
-
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5527
|
+
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
5462
5528
|
/**
|
|
5463
5529
|
* Deactivates active license.
|
|
5464
5530
|
* @summary Deactivate license
|
|
5465
5531
|
* @param {*} [options] Override http request option.
|
|
5466
5532
|
* @throws {RequiredError}
|
|
5467
5533
|
*/
|
|
5468
|
-
deactivateLicense(options?: RawAxiosRequestConfig): Promise<
|
|
5534
|
+
deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5469
5535
|
/**
|
|
5470
5536
|
* Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
|
|
5471
5537
|
* @summary Get license
|
|
5472
5538
|
* @param {*} [options] Override http request option.
|
|
5473
5539
|
* @throws {RequiredError}
|
|
5474
5540
|
*/
|
|
5475
|
-
getLicense(options?: RawAxiosRequestConfig): Promise<
|
|
5541
|
+
getLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
5476
5542
|
/**
|
|
5477
5543
|
* 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.
|
|
5478
5544
|
* @summary Get license status
|
|
5479
5545
|
* @param {*} [options] Override http request option.
|
|
5480
5546
|
* @throws {RequiredError}
|
|
5481
5547
|
*/
|
|
5482
|
-
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<
|
|
5548
|
+
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<LicenseStatus, any>>;
|
|
5483
5549
|
}
|
|
5484
5550
|
/**
|
|
5485
5551
|
* MotionGroupApi - axios parameter creator
|
|
@@ -5609,7 +5675,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5609
5675
|
* @param {*} [options] Override http request option.
|
|
5610
5676
|
* @throws {RequiredError}
|
|
5611
5677
|
*/
|
|
5612
|
-
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5678
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
5613
5679
|
/**
|
|
5614
5680
|
* 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.
|
|
5615
5681
|
* @summary Description
|
|
@@ -5619,7 +5685,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5619
5685
|
* @param {*} [options] Override http request option.
|
|
5620
5686
|
* @throws {RequiredError}
|
|
5621
5687
|
*/
|
|
5622
|
-
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
5688
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupDescription, any>>;
|
|
5623
5689
|
/**
|
|
5624
5690
|
* <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
5625
5691
|
* @summary Stream State
|
|
@@ -5631,7 +5697,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5631
5697
|
* @param {*} [options] Override http request option.
|
|
5632
5698
|
* @throws {RequiredError}
|
|
5633
5699
|
*/
|
|
5634
|
-
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5700
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
5635
5701
|
}
|
|
5636
5702
|
/**
|
|
5637
5703
|
* MotionGroupModelsApi - axios parameter creator
|
|
@@ -5780,7 +5846,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
5780
5846
|
* @param {*} [options] Override http request option.
|
|
5781
5847
|
* @throws {RequiredError}
|
|
5782
5848
|
*/
|
|
5783
|
-
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
5849
|
+
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
5784
5850
|
[key: string]: Collider;
|
|
5785
5851
|
}[], any>>;
|
|
5786
5852
|
/**
|
|
@@ -5790,7 +5856,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
5790
5856
|
* @param {*} [options] Override http request option.
|
|
5791
5857
|
* @throws {RequiredError}
|
|
5792
5858
|
*/
|
|
5793
|
-
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
5859
|
+
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
5794
5860
|
/**
|
|
5795
5861
|
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
5796
5862
|
* @summary Get Kinematics
|
|
@@ -5798,14 +5864,14 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
5798
5864
|
* @param {*} [options] Override http request option.
|
|
5799
5865
|
* @throws {RequiredError}
|
|
5800
5866
|
*/
|
|
5801
|
-
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
5867
|
+
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<KinematicModel, any>>;
|
|
5802
5868
|
/**
|
|
5803
5869
|
* Returns the list of supported motion group models.
|
|
5804
5870
|
* @summary Motion Group Models
|
|
5805
5871
|
* @param {*} [options] Override http request option.
|
|
5806
5872
|
* @throws {RequiredError}
|
|
5807
5873
|
*/
|
|
5808
|
-
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<
|
|
5874
|
+
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
5809
5875
|
/**
|
|
5810
5876
|
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
5811
5877
|
* @summary Download USD Model
|
|
@@ -5813,7 +5879,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
5813
5879
|
* @param {*} [options] Override http request option.
|
|
5814
5880
|
* @throws {RequiredError}
|
|
5815
5881
|
*/
|
|
5816
|
-
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
5882
|
+
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
5817
5883
|
}
|
|
5818
5884
|
/**
|
|
5819
5885
|
* ProgramApi - axios parameter creator
|
|
@@ -5950,7 +6016,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
5950
6016
|
* @param {*} [options] Override http request option.
|
|
5951
6017
|
* @throws {RequiredError}
|
|
5952
6018
|
*/
|
|
5953
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
6019
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program, any>>;
|
|
5954
6020
|
/**
|
|
5955
6021
|
* <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
5956
6022
|
* @summary List programs
|
|
@@ -5958,7 +6024,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
5958
6024
|
* @param {*} [options] Override http request option.
|
|
5959
6025
|
* @throws {RequiredError}
|
|
5960
6026
|
*/
|
|
5961
|
-
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6027
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program[], any>>;
|
|
5962
6028
|
/**
|
|
5963
6029
|
* <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5964
6030
|
* @summary Start the program
|
|
@@ -5968,7 +6034,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
5968
6034
|
* @param {*} [options] Override http request option.
|
|
5969
6035
|
* @throws {RequiredError}
|
|
5970
6036
|
*/
|
|
5971
|
-
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6037
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
|
|
5972
6038
|
/**
|
|
5973
6039
|
* <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
5974
6040
|
* @summary Stop program run
|
|
@@ -5977,7 +6043,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
5977
6043
|
* @param {*} [options] Override http request option.
|
|
5978
6044
|
* @throws {RequiredError}
|
|
5979
6045
|
*/
|
|
5980
|
-
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
6046
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5981
6047
|
}
|
|
5982
6048
|
/**
|
|
5983
6049
|
* RobotConfigurationsApi - axios parameter creator
|
|
@@ -6025,7 +6091,7 @@ declare class RobotConfigurationsApi extends BaseAPI {
|
|
|
6025
6091
|
* @param {*} [options] Override http request option.
|
|
6026
6092
|
* @throws {RequiredError}
|
|
6027
6093
|
*/
|
|
6028
|
-
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<
|
|
6094
|
+
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6029
6095
|
}
|
|
6030
6096
|
/**
|
|
6031
6097
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
@@ -6498,7 +6564,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6498
6564
|
* @param {*} [options] Override http request option.
|
|
6499
6565
|
* @throws {RequiredError}
|
|
6500
6566
|
*/
|
|
6501
|
-
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
6567
|
+
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6502
6568
|
/**
|
|
6503
6569
|
* Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6504
6570
|
* @summary Delete Link Chain
|
|
@@ -6507,7 +6573,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6507
6573
|
* @param {*} [options] Override http request option.
|
|
6508
6574
|
* @throws {RequiredError}
|
|
6509
6575
|
*/
|
|
6510
|
-
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
6576
|
+
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6511
6577
|
/**
|
|
6512
6578
|
* Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6513
6579
|
* @summary Delete Tool
|
|
@@ -6516,7 +6582,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6516
6582
|
* @param {*} [options] Override http request option.
|
|
6517
6583
|
* @throws {RequiredError}
|
|
6518
6584
|
*/
|
|
6519
|
-
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
6585
|
+
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6520
6586
|
/**
|
|
6521
6587
|
* Returns the collider.
|
|
6522
6588
|
* @summary Get Collider
|
|
@@ -6525,7 +6591,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6525
6591
|
* @param {*} [options] Override http request option.
|
|
6526
6592
|
* @throws {RequiredError}
|
|
6527
6593
|
*/
|
|
6528
|
-
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
6594
|
+
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
6529
6595
|
/**
|
|
6530
6596
|
* Returns the collision link chain.
|
|
6531
6597
|
* @summary Get Link Chain
|
|
@@ -6534,7 +6600,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6534
6600
|
* @param {*} [options] Override http request option.
|
|
6535
6601
|
* @throws {RequiredError}
|
|
6536
6602
|
*/
|
|
6537
|
-
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
6603
|
+
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6538
6604
|
[key: string]: Collider;
|
|
6539
6605
|
}[], any>>;
|
|
6540
6606
|
/**
|
|
@@ -6545,7 +6611,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6545
6611
|
* @param {*} [options] Override http request option.
|
|
6546
6612
|
* @throws {RequiredError}
|
|
6547
6613
|
*/
|
|
6548
|
-
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
6614
|
+
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6549
6615
|
[key: string]: Collider;
|
|
6550
6616
|
}, any>>;
|
|
6551
6617
|
/**
|
|
@@ -6555,7 +6621,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6555
6621
|
* @param {*} [options] Override http request option.
|
|
6556
6622
|
* @throws {RequiredError}
|
|
6557
6623
|
*/
|
|
6558
|
-
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6624
|
+
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6559
6625
|
[key: string]: {
|
|
6560
6626
|
[key: string]: Collider;
|
|
6561
6627
|
}[];
|
|
@@ -6567,7 +6633,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6567
6633
|
* @param {*} [options] Override http request option.
|
|
6568
6634
|
* @throws {RequiredError}
|
|
6569
6635
|
*/
|
|
6570
|
-
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6636
|
+
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6571
6637
|
/**
|
|
6572
6638
|
* Returns all stored colliders.
|
|
6573
6639
|
* @summary List Colliders
|
|
@@ -6575,7 +6641,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6575
6641
|
* @param {*} [options] Override http request option.
|
|
6576
6642
|
* @throws {RequiredError}
|
|
6577
6643
|
*/
|
|
6578
|
-
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6644
|
+
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6579
6645
|
[key: string]: Collider;
|
|
6580
6646
|
}, any>>;
|
|
6581
6647
|
/**
|
|
@@ -6585,7 +6651,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6585
6651
|
* @param {*} [options] Override http request option.
|
|
6586
6652
|
* @throws {RequiredError}
|
|
6587
6653
|
*/
|
|
6588
|
-
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6654
|
+
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6589
6655
|
/**
|
|
6590
6656
|
* Returns the list of stored tools.
|
|
6591
6657
|
* @summary List Tools
|
|
@@ -6593,7 +6659,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6593
6659
|
* @param {*} [options] Override http request option.
|
|
6594
6660
|
* @throws {RequiredError}
|
|
6595
6661
|
*/
|
|
6596
|
-
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6662
|
+
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6597
6663
|
[key: string]: {
|
|
6598
6664
|
[key: string]: Collider;
|
|
6599
6665
|
};
|
|
@@ -6605,7 +6671,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6605
6671
|
* @param {*} [options] Override http request option.
|
|
6606
6672
|
* @throws {RequiredError}
|
|
6607
6673
|
*/
|
|
6608
|
-
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6674
|
+
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6609
6675
|
/**
|
|
6610
6676
|
* Stores collider. - If the collider does not exist, it will be created. - If the collider exists, it will be updated.
|
|
6611
6677
|
* @summary Store Collider
|
|
@@ -6615,7 +6681,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6615
6681
|
* @param {*} [options] Override http request option.
|
|
6616
6682
|
* @throws {RequiredError}
|
|
6617
6683
|
*/
|
|
6618
|
-
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<
|
|
6684
|
+
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
6619
6685
|
/**
|
|
6620
6686
|
* Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
|
|
6621
6687
|
* @summary Store Link Chain
|
|
@@ -6627,7 +6693,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6627
6693
|
*/
|
|
6628
6694
|
storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{
|
|
6629
6695
|
[key: string]: Collider;
|
|
6630
|
-
}>, options?: RawAxiosRequestConfig): Promise<
|
|
6696
|
+
}>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6631
6697
|
[key: string]: Collider;
|
|
6632
6698
|
}[], any>>;
|
|
6633
6699
|
/**
|
|
@@ -6641,7 +6707,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6641
6707
|
*/
|
|
6642
6708
|
storeCollisionTool(cell: string, tool: string, requestBody: {
|
|
6643
6709
|
[key: string]: Collider;
|
|
6644
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
6710
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6645
6711
|
[key: string]: Collider;
|
|
6646
6712
|
}, any>>;
|
|
6647
6713
|
}
|
|
@@ -6808,7 +6874,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6808
6874
|
* @param {*} [options] Override http request option.
|
|
6809
6875
|
* @throws {RequiredError}
|
|
6810
6876
|
*/
|
|
6811
|
-
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
6877
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6812
6878
|
/**
|
|
6813
6879
|
* Returns the stored collision setup.
|
|
6814
6880
|
* @summary Get Collision Setup
|
|
@@ -6817,7 +6883,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6817
6883
|
* @param {*} [options] Override http request option.
|
|
6818
6884
|
* @throws {RequiredError}
|
|
6819
6885
|
*/
|
|
6820
|
-
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
6886
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
6821
6887
|
/**
|
|
6822
6888
|
* Returns a list of stored collision setups.
|
|
6823
6889
|
* @summary List Collision Setups
|
|
@@ -6825,7 +6891,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6825
6891
|
* @param {*} [options] Override http request option.
|
|
6826
6892
|
* @throws {RequiredError}
|
|
6827
6893
|
*/
|
|
6828
|
-
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6894
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6829
6895
|
[key: string]: CollisionSetup;
|
|
6830
6896
|
}, any>>;
|
|
6831
6897
|
/**
|
|
@@ -6835,7 +6901,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6835
6901
|
* @param {*} [options] Override http request option.
|
|
6836
6902
|
* @throws {RequiredError}
|
|
6837
6903
|
*/
|
|
6838
|
-
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6904
|
+
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6839
6905
|
/**
|
|
6840
6906
|
* Stores collision setup. - If the collision setup does not exist, it will be created. - If the collision setup exists, it will be updated.
|
|
6841
6907
|
* @summary Store Collision Setup
|
|
@@ -6845,7 +6911,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6845
6911
|
* @param {*} [options] Override http request option.
|
|
6846
6912
|
* @throws {RequiredError}
|
|
6847
6913
|
*/
|
|
6848
|
-
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<
|
|
6914
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
6849
6915
|
}
|
|
6850
6916
|
/**
|
|
6851
6917
|
* StoreObjectApi - axios parameter creator
|
|
@@ -7041,7 +7107,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7041
7107
|
* @param {*} [options] Override http request option.
|
|
7042
7108
|
* @throws {RequiredError}
|
|
7043
7109
|
*/
|
|
7044
|
-
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7110
|
+
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7045
7111
|
/**
|
|
7046
7112
|
* Delete an object <!-- theme: danger --> > This will delete persistently stored data.
|
|
7047
7113
|
* @summary Delete Object
|
|
@@ -7050,7 +7116,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7050
7116
|
* @param {*} [options] Override http request option.
|
|
7051
7117
|
* @throws {RequiredError}
|
|
7052
7118
|
*/
|
|
7053
|
-
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7119
|
+
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7054
7120
|
/**
|
|
7055
7121
|
* Returns content and metadata of a stored object.
|
|
7056
7122
|
* @summary Get Object
|
|
@@ -7059,7 +7125,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7059
7125
|
* @param {*} [options] Override http request option.
|
|
7060
7126
|
* @throws {RequiredError}
|
|
7061
7127
|
*/
|
|
7062
|
-
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7128
|
+
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7063
7129
|
/**
|
|
7064
7130
|
* Returns metadata. Object content is not returned.
|
|
7065
7131
|
* @summary Get Object Metadata
|
|
@@ -7068,7 +7134,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7068
7134
|
* @param {*} [options] Override http request option.
|
|
7069
7135
|
* @throws {RequiredError}
|
|
7070
7136
|
*/
|
|
7071
|
-
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7137
|
+
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7072
7138
|
/**
|
|
7073
7139
|
* List the keys for all objects.
|
|
7074
7140
|
* @summary List all Object Keys
|
|
@@ -7076,7 +7142,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7076
7142
|
* @param {*} [options] Override http request option.
|
|
7077
7143
|
* @throws {RequiredError}
|
|
7078
7144
|
*/
|
|
7079
|
-
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7145
|
+
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
7080
7146
|
/**
|
|
7081
7147
|
* 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.
|
|
7082
7148
|
* @summary Store Object
|
|
@@ -7089,7 +7155,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7089
7155
|
*/
|
|
7090
7156
|
storeObject(cell: string, key: string, xMetadata?: {
|
|
7091
7157
|
[key: string]: string;
|
|
7092
|
-
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<
|
|
7158
|
+
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7093
7159
|
}
|
|
7094
7160
|
/**
|
|
7095
7161
|
* SystemApi - axios parameter creator
|
|
@@ -7114,6 +7180,16 @@ declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
7114
7180
|
* @throws {RequiredError}
|
|
7115
7181
|
*/
|
|
7116
7182
|
checkNovaVersionUpdate: (channel: ReleaseChannel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7183
|
+
/**
|
|
7184
|
+
* <!-- theme: danger --> > **Experimental** Performs an address resolution protocol (ARP) scan on the specified interface/classless inter-domain routing (CIDR) and returns all discovered devices on the network by CIDR notation.
|
|
7185
|
+
* @summary Get ARP-Scan
|
|
7186
|
+
* @param {string} [_interface]
|
|
7187
|
+
* @param {string} [cidr]
|
|
7188
|
+
* @param {number} [timeout]
|
|
7189
|
+
* @param {*} [options] Override http request option.
|
|
7190
|
+
* @throws {RequiredError}
|
|
7191
|
+
*/
|
|
7192
|
+
getArpScan: (_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7117
7193
|
/**
|
|
7118
7194
|
* 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.
|
|
7119
7195
|
* @summary Retrieve Backup Status
|
|
@@ -7129,6 +7205,20 @@ declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
7129
7205
|
* @throws {RequiredError}
|
|
7130
7206
|
*/
|
|
7131
7207
|
getDiagnosePackage: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7208
|
+
/**
|
|
7209
|
+
* <!-- theme: danger --> > **Experimental** Get the network interfaces of the system.
|
|
7210
|
+
* @summary Network Interfaces
|
|
7211
|
+
* @param {*} [options] Override http request option.
|
|
7212
|
+
* @throws {RequiredError}
|
|
7213
|
+
*/
|
|
7214
|
+
getNetworkInterfaces: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7215
|
+
/**
|
|
7216
|
+
* <!-- theme: danger --> > **Experimental** Get the current state of the network.
|
|
7217
|
+
* @summary Network State
|
|
7218
|
+
* @param {*} [options] Override http request option.
|
|
7219
|
+
* @throws {RequiredError}
|
|
7220
|
+
*/
|
|
7221
|
+
getNetworkState: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7132
7222
|
/**
|
|
7133
7223
|
* Get the status of all system services.
|
|
7134
7224
|
* @summary Wandelbots NOVA status
|
|
@@ -7191,6 +7281,16 @@ declare const SystemApiFp: (configuration?: Configuration) => {
|
|
|
7191
7281
|
* @throws {RequiredError}
|
|
7192
7282
|
*/
|
|
7193
7283
|
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
7284
|
+
/**
|
|
7285
|
+
* <!-- theme: danger --> > **Experimental** Performs an address resolution protocol (ARP) scan on the specified interface/classless inter-domain routing (CIDR) and returns all discovered devices on the network by CIDR notation.
|
|
7286
|
+
* @summary Get ARP-Scan
|
|
7287
|
+
* @param {string} [_interface]
|
|
7288
|
+
* @param {string} [cidr]
|
|
7289
|
+
* @param {number} [timeout]
|
|
7290
|
+
* @param {*} [options] Override http request option.
|
|
7291
|
+
* @throws {RequiredError}
|
|
7292
|
+
*/
|
|
7293
|
+
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<NetworkDevice>>>;
|
|
7194
7294
|
/**
|
|
7195
7295
|
* 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.
|
|
7196
7296
|
* @summary Retrieve Backup Status
|
|
@@ -7206,6 +7306,20 @@ declare const SystemApiFp: (configuration?: Configuration) => {
|
|
|
7206
7306
|
* @throws {RequiredError}
|
|
7207
7307
|
*/
|
|
7208
7308
|
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
7309
|
+
/**
|
|
7310
|
+
* <!-- theme: danger --> > **Experimental** Get the network interfaces of the system.
|
|
7311
|
+
* @summary Network Interfaces
|
|
7312
|
+
* @param {*} [options] Override http request option.
|
|
7313
|
+
* @throws {RequiredError}
|
|
7314
|
+
*/
|
|
7315
|
+
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<NetworkInterface>>>;
|
|
7316
|
+
/**
|
|
7317
|
+
* <!-- theme: danger --> > **Experimental** Get the current state of the network.
|
|
7318
|
+
* @summary Network State
|
|
7319
|
+
* @param {*} [options] Override http request option.
|
|
7320
|
+
* @throws {RequiredError}
|
|
7321
|
+
*/
|
|
7322
|
+
getNetworkState(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetworkState>>;
|
|
7209
7323
|
/**
|
|
7210
7324
|
* Get the status of all system services.
|
|
7211
7325
|
* @summary Wandelbots NOVA status
|
|
@@ -7268,6 +7382,16 @@ declare const SystemApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
7268
7382
|
* @throws {RequiredError}
|
|
7269
7383
|
*/
|
|
7270
7384
|
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
7385
|
+
/**
|
|
7386
|
+
* <!-- theme: danger --> > **Experimental** Performs an address resolution protocol (ARP) scan on the specified interface/classless inter-domain routing (CIDR) and returns all discovered devices on the network by CIDR notation.
|
|
7387
|
+
* @summary Get ARP-Scan
|
|
7388
|
+
* @param {string} [_interface]
|
|
7389
|
+
* @param {string} [cidr]
|
|
7390
|
+
* @param {number} [timeout]
|
|
7391
|
+
* @param {*} [options] Override http request option.
|
|
7392
|
+
* @throws {RequiredError}
|
|
7393
|
+
*/
|
|
7394
|
+
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<NetworkDevice>>;
|
|
7271
7395
|
/**
|
|
7272
7396
|
* 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.
|
|
7273
7397
|
* @summary Retrieve Backup Status
|
|
@@ -7283,6 +7407,20 @@ declare const SystemApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
7283
7407
|
* @throws {RequiredError}
|
|
7284
7408
|
*/
|
|
7285
7409
|
getDiagnosePackage(options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
7410
|
+
/**
|
|
7411
|
+
* <!-- theme: danger --> > **Experimental** Get the network interfaces of the system.
|
|
7412
|
+
* @summary Network Interfaces
|
|
7413
|
+
* @param {*} [options] Override http request option.
|
|
7414
|
+
* @throws {RequiredError}
|
|
7415
|
+
*/
|
|
7416
|
+
getNetworkInterfaces(options?: RawAxiosRequestConfig): AxiosPromise<Array<NetworkInterface>>;
|
|
7417
|
+
/**
|
|
7418
|
+
* <!-- theme: danger --> > **Experimental** Get the current state of the network.
|
|
7419
|
+
* @summary Network State
|
|
7420
|
+
* @param {*} [options] Override http request option.
|
|
7421
|
+
* @throws {RequiredError}
|
|
7422
|
+
*/
|
|
7423
|
+
getNetworkState(options?: RawAxiosRequestConfig): AxiosPromise<NetworkState>;
|
|
7286
7424
|
/**
|
|
7287
7425
|
* Get the status of all system services.
|
|
7288
7426
|
* @summary Wandelbots NOVA status
|
|
@@ -7336,7 +7474,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7336
7474
|
*/
|
|
7337
7475
|
backupConfiguration(resources?: Array<string>, metadata?: {
|
|
7338
7476
|
[key: string]: string;
|
|
7339
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
7477
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7340
7478
|
/**
|
|
7341
7479
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
7342
7480
|
* @summary Check update
|
|
@@ -7344,7 +7482,17 @@ declare class SystemApi extends BaseAPI {
|
|
|
7344
7482
|
* @param {*} [options] Override http request option.
|
|
7345
7483
|
* @throws {RequiredError}
|
|
7346
7484
|
*/
|
|
7347
|
-
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
7485
|
+
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
7486
|
+
/**
|
|
7487
|
+
* <!-- theme: danger --> > **Experimental** Performs an address resolution protocol (ARP) scan on the specified interface/classless inter-domain routing (CIDR) and returns all discovered devices on the network by CIDR notation.
|
|
7488
|
+
* @summary Get ARP-Scan
|
|
7489
|
+
* @param {string} [_interface]
|
|
7490
|
+
* @param {string} [cidr]
|
|
7491
|
+
* @param {number} [timeout]
|
|
7492
|
+
* @param {*} [options] Override http request option.
|
|
7493
|
+
* @throws {RequiredError}
|
|
7494
|
+
*/
|
|
7495
|
+
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<NetworkDevice[], any>>;
|
|
7348
7496
|
/**
|
|
7349
7497
|
* 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.
|
|
7350
7498
|
* @summary Retrieve Backup Status
|
|
@@ -7352,35 +7500,49 @@ declare class SystemApi extends BaseAPI {
|
|
|
7352
7500
|
* @param {*} [options] Override http request option.
|
|
7353
7501
|
* @throws {RequiredError}
|
|
7354
7502
|
*/
|
|
7355
|
-
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
7503
|
+
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationArchiveStatus, any>>;
|
|
7356
7504
|
/**
|
|
7357
7505
|
* 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.
|
|
7358
7506
|
* @summary Download Diagnosis Package
|
|
7359
7507
|
* @param {*} [options] Override http request option.
|
|
7360
7508
|
* @throws {RequiredError}
|
|
7361
7509
|
*/
|
|
7362
|
-
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<
|
|
7510
|
+
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7511
|
+
/**
|
|
7512
|
+
* <!-- theme: danger --> > **Experimental** Get the network interfaces of the system.
|
|
7513
|
+
* @summary Network Interfaces
|
|
7514
|
+
* @param {*} [options] Override http request option.
|
|
7515
|
+
* @throws {RequiredError}
|
|
7516
|
+
*/
|
|
7517
|
+
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<NetworkInterface[], any>>;
|
|
7518
|
+
/**
|
|
7519
|
+
* <!-- theme: danger --> > **Experimental** Get the current state of the network.
|
|
7520
|
+
* @summary Network State
|
|
7521
|
+
* @param {*} [options] Override http request option.
|
|
7522
|
+
* @throws {RequiredError}
|
|
7523
|
+
*/
|
|
7524
|
+
getNetworkState(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<NetworkState, any>>;
|
|
7363
7525
|
/**
|
|
7364
7526
|
* Get the status of all system services.
|
|
7365
7527
|
* @summary Wandelbots NOVA status
|
|
7366
7528
|
* @param {*} [options] Override http request option.
|
|
7367
7529
|
* @throws {RequiredError}
|
|
7368
7530
|
*/
|
|
7369
|
-
getSystemStatus(options?: RawAxiosRequestConfig): Promise<
|
|
7531
|
+
getSystemStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatus[], any>>;
|
|
7370
7532
|
/**
|
|
7371
7533
|
* Get the current Wandelbots NOVA version.
|
|
7372
7534
|
* @summary Wandelbots NOVA Version
|
|
7373
7535
|
* @param {*} [options] Override http request option.
|
|
7374
7536
|
* @throws {RequiredError}
|
|
7375
7537
|
*/
|
|
7376
|
-
getSystemVersion(options?: RawAxiosRequestConfig): Promise<
|
|
7538
|
+
getSystemVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
7377
7539
|
/**
|
|
7378
7540
|
* Retrieves a list of all available configuration resources for backup purposes.
|
|
7379
7541
|
* @summary List Configuration Resources
|
|
7380
7542
|
* @param {*} [options] Override http request option.
|
|
7381
7543
|
* @throws {RequiredError}
|
|
7382
7544
|
*/
|
|
7383
|
-
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<
|
|
7545
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationResource[], any>>;
|
|
7384
7546
|
/**
|
|
7385
7547
|
* Restores a previously backed up configuration.
|
|
7386
7548
|
* @summary Restore Configuration Backup
|
|
@@ -7389,7 +7551,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7389
7551
|
* @param {*} [options] Override http request option.
|
|
7390
7552
|
* @throws {RequiredError}
|
|
7391
7553
|
*/
|
|
7392
|
-
restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<
|
|
7554
|
+
restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7393
7555
|
/**
|
|
7394
7556
|
* 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.
|
|
7395
7557
|
* @summary Update Wandelbots NOVA version
|
|
@@ -7397,7 +7559,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7397
7559
|
* @param {*} [options] Override http request option.
|
|
7398
7560
|
* @throws {RequiredError}
|
|
7399
7561
|
*/
|
|
7400
|
-
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7562
|
+
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7401
7563
|
}
|
|
7402
7564
|
/**
|
|
7403
7565
|
* TrajectoryCachingApi - axios parameter creator
|
|
@@ -7571,7 +7733,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7571
7733
|
* @param {*} [options] Override http request option.
|
|
7572
7734
|
* @throws {RequiredError}
|
|
7573
7735
|
*/
|
|
7574
|
-
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7736
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<AddTrajectoryResponse, any>>;
|
|
7575
7737
|
/**
|
|
7576
7738
|
* Clear the trajectory cache.
|
|
7577
7739
|
* @summary Clear Trajectories
|
|
@@ -7580,7 +7742,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7580
7742
|
* @param {*} [options] Override http request option.
|
|
7581
7743
|
* @throws {RequiredError}
|
|
7582
7744
|
*/
|
|
7583
|
-
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7745
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7584
7746
|
/**
|
|
7585
7747
|
* 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.
|
|
7586
7748
|
* @summary Delete Trajectory
|
|
@@ -7590,7 +7752,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7590
7752
|
* @param {*} [options] Override http request option.
|
|
7591
7753
|
* @throws {RequiredError}
|
|
7592
7754
|
*/
|
|
7593
|
-
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
7755
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7594
7756
|
/**
|
|
7595
7757
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7596
7758
|
* @summary Get Trajectory
|
|
@@ -7600,7 +7762,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7600
7762
|
* @param {*} [options] Override http request option.
|
|
7601
7763
|
* @throws {RequiredError}
|
|
7602
7764
|
*/
|
|
7603
|
-
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
7765
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
|
|
7604
7766
|
/**
|
|
7605
7767
|
* 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.
|
|
7606
7768
|
* @summary List Trajectories
|
|
@@ -7609,7 +7771,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7609
7771
|
* @param {*} [options] Override http request option.
|
|
7610
7772
|
* @throws {RequiredError}
|
|
7611
7773
|
*/
|
|
7612
|
-
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7774
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListTrajectoriesResponse, any>>;
|
|
7613
7775
|
}
|
|
7614
7776
|
/**
|
|
7615
7777
|
* TrajectoryExecutionApi - axios parameter creator
|
|
@@ -7669,7 +7831,7 @@ declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
7669
7831
|
* @param {*} [options] Override http request option.
|
|
7670
7832
|
* @throws {RequiredError}
|
|
7671
7833
|
*/
|
|
7672
|
-
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7834
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
7673
7835
|
}
|
|
7674
7836
|
/**
|
|
7675
7837
|
* TrajectoryPlanningApi - axios parameter creator
|
|
@@ -7752,7 +7914,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
7752
7914
|
* @param {*} [options] Override http request option.
|
|
7753
7915
|
* @throws {RequiredError}
|
|
7754
7916
|
*/
|
|
7755
|
-
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7917
|
+
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
|
|
7756
7918
|
/**
|
|
7757
7919
|
* 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.
|
|
7758
7920
|
* @summary Plan Trajectory
|
|
@@ -7761,7 +7923,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
7761
7923
|
* @param {*} [options] Override http request option.
|
|
7762
7924
|
* @throws {RequiredError}
|
|
7763
7925
|
*/
|
|
7764
|
-
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7926
|
+
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
7765
7927
|
}
|
|
7766
7928
|
/**
|
|
7767
7929
|
* VersionApi - axios parameter creator
|
|
@@ -7809,7 +7971,7 @@ declare class VersionApi extends BaseAPI {
|
|
|
7809
7971
|
* @param {*} [options] Override http request option.
|
|
7810
7972
|
* @throws {RequiredError}
|
|
7811
7973
|
*/
|
|
7812
|
-
getApiVersion(options?: RawAxiosRequestConfig): Promise<
|
|
7974
|
+
getApiVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ApiVersion, any>>;
|
|
7813
7975
|
}
|
|
7814
7976
|
/**
|
|
7815
7977
|
* VirtualControllerApi - axios parameter creator
|
|
@@ -8299,7 +8461,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8299
8461
|
* @param {*} [options] Override http request option.
|
|
8300
8462
|
* @throws {RequiredError}
|
|
8301
8463
|
*/
|
|
8302
|
-
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<
|
|
8464
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8303
8465
|
/**
|
|
8304
8466
|
* 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.
|
|
8305
8467
|
* @summary Add TCP
|
|
@@ -8311,7 +8473,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8311
8473
|
* @param {*} [options] Override http request option.
|
|
8312
8474
|
* @throws {RequiredError}
|
|
8313
8475
|
*/
|
|
8314
|
-
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<
|
|
8476
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8315
8477
|
/**
|
|
8316
8478
|
* 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.
|
|
8317
8479
|
* @summary Delete Coordinate System
|
|
@@ -8322,7 +8484,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8322
8484
|
* @param {*} [options] Override http request option.
|
|
8323
8485
|
* @throws {RequiredError}
|
|
8324
8486
|
*/
|
|
8325
|
-
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
8487
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8326
8488
|
/**
|
|
8327
8489
|
* 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.
|
|
8328
8490
|
* @summary Remove TCP
|
|
@@ -8333,7 +8495,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8333
8495
|
* @param {*} [options] Override http request option.
|
|
8334
8496
|
* @throws {RequiredError}
|
|
8335
8497
|
*/
|
|
8336
|
-
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<
|
|
8498
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8337
8499
|
/**
|
|
8338
8500
|
* 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.
|
|
8339
8501
|
* @summary Get Emergency Stop State
|
|
@@ -8342,7 +8504,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8342
8504
|
* @param {*} [options] Override http request option.
|
|
8343
8505
|
* @throws {RequiredError}
|
|
8344
8506
|
*/
|
|
8345
|
-
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8507
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Flag, any>>;
|
|
8346
8508
|
/**
|
|
8347
8509
|
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8348
8510
|
* @summary Get Motion Group State
|
|
@@ -8352,7 +8514,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8352
8514
|
* @param {*} [options] Override http request option.
|
|
8353
8515
|
* @throws {RequiredError}
|
|
8354
8516
|
*/
|
|
8355
|
-
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8517
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupJoints, any>>;
|
|
8356
8518
|
/**
|
|
8357
8519
|
* Gets information on the motion group.
|
|
8358
8520
|
* @summary Motion Group Description
|
|
@@ -8361,7 +8523,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8361
8523
|
* @param {*} [options] Override http request option.
|
|
8362
8524
|
* @throws {RequiredError}
|
|
8363
8525
|
*/
|
|
8364
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8526
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfo[], any>>;
|
|
8365
8527
|
/**
|
|
8366
8528
|
* 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.
|
|
8367
8529
|
* @summary Get Operation Mode
|
|
@@ -8370,7 +8532,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8370
8532
|
* @param {*} [options] Override http request option.
|
|
8371
8533
|
* @throws {RequiredError}
|
|
8372
8534
|
*/
|
|
8373
|
-
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8535
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<OpMode, any>>;
|
|
8374
8536
|
/**
|
|
8375
8537
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8376
8538
|
* @summary Get Mounting
|
|
@@ -8380,7 +8542,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8380
8542
|
* @param {*} [options] Override http request option.
|
|
8381
8543
|
* @throws {RequiredError}
|
|
8382
8544
|
*/
|
|
8383
|
-
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8545
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
8384
8546
|
/**
|
|
8385
8547
|
* Lists all coordinate systems on the robot controller.
|
|
8386
8548
|
* @summary List Coordinate Systems
|
|
@@ -8389,7 +8551,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8389
8551
|
* @param {*} [options] Override http request option.
|
|
8390
8552
|
* @throws {RequiredError}
|
|
8391
8553
|
*/
|
|
8392
|
-
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8554
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
8393
8555
|
/**
|
|
8394
8556
|
* Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
|
|
8395
8557
|
* @summary List TCPs
|
|
@@ -8399,7 +8561,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8399
8561
|
* @param {*} [options] Override http request option.
|
|
8400
8562
|
* @throws {RequiredError}
|
|
8401
8563
|
*/
|
|
8402
|
-
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8564
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp[], any>>;
|
|
8403
8565
|
/**
|
|
8404
8566
|
* 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.
|
|
8405
8567
|
* @summary Push or Release Emergency Stop
|
|
@@ -8409,7 +8571,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8409
8571
|
* @param {*} [options] Override http request option.
|
|
8410
8572
|
* @throws {RequiredError}
|
|
8411
8573
|
*/
|
|
8412
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
8574
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8413
8575
|
/**
|
|
8414
8576
|
* 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.
|
|
8415
8577
|
* @summary Set Motion Group State
|
|
@@ -8420,7 +8582,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8420
8582
|
* @param {*} [options] Override http request option.
|
|
8421
8583
|
* @throws {RequiredError}
|
|
8422
8584
|
*/
|
|
8423
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<
|
|
8585
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8424
8586
|
/**
|
|
8425
8587
|
* 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.
|
|
8426
8588
|
* @summary Set Operation Mode
|
|
@@ -8430,7 +8592,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8430
8592
|
* @param {*} [options] Override http request option.
|
|
8431
8593
|
* @throws {RequiredError}
|
|
8432
8594
|
*/
|
|
8433
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<
|
|
8595
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8434
8596
|
/**
|
|
8435
8597
|
* 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.
|
|
8436
8598
|
* @summary Set Mounting
|
|
@@ -8441,7 +8603,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8441
8603
|
* @param {*} [options] Override http request option.
|
|
8442
8604
|
* @throws {RequiredError}
|
|
8443
8605
|
*/
|
|
8444
|
-
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
8606
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
8445
8607
|
}
|
|
8446
8608
|
/**
|
|
8447
8609
|
* VirtualControllerBehaviorApi - axios parameter creator
|
|
@@ -8585,7 +8747,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8585
8747
|
* @param {*} [options] Override http request option.
|
|
8586
8748
|
* @throws {RequiredError}
|
|
8587
8749
|
*/
|
|
8588
|
-
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8750
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExternalJointStreamDatapoint[], any>>;
|
|
8589
8751
|
/**
|
|
8590
8752
|
* Get the cycle time of controller communication in [ms].
|
|
8591
8753
|
* @summary Get Cycle Time
|
|
@@ -8594,7 +8756,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8594
8756
|
* @param {*} [options] Override http request option.
|
|
8595
8757
|
* @throws {RequiredError}
|
|
8596
8758
|
*/
|
|
8597
|
-
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8759
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
|
|
8598
8760
|
/**
|
|
8599
8761
|
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
8600
8762
|
* @summary Get Behavior
|
|
@@ -8603,7 +8765,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8603
8765
|
* @param {*} [options] Override http request option.
|
|
8604
8766
|
* @throws {RequiredError}
|
|
8605
8767
|
*/
|
|
8606
|
-
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8768
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Behavior, any>>;
|
|
8607
8769
|
/**
|
|
8608
8770
|
* Set virtual controller behavior. See query parameters for details.
|
|
8609
8771
|
* @summary Set Behavior
|
|
@@ -8613,7 +8775,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8613
8775
|
* @param {*} [options] Override http request option.
|
|
8614
8776
|
* @throws {RequiredError}
|
|
8615
8777
|
*/
|
|
8616
|
-
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<
|
|
8778
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8617
8779
|
}
|
|
8618
8780
|
/**
|
|
8619
8781
|
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
@@ -8742,7 +8904,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
8742
8904
|
* @param {*} [options] Override http request option.
|
|
8743
8905
|
* @throws {RequiredError}
|
|
8744
8906
|
*/
|
|
8745
|
-
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
8907
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
8746
8908
|
/**
|
|
8747
8909
|
* 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.
|
|
8748
8910
|
* @summary List Descriptions
|
|
@@ -8755,7 +8917,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
8755
8917
|
* @param {*} [options] Override http request option.
|
|
8756
8918
|
* @throws {RequiredError}
|
|
8757
8919
|
*/
|
|
8758
|
-
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
8920
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
8759
8921
|
/**
|
|
8760
8922
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
8761
8923
|
* @summary Set Input/Ouput Values
|
|
@@ -8765,7 +8927,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
8765
8927
|
* @param {*} [options] Override http request option.
|
|
8766
8928
|
* @throws {RequiredError}
|
|
8767
8929
|
*/
|
|
8768
|
-
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
8930
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8769
8931
|
}
|
|
8770
8932
|
//#endregion
|
|
8771
|
-
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, BlendingSpace, BooleanValue, BooleanValueValueTypeEnum, Box, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIODescription, BusIOModbusClient, BusIOModbusClientBusTypeEnum, BusIOModbusServer, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClient, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServer, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtual, BusIOModbusVirtualBusTypeEnum, BusIOProfinet, BusIOProfinetBusTypeEnum, BusIOProfinetDefaultRoute, BusIOProfinetIpConfig, BusIOProfinetNetwork, BusIOProfinetVirtual, BusIOProfinetVirtualBusTypeEnum, BusIOType, BusIOsState, BusIOsStateEnum, COLLECTION_FORMATS, Capsule, CapsuleShapeTypeEnum, CartesianLimits, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Collider, ColliderShape, Collision, CollisionContact, CollisionError, 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, KinematicModel, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaController, KukaControllerKindEnum, KukaControllerRsiServer, License, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatus, LicenseStatusEnum, LimitRange, LimitSet, LimitsOverride, ListTrajectoriesResponse, Manufacturer, MidpointInsertionAlgorithm, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIO, ModbusIOArea, ModbusIOByteOrder, ModbusIOData, ModbusIOTypeEnum, ModelError, MotionCommand, MotionCommandBlending, MotionCommandPath, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupDescription, 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, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotController, RobotControllerConfiguration, RobotControllerState, RobotSystemMode, RobotTcp, RobotTcpData, SafetyStateType, ServiceGroup, ServiceStatus, ServiceStatusPhase, ServiceStatusResponse, ServiceStatusSeverity, ServiceStatusStatus, SetIO, SettableRobotSystemMode, SingularityTypeEnum, Sphere, SphereShapeTypeEnum, StartMovementRequest, StartMovementRequestMessageTypeEnum, StartMovementResponse, StartMovementResponseKindEnum, StartOnIO, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, StreamIOValuesResponse, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpOffset, TcpRequiredError, 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, VirtualRobotConfiguration, WaitForIOEventRequest, YaskawaController, YaskawaControllerKindEnum, operationServerMap };
|
|
8933
|
+
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, BlendingSpace, BooleanValue, BooleanValueValueTypeEnum, Box, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIODescription, BusIOModbusClient, BusIOModbusClientBusTypeEnum, BusIOModbusServer, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClient, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServer, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtual, BusIOModbusVirtualBusTypeEnum, BusIOProfinet, BusIOProfinetBusTypeEnum, BusIOProfinetDefaultRoute, BusIOProfinetIpConfig, BusIOProfinetNetwork, BusIOProfinetVirtual, BusIOProfinetVirtualBusTypeEnum, BusIOType, BusIOsState, BusIOsStateEnum, COLLECTION_FORMATS, Capsule, CapsuleShapeTypeEnum, CartesianLimits, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Collider, ColliderShape, Collision, CollisionContact, CollisionError, 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, KinematicModel, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaController, KukaControllerKindEnum, KukaControllerRsiServer, License, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatus, LicenseStatusEnum, LimitRange, LimitSet, LimitsOverride, ListTrajectoriesResponse, Manufacturer, MidpointInsertionAlgorithm, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIO, ModbusIOArea, ModbusIOByteOrder, ModbusIOData, ModbusIOTypeEnum, ModelError, MotionCommand, MotionCommandBlending, MotionCommandPath, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupDescription, MotionGroupInfo, MotionGroupJoints, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MotionGroupSetup, MotionGroupState, MotionGroupStateJointLimitReached, MovementErrorResponse, MovementErrorResponseKindEnum, NanValueError, NanValueErrorNanValue, NetworkDevice, NetworkInterface, NetworkState, NetworkStateConnectionTypeEnum, OpMode, OperatingState, OperationLimits, OperationMode, OrientationType, PathCartesianPTP, PathCartesianPTPPathDefinitionNameEnum, PathCircle, PathCirclePathDefinitionNameEnum, PathCubicSpline, PathCubicSplinePathDefinitionNameEnum, PathJointPTP, PathJointPTPPathDefinitionNameEnum, PathLine, PathLinePathDefinitionNameEnum, PauseJoggingRequest, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponse, PauseJoggingResponseKindEnum, PauseMovementRequest, PauseMovementRequestMessageTypeEnum, PauseMovementResponse, PauseMovementResponseKindEnum, PauseOnIO, Payload, Plan422Response, PlanCollisionFreeFailedResponse, PlanCollisionFreeRequest, PlanCollisionFreeResponse, PlanCollisionFreeResponseResponse, PlanTrajectoryFailedResponse, PlanTrajectoryFailedResponseErrorFeedback, PlanTrajectoryRequest, PlanTrajectoryResponse, PlanTrajectoryResponseResponse, PlanValidationError, PlanValidationErrorAllOfData, Plane, PlaneShapeTypeEnum, PlaybackSpeedRequest, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponse, PlaybackSpeedResponseKindEnum, Pose, ProfinetDescription, ProfinetIO, ProfinetIOData, ProfinetIODirection, ProfinetIOTypeEnum, ProfinetInputOutputConfig, ProfinetSlotDescription, ProfinetSubSlotDescription, Program, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRun, ProgramRunState, ProgramStartRequest, RRTConnectAlgorithm, RRTConnectAlgorithmAlgorithmNameEnum, Rectangle, RectangleShapeTypeEnum, RectangularCapsule, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequestArgs, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotController, RobotControllerConfiguration, RobotControllerState, RobotSystemMode, RobotTcp, RobotTcpData, SafetyStateType, ServiceGroup, ServiceStatus, ServiceStatusPhase, ServiceStatusResponse, ServiceStatusSeverity, ServiceStatusStatus, SetIO, SettableRobotSystemMode, SingularityTypeEnum, Sphere, SphereShapeTypeEnum, StartMovementRequest, StartMovementRequestMessageTypeEnum, StartMovementResponse, StartMovementResponseKindEnum, StartOnIO, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, StreamIOValuesResponse, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpOffset, TcpRequiredError, 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, VirtualRobotConfiguration, WaitForIOEventRequest, YaskawaController, YaskawaControllerKindEnum, operationServerMap };
|