@wandelbots/nova-api 25.10.0-dev.5 → 25.10.0-dev.51
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 +85 -1
- package/dist/v1/index.d.cts +262 -183
- package/dist/v1/index.d.ts +262 -183
- package/dist/v1/index.js +82 -2
- package/dist/v2/index.cjs +80 -0
- package/dist/v2/index.d.cts +204 -132
- package/dist/v2/index.d.ts +74 -2
- package/dist/v2/index.js +77 -1
- package/package.json +1 -1
package/dist/v1/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as axios129 from "axios";
|
|
2
2
|
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
3
|
|
|
4
4
|
//#region v1/configuration.d.ts
|
|
@@ -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: 1.
|
|
10
|
+
* The version of the OpenAPI document: 1.1.0 dev
|
|
11
11
|
*
|
|
12
12
|
*
|
|
13
13
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -268,6 +268,19 @@ interface AllJointPositionsResponse {
|
|
|
268
268
|
*/
|
|
269
269
|
'joint_positions'?: Array<Joints>;
|
|
270
270
|
}
|
|
271
|
+
/**
|
|
272
|
+
*
|
|
273
|
+
* @export
|
|
274
|
+
* @interface ApiVersion
|
|
275
|
+
*/
|
|
276
|
+
interface ApiVersion {
|
|
277
|
+
/**
|
|
278
|
+
* The version of the API.
|
|
279
|
+
* @type {string}
|
|
280
|
+
* @memberof ApiVersion
|
|
281
|
+
*/
|
|
282
|
+
'version': string;
|
|
283
|
+
}
|
|
271
284
|
/**
|
|
272
285
|
* An App is defined by a webserver, packed inside a container, serving a web-application.
|
|
273
286
|
* @export
|
|
@@ -7485,6 +7498,7 @@ declare const VirtualControllerTypes: {
|
|
|
7485
7498
|
readonly AbbIrb460020560: "abb-irb4600_205_60";
|
|
7486
7499
|
readonly AbbIrb460025020: "abb-irb4600_250_20";
|
|
7487
7500
|
readonly AbbIrb460025540: "abb-irb4600_255_40";
|
|
7501
|
+
readonly AbbIrb6730210310: "abb-irb6730_210_310";
|
|
7488
7502
|
readonly FanucArcMate100iD: "fanuc-arc_mate_100iD";
|
|
7489
7503
|
readonly FanucArcMate100iD16S: "fanuc-arc_mate_100iD16S";
|
|
7490
7504
|
readonly FanucArcMate120iD: "fanuc-arc_mate_120iD";
|
|
@@ -7522,11 +7536,14 @@ declare const VirtualControllerTypes: {
|
|
|
7522
7536
|
readonly KukaKr16R20102: "kuka-kr16_r2010_2";
|
|
7523
7537
|
readonly KukaKr20R1810: "kuka-kr20_r1810";
|
|
7524
7538
|
readonly KukaKr20R18102: "kuka-kr20_r1810_2";
|
|
7539
|
+
readonly KukaKr210R2700Extra: "kuka-kr210_r2700_extra";
|
|
7525
7540
|
readonly KukaKr210R27002: "kuka-kr210_r2700_2";
|
|
7526
7541
|
readonly KukaKr210R31002: "kuka-kr210_r3100_2";
|
|
7527
7542
|
readonly KukaKr210R33002: "kuka-kr210_r3300_2";
|
|
7528
7543
|
readonly KukaKr240R2700: "kuka-kr240_r2700";
|
|
7544
|
+
readonly KukaKr240R2900: "kuka-kr240_r2900";
|
|
7529
7545
|
readonly KukaKr250R27002: "kuka-kr250_r2700_2";
|
|
7546
|
+
readonly KukaKr270R2700: "kuka-kr270_r2700";
|
|
7530
7547
|
readonly KukaKr30R2100: "kuka-kr30_r2100";
|
|
7531
7548
|
readonly KukaKr30R3: "kuka-kr30_r3";
|
|
7532
7549
|
readonly KukaKr360L2403: "kuka-kr360_l240_3";
|
|
@@ -7827,7 +7844,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
7827
7844
|
* @throws {RequiredError}
|
|
7828
7845
|
* @memberof ApplicationApi
|
|
7829
7846
|
*/
|
|
7830
|
-
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7847
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
7831
7848
|
/**
|
|
7832
7849
|
* Delete all GUI applications from the cell.
|
|
7833
7850
|
* @summary Clear Applications
|
|
@@ -7837,7 +7854,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
7837
7854
|
* @throws {RequiredError}
|
|
7838
7855
|
* @memberof ApplicationApi
|
|
7839
7856
|
*/
|
|
7840
|
-
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7857
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
7841
7858
|
/**
|
|
7842
7859
|
* Delete a GUI application from the cell.
|
|
7843
7860
|
* @summary Delete Application
|
|
@@ -7848,7 +7865,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
7848
7865
|
* @throws {RequiredError}
|
|
7849
7866
|
* @memberof ApplicationApi
|
|
7850
7867
|
*/
|
|
7851
|
-
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7868
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
7852
7869
|
/**
|
|
7853
7870
|
* Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with the \'Update Configuration\' endpoint.
|
|
7854
7871
|
* @summary Configuration
|
|
@@ -7858,7 +7875,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
7858
7875
|
* @throws {RequiredError}
|
|
7859
7876
|
* @memberof ApplicationApi
|
|
7860
7877
|
*/
|
|
7861
|
-
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<
|
|
7878
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<App, any>>;
|
|
7862
7879
|
/**
|
|
7863
7880
|
* List all GUI applications that have been added to a cell. with the \'Add Application\' endpoint. If the cell does not contain GUI applications, the list is returned empty.
|
|
7864
7881
|
* @summary List Applications
|
|
@@ -7867,7 +7884,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
7867
7884
|
* @throws {RequiredError}
|
|
7868
7885
|
* @memberof ApplicationApi
|
|
7869
7886
|
*/
|
|
7870
|
-
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7887
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<string[], any>>;
|
|
7871
7888
|
/**
|
|
7872
7889
|
* Update the configuration of a GUI application in the cell.
|
|
7873
7890
|
* @summary Update Configuration
|
|
@@ -7879,7 +7896,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
7879
7896
|
* @throws {RequiredError}
|
|
7880
7897
|
* @memberof ApplicationApi
|
|
7881
7898
|
*/
|
|
7882
|
-
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7899
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
7883
7900
|
}
|
|
7884
7901
|
/**
|
|
7885
7902
|
* CellApi - axios parameter creator
|
|
@@ -8068,7 +8085,7 @@ declare class CellApi extends BaseAPI {
|
|
|
8068
8085
|
* @throws {RequiredError}
|
|
8069
8086
|
* @memberof CellApi
|
|
8070
8087
|
*/
|
|
8071
|
-
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8088
|
+
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
8072
8089
|
/**
|
|
8073
8090
|
* Deploy an entire cell with all its resources. A cell can be used to deploy a robot controller, one or more robots, as well as custom applications. Refer to the [Wandelbots NOVA documentation](docs/wandelbots-nova-api/#create-a-cell) for more information.
|
|
8074
8091
|
* @summary Add Cell
|
|
@@ -8078,7 +8095,7 @@ declare class CellApi extends BaseAPI {
|
|
|
8078
8095
|
* @throws {RequiredError}
|
|
8079
8096
|
* @memberof CellApi
|
|
8080
8097
|
*/
|
|
8081
|
-
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8098
|
+
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
8082
8099
|
/**
|
|
8083
8100
|
* List all cell resources. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
8084
8101
|
* @summary Configuration
|
|
@@ -8087,7 +8104,7 @@ declare class CellApi extends BaseAPI {
|
|
|
8087
8104
|
* @throws {RequiredError}
|
|
8088
8105
|
* @memberof CellApi
|
|
8089
8106
|
*/
|
|
8090
|
-
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8107
|
+
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<Cell, any>>;
|
|
8091
8108
|
/**
|
|
8092
8109
|
* List the status of all cell resources.
|
|
8093
8110
|
* @summary Service Status
|
|
@@ -8096,7 +8113,7 @@ declare class CellApi extends BaseAPI {
|
|
|
8096
8113
|
* @throws {RequiredError}
|
|
8097
8114
|
* @memberof CellApi
|
|
8098
8115
|
*/
|
|
8099
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8116
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ServiceStatus[], any>>;
|
|
8100
8117
|
/**
|
|
8101
8118
|
* List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
8102
8119
|
* @summary List Cells
|
|
@@ -8104,7 +8121,7 @@ declare class CellApi extends BaseAPI {
|
|
|
8104
8121
|
* @throws {RequiredError}
|
|
8105
8122
|
* @memberof CellApi
|
|
8106
8123
|
*/
|
|
8107
|
-
listCells(options?: RawAxiosRequestConfig): Promise<
|
|
8124
|
+
listCells(options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<string[], any>>;
|
|
8108
8125
|
/**
|
|
8109
8126
|
* Update the definition of the entire Cell.
|
|
8110
8127
|
* @summary Update Configuration
|
|
@@ -8115,7 +8132,7 @@ declare class CellApi extends BaseAPI {
|
|
|
8115
8132
|
* @throws {RequiredError}
|
|
8116
8133
|
* @memberof CellApi
|
|
8117
8134
|
*/
|
|
8118
|
-
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8135
|
+
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
8119
8136
|
}
|
|
8120
8137
|
/**
|
|
8121
8138
|
* ControllerApi - axios parameter creator
|
|
@@ -8548,7 +8565,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8548
8565
|
* @throws {RequiredError}
|
|
8549
8566
|
* @memberof ControllerApi
|
|
8550
8567
|
*/
|
|
8551
|
-
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8568
|
+
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
8552
8569
|
/**
|
|
8553
8570
|
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with the \'Add Robot Controller\' endpoint. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
8554
8571
|
* @summary Clear Robot Controllers
|
|
@@ -8558,7 +8575,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8558
8575
|
* @throws {RequiredError}
|
|
8559
8576
|
* @memberof ControllerApi
|
|
8560
8577
|
*/
|
|
8561
|
-
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8578
|
+
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
8562
8579
|
/**
|
|
8563
8580
|
* Delete a robot controller from the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
8564
8581
|
* @summary Delete Robot Controller
|
|
@@ -8569,7 +8586,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8569
8586
|
* @throws {RequiredError}
|
|
8570
8587
|
* @memberof ControllerApi
|
|
8571
8588
|
*/
|
|
8572
|
-
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8589
|
+
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
8573
8590
|
/**
|
|
8574
8591
|
* Get the current state of a robot controller.
|
|
8575
8592
|
* @summary State of Device
|
|
@@ -8579,7 +8596,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8579
8596
|
* @throws {RequiredError}
|
|
8580
8597
|
* @memberof ControllerApi
|
|
8581
8598
|
*/
|
|
8582
|
-
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8599
|
+
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<RobotControllerState, any>>;
|
|
8583
8600
|
/**
|
|
8584
8601
|
* 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).
|
|
8585
8602
|
* @summary Current Mode
|
|
@@ -8589,7 +8606,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8589
8606
|
* @throws {RequiredError}
|
|
8590
8607
|
* @memberof ControllerApi
|
|
8591
8608
|
*/
|
|
8592
|
-
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8609
|
+
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<GetModeResponse, any>>;
|
|
8593
8610
|
/**
|
|
8594
8611
|
* Get the configuration for a robot controller.
|
|
8595
8612
|
* @summary Robot Controller Configuration
|
|
@@ -8599,7 +8616,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8599
8616
|
* @throws {RequiredError}
|
|
8600
8617
|
* @memberof ControllerApi
|
|
8601
8618
|
*/
|
|
8602
|
-
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8619
|
+
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<RobotController, any>>;
|
|
8603
8620
|
/**
|
|
8604
8621
|
* Lists supported operating modes. Usually cobots support free drive and control, industrial robots only support control.
|
|
8605
8622
|
* @summary Supported Motion Modes
|
|
@@ -8609,7 +8626,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8609
8626
|
* @throws {RequiredError}
|
|
8610
8627
|
* @memberof ControllerApi
|
|
8611
8628
|
*/
|
|
8612
|
-
getSupportedModes(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8629
|
+
getSupportedModes(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ControllerCapabilities, any>>;
|
|
8613
8630
|
/**
|
|
8614
8631
|
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration. > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
|
|
8615
8632
|
* @summary Virtual Robot Configuration
|
|
@@ -8619,7 +8636,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8619
8636
|
* @throws {RequiredError}
|
|
8620
8637
|
* @memberof ControllerApi
|
|
8621
8638
|
*/
|
|
8622
|
-
getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8639
|
+
getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
8623
8640
|
/**
|
|
8624
8641
|
* List all configured robot controllers.
|
|
8625
8642
|
* @summary List Robot Controllers
|
|
@@ -8628,7 +8645,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8628
8645
|
* @throws {RequiredError}
|
|
8629
8646
|
* @memberof ControllerApi
|
|
8630
8647
|
*/
|
|
8631
|
-
listControllers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8648
|
+
listControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ControllerInstanceList, any>>;
|
|
8632
8649
|
/**
|
|
8633
8650
|
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
8634
8651
|
* @summary Set Default Mode
|
|
@@ -8639,7 +8656,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8639
8656
|
* @throws {RequiredError}
|
|
8640
8657
|
* @memberof ControllerApi
|
|
8641
8658
|
*/
|
|
8642
|
-
setDefaultMode(cell: string, controller: string, mode: SetDefaultModeModeEnum, options?: RawAxiosRequestConfig): Promise<
|
|
8659
|
+
setDefaultMode(cell: string, controller: string, mode: SetDefaultModeModeEnum, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
8643
8660
|
/**
|
|
8644
8661
|
* Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being crushed, > drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > - The robot is in a safe state, > - The right payload is set (e.g by using the (getActivePayload)[getActivePayload] endpoint), > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified response_rate. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular Collobarative Robots (\"Cobots\"). Use the (getSupportedModes)[getSupportedModes] endpoint to check if the robot controller supports free drive mode.
|
|
8645
8662
|
* @summary Stream Free Drive Mode
|
|
@@ -8650,7 +8667,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8650
8667
|
* @throws {RequiredError}
|
|
8651
8668
|
* @memberof ControllerApi
|
|
8652
8669
|
*/
|
|
8653
|
-
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8670
|
+
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<RobotControllerState, any>>;
|
|
8654
8671
|
/**
|
|
8655
8672
|
* Receive updates of the current robot system mode of a robot controller via websocket upon robot system mode change. See [setDefaultMode](setDefaultMode) for more information about the different modes.
|
|
8656
8673
|
* @summary Stream Mode Change
|
|
@@ -8660,7 +8677,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8660
8677
|
* @throws {RequiredError}
|
|
8661
8678
|
* @memberof ControllerApi
|
|
8662
8679
|
*/
|
|
8663
|
-
streamModeChange(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8680
|
+
streamModeChange(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ModeChangeResponse, any>>;
|
|
8664
8681
|
/**
|
|
8665
8682
|
* Receive updates of the state of a robot controller.
|
|
8666
8683
|
* @summary Stream State of Device
|
|
@@ -8671,7 +8688,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8671
8688
|
* @throws {RequiredError}
|
|
8672
8689
|
* @memberof ControllerApi
|
|
8673
8690
|
*/
|
|
8674
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8691
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<RobotControllerState, any>>;
|
|
8675
8692
|
/**
|
|
8676
8693
|
* 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. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
|
|
8677
8694
|
* @summary Update Robot Controller Configuration
|
|
@@ -8683,7 +8700,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
8683
8700
|
* @throws {RequiredError}
|
|
8684
8701
|
* @memberof ControllerApi
|
|
8685
8702
|
*/
|
|
8686
|
-
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8703
|
+
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
8687
8704
|
}
|
|
8688
8705
|
/**
|
|
8689
8706
|
* @export
|
|
@@ -8890,7 +8907,7 @@ declare class ControllerIOsApi extends BaseAPI {
|
|
|
8890
8907
|
* @throws {RequiredError}
|
|
8891
8908
|
* @memberof ControllerIOsApi
|
|
8892
8909
|
*/
|
|
8893
|
-
listIODescriptions(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
8910
|
+
listIODescriptions(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ListIODescriptionsResponse, any>>;
|
|
8894
8911
|
/**
|
|
8895
8912
|
* Retrieves the current values of I/Os. The identifiers of the I/Os must be provided in the request. Request all available I/O identifiers via [listIODescriptions](listIODescriptions).
|
|
8896
8913
|
* @summary Values
|
|
@@ -8901,7 +8918,7 @@ declare class ControllerIOsApi extends BaseAPI {
|
|
|
8901
8918
|
* @throws {RequiredError}
|
|
8902
8919
|
* @memberof ControllerIOsApi
|
|
8903
8920
|
*/
|
|
8904
|
-
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
8921
|
+
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ListIOValuesResponse, any>>;
|
|
8905
8922
|
/**
|
|
8906
8923
|
* Set the values of outputs. All available I/O identifiers and possible value ranges can be requested via [listIODescriptions](listIODescriptions). The call will return once the values have been set on and accepted by the robot. This might take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
|
|
8907
8924
|
* @summary Set Values
|
|
@@ -8912,7 +8929,7 @@ declare class ControllerIOsApi extends BaseAPI {
|
|
|
8912
8929
|
* @throws {RequiredError}
|
|
8913
8930
|
* @memberof ControllerIOsApi
|
|
8914
8931
|
*/
|
|
8915
|
-
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
8932
|
+
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
8916
8933
|
/**
|
|
8917
8934
|
* Continuously receive updates of I/O values via websocket. Updates are sent in the update rate of the controller. > **NOTE** > > Do not request too many values simultaneously as the request is then likely to fail. The amount of values that can be streamed simultaneously depends on the specific robot controller. > **NOTE** > > The inputs and outputs are sent in the update rate of the controller to prevent losing any values. Consider that this might lead to a high amount of data transmitted.
|
|
8918
8935
|
* @summary Stream Values
|
|
@@ -8923,7 +8940,7 @@ declare class ControllerIOsApi extends BaseAPI {
|
|
|
8923
8940
|
* @throws {RequiredError}
|
|
8924
8941
|
* @memberof ControllerIOsApi
|
|
8925
8942
|
*/
|
|
8926
|
-
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
8943
|
+
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ListIOValuesResponse, any>>;
|
|
8927
8944
|
/**
|
|
8928
8945
|
* Wait until an I/O reaches a certain value. This call returns as soon as the condition is met or the request fails. The comparison_type value is used to define how the current value of the I/O is compared with given value. Only set the value that corresponds to the value_type of the I/O, see (listIODescriptions)[listIODescriptions] for more information. Examples: If you want to wait until an analog input (\"AI_1\") is less than 10, you would set io to \"AI_1\" comparison_type to COMPARISON_LESS and only integer_value to 10. If you want to wait until an analog input (\"AI_2\") is greater than 5.0, you would set io to \"AI_2\" comparison_type to COMPARISON_GREATER and only floating_value to 5.0. If you want to wait until a digital input (\"DI_3\") is true, you would set io to \"DI_3\" comparison_type to COMPARISON_EQUAL and only boolean_value to true.
|
|
8929
8946
|
* @summary Wait For
|
|
@@ -8938,7 +8955,7 @@ declare class ControllerIOsApi extends BaseAPI {
|
|
|
8938
8955
|
* @throws {RequiredError}
|
|
8939
8956
|
* @memberof ControllerIOsApi
|
|
8940
8957
|
*/
|
|
8941
|
-
waitForIOEvent(cell: string, controller: string, io: string, comparisonType: WaitForIOEventComparisonTypeEnum, booleanValue?: boolean, integerValue?: string, floatingValue?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8958
|
+
waitForIOEvent(cell: string, controller: string, io: string, comparisonType: WaitForIOEventComparisonTypeEnum, booleanValue?: boolean, integerValue?: string, floatingValue?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<boolean, any>>;
|
|
8942
8959
|
}
|
|
8943
8960
|
/**
|
|
8944
8961
|
* @export
|
|
@@ -9124,7 +9141,7 @@ declare class CoordinateSystemsApi extends BaseAPI {
|
|
|
9124
9141
|
* @throws {RequiredError}
|
|
9125
9142
|
* @memberof CoordinateSystemsApi
|
|
9126
9143
|
*/
|
|
9127
|
-
addCoordinateSystem(cell: string, addRequest: AddRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9144
|
+
addCoordinateSystem(cell: string, addRequest: AddRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<CoordinateSystem, any>>;
|
|
9128
9145
|
/**
|
|
9129
9146
|
* Removes a user coordinate system specified by the given identifier. > **NOTE** > > If the coordinate system has originally been configured on the robot controller, it will remain on the controller even after this endpoint has been executed successfully.. This will remove the user coordinate system from the list of user coordinate systems but keep all dependent coordinate systems which use the deleted coordinate system as reference. Coordinate systems on the robot controller are not affected by this operation. They can be removed via the robot control panel only and will be removed in NOVA when the controller is removed. On virtual controllers, use the [deleteVirtualRobotCoordinateSystem](deleteVirtualRobotCoordinateSystem) endpoint to remove coordinate systems from NOVA and the virtual controller. All available coordinate systems can be listed via the [listCoordinateSystems](listCoordinateSystems) endpoint.
|
|
9130
9147
|
* @summary Delete
|
|
@@ -9134,7 +9151,7 @@ declare class CoordinateSystemsApi extends BaseAPI {
|
|
|
9134
9151
|
* @throws {RequiredError}
|
|
9135
9152
|
* @memberof CoordinateSystemsApi
|
|
9136
9153
|
*/
|
|
9137
|
-
deleteCoordinateSystem(cell: string, coordinateSystem: string, options?: RawAxiosRequestConfig): Promise<
|
|
9154
|
+
deleteCoordinateSystem(cell: string, coordinateSystem: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
9138
9155
|
/**
|
|
9139
9156
|
* Request a coordinate system specification for a given identifier. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. User coordinate systems can be configured on a robot controller during setup or added to the system via the [addCoordinateSystem](addCoordinateSystem) endpoint. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
|
|
9140
9157
|
* @summary Description
|
|
@@ -9145,7 +9162,7 @@ declare class CoordinateSystemsApi extends BaseAPI {
|
|
|
9145
9162
|
* @throws {RequiredError}
|
|
9146
9163
|
* @memberof CoordinateSystemsApi
|
|
9147
9164
|
*/
|
|
9148
|
-
getCoordinateSystem(cell: string, coordinateSystem: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<
|
|
9165
|
+
getCoordinateSystem(cell: string, coordinateSystem: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<CoordinateSystem, any>>;
|
|
9149
9166
|
/**
|
|
9150
9167
|
* Lists all specifications of coordinate systems from robot controllers and user coordinate systems added to the system via the [addCoordinateSystem](addCoordinateSystem) endpoint. Use parameter rotation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested rotation angle type. If parameter rotation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in the rotation angle type used on the robot controller. This can be useful for visualization purposes in the client application due to equivalent numbers with robot control panel visualization. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller. Updating the robot controller\'s configuration either requires credentials or is not possible. With the endpoint [addCoordinateSystem](addCoordinateSystem) you can create a coordinate system without changing the robot controller\'s configuration.
|
|
9151
9168
|
* @summary List
|
|
@@ -9155,7 +9172,7 @@ declare class CoordinateSystemsApi extends BaseAPI {
|
|
|
9155
9172
|
* @throws {RequiredError}
|
|
9156
9173
|
* @memberof CoordinateSystemsApi
|
|
9157
9174
|
*/
|
|
9158
|
-
listCoordinateSystems(cell: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<
|
|
9175
|
+
listCoordinateSystems(cell: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ListResponse, any>>;
|
|
9159
9176
|
/**
|
|
9160
9177
|
* Transform a pose to another base.
|
|
9161
9178
|
* @summary Transform
|
|
@@ -9166,7 +9183,7 @@ declare class CoordinateSystemsApi extends BaseAPI {
|
|
|
9166
9183
|
* @throws {RequiredError}
|
|
9167
9184
|
* @memberof CoordinateSystemsApi
|
|
9168
9185
|
*/
|
|
9169
|
-
transformInCoordinateSystem(cell: string, coordinateSystem: string, pose: Pose, options?: RawAxiosRequestConfig): Promise<
|
|
9186
|
+
transformInCoordinateSystem(cell: string, coordinateSystem: string, pose: Pose, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<Pose, any>>;
|
|
9170
9187
|
}
|
|
9171
9188
|
/**
|
|
9172
9189
|
* DeviceConfigurationApi - axios parameter creator
|
|
@@ -9346,7 +9363,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
|
|
|
9346
9363
|
* @throws {RequiredError}
|
|
9347
9364
|
* @memberof DeviceConfigurationApi
|
|
9348
9365
|
*/
|
|
9349
|
-
clearDevices(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9366
|
+
clearDevices(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
9350
9367
|
/**
|
|
9351
9368
|
* Deprecated endpoint. Overwrite existing devices in an existing robot cell. The devices are added to the robot cell in the order they are specified in the request body. Each device needs to have a unique identifier which is used to reference the device in Wandelscript. Devices which can be configured in the cell: - Robots - OPC UA devices ## Parameters - For more information about the available device configurations have a look at the **Schema** tab or in the provided examples.
|
|
9352
9369
|
* @summary Create Devices
|
|
@@ -9357,7 +9374,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
|
|
|
9357
9374
|
* @throws {RequiredError}
|
|
9358
9375
|
* @memberof DeviceConfigurationApi
|
|
9359
9376
|
*/
|
|
9360
|
-
createDevice(cell: string, createDeviceRequestInner: Array<CreateDeviceRequestInner>, options?: RawAxiosRequestConfig): Promise<
|
|
9377
|
+
createDevice(cell: string, createDeviceRequestInner: Array<CreateDeviceRequestInner>, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<any, any>>;
|
|
9361
9378
|
/**
|
|
9362
9379
|
* Deprecated endpoint. Deletes a specific device from the cell.
|
|
9363
9380
|
* @summary Delete Device
|
|
@@ -9368,7 +9385,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
|
|
|
9368
9385
|
* @throws {RequiredError}
|
|
9369
9386
|
* @memberof DeviceConfigurationApi
|
|
9370
9387
|
*/
|
|
9371
|
-
deleteDevice(cell: string, identifier: string, options?: RawAxiosRequestConfig): Promise<
|
|
9388
|
+
deleteDevice(cell: string, identifier: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
9372
9389
|
/**
|
|
9373
9390
|
* Deprecated endpoint. Returns information about a device.
|
|
9374
9391
|
* @summary Device Information
|
|
@@ -9379,7 +9396,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
|
|
|
9379
9396
|
* @throws {RequiredError}
|
|
9380
9397
|
* @memberof DeviceConfigurationApi
|
|
9381
9398
|
*/
|
|
9382
|
-
getDevice(cell: string, identifier: string, options?: RawAxiosRequestConfig): Promise<
|
|
9399
|
+
getDevice(cell: string, identifier: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<any, any>>;
|
|
9383
9400
|
/**
|
|
9384
9401
|
* Deprecated endpoint. Lists all devices which are configured in the cell: - Robots - Databases - OPC UA devices
|
|
9385
9402
|
* @summary List All Devices
|
|
@@ -9389,7 +9406,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
|
|
|
9389
9406
|
* @throws {RequiredError}
|
|
9390
9407
|
* @memberof DeviceConfigurationApi
|
|
9391
9408
|
*/
|
|
9392
|
-
listDevices(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9409
|
+
listDevices(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ListDevices200ResponseInner[], any>>;
|
|
9393
9410
|
}
|
|
9394
9411
|
/**
|
|
9395
9412
|
* LibraryProgramApi - axios parameter creator
|
|
@@ -9567,7 +9584,7 @@ declare class LibraryProgramApi extends BaseAPI {
|
|
|
9567
9584
|
* @throws {RequiredError}
|
|
9568
9585
|
* @memberof LibraryProgramApi
|
|
9569
9586
|
*/
|
|
9570
|
-
createProgram(cell: string, body: string, name?: string, options?: RawAxiosRequestConfig): Promise<
|
|
9587
|
+
createProgram(cell: string, body: string, name?: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ProgramMetadata, any>>;
|
|
9571
9588
|
/**
|
|
9572
9589
|
* <!-- theme: danger --> > **Experimental** Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
|
|
9573
9590
|
* @summary Delete Program
|
|
@@ -9577,7 +9594,7 @@ declare class LibraryProgramApi extends BaseAPI {
|
|
|
9577
9594
|
* @throws {RequiredError}
|
|
9578
9595
|
* @memberof LibraryProgramApi
|
|
9579
9596
|
*/
|
|
9580
|
-
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
9597
|
+
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ProgramMetadata, any>>;
|
|
9581
9598
|
/**
|
|
9582
9599
|
* <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
|
|
9583
9600
|
* @summary Delete Program List
|
|
@@ -9587,7 +9604,7 @@ declare class LibraryProgramApi extends BaseAPI {
|
|
|
9587
9604
|
* @throws {RequiredError}
|
|
9588
9605
|
* @memberof LibraryProgramApi
|
|
9589
9606
|
*/
|
|
9590
|
-
deleteProgramList(cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
9607
|
+
deleteProgramList(cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ListProgramMetadataResponse, any>>;
|
|
9591
9608
|
/**
|
|
9592
9609
|
* <!-- theme: danger --> > **Experimental** Returns the content of the program. The identifier of the program is received upon creation or from the metadata list of all the programs.
|
|
9593
9610
|
* @summary Get Program
|
|
@@ -9597,7 +9614,7 @@ declare class LibraryProgramApi extends BaseAPI {
|
|
|
9597
9614
|
* @throws {RequiredError}
|
|
9598
9615
|
* @memberof LibraryProgramApi
|
|
9599
9616
|
*/
|
|
9600
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
9617
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<string, any>>;
|
|
9601
9618
|
/**
|
|
9602
9619
|
* <!-- theme: danger --> > **Experimental** Updates the content of the program. The update overwrites the existing content. The metadata is updated in correspondence. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9603
9620
|
* @summary Update Program
|
|
@@ -9608,7 +9625,7 @@ declare class LibraryProgramApi extends BaseAPI {
|
|
|
9608
9625
|
* @throws {RequiredError}
|
|
9609
9626
|
* @memberof LibraryProgramApi
|
|
9610
9627
|
*/
|
|
9611
|
-
updateProgram(cell: string, program: string, body: string, options?: RawAxiosRequestConfig): Promise<
|
|
9628
|
+
updateProgram(cell: string, program: string, body: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ProgramMetadata, any>>;
|
|
9612
9629
|
}
|
|
9613
9630
|
/**
|
|
9614
9631
|
* LibraryProgramMetadataApi - axios parameter creator
|
|
@@ -9758,7 +9775,7 @@ declare class LibraryProgramMetadataApi extends BaseAPI {
|
|
|
9758
9775
|
* @throws {RequiredError}
|
|
9759
9776
|
* @memberof LibraryProgramMetadataApi
|
|
9760
9777
|
*/
|
|
9761
|
-
getProgramMetadata(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
9778
|
+
getProgramMetadata(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ProgramMetadata, any>>;
|
|
9762
9779
|
/**
|
|
9763
9780
|
* <!-- theme: danger --> > **Experimental** Returns a list of all the stored programs, represented by their metadata.
|
|
9764
9781
|
* @summary List Program Metadata
|
|
@@ -9768,7 +9785,7 @@ declare class LibraryProgramMetadataApi extends BaseAPI {
|
|
|
9768
9785
|
* @throws {RequiredError}
|
|
9769
9786
|
* @memberof LibraryProgramMetadataApi
|
|
9770
9787
|
*/
|
|
9771
|
-
listProgramMetadata(cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
9788
|
+
listProgramMetadata(cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ListProgramMetadataResponse, any>>;
|
|
9772
9789
|
/**
|
|
9773
9790
|
* <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
|
|
9774
9791
|
* @summary Update Program Metadata
|
|
@@ -9779,7 +9796,7 @@ declare class LibraryProgramMetadataApi extends BaseAPI {
|
|
|
9779
9796
|
* @throws {RequiredError}
|
|
9780
9797
|
* @memberof LibraryProgramMetadataApi
|
|
9781
9798
|
*/
|
|
9782
|
-
updateProgramMetadata(cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9799
|
+
updateProgramMetadata(cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ProgramMetadata, any>>;
|
|
9783
9800
|
/**
|
|
9784
9801
|
* <!-- theme: danger --> > **Experimental** Uploads an image for the corresponding program. The image is served as a static file. The path to the image is stored in the metadata.
|
|
9785
9802
|
* @summary Upload Program Metadata Image
|
|
@@ -9790,7 +9807,7 @@ declare class LibraryProgramMetadataApi extends BaseAPI {
|
|
|
9790
9807
|
* @throws {RequiredError}
|
|
9791
9808
|
* @memberof LibraryProgramMetadataApi
|
|
9792
9809
|
*/
|
|
9793
|
-
uploadProgramMetadataImage(cell: string, program: string, file: File, options?: RawAxiosRequestConfig): Promise<
|
|
9810
|
+
uploadProgramMetadataImage(cell: string, program: string, file: File, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ProgramMetadata, any>>;
|
|
9794
9811
|
}
|
|
9795
9812
|
/**
|
|
9796
9813
|
* LibraryRecipeApi - axios parameter creator
|
|
@@ -9972,7 +9989,7 @@ declare class LibraryRecipeApi extends BaseAPI {
|
|
|
9972
9989
|
* @throws {RequiredError}
|
|
9973
9990
|
* @memberof LibraryRecipeApi
|
|
9974
9991
|
*/
|
|
9975
|
-
createRecipe(cell: string, programId: string, body: object, name?: string, options?: RawAxiosRequestConfig): Promise<
|
|
9992
|
+
createRecipe(cell: string, programId: string, body: object, name?: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<RecipeMetadata, any>>;
|
|
9976
9993
|
/**
|
|
9977
9994
|
* # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes a recipe. This action is irreversible.
|
|
9978
9995
|
* @summary Delete Recipe
|
|
@@ -9982,7 +9999,7 @@ declare class LibraryRecipeApi extends BaseAPI {
|
|
|
9982
9999
|
* @throws {RequiredError}
|
|
9983
10000
|
* @memberof LibraryRecipeApi
|
|
9984
10001
|
*/
|
|
9985
|
-
deleteRecipe(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<
|
|
10002
|
+
deleteRecipe(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<RecipeMetadata, any>>;
|
|
9986
10003
|
/**
|
|
9987
10004
|
* <!-- theme: danger --> > **Experimental** Deletes the provided list of recipes. This action is irreversible.
|
|
9988
10005
|
* @summary Delete Recipe List
|
|
@@ -9992,7 +10009,7 @@ declare class LibraryRecipeApi extends BaseAPI {
|
|
|
9992
10009
|
* @throws {RequiredError}
|
|
9993
10010
|
* @memberof LibraryRecipeApi
|
|
9994
10011
|
*/
|
|
9995
|
-
deleteRecipeList(cell: string, recipeIds: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
10012
|
+
deleteRecipeList(cell: string, recipeIds: Array<string>, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ListRecipeMetadataResponse, any>>;
|
|
9996
10013
|
/**
|
|
9997
10014
|
* <!-- theme: danger --> > **Experimental** Returns the content of a recipe. The identifier of the recipe is recieved on creation or from the metadata list of all the recipes.
|
|
9998
10015
|
* @summary Get Recipe
|
|
@@ -10002,7 +10019,7 @@ declare class LibraryRecipeApi extends BaseAPI {
|
|
|
10002
10019
|
* @throws {RequiredError}
|
|
10003
10020
|
* @memberof LibraryRecipeApi
|
|
10004
10021
|
*/
|
|
10005
|
-
getRecipe(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<
|
|
10022
|
+
getRecipe(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<object, any>>;
|
|
10006
10023
|
/**
|
|
10007
10024
|
* <!-- theme: danger --> > **Experimental** Updates an existing recipe. The update is partial, only the set fields get updated.
|
|
10008
10025
|
* @summary Update Recipe
|
|
@@ -10013,7 +10030,7 @@ declare class LibraryRecipeApi extends BaseAPI {
|
|
|
10013
10030
|
* @throws {RequiredError}
|
|
10014
10031
|
* @memberof LibraryRecipeApi
|
|
10015
10032
|
*/
|
|
10016
|
-
updateRecipe(cell: string, recipe: string, body: object, options?: RawAxiosRequestConfig): Promise<
|
|
10033
|
+
updateRecipe(cell: string, recipe: string, body: object, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<RecipeMetadata, any>>;
|
|
10017
10034
|
}
|
|
10018
10035
|
/**
|
|
10019
10036
|
* LibraryRecipeMetadataApi - axios parameter creator
|
|
@@ -10160,7 +10177,7 @@ declare class LibraryRecipeMetadataApi extends BaseAPI {
|
|
|
10160
10177
|
* @throws {RequiredError}
|
|
10161
10178
|
* @memberof LibraryRecipeMetadataApi
|
|
10162
10179
|
*/
|
|
10163
|
-
getRecipeMetadata(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<
|
|
10180
|
+
getRecipeMetadata(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<RecipeMetadata, any>>;
|
|
10164
10181
|
/**
|
|
10165
10182
|
* <!-- theme: danger --> > **Experimental** List of all the stored recipes, represented by their metadata.
|
|
10166
10183
|
* @summary List Recipe Metadata
|
|
@@ -10169,7 +10186,7 @@ declare class LibraryRecipeMetadataApi extends BaseAPI {
|
|
|
10169
10186
|
* @throws {RequiredError}
|
|
10170
10187
|
* @memberof LibraryRecipeMetadataApi
|
|
10171
10188
|
*/
|
|
10172
|
-
listRecipeMetadata(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
10189
|
+
listRecipeMetadata(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ListRecipeMetadataResponse, any>>;
|
|
10173
10190
|
/**
|
|
10174
10191
|
* <!-- theme: danger --> > **Experimental** Updates the metadata of a recipe. The update is partial, only the set fields get updated.
|
|
10175
10192
|
* @summary Update Recipe Metadata
|
|
@@ -10180,7 +10197,7 @@ declare class LibraryRecipeMetadataApi extends BaseAPI {
|
|
|
10180
10197
|
* @throws {RequiredError}
|
|
10181
10198
|
* @memberof LibraryRecipeMetadataApi
|
|
10182
10199
|
*/
|
|
10183
|
-
updateRecipeMetadata(cell: string, recipe: string, updateRecipeMetadataRequest: UpdateRecipeMetadataRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10200
|
+
updateRecipeMetadata(cell: string, recipe: string, updateRecipeMetadataRequest: UpdateRecipeMetadataRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<RecipeMetadata, any>>;
|
|
10184
10201
|
/**
|
|
10185
10202
|
* <!-- theme: danger --> > **Experimental** Uploads an image for a recipe. The image is served as a static file and the path is stored in the metadata.
|
|
10186
10203
|
* @summary Upload Recipe Metadata Image
|
|
@@ -10191,7 +10208,7 @@ declare class LibraryRecipeMetadataApi extends BaseAPI {
|
|
|
10191
10208
|
* @throws {RequiredError}
|
|
10192
10209
|
* @memberof LibraryRecipeMetadataApi
|
|
10193
10210
|
*/
|
|
10194
|
-
uploadRecipeMetadataImage(cell: string, recipe: string, file: File, options?: RawAxiosRequestConfig): Promise<
|
|
10211
|
+
uploadRecipeMetadataImage(cell: string, recipe: string, file: File, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<RecipeMetadata, any>>;
|
|
10195
10212
|
}
|
|
10196
10213
|
/**
|
|
10197
10214
|
* LicenseApi - axios parameter creator
|
|
@@ -10313,7 +10330,7 @@ declare class LicenseApi extends BaseAPI {
|
|
|
10313
10330
|
* @throws {RequiredError}
|
|
10314
10331
|
* @memberof LicenseApi
|
|
10315
10332
|
*/
|
|
10316
|
-
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10333
|
+
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<License, any>>;
|
|
10317
10334
|
/**
|
|
10318
10335
|
* Deactivates active license.
|
|
10319
10336
|
* @summary Deactivate license
|
|
@@ -10321,7 +10338,7 @@ declare class LicenseApi extends BaseAPI {
|
|
|
10321
10338
|
* @throws {RequiredError}
|
|
10322
10339
|
* @memberof LicenseApi
|
|
10323
10340
|
*/
|
|
10324
|
-
deactivateLicense(options?: RawAxiosRequestConfig): Promise<
|
|
10341
|
+
deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
10325
10342
|
/**
|
|
10326
10343
|
* Get information on the license used with the Wandelbots NOVA instance, e.g. licensed product, expiration date, license status.
|
|
10327
10344
|
* @summary Get license
|
|
@@ -10329,7 +10346,7 @@ declare class LicenseApi extends BaseAPI {
|
|
|
10329
10346
|
* @throws {RequiredError}
|
|
10330
10347
|
* @memberof LicenseApi
|
|
10331
10348
|
*/
|
|
10332
|
-
getLicense(options?: RawAxiosRequestConfig): Promise<
|
|
10349
|
+
getLicense(options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<License, any>>;
|
|
10333
10350
|
/**
|
|
10334
10351
|
* Get the license status. If `valid`, Wandelbots NOVA can be used. If `expired`, the license has to be renewed in order to use Wandelbots NOVA.
|
|
10335
10352
|
* @summary Get license status
|
|
@@ -10337,7 +10354,7 @@ declare class LicenseApi extends BaseAPI {
|
|
|
10337
10354
|
* @throws {RequiredError}
|
|
10338
10355
|
* @memberof LicenseApi
|
|
10339
10356
|
*/
|
|
10340
|
-
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<
|
|
10357
|
+
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<LicenseStatus, any>>;
|
|
10341
10358
|
}
|
|
10342
10359
|
/**
|
|
10343
10360
|
* MotionApi - axios parameter creator
|
|
@@ -10897,7 +10914,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
10897
10914
|
* @throws {RequiredError}
|
|
10898
10915
|
* @memberof MotionApi
|
|
10899
10916
|
*/
|
|
10900
|
-
deleteAllMotions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
10917
|
+
deleteAllMotions(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
10901
10918
|
/**
|
|
10902
10919
|
* Remove a previously created motion from cache. Use [listMotions](listMotions) to list all available motions. Motions are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
10903
10920
|
* @summary Remove
|
|
@@ -10907,7 +10924,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
10907
10924
|
* @throws {RequiredError}
|
|
10908
10925
|
* @memberof MotionApi
|
|
10909
10926
|
*/
|
|
10910
|
-
deleteMotion(cell: string, motion: string, options?: RawAxiosRequestConfig): Promise<
|
|
10927
|
+
deleteMotion(cell: string, motion: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
10911
10928
|
/**
|
|
10912
10929
|
* <!-- theme: danger --> > Websocket endpoint Provides execution control over a previously planned trajectory. Enables the caller to attach I/O actions to the trajectory. Understanding the 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 [planMotion](planMotion). 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. ### 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 and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 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 - InitializeMovementResponse is sent to signal the success or failure of the InitializeMovementRequest. - Movement responses are streamed after a StartMovementRequest successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by InitializeMovementRequest. - Standstill reponse is sent once the movement has finished or has come to a standstill due to a pause. - PauseMovementResponse is sent to signal the success of the PauseMovementRequest. It does not signal the end of the movement. End of movement is signaled by Standstill reponse . - PlaybackSpeedResponse is sent to signal the success of the PlaybackSpeedRequest. - MovementError with error details is sent in case of an unexpected error, 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.
|
|
10913
10930
|
* @summary Execute Trajectory
|
|
@@ -10917,7 +10934,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
10917
10934
|
* @throws {RequiredError}
|
|
10918
10935
|
* @memberof MotionApi
|
|
10919
10936
|
*/
|
|
10920
|
-
executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10937
|
+
executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
10921
10938
|
/**
|
|
10922
10939
|
* Get the trajectory of a planned motion with defined `sample_time` in milliseconds (ms). The trajectory is a list of points containing cartesian and joint data. The cartesian data is in the requested coordinate system. To get a single point of the trajectory, please use the [getMotionTrajectorySample](getMotionTrajectorySample) endpoint.
|
|
10923
10940
|
* @summary Get Trajectory
|
|
@@ -10929,7 +10946,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
10929
10946
|
* @throws {RequiredError}
|
|
10930
10947
|
* @memberof MotionApi
|
|
10931
10948
|
*/
|
|
10932
|
-
getMotionTrajectory(cell: string, motion: string, sampleTime: number, responsesCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
10949
|
+
getMotionTrajectory(cell: string, motion: string, sampleTime: number, responsesCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<GetTrajectoryResponse, any>>;
|
|
10933
10950
|
/**
|
|
10934
10951
|
* Get a single point at a certain location of a planned motion. To get the whole trajectory, use the [getMotionTrajectory](getMotionTrajectory) endpoint.
|
|
10935
10952
|
* @summary Get Trajectory Sample
|
|
@@ -10941,7 +10958,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
10941
10958
|
* @throws {RequiredError}
|
|
10942
10959
|
* @memberof MotionApi
|
|
10943
10960
|
*/
|
|
10944
|
-
getMotionTrajectorySample(cell: string, motion: string, locationOnTrajectory?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
10961
|
+
getMotionTrajectorySample(cell: string, motion: string, locationOnTrajectory?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<GetTrajectorySampleResponse, any>>;
|
|
10945
10962
|
/**
|
|
10946
10963
|
* Get the joint data of a planned motion. The planned motion contains only the joint information, to persistently store and reload it later. The data will be sampled equidistantly with defined `sample_time` in milliseconds (ms). If not provided, the data is returned as it is stored on Wandelbots NOVA system. To request cartesian data for visualization purposes, use the [getMotionTrajectory](getMotionTrajectory) endpoint. To get a single point of the planned motion, use the [getMotionTrajectorySample](getMotionTrajectorySample) endpoint.
|
|
10947
10964
|
* @summary Get Planned Motion
|
|
@@ -10952,7 +10969,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
10952
10969
|
* @throws {RequiredError}
|
|
10953
10970
|
* @memberof MotionApi
|
|
10954
10971
|
*/
|
|
10955
|
-
getPlannedMotion(cell: string, motion: string, sampleTime?: number, options?: RawAxiosRequestConfig): Promise<
|
|
10972
|
+
getPlannedMotion(cell: string, motion: string, sampleTime?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<PlannedMotion, any>>;
|
|
10956
10973
|
/**
|
|
10957
10974
|
* Returns motion group models that are supported for planning.
|
|
10958
10975
|
* @summary Motion Group Models for Planning
|
|
@@ -10961,7 +10978,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
10961
10978
|
* @throws {RequiredError}
|
|
10962
10979
|
* @memberof MotionApi
|
|
10963
10980
|
*/
|
|
10964
|
-
getPlanningMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
10981
|
+
getPlanningMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<string[], any>>;
|
|
10965
10982
|
/**
|
|
10966
10983
|
* List all currently planned and available motions. Use [planMotion](planMotion) to plan a new motion. Motions are removed if the corresponding motion group or controller disconnects.
|
|
10967
10984
|
* @summary List All Motions
|
|
@@ -10970,7 +10987,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
10970
10987
|
* @throws {RequiredError}
|
|
10971
10988
|
* @memberof MotionApi
|
|
10972
10989
|
*/
|
|
10973
|
-
listMotions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
10990
|
+
listMotions(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<MotionIdsListResponse, any>>;
|
|
10974
10991
|
/**
|
|
10975
10992
|
* Loads and validates the data of a planned motion into a motion session. The response contains information about the validated motion. Validation can lead to three different results: - Fully valid: The whole planned motion can be executed from start to end. The response will contain the session to move the robot. - Partially valid: Only parts of the planned motion can be executed. The response will contain the session to move the robot and information about the failure for the part that is not executable. - Invalid: The planned motion can not be executed. The response will tell you, which information about the reason of failure. If the motion is at least partially valid, the parts of the motion that are valid can be executed using the [streamMoveForward](streamMoveForward) endpoint. You can use the following workflows: - Plan motions using the [planMotion](planMotion) endpoint, - Store the planned motion persistently, - Use this endpoint to reload the stored motion and get a motion session for it. - Execute the loaded motion using the [streamMoveForward](streamMoveForward) endpoint. OR: - Generate a planned motion with [planTrajectory](planTrajectory) or your own motion planner, - Send the planned motion to this endpoint to validate it and get a motion session for it, - Execute your motion using the [streamMoveForward](streamMoveForward) endpoint. Once a planned motion is validated, it is treated like a motion session and will appear in the list of available motions, see [listMotions](listMotions) endpoint. You can then execute a motion session with the [streamMoveForward](streamMoveForward) endpoint.
|
|
10976
10993
|
* @summary Load Planned Motion
|
|
@@ -10980,7 +10997,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
10980
10997
|
* @throws {RequiredError}
|
|
10981
10998
|
* @memberof MotionApi
|
|
10982
10999
|
*/
|
|
10983
|
-
loadPlannedMotion(cell: string, plannedMotion: PlannedMotion, options?: RawAxiosRequestConfig): Promise<
|
|
11000
|
+
loadPlannedMotion(cell: string, plannedMotion: PlannedMotion, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<PlanResponse, any>>;
|
|
10984
11001
|
/**
|
|
10985
11002
|
* <!-- theme: danger --> > **Experimental** Plans a collision-free PTP motion for a single motion group. Use the following workflow to execute a planned trajectory: 1. Plan collision-free movement/motion. 2. Validate and load the planned trajectory using the [loadPlannedMotion](loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](streamMove) endpoint.
|
|
10986
11003
|
* @summary Plan Collision Free PTP
|
|
@@ -10990,7 +11007,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
10990
11007
|
* @throws {RequiredError}
|
|
10991
11008
|
* @memberof MotionApi
|
|
10992
11009
|
*/
|
|
10993
|
-
planCollisionFreePTP(cell: string, planCollisionFreePTPRequest?: PlanCollisionFreePTPRequest, options?: RawAxiosRequestConfig): Promise<
|
|
11010
|
+
planCollisionFreePTP(cell: string, planCollisionFreePTPRequest?: PlanCollisionFreePTPRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
10994
11011
|
/**
|
|
10995
11012
|
* Deprecated endpoint. Use [planTrajectory](planTrajectory) and [loadPlannedMotion](loadPlannedMotion) instead. Plans a new motion for a single previously configured [motion group](listMotionGroups). Motions are described by a sequence of motion commands starting with start joints. A motion is planned from standstill to standstill. A single motion has constant TCP and payload. Currently, I/O actions can\'t be attached to a motion to execute the action in realtime while a motion is executed. If an I/O is needed at a specific point, multiple motions need to be planned. If an I/O is needed to be set while a motion is executed, the endpoint [setOutputValues](setOutputValues) could be used.
|
|
10996
11013
|
* @summary Plan Motion
|
|
@@ -11001,7 +11018,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
11001
11018
|
* @throws {RequiredError}
|
|
11002
11019
|
* @memberof MotionApi
|
|
11003
11020
|
*/
|
|
11004
|
-
planMotion(cell: string, planRequest: PlanRequest, options?: RawAxiosRequestConfig): Promise<
|
|
11021
|
+
planMotion(cell: string, planRequest: PlanRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<PlanResponse, any>>;
|
|
11005
11022
|
/**
|
|
11006
11023
|
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Validate and load the planned trajectory using the [loadPlannedMotion](loadPlannedMotion) endpoint. 3. Execute the loaded trajectory using the [streamMove](streamMove) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
11007
11024
|
* @summary Plan Trajectory
|
|
@@ -11011,7 +11028,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
11011
11028
|
* @throws {RequiredError}
|
|
11012
11029
|
* @memberof MotionApi
|
|
11013
11030
|
*/
|
|
11014
|
-
planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
11031
|
+
planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
11015
11032
|
/**
|
|
11016
11033
|
* Stops an active motion gracefully with deceleration until standstill while staying on the planned trajectory. When an active movement is stopped any further update request will be rejected. The active movement request returns until the robot has reached standstill. Currently it is not possible to restart the motion. Please send in a feature request if you need to restart/continue the motion.
|
|
11017
11034
|
* @summary Stop
|
|
@@ -11021,7 +11038,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
11021
11038
|
* @throws {RequiredError}
|
|
11022
11039
|
* @memberof MotionApi
|
|
11023
11040
|
*/
|
|
11024
|
-
stopExecution(cell: string, motion: string, options?: RawAxiosRequestConfig): Promise<
|
|
11041
|
+
stopExecution(cell: string, motion: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
11025
11042
|
/**
|
|
11026
11043
|
* Deprecated endpoint. Use `executeTrajectory` instead. Moves the motion group forward or backward along a previously planned motion. Or request to move the motion group via joint point-to-point to a given location on a planned motion. Or set the playback speed of the motion. Or stop the motion execution.
|
|
11027
11044
|
* @summary Stream Move
|
|
@@ -11032,7 +11049,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
11032
11049
|
* @throws {RequiredError}
|
|
11033
11050
|
* @memberof MotionApi
|
|
11034
11051
|
*/
|
|
11035
|
-
streamMove(cell: string, streamMoveRequest: StreamMoveRequest, options?: RawAxiosRequestConfig): Promise<
|
|
11052
|
+
streamMove(cell: string, streamMoveRequest: StreamMoveRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<StreamMoveResponse, any>>;
|
|
11036
11053
|
/**
|
|
11037
11054
|
* Deprecated endpoint. Use the [executeTrajectory](executeTrajectory) endpoint instead. Request to move the motion group backward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the endpoint of the planned motion. OR - The motion was stopped using [stopExecution](stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped. OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](streamMoveToTrajectoryViaJointP2P) endpoint.
|
|
11038
11055
|
* @summary Stream Backward
|
|
@@ -11047,7 +11064,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
11047
11064
|
* @throws {RequiredError}
|
|
11048
11065
|
* @memberof MotionApi
|
|
11049
11066
|
*/
|
|
11050
|
-
streamMoveBackward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<
|
|
11067
|
+
streamMoveBackward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<StreamMoveResponse, any>>;
|
|
11051
11068
|
/**
|
|
11052
11069
|
* Deprecated endpoint. Use the [executeTrajectory](executeTrajectory) endpoint instead. Moves the motion group forward along a previously planned motion. Once started, you can stop a motion using the [stopExecution](stopExecution) endpoint. Prerequisites, before starting the motion execution: - The motion group is currently at the start point of the planned motion. OR - The motion was stopped using [stopExecution](stopExecution) endpoint. Then it is possible to resume the motion execution from where it stopped. OR - The motion group was moved onto the motion using the [streamMoveToTrajectoryViaJointP2P](streamMoveToTrajectoryViaJointP2P) endpoint.
|
|
11053
11070
|
* @summary Stream Forward
|
|
@@ -11062,7 +11079,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
11062
11079
|
* @throws {RequiredError}
|
|
11063
11080
|
* @memberof MotionApi
|
|
11064
11081
|
*/
|
|
11065
|
-
streamMoveForward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<
|
|
11082
|
+
streamMoveForward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<StreamMoveResponse, any>>;
|
|
11066
11083
|
/**
|
|
11067
11084
|
* Request to move the motion group via joint point-to-point to a given location on a planned motion. You must use this endpoint in order to start moving from an arbritrary location of the trajectory. Afterwards, you are able to call [streamMoveForward](streamMoveForward) or [streamMoveBackward](streamMoveBackward) to move along planned motion. Use the [stopExecution](stopExecution) endpoint to stop the motion gracefully.
|
|
11068
11085
|
* @summary Stream to Trajectory
|
|
@@ -11080,7 +11097,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
11080
11097
|
* @throws {RequiredError}
|
|
11081
11098
|
* @memberof MotionApi
|
|
11082
11099
|
*/
|
|
11083
|
-
streamMoveToTrajectoryViaJointPTP(cell: string, motion: string, locationOnTrajectory: number, limitOverrideJointVelocityLimitsJoints?: Array<number>, limitOverrideJointAccelerationLimitsJoints?: Array<number>, limitOverrideTcpVelocityLimit?: number, limitOverrideTcpAccelerationLimit?: number, limitOverrideTcpOrientationVelocityLimit?: number, limitOverrideTcpOrientationAccelerationLimit?: number, responsesCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
11100
|
+
streamMoveToTrajectoryViaJointPTP(cell: string, motion: string, locationOnTrajectory: number, limitOverrideJointVelocityLimitsJoints?: Array<number>, limitOverrideJointAccelerationLimitsJoints?: Array<number>, limitOverrideTcpVelocityLimit?: number, limitOverrideTcpAccelerationLimit?: number, limitOverrideTcpOrientationVelocityLimit?: number, limitOverrideTcpOrientationAccelerationLimit?: number, responsesCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<StreamMoveResponse, any>>;
|
|
11084
11101
|
}
|
|
11085
11102
|
/**
|
|
11086
11103
|
* MotionGroupApi - axios parameter creator
|
|
@@ -11221,7 +11238,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
11221
11238
|
* @throws {RequiredError}
|
|
11222
11239
|
* @memberof MotionGroupApi
|
|
11223
11240
|
*/
|
|
11224
|
-
activateAllMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
11241
|
+
activateAllMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<MotionGroupInstanceList, any>>;
|
|
11225
11242
|
/**
|
|
11226
11243
|
* Activate the motion group and keeps the motion group in an active status. To manually activate a motion group, use this endpoint. When activating a motion group, interacting with the controller in other ways is not possible. To deactivate a motion group, use [deactivateMotionGroup](deactivateMotionGroup).
|
|
11227
11244
|
* @summary Activate
|
|
@@ -11231,7 +11248,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
11231
11248
|
* @throws {RequiredError}
|
|
11232
11249
|
* @memberof MotionGroupApi
|
|
11233
11250
|
*/
|
|
11234
|
-
activateMotionGroup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
11251
|
+
activateMotionGroup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<MotionGroupInstance, any>>;
|
|
11235
11252
|
/**
|
|
11236
11253
|
* Deactivate a motion group. Activate the motion group and keeps the motion group in an active status. The robot controller streams information about all active motion groups. Deactivate motion groups that you no longer use. When deactivating motion groups, it is not possible to interact with the controller in any other way.
|
|
11237
11254
|
* @summary Deactivate
|
|
@@ -11241,7 +11258,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
11241
11258
|
* @throws {RequiredError}
|
|
11242
11259
|
* @memberof MotionGroupApi
|
|
11243
11260
|
*/
|
|
11244
|
-
deactivateMotionGroup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
11261
|
+
deactivateMotionGroup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
11245
11262
|
/**
|
|
11246
11263
|
* List all active motion groups. A motion group is active if it is currently used by a controller.
|
|
11247
11264
|
* @summary List Active
|
|
@@ -11250,7 +11267,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
11250
11267
|
* @throws {RequiredError}
|
|
11251
11268
|
* @memberof MotionGroupApi
|
|
11252
11269
|
*/
|
|
11253
|
-
listMotionGroups(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
11270
|
+
listMotionGroups(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<MotionGroupInstanceList, any>>;
|
|
11254
11271
|
}
|
|
11255
11272
|
/**
|
|
11256
11273
|
* MotionGroupInfosApi - axios parameter creator
|
|
@@ -11607,7 +11624,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
11607
11624
|
* @throws {RequiredError}
|
|
11608
11625
|
* @memberof MotionGroupInfosApi
|
|
11609
11626
|
*/
|
|
11610
|
-
getActivePayload(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
11627
|
+
getActivePayload(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<Payload, any>>;
|
|
11611
11628
|
/**
|
|
11612
11629
|
* Get the internal selected TCP of a connected device.
|
|
11613
11630
|
* @summary Selected TCP
|
|
@@ -11618,7 +11635,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
11618
11635
|
* @throws {RequiredError}
|
|
11619
11636
|
* @memberof MotionGroupInfosApi
|
|
11620
11637
|
*/
|
|
11621
|
-
getActiveTcp(cell: string, motionGroup: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<
|
|
11638
|
+
getActiveTcp(cell: string, motionGroup: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<RobotTcp, any>>;
|
|
11622
11639
|
/**
|
|
11623
11640
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
11624
11641
|
* @summary State of Device
|
|
@@ -11630,7 +11647,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
11630
11647
|
* @throws {RequiredError}
|
|
11631
11648
|
* @memberof MotionGroupInfosApi
|
|
11632
11649
|
*/
|
|
11633
|
-
getCurrentMotionGroupState(cell: string, motionGroup: string, tcp?: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
11650
|
+
getCurrentMotionGroupState(cell: string, motionGroup: string, tcp?: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<MotionGroupStateResponse, any>>;
|
|
11634
11651
|
/**
|
|
11635
11652
|
* Shows the options the motion group offers in regard to the information service. Some motion groups may not provide all information services, e.g. some manufacturers don\'t have a blending zone concept.
|
|
11636
11653
|
* @summary Capabilities
|
|
@@ -11640,7 +11657,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
11640
11657
|
* @throws {RequiredError}
|
|
11641
11658
|
* @memberof MotionGroupInfosApi
|
|
11642
11659
|
*/
|
|
11643
|
-
getInfoCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
11660
|
+
getInfoCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<InfoServiceCapabilities, any>>;
|
|
11644
11661
|
/**
|
|
11645
11662
|
* Get static properties of the motion group. Those properties are used internally for motion group plannning. Only supported motion groups will return a valid response.
|
|
11646
11663
|
* @summary Get Static Properties
|
|
@@ -11650,7 +11667,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
11650
11667
|
* @throws {RequiredError}
|
|
11651
11668
|
* @memberof MotionGroupInfosApi
|
|
11652
11669
|
*/
|
|
11653
|
-
getMotionGroupSpecification(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
11670
|
+
getMotionGroupSpecification(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<MotionGroupSpecification, any>>;
|
|
11654
11671
|
/**
|
|
11655
11672
|
* Returns the configured mounting pose offset in relation to world coordinate system and the motion groups coordinate system.
|
|
11656
11673
|
* @summary Device Mounting
|
|
@@ -11660,7 +11677,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
11660
11677
|
* @throws {RequiredError}
|
|
11661
11678
|
* @memberof MotionGroupInfosApi
|
|
11662
11679
|
*/
|
|
11663
|
-
getMounting(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
11680
|
+
getMounting(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<Mounting, any>>;
|
|
11664
11681
|
/**
|
|
11665
11682
|
* <!-- theme: danger --> > **Experimental** Get the complete configuration which can be passed to the planner-optimizer (incl. motion group description, limits etc.)
|
|
11666
11683
|
* @summary Optimizer Configuration
|
|
@@ -11671,7 +11688,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
11671
11688
|
* @throws {RequiredError}
|
|
11672
11689
|
* @memberof MotionGroupInfosApi
|
|
11673
11690
|
*/
|
|
11674
|
-
getOptimizerConfiguration(cell: string, motionGroup: string, tcp?: string, options?: RawAxiosRequestConfig): Promise<
|
|
11691
|
+
getOptimizerConfiguration(cell: string, motionGroup: string, tcp?: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<OptimizerSetup, any>>;
|
|
11675
11692
|
/**
|
|
11676
11693
|
* Get the safety setup and limitations of a connected device, which restricts the device. Safety settings are configured globally on the robot controller and are valid for all the connected devices (like robots).
|
|
11677
11694
|
* @summary Safety Setup and Limitations
|
|
@@ -11681,7 +11698,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
11681
11698
|
* @throws {RequiredError}
|
|
11682
11699
|
* @memberof MotionGroupInfosApi
|
|
11683
11700
|
*/
|
|
11684
|
-
getSafetySetup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
11701
|
+
getSafetySetup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<SafetySetup, any>>;
|
|
11685
11702
|
/**
|
|
11686
11703
|
* Lists all defined payloads of the motion group. The payload is defined as the sum of all weights attached to the flange/endpoint of the motion group, e.g. sum of the tools and workpiece weight that are currently attached.
|
|
11687
11704
|
* @summary List Payloads
|
|
@@ -11691,7 +11708,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
11691
11708
|
* @throws {RequiredError}
|
|
11692
11709
|
* @memberof MotionGroupInfosApi
|
|
11693
11710
|
*/
|
|
11694
|
-
listPayloads(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
11711
|
+
listPayloads(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ListPayloadsResponse, any>>;
|
|
11695
11712
|
/**
|
|
11696
11713
|
* Get all internal configured TCPs of a connected device.
|
|
11697
11714
|
* @summary List TCPs
|
|
@@ -11702,7 +11719,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
11702
11719
|
* @throws {RequiredError}
|
|
11703
11720
|
* @memberof MotionGroupInfosApi
|
|
11704
11721
|
*/
|
|
11705
|
-
listTcps(cell: string, motionGroup: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<
|
|
11722
|
+
listTcps(cell: string, motionGroup: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ListTcpsResponse, any>>;
|
|
11706
11723
|
/**
|
|
11707
11724
|
* Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
11708
11725
|
* @summary Stream State of Device
|
|
@@ -11715,7 +11732,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
11715
11732
|
* @throws {RequiredError}
|
|
11716
11733
|
* @memberof MotionGroupInfosApi
|
|
11717
11734
|
*/
|
|
11718
|
-
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, tcp?: string, options?: RawAxiosRequestConfig): Promise<
|
|
11735
|
+
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, tcp?: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<MotionGroupStateResponse, any>>;
|
|
11719
11736
|
}
|
|
11720
11737
|
/**
|
|
11721
11738
|
* MotionGroupJoggingApi - axios parameter creator
|
|
@@ -11859,7 +11876,7 @@ declare class MotionGroupJoggingApi extends BaseAPI {
|
|
|
11859
11876
|
* @throws {RequiredError}
|
|
11860
11877
|
* @memberof MotionGroupJoggingApi
|
|
11861
11878
|
*/
|
|
11862
|
-
directionJogging(cell: string, directionJoggingRequest: DirectionJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
11879
|
+
directionJogging(cell: string, directionJoggingRequest: DirectionJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<JoggingResponse, any>>;
|
|
11863
11880
|
/**
|
|
11864
11881
|
* Shows the options the motion group offers in regard to jogging. Some motion groups may not provide all information services, e.g. it is physically not possible to move a one-axis-turntable in a linear way.
|
|
11865
11882
|
* @summary Capabilities
|
|
@@ -11869,7 +11886,7 @@ declare class MotionGroupJoggingApi extends BaseAPI {
|
|
|
11869
11886
|
* @throws {RequiredError}
|
|
11870
11887
|
* @memberof MotionGroupJoggingApi
|
|
11871
11888
|
*/
|
|
11872
|
-
getJoggingCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
11889
|
+
getJoggingCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<JoggingServiceCapabilities, any>>;
|
|
11873
11890
|
/**
|
|
11874
11891
|
* Move one or more joints of a motion group with specified velocities via a websocket. The purpose of a joint jogging motion is to maneuver a motion group in one or more joints with a specified velocity for each joint. The sign of the velocity determines the direction of the joint movement. The velocity is given in [rad/s]. In contrast to a planned motion, a jogging motion can be changed dynamically while the motion group is in motion. Only one single client at a time can jog a particular motion group. If another client tries to jog the same motion group at the same time, the second call will fail. The movement of the motion group will start as soon as: * the motion group is not in motion * the websocket connection is established * the first request has been sent As long as the jogging motion is ongoing, responses will be sent continuously and contain the current state of the motion group. The responses will be sent with the specified rate according to the *response_rate* parameter of the initial websocket request. While in motion, the desired joint velocity can be changed by sending a new request to the same websocket. The motion and sending of the replies will stop when: * a [stopJogging](stopJogging) request was received, processed, and the movement stopped Motion group state will be published in the original command stream until the motion group has fully stopped. * the client cancels the stream (not recommended, because final stopping position will not be returned from the stream) When a physical limit (e.g. joint limit) is reached, the motion group will stop moving in the desired direction. The stream, howewer, will continue to send the state until the client cancels the stream or sends the [stopJogging](stopJogging) request. **Usage example:** 1. Open a websocket via python and start the jogging motion: ```bash > python -m websockets \"ws://<IP of Wandelbots NOVA API>/api/v1/cells/<your cell id>/motion-groups/move-joint\" ``` 2. Send the following message to move with a velocity of 0.1 rad/s (negative) for joint 5 and 0.2 rad/s for joint 6: ```json { \"motion_group\": \"<your motion group id>\", \"joint_velocities\": [0, 0, 0, 0, -0.1, 0.2], \"response_rate\": 500 } ``` The provided NOVA API clients also natively support jogging motions, without the need to manually open a websocket. > **NOTE** > > If the jogging movement is stopped immediately, ensure that > > - A websocket connection is established. Websockets can be kept open until the robot\'s movement is done as opposed to a simple HTTP GET request. > > - The motion group is not in motion by another jogging movement or a planned movement. > **NOTE** > > If the robot does not move, ensure that > > - The joint velocity values are not zero, > > - The motion group is not in a state where it cannot move further (e.g. joint limit reached). > **NOTE** > > If the specified velocities are higher than the maximum allowed by the robot controller, the motion group will move with the maximum allowed velocities.
|
|
11875
11892
|
* @summary Stream Joints
|
|
@@ -11879,7 +11896,7 @@ declare class MotionGroupJoggingApi extends BaseAPI {
|
|
|
11879
11896
|
* @throws {RequiredError}
|
|
11880
11897
|
* @memberof MotionGroupJoggingApi
|
|
11881
11898
|
*/
|
|
11882
|
-
jointJogging(cell: string, jointJoggingRequest: JointJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
11899
|
+
jointJogging(cell: string, jointJoggingRequest: JointJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<JoggingResponse, any>>;
|
|
11883
11900
|
/**
|
|
11884
11901
|
* Stops an ongoing jogging movement as fast as possible. Until the motion group reaches standstill, it decelerates and keeps the last specified direction. This call will immediately return even if the deceleration is still in progress. After a stop request has been received, no further updates to the ongoing jogging movement are possible. State responses will be sent via the jogging stream until the motion group reaches standstill.
|
|
11885
11902
|
* @summary Stop
|
|
@@ -11889,7 +11906,7 @@ declare class MotionGroupJoggingApi extends BaseAPI {
|
|
|
11889
11906
|
* @throws {RequiredError}
|
|
11890
11907
|
* @memberof MotionGroupJoggingApi
|
|
11891
11908
|
*/
|
|
11892
|
-
stopJogging(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
11909
|
+
stopJogging(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
11893
11910
|
}
|
|
11894
11911
|
/**
|
|
11895
11912
|
* MotionGroupKinematicApi - axios parameter creator
|
|
@@ -12043,7 +12060,7 @@ declare class MotionGroupKinematicApi extends BaseAPI {
|
|
|
12043
12060
|
* @throws {RequiredError}
|
|
12044
12061
|
* @memberof MotionGroupKinematicApi
|
|
12045
12062
|
*/
|
|
12046
|
-
calculateAllInverseKinematic(cell: string, motionGroup: string, allJointPositionsRequest: AllJointPositionsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
12063
|
+
calculateAllInverseKinematic(cell: string, motionGroup: string, allJointPositionsRequest: AllJointPositionsRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<AllJointPositionsResponse, any>>;
|
|
12047
12064
|
/**
|
|
12048
12065
|
* Calculates the TCP pose from a joint position sample using the forward kinematics of the motion-group.
|
|
12049
12066
|
* @summary TcpPose from JointPosition
|
|
@@ -12054,7 +12071,7 @@ declare class MotionGroupKinematicApi extends BaseAPI {
|
|
|
12054
12071
|
* @throws {RequiredError}
|
|
12055
12072
|
* @memberof MotionGroupKinematicApi
|
|
12056
12073
|
*/
|
|
12057
|
-
calculateForwardKinematic(cell: string, motionGroup: string, tcpPoseRequest: TcpPoseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
12074
|
+
calculateForwardKinematic(cell: string, motionGroup: string, tcpPoseRequest: TcpPoseRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<Pose, any>>;
|
|
12058
12075
|
/**
|
|
12059
12076
|
* Calculate the joint positions the motion-group needs to apply for its TCP to be in a specified pose (Inverse Kinematic Solution). If multiple solutions are found, the one nearest to the given specified joint position is picked. * For all supported robot models, except the Fanuc CRX line, the returned joint position is guaranteed to have the same configuration (often referred to as ELBOW_UP, WRIST_DOWN, SHOULDER_RIGHT, f.e.) as the specified reference joint position. If the position limit of any single joint allows it to be in a range larger than 2 PI, the respective joint value in the result will be as close as possible to its reference value. * For the Fanuc CRX line the solution is selected to have the smallest distance measured by the norm of its difference to the reference joint position. The returned joint position is guaranteed to be within the joint limits and not in a singular position of the robot.
|
|
12060
12077
|
* @summary Nearest JointPosition from TcpPose
|
|
@@ -12065,7 +12082,7 @@ declare class MotionGroupKinematicApi extends BaseAPI {
|
|
|
12065
12082
|
* @throws {RequiredError}
|
|
12066
12083
|
* @memberof MotionGroupKinematicApi
|
|
12067
12084
|
*/
|
|
12068
|
-
calculateInverseKinematic(cell: string, motionGroup: string, jointPositionRequest: JointPositionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
12085
|
+
calculateInverseKinematic(cell: string, motionGroup: string, jointPositionRequest: JointPositionRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<Joints, any>>;
|
|
12069
12086
|
/**
|
|
12070
12087
|
* Get the kinematic endpoints provided for the specified motion-group.
|
|
12071
12088
|
* @summary Capabilities
|
|
@@ -12075,7 +12092,7 @@ declare class MotionGroupKinematicApi extends BaseAPI {
|
|
|
12075
12092
|
* @throws {RequiredError}
|
|
12076
12093
|
* @memberof MotionGroupKinematicApi
|
|
12077
12094
|
*/
|
|
12078
|
-
getKinematicCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
12095
|
+
getKinematicCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<KinematicServiceCapabilities, any>>;
|
|
12079
12096
|
}
|
|
12080
12097
|
/**
|
|
12081
12098
|
* ProgramApi - axios parameter creator
|
|
@@ -12324,7 +12341,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
12324
12341
|
* @throws {RequiredError}
|
|
12325
12342
|
* @memberof ProgramApi
|
|
12326
12343
|
*/
|
|
12327
|
-
createProgramRunner(cell: string, request: Request, options?: RawAxiosRequestConfig): Promise<
|
|
12344
|
+
createProgramRunner(cell: string, request: Request, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ProgramRunnerReference, any>>;
|
|
12328
12345
|
/**
|
|
12329
12346
|
* Execute a program in Wandelscript. The Wandelscript can also move multiple robots by using the \'do with\' syntax. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a succesful execution. Otherwise an error (e.g. out of reach, singularity), is returned. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
|
|
12330
12347
|
* @summary Execute Program
|
|
@@ -12334,7 +12351,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
12334
12351
|
* @throws {RequiredError}
|
|
12335
12352
|
* @memberof ProgramApi
|
|
12336
12353
|
*/
|
|
12337
|
-
executeProgram(cell: string, codeWithArguments: CodeWithArguments, options?: RawAxiosRequestConfig): Promise<
|
|
12354
|
+
executeProgram(cell: string, codeWithArguments: CodeWithArguments, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ProgramRun, any>>;
|
|
12338
12355
|
/**
|
|
12339
12356
|
* Returns information about a program currently executed. When a program is finished: Program response, result, collected Wandelscript logs, etc. When a program is running: Running status, current executed line, etc. ## Parameters - **runner_id**: The id of the program runner
|
|
12340
12357
|
* @summary Get Program Runner
|
|
@@ -12344,7 +12361,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
12344
12361
|
* @throws {RequiredError}
|
|
12345
12362
|
* @memberof ProgramApi
|
|
12346
12363
|
*/
|
|
12347
|
-
getProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<
|
|
12364
|
+
getProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ProgramRun, any>>;
|
|
12348
12365
|
/**
|
|
12349
12366
|
* Get details about all existing program runners.
|
|
12350
12367
|
* @summary List Program Runners
|
|
@@ -12353,7 +12370,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
12353
12370
|
* @throws {RequiredError}
|
|
12354
12371
|
* @memberof ProgramApi
|
|
12355
12372
|
*/
|
|
12356
|
-
listProgramRunners(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
12373
|
+
listProgramRunners(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ProgramRunnerReference[], any>>;
|
|
12357
12374
|
/**
|
|
12358
12375
|
* Migrate a program ## Parameters See the **Schema** tab for information about the request body
|
|
12359
12376
|
* @summary Migrate Program
|
|
@@ -12363,7 +12380,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
12363
12380
|
* @throws {RequiredError}
|
|
12364
12381
|
* @memberof ProgramApi
|
|
12365
12382
|
*/
|
|
12366
|
-
migrateProgram(cell: string, request1: Request1, options?: RawAxiosRequestConfig): Promise<
|
|
12383
|
+
migrateProgram(cell: string, request1: Request1, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<string, any>>;
|
|
12367
12384
|
/**
|
|
12368
12385
|
* Plan a program based on the specified robot type. The plan operation can be used to check if a Wandelscript is executable, given the current joint configuration of the robot. If the Wandelscript is executable, the result contains the motion path. If the Wandelscript is not executable, e.g. points that are out of reach, or the joints encounter a singularity, the reason is returned. The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as Content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
|
|
12369
12386
|
* @summary Plan Program
|
|
@@ -12374,7 +12391,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
12374
12391
|
* @throws {RequiredError}
|
|
12375
12392
|
* @memberof ProgramApi
|
|
12376
12393
|
*/
|
|
12377
|
-
planProgram(cell: string, request: Request, identifier?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12394
|
+
planProgram(cell: string, request: Request, identifier?: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ProgramRun, any>>;
|
|
12378
12395
|
/**
|
|
12379
12396
|
* Stop all runners.
|
|
12380
12397
|
* @summary Stop All Program Runners
|
|
@@ -12383,7 +12400,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
12383
12400
|
* @throws {RequiredError}
|
|
12384
12401
|
* @memberof ProgramApi
|
|
12385
12402
|
*/
|
|
12386
|
-
stopAllProgramRunner(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
12403
|
+
stopAllProgramRunner(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<any, any>>;
|
|
12387
12404
|
/**
|
|
12388
12405
|
* Stop a specific program runner. If the indicated runner was not running, an error will be returned. ## Parameters - **runner_id**: The id of the program runner
|
|
12389
12406
|
* @summary Stop Program Runner
|
|
@@ -12393,7 +12410,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
12393
12410
|
* @throws {RequiredError}
|
|
12394
12411
|
* @memberof ProgramApi
|
|
12395
12412
|
*/
|
|
12396
|
-
stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<
|
|
12413
|
+
stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
12397
12414
|
}
|
|
12398
12415
|
/**
|
|
12399
12416
|
* ProgramOperatorApi - axios parameter creator
|
|
@@ -12645,7 +12662,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
12645
12662
|
* @throws {RequiredError}
|
|
12646
12663
|
* @memberof ProgramOperatorApi
|
|
12647
12664
|
*/
|
|
12648
|
-
createProgramRun(cell: string, createProgramRunRequest: CreateProgramRunRequest, options?: RawAxiosRequestConfig): Promise<
|
|
12665
|
+
createProgramRun(cell: string, createProgramRunRequest: CreateProgramRunRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<CreateProgramRun200Response, any>>;
|
|
12649
12666
|
/**
|
|
12650
12667
|
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
12651
12668
|
* @summary Create Trigger
|
|
@@ -12655,7 +12672,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
12655
12672
|
* @throws {RequiredError}
|
|
12656
12673
|
* @memberof ProgramOperatorApi
|
|
12657
12674
|
*/
|
|
12658
|
-
createTrigger(cell: string, createTriggerRequest: CreateTriggerRequest, options?: RawAxiosRequestConfig): Promise<
|
|
12675
|
+
createTrigger(cell: string, createTriggerRequest: CreateTriggerRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<CreateTrigger200Response, any>>;
|
|
12659
12676
|
/**
|
|
12660
12677
|
* <!-- theme: danger --> > **Experimental** Delete an existing trigger.
|
|
12661
12678
|
* @summary Delete Trigger
|
|
@@ -12665,7 +12682,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
12665
12682
|
* @throws {RequiredError}
|
|
12666
12683
|
* @memberof ProgramOperatorApi
|
|
12667
12684
|
*/
|
|
12668
|
-
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
12685
|
+
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
12669
12686
|
/**
|
|
12670
12687
|
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
12671
12688
|
* @summary Get All Program Runs
|
|
@@ -12675,7 +12692,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
12675
12692
|
* @throws {RequiredError}
|
|
12676
12693
|
* @memberof ProgramOperatorApi
|
|
12677
12694
|
*/
|
|
12678
|
-
getAllProgramRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<
|
|
12695
|
+
getAllProgramRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<GetAllProgramRuns200Response, any>>;
|
|
12679
12696
|
/**
|
|
12680
12697
|
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
|
|
12681
12698
|
* @summary Get All Triggers
|
|
@@ -12684,7 +12701,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
12684
12701
|
* @throws {RequiredError}
|
|
12685
12702
|
* @memberof ProgramOperatorApi
|
|
12686
12703
|
*/
|
|
12687
|
-
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
12704
|
+
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<GetAllTriggers200Response, any>>;
|
|
12688
12705
|
/**
|
|
12689
12706
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
12690
12707
|
* @summary Get Program Run
|
|
@@ -12694,7 +12711,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
12694
12711
|
* @throws {RequiredError}
|
|
12695
12712
|
* @memberof ProgramOperatorApi
|
|
12696
12713
|
*/
|
|
12697
|
-
getProgramRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
12714
|
+
getProgramRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ProgramRunObject, any>>;
|
|
12698
12715
|
/**
|
|
12699
12716
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
12700
12717
|
* @summary Get Trigger
|
|
@@ -12704,7 +12721,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
12704
12721
|
* @throws {RequiredError}
|
|
12705
12722
|
* @memberof ProgramOperatorApi
|
|
12706
12723
|
*/
|
|
12707
|
-
getTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
12724
|
+
getTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<TriggerObject, any>>;
|
|
12708
12725
|
/**
|
|
12709
12726
|
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
12710
12727
|
* @summary Update Trigger
|
|
@@ -12715,7 +12732,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
12715
12732
|
* @throws {RequiredError}
|
|
12716
12733
|
* @memberof ProgramOperatorApi
|
|
12717
12734
|
*/
|
|
12718
|
-
updateTrigger(trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options?: RawAxiosRequestConfig): Promise<
|
|
12735
|
+
updateTrigger(trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<TriggerObject, any>>;
|
|
12719
12736
|
}
|
|
12720
12737
|
/**
|
|
12721
12738
|
* ProgramValuesApi - axios parameter creator
|
|
@@ -12938,7 +12955,7 @@ declare class ProgramValuesApi extends BaseAPI {
|
|
|
12938
12955
|
* @throws {RequiredError}
|
|
12939
12956
|
* @memberof ProgramValuesApi
|
|
12940
12957
|
*/
|
|
12941
|
-
clearProgramsValues(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
12958
|
+
clearProgramsValues(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
12942
12959
|
/**
|
|
12943
12960
|
* Deprecated endpoint. Add or overwrite one or more values in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
|
|
12944
12961
|
* @summary Add Value(s)
|
|
@@ -12951,7 +12968,7 @@ declare class ProgramValuesApi extends BaseAPI {
|
|
|
12951
12968
|
*/
|
|
12952
12969
|
createProgramsValue(cell: string, requestBody: {
|
|
12953
12970
|
[key: string]: CollectionValue;
|
|
12954
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
12971
|
+
}, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
12955
12972
|
/**
|
|
12956
12973
|
* Delete a value from the database.
|
|
12957
12974
|
* @summary Delete Value
|
|
@@ -12962,7 +12979,7 @@ declare class ProgramValuesApi extends BaseAPI {
|
|
|
12962
12979
|
* @throws {RequiredError}
|
|
12963
12980
|
* @memberof ProgramValuesApi
|
|
12964
12981
|
*/
|
|
12965
|
-
deleteProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
12982
|
+
deleteProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
12966
12983
|
/**
|
|
12967
12984
|
* Deprecated endpoint. Return a value stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value store. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
|
|
12968
12985
|
* @summary Get Value
|
|
@@ -12973,7 +12990,7 @@ declare class ProgramValuesApi extends BaseAPI {
|
|
|
12973
12990
|
* @throws {RequiredError}
|
|
12974
12991
|
* @memberof ProgramValuesApi
|
|
12975
12992
|
*/
|
|
12976
|
-
getProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
12993
|
+
getProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ResponseGetValueProgramsValuesKeyGet, any>>;
|
|
12977
12994
|
/**
|
|
12978
12995
|
* Deprecated endpoint. Gets all values that are stored in the database. PREREQUISITE: The database has been added as a device. Add the database with [createDevice](createDevice). The database itself is a key-value storage. For reference of possible data types see: * [Documentation for elementary data types](/docs/docs/wandelscript/data-types/#elementary-types)
|
|
12979
12996
|
* @summary Get Values
|
|
@@ -12983,7 +13000,7 @@ declare class ProgramValuesApi extends BaseAPI {
|
|
|
12983
13000
|
* @throws {RequiredError}
|
|
12984
13001
|
* @memberof ProgramValuesApi
|
|
12985
13002
|
*/
|
|
12986
|
-
listProgramsValues(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
13003
|
+
listProgramsValues(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<{
|
|
12987
13004
|
[key: string]: ResponseGetValuesProgramsValuesGetValue;
|
|
12988
13005
|
}, any>>;
|
|
12989
13006
|
/**
|
|
@@ -12997,7 +13014,7 @@ declare class ProgramValuesApi extends BaseAPI {
|
|
|
12997
13014
|
* @throws {RequiredError}
|
|
12998
13015
|
* @memberof ProgramValuesApi
|
|
12999
13016
|
*/
|
|
13000
|
-
updateProgramValue(cell: string, key: string, value: Value, options?: RawAxiosRequestConfig): Promise<
|
|
13017
|
+
updateProgramValue(cell: string, key: string, value: Value, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
13001
13018
|
}
|
|
13002
13019
|
/**
|
|
13003
13020
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
@@ -13032,11 +13049,12 @@ declare const StoreCollisionComponentsApiAxiosParamCreator: (configuration?: Con
|
|
|
13032
13049
|
*/
|
|
13033
13050
|
deleteStoredCollisionTool: (cell: string, tool: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13034
13051
|
/**
|
|
13035
|
-
* Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
13052
|
+
* Deprecated endpoint. Use [getCollisionModel](https://portal.wandelbots.io/docs/api/v2/ui/#/operations/getMotionGroupCollisionModel) instead. Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
13036
13053
|
* @summary Get Default Link Chain
|
|
13037
13054
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13038
13055
|
* @param {GetDefaultLinkChainMotionGroupModelEnum} motionGroupModel Unique identifier for the type of a motion group (robot model). Get the model name for a configured motion group from [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
13039
13056
|
* @param {*} [options] Override http request option.
|
|
13057
|
+
* @deprecated
|
|
13040
13058
|
* @throws {RequiredError}
|
|
13041
13059
|
*/
|
|
13042
13060
|
getDefaultLinkChain: (cell: string, motionGroupModel: GetDefaultLinkChainMotionGroupModelEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -13159,11 +13177,12 @@ declare const StoreCollisionComponentsApiFp: (configuration?: Configuration) =>
|
|
|
13159
13177
|
*/
|
|
13160
13178
|
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
13161
13179
|
/**
|
|
13162
|
-
* Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
13180
|
+
* Deprecated endpoint. Use [getCollisionModel](https://portal.wandelbots.io/docs/api/v2/ui/#/operations/getMotionGroupCollisionModel) instead. Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
13163
13181
|
* @summary Get Default Link Chain
|
|
13164
13182
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13165
13183
|
* @param {GetDefaultLinkChainMotionGroupModelEnum} motionGroupModel Unique identifier for the type of a motion group (robot model). Get the model name for a configured motion group from [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
13166
13184
|
* @param {*} [options] Override http request option.
|
|
13185
|
+
* @deprecated
|
|
13167
13186
|
* @throws {RequiredError}
|
|
13168
13187
|
*/
|
|
13169
13188
|
getDefaultLinkChain(cell: string, motionGroupModel: GetDefaultLinkChainMotionGroupModelEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<{
|
|
@@ -13306,11 +13325,12 @@ declare const StoreCollisionComponentsApiFactory: (configuration?: Configuration
|
|
|
13306
13325
|
*/
|
|
13307
13326
|
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
13308
13327
|
/**
|
|
13309
|
-
* Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
13328
|
+
* Deprecated endpoint. Use [getCollisionModel](https://portal.wandelbots.io/docs/api/v2/ui/#/operations/getMotionGroupCollisionModel) instead. Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
13310
13329
|
* @summary Get Default Link Chain
|
|
13311
13330
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13312
13331
|
* @param {GetDefaultLinkChainMotionGroupModelEnum} motionGroupModel Unique identifier for the type of a motion group (robot model). Get the model name for a configured motion group from [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
13313
13332
|
* @param {*} [options] Override http request option.
|
|
13333
|
+
* @deprecated
|
|
13314
13334
|
* @throws {RequiredError}
|
|
13315
13335
|
*/
|
|
13316
13336
|
getDefaultLinkChain(cell: string, motionGroupModel: GetDefaultLinkChainMotionGroupModelEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<{
|
|
@@ -13436,7 +13456,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
13436
13456
|
* @throws {RequiredError}
|
|
13437
13457
|
* @memberof StoreCollisionComponentsApi
|
|
13438
13458
|
*/
|
|
13439
|
-
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
13459
|
+
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
13440
13460
|
/**
|
|
13441
13461
|
* Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
|
|
13442
13462
|
* @summary Delete Link Chain
|
|
@@ -13446,7 +13466,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
13446
13466
|
* @throws {RequiredError}
|
|
13447
13467
|
* @memberof StoreCollisionComponentsApi
|
|
13448
13468
|
*/
|
|
13449
|
-
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
13469
|
+
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
13450
13470
|
/**
|
|
13451
13471
|
* Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
|
|
13452
13472
|
* @summary Delete Tool
|
|
@@ -13456,17 +13476,18 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
13456
13476
|
* @throws {RequiredError}
|
|
13457
13477
|
* @memberof StoreCollisionComponentsApi
|
|
13458
13478
|
*/
|
|
13459
|
-
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
13479
|
+
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
13460
13480
|
/**
|
|
13461
|
-
* Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
13481
|
+
* Deprecated endpoint. Use [getCollisionModel](https://portal.wandelbots.io/docs/api/v2/ui/#/operations/getMotionGroupCollisionModel) instead. Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
13462
13482
|
* @summary Get Default Link Chain
|
|
13463
13483
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13464
13484
|
* @param {GetDefaultLinkChainMotionGroupModelEnum} motionGroupModel Unique identifier for the type of a motion group (robot model). Get the model name for a configured motion group from [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
13465
13485
|
* @param {*} [options] Override http request option.
|
|
13486
|
+
* @deprecated
|
|
13466
13487
|
* @throws {RequiredError}
|
|
13467
13488
|
* @memberof StoreCollisionComponentsApi
|
|
13468
13489
|
*/
|
|
13469
|
-
getDefaultLinkChain(cell: string, motionGroupModel: GetDefaultLinkChainMotionGroupModelEnum, options?: RawAxiosRequestConfig): Promise<
|
|
13490
|
+
getDefaultLinkChain(cell: string, motionGroupModel: GetDefaultLinkChainMotionGroupModelEnum, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<{
|
|
13470
13491
|
[key: string]: Collider;
|
|
13471
13492
|
}[], any>>;
|
|
13472
13493
|
/**
|
|
@@ -13478,7 +13499,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
13478
13499
|
* @throws {RequiredError}
|
|
13479
13500
|
* @memberof StoreCollisionComponentsApi
|
|
13480
13501
|
*/
|
|
13481
|
-
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
13502
|
+
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<Collider, any>>;
|
|
13482
13503
|
/**
|
|
13483
13504
|
* Returns the collision link chain.
|
|
13484
13505
|
* @summary Get Link Chain
|
|
@@ -13488,7 +13509,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
13488
13509
|
* @throws {RequiredError}
|
|
13489
13510
|
* @memberof StoreCollisionComponentsApi
|
|
13490
13511
|
*/
|
|
13491
|
-
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
13512
|
+
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<{
|
|
13492
13513
|
[key: string]: Collider;
|
|
13493
13514
|
}[], any>>;
|
|
13494
13515
|
/**
|
|
@@ -13500,7 +13521,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
13500
13521
|
* @throws {RequiredError}
|
|
13501
13522
|
* @memberof StoreCollisionComponentsApi
|
|
13502
13523
|
*/
|
|
13503
|
-
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
13524
|
+
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<{
|
|
13504
13525
|
[key: string]: Collider;
|
|
13505
13526
|
}, any>>;
|
|
13506
13527
|
/**
|
|
@@ -13511,7 +13532,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
13511
13532
|
* @throws {RequiredError}
|
|
13512
13533
|
* @memberof StoreCollisionComponentsApi
|
|
13513
13534
|
*/
|
|
13514
|
-
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
13535
|
+
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<{
|
|
13515
13536
|
[key: string]: {
|
|
13516
13537
|
[key: string]: Collider;
|
|
13517
13538
|
}[];
|
|
@@ -13524,7 +13545,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
13524
13545
|
* @throws {RequiredError}
|
|
13525
13546
|
* @memberof StoreCollisionComponentsApi
|
|
13526
13547
|
*/
|
|
13527
|
-
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
13548
|
+
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<{
|
|
13528
13549
|
[key: string]: Collider;
|
|
13529
13550
|
}, any>>;
|
|
13530
13551
|
/**
|
|
@@ -13535,7 +13556,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
13535
13556
|
* @throws {RequiredError}
|
|
13536
13557
|
* @memberof StoreCollisionComponentsApi
|
|
13537
13558
|
*/
|
|
13538
|
-
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
13559
|
+
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<{
|
|
13539
13560
|
[key: string]: {
|
|
13540
13561
|
[key: string]: Collider;
|
|
13541
13562
|
};
|
|
@@ -13550,7 +13571,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
13550
13571
|
* @throws {RequiredError}
|
|
13551
13572
|
* @memberof StoreCollisionComponentsApi
|
|
13552
13573
|
*/
|
|
13553
|
-
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<
|
|
13574
|
+
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<Collider, any>>;
|
|
13554
13575
|
/**
|
|
13555
13576
|
* Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
|
|
13556
13577
|
* @summary Store Link Chain
|
|
@@ -13563,7 +13584,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
13563
13584
|
*/
|
|
13564
13585
|
storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{
|
|
13565
13586
|
[key: string]: Collider;
|
|
13566
|
-
}>, options?: RawAxiosRequestConfig): Promise<
|
|
13587
|
+
}>, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<{
|
|
13567
13588
|
[key: string]: Collider;
|
|
13568
13589
|
}[], any>>;
|
|
13569
13590
|
/**
|
|
@@ -13578,7 +13599,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
13578
13599
|
*/
|
|
13579
13600
|
storeCollisionTool(cell: string, tool: string, requestBody: {
|
|
13580
13601
|
[key: string]: Collider;
|
|
13581
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
13602
|
+
}, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<{
|
|
13582
13603
|
[key: string]: Collider;
|
|
13583
13604
|
}, any>>;
|
|
13584
13605
|
}
|
|
@@ -13612,6 +13633,7 @@ declare const GetDefaultLinkChainMotionGroupModelEnum: {
|
|
|
13612
13633
|
readonly Abb460020560: "ABB_4600_205_60";
|
|
13613
13634
|
readonly Abb460025020: "ABB_4600_250_20";
|
|
13614
13635
|
readonly Abb460025540: "ABB_4600_255_40";
|
|
13636
|
+
readonly Abb6730210310: "ABB_6730_210_310";
|
|
13615
13637
|
readonly FanucArcMate100iD: "FANUC_ARC_Mate_100iD";
|
|
13616
13638
|
readonly FanucArcMate100iD10L: "FANUC_ARC_Mate_100iD10L";
|
|
13617
13639
|
readonly FanucArcMate100iD16S: "FANUC_ARC_Mate_100iD16S";
|
|
@@ -13668,12 +13690,14 @@ declare const GetDefaultLinkChainMotionGroupModelEnum: {
|
|
|
13668
13690
|
readonly KukaKr20R1810: "KUKA_KR20_R1810";
|
|
13669
13691
|
readonly KukaKr20R18102: "KUKA_KR20_R1810_2";
|
|
13670
13692
|
readonly KukaKr210R2700: "KUKA_KR210_R2700";
|
|
13693
|
+
readonly KukaKr210R2700Extra: "KUKA_KR210_R2700_extra";
|
|
13671
13694
|
readonly KukaKr210R27002: "KUKA_KR210_R2700_2";
|
|
13672
13695
|
readonly KukaKr210R3100: "KUKA_KR210_R3100";
|
|
13673
13696
|
readonly KukaKr210R31002: "KUKA_KR210_R3100_2";
|
|
13674
13697
|
readonly KukaKr210R3300: "KUKA_KR210_R3300";
|
|
13675
13698
|
readonly KukaKr210R33002: "KUKA_KR210_R3300_2";
|
|
13676
13699
|
readonly KukaKr240R2700: "KUKA_KR240_R2700";
|
|
13700
|
+
readonly KukaKr240R2900: "KUKA_KR240_R2900";
|
|
13677
13701
|
readonly KukaKr250R27002: "KUKA_KR250_R2700_2";
|
|
13678
13702
|
readonly KukaKr270R2700: "KUKA_KR270_R2700";
|
|
13679
13703
|
readonly KukaKr270R3100: "KUKA_KR270_R3100";
|
|
@@ -13897,7 +13921,7 @@ declare class StoreCollisionScenesApi extends BaseAPI {
|
|
|
13897
13921
|
* @throws {RequiredError}
|
|
13898
13922
|
* @memberof StoreCollisionScenesApi
|
|
13899
13923
|
*/
|
|
13900
|
-
deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<
|
|
13924
|
+
deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
13901
13925
|
/**
|
|
13902
13926
|
* Returns the stored scene.
|
|
13903
13927
|
* @summary Get Scene
|
|
@@ -13907,7 +13931,7 @@ declare class StoreCollisionScenesApi extends BaseAPI {
|
|
|
13907
13931
|
* @throws {RequiredError}
|
|
13908
13932
|
* @memberof StoreCollisionScenesApi
|
|
13909
13933
|
*/
|
|
13910
|
-
getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<
|
|
13934
|
+
getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<CollisionScene, any>>;
|
|
13911
13935
|
/**
|
|
13912
13936
|
* Returns a list of stored scenes.
|
|
13913
13937
|
* @summary List Scenes
|
|
@@ -13916,7 +13940,7 @@ declare class StoreCollisionScenesApi extends BaseAPI {
|
|
|
13916
13940
|
* @throws {RequiredError}
|
|
13917
13941
|
* @memberof StoreCollisionScenesApi
|
|
13918
13942
|
*/
|
|
13919
|
-
listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
13943
|
+
listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<{
|
|
13920
13944
|
[key: string]: CollisionScene;
|
|
13921
13945
|
}, any>>;
|
|
13922
13946
|
/**
|
|
@@ -13929,7 +13953,7 @@ declare class StoreCollisionScenesApi extends BaseAPI {
|
|
|
13929
13953
|
* @throws {RequiredError}
|
|
13930
13954
|
* @memberof StoreCollisionScenesApi
|
|
13931
13955
|
*/
|
|
13932
|
-
storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<
|
|
13956
|
+
storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<CollisionScene, any>>;
|
|
13933
13957
|
}
|
|
13934
13958
|
/**
|
|
13935
13959
|
* StoreObjectApi - axios parameter creator
|
|
@@ -14132,7 +14156,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
14132
14156
|
* @throws {RequiredError}
|
|
14133
14157
|
* @memberof StoreObjectApi
|
|
14134
14158
|
*/
|
|
14135
|
-
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
14159
|
+
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
14136
14160
|
/**
|
|
14137
14161
|
* Delete an object <!-- theme: danger --> > This will delete persistently stored data.
|
|
14138
14162
|
* @summary Delete Object
|
|
@@ -14142,7 +14166,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
14142
14166
|
* @throws {RequiredError}
|
|
14143
14167
|
* @memberof StoreObjectApi
|
|
14144
14168
|
*/
|
|
14145
|
-
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
14169
|
+
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
14146
14170
|
/**
|
|
14147
14171
|
* Get the object. This request returns the object and any metadata attached to it.
|
|
14148
14172
|
* @summary Get Object
|
|
@@ -14152,7 +14176,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
14152
14176
|
* @throws {RequiredError}
|
|
14153
14177
|
* @memberof StoreObjectApi
|
|
14154
14178
|
*/
|
|
14155
|
-
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
14179
|
+
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<File, any>>;
|
|
14156
14180
|
/**
|
|
14157
14181
|
* Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
|
|
14158
14182
|
* @summary Get Object Metadata
|
|
@@ -14162,7 +14186,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
14162
14186
|
* @throws {RequiredError}
|
|
14163
14187
|
* @memberof StoreObjectApi
|
|
14164
14188
|
*/
|
|
14165
|
-
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
14189
|
+
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
14166
14190
|
/**
|
|
14167
14191
|
* List the keys for all objects.
|
|
14168
14192
|
* @summary List all Object Keys
|
|
@@ -14171,7 +14195,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
14171
14195
|
* @throws {RequiredError}
|
|
14172
14196
|
* @memberof StoreObjectApi
|
|
14173
14197
|
*/
|
|
14174
|
-
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
14198
|
+
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<string[], any>>;
|
|
14175
14199
|
/**
|
|
14176
14200
|
* Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
|
|
14177
14201
|
* @summary Store Object
|
|
@@ -14185,7 +14209,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
14185
14209
|
*/
|
|
14186
14210
|
storeObject(cell: string, key: string, xMetadata?: {
|
|
14187
14211
|
[key: string]: string;
|
|
14188
|
-
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<
|
|
14212
|
+
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
14189
14213
|
}
|
|
14190
14214
|
/**
|
|
14191
14215
|
* SystemApi - axios parameter creator
|
|
@@ -14331,7 +14355,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
14331
14355
|
* @throws {RequiredError}
|
|
14332
14356
|
* @memberof SystemApi
|
|
14333
14357
|
*/
|
|
14334
|
-
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
14358
|
+
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<string, any>>;
|
|
14335
14359
|
/**
|
|
14336
14360
|
* Collects information on the current status of all NOVA services and exports them as a .zip file. Includes information on all cells on the instance such as the service logs and virtual robot controllers. From each cell the logs of all services are included, as well as the configuration of each connected controller to start virtual robots.
|
|
14337
14361
|
* @summary Download Diagnosis Package
|
|
@@ -14339,7 +14363,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
14339
14363
|
* @throws {RequiredError}
|
|
14340
14364
|
* @memberof SystemApi
|
|
14341
14365
|
*/
|
|
14342
|
-
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<
|
|
14366
|
+
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<File, any>>;
|
|
14343
14367
|
/**
|
|
14344
14368
|
* Get the status of all system services.
|
|
14345
14369
|
* @summary Wandelbots NOVA status
|
|
@@ -14347,7 +14371,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
14347
14371
|
* @throws {RequiredError}
|
|
14348
14372
|
* @memberof SystemApi
|
|
14349
14373
|
*/
|
|
14350
|
-
getSystemStatus(options?: RawAxiosRequestConfig): Promise<
|
|
14374
|
+
getSystemStatus(options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ServiceStatus[], any>>;
|
|
14351
14375
|
/**
|
|
14352
14376
|
* Get the current Wandelbots NOVA version.
|
|
14353
14377
|
* @summary Wandelbots NOVA Version
|
|
@@ -14355,7 +14379,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
14355
14379
|
* @throws {RequiredError}
|
|
14356
14380
|
* @memberof SystemApi
|
|
14357
14381
|
*/
|
|
14358
|
-
getSystemVersion(options?: RawAxiosRequestConfig): Promise<
|
|
14382
|
+
getSystemVersion(options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<string, any>>;
|
|
14359
14383
|
/**
|
|
14360
14384
|
* Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If an error occurs, the API Request is sent 3 times. If the error persists, the old Wandelbots NOVA version is restored.
|
|
14361
14385
|
* @summary Update Wandelbots NOVA version
|
|
@@ -14364,7 +14388,62 @@ declare class SystemApi extends BaseAPI {
|
|
|
14364
14388
|
* @throws {RequiredError}
|
|
14365
14389
|
* @memberof SystemApi
|
|
14366
14390
|
*/
|
|
14367
|
-
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
14391
|
+
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<void, any>>;
|
|
14392
|
+
}
|
|
14393
|
+
/**
|
|
14394
|
+
* VersionApi - axios parameter creator
|
|
14395
|
+
* @export
|
|
14396
|
+
*/
|
|
14397
|
+
declare const VersionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
14398
|
+
/**
|
|
14399
|
+
* Retrieves the version of the NOVA API.
|
|
14400
|
+
* @summary API Version
|
|
14401
|
+
* @param {*} [options] Override http request option.
|
|
14402
|
+
* @throws {RequiredError}
|
|
14403
|
+
*/
|
|
14404
|
+
getApiVersion: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14405
|
+
};
|
|
14406
|
+
/**
|
|
14407
|
+
* VersionApi - functional programming interface
|
|
14408
|
+
* @export
|
|
14409
|
+
*/
|
|
14410
|
+
declare const VersionApiFp: (configuration?: Configuration) => {
|
|
14411
|
+
/**
|
|
14412
|
+
* Retrieves the version of the NOVA API.
|
|
14413
|
+
* @summary API Version
|
|
14414
|
+
* @param {*} [options] Override http request option.
|
|
14415
|
+
* @throws {RequiredError}
|
|
14416
|
+
*/
|
|
14417
|
+
getApiVersion(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiVersion>>;
|
|
14418
|
+
};
|
|
14419
|
+
/**
|
|
14420
|
+
* VersionApi - factory interface
|
|
14421
|
+
* @export
|
|
14422
|
+
*/
|
|
14423
|
+
declare const VersionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14424
|
+
/**
|
|
14425
|
+
* Retrieves the version of the NOVA API.
|
|
14426
|
+
* @summary API Version
|
|
14427
|
+
* @param {*} [options] Override http request option.
|
|
14428
|
+
* @throws {RequiredError}
|
|
14429
|
+
*/
|
|
14430
|
+
getApiVersion(options?: RawAxiosRequestConfig): AxiosPromise<ApiVersion>;
|
|
14431
|
+
};
|
|
14432
|
+
/**
|
|
14433
|
+
* VersionApi - object-oriented interface
|
|
14434
|
+
* @export
|
|
14435
|
+
* @class VersionApi
|
|
14436
|
+
* @extends {BaseAPI}
|
|
14437
|
+
*/
|
|
14438
|
+
declare class VersionApi extends BaseAPI {
|
|
14439
|
+
/**
|
|
14440
|
+
* Retrieves the version of the NOVA API.
|
|
14441
|
+
* @summary API Version
|
|
14442
|
+
* @param {*} [options] Override http request option.
|
|
14443
|
+
* @throws {RequiredError}
|
|
14444
|
+
* @memberof VersionApi
|
|
14445
|
+
*/
|
|
14446
|
+
getApiVersion(options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<ApiVersion, any>>;
|
|
14368
14447
|
}
|
|
14369
14448
|
/**
|
|
14370
14449
|
* VirtualRobotApi - axios parameter creator
|
|
@@ -14587,7 +14666,7 @@ declare class VirtualRobotApi extends BaseAPI {
|
|
|
14587
14666
|
* @throws {RequiredError}
|
|
14588
14667
|
* @memberof VirtualRobotApi
|
|
14589
14668
|
*/
|
|
14590
|
-
getMotionGroupState(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<
|
|
14669
|
+
getMotionGroupState(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<MotionGroupJoints, any>>;
|
|
14591
14670
|
/**
|
|
14592
14671
|
* Gets information on the motion group.
|
|
14593
14672
|
* @summary Motion Group Description
|
|
@@ -14597,7 +14676,7 @@ declare class VirtualRobotApi extends BaseAPI {
|
|
|
14597
14676
|
* @throws {RequiredError}
|
|
14598
14677
|
* @memberof VirtualRobotApi
|
|
14599
14678
|
*/
|
|
14600
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
14679
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<MotionGroupInfos, any>>;
|
|
14601
14680
|
/**
|
|
14602
14681
|
* Gets the description and value of a virtual controller I/O.
|
|
14603
14682
|
* @summary Get I/O
|
|
@@ -14608,7 +14687,7 @@ declare class VirtualRobotApi extends BaseAPI {
|
|
|
14608
14687
|
* @throws {RequiredError}
|
|
14609
14688
|
* @memberof VirtualRobotApi
|
|
14610
14689
|
*/
|
|
14611
|
-
getVirtualRobotIOValue(cell: string, controller: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
14690
|
+
getVirtualRobotIOValue(cell: string, controller: string, io: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<IO, any>>;
|
|
14612
14691
|
/**
|
|
14613
14692
|
* Lists all inputs/outputs of the virtual controller. Every input/output contains the description and the value. As a virtual robot can have up to thousand inputs/outputs, be ready to handle a large response. Use [List Descriptions](List Descriptions) to get a detailed description of an input/output.
|
|
14614
14693
|
* @summary List Inputs/Outputs
|
|
@@ -14618,7 +14697,7 @@ declare class VirtualRobotApi extends BaseAPI {
|
|
|
14618
14697
|
* @throws {RequiredError}
|
|
14619
14698
|
* @memberof VirtualRobotApi
|
|
14620
14699
|
*/
|
|
14621
|
-
listIOs(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
14700
|
+
listIOs(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<IOs, any>>;
|
|
14622
14701
|
/**
|
|
14623
14702
|
* Sets the values for joint position, joint velocity or joint acceleration of a motion group state. The values are immediately applied to the joints of the motion group. We recommend to only use the endpoint when the motion group is in monitor mode. In case the motion group is controlled, currently jogging or planning motions, the values are overridden by the controller or an error may occur.
|
|
14624
14703
|
* @summary Set Motion Group State
|
|
@@ -14630,7 +14709,7 @@ declare class VirtualRobotApi extends BaseAPI {
|
|
|
14630
14709
|
* @throws {RequiredError}
|
|
14631
14710
|
* @memberof VirtualRobotApi
|
|
14632
14711
|
*/
|
|
14633
|
-
setMotionGroupState(cell: string, controller: string, id: number, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<
|
|
14712
|
+
setMotionGroupState(cell: string, controller: string, id: number, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<object, any>>;
|
|
14634
14713
|
/**
|
|
14635
14714
|
* Sets the value of a virtual controller I/O.
|
|
14636
14715
|
* @summary Set I/O
|
|
@@ -14644,7 +14723,7 @@ declare class VirtualRobotApi extends BaseAPI {
|
|
|
14644
14723
|
* @throws {RequiredError}
|
|
14645
14724
|
* @memberof VirtualRobotApi
|
|
14646
14725
|
*/
|
|
14647
|
-
setVirtualRobotIOValue(cell: string, controller: string, io: string, bool?: boolean, integer?: string, _double?: number, options?: RawAxiosRequestConfig): Promise<
|
|
14726
|
+
setVirtualRobotIOValue(cell: string, controller: string, io: string, bool?: boolean, integer?: string, _double?: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<object, any>>;
|
|
14648
14727
|
}
|
|
14649
14728
|
/**
|
|
14650
14729
|
* VirtualRobotBehaviorApi - axios parameter creator
|
|
@@ -14774,7 +14853,7 @@ declare class VirtualRobotBehaviorApi extends BaseAPI {
|
|
|
14774
14853
|
* @throws {RequiredError}
|
|
14775
14854
|
* @memberof VirtualRobotBehaviorApi
|
|
14776
14855
|
*/
|
|
14777
|
-
externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<
|
|
14856
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<MotionGroupJoints, any>>;
|
|
14778
14857
|
/**
|
|
14779
14858
|
* Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
|
|
14780
14859
|
* @summary Behavior
|
|
@@ -14785,7 +14864,7 @@ declare class VirtualRobotBehaviorApi extends BaseAPI {
|
|
|
14785
14864
|
* @throws {RequiredError}
|
|
14786
14865
|
* @memberof VirtualRobotBehaviorApi
|
|
14787
14866
|
*/
|
|
14788
|
-
getMotionGroupBehavior(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<
|
|
14867
|
+
getMotionGroupBehavior(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<MotionGroupBehaviorGetter, any>>;
|
|
14789
14868
|
/**
|
|
14790
14869
|
* Switch robot motion group behavior.
|
|
14791
14870
|
* @summary Switch Behavior
|
|
@@ -14797,7 +14876,7 @@ declare class VirtualRobotBehaviorApi extends BaseAPI {
|
|
|
14797
14876
|
* @throws {RequiredError}
|
|
14798
14877
|
* @memberof VirtualRobotBehaviorApi
|
|
14799
14878
|
*/
|
|
14800
|
-
setMotionGroupBehavior(cell: string, controller: string, id: number, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<
|
|
14879
|
+
setMotionGroupBehavior(cell: string, controller: string, id: number, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<object, any>>;
|
|
14801
14880
|
}
|
|
14802
14881
|
/**
|
|
14803
14882
|
* VirtualRobotModeApi - axios parameter creator
|
|
@@ -14998,7 +15077,7 @@ declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
14998
15077
|
* @throws {RequiredError}
|
|
14999
15078
|
* @memberof VirtualRobotModeApi
|
|
15000
15079
|
*/
|
|
15001
|
-
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
15080
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<CycleTime, any>>;
|
|
15002
15081
|
/**
|
|
15003
15082
|
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
15004
15083
|
* @summary Get E-Stop State
|
|
@@ -15008,7 +15087,7 @@ declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
15008
15087
|
* @throws {RequiredError}
|
|
15009
15088
|
* @memberof VirtualRobotModeApi
|
|
15010
15089
|
*/
|
|
15011
|
-
getEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
15090
|
+
getEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<Flag, any>>;
|
|
15012
15091
|
/**
|
|
15013
15092
|
* Requests the Operation Mode of the virtual robot controller. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
|
|
15014
15093
|
* @summary Get Operation Mode
|
|
@@ -15018,7 +15097,7 @@ declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
15018
15097
|
* @throws {RequiredError}
|
|
15019
15098
|
* @memberof VirtualRobotModeApi
|
|
15020
15099
|
*/
|
|
15021
|
-
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
15100
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<OpMode, any>>;
|
|
15022
15101
|
/**
|
|
15023
15102
|
* Activates the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
15024
15103
|
* @summary Push E-Stop
|
|
@@ -15028,7 +15107,7 @@ declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
15028
15107
|
* @throws {RequiredError}
|
|
15029
15108
|
* @memberof VirtualRobotModeApi
|
|
15030
15109
|
*/
|
|
15031
|
-
pushEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
15110
|
+
pushEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<object, any>>;
|
|
15032
15111
|
/**
|
|
15033
15112
|
* Releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions on virtual and physical robot controllers. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state regardless of the controller type. There the Emergency Stop state is visible as the `safety_state`. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
15034
15113
|
* @summary Release E-Stop
|
|
@@ -15038,7 +15117,7 @@ declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
15038
15117
|
* @throws {RequiredError}
|
|
15039
15118
|
* @memberof VirtualRobotModeApi
|
|
15040
15119
|
*/
|
|
15041
|
-
releaseEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
15120
|
+
releaseEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<object, any>>;
|
|
15042
15121
|
/**
|
|
15043
15122
|
* Changes the Operation Mode of the virtual robot controller to the specified value. To get the Operation Mode regardless of the controller type use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The Operating Mode can only change be changed via API when using virtual robot controllers.
|
|
15044
15123
|
* @summary Set Operation Mode
|
|
@@ -15049,7 +15128,7 @@ declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
15049
15128
|
* @throws {RequiredError}
|
|
15050
15129
|
* @memberof VirtualRobotModeApi
|
|
15051
15130
|
*/
|
|
15052
|
-
setOperationMode(cell: string, controller: string, mode: SetOperationModeModeEnum, options?: RawAxiosRequestConfig): Promise<
|
|
15131
|
+
setOperationMode(cell: string, controller: string, mode: SetOperationModeModeEnum, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<object, any>>;
|
|
15053
15132
|
}
|
|
15054
15133
|
/**
|
|
15055
15134
|
* @export
|
|
@@ -15343,7 +15422,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15343
15422
|
* @throws {RequiredError}
|
|
15344
15423
|
* @memberof VirtualRobotSetupApi
|
|
15345
15424
|
*/
|
|
15346
|
-
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
15425
|
+
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<object, any>>;
|
|
15347
15426
|
/**
|
|
15348
15427
|
* Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#tcp) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
|
|
15349
15428
|
* @summary Add TCP
|
|
@@ -15355,7 +15434,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15355
15434
|
* @throws {RequiredError}
|
|
15356
15435
|
* @memberof VirtualRobotSetupApi
|
|
15357
15436
|
*/
|
|
15358
|
-
addVirtualRobotTcp(cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<
|
|
15437
|
+
addVirtualRobotTcp(cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<object, any>>;
|
|
15359
15438
|
/**
|
|
15360
15439
|
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15361
15440
|
* @summary Remove Coordinate System
|
|
@@ -15367,7 +15446,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15367
15446
|
* @throws {RequiredError}
|
|
15368
15447
|
* @memberof VirtualRobotSetupApi
|
|
15369
15448
|
*/
|
|
15370
|
-
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
15449
|
+
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<object, any>>;
|
|
15371
15450
|
/**
|
|
15372
15451
|
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
|
|
15373
15452
|
* @summary Remove TCP
|
|
@@ -15379,7 +15458,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15379
15458
|
* @throws {RequiredError}
|
|
15380
15459
|
* @memberof VirtualRobotSetupApi
|
|
15381
15460
|
*/
|
|
15382
|
-
deleteVirtualRobotTcp(cell: string, controller: string, id: number, tcp: string, options?: RawAxiosRequestConfig): Promise<
|
|
15461
|
+
deleteVirtualRobotTcp(cell: string, controller: string, id: number, tcp: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<object, any>>;
|
|
15383
15462
|
/**
|
|
15384
15463
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
15385
15464
|
* @summary Get Mounting
|
|
@@ -15390,7 +15469,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15390
15469
|
* @throws {RequiredError}
|
|
15391
15470
|
* @memberof VirtualRobotSetupApi
|
|
15392
15471
|
*/
|
|
15393
|
-
getVirtualRobotMounting(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<
|
|
15472
|
+
getVirtualRobotMounting(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<CoordinateSystem, any>>;
|
|
15394
15473
|
/**
|
|
15395
15474
|
* Lists all coordinate systems on the robot controller.
|
|
15396
15475
|
* @summary List Coordinate Systems
|
|
@@ -15400,7 +15479,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15400
15479
|
* @throws {RequiredError}
|
|
15401
15480
|
* @memberof VirtualRobotSetupApi
|
|
15402
15481
|
*/
|
|
15403
|
-
listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
15482
|
+
listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<CoordinateSystems, any>>;
|
|
15404
15483
|
/**
|
|
15405
15484
|
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
15406
15485
|
* @summary List TCPs
|
|
@@ -15411,7 +15490,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15411
15490
|
* @throws {RequiredError}
|
|
15412
15491
|
* @memberof VirtualRobotSetupApi
|
|
15413
15492
|
*/
|
|
15414
|
-
listVirtualRobotTcps(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<
|
|
15493
|
+
listVirtualRobotTcps(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<RobotTcps, any>>;
|
|
15415
15494
|
/**
|
|
15416
15495
|
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
|
|
15417
15496
|
* @summary Set Mounting
|
|
@@ -15423,7 +15502,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15423
15502
|
* @throws {RequiredError}
|
|
15424
15503
|
* @memberof VirtualRobotSetupApi
|
|
15425
15504
|
*/
|
|
15426
|
-
setVirtualRobotMounting(cell: string, controller: string, id: number, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
15505
|
+
setVirtualRobotMounting(cell: string, controller: string, id: number, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios129.AxiosResponse<CoordinateSystem, any>>;
|
|
15427
15506
|
}
|
|
15428
15507
|
//#endregion
|
|
15429
|
-
export { AbbController, AbbControllerEgmServer, AbbControllerKindEnum, ActivateLicenseRequest, AddRequest, AllJointPositionsRequest, AllJointPositionsResponse, App, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, ArrayInput, ArrayOutput, BASE_PATH, BaseAPI, Behavior, BlendingAuto, BlendingAutoBlendingNameEnum, BlendingPosition, BlendingPositionBlendingNameEnum, Box, Box2, Box2BoxTypeEnum, Box2ShapeTypeEnum, Box3, Box3ShapeTypeEnum, Box3TypeEnum, BoxTypeEnum, COLLECTION_FORMATS, Capsule, Capsule2, Capsule2ShapeTypeEnum, Capsule3, Capsule3ShapeTypeEnum, Capture, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Circle, CodeWithArguments, CollectionValue, Collider, ColliderInput, ColliderOutput, ColliderOutputShape, ColliderShape, Collision, CollisionContact, CollisionMotionGroup, CollisionMotionGroupAssembly, CollisionRobotConfigurationInput, CollisionRobotConfigurationOutput, CollisionScene, CollisionSceneAssembly, Command, CommandSettings, Comparator, Compound, Configuration, ConfigurationParameters, ContainerEnvironmentInner, ContainerImage, ContainerImageSecretsInner, ContainerResources, ContainerStorage, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerCapabilities, ControllerIOsApi, ControllerIOsApiAxiosParamCreator, ControllerIOsApiFactory, ControllerIOsApiFp, ControllerInstance, ControllerInstanceList, ConvexHull, ConvexHull2, ConvexHull2ShapeTypeEnum, ConvexHull3, ConvexHull3ShapeTypeEnum, CoordinateSystem, CoordinateSystems, CoordinateSystemsApi, CoordinateSystemsApiAxiosParamCreator, CoordinateSystemsApiFactory, CoordinateSystemsApiFp, CreateDeviceRequestInner, CreateProgramRun200Response, CreateProgramRunRequest, CreateTrigger200Response, CreateTriggerRequest, CreateTriggerRequestConfig, CubicSpline, CubicSplineCubicSplineParameter, CubicSplineParameter, CycleTime, Cylinder, Cylinder2, Cylinder2ShapeTypeEnum, Cylinder3, Cylinder3ShapeTypeEnum, DHParameter, DeviceConfigurationApi, DeviceConfigurationApiAxiosParamCreator, DeviceConfigurationApiFactory, DeviceConfigurationApiFp, Direction, DirectionJoggingRequest, ExecuteTrajectoryRequest, ExecuteTrajectoryResponse, ExecutionResult, ExternalJointStreamDatapoint, ExternalJointStreamDatapointValue, FanucController, FanucControllerKindEnum, FeedbackCollision, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceeded, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspace, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularity, FeedbackSingularityErrorFeedbackNameEnum, Flag, ForceVector, Geometry, GetAllProgramRuns200Response, GetAllTriggers200Response, GetDefaultLinkChainMotionGroupModelEnum, GetModeResponse, GetTrajectoryResponse, GetTrajectorySampleResponse, GoogleProtobufAny, HTTPExceptionResponse, HTTPValidationError, HTTPValidationError2, IO, IODescription, IODescriptionTypeEnum, IODescriptionUnitEnum, IODescriptionValueTypeEnum, IODirectionEnum, IOValue, IOs, ImageCredentials, InfoServiceCapabilities, InitializeMovementRequest, InitializeMovementResponse, InitializeMovementResponseInitResponse, JoggingResponse, JoggingResponseMovementStateEnum, JoggingServiceCapabilities, JointJoggingRequest, JointLimit, JointLimitExceeded, JointLimitJointEnum, JointPositionRequest, JointTrajectory, Joints, KinematicServiceCapabilities, KukaController, KukaControllerKindEnum, KukaControllerRsiServer, LibraryProgramApi, LibraryProgramApiAxiosParamCreator, LibraryProgramApiFactory, LibraryProgramApiFp, LibraryProgramMetadataApi, LibraryProgramMetadataApiAxiosParamCreator, LibraryProgramMetadataApiFactory, LibraryProgramMetadataApiFp, LibraryRecipeApi, LibraryRecipeApiAxiosParamCreator, LibraryRecipeApiFactory, LibraryRecipeApiFp, LibraryRecipeMetadataApi, LibraryRecipeMetadataApiAxiosParamCreator, LibraryRecipeMetadataApiFactory, LibraryRecipeMetadataApiFp, License, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatus, LicenseStatusEnum, LimitSettings, LimitsOverride, ListDevices200ResponseInner, ListIODescriptionsResponse, ListIOValuesResponse, ListPayloadsResponse, ListProgramMetadataResponse, ListRecipeMetadataResponse, ListResponse, ListTcpsResponse, Manufacturer, ModeChangeResponse, ModelError, MotionApi, MotionApiAxiosParamCreator, MotionApiFactory, MotionApiFp, MotionCommand, MotionCommandBlending, MotionCommandPath, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupBehaviorGetter, MotionGroupInfo, MotionGroupInfos, MotionGroupInfosApi, MotionGroupInfosApiAxiosParamCreator, MotionGroupInfosApiFactory, MotionGroupInfosApiFp, MotionGroupInstance, MotionGroupInstanceList, MotionGroupJoggingApi, MotionGroupJoggingApiAxiosParamCreator, MotionGroupJoggingApiFactory, MotionGroupJoggingApiFp, MotionGroupJoints, MotionGroupKinematicApi, MotionGroupKinematicApiAxiosParamCreator, MotionGroupKinematicApiFactory, MotionGroupKinematicApiFp, MotionGroupPhysical, MotionGroupSpecification, MotionGroupState, MotionGroupStateJointLimitReached, MotionGroupStateResponse, MotionId, MotionIdsListResponse, MotionVector, Mounting, MoveRequest, MoveResponse, MoveToTrajectoryViaJointPTPRequest, Movement, MovementError, MovementErrorError, MovementMovement, OpMode, OpModeModeEnum, OpcuaNodeValueTriggerConfig, OpcuaNodeValueTriggerConfigNodeValue, OptimizerSetup, OutOfWorkspace, Path, PathCartesianPTP, PathCartesianPTPPathDefinitionNameEnum, PathCircle, PathCirclePathDefinitionNameEnum, PathCubicSpline, PathCubicSplinePathDefinitionNameEnum, PathJointPTP, PathJointPTPPathDefinitionNameEnum, PathLine, PathLinePathDefinitionNameEnum, PauseMovementRequest, PauseMovementResponse, PauseMovementResponsePauseResponse, PauseOnIO, Payload, PlanCollisionFreePTPRequest, PlanCollisionFreePTPRequestTarget, PlanFailedOnTrajectoryResponse, PlanFailedResponse, PlanRequest, PlanResponse, PlanSuccessfulResponse, PlanTrajectoryFailedResponse, PlanTrajectoryFailedResponseErrorFeedback, PlanTrajectoryRequest, PlanTrajectoryResponse, PlanTrajectoryResponseResponse, Plane2, Plane2ShapeTypeEnum, Plane3, Plane3ShapeTypeEnum, PlannedMotion, PlannerPose, PlanningLimits, PlanningLimitsLimitRange, PlaybackSpeedRequest, PlaybackSpeedResponse, PlaybackSpeedResponsePlaybackSpeedResponse, PointCloud, Pose, Pose2, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramMetadata, ProgramOperatorApi, ProgramOperatorApiAxiosParamCreator, ProgramOperatorApiFactory, ProgramOperatorApiFp, ProgramRun, ProgramRunObject, ProgramRunState, ProgramRunnerReference, ProgramValuesApi, ProgramValuesApiAxiosParamCreator, ProgramValuesApiFactory, ProgramValuesApiFp, PyjectoryDatatypesCorePose, PyjectoryDatatypesSerializerOrientation, PyjectoryDatatypesSerializerPose, PyjectoryDatatypesSerializerPosition, PyripheryEtcdETCDConfiguration, PyripheryHardwareIsaacIsaacConfiguration, PyripheryOpcuaOPCUAConfiguration, PyripheryPyraeControllerControllerConfiguration, PyripheryPyraeRobotRobotConfiguration, PyripheryPyraeRobotRobotConfigurationTypeEnum, PyripheryRoboticsConfigurableCollisionSceneConfigurableCollisionSceneConfigurationInput, PyripheryRoboticsConfigurableCollisionSceneConfigurableCollisionSceneConfigurationOutput, PyripheryRoboticsRobotcellTimerConfiguration, PyripheryRoboticsRobotcellTimerConfigurationTypeEnum, PyripheryRoboticsSimulationRobotWithViewOpen3dConfiguration, PyripheryRoboticsSimulationSimulatedIOConfiguration, PyripheryRoboticsSimulationSimulatedOPCUAConfiguration, Quaternion, RecipeMetadata, Rectangle, Rectangle2, Rectangle2ShapeTypeEnum, Rectangle3, Rectangle3ShapeTypeEnum, RectangularCapsule, RectangularCapsule2, RectangularCapsule2ShapeTypeEnum, RectangularCapsule3, RectangularCapsule3ShapeTypeEnum, ReleaseChannel, Request, Request1, RequestArgs, RequiredError, ResponseGetValueProgramsValuesKeyGet, ResponseGetValuesProgramsValuesGetValue, RobotController, RobotControllerConfiguration, RobotControllerState, RobotControllerStateOperationModeEnum, RobotControllerStateSafetyStateEnum, RobotLinkGeometry, RobotState, RobotSystemMode, RobotTcp, RobotTcps, RotationAngleTypes, RotationAngles, SafetyConfiguration, SafetySetup, SafetySetupSafetySettings, SafetySetupSafetySettingsSafetyStateEnum, SafetySetupSafetyZone, SafetyZone, SafetyZoneLimits, SafetyZoneViolation, ServiceStatus, ServiceStatusPhase, ServiceStatusSeverity, ServiceStatusStatus, SetDefaultModeModeEnum, SetIO, SetOperationModeModeEnum, SetPlaybackSpeed, SingleJointLimit, SingleJointLimitJointEnum, Singularity, SingularitySingularityTypeEnum, SingularityTypeEnum, Sphere, Sphere2, Sphere2ShapeTypeEnum, Sphere3, Sphere3ShapeTypeEnum, Standstill, StandstillReason, StandstillStandstill, StartMovementRequest, StartOnIO, Status, StopResponse, StopResponseStopCodeEnum, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionScenesApi, StoreCollisionScenesApiAxiosParamCreator, StoreCollisionScenesApiFactory, StoreCollisionScenesApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, StoreValue, StreamMoveBackward, StreamMoveForward, StreamMovePlaybackSpeed, StreamMoveRequest, StreamMoveResponse, StreamMoveToTrajectory, StreamStop, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpPose, TcpPoseRequest, ToolGeometry, TrajectorySample, TriggerObject, TriggerType, UniversalrobotsController, UniversalrobotsControllerKindEnum, UpdateNovaVersionRequest, UpdateProgramMetadataRequest, UpdateRecipeMetadataRequest, UpdateTriggerRequest, ValidationError, ValidationError2, ValidationError2LocInner, ValidationErrorLocInner, Value, Vector3d, VersionNumber, VirtualController, VirtualControllerKindEnum, VirtualControllerTypes, VirtualRobotApi, VirtualRobotApiAxiosParamCreator, VirtualRobotApiFactory, VirtualRobotApiFp, VirtualRobotBehaviorApi, VirtualRobotBehaviorApiAxiosParamCreator, VirtualRobotBehaviorApiFactory, VirtualRobotBehaviorApiFp, VirtualRobotConfiguration, VirtualRobotModeApi, VirtualRobotModeApiAxiosParamCreator, VirtualRobotModeApiFactory, VirtualRobotModeApiFp, VirtualRobotSetupApi, VirtualRobotSetupApiAxiosParamCreator, VirtualRobotSetupApiFactory, VirtualRobotSetupApiFp, WaitForIOEventComparisonTypeEnum, YaskawaController, YaskawaControllerKindEnum, operationServerMap };
|
|
15508
|
+
export { AbbController, AbbControllerEgmServer, AbbControllerKindEnum, ActivateLicenseRequest, AddRequest, AllJointPositionsRequest, AllJointPositionsResponse, ApiVersion, App, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, ArrayInput, ArrayOutput, BASE_PATH, BaseAPI, Behavior, BlendingAuto, BlendingAutoBlendingNameEnum, BlendingPosition, BlendingPositionBlendingNameEnum, Box, Box2, Box2BoxTypeEnum, Box2ShapeTypeEnum, Box3, Box3ShapeTypeEnum, Box3TypeEnum, BoxTypeEnum, COLLECTION_FORMATS, Capsule, Capsule2, Capsule2ShapeTypeEnum, Capsule3, Capsule3ShapeTypeEnum, Capture, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Circle, CodeWithArguments, CollectionValue, Collider, ColliderInput, ColliderOutput, ColliderOutputShape, ColliderShape, Collision, CollisionContact, CollisionMotionGroup, CollisionMotionGroupAssembly, CollisionRobotConfigurationInput, CollisionRobotConfigurationOutput, CollisionScene, CollisionSceneAssembly, Command, CommandSettings, Comparator, Compound, Configuration, ConfigurationParameters, ContainerEnvironmentInner, ContainerImage, ContainerImageSecretsInner, ContainerResources, ContainerStorage, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerCapabilities, ControllerIOsApi, ControllerIOsApiAxiosParamCreator, ControllerIOsApiFactory, ControllerIOsApiFp, ControllerInstance, ControllerInstanceList, ConvexHull, ConvexHull2, ConvexHull2ShapeTypeEnum, ConvexHull3, ConvexHull3ShapeTypeEnum, CoordinateSystem, CoordinateSystems, CoordinateSystemsApi, CoordinateSystemsApiAxiosParamCreator, CoordinateSystemsApiFactory, CoordinateSystemsApiFp, CreateDeviceRequestInner, CreateProgramRun200Response, CreateProgramRunRequest, CreateTrigger200Response, CreateTriggerRequest, CreateTriggerRequestConfig, CubicSpline, CubicSplineCubicSplineParameter, CubicSplineParameter, CycleTime, Cylinder, Cylinder2, Cylinder2ShapeTypeEnum, Cylinder3, Cylinder3ShapeTypeEnum, DHParameter, DeviceConfigurationApi, DeviceConfigurationApiAxiosParamCreator, DeviceConfigurationApiFactory, DeviceConfigurationApiFp, Direction, DirectionJoggingRequest, ExecuteTrajectoryRequest, ExecuteTrajectoryResponse, ExecutionResult, ExternalJointStreamDatapoint, ExternalJointStreamDatapointValue, FanucController, FanucControllerKindEnum, FeedbackCollision, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceeded, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspace, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularity, FeedbackSingularityErrorFeedbackNameEnum, Flag, ForceVector, Geometry, GetAllProgramRuns200Response, GetAllTriggers200Response, GetDefaultLinkChainMotionGroupModelEnum, GetModeResponse, GetTrajectoryResponse, GetTrajectorySampleResponse, GoogleProtobufAny, HTTPExceptionResponse, HTTPValidationError, HTTPValidationError2, IO, IODescription, IODescriptionTypeEnum, IODescriptionUnitEnum, IODescriptionValueTypeEnum, IODirectionEnum, IOValue, IOs, ImageCredentials, InfoServiceCapabilities, InitializeMovementRequest, InitializeMovementResponse, InitializeMovementResponseInitResponse, JoggingResponse, JoggingResponseMovementStateEnum, JoggingServiceCapabilities, JointJoggingRequest, JointLimit, JointLimitExceeded, JointLimitJointEnum, JointPositionRequest, JointTrajectory, Joints, KinematicServiceCapabilities, KukaController, KukaControllerKindEnum, KukaControllerRsiServer, LibraryProgramApi, LibraryProgramApiAxiosParamCreator, LibraryProgramApiFactory, LibraryProgramApiFp, LibraryProgramMetadataApi, LibraryProgramMetadataApiAxiosParamCreator, LibraryProgramMetadataApiFactory, LibraryProgramMetadataApiFp, LibraryRecipeApi, LibraryRecipeApiAxiosParamCreator, LibraryRecipeApiFactory, LibraryRecipeApiFp, LibraryRecipeMetadataApi, LibraryRecipeMetadataApiAxiosParamCreator, LibraryRecipeMetadataApiFactory, LibraryRecipeMetadataApiFp, License, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatus, LicenseStatusEnum, LimitSettings, LimitsOverride, ListDevices200ResponseInner, ListIODescriptionsResponse, ListIOValuesResponse, ListPayloadsResponse, ListProgramMetadataResponse, ListRecipeMetadataResponse, ListResponse, ListTcpsResponse, Manufacturer, ModeChangeResponse, ModelError, MotionApi, MotionApiAxiosParamCreator, MotionApiFactory, MotionApiFp, MotionCommand, MotionCommandBlending, MotionCommandPath, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupBehaviorGetter, MotionGroupInfo, MotionGroupInfos, MotionGroupInfosApi, MotionGroupInfosApiAxiosParamCreator, MotionGroupInfosApiFactory, MotionGroupInfosApiFp, MotionGroupInstance, MotionGroupInstanceList, MotionGroupJoggingApi, MotionGroupJoggingApiAxiosParamCreator, MotionGroupJoggingApiFactory, MotionGroupJoggingApiFp, MotionGroupJoints, MotionGroupKinematicApi, MotionGroupKinematicApiAxiosParamCreator, MotionGroupKinematicApiFactory, MotionGroupKinematicApiFp, MotionGroupPhysical, MotionGroupSpecification, MotionGroupState, MotionGroupStateJointLimitReached, MotionGroupStateResponse, MotionId, MotionIdsListResponse, MotionVector, Mounting, MoveRequest, MoveResponse, MoveToTrajectoryViaJointPTPRequest, Movement, MovementError, MovementErrorError, MovementMovement, OpMode, OpModeModeEnum, OpcuaNodeValueTriggerConfig, OpcuaNodeValueTriggerConfigNodeValue, OptimizerSetup, OutOfWorkspace, Path, PathCartesianPTP, PathCartesianPTPPathDefinitionNameEnum, PathCircle, PathCirclePathDefinitionNameEnum, PathCubicSpline, PathCubicSplinePathDefinitionNameEnum, PathJointPTP, PathJointPTPPathDefinitionNameEnum, PathLine, PathLinePathDefinitionNameEnum, PauseMovementRequest, PauseMovementResponse, PauseMovementResponsePauseResponse, PauseOnIO, Payload, PlanCollisionFreePTPRequest, PlanCollisionFreePTPRequestTarget, PlanFailedOnTrajectoryResponse, PlanFailedResponse, PlanRequest, PlanResponse, PlanSuccessfulResponse, PlanTrajectoryFailedResponse, PlanTrajectoryFailedResponseErrorFeedback, PlanTrajectoryRequest, PlanTrajectoryResponse, PlanTrajectoryResponseResponse, Plane2, Plane2ShapeTypeEnum, Plane3, Plane3ShapeTypeEnum, PlannedMotion, PlannerPose, PlanningLimits, PlanningLimitsLimitRange, PlaybackSpeedRequest, PlaybackSpeedResponse, PlaybackSpeedResponsePlaybackSpeedResponse, PointCloud, Pose, Pose2, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramMetadata, ProgramOperatorApi, ProgramOperatorApiAxiosParamCreator, ProgramOperatorApiFactory, ProgramOperatorApiFp, ProgramRun, ProgramRunObject, ProgramRunState, ProgramRunnerReference, ProgramValuesApi, ProgramValuesApiAxiosParamCreator, ProgramValuesApiFactory, ProgramValuesApiFp, PyjectoryDatatypesCorePose, PyjectoryDatatypesSerializerOrientation, PyjectoryDatatypesSerializerPose, PyjectoryDatatypesSerializerPosition, PyripheryEtcdETCDConfiguration, PyripheryHardwareIsaacIsaacConfiguration, PyripheryOpcuaOPCUAConfiguration, PyripheryPyraeControllerControllerConfiguration, PyripheryPyraeRobotRobotConfiguration, PyripheryPyraeRobotRobotConfigurationTypeEnum, PyripheryRoboticsConfigurableCollisionSceneConfigurableCollisionSceneConfigurationInput, PyripheryRoboticsConfigurableCollisionSceneConfigurableCollisionSceneConfigurationOutput, PyripheryRoboticsRobotcellTimerConfiguration, PyripheryRoboticsRobotcellTimerConfigurationTypeEnum, PyripheryRoboticsSimulationRobotWithViewOpen3dConfiguration, PyripheryRoboticsSimulationSimulatedIOConfiguration, PyripheryRoboticsSimulationSimulatedOPCUAConfiguration, Quaternion, RecipeMetadata, Rectangle, Rectangle2, Rectangle2ShapeTypeEnum, Rectangle3, Rectangle3ShapeTypeEnum, RectangularCapsule, RectangularCapsule2, RectangularCapsule2ShapeTypeEnum, RectangularCapsule3, RectangularCapsule3ShapeTypeEnum, ReleaseChannel, Request, Request1, RequestArgs, RequiredError, ResponseGetValueProgramsValuesKeyGet, ResponseGetValuesProgramsValuesGetValue, RobotController, RobotControllerConfiguration, RobotControllerState, RobotControllerStateOperationModeEnum, RobotControllerStateSafetyStateEnum, RobotLinkGeometry, RobotState, RobotSystemMode, RobotTcp, RobotTcps, RotationAngleTypes, RotationAngles, SafetyConfiguration, SafetySetup, SafetySetupSafetySettings, SafetySetupSafetySettingsSafetyStateEnum, SafetySetupSafetyZone, SafetyZone, SafetyZoneLimits, SafetyZoneViolation, ServiceStatus, ServiceStatusPhase, ServiceStatusSeverity, ServiceStatusStatus, SetDefaultModeModeEnum, SetIO, SetOperationModeModeEnum, SetPlaybackSpeed, SingleJointLimit, SingleJointLimitJointEnum, Singularity, SingularitySingularityTypeEnum, SingularityTypeEnum, Sphere, Sphere2, Sphere2ShapeTypeEnum, Sphere3, Sphere3ShapeTypeEnum, Standstill, StandstillReason, StandstillStandstill, StartMovementRequest, StartOnIO, Status, StopResponse, StopResponseStopCodeEnum, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionScenesApi, StoreCollisionScenesApiAxiosParamCreator, StoreCollisionScenesApiFactory, StoreCollisionScenesApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, StoreValue, StreamMoveBackward, StreamMoveForward, StreamMovePlaybackSpeed, StreamMoveRequest, StreamMoveResponse, StreamMoveToTrajectory, StreamStop, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpPose, TcpPoseRequest, ToolGeometry, TrajectorySample, TriggerObject, TriggerType, UniversalrobotsController, UniversalrobotsControllerKindEnum, UpdateNovaVersionRequest, UpdateProgramMetadataRequest, UpdateRecipeMetadataRequest, UpdateTriggerRequest, ValidationError, ValidationError2, ValidationError2LocInner, ValidationErrorLocInner, Value, Vector3d, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VersionNumber, VirtualController, VirtualControllerKindEnum, VirtualControllerTypes, VirtualRobotApi, VirtualRobotApiAxiosParamCreator, VirtualRobotApiFactory, VirtualRobotApiFp, VirtualRobotBehaviorApi, VirtualRobotBehaviorApiAxiosParamCreator, VirtualRobotBehaviorApiFactory, VirtualRobotBehaviorApiFp, VirtualRobotConfiguration, VirtualRobotModeApi, VirtualRobotModeApiAxiosParamCreator, VirtualRobotModeApiFactory, VirtualRobotModeApiFp, VirtualRobotSetupApi, VirtualRobotSetupApiAxiosParamCreator, VirtualRobotSetupApiFactory, VirtualRobotSetupApiFp, WaitForIOEventComparisonTypeEnum, YaskawaController, YaskawaControllerKindEnum, operationServerMap };
|