@wandelbots/nova-api 25.7.0-dev.27 → 25.7.0-dev.28
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 -64
- package/v2/api.js +24 -93
- package/v2/api.js.map +1 -1
- package/v2/api.ts +37 -116
package/package.json
CHANGED
package/v2/api.d.ts
CHANGED
|
@@ -1650,19 +1650,6 @@ export interface ForwardKinematicsValidationError {
|
|
|
1650
1650
|
*/
|
|
1651
1651
|
'data'?: ErrorInvalidJointCount;
|
|
1652
1652
|
}
|
|
1653
|
-
/**
|
|
1654
|
-
*
|
|
1655
|
-
* @export
|
|
1656
|
-
* @interface GetModeResponse
|
|
1657
|
-
*/
|
|
1658
|
-
export interface GetModeResponse {
|
|
1659
|
-
/**
|
|
1660
|
-
*
|
|
1661
|
-
* @type {RobotSystemMode}
|
|
1662
|
-
* @memberof GetModeResponse
|
|
1663
|
-
*/
|
|
1664
|
-
'robot_system_mode': RobotSystemMode;
|
|
1665
|
-
}
|
|
1666
1653
|
/**
|
|
1667
1654
|
*
|
|
1668
1655
|
* @export
|
|
@@ -4229,6 +4216,18 @@ export type RobotControllerConfiguration = AbbController | FanucController | Kuk
|
|
|
4229
4216
|
* @interface RobotControllerState
|
|
4230
4217
|
*/
|
|
4231
4218
|
export interface RobotControllerState {
|
|
4219
|
+
/**
|
|
4220
|
+
* Mode of communication and control between NOVA and the robot controller.
|
|
4221
|
+
* @type {RobotSystemMode}
|
|
4222
|
+
* @memberof RobotControllerState
|
|
4223
|
+
*/
|
|
4224
|
+
'mode': RobotSystemMode;
|
|
4225
|
+
/**
|
|
4226
|
+
* Last error stack encountered during initialization process or after a controller disconnect. At this stage, it\'s unclear whether the error is fatal. Evaluate `last_error` to decide whether to remove the controller using `deleteController`. Examples: - Delete required: Host resolution fails repeatedly due to an incorrect IP. - Delete not required: Temporary network delay caused a disconnect; the system will auto-reconnect.
|
|
4227
|
+
* @type {Array<string>}
|
|
4228
|
+
* @memberof RobotControllerState
|
|
4229
|
+
*/
|
|
4230
|
+
'last_error'?: Array<string>;
|
|
4232
4231
|
/**
|
|
4233
4232
|
* Timestamp indicating when the represented information was received from the robot controller.
|
|
4234
4233
|
* @type {string}
|
|
@@ -4273,16 +4272,16 @@ export interface RobotControllerState {
|
|
|
4273
4272
|
'motion_groups': Array<MotionGroupState>;
|
|
4274
4273
|
}
|
|
4275
4274
|
/**
|
|
4276
|
-
*
|
|
4275
|
+
* Defines the current system mode of the robot system, including NOVA communicating with the robot controller. ### MODE_CONTROLLER_NOT_CONFIGURED No controller with the specified identifier is configured. Call [addRobotController](addRobotController) to register a controller. ### MODE_INITIALIZING Indicates that a connection to the robot controller is established or reestablished in case of a disconnect. On success, the controller is set to MODE_MONITOR. On failure, the initialization process is retried until successful or cancelled by the user. ### MODE_MONITOR Read-only mode with an active controller connection. - Receives robot state and I/O signals - Move requests are rejected - No commands are sent to the controller ### MODE_CONTROL Active control mode. **Movement is possible in this mode** The robot is cyclically commanded to hold its current position. The robot state is received in sync with the controller cycle. Motion and jogging requests are accepted and executed. Input/Output interaction is enabled. ### MODE_FREE_DRIVE Read-only mode with servo motors enabled for manual movement (Free Drive). Move requests are rejected. Not supported by all robots: Use [getSupportedModes](getSupportedModes) to check Free Drive availability.
|
|
4277
4276
|
* @export
|
|
4278
4277
|
* @enum {string}
|
|
4279
4278
|
*/
|
|
4280
4279
|
export declare const RobotSystemMode: {
|
|
4281
|
-
readonly
|
|
4282
|
-
readonly
|
|
4283
|
-
readonly
|
|
4284
|
-
readonly
|
|
4285
|
-
readonly
|
|
4280
|
+
readonly ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED";
|
|
4281
|
+
readonly ModeInitializing: "MODE_INITIALIZING";
|
|
4282
|
+
readonly ModeMonitor: "MODE_MONITOR";
|
|
4283
|
+
readonly ModeControl: "MODE_CONTROL";
|
|
4284
|
+
readonly ModeFreeDrive: "MODE_FREE_DRIVE";
|
|
4286
4285
|
};
|
|
4287
4286
|
export type RobotSystemMode = typeof RobotSystemMode[keyof typeof RobotSystemMode];
|
|
4288
4287
|
/**
|
|
@@ -6360,15 +6359,6 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
6360
6359
|
* @throws {RequiredError}
|
|
6361
6360
|
*/
|
|
6362
6361
|
getCurrentRobotControllerState: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6363
|
-
/**
|
|
6364
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
6365
|
-
* @summary Current Mode
|
|
6366
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6367
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6368
|
-
* @param {*} [options] Override http request option.
|
|
6369
|
-
* @throws {RequiredError}
|
|
6370
|
-
*/
|
|
6371
|
-
getMode: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6372
6362
|
/**
|
|
6373
6363
|
* Get the configuration for a robot controller.
|
|
6374
6364
|
* @summary Robot Controller
|
|
@@ -6426,15 +6416,16 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
6426
6416
|
*/
|
|
6427
6417
|
streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6428
6418
|
/**
|
|
6429
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
6419
|
+
* <!-- theme: danger --> > 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.
|
|
6430
6420
|
* @summary Stream State
|
|
6431
6421
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6432
6422
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6433
6423
|
* @param {number} [responseRate]
|
|
6424
|
+
* @param {number} [addControllerTimeout]
|
|
6434
6425
|
* @param {*} [options] Override http request option.
|
|
6435
6426
|
* @throws {RequiredError}
|
|
6436
6427
|
*/
|
|
6437
|
-
streamRobotControllerState: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6428
|
+
streamRobotControllerState: (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6438
6429
|
/**
|
|
6439
6430
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
6440
6431
|
* @summary Update Robot Controller
|
|
@@ -6510,15 +6501,6 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
6510
6501
|
* @throws {RequiredError}
|
|
6511
6502
|
*/
|
|
6512
6503
|
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
6513
|
-
/**
|
|
6514
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
6515
|
-
* @summary Current Mode
|
|
6516
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6517
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6518
|
-
* @param {*} [options] Override http request option.
|
|
6519
|
-
* @throws {RequiredError}
|
|
6520
|
-
*/
|
|
6521
|
-
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetModeResponse>>;
|
|
6522
6504
|
/**
|
|
6523
6505
|
* Get the configuration for a robot controller.
|
|
6524
6506
|
* @summary Robot Controller
|
|
@@ -6576,15 +6558,16 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
6576
6558
|
*/
|
|
6577
6559
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
6578
6560
|
/**
|
|
6579
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
6561
|
+
* <!-- theme: danger --> > 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.
|
|
6580
6562
|
* @summary Stream State
|
|
6581
6563
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6582
6564
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6583
6565
|
* @param {number} [responseRate]
|
|
6566
|
+
* @param {number} [addControllerTimeout]
|
|
6584
6567
|
* @param {*} [options] Override http request option.
|
|
6585
6568
|
* @throws {RequiredError}
|
|
6586
6569
|
*/
|
|
6587
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
6570
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
6588
6571
|
/**
|
|
6589
6572
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
6590
6573
|
* @summary Update Robot Controller
|
|
@@ -6660,15 +6643,6 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
6660
6643
|
* @throws {RequiredError}
|
|
6661
6644
|
*/
|
|
6662
6645
|
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
6663
|
-
/**
|
|
6664
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
6665
|
-
* @summary Current Mode
|
|
6666
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6667
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6668
|
-
* @param {*} [options] Override http request option.
|
|
6669
|
-
* @throws {RequiredError}
|
|
6670
|
-
*/
|
|
6671
|
-
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<GetModeResponse>;
|
|
6672
6646
|
/**
|
|
6673
6647
|
* Get the configuration for a robot controller.
|
|
6674
6648
|
* @summary Robot Controller
|
|
@@ -6726,15 +6700,16 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
6726
6700
|
*/
|
|
6727
6701
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
6728
6702
|
/**
|
|
6729
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
6703
|
+
* <!-- theme: danger --> > 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.
|
|
6730
6704
|
* @summary Stream State
|
|
6731
6705
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6732
6706
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6733
6707
|
* @param {number} [responseRate]
|
|
6708
|
+
* @param {number} [addControllerTimeout]
|
|
6734
6709
|
* @param {*} [options] Override http request option.
|
|
6735
6710
|
* @throws {RequiredError}
|
|
6736
6711
|
*/
|
|
6737
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
6712
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
6738
6713
|
/**
|
|
6739
6714
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
6740
6715
|
* @summary Update Robot Controller
|
|
@@ -6818,16 +6793,6 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
6818
6793
|
* @memberof ControllerApi
|
|
6819
6794
|
*/
|
|
6820
6795
|
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
|
|
6821
|
-
/**
|
|
6822
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
6823
|
-
* @summary Current Mode
|
|
6824
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6825
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6826
|
-
* @param {*} [options] Override http request option.
|
|
6827
|
-
* @throws {RequiredError}
|
|
6828
|
-
* @memberof ControllerApi
|
|
6829
|
-
*/
|
|
6830
|
-
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetModeResponse, any>>;
|
|
6831
6796
|
/**
|
|
6832
6797
|
* Get the configuration for a robot controller.
|
|
6833
6798
|
* @summary Robot Controller
|
|
@@ -6891,16 +6856,17 @@ export declare class ControllerApi extends BaseAPI {
|
|
|
6891
6856
|
*/
|
|
6892
6857
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
|
|
6893
6858
|
/**
|
|
6894
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
6859
|
+
* <!-- theme: danger --> > 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.
|
|
6895
6860
|
* @summary Stream State
|
|
6896
6861
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6897
6862
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
6898
6863
|
* @param {number} [responseRate]
|
|
6864
|
+
* @param {number} [addControllerTimeout]
|
|
6899
6865
|
* @param {*} [options] Override http request option.
|
|
6900
6866
|
* @throws {RequiredError}
|
|
6901
6867
|
* @memberof ControllerApi
|
|
6902
6868
|
*/
|
|
6903
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
|
|
6869
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
|
|
6904
6870
|
/**
|
|
6905
6871
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
6906
6872
|
* @summary Update Robot Controller
|
package/v2/api.js
CHANGED
|
@@ -374,16 +374,16 @@ export const ReleaseChannel = {
|
|
|
374
374
|
Next: 'next'
|
|
375
375
|
};
|
|
376
376
|
/**
|
|
377
|
-
*
|
|
377
|
+
* Defines the current system mode of the robot system, including NOVA communicating with the robot controller. ### MODE_CONTROLLER_NOT_CONFIGURED No controller with the specified identifier is configured. Call [addRobotController](addRobotController) to register a controller. ### MODE_INITIALIZING Indicates that a connection to the robot controller is established or reestablished in case of a disconnect. On success, the controller is set to MODE_MONITOR. On failure, the initialization process is retried until successful or cancelled by the user. ### MODE_MONITOR Read-only mode with an active controller connection. - Receives robot state and I/O signals - Move requests are rejected - No commands are sent to the controller ### MODE_CONTROL Active control mode. **Movement is possible in this mode** The robot is cyclically commanded to hold its current position. The robot state is received in sync with the controller cycle. Motion and jogging requests are accepted and executed. Input/Output interaction is enabled. ### MODE_FREE_DRIVE Read-only mode with servo motors enabled for manual movement (Free Drive). Move requests are rejected. Not supported by all robots: Use [getSupportedModes](getSupportedModes) to check Free Drive availability.
|
|
378
378
|
* @export
|
|
379
379
|
* @enum {string}
|
|
380
380
|
*/
|
|
381
381
|
export const RobotSystemMode = {
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
382
|
+
ModeControllerNotConfigured: 'MODE_CONTROLLER_NOT_CONFIGURED',
|
|
383
|
+
ModeInitializing: 'MODE_INITIALIZING',
|
|
384
|
+
ModeMonitor: 'MODE_MONITOR',
|
|
385
|
+
ModeControl: 'MODE_CONTROL',
|
|
386
|
+
ModeFreeDrive: 'MODE_FREE_DRIVE'
|
|
387
387
|
};
|
|
388
388
|
/**
|
|
389
389
|
* Current safety state of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - SAFETY_STATE_NORMAL - SAFETY_STATE_REDUCED All other modes are considered as non-operational.
|
|
@@ -2979,45 +2979,6 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
2979
2979
|
options: localVarRequestOptions,
|
|
2980
2980
|
};
|
|
2981
2981
|
},
|
|
2982
|
-
/**
|
|
2983
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
2984
|
-
* @summary Current Mode
|
|
2985
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2986
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
2987
|
-
* @param {*} [options] Override http request option.
|
|
2988
|
-
* @throws {RequiredError}
|
|
2989
|
-
*/
|
|
2990
|
-
getMode: async (cell, controller, options = {}) => {
|
|
2991
|
-
// verify required parameter 'cell' is not null or undefined
|
|
2992
|
-
assertParamExists('getMode', 'cell', cell);
|
|
2993
|
-
// verify required parameter 'controller' is not null or undefined
|
|
2994
|
-
assertParamExists('getMode', 'controller', controller);
|
|
2995
|
-
const localVarPath = `/cells/{cell}/controllers/{controller}/mode`
|
|
2996
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
2997
|
-
.replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
|
|
2998
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2999
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3000
|
-
let baseOptions;
|
|
3001
|
-
if (configuration) {
|
|
3002
|
-
baseOptions = configuration.baseOptions;
|
|
3003
|
-
}
|
|
3004
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
3005
|
-
const localVarHeaderParameter = {};
|
|
3006
|
-
const localVarQueryParameter = {};
|
|
3007
|
-
// authentication BasicAuth required
|
|
3008
|
-
// http basic authentication required
|
|
3009
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3010
|
-
// authentication BearerAuth required
|
|
3011
|
-
// http bearer authentication required
|
|
3012
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3013
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3014
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3015
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
3016
|
-
return {
|
|
3017
|
-
url: toPathString(localVarUrlObj),
|
|
3018
|
-
options: localVarRequestOptions,
|
|
3019
|
-
};
|
|
3020
|
-
},
|
|
3021
2982
|
/**
|
|
3022
2983
|
* Get the configuration for a robot controller.
|
|
3023
2984
|
* @summary Robot Controller
|
|
@@ -3263,15 +3224,16 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
3263
3224
|
};
|
|
3264
3225
|
},
|
|
3265
3226
|
/**
|
|
3266
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
3227
|
+
* <!-- theme: danger --> > 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.
|
|
3267
3228
|
* @summary Stream State
|
|
3268
3229
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3269
3230
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3270
3231
|
* @param {number} [responseRate]
|
|
3232
|
+
* @param {number} [addControllerTimeout]
|
|
3271
3233
|
* @param {*} [options] Override http request option.
|
|
3272
3234
|
* @throws {RequiredError}
|
|
3273
3235
|
*/
|
|
3274
|
-
streamRobotControllerState: async (cell, controller, responseRate, options = {}) => {
|
|
3236
|
+
streamRobotControllerState: async (cell, controller, responseRate, addControllerTimeout, options = {}) => {
|
|
3275
3237
|
// verify required parameter 'cell' is not null or undefined
|
|
3276
3238
|
assertParamExists('streamRobotControllerState', 'cell', cell);
|
|
3277
3239
|
// verify required parameter 'controller' is not null or undefined
|
|
@@ -3297,6 +3259,9 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
|
|
|
3297
3259
|
if (responseRate !== undefined) {
|
|
3298
3260
|
localVarQueryParameter['response_rate'] = responseRate;
|
|
3299
3261
|
}
|
|
3262
|
+
if (addControllerTimeout !== undefined) {
|
|
3263
|
+
localVarQueryParameter['add_controller_timeout'] = addControllerTimeout;
|
|
3264
|
+
}
|
|
3300
3265
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3301
3266
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3302
3267
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -3450,20 +3415,6 @@ export const ControllerApiFp = function (configuration) {
|
|
|
3450
3415
|
const localVarOperationServerBasePath = operationServerMap['ControllerApi.getCurrentRobotControllerState']?.[localVarOperationServerIndex]?.url;
|
|
3451
3416
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3452
3417
|
},
|
|
3453
|
-
/**
|
|
3454
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
3455
|
-
* @summary Current Mode
|
|
3456
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3457
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3458
|
-
* @param {*} [options] Override http request option.
|
|
3459
|
-
* @throws {RequiredError}
|
|
3460
|
-
*/
|
|
3461
|
-
async getMode(cell, controller, options) {
|
|
3462
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getMode(cell, controller, options);
|
|
3463
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3464
|
-
const localVarOperationServerBasePath = operationServerMap['ControllerApi.getMode']?.[localVarOperationServerIndex]?.url;
|
|
3465
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3466
|
-
},
|
|
3467
3418
|
/**
|
|
3468
3419
|
* Get the configuration for a robot controller.
|
|
3469
3420
|
* @summary Robot Controller
|
|
@@ -3551,16 +3502,17 @@ export const ControllerApiFp = function (configuration) {
|
|
|
3551
3502
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3552
3503
|
},
|
|
3553
3504
|
/**
|
|
3554
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
3505
|
+
* <!-- theme: danger --> > 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.
|
|
3555
3506
|
* @summary Stream State
|
|
3556
3507
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3557
3508
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3558
3509
|
* @param {number} [responseRate]
|
|
3510
|
+
* @param {number} [addControllerTimeout]
|
|
3559
3511
|
* @param {*} [options] Override http request option.
|
|
3560
3512
|
* @throws {RequiredError}
|
|
3561
3513
|
*/
|
|
3562
|
-
async streamRobotControllerState(cell, controller, responseRate, options) {
|
|
3563
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.streamRobotControllerState(cell, controller, responseRate, options);
|
|
3514
|
+
async streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options) {
|
|
3515
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options);
|
|
3564
3516
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3565
3517
|
const localVarOperationServerBasePath = operationServerMap['ControllerApi.streamRobotControllerState']?.[localVarOperationServerIndex]?.url;
|
|
3566
3518
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3660,17 +3612,6 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
3660
3612
|
getCurrentRobotControllerState(cell, controller, options) {
|
|
3661
3613
|
return localVarFp.getCurrentRobotControllerState(cell, controller, options).then((request) => request(axios, basePath));
|
|
3662
3614
|
},
|
|
3663
|
-
/**
|
|
3664
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
3665
|
-
* @summary Current Mode
|
|
3666
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3667
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3668
|
-
* @param {*} [options] Override http request option.
|
|
3669
|
-
* @throws {RequiredError}
|
|
3670
|
-
*/
|
|
3671
|
-
getMode(cell, controller, options) {
|
|
3672
|
-
return localVarFp.getMode(cell, controller, options).then((request) => request(axios, basePath));
|
|
3673
|
-
},
|
|
3674
3615
|
/**
|
|
3675
3616
|
* Get the configuration for a robot controller.
|
|
3676
3617
|
* @summary Robot Controller
|
|
@@ -3740,16 +3681,17 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
3740
3681
|
return localVarFp.streamFreeDrive(cell, controller, responseRate, options).then((request) => request(axios, basePath));
|
|
3741
3682
|
},
|
|
3742
3683
|
/**
|
|
3743
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
3684
|
+
* <!-- theme: danger --> > 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.
|
|
3744
3685
|
* @summary Stream State
|
|
3745
3686
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3746
3687
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3747
3688
|
* @param {number} [responseRate]
|
|
3689
|
+
* @param {number} [addControllerTimeout]
|
|
3748
3690
|
* @param {*} [options] Override http request option.
|
|
3749
3691
|
* @throws {RequiredError}
|
|
3750
3692
|
*/
|
|
3751
|
-
streamRobotControllerState(cell, controller, responseRate, options) {
|
|
3752
|
-
return localVarFp.streamRobotControllerState(cell, controller, responseRate, options).then((request) => request(axios, basePath));
|
|
3693
|
+
streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options) {
|
|
3694
|
+
return localVarFp.streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(axios, basePath));
|
|
3753
3695
|
},
|
|
3754
3696
|
/**
|
|
3755
3697
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
@@ -3849,18 +3791,6 @@ export class ControllerApi extends BaseAPI {
|
|
|
3849
3791
|
getCurrentRobotControllerState(cell, controller, options) {
|
|
3850
3792
|
return ControllerApiFp(this.configuration).getCurrentRobotControllerState(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
3851
3793
|
}
|
|
3852
|
-
/**
|
|
3853
|
-
* Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
|
|
3854
|
-
* @summary Current Mode
|
|
3855
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3856
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3857
|
-
* @param {*} [options] Override http request option.
|
|
3858
|
-
* @throws {RequiredError}
|
|
3859
|
-
* @memberof ControllerApi
|
|
3860
|
-
*/
|
|
3861
|
-
getMode(cell, controller, options) {
|
|
3862
|
-
return ControllerApiFp(this.configuration).getMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
3863
|
-
}
|
|
3864
3794
|
/**
|
|
3865
3795
|
* Get the configuration for a robot controller.
|
|
3866
3796
|
* @summary Robot Controller
|
|
@@ -3936,17 +3866,18 @@ export class ControllerApi extends BaseAPI {
|
|
|
3936
3866
|
return ControllerApiFp(this.configuration).streamFreeDrive(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
|
|
3937
3867
|
}
|
|
3938
3868
|
/**
|
|
3939
|
-
* <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
|
|
3869
|
+
* <!-- theme: danger --> > 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.
|
|
3940
3870
|
* @summary Stream State
|
|
3941
3871
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3942
3872
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3943
3873
|
* @param {number} [responseRate]
|
|
3874
|
+
* @param {number} [addControllerTimeout]
|
|
3944
3875
|
* @param {*} [options] Override http request option.
|
|
3945
3876
|
* @throws {RequiredError}
|
|
3946
3877
|
* @memberof ControllerApi
|
|
3947
3878
|
*/
|
|
3948
|
-
streamRobotControllerState(cell, controller, responseRate, options) {
|
|
3949
|
-
return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
|
|
3879
|
+
streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options) {
|
|
3880
|
+
return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
3950
3881
|
}
|
|
3951
3882
|
/**
|
|
3952
3883
|
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|