@wandelbots/nova-api 25.5.0-dev.13 → 25.5.0-dev.15
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/package.json +1 -1
- package/v2/api.d.ts +29 -66
- package/v2/api.js.map +1 -1
- package/v2/api.ts +28 -61
package/v2/api.ts
CHANGED
|
@@ -4377,28 +4377,28 @@ export interface ProgramRequest {
|
|
|
4377
4377
|
* @type {string}
|
|
4378
4378
|
* @memberof ProgramRequest
|
|
4379
4379
|
*/
|
|
4380
|
-
'program'
|
|
4380
|
+
'program': string;
|
|
4381
4381
|
/**
|
|
4382
|
-
*
|
|
4382
|
+
* Identifier of the default robot to use for execution
|
|
4383
4383
|
* @type {string}
|
|
4384
4384
|
* @memberof ProgramRequest
|
|
4385
4385
|
*/
|
|
4386
|
-
'default_robot'?: string
|
|
4386
|
+
'default_robot'?: string;
|
|
4387
4387
|
/**
|
|
4388
|
-
*
|
|
4388
|
+
* Identifier of the default TCP to use for execution
|
|
4389
4389
|
* @type {string}
|
|
4390
4390
|
* @memberof ProgramRequest
|
|
4391
4391
|
*/
|
|
4392
|
-
'default_tcp'?: string
|
|
4392
|
+
'default_tcp'?: string;
|
|
4393
4393
|
/**
|
|
4394
4394
|
* Initial arguments that are available within the program
|
|
4395
|
-
* @type {
|
|
4395
|
+
* @type {object}
|
|
4396
4396
|
* @memberof ProgramRequest
|
|
4397
4397
|
*/
|
|
4398
|
-
'run_args'?:
|
|
4398
|
+
'run_args'?: object;
|
|
4399
4399
|
}
|
|
4400
4400
|
/**
|
|
4401
|
-
* Holds the state of a program run.
|
|
4401
|
+
* Holds the state of a program run.
|
|
4402
4402
|
* @export
|
|
4403
4403
|
* @interface ProgramRun
|
|
4404
4404
|
*/
|
|
@@ -4416,47 +4416,47 @@ export interface ProgramRun {
|
|
|
4416
4416
|
*/
|
|
4417
4417
|
'state': ProgramRunState;
|
|
4418
4418
|
/**
|
|
4419
|
-
*
|
|
4419
|
+
* Logs of the program run
|
|
4420
4420
|
* @type {string}
|
|
4421
4421
|
* @memberof ProgramRun
|
|
4422
4422
|
*/
|
|
4423
|
-
'logs'?: string
|
|
4423
|
+
'logs'?: string;
|
|
4424
4424
|
/**
|
|
4425
|
-
*
|
|
4425
|
+
* Stdout of the program run
|
|
4426
4426
|
* @type {string}
|
|
4427
4427
|
* @memberof ProgramRun
|
|
4428
4428
|
*/
|
|
4429
|
-
'stdout'?: string
|
|
4429
|
+
'stdout'?: string;
|
|
4430
4430
|
/**
|
|
4431
4431
|
* Stores runtime variables of the run
|
|
4432
|
-
* @type {
|
|
4432
|
+
* @type {object}
|
|
4433
4433
|
* @memberof ProgramRun
|
|
4434
4434
|
*/
|
|
4435
|
-
'store'?:
|
|
4435
|
+
'store'?: object;
|
|
4436
4436
|
/**
|
|
4437
|
-
*
|
|
4437
|
+
* Error message of the program run, if any
|
|
4438
4438
|
* @type {string}
|
|
4439
4439
|
* @memberof ProgramRun
|
|
4440
4440
|
*/
|
|
4441
|
-
'error'?: string
|
|
4441
|
+
'error'?: string;
|
|
4442
4442
|
/**
|
|
4443
|
-
*
|
|
4443
|
+
* Traceback of the program run, if any
|
|
4444
4444
|
* @type {string}
|
|
4445
4445
|
* @memberof ProgramRun
|
|
4446
4446
|
*/
|
|
4447
|
-
'traceback'?: string
|
|
4447
|
+
'traceback'?: string;
|
|
4448
4448
|
/**
|
|
4449
|
-
*
|
|
4449
|
+
* Start time of the program run
|
|
4450
4450
|
* @type {number}
|
|
4451
4451
|
* @memberof ProgramRun
|
|
4452
4452
|
*/
|
|
4453
|
-
'start_time'?: number
|
|
4453
|
+
'start_time'?: number;
|
|
4454
4454
|
/**
|
|
4455
|
-
*
|
|
4455
|
+
* End time of the program run
|
|
4456
4456
|
* @type {number}
|
|
4457
4457
|
* @memberof ProgramRun
|
|
4458
4458
|
*/
|
|
4459
|
-
'end_time'?: number
|
|
4459
|
+
'end_time'?: number;
|
|
4460
4460
|
/**
|
|
4461
4461
|
* Execution results of the program run
|
|
4462
4462
|
* @type {Array<ProgramRunResult>}
|
|
@@ -4790,7 +4790,7 @@ export interface RobotLinkGeometry {
|
|
|
4790
4790
|
'geometry': Geometry;
|
|
4791
4791
|
}
|
|
4792
4792
|
/**
|
|
4793
|
-
* Collection of information on the current state of the robot
|
|
4793
|
+
* Collection of information on the current state of the robot.
|
|
4794
4794
|
* @export
|
|
4795
4795
|
* @interface RobotState
|
|
4796
4796
|
*/
|
|
@@ -4806,7 +4806,7 @@ export interface RobotState {
|
|
|
4806
4806
|
* @type {Array<number>}
|
|
4807
4807
|
* @memberof RobotState
|
|
4808
4808
|
*/
|
|
4809
|
-
'joints'?: Array<number
|
|
4809
|
+
'joints'?: Array<number>;
|
|
4810
4810
|
}
|
|
4811
4811
|
/**
|
|
4812
4812
|
* The system mode of the robot system. ### ROBOT_SYSTEM_MODE_UNDEFINED Indicates that the robot controller is currently performing a mode transition. ### ROBOT_SYSTEM_MODE_DISCONNECT There is no communication with the robot controller at all. All connections are closed. No command is sent to the robot controller while in this mode. No input/output interaction is possible in this mode! All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_MONITOR A connection to the robot controller is established to only read the robot controller state. No command is sent to the robot controller while in this mode. It is possible to receive input/output information. All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_CONTROL An active connection is established with the robot controller and the robot system is cyclic commanded to stay in its actual position. The robot controller state is received in the cycle time of the robot controller. Requests via the MotionService and JoggingService will be processed and executed in this mode. Input/Output interaction is possible in this mode! **In this mode the robot system can be commanded to move.** ### ROBOT_SYSTEM_MODE_FREE_DRIVE Like ROBOT_SYSTEM_MODE_MONITOR a connection to the robot controller is established to only read the robot controller state. The difference is that the motion groups can be moved by the user (Free Drive). Thus, the servo motors are turned on. All move requests will be rejected in this mode! **This mode is not supported by every robot!** Use [getSupportedModes](getSupportedModes) to evaluate if the device support free drive.
|
|
@@ -4877,13 +4877,6 @@ export interface RobotTcps {
|
|
|
4877
4877
|
*/
|
|
4878
4878
|
'tcps': Array<RobotTcp>;
|
|
4879
4879
|
}
|
|
4880
|
-
/**
|
|
4881
|
-
*
|
|
4882
|
-
* @export
|
|
4883
|
-
* @interface RunArgsValue
|
|
4884
|
-
*/
|
|
4885
|
-
export interface RunArgsValue {
|
|
4886
|
-
}
|
|
4887
4880
|
/**
|
|
4888
4881
|
* The safety configuration of a motion-group. Used for motion planning.
|
|
4889
4882
|
* @export
|
|
@@ -5421,25 +5414,6 @@ export interface StartOnIO {
|
|
|
5421
5414
|
}
|
|
5422
5415
|
|
|
5423
5416
|
|
|
5424
|
-
/**
|
|
5425
|
-
*
|
|
5426
|
-
* @export
|
|
5427
|
-
* @interface StoreValue
|
|
5428
|
-
*/
|
|
5429
|
-
export interface StoreValue {
|
|
5430
|
-
/**
|
|
5431
|
-
* A three-dimensional vector [x, y, z] with double precision.
|
|
5432
|
-
* @type {Array<number>}
|
|
5433
|
-
* @memberof StoreValue
|
|
5434
|
-
*/
|
|
5435
|
-
'position'?: Array<number>;
|
|
5436
|
-
/**
|
|
5437
|
-
* Defines a rotation in 3D space. A three-dimensional Vector [rx, ry, rz] with double precision. Rotation is applied around the vector. The angle of rotation equals the length of the vector.
|
|
5438
|
-
* @type {Array<number>}
|
|
5439
|
-
* @memberof StoreValue
|
|
5440
|
-
*/
|
|
5441
|
-
'orientation'?: Array<number>;
|
|
5442
|
-
}
|
|
5443
5417
|
/**
|
|
5444
5418
|
* Representing a robot pose in operational space aware of a configured TCP.
|
|
5445
5419
|
* @export
|
|
@@ -5853,10 +5827,10 @@ export interface ValidationError {
|
|
|
5853
5827
|
export interface ValidationError2 {
|
|
5854
5828
|
/**
|
|
5855
5829
|
*
|
|
5856
|
-
* @type {Array<
|
|
5830
|
+
* @type {Array<number>}
|
|
5857
5831
|
* @memberof ValidationError2
|
|
5858
5832
|
*/
|
|
5859
|
-
'loc': Array<
|
|
5833
|
+
'loc': Array<number>;
|
|
5860
5834
|
/**
|
|
5861
5835
|
*
|
|
5862
5836
|
* @type {string}
|
|
@@ -5870,13 +5844,6 @@ export interface ValidationError2 {
|
|
|
5870
5844
|
*/
|
|
5871
5845
|
'type': string;
|
|
5872
5846
|
}
|
|
5873
|
-
/**
|
|
5874
|
-
*
|
|
5875
|
-
* @export
|
|
5876
|
-
* @interface ValidationError2LocInner
|
|
5877
|
-
*/
|
|
5878
|
-
export interface ValidationError2LocInner {
|
|
5879
|
-
}
|
|
5880
5847
|
/**
|
|
5881
5848
|
* @type ValidationErrorLocInner
|
|
5882
5849
|
* @export
|
|
@@ -12257,7 +12224,7 @@ export const ProgramApiFp = function(configuration?: Configuration) {
|
|
|
12257
12224
|
* @param {*} [options] Override http request option.
|
|
12258
12225
|
* @throws {RequiredError}
|
|
12259
12226
|
*/
|
|
12260
|
-
async stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
12227
|
+
async stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
12261
12228
|
const localVarAxiosArgs = await localVarAxiosParamCreator.stopAllPrograms(cell, options);
|
|
12262
12229
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12263
12230
|
const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopAllPrograms']?.[localVarOperationServerIndex]?.url;
|
|
@@ -12362,7 +12329,7 @@ export const ProgramApiFactory = function (configuration?: Configuration, basePa
|
|
|
12362
12329
|
* @param {*} [options] Override http request option.
|
|
12363
12330
|
* @throws {RequiredError}
|
|
12364
12331
|
*/
|
|
12365
|
-
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
12332
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
12366
12333
|
return localVarFp.stopAllPrograms(cell, options).then((request) => request(axios, basePath));
|
|
12367
12334
|
},
|
|
12368
12335
|
/**
|