@wandelbots/nova-api 26.1.0-rc.2 → 26.2.0-dev.10
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/v2/index.cjs +6 -1
- package/dist/v2/index.d.cts +151 -146
- package/dist/v2/index.d.ts +11 -6
- package/dist/v2/index.js +6 -1
- package/package.json +1 -1
package/dist/v2/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as axios176 from "axios";
|
|
2
2
|
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
3
|
|
|
4
4
|
//#region v2/configuration.d.ts
|
|
@@ -7,7 +7,7 @@ import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
|
7
7
|
* Wandelbots NOVA API
|
|
8
8
|
* Interact with robots in an easy and intuitive way.
|
|
9
9
|
*
|
|
10
|
-
* The version of the OpenAPI document: 2.
|
|
10
|
+
* The version of the OpenAPI document: 2.2.0 dev
|
|
11
11
|
*
|
|
12
12
|
*
|
|
13
13
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -164,7 +164,7 @@ interface ActivateLicenseRequest {
|
|
|
164
164
|
interface AddTrajectoryError {
|
|
165
165
|
'message'?: string;
|
|
166
166
|
/**
|
|
167
|
-
*
|
|
167
|
+
* - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
168
168
|
*/
|
|
169
169
|
'location'?: number;
|
|
170
170
|
'data'?: AddTrajectoryErrorData;
|
|
@@ -1343,7 +1343,7 @@ interface InitializeMovementRequest {
|
|
|
1343
1343
|
'message_type': InitializeMovementRequestMessageTypeEnum;
|
|
1344
1344
|
'trajectory': InitializeMovementRequestTrajectory;
|
|
1345
1345
|
/**
|
|
1346
|
-
*
|
|
1346
|
+
* - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
1347
1347
|
*/
|
|
1348
1348
|
'initial_location'?: number;
|
|
1349
1349
|
/**
|
|
@@ -2349,7 +2349,7 @@ type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFail
|
|
|
2349
2349
|
interface PlanTrajectoryFailedResponse {
|
|
2350
2350
|
'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
|
|
2351
2351
|
/**
|
|
2352
|
-
*
|
|
2352
|
+
* - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
2353
2353
|
*/
|
|
2354
2354
|
'error_location_on_trajectory': number;
|
|
2355
2355
|
/**
|
|
@@ -2911,9 +2911,14 @@ interface SetIO {
|
|
|
2911
2911
|
'location': number;
|
|
2912
2912
|
'io_origin': IOOrigin;
|
|
2913
2913
|
}
|
|
2914
|
+
/**
|
|
2915
|
+
* Defines available system modes of the robot system. Short versions (no \"ROBOT_SYSTEM_\" prefix) are provided, reusing strings from [getMode](getMode) responses.
|
|
2916
|
+
*/
|
|
2914
2917
|
declare const SettableRobotSystemMode: {
|
|
2915
2918
|
readonly RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR";
|
|
2919
|
+
readonly ModeMonitor: "MODE_MONITOR";
|
|
2916
2920
|
readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
|
|
2921
|
+
readonly ModeControl: "MODE_CONTROL";
|
|
2917
2922
|
};
|
|
2918
2923
|
type SettableRobotSystemMode = typeof SettableRobotSystemMode[keyof typeof SettableRobotSystemMode];
|
|
2919
2924
|
declare const SingularityTypeEnum: {
|
|
@@ -2946,7 +2951,7 @@ interface StartMovementRequest {
|
|
|
2946
2951
|
'message_type': StartMovementRequestMessageTypeEnum;
|
|
2947
2952
|
'direction'?: Direction;
|
|
2948
2953
|
/**
|
|
2949
|
-
*
|
|
2954
|
+
* - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
2950
2955
|
*/
|
|
2951
2956
|
'target_location'?: number;
|
|
2952
2957
|
/**
|
|
@@ -3101,7 +3106,7 @@ interface TrajectoryDetails {
|
|
|
3101
3106
|
*/
|
|
3102
3107
|
'trajectory': string;
|
|
3103
3108
|
/**
|
|
3104
|
-
*
|
|
3109
|
+
* - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
3105
3110
|
*/
|
|
3106
3111
|
'location': number;
|
|
3107
3112
|
'state': TrajectoryDetailsState;
|
|
@@ -3502,7 +3507,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3502
3507
|
* @param {*} [options] Override http request option.
|
|
3503
3508
|
* @throws {RequiredError}
|
|
3504
3509
|
*/
|
|
3505
|
-
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3510
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
3506
3511
|
/**
|
|
3507
3512
|
* Delete all GUI applications from the cell.
|
|
3508
3513
|
* @summary Clear Applications
|
|
@@ -3511,7 +3516,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3511
3516
|
* @param {*} [options] Override http request option.
|
|
3512
3517
|
* @throws {RequiredError}
|
|
3513
3518
|
*/
|
|
3514
|
-
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3519
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
3515
3520
|
/**
|
|
3516
3521
|
* Delete a GUI application from the cell.
|
|
3517
3522
|
* @summary Delete Application
|
|
@@ -3521,7 +3526,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3521
3526
|
* @param {*} [options] Override http request option.
|
|
3522
3527
|
* @throws {RequiredError}
|
|
3523
3528
|
*/
|
|
3524
|
-
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3529
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
3525
3530
|
/**
|
|
3526
3531
|
* 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).
|
|
3527
3532
|
* @summary Configuration
|
|
@@ -3530,7 +3535,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3530
3535
|
* @param {*} [options] Override http request option.
|
|
3531
3536
|
* @throws {RequiredError}
|
|
3532
3537
|
*/
|
|
3533
|
-
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<
|
|
3538
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<App, any>>;
|
|
3534
3539
|
/**
|
|
3535
3540
|
* 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.
|
|
3536
3541
|
* @summary List Applications
|
|
@@ -3538,7 +3543,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3538
3543
|
* @param {*} [options] Override http request option.
|
|
3539
3544
|
* @throws {RequiredError}
|
|
3540
3545
|
*/
|
|
3541
|
-
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
3546
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
3542
3547
|
/**
|
|
3543
3548
|
* Update the configuration of a GUI application in the cell.
|
|
3544
3549
|
* @summary Update Configuration
|
|
@@ -3549,7 +3554,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3549
3554
|
* @param {*} [options] Override http request option.
|
|
3550
3555
|
* @throws {RequiredError}
|
|
3551
3556
|
*/
|
|
3552
|
-
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3557
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
3553
3558
|
}
|
|
3554
3559
|
/**
|
|
3555
3560
|
* BUSInputsOutputsApi - axios parameter creator
|
|
@@ -4053,7 +4058,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4053
4058
|
* @param {*} [options] Override http request option.
|
|
4054
4059
|
* @throws {RequiredError}
|
|
4055
4060
|
*/
|
|
4056
|
-
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4061
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4057
4062
|
/**
|
|
4058
4063
|
* 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).
|
|
4059
4064
|
* @summary Add MODBUS Input/Output
|
|
@@ -4063,7 +4068,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4063
4068
|
* @param {*} [options] Override http request option.
|
|
4064
4069
|
* @throws {RequiredError}
|
|
4065
4070
|
*/
|
|
4066
|
-
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<
|
|
4071
|
+
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4067
4072
|
/**
|
|
4068
4073
|
* 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).
|
|
4069
4074
|
* @summary Add PROFINET Input/Output
|
|
@@ -4073,7 +4078,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4073
4078
|
* @param {*} [options] Override http request option.
|
|
4074
4079
|
* @throws {RequiredError}
|
|
4075
4080
|
*/
|
|
4076
|
-
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<
|
|
4081
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4077
4082
|
/**
|
|
4078
4083
|
* Remove the BUS inputs/outputs service from the cell.
|
|
4079
4084
|
* @summary Clear Service
|
|
@@ -4082,7 +4087,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4082
4087
|
* @param {*} [options] Override http request option.
|
|
4083
4088
|
* @throws {RequiredError}
|
|
4084
4089
|
*/
|
|
4085
|
-
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4090
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4086
4091
|
/**
|
|
4087
4092
|
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4088
4093
|
* @summary Remove all MODBUS Input/Outputs
|
|
@@ -4090,7 +4095,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4090
4095
|
* @param {*} [options] Override http request option.
|
|
4091
4096
|
* @throws {RequiredError}
|
|
4092
4097
|
*/
|
|
4093
|
-
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4098
|
+
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4094
4099
|
/**
|
|
4095
4100
|
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
4096
4101
|
* @summary Remove all PROFINET Input/Outputs
|
|
@@ -4098,7 +4103,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4098
4103
|
* @param {*} [options] Override http request option.
|
|
4099
4104
|
* @throws {RequiredError}
|
|
4100
4105
|
*/
|
|
4101
|
-
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4106
|
+
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4102
4107
|
/**
|
|
4103
4108
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4104
4109
|
* @summary Remove MODBUS Input/Ouptut
|
|
@@ -4107,7 +4112,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4107
4112
|
* @param {*} [options] Override http request option.
|
|
4108
4113
|
* @throws {RequiredError}
|
|
4109
4114
|
*/
|
|
4110
|
-
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
4115
|
+
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4111
4116
|
/**
|
|
4112
4117
|
* Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
4113
4118
|
* @summary Remove PROFINET Input/Ouptut
|
|
@@ -4116,7 +4121,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4116
4121
|
* @param {*} [options] Override http request option.
|
|
4117
4122
|
* @throws {RequiredError}
|
|
4118
4123
|
*/
|
|
4119
|
-
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
4124
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4120
4125
|
/**
|
|
4121
4126
|
* Get deployed BUS inputs/outputs service.
|
|
4122
4127
|
* @summary Get Service
|
|
@@ -4124,7 +4129,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4124
4129
|
* @param {*} [options] Override http request option.
|
|
4125
4130
|
* @throws {RequiredError}
|
|
4126
4131
|
*/
|
|
4127
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4132
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<BusIOType, any>>;
|
|
4128
4133
|
/**
|
|
4129
4134
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
4130
4135
|
* @summary State
|
|
@@ -4132,7 +4137,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4132
4137
|
* @param {*} [options] Override http request option.
|
|
4133
4138
|
* @throws {RequiredError}
|
|
4134
4139
|
*/
|
|
4135
|
-
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4140
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<BusIOsState, any>>;
|
|
4136
4141
|
/**
|
|
4137
4142
|
* 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).
|
|
4138
4143
|
* @summary Get Input/Output Values
|
|
@@ -4141,7 +4146,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4141
4146
|
* @param {*} [options] Override http request option.
|
|
4142
4147
|
* @throws {RequiredError}
|
|
4143
4148
|
*/
|
|
4144
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
4149
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<IOValue[], any>>;
|
|
4145
4150
|
/**
|
|
4146
4151
|
* Get description of NOVA as a PROFINET device.
|
|
4147
4152
|
* @summary Get PROFINET Description
|
|
@@ -4149,7 +4154,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4149
4154
|
* @param {*} [options] Override http request option.
|
|
4150
4155
|
* @throws {RequiredError}
|
|
4151
4156
|
*/
|
|
4152
|
-
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4157
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ProfinetDescription, any>>;
|
|
4153
4158
|
/**
|
|
4154
4159
|
* 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.
|
|
4155
4160
|
* @summary PROFINET Inputs/Outputs to File
|
|
@@ -4159,7 +4164,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4159
4164
|
* @param {*} [options] Override http request option.
|
|
4160
4165
|
* @throws {RequiredError}
|
|
4161
4166
|
*/
|
|
4162
|
-
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4167
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string, any>>;
|
|
4163
4168
|
/**
|
|
4164
4169
|
* 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.
|
|
4165
4170
|
* @summary List Descriptions
|
|
@@ -4167,7 +4172,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4167
4172
|
* @param {*} [options] Override http request option.
|
|
4168
4173
|
* @throws {RequiredError}
|
|
4169
4174
|
*/
|
|
4170
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4175
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<BusIODescription[], any>>;
|
|
4171
4176
|
/**
|
|
4172
4177
|
* 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).
|
|
4173
4178
|
* @summary List MODBUS Input/Output Configuration
|
|
@@ -4175,7 +4180,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4175
4180
|
* @param {*} [options] Override http request option.
|
|
4176
4181
|
* @throws {RequiredError}
|
|
4177
4182
|
*/
|
|
4178
|
-
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4183
|
+
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ModbusIO[], any>>;
|
|
4179
4184
|
/**
|
|
4180
4185
|
* 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.
|
|
4181
4186
|
* @summary List PROFINET Input/Output Configuration
|
|
@@ -4183,7 +4188,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4183
4188
|
* @param {*} [options] Override http request option.
|
|
4184
4189
|
* @throws {RequiredError}
|
|
4185
4190
|
*/
|
|
4186
|
-
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4191
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ProfinetIO[], any>>;
|
|
4187
4192
|
/**
|
|
4188
4193
|
* 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.
|
|
4189
4194
|
* @summary Set Output Values
|
|
@@ -4192,7 +4197,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4192
4197
|
* @param {*} [options] Override http request option.
|
|
4193
4198
|
* @throws {RequiredError}
|
|
4194
4199
|
*/
|
|
4195
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
4200
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4196
4201
|
/**
|
|
4197
4202
|
* 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.
|
|
4198
4203
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
@@ -4201,7 +4206,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4201
4206
|
* @param {*} [options] Override http request option.
|
|
4202
4207
|
* @throws {RequiredError}
|
|
4203
4208
|
*/
|
|
4204
|
-
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<
|
|
4209
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4205
4210
|
}
|
|
4206
4211
|
/**
|
|
4207
4212
|
* CellApi - axios parameter creator
|
|
@@ -4410,7 +4415,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4410
4415
|
* @param {*} [options] Override http request option.
|
|
4411
4416
|
* @throws {RequiredError}
|
|
4412
4417
|
*/
|
|
4413
|
-
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4418
|
+
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4414
4419
|
/**
|
|
4415
4420
|
* 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.
|
|
4416
4421
|
* @summary Add Cell
|
|
@@ -4419,7 +4424,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4419
4424
|
* @param {*} [options] Override http request option.
|
|
4420
4425
|
* @throws {RequiredError}
|
|
4421
4426
|
*/
|
|
4422
|
-
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4427
|
+
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4423
4428
|
/**
|
|
4424
4429
|
* List all cell resources.
|
|
4425
4430
|
* @summary Configuration
|
|
@@ -4427,7 +4432,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4427
4432
|
* @param {*} [options] Override http request option.
|
|
4428
4433
|
* @throws {RequiredError}
|
|
4429
4434
|
*/
|
|
4430
|
-
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4435
|
+
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Cell, any>>;
|
|
4431
4436
|
/**
|
|
4432
4437
|
* List the status of all cell resources.
|
|
4433
4438
|
* @summary Service Status
|
|
@@ -4435,14 +4440,14 @@ declare class CellApi extends BaseAPI {
|
|
|
4435
4440
|
* @param {*} [options] Override http request option.
|
|
4436
4441
|
* @throws {RequiredError}
|
|
4437
4442
|
*/
|
|
4438
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4443
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ServiceStatusResponse, any>>;
|
|
4439
4444
|
/**
|
|
4440
4445
|
* List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
4441
4446
|
* @summary List Cells
|
|
4442
4447
|
* @param {*} [options] Override http request option.
|
|
4443
4448
|
* @throws {RequiredError}
|
|
4444
4449
|
*/
|
|
4445
|
-
listCells(options?: RawAxiosRequestConfig): Promise<
|
|
4450
|
+
listCells(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
4446
4451
|
/**
|
|
4447
4452
|
* Deactivate or activate the services of a cell.
|
|
4448
4453
|
* @summary Operating State
|
|
@@ -4451,7 +4456,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4451
4456
|
* @param {*} [options] Override http request option.
|
|
4452
4457
|
* @throws {RequiredError}
|
|
4453
4458
|
*/
|
|
4454
|
-
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<
|
|
4459
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4455
4460
|
/**
|
|
4456
4461
|
* Update the definition of the entire Cell.
|
|
4457
4462
|
* @summary Update Configuration
|
|
@@ -4461,7 +4466,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4461
4466
|
* @param {*} [options] Override http request option.
|
|
4462
4467
|
* @throws {RequiredError}
|
|
4463
4468
|
*/
|
|
4464
|
-
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4469
|
+
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4465
4470
|
}
|
|
4466
4471
|
/**
|
|
4467
4472
|
* ControllerApi - axios parameter creator
|
|
@@ -4899,7 +4904,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4899
4904
|
* @param {*} [options] Override http request option.
|
|
4900
4905
|
* @throws {RequiredError}
|
|
4901
4906
|
*/
|
|
4902
|
-
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4907
|
+
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4903
4908
|
/**
|
|
4904
4909
|
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
4905
4910
|
* @summary Clear Robot Controllers
|
|
@@ -4908,7 +4913,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4908
4913
|
* @param {*} [options] Override http request option.
|
|
4909
4914
|
* @throws {RequiredError}
|
|
4910
4915
|
*/
|
|
4911
|
-
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4916
|
+
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4912
4917
|
/**
|
|
4913
4918
|
* Delete a robot controller from the cell.
|
|
4914
4919
|
* @summary Delete Robot Controller
|
|
@@ -4918,7 +4923,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4918
4923
|
* @param {*} [options] Override http request option.
|
|
4919
4924
|
* @throws {RequiredError}
|
|
4920
4925
|
*/
|
|
4921
|
-
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4926
|
+
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4922
4927
|
/**
|
|
4923
4928
|
* 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.
|
|
4924
4929
|
* @summary Description
|
|
@@ -4927,7 +4932,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4927
4932
|
* @param {*} [options] Override http request option.
|
|
4928
4933
|
* @throws {RequiredError}
|
|
4929
4934
|
*/
|
|
4930
|
-
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4935
|
+
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ControllerDescription, any>>;
|
|
4931
4936
|
/**
|
|
4932
4937
|
* 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.
|
|
4933
4938
|
* @summary Coordinate System
|
|
@@ -4938,7 +4943,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4938
4943
|
* @param {*} [options] Override http request option.
|
|
4939
4944
|
* @throws {RequiredError}
|
|
4940
4945
|
*/
|
|
4941
|
-
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
4946
|
+
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CoordinateSystem, any>>;
|
|
4942
4947
|
/**
|
|
4943
4948
|
* Get the current state of a robot controller.
|
|
4944
4949
|
* @summary State
|
|
@@ -4947,7 +4952,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4947
4952
|
* @param {*} [options] Override http request option.
|
|
4948
4953
|
* @throws {RequiredError}
|
|
4949
4954
|
*/
|
|
4950
|
-
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4955
|
+
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<RobotControllerState, any>>;
|
|
4951
4956
|
/**
|
|
4952
4957
|
* Get the configuration for a robot controller.
|
|
4953
4958
|
* @summary Robot Controller
|
|
@@ -4956,7 +4961,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4956
4961
|
* @param {*} [options] Override http request option.
|
|
4957
4962
|
* @throws {RequiredError}
|
|
4958
4963
|
*/
|
|
4959
|
-
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4964
|
+
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<RobotController, any>>;
|
|
4960
4965
|
/**
|
|
4961
4966
|
* 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.
|
|
4962
4967
|
* @summary Virtual Controller Configuration
|
|
@@ -4965,7 +4970,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4965
4970
|
* @param {*} [options] Override http request option.
|
|
4966
4971
|
* @throws {RequiredError}
|
|
4967
4972
|
*/
|
|
4968
|
-
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4973
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
4969
4974
|
/**
|
|
4970
4975
|
* 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.
|
|
4971
4976
|
* @summary List Coordinate Systems
|
|
@@ -4975,7 +4980,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4975
4980
|
* @param {*} [options] Override http request option.
|
|
4976
4981
|
* @throws {RequiredError}
|
|
4977
4982
|
*/
|
|
4978
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
4983
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CoordinateSystem[], any>>;
|
|
4979
4984
|
/**
|
|
4980
4985
|
* List the names of all deployed robot controllers.
|
|
4981
4986
|
* @summary List Robot Controllers
|
|
@@ -4983,7 +4988,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4983
4988
|
* @param {*} [options] Override http request option.
|
|
4984
4989
|
* @throws {RequiredError}
|
|
4985
4990
|
*/
|
|
4986
|
-
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4991
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
4987
4992
|
/**
|
|
4988
4993
|
* 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.
|
|
4989
4994
|
* @summary Set Default Mode
|
|
@@ -4993,7 +4998,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4993
4998
|
* @param {*} [options] Override http request option.
|
|
4994
4999
|
* @throws {RequiredError}
|
|
4995
5000
|
*/
|
|
4996
|
-
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<
|
|
5001
|
+
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
4997
5002
|
/**
|
|
4998
5003
|
* <!-- 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.
|
|
4999
5004
|
* @summary Stream Free Drive
|
|
@@ -5003,7 +5008,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5003
5008
|
* @param {*} [options] Override http request option.
|
|
5004
5009
|
* @throws {RequiredError}
|
|
5005
5010
|
*/
|
|
5006
|
-
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5011
|
+
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<RobotControllerState, any>>;
|
|
5007
5012
|
/**
|
|
5008
5013
|
* <!-- 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.
|
|
5009
5014
|
* @summary Stream State
|
|
@@ -5014,7 +5019,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5014
5019
|
* @param {*} [options] Override http request option.
|
|
5015
5020
|
* @throws {RequiredError}
|
|
5016
5021
|
*/
|
|
5017
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5022
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<RobotControllerState, any>>;
|
|
5018
5023
|
/**
|
|
5019
5024
|
* 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).
|
|
5020
5025
|
* @summary Update Robot Controller
|
|
@@ -5025,7 +5030,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5025
5030
|
* @param {*} [options] Override http request option.
|
|
5026
5031
|
* @throws {RequiredError}
|
|
5027
5032
|
*/
|
|
5028
|
-
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5033
|
+
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5029
5034
|
}
|
|
5030
5035
|
/**
|
|
5031
5036
|
* ControllerInputsOutputsApi - axios parameter creator
|
|
@@ -5217,7 +5222,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5217
5222
|
* @param {*} [options] Override http request option.
|
|
5218
5223
|
* @throws {RequiredError}
|
|
5219
5224
|
*/
|
|
5220
|
-
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5225
|
+
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<IODescription[], any>>;
|
|
5221
5226
|
/**
|
|
5222
5227
|
* 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).
|
|
5223
5228
|
* @summary Get Input/Output Values
|
|
@@ -5227,7 +5232,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5227
5232
|
* @param {*} [options] Override http request option.
|
|
5228
5233
|
* @throws {RequiredError}
|
|
5229
5234
|
*/
|
|
5230
|
-
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5235
|
+
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<IOValue[], any>>;
|
|
5231
5236
|
/**
|
|
5232
5237
|
* 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.
|
|
5233
5238
|
* @summary Set Output Values
|
|
@@ -5237,7 +5242,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5237
5242
|
* @param {*} [options] Override http request option.
|
|
5238
5243
|
* @throws {RequiredError}
|
|
5239
5244
|
*/
|
|
5240
|
-
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
5245
|
+
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5241
5246
|
/**
|
|
5242
5247
|
* <!-- 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.
|
|
5243
5248
|
* @summary Stream Input/Output Values
|
|
@@ -5247,7 +5252,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5247
5252
|
* @param {*} [options] Override http request option.
|
|
5248
5253
|
* @throws {RequiredError}
|
|
5249
5254
|
*/
|
|
5250
|
-
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5255
|
+
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<StreamIOValuesResponse, any>>;
|
|
5251
5256
|
/**
|
|
5252
5257
|
* 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 ```
|
|
5253
5258
|
* @summary Wait For
|
|
@@ -5257,7 +5262,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5257
5262
|
* @param {*} [options] Override http request option.
|
|
5258
5263
|
* @throws {RequiredError}
|
|
5259
5264
|
*/
|
|
5260
|
-
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5265
|
+
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<boolean, any>>;
|
|
5261
5266
|
}
|
|
5262
5267
|
/**
|
|
5263
5268
|
* JoggingApi - axios parameter creator
|
|
@@ -5317,7 +5322,7 @@ declare class JoggingApi extends BaseAPI {
|
|
|
5317
5322
|
* @param {*} [options] Override http request option.
|
|
5318
5323
|
* @throws {RequiredError}
|
|
5319
5324
|
*/
|
|
5320
|
-
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5325
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ExecuteJoggingResponse, any>>;
|
|
5321
5326
|
}
|
|
5322
5327
|
/**
|
|
5323
5328
|
* KinematicsApi - axios parameter creator
|
|
@@ -5400,7 +5405,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
5400
5405
|
* @param {*} [options] Override http request option.
|
|
5401
5406
|
* @throws {RequiredError}
|
|
5402
5407
|
*/
|
|
5403
|
-
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5408
|
+
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ForwardKinematicsResponse, any>>;
|
|
5404
5409
|
/**
|
|
5405
5410
|
* Returns the reachable joint positions for a list of given poses.
|
|
5406
5411
|
* @summary Inverse kinematics
|
|
@@ -5409,7 +5414,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
5409
5414
|
* @param {*} [options] Override http request option.
|
|
5410
5415
|
* @throws {RequiredError}
|
|
5411
5416
|
*/
|
|
5412
|
-
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5417
|
+
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<InverseKinematicsResponse, any>>;
|
|
5413
5418
|
}
|
|
5414
5419
|
/**
|
|
5415
5420
|
* LicenseApi - axios parameter creator
|
|
@@ -5524,28 +5529,28 @@ declare class LicenseApi extends BaseAPI {
|
|
|
5524
5529
|
* @param {*} [options] Override http request option.
|
|
5525
5530
|
* @throws {RequiredError}
|
|
5526
5531
|
*/
|
|
5527
|
-
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5532
|
+
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<License, any>>;
|
|
5528
5533
|
/**
|
|
5529
5534
|
* Deactivates active license.
|
|
5530
5535
|
* @summary Deactivate license
|
|
5531
5536
|
* @param {*} [options] Override http request option.
|
|
5532
5537
|
* @throws {RequiredError}
|
|
5533
5538
|
*/
|
|
5534
|
-
deactivateLicense(options?: RawAxiosRequestConfig): Promise<
|
|
5539
|
+
deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
5535
5540
|
/**
|
|
5536
5541
|
* Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
|
|
5537
5542
|
* @summary Get license
|
|
5538
5543
|
* @param {*} [options] Override http request option.
|
|
5539
5544
|
* @throws {RequiredError}
|
|
5540
5545
|
*/
|
|
5541
|
-
getLicense(options?: RawAxiosRequestConfig): Promise<
|
|
5546
|
+
getLicense(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<License, any>>;
|
|
5542
5547
|
/**
|
|
5543
5548
|
* 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.
|
|
5544
5549
|
* @summary Get license status
|
|
5545
5550
|
* @param {*} [options] Override http request option.
|
|
5546
5551
|
* @throws {RequiredError}
|
|
5547
5552
|
*/
|
|
5548
|
-
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<
|
|
5553
|
+
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<LicenseStatus, any>>;
|
|
5549
5554
|
}
|
|
5550
5555
|
/**
|
|
5551
5556
|
* MotionGroupApi - axios parameter creator
|
|
@@ -5675,7 +5680,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5675
5680
|
* @param {*} [options] Override http request option.
|
|
5676
5681
|
* @throws {RequiredError}
|
|
5677
5682
|
*/
|
|
5678
|
-
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5683
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<MotionGroupState, any>>;
|
|
5679
5684
|
/**
|
|
5680
5685
|
* 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.
|
|
5681
5686
|
* @summary Description
|
|
@@ -5685,7 +5690,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5685
5690
|
* @param {*} [options] Override http request option.
|
|
5686
5691
|
* @throws {RequiredError}
|
|
5687
5692
|
*/
|
|
5688
|
-
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
5693
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<MotionGroupDescription, any>>;
|
|
5689
5694
|
/**
|
|
5690
5695
|
* <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
5691
5696
|
* @summary Stream State
|
|
@@ -5697,7 +5702,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5697
5702
|
* @param {*} [options] Override http request option.
|
|
5698
5703
|
* @throws {RequiredError}
|
|
5699
5704
|
*/
|
|
5700
|
-
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5705
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<MotionGroupState, any>>;
|
|
5701
5706
|
}
|
|
5702
5707
|
/**
|
|
5703
5708
|
* MotionGroupModelsApi - axios parameter creator
|
|
@@ -5846,7 +5851,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
5846
5851
|
* @param {*} [options] Override http request option.
|
|
5847
5852
|
* @throws {RequiredError}
|
|
5848
5853
|
*/
|
|
5849
|
-
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
5854
|
+
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
5850
5855
|
[key: string]: Collider;
|
|
5851
5856
|
}[], any>>;
|
|
5852
5857
|
/**
|
|
@@ -5856,7 +5861,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
5856
5861
|
* @param {*} [options] Override http request option.
|
|
5857
5862
|
* @throws {RequiredError}
|
|
5858
5863
|
*/
|
|
5859
|
-
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
5864
|
+
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<File, any>>;
|
|
5860
5865
|
/**
|
|
5861
5866
|
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
5862
5867
|
* @summary Get Kinematics
|
|
@@ -5864,14 +5869,14 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
5864
5869
|
* @param {*} [options] Override http request option.
|
|
5865
5870
|
* @throws {RequiredError}
|
|
5866
5871
|
*/
|
|
5867
|
-
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
5872
|
+
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<KinematicModel, any>>;
|
|
5868
5873
|
/**
|
|
5869
5874
|
* Returns the list of supported motion group models.
|
|
5870
5875
|
* @summary Motion Group Models
|
|
5871
5876
|
* @param {*} [options] Override http request option.
|
|
5872
5877
|
* @throws {RequiredError}
|
|
5873
5878
|
*/
|
|
5874
|
-
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<
|
|
5879
|
+
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
5875
5880
|
/**
|
|
5876
5881
|
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
5877
5882
|
* @summary Download USD Model
|
|
@@ -5879,7 +5884,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
5879
5884
|
* @param {*} [options] Override http request option.
|
|
5880
5885
|
* @throws {RequiredError}
|
|
5881
5886
|
*/
|
|
5882
|
-
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
5887
|
+
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<File, any>>;
|
|
5883
5888
|
}
|
|
5884
5889
|
/**
|
|
5885
5890
|
* ProgramApi - axios parameter creator
|
|
@@ -6016,7 +6021,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6016
6021
|
* @param {*} [options] Override http request option.
|
|
6017
6022
|
* @throws {RequiredError}
|
|
6018
6023
|
*/
|
|
6019
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
6024
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Program, any>>;
|
|
6020
6025
|
/**
|
|
6021
6026
|
* <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
6022
6027
|
* @summary List programs
|
|
@@ -6024,7 +6029,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6024
6029
|
* @param {*} [options] Override http request option.
|
|
6025
6030
|
* @throws {RequiredError}
|
|
6026
6031
|
*/
|
|
6027
|
-
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6032
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Program[], any>>;
|
|
6028
6033
|
/**
|
|
6029
6034
|
* <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
6030
6035
|
* @summary Start the program
|
|
@@ -6034,7 +6039,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6034
6039
|
* @param {*} [options] Override http request option.
|
|
6035
6040
|
* @throws {RequiredError}
|
|
6036
6041
|
*/
|
|
6037
|
-
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6042
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ProgramRun, any>>;
|
|
6038
6043
|
/**
|
|
6039
6044
|
* <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
6040
6045
|
* @summary Stop program run
|
|
@@ -6043,7 +6048,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6043
6048
|
* @param {*} [options] Override http request option.
|
|
6044
6049
|
* @throws {RequiredError}
|
|
6045
6050
|
*/
|
|
6046
|
-
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
6051
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
6047
6052
|
}
|
|
6048
6053
|
/**
|
|
6049
6054
|
* RobotConfigurationsApi - axios parameter creator
|
|
@@ -6091,7 +6096,7 @@ declare class RobotConfigurationsApi extends BaseAPI {
|
|
|
6091
6096
|
* @param {*} [options] Override http request option.
|
|
6092
6097
|
* @throws {RequiredError}
|
|
6093
6098
|
*/
|
|
6094
|
-
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<
|
|
6099
|
+
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
6095
6100
|
}
|
|
6096
6101
|
/**
|
|
6097
6102
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
@@ -6564,7 +6569,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6564
6569
|
* @param {*} [options] Override http request option.
|
|
6565
6570
|
* @throws {RequiredError}
|
|
6566
6571
|
*/
|
|
6567
|
-
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
6572
|
+
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
6568
6573
|
/**
|
|
6569
6574
|
* Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6570
6575
|
* @summary Delete Link Chain
|
|
@@ -6573,7 +6578,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6573
6578
|
* @param {*} [options] Override http request option.
|
|
6574
6579
|
* @throws {RequiredError}
|
|
6575
6580
|
*/
|
|
6576
|
-
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
6581
|
+
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
6577
6582
|
/**
|
|
6578
6583
|
* Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6579
6584
|
* @summary Delete Tool
|
|
@@ -6582,7 +6587,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6582
6587
|
* @param {*} [options] Override http request option.
|
|
6583
6588
|
* @throws {RequiredError}
|
|
6584
6589
|
*/
|
|
6585
|
-
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
6590
|
+
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
6586
6591
|
/**
|
|
6587
6592
|
* Returns the collider.
|
|
6588
6593
|
* @summary Get Collider
|
|
@@ -6591,7 +6596,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6591
6596
|
* @param {*} [options] Override http request option.
|
|
6592
6597
|
* @throws {RequiredError}
|
|
6593
6598
|
*/
|
|
6594
|
-
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
6599
|
+
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Collider, any>>;
|
|
6595
6600
|
/**
|
|
6596
6601
|
* Returns the collision link chain.
|
|
6597
6602
|
* @summary Get Link Chain
|
|
@@ -6600,7 +6605,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6600
6605
|
* @param {*} [options] Override http request option.
|
|
6601
6606
|
* @throws {RequiredError}
|
|
6602
6607
|
*/
|
|
6603
|
-
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
6608
|
+
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
6604
6609
|
[key: string]: Collider;
|
|
6605
6610
|
}[], any>>;
|
|
6606
6611
|
/**
|
|
@@ -6611,7 +6616,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6611
6616
|
* @param {*} [options] Override http request option.
|
|
6612
6617
|
* @throws {RequiredError}
|
|
6613
6618
|
*/
|
|
6614
|
-
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
6619
|
+
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
6615
6620
|
[key: string]: Collider;
|
|
6616
6621
|
}, any>>;
|
|
6617
6622
|
/**
|
|
@@ -6621,7 +6626,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6621
6626
|
* @param {*} [options] Override http request option.
|
|
6622
6627
|
* @throws {RequiredError}
|
|
6623
6628
|
*/
|
|
6624
|
-
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6629
|
+
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
6625
6630
|
[key: string]: {
|
|
6626
6631
|
[key: string]: Collider;
|
|
6627
6632
|
}[];
|
|
@@ -6633,7 +6638,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6633
6638
|
* @param {*} [options] Override http request option.
|
|
6634
6639
|
* @throws {RequiredError}
|
|
6635
6640
|
*/
|
|
6636
|
-
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6641
|
+
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
6637
6642
|
/**
|
|
6638
6643
|
* Returns all stored colliders.
|
|
6639
6644
|
* @summary List Colliders
|
|
@@ -6641,7 +6646,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6641
6646
|
* @param {*} [options] Override http request option.
|
|
6642
6647
|
* @throws {RequiredError}
|
|
6643
6648
|
*/
|
|
6644
|
-
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6649
|
+
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
6645
6650
|
[key: string]: Collider;
|
|
6646
6651
|
}, any>>;
|
|
6647
6652
|
/**
|
|
@@ -6651,7 +6656,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6651
6656
|
* @param {*} [options] Override http request option.
|
|
6652
6657
|
* @throws {RequiredError}
|
|
6653
6658
|
*/
|
|
6654
|
-
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6659
|
+
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
6655
6660
|
/**
|
|
6656
6661
|
* Returns the list of stored tools.
|
|
6657
6662
|
* @summary List Tools
|
|
@@ -6659,7 +6664,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6659
6664
|
* @param {*} [options] Override http request option.
|
|
6660
6665
|
* @throws {RequiredError}
|
|
6661
6666
|
*/
|
|
6662
|
-
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6667
|
+
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
6663
6668
|
[key: string]: {
|
|
6664
6669
|
[key: string]: Collider;
|
|
6665
6670
|
};
|
|
@@ -6671,7 +6676,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6671
6676
|
* @param {*} [options] Override http request option.
|
|
6672
6677
|
* @throws {RequiredError}
|
|
6673
6678
|
*/
|
|
6674
|
-
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6679
|
+
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
6675
6680
|
/**
|
|
6676
6681
|
* Stores collider. - If the collider does not exist, it will be created. - If the collider exists, it will be updated.
|
|
6677
6682
|
* @summary Store Collider
|
|
@@ -6681,7 +6686,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6681
6686
|
* @param {*} [options] Override http request option.
|
|
6682
6687
|
* @throws {RequiredError}
|
|
6683
6688
|
*/
|
|
6684
|
-
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<
|
|
6689
|
+
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Collider, any>>;
|
|
6685
6690
|
/**
|
|
6686
6691
|
* Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
|
|
6687
6692
|
* @summary Store Link Chain
|
|
@@ -6693,7 +6698,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6693
6698
|
*/
|
|
6694
6699
|
storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{
|
|
6695
6700
|
[key: string]: Collider;
|
|
6696
|
-
}>, options?: RawAxiosRequestConfig): Promise<
|
|
6701
|
+
}>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
6697
6702
|
[key: string]: Collider;
|
|
6698
6703
|
}[], any>>;
|
|
6699
6704
|
/**
|
|
@@ -6707,7 +6712,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6707
6712
|
*/
|
|
6708
6713
|
storeCollisionTool(cell: string, tool: string, requestBody: {
|
|
6709
6714
|
[key: string]: Collider;
|
|
6710
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
6715
|
+
}, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
6711
6716
|
[key: string]: Collider;
|
|
6712
6717
|
}, any>>;
|
|
6713
6718
|
}
|
|
@@ -6874,7 +6879,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6874
6879
|
* @param {*} [options] Override http request option.
|
|
6875
6880
|
* @throws {RequiredError}
|
|
6876
6881
|
*/
|
|
6877
|
-
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
6882
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
6878
6883
|
/**
|
|
6879
6884
|
* Returns the stored collision setup.
|
|
6880
6885
|
* @summary Get Collision Setup
|
|
@@ -6883,7 +6888,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6883
6888
|
* @param {*} [options] Override http request option.
|
|
6884
6889
|
* @throws {RequiredError}
|
|
6885
6890
|
*/
|
|
6886
|
-
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
6891
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CollisionSetup, any>>;
|
|
6887
6892
|
/**
|
|
6888
6893
|
* Returns a list of stored collision setups.
|
|
6889
6894
|
* @summary List Collision Setups
|
|
@@ -6891,7 +6896,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6891
6896
|
* @param {*} [options] Override http request option.
|
|
6892
6897
|
* @throws {RequiredError}
|
|
6893
6898
|
*/
|
|
6894
|
-
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6899
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<{
|
|
6895
6900
|
[key: string]: CollisionSetup;
|
|
6896
6901
|
}, any>>;
|
|
6897
6902
|
/**
|
|
@@ -6901,7 +6906,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6901
6906
|
* @param {*} [options] Override http request option.
|
|
6902
6907
|
* @throws {RequiredError}
|
|
6903
6908
|
*/
|
|
6904
|
-
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6909
|
+
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
6905
6910
|
/**
|
|
6906
6911
|
* Stores collision setup. - If the collision setup does not exist, it will be created. - If the collision setup exists, it will be updated.
|
|
6907
6912
|
* @summary Store Collision Setup
|
|
@@ -6911,7 +6916,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6911
6916
|
* @param {*} [options] Override http request option.
|
|
6912
6917
|
* @throws {RequiredError}
|
|
6913
6918
|
*/
|
|
6914
|
-
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<
|
|
6919
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CollisionSetup, any>>;
|
|
6915
6920
|
}
|
|
6916
6921
|
/**
|
|
6917
6922
|
* StoreObjectApi - axios parameter creator
|
|
@@ -7107,7 +7112,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7107
7112
|
* @param {*} [options] Override http request option.
|
|
7108
7113
|
* @throws {RequiredError}
|
|
7109
7114
|
*/
|
|
7110
|
-
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7115
|
+
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
7111
7116
|
/**
|
|
7112
7117
|
* Delete an object <!-- theme: danger --> > This will delete persistently stored data.
|
|
7113
7118
|
* @summary Delete Object
|
|
@@ -7116,7 +7121,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7116
7121
|
* @param {*} [options] Override http request option.
|
|
7117
7122
|
* @throws {RequiredError}
|
|
7118
7123
|
*/
|
|
7119
|
-
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7124
|
+
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
7120
7125
|
/**
|
|
7121
7126
|
* Returns content and metadata of a stored object.
|
|
7122
7127
|
* @summary Get Object
|
|
@@ -7125,7 +7130,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7125
7130
|
* @param {*} [options] Override http request option.
|
|
7126
7131
|
* @throws {RequiredError}
|
|
7127
7132
|
*/
|
|
7128
|
-
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7133
|
+
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<File, any>>;
|
|
7129
7134
|
/**
|
|
7130
7135
|
* Returns metadata. Object content is not returned.
|
|
7131
7136
|
* @summary Get Object Metadata
|
|
@@ -7134,7 +7139,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7134
7139
|
* @param {*} [options] Override http request option.
|
|
7135
7140
|
* @throws {RequiredError}
|
|
7136
7141
|
*/
|
|
7137
|
-
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7142
|
+
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
7138
7143
|
/**
|
|
7139
7144
|
* List the keys for all objects.
|
|
7140
7145
|
* @summary List all Object Keys
|
|
@@ -7142,7 +7147,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7142
7147
|
* @param {*} [options] Override http request option.
|
|
7143
7148
|
* @throws {RequiredError}
|
|
7144
7149
|
*/
|
|
7145
|
-
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7150
|
+
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string[], any>>;
|
|
7146
7151
|
/**
|
|
7147
7152
|
* 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.
|
|
7148
7153
|
* @summary Store Object
|
|
@@ -7155,7 +7160,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7155
7160
|
*/
|
|
7156
7161
|
storeObject(cell: string, key: string, xMetadata?: {
|
|
7157
7162
|
[key: string]: string;
|
|
7158
|
-
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<
|
|
7163
|
+
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
7159
7164
|
}
|
|
7160
7165
|
/**
|
|
7161
7166
|
* SystemApi - axios parameter creator
|
|
@@ -7474,7 +7479,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7474
7479
|
*/
|
|
7475
7480
|
backupConfiguration(resources?: Array<string>, metadata?: {
|
|
7476
7481
|
[key: string]: string;
|
|
7477
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
7482
|
+
}, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<File, any>>;
|
|
7478
7483
|
/**
|
|
7479
7484
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
7480
7485
|
* @summary Check update
|
|
@@ -7482,7 +7487,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7482
7487
|
* @param {*} [options] Override http request option.
|
|
7483
7488
|
* @throws {RequiredError}
|
|
7484
7489
|
*/
|
|
7485
|
-
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
7490
|
+
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string, any>>;
|
|
7486
7491
|
/**
|
|
7487
7492
|
* <!-- 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
7493
|
* @summary Get ARP-Scan
|
|
@@ -7492,7 +7497,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7492
7497
|
* @param {*} [options] Override http request option.
|
|
7493
7498
|
* @throws {RequiredError}
|
|
7494
7499
|
*/
|
|
7495
|
-
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7500
|
+
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<NetworkDevice[], any>>;
|
|
7496
7501
|
/**
|
|
7497
7502
|
* 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.
|
|
7498
7503
|
* @summary Retrieve Backup Status
|
|
@@ -7500,49 +7505,49 @@ declare class SystemApi extends BaseAPI {
|
|
|
7500
7505
|
* @param {*} [options] Override http request option.
|
|
7501
7506
|
* @throws {RequiredError}
|
|
7502
7507
|
*/
|
|
7503
|
-
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
7508
|
+
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ConfigurationArchiveStatus, any>>;
|
|
7504
7509
|
/**
|
|
7505
7510
|
* 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.
|
|
7506
7511
|
* @summary Download Diagnosis Package
|
|
7507
7512
|
* @param {*} [options] Override http request option.
|
|
7508
7513
|
* @throws {RequiredError}
|
|
7509
7514
|
*/
|
|
7510
|
-
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<
|
|
7515
|
+
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<File, any>>;
|
|
7511
7516
|
/**
|
|
7512
7517
|
* <!-- theme: danger --> > **Experimental** Get the network interfaces of the system.
|
|
7513
7518
|
* @summary Network Interfaces
|
|
7514
7519
|
* @param {*} [options] Override http request option.
|
|
7515
7520
|
* @throws {RequiredError}
|
|
7516
7521
|
*/
|
|
7517
|
-
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<
|
|
7522
|
+
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<NetworkInterface[], any>>;
|
|
7518
7523
|
/**
|
|
7519
7524
|
* <!-- theme: danger --> > **Experimental** Get the current state of the network.
|
|
7520
7525
|
* @summary Network State
|
|
7521
7526
|
* @param {*} [options] Override http request option.
|
|
7522
7527
|
* @throws {RequiredError}
|
|
7523
7528
|
*/
|
|
7524
|
-
getNetworkState(options?: RawAxiosRequestConfig): Promise<
|
|
7529
|
+
getNetworkState(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<NetworkState, any>>;
|
|
7525
7530
|
/**
|
|
7526
7531
|
* Get the status of all system services.
|
|
7527
7532
|
* @summary Wandelbots NOVA status
|
|
7528
7533
|
* @param {*} [options] Override http request option.
|
|
7529
7534
|
* @throws {RequiredError}
|
|
7530
7535
|
*/
|
|
7531
|
-
getSystemStatus(options?: RawAxiosRequestConfig): Promise<
|
|
7536
|
+
getSystemStatus(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ServiceStatus[], any>>;
|
|
7532
7537
|
/**
|
|
7533
7538
|
* Get the current Wandelbots NOVA version.
|
|
7534
7539
|
* @summary Wandelbots NOVA Version
|
|
7535
7540
|
* @param {*} [options] Override http request option.
|
|
7536
7541
|
* @throws {RequiredError}
|
|
7537
7542
|
*/
|
|
7538
|
-
getSystemVersion(options?: RawAxiosRequestConfig): Promise<
|
|
7543
|
+
getSystemVersion(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<string, any>>;
|
|
7539
7544
|
/**
|
|
7540
7545
|
* Retrieves a list of all available configuration resources for backup purposes.
|
|
7541
7546
|
* @summary List Configuration Resources
|
|
7542
7547
|
* @param {*} [options] Override http request option.
|
|
7543
7548
|
* @throws {RequiredError}
|
|
7544
7549
|
*/
|
|
7545
|
-
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<
|
|
7550
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ConfigurationResource[], any>>;
|
|
7546
7551
|
/**
|
|
7547
7552
|
* Restores a previously backed up configuration. If an empty array of resources is provided, all resources from the backup will be restored.
|
|
7548
7553
|
* @summary Restore Configuration Backup
|
|
@@ -7551,7 +7556,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7551
7556
|
* @param {*} [options] Override http request option.
|
|
7552
7557
|
* @throws {RequiredError}
|
|
7553
7558
|
*/
|
|
7554
|
-
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
7559
|
+
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
7555
7560
|
/**
|
|
7556
7561
|
* 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.
|
|
7557
7562
|
* @summary Update Wandelbots NOVA version
|
|
@@ -7559,7 +7564,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7559
7564
|
* @param {*} [options] Override http request option.
|
|
7560
7565
|
* @throws {RequiredError}
|
|
7561
7566
|
*/
|
|
7562
|
-
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7567
|
+
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
7563
7568
|
}
|
|
7564
7569
|
/**
|
|
7565
7570
|
* TrajectoryCachingApi - axios parameter creator
|
|
@@ -7733,7 +7738,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7733
7738
|
* @param {*} [options] Override http request option.
|
|
7734
7739
|
* @throws {RequiredError}
|
|
7735
7740
|
*/
|
|
7736
|
-
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7741
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<AddTrajectoryResponse, any>>;
|
|
7737
7742
|
/**
|
|
7738
7743
|
* Clear the trajectory cache.
|
|
7739
7744
|
* @summary Clear Trajectories
|
|
@@ -7742,7 +7747,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7742
7747
|
* @param {*} [options] Override http request option.
|
|
7743
7748
|
* @throws {RequiredError}
|
|
7744
7749
|
*/
|
|
7745
|
-
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7750
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
7746
7751
|
/**
|
|
7747
7752
|
* 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.
|
|
7748
7753
|
* @summary Delete Trajectory
|
|
@@ -7752,7 +7757,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7752
7757
|
* @param {*} [options] Override http request option.
|
|
7753
7758
|
* @throws {RequiredError}
|
|
7754
7759
|
*/
|
|
7755
|
-
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
7760
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
7756
7761
|
/**
|
|
7757
7762
|
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7758
7763
|
* @summary Get Trajectory
|
|
@@ -7762,7 +7767,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7762
7767
|
* @param {*} [options] Override http request option.
|
|
7763
7768
|
* @throws {RequiredError}
|
|
7764
7769
|
*/
|
|
7765
|
-
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
7770
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<GetTrajectoryResponse, any>>;
|
|
7766
7771
|
/**
|
|
7767
7772
|
* 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.
|
|
7768
7773
|
* @summary List Trajectories
|
|
@@ -7771,7 +7776,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7771
7776
|
* @param {*} [options] Override http request option.
|
|
7772
7777
|
* @throws {RequiredError}
|
|
7773
7778
|
*/
|
|
7774
|
-
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7779
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ListTrajectoriesResponse, any>>;
|
|
7775
7780
|
}
|
|
7776
7781
|
/**
|
|
7777
7782
|
* TrajectoryExecutionApi - axios parameter creator
|
|
@@ -7831,7 +7836,7 @@ declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
7831
7836
|
* @param {*} [options] Override http request option.
|
|
7832
7837
|
* @throws {RequiredError}
|
|
7833
7838
|
*/
|
|
7834
|
-
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7839
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
7835
7840
|
}
|
|
7836
7841
|
/**
|
|
7837
7842
|
* TrajectoryPlanningApi - axios parameter creator
|
|
@@ -7914,7 +7919,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
7914
7919
|
* @param {*} [options] Override http request option.
|
|
7915
7920
|
* @throws {RequiredError}
|
|
7916
7921
|
*/
|
|
7917
|
-
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7922
|
+
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<PlanCollisionFreeResponse, any>>;
|
|
7918
7923
|
/**
|
|
7919
7924
|
* 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.
|
|
7920
7925
|
* @summary Plan Trajectory
|
|
@@ -7923,7 +7928,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
7923
7928
|
* @param {*} [options] Override http request option.
|
|
7924
7929
|
* @throws {RequiredError}
|
|
7925
7930
|
*/
|
|
7926
|
-
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7931
|
+
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
7927
7932
|
}
|
|
7928
7933
|
/**
|
|
7929
7934
|
* VersionApi - axios parameter creator
|
|
@@ -7971,7 +7976,7 @@ declare class VersionApi extends BaseAPI {
|
|
|
7971
7976
|
* @param {*} [options] Override http request option.
|
|
7972
7977
|
* @throws {RequiredError}
|
|
7973
7978
|
*/
|
|
7974
|
-
getApiVersion(options?: RawAxiosRequestConfig): Promise<
|
|
7979
|
+
getApiVersion(options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ApiVersion, any>>;
|
|
7975
7980
|
}
|
|
7976
7981
|
/**
|
|
7977
7982
|
* VirtualControllerApi - axios parameter creator
|
|
@@ -8461,7 +8466,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8461
8466
|
* @param {*} [options] Override http request option.
|
|
8462
8467
|
* @throws {RequiredError}
|
|
8463
8468
|
*/
|
|
8464
|
-
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<
|
|
8469
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8465
8470
|
/**
|
|
8466
8471
|
* 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.
|
|
8467
8472
|
* @summary Add TCP
|
|
@@ -8473,7 +8478,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8473
8478
|
* @param {*} [options] Override http request option.
|
|
8474
8479
|
* @throws {RequiredError}
|
|
8475
8480
|
*/
|
|
8476
|
-
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<
|
|
8481
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8477
8482
|
/**
|
|
8478
8483
|
* 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.
|
|
8479
8484
|
* @summary Delete Coordinate System
|
|
@@ -8484,7 +8489,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8484
8489
|
* @param {*} [options] Override http request option.
|
|
8485
8490
|
* @throws {RequiredError}
|
|
8486
8491
|
*/
|
|
8487
|
-
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
8492
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8488
8493
|
/**
|
|
8489
8494
|
* 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.
|
|
8490
8495
|
* @summary Remove TCP
|
|
@@ -8495,7 +8500,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8495
8500
|
* @param {*} [options] Override http request option.
|
|
8496
8501
|
* @throws {RequiredError}
|
|
8497
8502
|
*/
|
|
8498
|
-
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<
|
|
8503
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8499
8504
|
/**
|
|
8500
8505
|
* 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.
|
|
8501
8506
|
* @summary Get Emergency Stop State
|
|
@@ -8504,7 +8509,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8504
8509
|
* @param {*} [options] Override http request option.
|
|
8505
8510
|
* @throws {RequiredError}
|
|
8506
8511
|
*/
|
|
8507
|
-
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8512
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Flag, any>>;
|
|
8508
8513
|
/**
|
|
8509
8514
|
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8510
8515
|
* @summary Get Motion Group State
|
|
@@ -8514,7 +8519,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8514
8519
|
* @param {*} [options] Override http request option.
|
|
8515
8520
|
* @throws {RequiredError}
|
|
8516
8521
|
*/
|
|
8517
|
-
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8522
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<MotionGroupJoints, any>>;
|
|
8518
8523
|
/**
|
|
8519
8524
|
* Gets information on the motion group.
|
|
8520
8525
|
* @summary Motion Group Description
|
|
@@ -8523,7 +8528,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8523
8528
|
* @param {*} [options] Override http request option.
|
|
8524
8529
|
* @throws {RequiredError}
|
|
8525
8530
|
*/
|
|
8526
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8531
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<MotionGroupInfo[], any>>;
|
|
8527
8532
|
/**
|
|
8528
8533
|
* 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.
|
|
8529
8534
|
* @summary Get Operation Mode
|
|
@@ -8532,7 +8537,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8532
8537
|
* @param {*} [options] Override http request option.
|
|
8533
8538
|
* @throws {RequiredError}
|
|
8534
8539
|
*/
|
|
8535
|
-
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8540
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<OpMode, any>>;
|
|
8536
8541
|
/**
|
|
8537
8542
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8538
8543
|
* @summary Get Mounting
|
|
@@ -8542,7 +8547,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8542
8547
|
* @param {*} [options] Override http request option.
|
|
8543
8548
|
* @throws {RequiredError}
|
|
8544
8549
|
*/
|
|
8545
|
-
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8550
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CoordinateSystem, any>>;
|
|
8546
8551
|
/**
|
|
8547
8552
|
* Lists all coordinate systems on the robot controller.
|
|
8548
8553
|
* @summary List Coordinate Systems
|
|
@@ -8551,7 +8556,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8551
8556
|
* @param {*} [options] Override http request option.
|
|
8552
8557
|
* @throws {RequiredError}
|
|
8553
8558
|
*/
|
|
8554
|
-
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8559
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CoordinateSystem[], any>>;
|
|
8555
8560
|
/**
|
|
8556
8561
|
* Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
|
|
8557
8562
|
* @summary List TCPs
|
|
@@ -8561,7 +8566,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8561
8566
|
* @param {*} [options] Override http request option.
|
|
8562
8567
|
* @throws {RequiredError}
|
|
8563
8568
|
*/
|
|
8564
|
-
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8569
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<RobotTcp[], any>>;
|
|
8565
8570
|
/**
|
|
8566
8571
|
* 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.
|
|
8567
8572
|
* @summary Push or Release Emergency Stop
|
|
@@ -8571,7 +8576,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8571
8576
|
* @param {*} [options] Override http request option.
|
|
8572
8577
|
* @throws {RequiredError}
|
|
8573
8578
|
*/
|
|
8574
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
8579
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8575
8580
|
/**
|
|
8576
8581
|
* 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.
|
|
8577
8582
|
* @summary Set Motion Group State
|
|
@@ -8582,7 +8587,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8582
8587
|
* @param {*} [options] Override http request option.
|
|
8583
8588
|
* @throws {RequiredError}
|
|
8584
8589
|
*/
|
|
8585
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<
|
|
8590
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8586
8591
|
/**
|
|
8587
8592
|
* 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.
|
|
8588
8593
|
* @summary Set Operation Mode
|
|
@@ -8592,7 +8597,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8592
8597
|
* @param {*} [options] Override http request option.
|
|
8593
8598
|
* @throws {RequiredError}
|
|
8594
8599
|
*/
|
|
8595
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<
|
|
8600
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8596
8601
|
/**
|
|
8597
8602
|
* 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.
|
|
8598
8603
|
* @summary Set Mounting
|
|
@@ -8603,7 +8608,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8603
8608
|
* @param {*} [options] Override http request option.
|
|
8604
8609
|
* @throws {RequiredError}
|
|
8605
8610
|
*/
|
|
8606
|
-
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
8611
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CoordinateSystem, any>>;
|
|
8607
8612
|
}
|
|
8608
8613
|
/**
|
|
8609
8614
|
* VirtualControllerBehaviorApi - axios parameter creator
|
|
@@ -8747,7 +8752,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8747
8752
|
* @param {*} [options] Override http request option.
|
|
8748
8753
|
* @throws {RequiredError}
|
|
8749
8754
|
*/
|
|
8750
|
-
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8755
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<ExternalJointStreamDatapoint[], any>>;
|
|
8751
8756
|
/**
|
|
8752
8757
|
* Get the cycle time of controller communication in [ms].
|
|
8753
8758
|
* @summary Get Cycle Time
|
|
@@ -8756,7 +8761,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8756
8761
|
* @param {*} [options] Override http request option.
|
|
8757
8762
|
* @throws {RequiredError}
|
|
8758
8763
|
*/
|
|
8759
|
-
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8764
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<CycleTime, any>>;
|
|
8760
8765
|
/**
|
|
8761
8766
|
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
8762
8767
|
* @summary Get Behavior
|
|
@@ -8765,7 +8770,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8765
8770
|
* @param {*} [options] Override http request option.
|
|
8766
8771
|
* @throws {RequiredError}
|
|
8767
8772
|
*/
|
|
8768
|
-
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8773
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<Behavior, any>>;
|
|
8769
8774
|
/**
|
|
8770
8775
|
* Set virtual controller behavior. See query parameters for details.
|
|
8771
8776
|
* @summary Set Behavior
|
|
@@ -8775,7 +8780,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8775
8780
|
* @param {*} [options] Override http request option.
|
|
8776
8781
|
* @throws {RequiredError}
|
|
8777
8782
|
*/
|
|
8778
|
-
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<
|
|
8783
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8779
8784
|
}
|
|
8780
8785
|
/**
|
|
8781
8786
|
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
@@ -8904,7 +8909,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
8904
8909
|
* @param {*} [options] Override http request option.
|
|
8905
8910
|
* @throws {RequiredError}
|
|
8906
8911
|
*/
|
|
8907
|
-
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
8912
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<IOValue[], any>>;
|
|
8908
8913
|
/**
|
|
8909
8914
|
* 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.
|
|
8910
8915
|
* @summary List Descriptions
|
|
@@ -8917,7 +8922,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
8917
8922
|
* @param {*} [options] Override http request option.
|
|
8918
8923
|
* @throws {RequiredError}
|
|
8919
8924
|
*/
|
|
8920
|
-
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
8925
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<IODescription[], any>>;
|
|
8921
8926
|
/**
|
|
8922
8927
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
8923
8928
|
* @summary Set Input/Ouput Values
|
|
@@ -8927,7 +8932,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
8927
8932
|
* @param {*} [options] Override http request option.
|
|
8928
8933
|
* @throws {RequiredError}
|
|
8929
8934
|
*/
|
|
8930
|
-
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
8935
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios176.AxiosResponse<void, any>>;
|
|
8931
8936
|
}
|
|
8932
8937
|
//#endregion
|
|
8933
8938
|
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 };
|