@wandelbots/nova-api 26.1.0-dev.46 → 26.1.0-dev.48
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.d.ts +178 -178
- package/dist/v2/index.d.ts +135 -135
- package/package.json +1 -1
package/dist/v1/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as axios0 from "axios";
|
|
2
2
|
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
3
|
|
|
4
4
|
//#region v1/configuration.d.ts
|
|
@@ -4069,7 +4069,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4069
4069
|
* @param {*} [options] Override http request option.
|
|
4070
4070
|
* @throws {RequiredError}
|
|
4071
4071
|
*/
|
|
4072
|
-
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4072
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4073
4073
|
/**
|
|
4074
4074
|
* Delete all GUI applications from the cell.
|
|
4075
4075
|
* @summary Clear Applications
|
|
@@ -4078,7 +4078,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4078
4078
|
* @param {*} [options] Override http request option.
|
|
4079
4079
|
* @throws {RequiredError}
|
|
4080
4080
|
*/
|
|
4081
|
-
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4081
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4082
4082
|
/**
|
|
4083
4083
|
* Delete a GUI application from the cell.
|
|
4084
4084
|
* @summary Delete Application
|
|
@@ -4088,7 +4088,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4088
4088
|
* @param {*} [options] Override http request option.
|
|
4089
4089
|
* @throws {RequiredError}
|
|
4090
4090
|
*/
|
|
4091
|
-
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4091
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4092
4092
|
/**
|
|
4093
4093
|
* 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.
|
|
4094
4094
|
* @summary Configuration
|
|
@@ -4097,7 +4097,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4097
4097
|
* @param {*} [options] Override http request option.
|
|
4098
4098
|
* @throws {RequiredError}
|
|
4099
4099
|
*/
|
|
4100
|
-
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<
|
|
4100
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
|
|
4101
4101
|
/**
|
|
4102
4102
|
* 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.
|
|
4103
4103
|
* @summary List Applications
|
|
@@ -4105,7 +4105,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4105
4105
|
* @param {*} [options] Override http request option.
|
|
4106
4106
|
* @throws {RequiredError}
|
|
4107
4107
|
*/
|
|
4108
|
-
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4108
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
4109
4109
|
/**
|
|
4110
4110
|
* Update the configuration of a GUI application in the cell.
|
|
4111
4111
|
* @summary Update Configuration
|
|
@@ -4116,7 +4116,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4116
4116
|
* @param {*} [options] Override http request option.
|
|
4117
4117
|
* @throws {RequiredError}
|
|
4118
4118
|
*/
|
|
4119
|
-
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4119
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4120
4120
|
}
|
|
4121
4121
|
/**
|
|
4122
4122
|
* CellApi - axios parameter creator
|
|
@@ -4298,7 +4298,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4298
4298
|
* @param {*} [options] Override http request option.
|
|
4299
4299
|
* @throws {RequiredError}
|
|
4300
4300
|
*/
|
|
4301
|
-
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4301
|
+
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4302
4302
|
/**
|
|
4303
4303
|
* 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.
|
|
4304
4304
|
* @summary Add Cell
|
|
@@ -4307,7 +4307,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4307
4307
|
* @param {*} [options] Override http request option.
|
|
4308
4308
|
* @throws {RequiredError}
|
|
4309
4309
|
*/
|
|
4310
|
-
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4310
|
+
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4311
4311
|
/**
|
|
4312
4312
|
* 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.
|
|
4313
4313
|
* @summary Configuration
|
|
@@ -4315,7 +4315,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4315
4315
|
* @param {*} [options] Override http request option.
|
|
4316
4316
|
* @throws {RequiredError}
|
|
4317
4317
|
*/
|
|
4318
|
-
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4318
|
+
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Cell, any>>;
|
|
4319
4319
|
/**
|
|
4320
4320
|
* List the status of all cell resources.
|
|
4321
4321
|
* @summary Service Status
|
|
@@ -4323,14 +4323,14 @@ declare class CellApi extends BaseAPI {
|
|
|
4323
4323
|
* @param {*} [options] Override http request option.
|
|
4324
4324
|
* @throws {RequiredError}
|
|
4325
4325
|
*/
|
|
4326
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4326
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatus[], any>>;
|
|
4327
4327
|
/**
|
|
4328
4328
|
* List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
4329
4329
|
* @summary List Cells
|
|
4330
4330
|
* @param {*} [options] Override http request option.
|
|
4331
4331
|
* @throws {RequiredError}
|
|
4332
4332
|
*/
|
|
4333
|
-
listCells(options?: RawAxiosRequestConfig): Promise<
|
|
4333
|
+
listCells(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
4334
4334
|
/**
|
|
4335
4335
|
* Update the definition of the entire Cell.
|
|
4336
4336
|
* @summary Update Configuration
|
|
@@ -4340,7 +4340,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4340
4340
|
* @param {*} [options] Override http request option.
|
|
4341
4341
|
* @throws {RequiredError}
|
|
4342
4342
|
*/
|
|
4343
|
-
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4343
|
+
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4344
4344
|
}
|
|
4345
4345
|
/**
|
|
4346
4346
|
* ControllerApi - axios parameter creator
|
|
@@ -4766,7 +4766,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4766
4766
|
* @param {*} [options] Override http request option.
|
|
4767
4767
|
* @throws {RequiredError}
|
|
4768
4768
|
*/
|
|
4769
|
-
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4769
|
+
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4770
4770
|
/**
|
|
4771
4771
|
* 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.
|
|
4772
4772
|
* @summary Clear Robot Controllers
|
|
@@ -4775,7 +4775,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4775
4775
|
* @param {*} [options] Override http request option.
|
|
4776
4776
|
* @throws {RequiredError}
|
|
4777
4777
|
*/
|
|
4778
|
-
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4778
|
+
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4779
4779
|
/**
|
|
4780
4780
|
* Delete a robot controller from the cell. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
|
|
4781
4781
|
* @summary Delete Robot Controller
|
|
@@ -4785,7 +4785,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4785
4785
|
* @param {*} [options] Override http request option.
|
|
4786
4786
|
* @throws {RequiredError}
|
|
4787
4787
|
*/
|
|
4788
|
-
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4788
|
+
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4789
4789
|
/**
|
|
4790
4790
|
* Get the current state of a robot controller.
|
|
4791
4791
|
* @summary State of Device
|
|
@@ -4794,7 +4794,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4794
4794
|
* @param {*} [options] Override http request option.
|
|
4795
4795
|
* @throws {RequiredError}
|
|
4796
4796
|
*/
|
|
4797
|
-
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4797
|
+
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
4798
4798
|
/**
|
|
4799
4799
|
* 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).
|
|
4800
4800
|
* @summary Current Mode
|
|
@@ -4803,7 +4803,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4803
4803
|
* @param {*} [options] Override http request option.
|
|
4804
4804
|
* @throws {RequiredError}
|
|
4805
4805
|
*/
|
|
4806
|
-
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4806
|
+
getMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetModeResponse, any>>;
|
|
4807
4807
|
/**
|
|
4808
4808
|
* Get the configuration for a robot controller.
|
|
4809
4809
|
* @summary Robot Controller Configuration
|
|
@@ -4812,7 +4812,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4812
4812
|
* @param {*} [options] Override http request option.
|
|
4813
4813
|
* @throws {RequiredError}
|
|
4814
4814
|
*/
|
|
4815
|
-
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4815
|
+
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
|
|
4816
4816
|
/**
|
|
4817
4817
|
* Lists supported operating modes. Usually cobots support free drive and control, industrial robots only support control.
|
|
4818
4818
|
* @summary Supported Motion Modes
|
|
@@ -4821,7 +4821,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4821
4821
|
* @param {*} [options] Override http request option.
|
|
4822
4822
|
* @throws {RequiredError}
|
|
4823
4823
|
*/
|
|
4824
|
-
getSupportedModes(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4824
|
+
getSupportedModes(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ControllerCapabilities, any>>;
|
|
4825
4825
|
/**
|
|
4826
4826
|
* 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.
|
|
4827
4827
|
* @summary Virtual Robot Configuration
|
|
@@ -4830,7 +4830,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4830
4830
|
* @param {*} [options] Override http request option.
|
|
4831
4831
|
* @throws {RequiredError}
|
|
4832
4832
|
*/
|
|
4833
|
-
getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4833
|
+
getVirtualRobotConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
4834
4834
|
/**
|
|
4835
4835
|
* List all configured robot controllers.
|
|
4836
4836
|
* @summary List Robot Controllers
|
|
@@ -4838,7 +4838,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4838
4838
|
* @param {*} [options] Override http request option.
|
|
4839
4839
|
* @throws {RequiredError}
|
|
4840
4840
|
*/
|
|
4841
|
-
listControllers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4841
|
+
listControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ControllerInstanceList, any>>;
|
|
4842
4842
|
/**
|
|
4843
4843
|
* 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.
|
|
4844
4844
|
* @summary Set Default Mode
|
|
@@ -4848,7 +4848,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4848
4848
|
* @param {*} [options] Override http request option.
|
|
4849
4849
|
* @throws {RequiredError}
|
|
4850
4850
|
*/
|
|
4851
|
-
setDefaultMode(cell: string, controller: string, mode: SetDefaultModeModeEnum, options?: RawAxiosRequestConfig): Promise<
|
|
4851
|
+
setDefaultMode(cell: string, controller: string, mode: SetDefaultModeModeEnum, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4852
4852
|
/**
|
|
4853
4853
|
* 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.
|
|
4854
4854
|
* @summary Stream Free Drive Mode
|
|
@@ -4858,7 +4858,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4858
4858
|
* @param {*} [options] Override http request option.
|
|
4859
4859
|
* @throws {RequiredError}
|
|
4860
4860
|
*/
|
|
4861
|
-
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4861
|
+
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
4862
4862
|
/**
|
|
4863
4863
|
* 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.
|
|
4864
4864
|
* @summary Stream Mode Change
|
|
@@ -4867,7 +4867,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4867
4867
|
* @param {*} [options] Override http request option.
|
|
4868
4868
|
* @throws {RequiredError}
|
|
4869
4869
|
*/
|
|
4870
|
-
streamModeChange(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
4870
|
+
streamModeChange(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ModeChangeResponse, any>>;
|
|
4871
4871
|
/**
|
|
4872
4872
|
* Receive updates of the state of a robot controller.
|
|
4873
4873
|
* @summary Stream State of Device
|
|
@@ -4877,7 +4877,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4877
4877
|
* @param {*} [options] Override http request option.
|
|
4878
4878
|
* @throws {RequiredError}
|
|
4879
4879
|
*/
|
|
4880
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4880
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
4881
4881
|
/**
|
|
4882
4882
|
* 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).
|
|
4883
4883
|
* @summary Update Robot Controller Configuration
|
|
@@ -4888,7 +4888,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4888
4888
|
* @param {*} [options] Override http request option.
|
|
4889
4889
|
* @throws {RequiredError}
|
|
4890
4890
|
*/
|
|
4891
|
-
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4891
|
+
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4892
4892
|
}
|
|
4893
4893
|
declare const SetDefaultModeModeEnum: {
|
|
4894
4894
|
readonly ModeMonitor: "MODE_MONITOR";
|
|
@@ -5085,7 +5085,7 @@ declare class ControllerIOsApi extends BaseAPI {
|
|
|
5085
5085
|
* @param {*} [options] Override http request option.
|
|
5086
5086
|
* @throws {RequiredError}
|
|
5087
5087
|
*/
|
|
5088
|
-
listIODescriptions(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5088
|
+
listIODescriptions(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListIODescriptionsResponse, any>>;
|
|
5089
5089
|
/**
|
|
5090
5090
|
* 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).
|
|
5091
5091
|
* @summary Values
|
|
@@ -5095,7 +5095,7 @@ declare class ControllerIOsApi extends BaseAPI {
|
|
|
5095
5095
|
* @param {*} [options] Override http request option.
|
|
5096
5096
|
* @throws {RequiredError}
|
|
5097
5097
|
*/
|
|
5098
|
-
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5098
|
+
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListIOValuesResponse, any>>;
|
|
5099
5099
|
/**
|
|
5100
5100
|
* 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.
|
|
5101
5101
|
* @summary Set Values
|
|
@@ -5105,7 +5105,7 @@ declare class ControllerIOsApi extends BaseAPI {
|
|
|
5105
5105
|
* @param {*} [options] Override http request option.
|
|
5106
5106
|
* @throws {RequiredError}
|
|
5107
5107
|
*/
|
|
5108
|
-
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
5108
|
+
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5109
5109
|
/**
|
|
5110
5110
|
* 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.
|
|
5111
5111
|
* @summary Stream Values
|
|
@@ -5115,7 +5115,7 @@ declare class ControllerIOsApi extends BaseAPI {
|
|
|
5115
5115
|
* @param {*} [options] Override http request option.
|
|
5116
5116
|
* @throws {RequiredError}
|
|
5117
5117
|
*/
|
|
5118
|
-
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5118
|
+
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListIOValuesResponse, any>>;
|
|
5119
5119
|
/**
|
|
5120
5120
|
* 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.
|
|
5121
5121
|
* @summary Wait For
|
|
@@ -5129,7 +5129,7 @@ declare class ControllerIOsApi extends BaseAPI {
|
|
|
5129
5129
|
* @param {*} [options] Override http request option.
|
|
5130
5130
|
* @throws {RequiredError}
|
|
5131
5131
|
*/
|
|
5132
|
-
waitForIOEvent(cell: string, controller: string, io: string, comparisonType: WaitForIOEventComparisonTypeEnum, booleanValue?: boolean, integerValue?: string, floatingValue?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5132
|
+
waitForIOEvent(cell: string, controller: string, io: string, comparisonType: WaitForIOEventComparisonTypeEnum, booleanValue?: boolean, integerValue?: string, floatingValue?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<boolean, any>>;
|
|
5133
5133
|
}
|
|
5134
5134
|
declare const WaitForIOEventComparisonTypeEnum: {
|
|
5135
5135
|
readonly ComparisonTypeEqual: "COMPARISON_TYPE_EQUAL";
|
|
@@ -5305,7 +5305,7 @@ declare class CoordinateSystemsApi extends BaseAPI {
|
|
|
5305
5305
|
* @param {*} [options] Override http request option.
|
|
5306
5306
|
* @throws {RequiredError}
|
|
5307
5307
|
*/
|
|
5308
|
-
addCoordinateSystem(cell: string, addRequest: AddRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5308
|
+
addCoordinateSystem(cell: string, addRequest: AddRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
5309
5309
|
/**
|
|
5310
5310
|
* 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.
|
|
5311
5311
|
* @summary Delete
|
|
@@ -5314,7 +5314,7 @@ declare class CoordinateSystemsApi extends BaseAPI {
|
|
|
5314
5314
|
* @param {*} [options] Override http request option.
|
|
5315
5315
|
* @throws {RequiredError}
|
|
5316
5316
|
*/
|
|
5317
|
-
deleteCoordinateSystem(cell: string, coordinateSystem: string, options?: RawAxiosRequestConfig): Promise<
|
|
5317
|
+
deleteCoordinateSystem(cell: string, coordinateSystem: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5318
5318
|
/**
|
|
5319
5319
|
* 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.
|
|
5320
5320
|
* @summary Description
|
|
@@ -5324,7 +5324,7 @@ declare class CoordinateSystemsApi extends BaseAPI {
|
|
|
5324
5324
|
* @param {*} [options] Override http request option.
|
|
5325
5325
|
* @throws {RequiredError}
|
|
5326
5326
|
*/
|
|
5327
|
-
getCoordinateSystem(cell: string, coordinateSystem: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<
|
|
5327
|
+
getCoordinateSystem(cell: string, coordinateSystem: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
5328
5328
|
/**
|
|
5329
5329
|
* 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.
|
|
5330
5330
|
* @summary List
|
|
@@ -5333,7 +5333,7 @@ declare class CoordinateSystemsApi extends BaseAPI {
|
|
|
5333
5333
|
* @param {*} [options] Override http request option.
|
|
5334
5334
|
* @throws {RequiredError}
|
|
5335
5335
|
*/
|
|
5336
|
-
listCoordinateSystems(cell: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<
|
|
5336
|
+
listCoordinateSystems(cell: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListResponse, any>>;
|
|
5337
5337
|
/**
|
|
5338
5338
|
* Transform a pose to another base.
|
|
5339
5339
|
* @summary Transform
|
|
@@ -5343,7 +5343,7 @@ declare class CoordinateSystemsApi extends BaseAPI {
|
|
|
5343
5343
|
* @param {*} [options] Override http request option.
|
|
5344
5344
|
* @throws {RequiredError}
|
|
5345
5345
|
*/
|
|
5346
|
-
transformInCoordinateSystem(cell: string, coordinateSystem: string, pose: Pose, options?: RawAxiosRequestConfig): Promise<
|
|
5346
|
+
transformInCoordinateSystem(cell: string, coordinateSystem: string, pose: Pose, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Pose, any>>;
|
|
5347
5347
|
}
|
|
5348
5348
|
/**
|
|
5349
5349
|
* DeviceConfigurationApi - axios parameter creator
|
|
@@ -5516,7 +5516,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
|
|
|
5516
5516
|
* @deprecated
|
|
5517
5517
|
* @throws {RequiredError}
|
|
5518
5518
|
*/
|
|
5519
|
-
clearDevices(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5519
|
+
clearDevices(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5520
5520
|
/**
|
|
5521
5521
|
* 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.
|
|
5522
5522
|
* @summary Create Devices
|
|
@@ -5526,7 +5526,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
|
|
|
5526
5526
|
* @deprecated
|
|
5527
5527
|
* @throws {RequiredError}
|
|
5528
5528
|
*/
|
|
5529
|
-
createDevice(cell: string, createDeviceRequestInner: Array<CreateDeviceRequestInner>, options?: RawAxiosRequestConfig): Promise<
|
|
5529
|
+
createDevice(cell: string, createDeviceRequestInner: Array<CreateDeviceRequestInner>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<any, any>>;
|
|
5530
5530
|
/**
|
|
5531
5531
|
* Deprecated endpoint. Deletes a specific device from the cell.
|
|
5532
5532
|
* @summary Delete Device
|
|
@@ -5536,7 +5536,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
|
|
|
5536
5536
|
* @deprecated
|
|
5537
5537
|
* @throws {RequiredError}
|
|
5538
5538
|
*/
|
|
5539
|
-
deleteDevice(cell: string, identifier: string, options?: RawAxiosRequestConfig): Promise<
|
|
5539
|
+
deleteDevice(cell: string, identifier: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5540
5540
|
/**
|
|
5541
5541
|
* Deprecated endpoint. Returns information about a device.
|
|
5542
5542
|
* @summary Device Information
|
|
@@ -5546,7 +5546,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
|
|
|
5546
5546
|
* @deprecated
|
|
5547
5547
|
* @throws {RequiredError}
|
|
5548
5548
|
*/
|
|
5549
|
-
getDevice(cell: string, identifier: string, options?: RawAxiosRequestConfig): Promise<
|
|
5549
|
+
getDevice(cell: string, identifier: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<any, any>>;
|
|
5550
5550
|
/**
|
|
5551
5551
|
* Deprecated endpoint. Lists all devices which are configured in the cell: - Robots - Databases - OPC UA devices
|
|
5552
5552
|
* @summary List All Devices
|
|
@@ -5555,7 +5555,7 @@ declare class DeviceConfigurationApi extends BaseAPI {
|
|
|
5555
5555
|
* @deprecated
|
|
5556
5556
|
* @throws {RequiredError}
|
|
5557
5557
|
*/
|
|
5558
|
-
listDevices(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5558
|
+
listDevices(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListDevices200ResponseInner[], any>>;
|
|
5559
5559
|
}
|
|
5560
5560
|
/**
|
|
5561
5561
|
* LibraryProgramApi - axios parameter creator
|
|
@@ -5726,7 +5726,7 @@ declare class LibraryProgramApi extends BaseAPI {
|
|
|
5726
5726
|
* @param {*} [options] Override http request option.
|
|
5727
5727
|
* @throws {RequiredError}
|
|
5728
5728
|
*/
|
|
5729
|
-
createProgram(cell: string, body: string, name?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5729
|
+
createProgram(cell: string, body: string, name?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramMetadata, any>>;
|
|
5730
5730
|
/**
|
|
5731
5731
|
* <!-- theme: danger --> > **Experimental** Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
|
|
5732
5732
|
* @summary Delete Program
|
|
@@ -5735,7 +5735,7 @@ declare class LibraryProgramApi extends BaseAPI {
|
|
|
5735
5735
|
* @param {*} [options] Override http request option.
|
|
5736
5736
|
* @throws {RequiredError}
|
|
5737
5737
|
*/
|
|
5738
|
-
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
5738
|
+
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramMetadata, any>>;
|
|
5739
5739
|
/**
|
|
5740
5740
|
* <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
|
|
5741
5741
|
* @summary Delete Program List
|
|
@@ -5744,7 +5744,7 @@ declare class LibraryProgramApi extends BaseAPI {
|
|
|
5744
5744
|
* @param {*} [options] Override http request option.
|
|
5745
5745
|
* @throws {RequiredError}
|
|
5746
5746
|
*/
|
|
5747
|
-
deleteProgramList(cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5747
|
+
deleteProgramList(cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListProgramMetadataResponse, any>>;
|
|
5748
5748
|
/**
|
|
5749
5749
|
* <!-- 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.
|
|
5750
5750
|
* @summary Get Program
|
|
@@ -5753,7 +5753,7 @@ declare class LibraryProgramApi extends BaseAPI {
|
|
|
5753
5753
|
* @param {*} [options] Override http request option.
|
|
5754
5754
|
* @throws {RequiredError}
|
|
5755
5755
|
*/
|
|
5756
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
5756
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
5757
5757
|
/**
|
|
5758
5758
|
* <!-- 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 ```
|
|
5759
5759
|
* @summary Update Program
|
|
@@ -5763,7 +5763,7 @@ declare class LibraryProgramApi extends BaseAPI {
|
|
|
5763
5763
|
* @param {*} [options] Override http request option.
|
|
5764
5764
|
* @throws {RequiredError}
|
|
5765
5765
|
*/
|
|
5766
|
-
updateProgram(cell: string, program: string, body: string, options?: RawAxiosRequestConfig): Promise<
|
|
5766
|
+
updateProgram(cell: string, program: string, body: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramMetadata, any>>;
|
|
5767
5767
|
}
|
|
5768
5768
|
/**
|
|
5769
5769
|
* LibraryProgramMetadataApi - axios parameter creator
|
|
@@ -5906,7 +5906,7 @@ declare class LibraryProgramMetadataApi extends BaseAPI {
|
|
|
5906
5906
|
* @param {*} [options] Override http request option.
|
|
5907
5907
|
* @throws {RequiredError}
|
|
5908
5908
|
*/
|
|
5909
|
-
getProgramMetadata(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
5909
|
+
getProgramMetadata(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramMetadata, any>>;
|
|
5910
5910
|
/**
|
|
5911
5911
|
* <!-- theme: danger --> > **Experimental** Returns a list of all the stored programs, represented by their metadata.
|
|
5912
5912
|
* @summary List Program Metadata
|
|
@@ -5915,7 +5915,7 @@ declare class LibraryProgramMetadataApi extends BaseAPI {
|
|
|
5915
5915
|
* @param {*} [options] Override http request option.
|
|
5916
5916
|
* @throws {RequiredError}
|
|
5917
5917
|
*/
|
|
5918
|
-
listProgramMetadata(cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
5918
|
+
listProgramMetadata(cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListProgramMetadataResponse, any>>;
|
|
5919
5919
|
/**
|
|
5920
5920
|
* <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
|
|
5921
5921
|
* @summary Update Program Metadata
|
|
@@ -5925,7 +5925,7 @@ declare class LibraryProgramMetadataApi extends BaseAPI {
|
|
|
5925
5925
|
* @param {*} [options] Override http request option.
|
|
5926
5926
|
* @throws {RequiredError}
|
|
5927
5927
|
*/
|
|
5928
|
-
updateProgramMetadata(cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5928
|
+
updateProgramMetadata(cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramMetadata, any>>;
|
|
5929
5929
|
/**
|
|
5930
5930
|
* <!-- 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.
|
|
5931
5931
|
* @summary Upload Program Metadata Image
|
|
@@ -5935,7 +5935,7 @@ declare class LibraryProgramMetadataApi extends BaseAPI {
|
|
|
5935
5935
|
* @param {*} [options] Override http request option.
|
|
5936
5936
|
* @throws {RequiredError}
|
|
5937
5937
|
*/
|
|
5938
|
-
uploadProgramMetadataImage(cell: string, program: string, file: File, options?: RawAxiosRequestConfig): Promise<
|
|
5938
|
+
uploadProgramMetadataImage(cell: string, program: string, file: File, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramMetadata, any>>;
|
|
5939
5939
|
}
|
|
5940
5940
|
/**
|
|
5941
5941
|
* LibraryRecipeApi - axios parameter creator
|
|
@@ -6110,7 +6110,7 @@ declare class LibraryRecipeApi extends BaseAPI {
|
|
|
6110
6110
|
* @param {*} [options] Override http request option.
|
|
6111
6111
|
* @throws {RequiredError}
|
|
6112
6112
|
*/
|
|
6113
|
-
createRecipe(cell: string, programId: string, body: object, name?: string, options?: RawAxiosRequestConfig): Promise<
|
|
6113
|
+
createRecipe(cell: string, programId: string, body: object, name?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RecipeMetadata, any>>;
|
|
6114
6114
|
/**
|
|
6115
6115
|
* # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes a recipe. This action is irreversible.
|
|
6116
6116
|
* @summary Delete Recipe
|
|
@@ -6119,7 +6119,7 @@ declare class LibraryRecipeApi extends BaseAPI {
|
|
|
6119
6119
|
* @param {*} [options] Override http request option.
|
|
6120
6120
|
* @throws {RequiredError}
|
|
6121
6121
|
*/
|
|
6122
|
-
deleteRecipe(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<
|
|
6122
|
+
deleteRecipe(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RecipeMetadata, any>>;
|
|
6123
6123
|
/**
|
|
6124
6124
|
* <!-- theme: danger --> > **Experimental** Deletes the provided list of recipes. This action is irreversible.
|
|
6125
6125
|
* @summary Delete Recipe List
|
|
@@ -6128,7 +6128,7 @@ declare class LibraryRecipeApi extends BaseAPI {
|
|
|
6128
6128
|
* @param {*} [options] Override http request option.
|
|
6129
6129
|
* @throws {RequiredError}
|
|
6130
6130
|
*/
|
|
6131
|
-
deleteRecipeList(cell: string, recipeIds: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
6131
|
+
deleteRecipeList(cell: string, recipeIds: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListRecipeMetadataResponse, any>>;
|
|
6132
6132
|
/**
|
|
6133
6133
|
* <!-- 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.
|
|
6134
6134
|
* @summary Get Recipe
|
|
@@ -6137,7 +6137,7 @@ declare class LibraryRecipeApi extends BaseAPI {
|
|
|
6137
6137
|
* @param {*} [options] Override http request option.
|
|
6138
6138
|
* @throws {RequiredError}
|
|
6139
6139
|
*/
|
|
6140
|
-
getRecipe(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<
|
|
6140
|
+
getRecipe(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
|
|
6141
6141
|
/**
|
|
6142
6142
|
* <!-- theme: danger --> > **Experimental** Updates an existing recipe. The update is partial, only the set fields get updated.
|
|
6143
6143
|
* @summary Update Recipe
|
|
@@ -6147,7 +6147,7 @@ declare class LibraryRecipeApi extends BaseAPI {
|
|
|
6147
6147
|
* @param {*} [options] Override http request option.
|
|
6148
6148
|
* @throws {RequiredError}
|
|
6149
6149
|
*/
|
|
6150
|
-
updateRecipe(cell: string, recipe: string, body: object, options?: RawAxiosRequestConfig): Promise<
|
|
6150
|
+
updateRecipe(cell: string, recipe: string, body: object, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RecipeMetadata, any>>;
|
|
6151
6151
|
}
|
|
6152
6152
|
/**
|
|
6153
6153
|
* LibraryRecipeMetadataApi - axios parameter creator
|
|
@@ -6287,7 +6287,7 @@ declare class LibraryRecipeMetadataApi extends BaseAPI {
|
|
|
6287
6287
|
* @param {*} [options] Override http request option.
|
|
6288
6288
|
* @throws {RequiredError}
|
|
6289
6289
|
*/
|
|
6290
|
-
getRecipeMetadata(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<
|
|
6290
|
+
getRecipeMetadata(cell: string, recipe: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RecipeMetadata, any>>;
|
|
6291
6291
|
/**
|
|
6292
6292
|
* <!-- theme: danger --> > **Experimental** List of all the stored recipes, represented by their metadata.
|
|
6293
6293
|
* @summary List Recipe Metadata
|
|
@@ -6295,7 +6295,7 @@ declare class LibraryRecipeMetadataApi extends BaseAPI {
|
|
|
6295
6295
|
* @param {*} [options] Override http request option.
|
|
6296
6296
|
* @throws {RequiredError}
|
|
6297
6297
|
*/
|
|
6298
|
-
listRecipeMetadata(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6298
|
+
listRecipeMetadata(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListRecipeMetadataResponse, any>>;
|
|
6299
6299
|
/**
|
|
6300
6300
|
* <!-- theme: danger --> > **Experimental** Updates the metadata of a recipe. The update is partial, only the set fields get updated.
|
|
6301
6301
|
* @summary Update Recipe Metadata
|
|
@@ -6305,7 +6305,7 @@ declare class LibraryRecipeMetadataApi extends BaseAPI {
|
|
|
6305
6305
|
* @param {*} [options] Override http request option.
|
|
6306
6306
|
* @throws {RequiredError}
|
|
6307
6307
|
*/
|
|
6308
|
-
updateRecipeMetadata(cell: string, recipe: string, updateRecipeMetadataRequest: UpdateRecipeMetadataRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6308
|
+
updateRecipeMetadata(cell: string, recipe: string, updateRecipeMetadataRequest: UpdateRecipeMetadataRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RecipeMetadata, any>>;
|
|
6309
6309
|
/**
|
|
6310
6310
|
* <!-- 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.
|
|
6311
6311
|
* @summary Upload Recipe Metadata Image
|
|
@@ -6315,7 +6315,7 @@ declare class LibraryRecipeMetadataApi extends BaseAPI {
|
|
|
6315
6315
|
* @param {*} [options] Override http request option.
|
|
6316
6316
|
* @throws {RequiredError}
|
|
6317
6317
|
*/
|
|
6318
|
-
uploadRecipeMetadataImage(cell: string, recipe: string, file: File, options?: RawAxiosRequestConfig): Promise<
|
|
6318
|
+
uploadRecipeMetadataImage(cell: string, recipe: string, file: File, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RecipeMetadata, any>>;
|
|
6319
6319
|
}
|
|
6320
6320
|
/**
|
|
6321
6321
|
* LicenseApi - axios parameter creator
|
|
@@ -6430,28 +6430,28 @@ declare class LicenseApi extends BaseAPI {
|
|
|
6430
6430
|
* @param {*} [options] Override http request option.
|
|
6431
6431
|
* @throws {RequiredError}
|
|
6432
6432
|
*/
|
|
6433
|
-
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6433
|
+
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
6434
6434
|
/**
|
|
6435
6435
|
* Deactivates active license.
|
|
6436
6436
|
* @summary Deactivate license
|
|
6437
6437
|
* @param {*} [options] Override http request option.
|
|
6438
6438
|
* @throws {RequiredError}
|
|
6439
6439
|
*/
|
|
6440
|
-
deactivateLicense(options?: RawAxiosRequestConfig): Promise<
|
|
6440
|
+
deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6441
6441
|
/**
|
|
6442
6442
|
* Get information on the license used with the Wandelbots NOVA instance, e.g. licensed product, expiration date, license status.
|
|
6443
6443
|
* @summary Get license
|
|
6444
6444
|
* @param {*} [options] Override http request option.
|
|
6445
6445
|
* @throws {RequiredError}
|
|
6446
6446
|
*/
|
|
6447
|
-
getLicense(options?: RawAxiosRequestConfig): Promise<
|
|
6447
|
+
getLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
6448
6448
|
/**
|
|
6449
6449
|
* 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.
|
|
6450
6450
|
* @summary Get license status
|
|
6451
6451
|
* @param {*} [options] Override http request option.
|
|
6452
6452
|
* @throws {RequiredError}
|
|
6453
6453
|
*/
|
|
6454
|
-
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<
|
|
6454
|
+
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<LicenseStatus, any>>;
|
|
6455
6455
|
}
|
|
6456
6456
|
/**
|
|
6457
6457
|
* MotionApi - axios parameter creator
|
|
@@ -7004,7 +7004,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7004
7004
|
* @param {*} [options] Override http request option.
|
|
7005
7005
|
* @throws {RequiredError}
|
|
7006
7006
|
*/
|
|
7007
|
-
deleteAllMotions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7007
|
+
deleteAllMotions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7008
7008
|
/**
|
|
7009
7009
|
* 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.
|
|
7010
7010
|
* @summary Remove
|
|
@@ -7013,7 +7013,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7013
7013
|
* @param {*} [options] Override http request option.
|
|
7014
7014
|
* @throws {RequiredError}
|
|
7015
7015
|
*/
|
|
7016
|
-
deleteMotion(cell: string, motion: string, options?: RawAxiosRequestConfig): Promise<
|
|
7016
|
+
deleteMotion(cell: string, motion: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7017
7017
|
/**
|
|
7018
7018
|
* <!-- 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.
|
|
7019
7019
|
* @summary Execute Trajectory
|
|
@@ -7022,7 +7022,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7022
7022
|
* @param {*} [options] Override http request option.
|
|
7023
7023
|
* @throws {RequiredError}
|
|
7024
7024
|
*/
|
|
7025
|
-
executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7025
|
+
executeTrajectory(cell: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
7026
7026
|
/**
|
|
7027
7027
|
* 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.
|
|
7028
7028
|
* @summary Get Trajectory
|
|
@@ -7033,7 +7033,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7033
7033
|
* @param {*} [options] Override http request option.
|
|
7034
7034
|
* @throws {RequiredError}
|
|
7035
7035
|
*/
|
|
7036
|
-
getMotionTrajectory(cell: string, motion: string, sampleTime: number, responsesCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
7036
|
+
getMotionTrajectory(cell: string, motion: string, sampleTime: number, responsesCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
|
|
7037
7037
|
/**
|
|
7038
7038
|
* Get a single point at a certain location of a planned motion. To get the whole trajectory, use the [getMotionTrajectory](getMotionTrajectory) endpoint.
|
|
7039
7039
|
* @summary Get Trajectory Sample
|
|
@@ -7044,7 +7044,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7044
7044
|
* @param {*} [options] Override http request option.
|
|
7045
7045
|
* @throws {RequiredError}
|
|
7046
7046
|
*/
|
|
7047
|
-
getMotionTrajectorySample(cell: string, motion: string, locationOnTrajectory?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
7047
|
+
getMotionTrajectorySample(cell: string, motion: string, locationOnTrajectory?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectorySampleResponse, any>>;
|
|
7048
7048
|
/**
|
|
7049
7049
|
* 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.
|
|
7050
7050
|
* @summary Get Planned Motion
|
|
@@ -7054,7 +7054,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7054
7054
|
* @param {*} [options] Override http request option.
|
|
7055
7055
|
* @throws {RequiredError}
|
|
7056
7056
|
*/
|
|
7057
|
-
getPlannedMotion(cell: string, motion: string, sampleTime?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7057
|
+
getPlannedMotion(cell: string, motion: string, sampleTime?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlannedMotion, any>>;
|
|
7058
7058
|
/**
|
|
7059
7059
|
* Returns motion group models that are supported for planning.
|
|
7060
7060
|
* @summary Motion Group Models for Planning
|
|
@@ -7062,7 +7062,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7062
7062
|
* @param {*} [options] Override http request option.
|
|
7063
7063
|
* @throws {RequiredError}
|
|
7064
7064
|
*/
|
|
7065
|
-
getPlanningMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7065
|
+
getPlanningMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
7066
7066
|
/**
|
|
7067
7067
|
* 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.
|
|
7068
7068
|
* @summary List All Motions
|
|
@@ -7070,7 +7070,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7070
7070
|
* @param {*} [options] Override http request option.
|
|
7071
7071
|
* @throws {RequiredError}
|
|
7072
7072
|
*/
|
|
7073
|
-
listMotions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7073
|
+
listMotions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionIdsListResponse, any>>;
|
|
7074
7074
|
/**
|
|
7075
7075
|
* 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.
|
|
7076
7076
|
* @summary Load Planned Motion
|
|
@@ -7079,7 +7079,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7079
7079
|
* @param {*} [options] Override http request option.
|
|
7080
7080
|
* @throws {RequiredError}
|
|
7081
7081
|
*/
|
|
7082
|
-
loadPlannedMotion(cell: string, plannedMotion: PlannedMotion, options?: RawAxiosRequestConfig): Promise<
|
|
7082
|
+
loadPlannedMotion(cell: string, plannedMotion: PlannedMotion, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanResponse, any>>;
|
|
7083
7083
|
/**
|
|
7084
7084
|
* <!-- 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.
|
|
7085
7085
|
* @summary Plan Collision Free PTP
|
|
@@ -7088,7 +7088,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7088
7088
|
* @param {*} [options] Override http request option.
|
|
7089
7089
|
* @throws {RequiredError}
|
|
7090
7090
|
*/
|
|
7091
|
-
planCollisionFreePTP(cell: string, planCollisionFreePTPRequest?: PlanCollisionFreePTPRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7091
|
+
planCollisionFreePTP(cell: string, planCollisionFreePTPRequest?: PlanCollisionFreePTPRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
7092
7092
|
/**
|
|
7093
7093
|
* 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.
|
|
7094
7094
|
* @summary Plan Motion
|
|
@@ -7098,7 +7098,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7098
7098
|
* @deprecated
|
|
7099
7099
|
* @throws {RequiredError}
|
|
7100
7100
|
*/
|
|
7101
|
-
planMotion(cell: string, planRequest: PlanRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7101
|
+
planMotion(cell: string, planRequest: PlanRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanResponse, any>>;
|
|
7102
7102
|
/**
|
|
7103
7103
|
* 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.
|
|
7104
7104
|
* @summary Plan Trajectory
|
|
@@ -7107,7 +7107,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7107
7107
|
* @param {*} [options] Override http request option.
|
|
7108
7108
|
* @throws {RequiredError}
|
|
7109
7109
|
*/
|
|
7110
|
-
planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7110
|
+
planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
7111
7111
|
/**
|
|
7112
7112
|
* 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. This call will immediately return even if the deceleration is still in progress. The active movement stream returns responses 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.
|
|
7113
7113
|
* @summary Stop
|
|
@@ -7116,7 +7116,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7116
7116
|
* @param {*} [options] Override http request option.
|
|
7117
7117
|
* @throws {RequiredError}
|
|
7118
7118
|
*/
|
|
7119
|
-
stopExecution(cell: string, motion: string, options?: RawAxiosRequestConfig): Promise<
|
|
7119
|
+
stopExecution(cell: string, motion: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7120
7120
|
/**
|
|
7121
7121
|
* 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.
|
|
7122
7122
|
* @summary Stream Move
|
|
@@ -7126,7 +7126,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7126
7126
|
* @deprecated
|
|
7127
7127
|
* @throws {RequiredError}
|
|
7128
7128
|
*/
|
|
7129
|
-
streamMove(cell: string, streamMoveRequest: StreamMoveRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7129
|
+
streamMove(cell: string, streamMoveRequest: StreamMoveRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamMoveResponse, any>>;
|
|
7130
7130
|
/**
|
|
7131
7131
|
* 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.
|
|
7132
7132
|
* @summary Stream Backward
|
|
@@ -7140,7 +7140,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7140
7140
|
* @deprecated
|
|
7141
7141
|
* @throws {RequiredError}
|
|
7142
7142
|
*/
|
|
7143
|
-
streamMoveBackward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7143
|
+
streamMoveBackward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamMoveResponse, any>>;
|
|
7144
7144
|
/**
|
|
7145
7145
|
* 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.
|
|
7146
7146
|
* @summary Stream Forward
|
|
@@ -7154,7 +7154,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7154
7154
|
* @deprecated
|
|
7155
7155
|
* @throws {RequiredError}
|
|
7156
7156
|
*/
|
|
7157
|
-
streamMoveForward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7157
|
+
streamMoveForward(cell: string, motion: string, playbackSpeedInPercent: number, responseRate?: number, responseCoordinateSystem?: string, startLocationOnTrajectory?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamMoveResponse, any>>;
|
|
7158
7158
|
/**
|
|
7159
7159
|
* 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.
|
|
7160
7160
|
* @summary Stream to Trajectory
|
|
@@ -7171,7 +7171,7 @@ declare class MotionApi extends BaseAPI {
|
|
|
7171
7171
|
* @param {*} [options] Override http request option.
|
|
7172
7172
|
* @throws {RequiredError}
|
|
7173
7173
|
*/
|
|
7174
|
-
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<
|
|
7174
|
+
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<axios0.AxiosResponse<StreamMoveResponse, any>>;
|
|
7175
7175
|
}
|
|
7176
7176
|
/**
|
|
7177
7177
|
* MotionGroupApi - axios parameter creator
|
|
@@ -7305,7 +7305,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
7305
7305
|
* @param {*} [options] Override http request option.
|
|
7306
7306
|
* @throws {RequiredError}
|
|
7307
7307
|
*/
|
|
7308
|
-
activateAllMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7308
|
+
activateAllMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInstanceList, any>>;
|
|
7309
7309
|
/**
|
|
7310
7310
|
* 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).
|
|
7311
7311
|
* @summary Activate
|
|
@@ -7314,7 +7314,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
7314
7314
|
* @param {*} [options] Override http request option.
|
|
7315
7315
|
* @throws {RequiredError}
|
|
7316
7316
|
*/
|
|
7317
|
-
activateMotionGroup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7317
|
+
activateMotionGroup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInstance, any>>;
|
|
7318
7318
|
/**
|
|
7319
7319
|
* 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.
|
|
7320
7320
|
* @summary Deactivate
|
|
@@ -7323,7 +7323,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
7323
7323
|
* @param {*} [options] Override http request option.
|
|
7324
7324
|
* @throws {RequiredError}
|
|
7325
7325
|
*/
|
|
7326
|
-
deactivateMotionGroup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7326
|
+
deactivateMotionGroup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7327
7327
|
/**
|
|
7328
7328
|
* List all active motion groups. A motion group is active if it is currently used by a controller.
|
|
7329
7329
|
* @summary List Active
|
|
@@ -7331,7 +7331,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
7331
7331
|
* @param {*} [options] Override http request option.
|
|
7332
7332
|
* @throws {RequiredError}
|
|
7333
7333
|
*/
|
|
7334
|
-
listMotionGroups(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7334
|
+
listMotionGroups(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInstanceList, any>>;
|
|
7335
7335
|
}
|
|
7336
7336
|
/**
|
|
7337
7337
|
* MotionGroupInfosApi - axios parameter creator
|
|
@@ -7681,7 +7681,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
7681
7681
|
* @param {*} [options] Override http request option.
|
|
7682
7682
|
* @throws {RequiredError}
|
|
7683
7683
|
*/
|
|
7684
|
-
getActivePayload(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7684
|
+
getActivePayload(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Payload, any>>;
|
|
7685
7685
|
/**
|
|
7686
7686
|
* Get the internal selected TCP of a connected device.
|
|
7687
7687
|
* @summary Selected TCP
|
|
@@ -7691,7 +7691,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
7691
7691
|
* @param {*} [options] Override http request option.
|
|
7692
7692
|
* @throws {RequiredError}
|
|
7693
7693
|
*/
|
|
7694
|
-
getActiveTcp(cell: string, motionGroup: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<
|
|
7694
|
+
getActiveTcp(cell: string, motionGroup: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp, any>>;
|
|
7695
7695
|
/**
|
|
7696
7696
|
* Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
|
|
7697
7697
|
* @summary State of Device
|
|
@@ -7702,7 +7702,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
7702
7702
|
* @param {*} [options] Override http request option.
|
|
7703
7703
|
* @throws {RequiredError}
|
|
7704
7704
|
*/
|
|
7705
|
-
getCurrentMotionGroupState(cell: string, motionGroup: string, tcp?: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
7705
|
+
getCurrentMotionGroupState(cell: string, motionGroup: string, tcp?: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupStateResponse, any>>;
|
|
7706
7706
|
/**
|
|
7707
7707
|
* 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.
|
|
7708
7708
|
* @summary Capabilities
|
|
@@ -7711,7 +7711,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
7711
7711
|
* @param {*} [options] Override http request option.
|
|
7712
7712
|
* @throws {RequiredError}
|
|
7713
7713
|
*/
|
|
7714
|
-
getInfoCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7714
|
+
getInfoCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<InfoServiceCapabilities, any>>;
|
|
7715
7715
|
/**
|
|
7716
7716
|
* 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.
|
|
7717
7717
|
* @summary Get Static Properties
|
|
@@ -7720,7 +7720,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
7720
7720
|
* @param {*} [options] Override http request option.
|
|
7721
7721
|
* @throws {RequiredError}
|
|
7722
7722
|
*/
|
|
7723
|
-
getMotionGroupSpecification(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7723
|
+
getMotionGroupSpecification(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupSpecification, any>>;
|
|
7724
7724
|
/**
|
|
7725
7725
|
* Returns the configured mounting pose offset in relation to world coordinate system and the motion groups coordinate system.
|
|
7726
7726
|
* @summary Device Mounting
|
|
@@ -7729,7 +7729,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
7729
7729
|
* @param {*} [options] Override http request option.
|
|
7730
7730
|
* @throws {RequiredError}
|
|
7731
7731
|
*/
|
|
7732
|
-
getMounting(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7732
|
+
getMounting(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Mounting, any>>;
|
|
7733
7733
|
/**
|
|
7734
7734
|
* <!-- theme: danger --> > **Experimental** Get the complete configuration which can be passed to the planner-optimizer (incl. motion group description, limits etc.)
|
|
7735
7735
|
* @summary Optimizer Configuration
|
|
@@ -7739,7 +7739,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
7739
7739
|
* @param {*} [options] Override http request option.
|
|
7740
7740
|
* @throws {RequiredError}
|
|
7741
7741
|
*/
|
|
7742
|
-
getOptimizerConfiguration(cell: string, motionGroup: string, tcp?: string, options?: RawAxiosRequestConfig): Promise<
|
|
7742
|
+
getOptimizerConfiguration(cell: string, motionGroup: string, tcp?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<OptimizerSetup, any>>;
|
|
7743
7743
|
/**
|
|
7744
7744
|
* 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).
|
|
7745
7745
|
* @summary Safety Setup and Limitations
|
|
@@ -7748,7 +7748,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
7748
7748
|
* @param {*} [options] Override http request option.
|
|
7749
7749
|
* @throws {RequiredError}
|
|
7750
7750
|
*/
|
|
7751
|
-
getSafetySetup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7751
|
+
getSafetySetup(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<SafetySetup, any>>;
|
|
7752
7752
|
/**
|
|
7753
7753
|
* 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.
|
|
7754
7754
|
* @summary List Payloads
|
|
@@ -7757,7 +7757,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
7757
7757
|
* @param {*} [options] Override http request option.
|
|
7758
7758
|
* @throws {RequiredError}
|
|
7759
7759
|
*/
|
|
7760
|
-
listPayloads(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7760
|
+
listPayloads(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListPayloadsResponse, any>>;
|
|
7761
7761
|
/**
|
|
7762
7762
|
* Get all internal configured TCPs of a connected device.
|
|
7763
7763
|
* @summary List TCPs
|
|
@@ -7767,7 +7767,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
7767
7767
|
* @param {*} [options] Override http request option.
|
|
7768
7768
|
* @throws {RequiredError}
|
|
7769
7769
|
*/
|
|
7770
|
-
listTcps(cell: string, motionGroup: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<
|
|
7770
|
+
listTcps(cell: string, motionGroup: string, rotationType?: RotationAngleTypes, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListTcpsResponse, any>>;
|
|
7771
7771
|
/**
|
|
7772
7772
|
* Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
7773
7773
|
* @summary Stream State of Device
|
|
@@ -7779,7 +7779,7 @@ declare class MotionGroupInfosApi extends BaseAPI {
|
|
|
7779
7779
|
* @param {*} [options] Override http request option.
|
|
7780
7780
|
* @throws {RequiredError}
|
|
7781
7781
|
*/
|
|
7782
|
-
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, tcp?: string, options?: RawAxiosRequestConfig): Promise<
|
|
7782
|
+
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, tcp?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupStateResponse, any>>;
|
|
7783
7783
|
}
|
|
7784
7784
|
/**
|
|
7785
7785
|
* MotionGroupJoggingApi - axios parameter creator
|
|
@@ -7916,7 +7916,7 @@ declare class MotionGroupJoggingApi extends BaseAPI {
|
|
|
7916
7916
|
* @param {*} [options] Override http request option.
|
|
7917
7917
|
* @throws {RequiredError}
|
|
7918
7918
|
*/
|
|
7919
|
-
directionJogging(cell: string, directionJoggingRequest: DirectionJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7919
|
+
directionJogging(cell: string, directionJoggingRequest: DirectionJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<JoggingResponse, any>>;
|
|
7920
7920
|
/**
|
|
7921
7921
|
* 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.
|
|
7922
7922
|
* @summary Capabilities
|
|
@@ -7925,7 +7925,7 @@ declare class MotionGroupJoggingApi extends BaseAPI {
|
|
|
7925
7925
|
* @param {*} [options] Override http request option.
|
|
7926
7926
|
* @throws {RequiredError}
|
|
7927
7927
|
*/
|
|
7928
|
-
getJoggingCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7928
|
+
getJoggingCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<JoggingServiceCapabilities, any>>;
|
|
7929
7929
|
/**
|
|
7930
7930
|
* 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.
|
|
7931
7931
|
* @summary Stream Joints
|
|
@@ -7934,7 +7934,7 @@ declare class MotionGroupJoggingApi extends BaseAPI {
|
|
|
7934
7934
|
* @param {*} [options] Override http request option.
|
|
7935
7935
|
* @throws {RequiredError}
|
|
7936
7936
|
*/
|
|
7937
|
-
jointJogging(cell: string, jointJoggingRequest: JointJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7937
|
+
jointJogging(cell: string, jointJoggingRequest: JointJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<JoggingResponse, any>>;
|
|
7938
7938
|
/**
|
|
7939
7939
|
* 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.
|
|
7940
7940
|
* @summary Stop
|
|
@@ -7943,7 +7943,7 @@ declare class MotionGroupJoggingApi extends BaseAPI {
|
|
|
7943
7943
|
* @param {*} [options] Override http request option.
|
|
7944
7944
|
* @throws {RequiredError}
|
|
7945
7945
|
*/
|
|
7946
|
-
stopJogging(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7946
|
+
stopJogging(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7947
7947
|
}
|
|
7948
7948
|
/**
|
|
7949
7949
|
* MotionGroupKinematicApi - axios parameter creator
|
|
@@ -8090,7 +8090,7 @@ declare class MotionGroupKinematicApi extends BaseAPI {
|
|
|
8090
8090
|
* @param {*} [options] Override http request option.
|
|
8091
8091
|
* @throws {RequiredError}
|
|
8092
8092
|
*/
|
|
8093
|
-
calculateAllInverseKinematic(cell: string, motionGroup: string, allJointPositionsRequest: AllJointPositionsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8093
|
+
calculateAllInverseKinematic(cell: string, motionGroup: string, allJointPositionsRequest: AllJointPositionsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<AllJointPositionsResponse, any>>;
|
|
8094
8094
|
/**
|
|
8095
8095
|
* Calculates the TCP pose from a joint position sample using the forward kinematics of the motion-group.
|
|
8096
8096
|
* @summary TcpPose from JointPosition
|
|
@@ -8100,7 +8100,7 @@ declare class MotionGroupKinematicApi extends BaseAPI {
|
|
|
8100
8100
|
* @param {*} [options] Override http request option.
|
|
8101
8101
|
* @throws {RequiredError}
|
|
8102
8102
|
*/
|
|
8103
|
-
calculateForwardKinematic(cell: string, motionGroup: string, tcpPoseRequest: TcpPoseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8103
|
+
calculateForwardKinematic(cell: string, motionGroup: string, tcpPoseRequest: TcpPoseRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Pose, any>>;
|
|
8104
8104
|
/**
|
|
8105
8105
|
* 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.
|
|
8106
8106
|
* @summary Nearest JointPosition from TcpPose
|
|
@@ -8110,7 +8110,7 @@ declare class MotionGroupKinematicApi extends BaseAPI {
|
|
|
8110
8110
|
* @param {*} [options] Override http request option.
|
|
8111
8111
|
* @throws {RequiredError}
|
|
8112
8112
|
*/
|
|
8113
|
-
calculateInverseKinematic(cell: string, motionGroup: string, jointPositionRequest: JointPositionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8113
|
+
calculateInverseKinematic(cell: string, motionGroup: string, jointPositionRequest: JointPositionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Joints, any>>;
|
|
8114
8114
|
/**
|
|
8115
8115
|
* Get the kinematic endpoints provided for the specified motion-group.
|
|
8116
8116
|
* @summary Capabilities
|
|
@@ -8119,7 +8119,7 @@ declare class MotionGroupKinematicApi extends BaseAPI {
|
|
|
8119
8119
|
* @param {*} [options] Override http request option.
|
|
8120
8120
|
* @throws {RequiredError}
|
|
8121
8121
|
*/
|
|
8122
|
-
getKinematicCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8122
|
+
getKinematicCapabilities(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<KinematicServiceCapabilities, any>>;
|
|
8123
8123
|
}
|
|
8124
8124
|
/**
|
|
8125
8125
|
* ProgramApi - axios parameter creator
|
|
@@ -8361,7 +8361,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8361
8361
|
* @param {*} [options] Override http request option.
|
|
8362
8362
|
* @throws {RequiredError}
|
|
8363
8363
|
*/
|
|
8364
|
-
createProgramRunner(cell: string, request: Request, options?: RawAxiosRequestConfig): Promise<
|
|
8364
|
+
createProgramRunner(cell: string, request: Request, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRunnerReference, any>>;
|
|
8365
8365
|
/**
|
|
8366
8366
|
* 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)
|
|
8367
8367
|
* @summary Execute Program
|
|
@@ -8370,7 +8370,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8370
8370
|
* @param {*} [options] Override http request option.
|
|
8371
8371
|
* @throws {RequiredError}
|
|
8372
8372
|
*/
|
|
8373
|
-
executeProgram(cell: string, codeWithArguments: CodeWithArguments, options?: RawAxiosRequestConfig): Promise<
|
|
8373
|
+
executeProgram(cell: string, codeWithArguments: CodeWithArguments, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
|
|
8374
8374
|
/**
|
|
8375
8375
|
* 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
|
|
8376
8376
|
* @summary Get Program Runner
|
|
@@ -8379,7 +8379,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8379
8379
|
* @param {*} [options] Override http request option.
|
|
8380
8380
|
* @throws {RequiredError}
|
|
8381
8381
|
*/
|
|
8382
|
-
getProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<
|
|
8382
|
+
getProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
|
|
8383
8383
|
/**
|
|
8384
8384
|
* Get details about all existing program runners.
|
|
8385
8385
|
* @summary List Program Runners
|
|
@@ -8387,7 +8387,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8387
8387
|
* @param {*} [options] Override http request option.
|
|
8388
8388
|
* @throws {RequiredError}
|
|
8389
8389
|
*/
|
|
8390
|
-
listProgramRunners(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8390
|
+
listProgramRunners(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRunnerReference[], any>>;
|
|
8391
8391
|
/**
|
|
8392
8392
|
* Migrate a program ## Parameters See the **Schema** tab for information about the request body
|
|
8393
8393
|
* @summary Migrate Program
|
|
@@ -8396,7 +8396,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8396
8396
|
* @param {*} [options] Override http request option.
|
|
8397
8397
|
* @throws {RequiredError}
|
|
8398
8398
|
*/
|
|
8399
|
-
migrateProgram(cell: string, request1: Request1, options?: RawAxiosRequestConfig): Promise<
|
|
8399
|
+
migrateProgram(cell: string, request1: Request1, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
8400
8400
|
/**
|
|
8401
8401
|
* 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)
|
|
8402
8402
|
* @summary Plan Program
|
|
@@ -8406,7 +8406,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8406
8406
|
* @param {*} [options] Override http request option.
|
|
8407
8407
|
* @throws {RequiredError}
|
|
8408
8408
|
*/
|
|
8409
|
-
planProgram(cell: string, request: Request, identifier?: string, options?: RawAxiosRequestConfig): Promise<
|
|
8409
|
+
planProgram(cell: string, request: Request, identifier?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
|
|
8410
8410
|
/**
|
|
8411
8411
|
* Stop all runners.
|
|
8412
8412
|
* @summary Stop All Program Runners
|
|
@@ -8414,7 +8414,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8414
8414
|
* @param {*} [options] Override http request option.
|
|
8415
8415
|
* @throws {RequiredError}
|
|
8416
8416
|
*/
|
|
8417
|
-
stopAllProgramRunner(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8417
|
+
stopAllProgramRunner(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<any, any>>;
|
|
8418
8418
|
/**
|
|
8419
8419
|
* 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
|
|
8420
8420
|
* @summary Stop Program Runner
|
|
@@ -8423,7 +8423,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
8423
8423
|
* @param {*} [options] Override http request option.
|
|
8424
8424
|
* @throws {RequiredError}
|
|
8425
8425
|
*/
|
|
8426
|
-
stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<
|
|
8426
|
+
stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8427
8427
|
}
|
|
8428
8428
|
/**
|
|
8429
8429
|
* ProgramOperatorApi - axios parameter creator
|
|
@@ -8668,7 +8668,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
8668
8668
|
* @param {*} [options] Override http request option.
|
|
8669
8669
|
* @throws {RequiredError}
|
|
8670
8670
|
*/
|
|
8671
|
-
createProgramRun(cell: string, createProgramRunRequest: CreateProgramRunRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8671
|
+
createProgramRun(cell: string, createProgramRunRequest: CreateProgramRunRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CreateProgramRun200Response, any>>;
|
|
8672
8672
|
/**
|
|
8673
8673
|
* <!-- 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.
|
|
8674
8674
|
* @summary Create Trigger
|
|
@@ -8677,7 +8677,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
8677
8677
|
* @param {*} [options] Override http request option.
|
|
8678
8678
|
* @throws {RequiredError}
|
|
8679
8679
|
*/
|
|
8680
|
-
createTrigger(cell: string, createTriggerRequest: CreateTriggerRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8680
|
+
createTrigger(cell: string, createTriggerRequest: CreateTriggerRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CreateTrigger200Response, any>>;
|
|
8681
8681
|
/**
|
|
8682
8682
|
* <!-- theme: danger --> > **Experimental** Delete an existing trigger.
|
|
8683
8683
|
* @summary Delete Trigger
|
|
@@ -8686,7 +8686,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
8686
8686
|
* @param {*} [options] Override http request option.
|
|
8687
8687
|
* @throws {RequiredError}
|
|
8688
8688
|
*/
|
|
8689
|
-
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8689
|
+
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8690
8690
|
/**
|
|
8691
8691
|
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
8692
8692
|
* @summary Get All Program Runs
|
|
@@ -8695,7 +8695,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
8695
8695
|
* @param {*} [options] Override http request option.
|
|
8696
8696
|
* @throws {RequiredError}
|
|
8697
8697
|
*/
|
|
8698
|
-
getAllProgramRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<
|
|
8698
|
+
getAllProgramRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetAllProgramRuns200Response, any>>;
|
|
8699
8699
|
/**
|
|
8700
8700
|
* <!-- 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.
|
|
8701
8701
|
* @summary Get All Triggers
|
|
@@ -8703,7 +8703,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
8703
8703
|
* @param {*} [options] Override http request option.
|
|
8704
8704
|
* @throws {RequiredError}
|
|
8705
8705
|
*/
|
|
8706
|
-
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8706
|
+
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetAllTriggers200Response, any>>;
|
|
8707
8707
|
/**
|
|
8708
8708
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
8709
8709
|
* @summary Get Program Run
|
|
@@ -8712,7 +8712,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
8712
8712
|
* @param {*} [options] Override http request option.
|
|
8713
8713
|
* @throws {RequiredError}
|
|
8714
8714
|
*/
|
|
8715
|
-
getProgramRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8715
|
+
getProgramRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRunObject, any>>;
|
|
8716
8716
|
/**
|
|
8717
8717
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
8718
8718
|
* @summary Get Trigger
|
|
@@ -8721,7 +8721,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
8721
8721
|
* @param {*} [options] Override http request option.
|
|
8722
8722
|
* @throws {RequiredError}
|
|
8723
8723
|
*/
|
|
8724
|
-
getTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8724
|
+
getTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<TriggerObject, any>>;
|
|
8725
8725
|
/**
|
|
8726
8726
|
* <!-- 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.
|
|
8727
8727
|
* @summary Update Trigger
|
|
@@ -8731,7 +8731,7 @@ declare class ProgramOperatorApi extends BaseAPI {
|
|
|
8731
8731
|
* @param {*} [options] Override http request option.
|
|
8732
8732
|
* @throws {RequiredError}
|
|
8733
8733
|
*/
|
|
8734
|
-
updateTrigger(trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8734
|
+
updateTrigger(trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<TriggerObject, any>>;
|
|
8735
8735
|
}
|
|
8736
8736
|
/**
|
|
8737
8737
|
* ProgramValuesApi - axios parameter creator
|
|
@@ -8947,7 +8947,7 @@ declare class ProgramValuesApi extends BaseAPI {
|
|
|
8947
8947
|
* @deprecated
|
|
8948
8948
|
* @throws {RequiredError}
|
|
8949
8949
|
*/
|
|
8950
|
-
clearProgramsValues(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8950
|
+
clearProgramsValues(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8951
8951
|
/**
|
|
8952
8952
|
* 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)
|
|
8953
8953
|
* @summary Add Value(s)
|
|
@@ -8959,7 +8959,7 @@ declare class ProgramValuesApi extends BaseAPI {
|
|
|
8959
8959
|
*/
|
|
8960
8960
|
createProgramsValue(cell: string, requestBody: {
|
|
8961
8961
|
[key: string]: CollectionValue;
|
|
8962
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
8962
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8963
8963
|
/**
|
|
8964
8964
|
* Delete a value from the database.
|
|
8965
8965
|
* @summary Delete Value
|
|
@@ -8969,7 +8969,7 @@ declare class ProgramValuesApi extends BaseAPI {
|
|
|
8969
8969
|
* @deprecated
|
|
8970
8970
|
* @throws {RequiredError}
|
|
8971
8971
|
*/
|
|
8972
|
-
deleteProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
8972
|
+
deleteProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8973
8973
|
/**
|
|
8974
8974
|
* 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)
|
|
8975
8975
|
* @summary Get Value
|
|
@@ -8979,7 +8979,7 @@ declare class ProgramValuesApi extends BaseAPI {
|
|
|
8979
8979
|
* @deprecated
|
|
8980
8980
|
* @throws {RequiredError}
|
|
8981
8981
|
*/
|
|
8982
|
-
getProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
8982
|
+
getProgramValue(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ResponseGetValueProgramsValuesKeyGet, any>>;
|
|
8983
8983
|
/**
|
|
8984
8984
|
* 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)
|
|
8985
8985
|
* @summary Get Values
|
|
@@ -8988,7 +8988,7 @@ declare class ProgramValuesApi extends BaseAPI {
|
|
|
8988
8988
|
* @deprecated
|
|
8989
8989
|
* @throws {RequiredError}
|
|
8990
8990
|
*/
|
|
8991
|
-
listProgramsValues(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8991
|
+
listProgramsValues(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
8992
8992
|
[key: string]: ResponseGetValuesProgramsValuesGetValue;
|
|
8993
8993
|
}, any>>;
|
|
8994
8994
|
/**
|
|
@@ -9001,7 +9001,7 @@ declare class ProgramValuesApi extends BaseAPI {
|
|
|
9001
9001
|
* @deprecated
|
|
9002
9002
|
* @throws {RequiredError}
|
|
9003
9003
|
*/
|
|
9004
|
-
updateProgramValue(cell: string, key: string, value: Value, options?: RawAxiosRequestConfig): Promise<
|
|
9004
|
+
updateProgramValue(cell: string, key: string, value: Value, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9005
9005
|
}
|
|
9006
9006
|
/**
|
|
9007
9007
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
@@ -9436,7 +9436,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9436
9436
|
* @param {*} [options] Override http request option.
|
|
9437
9437
|
* @throws {RequiredError}
|
|
9438
9438
|
*/
|
|
9439
|
-
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
9439
|
+
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9440
9440
|
/**
|
|
9441
9441
|
* Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
|
|
9442
9442
|
* @summary Delete Link Chain
|
|
@@ -9445,7 +9445,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9445
9445
|
* @param {*} [options] Override http request option.
|
|
9446
9446
|
* @throws {RequiredError}
|
|
9447
9447
|
*/
|
|
9448
|
-
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
9448
|
+
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9449
9449
|
/**
|
|
9450
9450
|
* Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
|
|
9451
9451
|
* @summary Delete Tool
|
|
@@ -9454,7 +9454,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9454
9454
|
* @param {*} [options] Override http request option.
|
|
9455
9455
|
* @throws {RequiredError}
|
|
9456
9456
|
*/
|
|
9457
|
-
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
9457
|
+
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9458
9458
|
/**
|
|
9459
9459
|
* 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.
|
|
9460
9460
|
* @summary Get Default Link Chain
|
|
@@ -9464,7 +9464,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9464
9464
|
* @deprecated
|
|
9465
9465
|
* @throws {RequiredError}
|
|
9466
9466
|
*/
|
|
9467
|
-
getDefaultLinkChain(cell: string, motionGroupModel: GetDefaultLinkChainMotionGroupModelEnum, options?: RawAxiosRequestConfig): Promise<
|
|
9467
|
+
getDefaultLinkChain(cell: string, motionGroupModel: GetDefaultLinkChainMotionGroupModelEnum, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9468
9468
|
[key: string]: Collider;
|
|
9469
9469
|
}[], any>>;
|
|
9470
9470
|
/**
|
|
@@ -9475,7 +9475,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9475
9475
|
* @param {*} [options] Override http request option.
|
|
9476
9476
|
* @throws {RequiredError}
|
|
9477
9477
|
*/
|
|
9478
|
-
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
9478
|
+
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
9479
9479
|
/**
|
|
9480
9480
|
* Returns the collision link chain.
|
|
9481
9481
|
* @summary Get Link Chain
|
|
@@ -9484,7 +9484,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9484
9484
|
* @param {*} [options] Override http request option.
|
|
9485
9485
|
* @throws {RequiredError}
|
|
9486
9486
|
*/
|
|
9487
|
-
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
9487
|
+
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9488
9488
|
[key: string]: Collider;
|
|
9489
9489
|
}[], any>>;
|
|
9490
9490
|
/**
|
|
@@ -9495,7 +9495,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9495
9495
|
* @param {*} [options] Override http request option.
|
|
9496
9496
|
* @throws {RequiredError}
|
|
9497
9497
|
*/
|
|
9498
|
-
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
9498
|
+
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9499
9499
|
[key: string]: Collider;
|
|
9500
9500
|
}, any>>;
|
|
9501
9501
|
/**
|
|
@@ -9505,7 +9505,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9505
9505
|
* @param {*} [options] Override http request option.
|
|
9506
9506
|
* @throws {RequiredError}
|
|
9507
9507
|
*/
|
|
9508
|
-
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9508
|
+
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9509
9509
|
[key: string]: {
|
|
9510
9510
|
[key: string]: Collider;
|
|
9511
9511
|
}[];
|
|
@@ -9517,7 +9517,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9517
9517
|
* @param {*} [options] Override http request option.
|
|
9518
9518
|
* @throws {RequiredError}
|
|
9519
9519
|
*/
|
|
9520
|
-
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9520
|
+
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9521
9521
|
[key: string]: Collider;
|
|
9522
9522
|
}, any>>;
|
|
9523
9523
|
/**
|
|
@@ -9527,7 +9527,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9527
9527
|
* @param {*} [options] Override http request option.
|
|
9528
9528
|
* @throws {RequiredError}
|
|
9529
9529
|
*/
|
|
9530
|
-
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9530
|
+
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9531
9531
|
[key: string]: {
|
|
9532
9532
|
[key: string]: Collider;
|
|
9533
9533
|
};
|
|
@@ -9541,7 +9541,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9541
9541
|
* @param {*} [options] Override http request option.
|
|
9542
9542
|
* @throws {RequiredError}
|
|
9543
9543
|
*/
|
|
9544
|
-
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<
|
|
9544
|
+
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
9545
9545
|
/**
|
|
9546
9546
|
* Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
|
|
9547
9547
|
* @summary Store Link Chain
|
|
@@ -9553,7 +9553,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9553
9553
|
*/
|
|
9554
9554
|
storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{
|
|
9555
9555
|
[key: string]: Collider;
|
|
9556
|
-
}>, options?: RawAxiosRequestConfig): Promise<
|
|
9556
|
+
}>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9557
9557
|
[key: string]: Collider;
|
|
9558
9558
|
}[], any>>;
|
|
9559
9559
|
/**
|
|
@@ -9567,7 +9567,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
9567
9567
|
*/
|
|
9568
9568
|
storeCollisionTool(cell: string, tool: string, requestBody: {
|
|
9569
9569
|
[key: string]: Collider;
|
|
9570
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
9570
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9571
9571
|
[key: string]: Collider;
|
|
9572
9572
|
}, any>>;
|
|
9573
9573
|
}
|
|
@@ -9882,7 +9882,7 @@ declare class StoreCollisionScenesApi extends BaseAPI {
|
|
|
9882
9882
|
* @param {*} [options] Override http request option.
|
|
9883
9883
|
* @throws {RequiredError}
|
|
9884
9884
|
*/
|
|
9885
|
-
deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<
|
|
9885
|
+
deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
9886
9886
|
/**
|
|
9887
9887
|
* Returns the stored scene.
|
|
9888
9888
|
* @summary Get Scene
|
|
@@ -9891,7 +9891,7 @@ declare class StoreCollisionScenesApi extends BaseAPI {
|
|
|
9891
9891
|
* @param {*} [options] Override http request option.
|
|
9892
9892
|
* @throws {RequiredError}
|
|
9893
9893
|
*/
|
|
9894
|
-
getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<
|
|
9894
|
+
getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionScene, any>>;
|
|
9895
9895
|
/**
|
|
9896
9896
|
* Returns a list of stored scenes.
|
|
9897
9897
|
* @summary List Scenes
|
|
@@ -9899,7 +9899,7 @@ declare class StoreCollisionScenesApi extends BaseAPI {
|
|
|
9899
9899
|
* @param {*} [options] Override http request option.
|
|
9900
9900
|
* @throws {RequiredError}
|
|
9901
9901
|
*/
|
|
9902
|
-
listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
9902
|
+
listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
9903
9903
|
[key: string]: CollisionScene;
|
|
9904
9904
|
}, any>>;
|
|
9905
9905
|
/**
|
|
@@ -9911,7 +9911,7 @@ declare class StoreCollisionScenesApi extends BaseAPI {
|
|
|
9911
9911
|
* @param {*} [options] Override http request option.
|
|
9912
9912
|
* @throws {RequiredError}
|
|
9913
9913
|
*/
|
|
9914
|
-
storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<
|
|
9914
|
+
storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionScene, any>>;
|
|
9915
9915
|
}
|
|
9916
9916
|
/**
|
|
9917
9917
|
* StoreObjectApi - axios parameter creator
|
|
@@ -10107,7 +10107,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
10107
10107
|
* @param {*} [options] Override http request option.
|
|
10108
10108
|
* @throws {RequiredError}
|
|
10109
10109
|
*/
|
|
10110
|
-
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
10110
|
+
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10111
10111
|
/**
|
|
10112
10112
|
* Delete an object <!-- theme: danger --> > This will delete persistently stored data.
|
|
10113
10113
|
* @summary Delete Object
|
|
@@ -10116,7 +10116,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
10116
10116
|
* @param {*} [options] Override http request option.
|
|
10117
10117
|
* @throws {RequiredError}
|
|
10118
10118
|
*/
|
|
10119
|
-
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
10119
|
+
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10120
10120
|
/**
|
|
10121
10121
|
* Get the object. This request returns the object and any metadata attached to it.
|
|
10122
10122
|
* @summary Get Object
|
|
@@ -10125,7 +10125,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
10125
10125
|
* @param {*} [options] Override http request option.
|
|
10126
10126
|
* @throws {RequiredError}
|
|
10127
10127
|
*/
|
|
10128
|
-
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
10128
|
+
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
10129
10129
|
/**
|
|
10130
10130
|
* Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
|
|
10131
10131
|
* @summary Get Object Metadata
|
|
@@ -10134,7 +10134,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
10134
10134
|
* @param {*} [options] Override http request option.
|
|
10135
10135
|
* @throws {RequiredError}
|
|
10136
10136
|
*/
|
|
10137
|
-
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
10137
|
+
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10138
10138
|
/**
|
|
10139
10139
|
* List the keys for all objects.
|
|
10140
10140
|
* @summary List all Object Keys
|
|
@@ -10142,7 +10142,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
10142
10142
|
* @param {*} [options] Override http request option.
|
|
10143
10143
|
* @throws {RequiredError}
|
|
10144
10144
|
*/
|
|
10145
|
-
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
10145
|
+
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
10146
10146
|
/**
|
|
10147
10147
|
* 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.
|
|
10148
10148
|
* @summary Store Object
|
|
@@ -10155,7 +10155,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
10155
10155
|
*/
|
|
10156
10156
|
storeObject(cell: string, key: string, xMetadata?: {
|
|
10157
10157
|
[key: string]: string;
|
|
10158
|
-
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<
|
|
10158
|
+
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10159
10159
|
}
|
|
10160
10160
|
/**
|
|
10161
10161
|
* SystemApi - axios parameter creator
|
|
@@ -10294,28 +10294,28 @@ declare class SystemApi extends BaseAPI {
|
|
|
10294
10294
|
* @param {*} [options] Override http request option.
|
|
10295
10295
|
* @throws {RequiredError}
|
|
10296
10296
|
*/
|
|
10297
|
-
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
10297
|
+
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
10298
10298
|
/**
|
|
10299
10299
|
* 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.
|
|
10300
10300
|
* @summary Download Diagnosis Package
|
|
10301
10301
|
* @param {*} [options] Override http request option.
|
|
10302
10302
|
* @throws {RequiredError}
|
|
10303
10303
|
*/
|
|
10304
|
-
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<
|
|
10304
|
+
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
10305
10305
|
/**
|
|
10306
10306
|
* Get the status of all system services.
|
|
10307
10307
|
* @summary Wandelbots NOVA status
|
|
10308
10308
|
* @param {*} [options] Override http request option.
|
|
10309
10309
|
* @throws {RequiredError}
|
|
10310
10310
|
*/
|
|
10311
|
-
getSystemStatus(options?: RawAxiosRequestConfig): Promise<
|
|
10311
|
+
getSystemStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatus[], any>>;
|
|
10312
10312
|
/**
|
|
10313
10313
|
* Get the current Wandelbots NOVA version.
|
|
10314
10314
|
* @summary Wandelbots NOVA Version
|
|
10315
10315
|
* @param {*} [options] Override http request option.
|
|
10316
10316
|
* @throws {RequiredError}
|
|
10317
10317
|
*/
|
|
10318
|
-
getSystemVersion(options?: RawAxiosRequestConfig): Promise<
|
|
10318
|
+
getSystemVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
10319
10319
|
/**
|
|
10320
10320
|
* 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.
|
|
10321
10321
|
* @summary Update Wandelbots NOVA version
|
|
@@ -10323,7 +10323,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
10323
10323
|
* @param {*} [options] Override http request option.
|
|
10324
10324
|
* @throws {RequiredError}
|
|
10325
10325
|
*/
|
|
10326
|
-
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10326
|
+
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
10327
10327
|
}
|
|
10328
10328
|
/**
|
|
10329
10329
|
* VersionApi - axios parameter creator
|
|
@@ -10371,7 +10371,7 @@ declare class VersionApi extends BaseAPI {
|
|
|
10371
10371
|
* @param {*} [options] Override http request option.
|
|
10372
10372
|
* @throws {RequiredError}
|
|
10373
10373
|
*/
|
|
10374
|
-
getApiVersion(options?: RawAxiosRequestConfig): Promise<
|
|
10374
|
+
getApiVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ApiVersion, any>>;
|
|
10375
10375
|
}
|
|
10376
10376
|
/**
|
|
10377
10377
|
* VirtualRobotApi - axios parameter creator
|
|
@@ -10587,7 +10587,7 @@ declare class VirtualRobotApi extends BaseAPI {
|
|
|
10587
10587
|
* @param {*} [options] Override http request option.
|
|
10588
10588
|
* @throws {RequiredError}
|
|
10589
10589
|
*/
|
|
10590
|
-
getMotionGroupState(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<
|
|
10590
|
+
getMotionGroupState(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupJoints, any>>;
|
|
10591
10591
|
/**
|
|
10592
10592
|
* Gets information on the motion group.
|
|
10593
10593
|
* @summary Motion Group Description
|
|
@@ -10596,7 +10596,7 @@ declare class VirtualRobotApi extends BaseAPI {
|
|
|
10596
10596
|
* @param {*} [options] Override http request option.
|
|
10597
10597
|
* @throws {RequiredError}
|
|
10598
10598
|
*/
|
|
10599
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10599
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfos, any>>;
|
|
10600
10600
|
/**
|
|
10601
10601
|
* Gets the description and value of a virtual controller I/O.
|
|
10602
10602
|
* @summary Get I/O
|
|
@@ -10606,7 +10606,7 @@ declare class VirtualRobotApi extends BaseAPI {
|
|
|
10606
10606
|
* @param {*} [options] Override http request option.
|
|
10607
10607
|
* @throws {RequiredError}
|
|
10608
10608
|
*/
|
|
10609
|
-
getVirtualRobotIOValue(cell: string, controller: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
10609
|
+
getVirtualRobotIOValue(cell: string, controller: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IO, any>>;
|
|
10610
10610
|
/**
|
|
10611
10611
|
* 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.
|
|
10612
10612
|
* @summary List Inputs/Outputs
|
|
@@ -10615,7 +10615,7 @@ declare class VirtualRobotApi extends BaseAPI {
|
|
|
10615
10615
|
* @param {*} [options] Override http request option.
|
|
10616
10616
|
* @throws {RequiredError}
|
|
10617
10617
|
*/
|
|
10618
|
-
listIOs(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10618
|
+
listIOs(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOs, any>>;
|
|
10619
10619
|
/**
|
|
10620
10620
|
* 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.
|
|
10621
10621
|
* @summary Set Motion Group State
|
|
@@ -10626,7 +10626,7 @@ declare class VirtualRobotApi extends BaseAPI {
|
|
|
10626
10626
|
* @param {*} [options] Override http request option.
|
|
10627
10627
|
* @throws {RequiredError}
|
|
10628
10628
|
*/
|
|
10629
|
-
setMotionGroupState(cell: string, controller: string, id: number, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<
|
|
10629
|
+
setMotionGroupState(cell: string, controller: string, id: number, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
|
|
10630
10630
|
/**
|
|
10631
10631
|
* Sets the value of a virtual controller I/O.
|
|
10632
10632
|
* @summary Set I/O
|
|
@@ -10639,7 +10639,7 @@ declare class VirtualRobotApi extends BaseAPI {
|
|
|
10639
10639
|
* @param {*} [options] Override http request option.
|
|
10640
10640
|
* @throws {RequiredError}
|
|
10641
10641
|
*/
|
|
10642
|
-
setVirtualRobotIOValue(cell: string, controller: string, io: string, bool?: boolean, integer?: string, _double?: number, options?: RawAxiosRequestConfig): Promise<
|
|
10642
|
+
setVirtualRobotIOValue(cell: string, controller: string, io: string, bool?: boolean, integer?: string, _double?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
|
|
10643
10643
|
}
|
|
10644
10644
|
/**
|
|
10645
10645
|
* VirtualRobotBehaviorApi - axios parameter creator
|
|
@@ -10762,7 +10762,7 @@ declare class VirtualRobotBehaviorApi extends BaseAPI {
|
|
|
10762
10762
|
* @param {*} [options] Override http request option.
|
|
10763
10763
|
* @throws {RequiredError}
|
|
10764
10764
|
*/
|
|
10765
|
-
externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<
|
|
10765
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamDatapoint: ExternalJointStreamDatapoint, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupJoints, any>>;
|
|
10766
10766
|
/**
|
|
10767
10767
|
* Get the current robot motion group behavior - please see the setter [setMotionGroupBehavior](setMotionGroupBehavior) and the enum for details.
|
|
10768
10768
|
* @summary Behavior
|
|
@@ -10772,7 +10772,7 @@ declare class VirtualRobotBehaviorApi extends BaseAPI {
|
|
|
10772
10772
|
* @param {*} [options] Override http request option.
|
|
10773
10773
|
* @throws {RequiredError}
|
|
10774
10774
|
*/
|
|
10775
|
-
getMotionGroupBehavior(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<
|
|
10775
|
+
getMotionGroupBehavior(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupBehaviorGetter, any>>;
|
|
10776
10776
|
/**
|
|
10777
10777
|
* Switch robot motion group behavior.
|
|
10778
10778
|
* @summary Switch Behavior
|
|
@@ -10783,7 +10783,7 @@ declare class VirtualRobotBehaviorApi extends BaseAPI {
|
|
|
10783
10783
|
* @param {*} [options] Override http request option.
|
|
10784
10784
|
* @throws {RequiredError}
|
|
10785
10785
|
*/
|
|
10786
|
-
setMotionGroupBehavior(cell: string, controller: string, id: number, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<
|
|
10786
|
+
setMotionGroupBehavior(cell: string, controller: string, id: number, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
|
|
10787
10787
|
}
|
|
10788
10788
|
/**
|
|
10789
10789
|
* VirtualRobotModeApi - axios parameter creator
|
|
@@ -10977,7 +10977,7 @@ declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
10977
10977
|
* @param {*} [options] Override http request option.
|
|
10978
10978
|
* @throws {RequiredError}
|
|
10979
10979
|
*/
|
|
10980
|
-
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10980
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
|
|
10981
10981
|
/**
|
|
10982
10982
|
* 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.
|
|
10983
10983
|
* @summary Get E-Stop State
|
|
@@ -10986,7 +10986,7 @@ declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
10986
10986
|
* @param {*} [options] Override http request option.
|
|
10987
10987
|
* @throws {RequiredError}
|
|
10988
10988
|
*/
|
|
10989
|
-
getEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10989
|
+
getEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Flag, any>>;
|
|
10990
10990
|
/**
|
|
10991
10991
|
* 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.
|
|
10992
10992
|
* @summary Get Operation Mode
|
|
@@ -10995,7 +10995,7 @@ declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
10995
10995
|
* @param {*} [options] Override http request option.
|
|
10996
10996
|
* @throws {RequiredError}
|
|
10997
10997
|
*/
|
|
10998
|
-
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10998
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<OpMode, any>>;
|
|
10999
10999
|
/**
|
|
11000
11000
|
* 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.
|
|
11001
11001
|
* @summary Push E-Stop
|
|
@@ -11004,7 +11004,7 @@ declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
11004
11004
|
* @param {*} [options] Override http request option.
|
|
11005
11005
|
* @throws {RequiredError}
|
|
11006
11006
|
*/
|
|
11007
|
-
pushEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
11007
|
+
pushEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
|
|
11008
11008
|
/**
|
|
11009
11009
|
* 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.
|
|
11010
11010
|
* @summary Release E-Stop
|
|
@@ -11013,7 +11013,7 @@ declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
11013
11013
|
* @param {*} [options] Override http request option.
|
|
11014
11014
|
* @throws {RequiredError}
|
|
11015
11015
|
*/
|
|
11016
|
-
releaseEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
11016
|
+
releaseEStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
|
|
11017
11017
|
/**
|
|
11018
11018
|
* 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.
|
|
11019
11019
|
* @summary Set Operation Mode
|
|
@@ -11023,7 +11023,7 @@ declare class VirtualRobotModeApi extends BaseAPI {
|
|
|
11023
11023
|
* @param {*} [options] Override http request option.
|
|
11024
11024
|
* @throws {RequiredError}
|
|
11025
11025
|
*/
|
|
11026
|
-
setOperationMode(cell: string, controller: string, mode: SetOperationModeModeEnum, options?: RawAxiosRequestConfig): Promise<
|
|
11026
|
+
setOperationMode(cell: string, controller: string, mode: SetOperationModeModeEnum, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
|
|
11027
11027
|
}
|
|
11028
11028
|
declare const SetOperationModeModeEnum: {
|
|
11029
11029
|
readonly OperationModeManual: "OPERATION_MODE_MANUAL";
|
|
@@ -11307,7 +11307,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
11307
11307
|
* @param {*} [options] Override http request option.
|
|
11308
11308
|
* @throws {RequiredError}
|
|
11309
11309
|
*/
|
|
11310
|
-
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
11310
|
+
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
|
|
11311
11311
|
/**
|
|
11312
11312
|
* 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.
|
|
11313
11313
|
* @summary Add TCP
|
|
@@ -11318,7 +11318,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
11318
11318
|
* @param {*} [options] Override http request option.
|
|
11319
11319
|
* @throws {RequiredError}
|
|
11320
11320
|
*/
|
|
11321
|
-
addVirtualRobotTcp(cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<
|
|
11321
|
+
addVirtualRobotTcp(cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
|
|
11322
11322
|
/**
|
|
11323
11323
|
* 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.
|
|
11324
11324
|
* @summary Remove Coordinate System
|
|
@@ -11329,7 +11329,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
11329
11329
|
* @param {*} [options] Override http request option.
|
|
11330
11330
|
* @throws {RequiredError}
|
|
11331
11331
|
*/
|
|
11332
|
-
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
11332
|
+
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
|
|
11333
11333
|
/**
|
|
11334
11334
|
* 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.
|
|
11335
11335
|
* @summary Remove TCP
|
|
@@ -11340,7 +11340,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
11340
11340
|
* @param {*} [options] Override http request option.
|
|
11341
11341
|
* @throws {RequiredError}
|
|
11342
11342
|
*/
|
|
11343
|
-
deleteVirtualRobotTcp(cell: string, controller: string, id: number, tcp: string, options?: RawAxiosRequestConfig): Promise<
|
|
11343
|
+
deleteVirtualRobotTcp(cell: string, controller: string, id: number, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<object, any>>;
|
|
11344
11344
|
/**
|
|
11345
11345
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
11346
11346
|
* @summary Get Mounting
|
|
@@ -11350,7 +11350,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
11350
11350
|
* @param {*} [options] Override http request option.
|
|
11351
11351
|
* @throws {RequiredError}
|
|
11352
11352
|
*/
|
|
11353
|
-
getVirtualRobotMounting(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<
|
|
11353
|
+
getVirtualRobotMounting(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
11354
11354
|
/**
|
|
11355
11355
|
* Lists all coordinate systems on the robot controller.
|
|
11356
11356
|
* @summary List Coordinate Systems
|
|
@@ -11359,7 +11359,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
11359
11359
|
* @param {*} [options] Override http request option.
|
|
11360
11360
|
* @throws {RequiredError}
|
|
11361
11361
|
*/
|
|
11362
|
-
listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
11362
|
+
listVirtualRobotCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystems, any>>;
|
|
11363
11363
|
/**
|
|
11364
11364
|
* Lists TCPs of the motion group. An empty TCP list is valid, for example for external axes.
|
|
11365
11365
|
* @summary List TCPs
|
|
@@ -11369,7 +11369,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
11369
11369
|
* @param {*} [options] Override http request option.
|
|
11370
11370
|
* @throws {RequiredError}
|
|
11371
11371
|
*/
|
|
11372
|
-
listVirtualRobotTcps(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<
|
|
11372
|
+
listVirtualRobotTcps(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcps, any>>;
|
|
11373
11373
|
/**
|
|
11374
11374
|
* 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.
|
|
11375
11375
|
* @summary Set Mounting
|
|
@@ -11380,7 +11380,7 @@ declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
11380
11380
|
* @param {*} [options] Override http request option.
|
|
11381
11381
|
* @throws {RequiredError}
|
|
11382
11382
|
*/
|
|
11383
|
-
setVirtualRobotMounting(cell: string, controller: string, id: number, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
11383
|
+
setVirtualRobotMounting(cell: string, controller: string, id: number, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
11384
11384
|
}
|
|
11385
11385
|
//#endregion
|
|
11386
11386
|
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, 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 };
|