@wandelbots/nova-api 25.11.0-dev.3 → 25.11.0-dev.30
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/dist/v1/index.cjs +1 -1
- package/dist/v1/index.d.cts +183 -183
- package/dist/v1/index.d.ts +183 -183
- package/dist/v1/index.js +1 -1
- package/dist/v2/index.cjs +98 -6
- package/dist/v2/index.d.cts +93 -25
- package/dist/v2/index.d.ts +93 -25
- package/dist/v2/index.js +98 -6
- package/package.json +1 -1
package/dist/v2/index.d.ts
CHANGED
|
@@ -7,7 +7,7 @@ import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
|
7
7
|
* Wandelbots NOVA API
|
|
8
8
|
* Interact with robots in an easy and intuitive way.
|
|
9
9
|
*
|
|
10
|
-
* The version of the OpenAPI document: 2.
|
|
10
|
+
* The version of the OpenAPI document: 2.1.0 dev
|
|
11
11
|
*
|
|
12
12
|
*
|
|
13
13
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1846,6 +1846,10 @@ interface MotionGroupDescription {
|
|
|
1846
1846
|
* The DH parameters describing the motion group geometry, starting from base.
|
|
1847
1847
|
*/
|
|
1848
1848
|
'dh_parameters'?: Array<DHParameter>;
|
|
1849
|
+
/**
|
|
1850
|
+
* The serial number of the motion group, if available. If not available, the serial number of the robot controller. If not available, empty.
|
|
1851
|
+
*/
|
|
1852
|
+
'serial_number'?: string;
|
|
1849
1853
|
}
|
|
1850
1854
|
interface MotionGroupInfo {
|
|
1851
1855
|
/**
|
|
@@ -3606,6 +3610,22 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3606
3610
|
* @throws {RequiredError}
|
|
3607
3611
|
*/
|
|
3608
3612
|
clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3613
|
+
/**
|
|
3614
|
+
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3615
|
+
* @summary Remove all MODBUS Input/Outputs
|
|
3616
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3617
|
+
* @param {*} [options] Override http request option.
|
|
3618
|
+
* @throws {RequiredError}
|
|
3619
|
+
*/
|
|
3620
|
+
deleteAllModbusIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3621
|
+
/**
|
|
3622
|
+
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
3623
|
+
* @summary Remove all PROFINET Input/Outputs
|
|
3624
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3625
|
+
* @param {*} [options] Override http request option.
|
|
3626
|
+
* @throws {RequiredError}
|
|
3627
|
+
*/
|
|
3628
|
+
deleteAllProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3609
3629
|
/**
|
|
3610
3630
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3611
3631
|
* @summary Remove MODBUS Input/Ouptut
|
|
@@ -3753,6 +3773,22 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3753
3773
|
* @throws {RequiredError}
|
|
3754
3774
|
*/
|
|
3755
3775
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3776
|
+
/**
|
|
3777
|
+
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3778
|
+
* @summary Remove all MODBUS Input/Outputs
|
|
3779
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3780
|
+
* @param {*} [options] Override http request option.
|
|
3781
|
+
* @throws {RequiredError}
|
|
3782
|
+
*/
|
|
3783
|
+
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3784
|
+
/**
|
|
3785
|
+
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
3786
|
+
* @summary Remove all PROFINET Input/Outputs
|
|
3787
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3788
|
+
* @param {*} [options] Override http request option.
|
|
3789
|
+
* @throws {RequiredError}
|
|
3790
|
+
*/
|
|
3791
|
+
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3756
3792
|
/**
|
|
3757
3793
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3758
3794
|
* @summary Remove MODBUS Input/Ouptut
|
|
@@ -3900,6 +3936,22 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
3900
3936
|
* @throws {RequiredError}
|
|
3901
3937
|
*/
|
|
3902
3938
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3939
|
+
/**
|
|
3940
|
+
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3941
|
+
* @summary Remove all MODBUS Input/Outputs
|
|
3942
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3943
|
+
* @param {*} [options] Override http request option.
|
|
3944
|
+
* @throws {RequiredError}
|
|
3945
|
+
*/
|
|
3946
|
+
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3947
|
+
/**
|
|
3948
|
+
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
3949
|
+
* @summary Remove all PROFINET Input/Outputs
|
|
3950
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3951
|
+
* @param {*} [options] Override http request option.
|
|
3952
|
+
* @throws {RequiredError}
|
|
3953
|
+
*/
|
|
3954
|
+
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3903
3955
|
/**
|
|
3904
3956
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3905
3957
|
* @summary Remove MODBUS Input/Ouptut
|
|
@@ -4047,6 +4099,22 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4047
4099
|
* @throws {RequiredError}
|
|
4048
4100
|
*/
|
|
4049
4101
|
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4102
|
+
/**
|
|
4103
|
+
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4104
|
+
* @summary Remove all MODBUS Input/Outputs
|
|
4105
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4106
|
+
* @param {*} [options] Override http request option.
|
|
4107
|
+
* @throws {RequiredError}
|
|
4108
|
+
*/
|
|
4109
|
+
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4110
|
+
/**
|
|
4111
|
+
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
4112
|
+
* @summary Remove all PROFINET Input/Outputs
|
|
4113
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4114
|
+
* @param {*} [options] Override http request option.
|
|
4115
|
+
* @throws {RequiredError}
|
|
4116
|
+
*/
|
|
4117
|
+
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4050
4118
|
/**
|
|
4051
4119
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4052
4120
|
* @summary Remove MODBUS Input/Ouptut
|
|
@@ -5212,7 +5280,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5212
5280
|
*/
|
|
5213
5281
|
declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5214
5282
|
/**
|
|
5215
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
5283
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the (state stream)[streamMotionGroupState], which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
5216
5284
|
* @summary Execute Jogging
|
|
5217
5285
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5218
5286
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5227,7 +5295,7 @@ declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
5227
5295
|
*/
|
|
5228
5296
|
declare const JoggingApiFp: (configuration?: Configuration) => {
|
|
5229
5297
|
/**
|
|
5230
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
5298
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the (state stream)[streamMotionGroupState], which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
5231
5299
|
* @summary Execute Jogging
|
|
5232
5300
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5233
5301
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5242,7 +5310,7 @@ declare const JoggingApiFp: (configuration?: Configuration) => {
|
|
|
5242
5310
|
*/
|
|
5243
5311
|
declare const JoggingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5244
5312
|
/**
|
|
5245
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
5313
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the (state stream)[streamMotionGroupState], which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
5246
5314
|
* @summary Execute Jogging
|
|
5247
5315
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5248
5316
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5257,7 +5325,7 @@ declare const JoggingApiFactory: (configuration?: Configuration, basePath?: stri
|
|
|
5257
5325
|
*/
|
|
5258
5326
|
declare class JoggingApi extends BaseAPI {
|
|
5259
5327
|
/**
|
|
5260
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
5328
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the (state stream)[streamMotionGroupState], which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
5261
5329
|
* @summary Execute Jogging
|
|
5262
5330
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5263
5331
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5738,7 +5806,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
5738
5806
|
*/
|
|
5739
5807
|
declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5740
5808
|
/**
|
|
5741
|
-
* Get details of a program.
|
|
5809
|
+
* <!-- theme: danger --> > **Experimental** Get details of a program.
|
|
5742
5810
|
* @summary Get program
|
|
5743
5811
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5744
5812
|
* @param {string} program
|
|
@@ -5747,7 +5815,7 @@ declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
5747
5815
|
*/
|
|
5748
5816
|
getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5749
5817
|
/**
|
|
5750
|
-
* List details of all existing programs.
|
|
5818
|
+
* <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
5751
5819
|
* @summary List programs
|
|
5752
5820
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5753
5821
|
* @param {*} [options] Override http request option.
|
|
@@ -5755,7 +5823,7 @@ declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
5755
5823
|
*/
|
|
5756
5824
|
listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5757
5825
|
/**
|
|
5758
|
-
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5826
|
+
* <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5759
5827
|
* @summary Start the program
|
|
5760
5828
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5761
5829
|
* @param {string} program
|
|
@@ -5765,7 +5833,7 @@ declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
5765
5833
|
*/
|
|
5766
5834
|
startProgram: (cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5767
5835
|
/**
|
|
5768
|
-
* Stop a specific program run.
|
|
5836
|
+
* <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
5769
5837
|
* @summary Stop program run
|
|
5770
5838
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5771
5839
|
* @param {string} program
|
|
@@ -5779,7 +5847,7 @@ declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
5779
5847
|
*/
|
|
5780
5848
|
declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
5781
5849
|
/**
|
|
5782
|
-
* Get details of a program.
|
|
5850
|
+
* <!-- theme: danger --> > **Experimental** Get details of a program.
|
|
5783
5851
|
* @summary Get program
|
|
5784
5852
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5785
5853
|
* @param {string} program
|
|
@@ -5788,7 +5856,7 @@ declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
|
5788
5856
|
*/
|
|
5789
5857
|
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>>;
|
|
5790
5858
|
/**
|
|
5791
|
-
* List details of all existing programs.
|
|
5859
|
+
* <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
5792
5860
|
* @summary List programs
|
|
5793
5861
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5794
5862
|
* @param {*} [options] Override http request option.
|
|
@@ -5796,7 +5864,7 @@ declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
|
5796
5864
|
*/
|
|
5797
5865
|
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>>;
|
|
5798
5866
|
/**
|
|
5799
|
-
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5867
|
+
* <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5800
5868
|
* @summary Start the program
|
|
5801
5869
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5802
5870
|
* @param {string} program
|
|
@@ -5806,7 +5874,7 @@ declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
|
5806
5874
|
*/
|
|
5807
5875
|
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
5808
5876
|
/**
|
|
5809
|
-
* Stop a specific program run.
|
|
5877
|
+
* <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
5810
5878
|
* @summary Stop program run
|
|
5811
5879
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5812
5880
|
* @param {string} program
|
|
@@ -5820,7 +5888,7 @@ declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
|
5820
5888
|
*/
|
|
5821
5889
|
declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5822
5890
|
/**
|
|
5823
|
-
* Get details of a program.
|
|
5891
|
+
* <!-- theme: danger --> > **Experimental** Get details of a program.
|
|
5824
5892
|
* @summary Get program
|
|
5825
5893
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5826
5894
|
* @param {string} program
|
|
@@ -5829,7 +5897,7 @@ declare const ProgramApiFactory: (configuration?: Configuration, basePath?: stri
|
|
|
5829
5897
|
*/
|
|
5830
5898
|
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program>;
|
|
5831
5899
|
/**
|
|
5832
|
-
* List details of all existing programs.
|
|
5900
|
+
* <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
5833
5901
|
* @summary List programs
|
|
5834
5902
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5835
5903
|
* @param {*} [options] Override http request option.
|
|
@@ -5837,7 +5905,7 @@ declare const ProgramApiFactory: (configuration?: Configuration, basePath?: stri
|
|
|
5837
5905
|
*/
|
|
5838
5906
|
listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>>;
|
|
5839
5907
|
/**
|
|
5840
|
-
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5908
|
+
* <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5841
5909
|
* @summary Start the program
|
|
5842
5910
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5843
5911
|
* @param {string} program
|
|
@@ -5847,7 +5915,7 @@ declare const ProgramApiFactory: (configuration?: Configuration, basePath?: stri
|
|
|
5847
5915
|
*/
|
|
5848
5916
|
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
5849
5917
|
/**
|
|
5850
|
-
* Stop a specific program run.
|
|
5918
|
+
* <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
5851
5919
|
* @summary Stop program run
|
|
5852
5920
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5853
5921
|
* @param {string} program
|
|
@@ -5861,7 +5929,7 @@ declare const ProgramApiFactory: (configuration?: Configuration, basePath?: stri
|
|
|
5861
5929
|
*/
|
|
5862
5930
|
declare class ProgramApi extends BaseAPI {
|
|
5863
5931
|
/**
|
|
5864
|
-
* Get details of a program.
|
|
5932
|
+
* <!-- theme: danger --> > **Experimental** Get details of a program.
|
|
5865
5933
|
* @summary Get program
|
|
5866
5934
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5867
5935
|
* @param {string} program
|
|
@@ -5870,7 +5938,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
5870
5938
|
*/
|
|
5871
5939
|
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program, any>>;
|
|
5872
5940
|
/**
|
|
5873
|
-
* List details of all existing programs.
|
|
5941
|
+
* <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
5874
5942
|
* @summary List programs
|
|
5875
5943
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5876
5944
|
* @param {*} [options] Override http request option.
|
|
@@ -5878,7 +5946,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
5878
5946
|
*/
|
|
5879
5947
|
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program[], any>>;
|
|
5880
5948
|
/**
|
|
5881
|
-
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5949
|
+
* <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5882
5950
|
* @summary Start the program
|
|
5883
5951
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5884
5952
|
* @param {string} program
|
|
@@ -5888,7 +5956,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
5888
5956
|
*/
|
|
5889
5957
|
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
|
|
5890
5958
|
/**
|
|
5891
|
-
* Stop a specific program run.
|
|
5959
|
+
* <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
5892
5960
|
* @summary Stop program run
|
|
5893
5961
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5894
5962
|
* @param {string} program
|
|
@@ -7486,7 +7554,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7486
7554
|
*/
|
|
7487
7555
|
declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7488
7556
|
/**
|
|
7489
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time
|
|
7557
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
|
|
7490
7558
|
* @summary Execute Trajectory
|
|
7491
7559
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7492
7560
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7501,7 +7569,7 @@ declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configur
|
|
|
7501
7569
|
*/
|
|
7502
7570
|
declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
|
|
7503
7571
|
/**
|
|
7504
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time
|
|
7572
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
|
|
7505
7573
|
* @summary Execute Trajectory
|
|
7506
7574
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7507
7575
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7516,7 +7584,7 @@ declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
|
|
|
7516
7584
|
*/
|
|
7517
7585
|
declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7518
7586
|
/**
|
|
7519
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time
|
|
7587
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
|
|
7520
7588
|
* @summary Execute Trajectory
|
|
7521
7589
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7522
7590
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7531,7 +7599,7 @@ declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, bas
|
|
|
7531
7599
|
*/
|
|
7532
7600
|
declare class TrajectoryExecutionApi extends BaseAPI {
|
|
7533
7601
|
/**
|
|
7534
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time
|
|
7602
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
|
|
7535
7603
|
* @summary Execute Trajectory
|
|
7536
7604
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7537
7605
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
package/dist/v2/index.js
CHANGED
|
@@ -1011,6 +1011,60 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1011
1011
|
options: localVarRequestOptions
|
|
1012
1012
|
};
|
|
1013
1013
|
},
|
|
1014
|
+
deleteAllModbusIOs: async (cell, options = {}) => {
|
|
1015
|
+
assertParamExists("deleteAllModbusIOs", "cell", cell);
|
|
1016
|
+
const localVarPath = `/cells/{cell}/bus-ios/modbus/ios`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1017
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1018
|
+
let baseOptions;
|
|
1019
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
1020
|
+
const localVarRequestOptions = {
|
|
1021
|
+
method: "DELETE",
|
|
1022
|
+
...baseOptions,
|
|
1023
|
+
...options
|
|
1024
|
+
};
|
|
1025
|
+
const localVarHeaderParameter = {};
|
|
1026
|
+
const localVarQueryParameter = {};
|
|
1027
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1028
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1029
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1030
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1031
|
+
localVarRequestOptions.headers = {
|
|
1032
|
+
...localVarHeaderParameter,
|
|
1033
|
+
...headersFromBaseOptions,
|
|
1034
|
+
...options.headers
|
|
1035
|
+
};
|
|
1036
|
+
return {
|
|
1037
|
+
url: toPathString(localVarUrlObj),
|
|
1038
|
+
options: localVarRequestOptions
|
|
1039
|
+
};
|
|
1040
|
+
},
|
|
1041
|
+
deleteAllProfinetIOs: async (cell, options = {}) => {
|
|
1042
|
+
assertParamExists("deleteAllProfinetIOs", "cell", cell);
|
|
1043
|
+
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1044
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1045
|
+
let baseOptions;
|
|
1046
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
1047
|
+
const localVarRequestOptions = {
|
|
1048
|
+
method: "DELETE",
|
|
1049
|
+
...baseOptions,
|
|
1050
|
+
...options
|
|
1051
|
+
};
|
|
1052
|
+
const localVarHeaderParameter = {};
|
|
1053
|
+
const localVarQueryParameter = {};
|
|
1054
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1055
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1056
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1057
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1058
|
+
localVarRequestOptions.headers = {
|
|
1059
|
+
...localVarHeaderParameter,
|
|
1060
|
+
...headersFromBaseOptions,
|
|
1061
|
+
...options.headers
|
|
1062
|
+
};
|
|
1063
|
+
return {
|
|
1064
|
+
url: toPathString(localVarUrlObj),
|
|
1065
|
+
options: localVarRequestOptions
|
|
1066
|
+
};
|
|
1067
|
+
},
|
|
1014
1068
|
deleteModbusIO: async (cell, io, options = {}) => {
|
|
1015
1069
|
assertParamExists("deleteModbusIO", "cell", cell);
|
|
1016
1070
|
assertParamExists("deleteModbusIO", "io", io);
|
|
@@ -1378,6 +1432,18 @@ const BUSInputsOutputsApiFp = function(configuration) {
|
|
|
1378
1432
|
const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.clearBusIOService"]?.[localVarOperationServerIndex]?.url;
|
|
1379
1433
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1380
1434
|
},
|
|
1435
|
+
async deleteAllModbusIOs(cell, options) {
|
|
1436
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAllModbusIOs(cell, options);
|
|
1437
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1438
|
+
const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.deleteAllModbusIOs"]?.[localVarOperationServerIndex]?.url;
|
|
1439
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1440
|
+
},
|
|
1441
|
+
async deleteAllProfinetIOs(cell, options) {
|
|
1442
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAllProfinetIOs(cell, options);
|
|
1443
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1444
|
+
const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.deleteAllProfinetIOs"]?.[localVarOperationServerIndex]?.url;
|
|
1445
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1446
|
+
},
|
|
1381
1447
|
async deleteModbusIO(cell, io, options) {
|
|
1382
1448
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteModbusIO(cell, io, options);
|
|
1383
1449
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -1470,6 +1536,12 @@ const BUSInputsOutputsApiFactory = function(configuration, basePath, axios) {
|
|
|
1470
1536
|
clearBusIOService(cell, completionTimeout, options) {
|
|
1471
1537
|
return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
|
|
1472
1538
|
},
|
|
1539
|
+
deleteAllModbusIOs(cell, options) {
|
|
1540
|
+
return localVarFp.deleteAllModbusIOs(cell, options).then((request) => request(axios, basePath));
|
|
1541
|
+
},
|
|
1542
|
+
deleteAllProfinetIOs(cell, options) {
|
|
1543
|
+
return localVarFp.deleteAllProfinetIOs(cell, options).then((request) => request(axios, basePath));
|
|
1544
|
+
},
|
|
1473
1545
|
deleteModbusIO(cell, io, options) {
|
|
1474
1546
|
return localVarFp.deleteModbusIO(cell, io, options).then((request) => request(axios, basePath));
|
|
1475
1547
|
},
|
|
@@ -1560,6 +1632,26 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1560
1632
|
return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
1561
1633
|
}
|
|
1562
1634
|
/**
|
|
1635
|
+
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
1636
|
+
* @summary Remove all MODBUS Input/Outputs
|
|
1637
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1638
|
+
* @param {*} [options] Override http request option.
|
|
1639
|
+
* @throws {RequiredError}
|
|
1640
|
+
*/
|
|
1641
|
+
deleteAllModbusIOs(cell, options) {
|
|
1642
|
+
return BUSInputsOutputsApiFp(this.configuration).deleteAllModbusIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1643
|
+
}
|
|
1644
|
+
/**
|
|
1645
|
+
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
1646
|
+
* @summary Remove all PROFINET Input/Outputs
|
|
1647
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1648
|
+
* @param {*} [options] Override http request option.
|
|
1649
|
+
* @throws {RequiredError}
|
|
1650
|
+
*/
|
|
1651
|
+
deleteAllProfinetIOs(cell, options) {
|
|
1652
|
+
return BUSInputsOutputsApiFp(this.configuration).deleteAllProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1653
|
+
}
|
|
1654
|
+
/**
|
|
1563
1655
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
1564
1656
|
* @summary Remove MODBUS Input/Ouptut
|
|
1565
1657
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -3123,7 +3215,7 @@ const JoggingApiFactory = function(configuration, basePath, axios) {
|
|
|
3123
3215
|
*/
|
|
3124
3216
|
var JoggingApi = class extends BaseAPI {
|
|
3125
3217
|
/**
|
|
3126
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
3218
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the (state stream)[streamMotionGroupState], which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
3127
3219
|
* @summary Execute Jogging
|
|
3128
3220
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3129
3221
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3946,7 +4038,7 @@ const ProgramApiFactory = function(configuration, basePath, axios) {
|
|
|
3946
4038
|
*/
|
|
3947
4039
|
var ProgramApi = class extends BaseAPI {
|
|
3948
4040
|
/**
|
|
3949
|
-
* Get details of a program.
|
|
4041
|
+
* <!-- theme: danger --> > **Experimental** Get details of a program.
|
|
3950
4042
|
* @summary Get program
|
|
3951
4043
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3952
4044
|
* @param {string} program
|
|
@@ -3957,7 +4049,7 @@ var ProgramApi = class extends BaseAPI {
|
|
|
3957
4049
|
return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
|
|
3958
4050
|
}
|
|
3959
4051
|
/**
|
|
3960
|
-
* List details of all existing programs.
|
|
4052
|
+
* <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
3961
4053
|
* @summary List programs
|
|
3962
4054
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3963
4055
|
* @param {*} [options] Override http request option.
|
|
@@ -3967,7 +4059,7 @@ var ProgramApi = class extends BaseAPI {
|
|
|
3967
4059
|
return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
|
|
3968
4060
|
}
|
|
3969
4061
|
/**
|
|
3970
|
-
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
4062
|
+
* <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
3971
4063
|
* @summary Start the program
|
|
3972
4064
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3973
4065
|
* @param {string} program
|
|
@@ -3979,7 +4071,7 @@ var ProgramApi = class extends BaseAPI {
|
|
|
3979
4071
|
return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3980
4072
|
}
|
|
3981
4073
|
/**
|
|
3982
|
-
* Stop a specific program run.
|
|
4074
|
+
* <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
3983
4075
|
* @summary Stop program run
|
|
3984
4076
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3985
4077
|
* @param {string} program
|
|
@@ -6099,7 +6191,7 @@ const TrajectoryExecutionApiFactory = function(configuration, basePath, axios) {
|
|
|
6099
6191
|
*/
|
|
6100
6192
|
var TrajectoryExecutionApi = class extends BaseAPI {
|
|
6101
6193
|
/**
|
|
6102
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time
|
|
6194
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
|
|
6103
6195
|
* @summary Execute Trajectory
|
|
6104
6196
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6105
6197
|
* @param {string} controller Unique identifier to address a controller in the cell.
|