@wandelbots/nova-api 25.7.0-dev.27 → 25.7.0-dev.29

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/v1/api.ts CHANGED
@@ -7528,6 +7528,7 @@ export const VirtualControllerTypes = {
7528
7528
  FanucCrx20ial: 'fanuc-crx20ial',
7529
7529
  FanucCrx25ia: 'fanuc-crx25ia',
7530
7530
  FanucCrx30ia: 'fanuc-crx30ia',
7531
+ FanucCrx5ia: 'fanuc-crx5ia',
7531
7532
  FanucLrMate200iD: 'fanuc-lr_mate_200iD',
7532
7533
  FanucLrMate200iD4S: 'fanuc-lr_mate_200iD4S',
7533
7534
  FanucLrMate200iD7L: 'fanuc-lr_mate_200iD7L',
@@ -7535,6 +7536,7 @@ export const VirtualControllerTypes = {
7535
7536
  FanucM10iD16S: 'fanuc-m10iD16S',
7536
7537
  FanucM20iD25: 'fanuc-m20iD25',
7537
7538
  FanucM20iD35: 'fanuc-m20iD35',
7539
+ FanucM710iC20L: 'fanuc-m710iC20L',
7538
7540
  FanucM900iB280L: 'fanuc-m900iB280L',
7539
7541
  FanucM900iB360E: 'fanuc-m900iB360E',
7540
7542
  FanucR2000ic125l: 'fanuc-r2000ic125l',
@@ -20633,6 +20635,7 @@ export const GetDefaultLinkChainMotionGroupModelEnum = {
20633
20635
  FanucM20iD12L: 'FANUC_M20iD12L',
20634
20636
  FanucM20iD25: 'FANUC_M20iD25',
20635
20637
  FanucM20iD35: 'FANUC_M20iD35',
20638
+ FanucM710iC20L: 'FANUC_M710iC20L',
20636
20639
  FanucM900iB280L: 'FANUC_M900iB280L',
20637
20640
  FanucM900iB360E: 'FANUC_M900iB360E',
20638
20641
  FanucR2000iC125L: 'FANUC_R2000iC125L',
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
- * 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.
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 RobotSystemModeUndefined: "ROBOT_SYSTEM_MODE_UNDEFINED";
4282
- readonly RobotSystemModeDisconnect: "ROBOT_SYSTEM_MODE_DISCONNECT";
4283
- readonly RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR";
4284
- readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
4285
- readonly RobotSystemModeFreeDrive: "ROBOT_SYSTEM_MODE_FREE_DRIVE";
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
  /**
@@ -5081,7 +5080,7 @@ export interface VirtualController {
5081
5080
  * @type {string}
5082
5081
  * @memberof VirtualController
5083
5082
  */
5084
- 'position'?: string;
5083
+ 'initial_joint_position'?: string;
5085
5084
  }
5086
5085
  export declare const VirtualControllerKindEnum: {
5087
5086
  readonly VirtualController: "VirtualController";
@@ -5127,6 +5126,7 @@ export declare const VirtualControllerTypes: {
5127
5126
  readonly FanucCrx20ial: "fanuc-crx20ial";
5128
5127
  readonly FanucCrx25ia: "fanuc-crx25ia";
5129
5128
  readonly FanucCrx30ia: "fanuc-crx30ia";
5129
+ readonly FanucCrx5ia: "fanuc-crx5ia";
5130
5130
  readonly FanucLrMate200iD: "fanuc-lr_mate_200iD";
5131
5131
  readonly FanucLrMate200iD4S: "fanuc-lr_mate_200iD4S";
5132
5132
  readonly FanucLrMate200iD7L: "fanuc-lr_mate_200iD7L";
@@ -5134,6 +5134,7 @@ export declare const VirtualControllerTypes: {
5134
5134
  readonly FanucM10iD16S: "fanuc-m10iD16S";
5135
5135
  readonly FanucM20iD25: "fanuc-m20iD25";
5136
5136
  readonly FanucM20iD35: "fanuc-m20iD35";
5137
+ readonly FanucM710iC20L: "fanuc-m710iC20L";
5137
5138
  readonly FanucM900iB280L: "fanuc-m900iB280L";
5138
5139
  readonly FanucM900iB360E: "fanuc-m900iB360E";
5139
5140
  readonly FanucR2000ic125l: "fanuc-r2000ic125l";
@@ -6360,15 +6361,6 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
6360
6361
  * @throws {RequiredError}
6361
6362
  */
6362
6363
  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
6364
  /**
6373
6365
  * Get the configuration for a robot controller.
6374
6366
  * @summary Robot Controller
@@ -6426,15 +6418,16 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
6426
6418
  */
6427
6419
  streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6428
6420
  /**
6429
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
6421
+ * <!-- 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
6422
  * @summary Stream State
6431
6423
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6432
6424
  * @param {string} controller Unique identifier to address a controller in the cell.
6433
6425
  * @param {number} [responseRate]
6426
+ * @param {number} [addControllerTimeout]
6434
6427
  * @param {*} [options] Override http request option.
6435
6428
  * @throws {RequiredError}
6436
6429
  */
6437
- streamRobotControllerState: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6430
+ streamRobotControllerState: (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6438
6431
  /**
6439
6432
  * 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
6433
  * @summary Update Robot Controller
@@ -6510,15 +6503,6 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
6510
6503
  * @throws {RequiredError}
6511
6504
  */
6512
6505
  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
6506
  /**
6523
6507
  * Get the configuration for a robot controller.
6524
6508
  * @summary Robot Controller
@@ -6576,15 +6560,16 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
6576
6560
  */
6577
6561
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
6578
6562
  /**
6579
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
6563
+ * <!-- 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
6564
  * @summary Stream State
6581
6565
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6582
6566
  * @param {string} controller Unique identifier to address a controller in the cell.
6583
6567
  * @param {number} [responseRate]
6568
+ * @param {number} [addControllerTimeout]
6584
6569
  * @param {*} [options] Override http request option.
6585
6570
  * @throws {RequiredError}
6586
6571
  */
6587
- streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
6572
+ streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
6588
6573
  /**
6589
6574
  * 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
6575
  * @summary Update Robot Controller
@@ -6660,15 +6645,6 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
6660
6645
  * @throws {RequiredError}
6661
6646
  */
6662
6647
  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
6648
  /**
6673
6649
  * Get the configuration for a robot controller.
6674
6650
  * @summary Robot Controller
@@ -6726,15 +6702,16 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
6726
6702
  */
6727
6703
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
6728
6704
  /**
6729
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
6705
+ * <!-- 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
6706
  * @summary Stream State
6731
6707
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6732
6708
  * @param {string} controller Unique identifier to address a controller in the cell.
6733
6709
  * @param {number} [responseRate]
6710
+ * @param {number} [addControllerTimeout]
6734
6711
  * @param {*} [options] Override http request option.
6735
6712
  * @throws {RequiredError}
6736
6713
  */
6737
- streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
6714
+ streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
6738
6715
  /**
6739
6716
  * 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
6717
  * @summary Update Robot Controller
@@ -6818,16 +6795,6 @@ export declare class ControllerApi extends BaseAPI {
6818
6795
  * @memberof ControllerApi
6819
6796
  */
6820
6797
  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
6798
  /**
6832
6799
  * Get the configuration for a robot controller.
6833
6800
  * @summary Robot Controller
@@ -6891,16 +6858,17 @@ export declare class ControllerApi extends BaseAPI {
6891
6858
  */
6892
6859
  streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
6893
6860
  /**
6894
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
6861
+ * <!-- 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
6862
  * @summary Stream State
6896
6863
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6897
6864
  * @param {string} controller Unique identifier to address a controller in the cell.
6898
6865
  * @param {number} [responseRate]
6866
+ * @param {number} [addControllerTimeout]
6899
6867
  * @param {*} [options] Override http request option.
6900
6868
  * @throws {RequiredError}
6901
6869
  * @memberof ControllerApi
6902
6870
  */
6903
- streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
6871
+ streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotControllerState, any>>;
6904
6872
  /**
6905
6873
  * 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
6874
  * @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
- * 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.
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
- RobotSystemModeUndefined: 'ROBOT_SYSTEM_MODE_UNDEFINED',
383
- RobotSystemModeDisconnect: 'ROBOT_SYSTEM_MODE_DISCONNECT',
384
- RobotSystemModeMonitor: 'ROBOT_SYSTEM_MODE_MONITOR',
385
- RobotSystemModeControl: 'ROBOT_SYSTEM_MODE_CONTROL',
386
- RobotSystemModeFreeDrive: 'ROBOT_SYSTEM_MODE_FREE_DRIVE'
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.
@@ -571,6 +571,7 @@ export const VirtualControllerTypes = {
571
571
  FanucCrx20ial: 'fanuc-crx20ial',
572
572
  FanucCrx25ia: 'fanuc-crx25ia',
573
573
  FanucCrx30ia: 'fanuc-crx30ia',
574
+ FanucCrx5ia: 'fanuc-crx5ia',
574
575
  FanucLrMate200iD: 'fanuc-lr_mate_200iD',
575
576
  FanucLrMate200iD4S: 'fanuc-lr_mate_200iD4S',
576
577
  FanucLrMate200iD7L: 'fanuc-lr_mate_200iD7L',
@@ -578,6 +579,7 @@ export const VirtualControllerTypes = {
578
579
  FanucM10iD16S: 'fanuc-m10iD16S',
579
580
  FanucM20iD25: 'fanuc-m20iD25',
580
581
  FanucM20iD35: 'fanuc-m20iD35',
582
+ FanucM710iC20L: 'fanuc-m710iC20L',
581
583
  FanucM900iB280L: 'fanuc-m900iB280L',
582
584
  FanucM900iB360E: 'fanuc-m900iB360E',
583
585
  FanucR2000ic125l: 'fanuc-r2000ic125l',
@@ -2979,45 +2981,6 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
2979
2981
  options: localVarRequestOptions,
2980
2982
  };
2981
2983
  },
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
2984
  /**
3022
2985
  * Get the configuration for a robot controller.
3023
2986
  * @summary Robot Controller
@@ -3263,15 +3226,16 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
3263
3226
  };
3264
3227
  },
3265
3228
  /**
3266
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
3229
+ * <!-- 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
3230
  * @summary Stream State
3268
3231
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3269
3232
  * @param {string} controller Unique identifier to address a controller in the cell.
3270
3233
  * @param {number} [responseRate]
3234
+ * @param {number} [addControllerTimeout]
3271
3235
  * @param {*} [options] Override http request option.
3272
3236
  * @throws {RequiredError}
3273
3237
  */
3274
- streamRobotControllerState: async (cell, controller, responseRate, options = {}) => {
3238
+ streamRobotControllerState: async (cell, controller, responseRate, addControllerTimeout, options = {}) => {
3275
3239
  // verify required parameter 'cell' is not null or undefined
3276
3240
  assertParamExists('streamRobotControllerState', 'cell', cell);
3277
3241
  // verify required parameter 'controller' is not null or undefined
@@ -3297,6 +3261,9 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
3297
3261
  if (responseRate !== undefined) {
3298
3262
  localVarQueryParameter['response_rate'] = responseRate;
3299
3263
  }
3264
+ if (addControllerTimeout !== undefined) {
3265
+ localVarQueryParameter['add_controller_timeout'] = addControllerTimeout;
3266
+ }
3300
3267
  setSearchParams(localVarUrlObj, localVarQueryParameter);
3301
3268
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3302
3269
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -3450,20 +3417,6 @@ export const ControllerApiFp = function (configuration) {
3450
3417
  const localVarOperationServerBasePath = operationServerMap['ControllerApi.getCurrentRobotControllerState']?.[localVarOperationServerIndex]?.url;
3451
3418
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3452
3419
  },
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
3420
  /**
3468
3421
  * Get the configuration for a robot controller.
3469
3422
  * @summary Robot Controller
@@ -3551,16 +3504,17 @@ export const ControllerApiFp = function (configuration) {
3551
3504
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3552
3505
  },
3553
3506
  /**
3554
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
3507
+ * <!-- 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
3508
  * @summary Stream State
3556
3509
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3557
3510
  * @param {string} controller Unique identifier to address a controller in the cell.
3558
3511
  * @param {number} [responseRate]
3512
+ * @param {number} [addControllerTimeout]
3559
3513
  * @param {*} [options] Override http request option.
3560
3514
  * @throws {RequiredError}
3561
3515
  */
3562
- async streamRobotControllerState(cell, controller, responseRate, options) {
3563
- const localVarAxiosArgs = await localVarAxiosParamCreator.streamRobotControllerState(cell, controller, responseRate, options);
3516
+ async streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options) {
3517
+ const localVarAxiosArgs = await localVarAxiosParamCreator.streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options);
3564
3518
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3565
3519
  const localVarOperationServerBasePath = operationServerMap['ControllerApi.streamRobotControllerState']?.[localVarOperationServerIndex]?.url;
3566
3520
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3660,17 +3614,6 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
3660
3614
  getCurrentRobotControllerState(cell, controller, options) {
3661
3615
  return localVarFp.getCurrentRobotControllerState(cell, controller, options).then((request) => request(axios, basePath));
3662
3616
  },
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
3617
  /**
3675
3618
  * Get the configuration for a robot controller.
3676
3619
  * @summary Robot Controller
@@ -3740,16 +3683,17 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
3740
3683
  return localVarFp.streamFreeDrive(cell, controller, responseRate, options).then((request) => request(axios, basePath));
3741
3684
  },
3742
3685
  /**
3743
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
3686
+ * <!-- 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
3687
  * @summary Stream State
3745
3688
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3746
3689
  * @param {string} controller Unique identifier to address a controller in the cell.
3747
3690
  * @param {number} [responseRate]
3691
+ * @param {number} [addControllerTimeout]
3748
3692
  * @param {*} [options] Override http request option.
3749
3693
  * @throws {RequiredError}
3750
3694
  */
3751
- streamRobotControllerState(cell, controller, responseRate, options) {
3752
- return localVarFp.streamRobotControllerState(cell, controller, responseRate, options).then((request) => request(axios, basePath));
3695
+ streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options) {
3696
+ return localVarFp.streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(axios, basePath));
3753
3697
  },
3754
3698
  /**
3755
3699
  * 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 +3793,6 @@ export class ControllerApi extends BaseAPI {
3849
3793
  getCurrentRobotControllerState(cell, controller, options) {
3850
3794
  return ControllerApiFp(this.configuration).getCurrentRobotControllerState(cell, controller, options).then((request) => request(this.axios, this.basePath));
3851
3795
  }
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
3796
  /**
3865
3797
  * Get the configuration for a robot controller.
3866
3798
  * @summary Robot Controller
@@ -3936,17 +3868,18 @@ export class ControllerApi extends BaseAPI {
3936
3868
  return ControllerApiFp(this.configuration).streamFreeDrive(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
3937
3869
  }
3938
3870
  /**
3939
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
3871
+ * <!-- 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
3872
  * @summary Stream State
3941
3873
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3942
3874
  * @param {string} controller Unique identifier to address a controller in the cell.
3943
3875
  * @param {number} [responseRate]
3876
+ * @param {number} [addControllerTimeout]
3944
3877
  * @param {*} [options] Override http request option.
3945
3878
  * @throws {RequiredError}
3946
3879
  * @memberof ControllerApi
3947
3880
  */
3948
- streamRobotControllerState(cell, controller, responseRate, options) {
3949
- return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
3881
+ streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options) {
3882
+ return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(this.axios, this.basePath));
3950
3883
  }
3951
3884
  /**
3952
3885
  * 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.