@wandelbots/nova-api 25.6.0-dev.18 → 25.6.0-dev.19
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 +30 -12
- package/v2/api.js +4 -4
- package/v2/api.js.map +1 -1
- package/v2/api.ts +30 -12
package/package.json
CHANGED
package/v2/api.d.ts
CHANGED
|
@@ -271,7 +271,7 @@ export interface BooleanValue {
|
|
|
271
271
|
* @type {boolean}
|
|
272
272
|
* @memberof BooleanValue
|
|
273
273
|
*/
|
|
274
|
-
'
|
|
274
|
+
'value': boolean;
|
|
275
275
|
/**
|
|
276
276
|
*
|
|
277
277
|
* @type {string}
|
|
@@ -1326,7 +1326,7 @@ export interface Flag {
|
|
|
1326
1326
|
'active': boolean;
|
|
1327
1327
|
}
|
|
1328
1328
|
/**
|
|
1329
|
-
*
|
|
1329
|
+
*
|
|
1330
1330
|
* @export
|
|
1331
1331
|
* @interface FloatValue
|
|
1332
1332
|
*/
|
|
@@ -1336,9 +1336,9 @@ export interface FloatValue {
|
|
|
1336
1336
|
* @type {number}
|
|
1337
1337
|
* @memberof FloatValue
|
|
1338
1338
|
*/
|
|
1339
|
-
'
|
|
1339
|
+
'value': number;
|
|
1340
1340
|
/**
|
|
1341
|
-
*
|
|
1341
|
+
* Input/Output floating number representation.
|
|
1342
1342
|
* @type {string}
|
|
1343
1343
|
* @memberof FloatValue
|
|
1344
1344
|
*/
|
|
@@ -1455,7 +1455,7 @@ export interface IOBooleanValue {
|
|
|
1455
1455
|
* @type {boolean}
|
|
1456
1456
|
* @memberof IOBooleanValue
|
|
1457
1457
|
*/
|
|
1458
|
-
'
|
|
1458
|
+
'value': boolean;
|
|
1459
1459
|
/**
|
|
1460
1460
|
*
|
|
1461
1461
|
* @type {string}
|
|
@@ -1560,7 +1560,7 @@ export interface IOFloatValue {
|
|
|
1560
1560
|
* @type {number}
|
|
1561
1561
|
* @memberof IOFloatValue
|
|
1562
1562
|
*/
|
|
1563
|
-
'
|
|
1563
|
+
'value': number;
|
|
1564
1564
|
/**
|
|
1565
1565
|
*
|
|
1566
1566
|
* @type {string}
|
|
@@ -1589,7 +1589,7 @@ export interface IOIntegerValue {
|
|
|
1589
1589
|
* @type {string}
|
|
1590
1590
|
* @memberof IOIntegerValue
|
|
1591
1591
|
*/
|
|
1592
|
-
'
|
|
1592
|
+
'value': string;
|
|
1593
1593
|
/**
|
|
1594
1594
|
*
|
|
1595
1595
|
* @type {string}
|
|
@@ -1859,7 +1859,7 @@ export interface IntegerValue {
|
|
|
1859
1859
|
* @type {string}
|
|
1860
1860
|
* @memberof IntegerValue
|
|
1861
1861
|
*/
|
|
1862
|
-
'
|
|
1862
|
+
'value': string;
|
|
1863
1863
|
/**
|
|
1864
1864
|
*
|
|
1865
1865
|
* @type {string}
|
|
@@ -3692,6 +3692,12 @@ export interface ProgramRun {
|
|
|
3692
3692
|
* @memberof ProgramRun
|
|
3693
3693
|
*/
|
|
3694
3694
|
'execution_results'?: Array<Array<MotionState>>;
|
|
3695
|
+
/**
|
|
3696
|
+
* Result of the executed program. Content depends on the program type.
|
|
3697
|
+
* @type {object}
|
|
3698
|
+
* @memberof ProgramRun
|
|
3699
|
+
*/
|
|
3700
|
+
'result'?: object;
|
|
3695
3701
|
}
|
|
3696
3702
|
/**
|
|
3697
3703
|
*
|
|
@@ -4412,6 +4418,18 @@ export interface StreamIOValuesResponse {
|
|
|
4412
4418
|
* @memberof StreamIOValuesResponse
|
|
4413
4419
|
*/
|
|
4414
4420
|
'io_values': Array<IOValue>;
|
|
4421
|
+
/**
|
|
4422
|
+
* Timestamp indicating when the represented information was received from the robot controller.
|
|
4423
|
+
* @type {string}
|
|
4424
|
+
* @memberof StreamIOValuesResponse
|
|
4425
|
+
*/
|
|
4426
|
+
'timestamp': string;
|
|
4427
|
+
/**
|
|
4428
|
+
* Sequence number of the controller state. It starts with 0 upon establishing the connection with a physical controller. The sequence number is reset when the connection to the physical controller is closed and re-established.
|
|
4429
|
+
* @type {number}
|
|
4430
|
+
* @memberof StreamIOValuesResponse
|
|
4431
|
+
*/
|
|
4432
|
+
'sequence_number': number;
|
|
4415
4433
|
}
|
|
4416
4434
|
/**
|
|
4417
4435
|
*
|
|
@@ -6201,7 +6219,7 @@ export declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration
|
|
|
6201
6219
|
*/
|
|
6202
6220
|
streamIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6203
6221
|
/**
|
|
6204
|
-
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only
|
|
6222
|
+
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only value to 10. If you want to wait until an analog input (\"AI_2\") is greater than 5.0, you would set io to \"AI_2\" comparison_type to COMPARISON_GREATER and only value to 5.0. If you want to wait until a digital input (\"DI_3\") is true, you would set io to \"DI_3\" comparison_type to COMPARISON_EQUAL and only value to true.
|
|
6205
6223
|
* @summary Wait For
|
|
6206
6224
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6207
6225
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6260,7 +6278,7 @@ export declare const ControllerInputsOutputsApiFp: (configuration?: Configuratio
|
|
|
6260
6278
|
*/
|
|
6261
6279
|
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamIOValuesResponse>>;
|
|
6262
6280
|
/**
|
|
6263
|
-
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only
|
|
6281
|
+
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only value to 10. If you want to wait until an analog input (\"AI_2\") is greater than 5.0, you would set io to \"AI_2\" comparison_type to COMPARISON_GREATER and only value to 5.0. If you want to wait until a digital input (\"DI_3\") is true, you would set io to \"DI_3\" comparison_type to COMPARISON_EQUAL and only value to true.
|
|
6264
6282
|
* @summary Wait For
|
|
6265
6283
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6266
6284
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6319,7 +6337,7 @@ export declare const ControllerInputsOutputsApiFactory: (configuration?: Configu
|
|
|
6319
6337
|
*/
|
|
6320
6338
|
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<StreamIOValuesResponse>;
|
|
6321
6339
|
/**
|
|
6322
|
-
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only
|
|
6340
|
+
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only value to 10. If you want to wait until an analog input (\"AI_2\") is greater than 5.0, you would set io to \"AI_2\" comparison_type to COMPARISON_GREATER and only value to 5.0. If you want to wait until a digital input (\"DI_3\") is true, you would set io to \"DI_3\" comparison_type to COMPARISON_EQUAL and only value to true.
|
|
6323
6341
|
* @summary Wait For
|
|
6324
6342
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6325
6343
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6384,7 +6402,7 @@ export declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
6384
6402
|
*/
|
|
6385
6403
|
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StreamIOValuesResponse, any>>;
|
|
6386
6404
|
/**
|
|
6387
|
-
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only
|
|
6405
|
+
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only value to 10. If you want to wait until an analog input (\"AI_2\") is greater than 5.0, you would set io to \"AI_2\" comparison_type to COMPARISON_GREATER and only value to 5.0. If you want to wait until a digital input (\"DI_3\") is true, you would set io to \"DI_3\" comparison_type to COMPARISON_EQUAL and only value to true.
|
|
6388
6406
|
* @summary Wait For
|
|
6389
6407
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6390
6408
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
package/v2/api.js
CHANGED
|
@@ -2964,7 +2964,7 @@ export const ControllerInputsOutputsApiAxiosParamCreator = function (configurati
|
|
|
2964
2964
|
};
|
|
2965
2965
|
},
|
|
2966
2966
|
/**
|
|
2967
|
-
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only
|
|
2967
|
+
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only value to 10. If you want to wait until an analog input (\"AI_2\") is greater than 5.0, you would set io to \"AI_2\" comparison_type to COMPARISON_GREATER and only value to 5.0. If you want to wait until a digital input (\"DI_3\") is true, you would set io to \"DI_3\" comparison_type to COMPARISON_EQUAL and only value to true.
|
|
2968
2968
|
* @summary Wait For
|
|
2969
2969
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2970
2970
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3080,7 +3080,7 @@ export const ControllerInputsOutputsApiFp = function (configuration) {
|
|
|
3080
3080
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3081
3081
|
},
|
|
3082
3082
|
/**
|
|
3083
|
-
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only
|
|
3083
|
+
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only value to 10. If you want to wait until an analog input (\"AI_2\") is greater than 5.0, you would set io to \"AI_2\" comparison_type to COMPARISON_GREATER and only value to 5.0. If you want to wait until a digital input (\"DI_3\") is true, you would set io to \"DI_3\" comparison_type to COMPARISON_EQUAL and only value to true.
|
|
3084
3084
|
* @summary Wait For
|
|
3085
3085
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3086
3086
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3155,7 +3155,7 @@ export const ControllerInputsOutputsApiFactory = function (configuration, basePa
|
|
|
3155
3155
|
return localVarFp.streamIOValues(cell, controller, ios, options).then((request) => request(axios, basePath));
|
|
3156
3156
|
},
|
|
3157
3157
|
/**
|
|
3158
|
-
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only
|
|
3158
|
+
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only value to 10. If you want to wait until an analog input (\"AI_2\") is greater than 5.0, you would set io to \"AI_2\" comparison_type to COMPARISON_GREATER and only value to 5.0. If you want to wait until a digital input (\"DI_3\") is true, you would set io to \"DI_3\" comparison_type to COMPARISON_EQUAL and only value to true.
|
|
3159
3159
|
* @summary Wait For
|
|
3160
3160
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3161
3161
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3231,7 +3231,7 @@ export class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
3231
3231
|
return ControllerInputsOutputsApiFp(this.configuration).streamIOValues(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
|
|
3232
3232
|
}
|
|
3233
3233
|
/**
|
|
3234
|
-
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only
|
|
3234
|
+
* 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: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only value to 10. If you want to wait until an analog input (\"AI_2\") is greater than 5.0, you would set io to \"AI_2\" comparison_type to COMPARISON_GREATER and only value to 5.0. If you want to wait until a digital input (\"DI_3\") is true, you would set io to \"DI_3\" comparison_type to COMPARISON_EQUAL and only value to true.
|
|
3235
3235
|
* @summary Wait For
|
|
3236
3236
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3237
3237
|
* @param {string} controller Unique identifier to address a controller in the cell.
|