@wandelbots/nova-api 25.5.0-dev.14 → 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/package.json
CHANGED
package/v2/api.d.ts
CHANGED
|
@@ -4234,30 +4234,28 @@ export interface ProgramRequest {
|
|
|
4234
4234
|
* @type {string}
|
|
4235
4235
|
* @memberof ProgramRequest
|
|
4236
4236
|
*/
|
|
4237
|
-
'program'
|
|
4237
|
+
'program': string;
|
|
4238
4238
|
/**
|
|
4239
|
-
*
|
|
4239
|
+
* Identifier of the default robot to use for execution
|
|
4240
4240
|
* @type {string}
|
|
4241
4241
|
* @memberof ProgramRequest
|
|
4242
4242
|
*/
|
|
4243
|
-
'default_robot'?: string
|
|
4243
|
+
'default_robot'?: string;
|
|
4244
4244
|
/**
|
|
4245
|
-
*
|
|
4245
|
+
* Identifier of the default TCP to use for execution
|
|
4246
4246
|
* @type {string}
|
|
4247
4247
|
* @memberof ProgramRequest
|
|
4248
4248
|
*/
|
|
4249
|
-
'default_tcp'?: string
|
|
4249
|
+
'default_tcp'?: string;
|
|
4250
4250
|
/**
|
|
4251
4251
|
* Initial arguments that are available within the program
|
|
4252
|
-
* @type {
|
|
4252
|
+
* @type {object}
|
|
4253
4253
|
* @memberof ProgramRequest
|
|
4254
4254
|
*/
|
|
4255
|
-
'run_args'?:
|
|
4256
|
-
[key: string]: RunArgsValue;
|
|
4257
|
-
};
|
|
4255
|
+
'run_args'?: object;
|
|
4258
4256
|
}
|
|
4259
4257
|
/**
|
|
4260
|
-
* Holds the state of a program run.
|
|
4258
|
+
* Holds the state of a program run.
|
|
4261
4259
|
* @export
|
|
4262
4260
|
* @interface ProgramRun
|
|
4263
4261
|
*/
|
|
@@ -4275,49 +4273,47 @@ export interface ProgramRun {
|
|
|
4275
4273
|
*/
|
|
4276
4274
|
'state': ProgramRunState;
|
|
4277
4275
|
/**
|
|
4278
|
-
*
|
|
4276
|
+
* Logs of the program run
|
|
4279
4277
|
* @type {string}
|
|
4280
4278
|
* @memberof ProgramRun
|
|
4281
4279
|
*/
|
|
4282
|
-
'logs'?: string
|
|
4280
|
+
'logs'?: string;
|
|
4283
4281
|
/**
|
|
4284
|
-
*
|
|
4282
|
+
* Stdout of the program run
|
|
4285
4283
|
* @type {string}
|
|
4286
4284
|
* @memberof ProgramRun
|
|
4287
4285
|
*/
|
|
4288
|
-
'stdout'?: string
|
|
4286
|
+
'stdout'?: string;
|
|
4289
4287
|
/**
|
|
4290
4288
|
* Stores runtime variables of the run
|
|
4291
|
-
* @type {
|
|
4289
|
+
* @type {object}
|
|
4292
4290
|
* @memberof ProgramRun
|
|
4293
4291
|
*/
|
|
4294
|
-
'store'?:
|
|
4295
|
-
[key: string]: StoreValue;
|
|
4296
|
-
};
|
|
4292
|
+
'store'?: object;
|
|
4297
4293
|
/**
|
|
4298
|
-
*
|
|
4294
|
+
* Error message of the program run, if any
|
|
4299
4295
|
* @type {string}
|
|
4300
4296
|
* @memberof ProgramRun
|
|
4301
4297
|
*/
|
|
4302
|
-
'error'?: string
|
|
4298
|
+
'error'?: string;
|
|
4303
4299
|
/**
|
|
4304
|
-
*
|
|
4300
|
+
* Traceback of the program run, if any
|
|
4305
4301
|
* @type {string}
|
|
4306
4302
|
* @memberof ProgramRun
|
|
4307
4303
|
*/
|
|
4308
|
-
'traceback'?: string
|
|
4304
|
+
'traceback'?: string;
|
|
4309
4305
|
/**
|
|
4310
|
-
*
|
|
4306
|
+
* Start time of the program run
|
|
4311
4307
|
* @type {number}
|
|
4312
4308
|
* @memberof ProgramRun
|
|
4313
4309
|
*/
|
|
4314
|
-
'start_time'?: number
|
|
4310
|
+
'start_time'?: number;
|
|
4315
4311
|
/**
|
|
4316
|
-
*
|
|
4312
|
+
* End time of the program run
|
|
4317
4313
|
* @type {number}
|
|
4318
4314
|
* @memberof ProgramRun
|
|
4319
4315
|
*/
|
|
4320
|
-
'end_time'?: number
|
|
4316
|
+
'end_time'?: number;
|
|
4321
4317
|
/**
|
|
4322
4318
|
* Execution results of the program run
|
|
4323
4319
|
* @type {Array<ProgramRunResult>}
|
|
@@ -4630,7 +4626,7 @@ export interface RobotLinkGeometry {
|
|
|
4630
4626
|
'geometry': Geometry;
|
|
4631
4627
|
}
|
|
4632
4628
|
/**
|
|
4633
|
-
* Collection of information on the current state of the robot
|
|
4629
|
+
* Collection of information on the current state of the robot.
|
|
4634
4630
|
* @export
|
|
4635
4631
|
* @interface RobotState
|
|
4636
4632
|
*/
|
|
@@ -4646,7 +4642,7 @@ export interface RobotState {
|
|
|
4646
4642
|
* @type {Array<number>}
|
|
4647
4643
|
* @memberof RobotState
|
|
4648
4644
|
*/
|
|
4649
|
-
'joints'?: Array<number
|
|
4645
|
+
'joints'?: Array<number>;
|
|
4650
4646
|
}
|
|
4651
4647
|
/**
|
|
4652
4648
|
* 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.
|
|
@@ -4711,13 +4707,6 @@ export interface RobotTcps {
|
|
|
4711
4707
|
*/
|
|
4712
4708
|
'tcps': Array<RobotTcp>;
|
|
4713
4709
|
}
|
|
4714
|
-
/**
|
|
4715
|
-
*
|
|
4716
|
-
* @export
|
|
4717
|
-
* @interface RunArgsValue
|
|
4718
|
-
*/
|
|
4719
|
-
export interface RunArgsValue {
|
|
4720
|
-
}
|
|
4721
4710
|
/**
|
|
4722
4711
|
* The safety configuration of a motion-group. Used for motion planning.
|
|
4723
4712
|
* @export
|
|
@@ -5213,25 +5202,6 @@ export interface StartOnIO {
|
|
|
5213
5202
|
*/
|
|
5214
5203
|
'comparator': Comparator;
|
|
5215
5204
|
}
|
|
5216
|
-
/**
|
|
5217
|
-
*
|
|
5218
|
-
* @export
|
|
5219
|
-
* @interface StoreValue
|
|
5220
|
-
*/
|
|
5221
|
-
export interface StoreValue {
|
|
5222
|
-
/**
|
|
5223
|
-
* A three-dimensional vector [x, y, z] with double precision.
|
|
5224
|
-
* @type {Array<number>}
|
|
5225
|
-
* @memberof StoreValue
|
|
5226
|
-
*/
|
|
5227
|
-
'position'?: Array<number>;
|
|
5228
|
-
/**
|
|
5229
|
-
* 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.
|
|
5230
|
-
* @type {Array<number>}
|
|
5231
|
-
* @memberof StoreValue
|
|
5232
|
-
*/
|
|
5233
|
-
'orientation'?: Array<number>;
|
|
5234
|
-
}
|
|
5235
5205
|
/**
|
|
5236
5206
|
* Representing a robot pose in operational space aware of a configured TCP.
|
|
5237
5207
|
* @export
|
|
@@ -5621,10 +5591,10 @@ export interface ValidationError {
|
|
|
5621
5591
|
export interface ValidationError2 {
|
|
5622
5592
|
/**
|
|
5623
5593
|
*
|
|
5624
|
-
* @type {Array<
|
|
5594
|
+
* @type {Array<number>}
|
|
5625
5595
|
* @memberof ValidationError2
|
|
5626
5596
|
*/
|
|
5627
|
-
'loc': Array<
|
|
5597
|
+
'loc': Array<number>;
|
|
5628
5598
|
/**
|
|
5629
5599
|
*
|
|
5630
5600
|
* @type {string}
|
|
@@ -5638,13 +5608,6 @@ export interface ValidationError2 {
|
|
|
5638
5608
|
*/
|
|
5639
5609
|
'type': string;
|
|
5640
5610
|
}
|
|
5641
|
-
/**
|
|
5642
|
-
*
|
|
5643
|
-
* @export
|
|
5644
|
-
* @interface ValidationError2LocInner
|
|
5645
|
-
*/
|
|
5646
|
-
export interface ValidationError2LocInner {
|
|
5647
|
-
}
|
|
5648
5611
|
/**
|
|
5649
5612
|
* @type ValidationErrorLocInner
|
|
5650
5613
|
* @export
|
|
@@ -8607,7 +8570,7 @@ export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
|
8607
8570
|
* @param {*} [options] Override http request option.
|
|
8608
8571
|
* @throws {RequiredError}
|
|
8609
8572
|
*/
|
|
8610
|
-
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
8573
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8611
8574
|
/**
|
|
8612
8575
|
* Stop a specific program run.
|
|
8613
8576
|
* @summary Stop program run
|
|
@@ -8683,7 +8646,7 @@ export declare const ProgramApiFactory: (configuration?: Configuration, basePath
|
|
|
8683
8646
|
* @param {*} [options] Override http request option.
|
|
8684
8647
|
* @throws {RequiredError}
|
|
8685
8648
|
*/
|
|
8686
|
-
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
8649
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8687
8650
|
/**
|
|
8688
8651
|
* Stop a specific program run.
|
|
8689
8652
|
* @summary Stop program run
|
|
@@ -8767,7 +8730,7 @@ export declare class ProgramApi extends BaseAPI {
|
|
|
8767
8730
|
* @throws {RequiredError}
|
|
8768
8731
|
* @memberof ProgramApi
|
|
8769
8732
|
*/
|
|
8770
|
-
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
8733
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8771
8734
|
/**
|
|
8772
8735
|
* Stop a specific program run.
|
|
8773
8736
|
* @summary Stop program run
|