@wandelbots/nova-js
Version:
Official JS client for the Wandelbots API
982 lines (981 loc) • 563 kB
JavaScript
import { i as guardedPageReload, n as loginWithAuth0, o as availableStorage, s as AutoReconnectingWebsocket } from "../LoginWithAuth0-D92HnzHq.mjs";
import { a as parseNovaInstanceUrl } from "../converters-DnG1fX23.mjs";
import globalAxios, { AxiosError, isAxiosError } from "axios";
import * as pathToRegexp from "path-to-regexp";
//#region node_modules/.pnpm/@wandelbots+nova-api@26.5.1/node_modules/@wandelbots/nova-api/dist/defineProperty-6Ts4XR6h.js
function _typeof(o) {
"@babel/helpers - typeof";
return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
return typeof o;
} : function(o) {
return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o;
}, _typeof(o);
}
function toPrimitive(t, r) {
if ("object" != _typeof(t) || !t) return t;
var e = t[Symbol.toPrimitive];
if (void 0 !== e) {
var i = e.call(t, r || "default");
if ("object" != _typeof(i)) return i;
throw new TypeError("@@toPrimitive must return a primitive value.");
}
return ("string" === r ? String : Number)(t);
}
function toPropertyKey(t) {
var i = toPrimitive(t, "string");
return "symbol" == _typeof(i) ? i : i + "";
}
function _defineProperty(e, r, t) {
return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
value: t,
enumerable: !0,
configurable: !0,
writable: !0
}) : e[r] = t, e;
}
//#endregion
//#region node_modules/.pnpm/@wandelbots+nova-api@26.5.1/node_modules/@wandelbots/nova-api/dist/v2/index.js
const BASE_PATH = "/api/v2".replace(/\/+$/, "");
const COLLECTION_FORMATS = {
csv: ",",
ssv: " ",
tsv: " ",
pipes: "|"
};
var BaseAPI = class {
constructor(configuration, basePath = BASE_PATH, axios = globalAxios) {
this.basePath = basePath;
this.axios = axios;
_defineProperty(this, "configuration", void 0);
if (configuration) {
this.configuration = configuration;
this.basePath = configuration.basePath ?? basePath;
}
}
};
var RequiredError = class extends Error {
constructor(field, msg) {
super(msg);
this.field = field;
this.name = "RequiredError";
}
};
const operationServerMap = {};
const DUMMY_BASE_URL = "https://example.com";
/**
*
* @throws {RequiredError}
*/
const assertParamExists = function(functionName, paramName, paramValue) {
if (paramValue === null || paramValue === void 0) throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
};
const setBearerAuthToObject = async function(object, configuration) {
if (configuration && configuration.accessToken) object["Authorization"] = "Bearer " + (typeof configuration.accessToken === "function" ? await configuration.accessToken() : await configuration.accessToken);
};
function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
if (parameter == null) return;
if (typeof parameter === "object") if (Array.isArray(parameter)) parameter.forEach((item) => setFlattenedQueryParams(urlSearchParams, item, key));
else Object.keys(parameter).forEach((currentKey) => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== "" ? "." : ""}${currentKey}`));
else if (urlSearchParams.has(key)) urlSearchParams.append(key, parameter);
else urlSearchParams.set(key, parameter);
}
const setSearchParams = function(url, ...objects) {
const searchParams = new URLSearchParams(url.search);
setFlattenedQueryParams(searchParams, objects);
url.search = searchParams.toString();
};
const serializeDataIfNeeded = function(value, requestOptions, configuration) {
const nonString = typeof value !== "string";
return (nonString && configuration && configuration.isJsonMime ? configuration.isJsonMime(requestOptions.headers["Content-Type"]) : nonString) ? JSON.stringify(value !== void 0 ? value : {}) : value || "";
};
const toPathString = function(url) {
return url.pathname + url.search + url.hash;
};
const createRequestFunction = function(axiosArgs, globalAxios, BASE_PATH, configuration) {
return (axios = globalAxios, basePath = BASE_PATH) => {
const axiosRequestArgs = {
...axiosArgs.options,
url: (axios.defaults.baseURL ? "" : configuration?.basePath ?? basePath) + axiosArgs.url
};
return axios.request(axiosRequestArgs);
};
};
const AbbControllerKindEnum = { AbbController: "AbbController" };
/**
* ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion groups of the controller take commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g., with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that, the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](#/operations/externalJointsStream).
*/
const Behavior = {
BehaviorAutomatic: "BEHAVIOR_AUTOMATIC",
BehaviorAutomaticNotComplyWithCycletime: "BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME",
BehaviorExternalSource: "BEHAVIOR_EXTERNAL_SOURCE"
};
const BlendingAutoBlendingNameEnum = { BlendingAuto: "BlendingAuto" };
const BlendingPositionBlendingNameEnum = { BlendingPosition: "BlendingPosition" };
/**
* Defines the space in which blending is performed. - `JOINT`: Zone blending is performed in joint space - `CARTESIAN`: Auto-blending is performed in cartesian space
*/
const BlendingSpace = {
Joint: "JOINT",
Cartesian: "CARTESIAN"
};
const BooleanValueValueTypeEnum = { Boolean: "boolean" };
const BoxShapeTypeEnum = { Box: "box" };
const BoxBoxTypeEnum = {
Hollow: "HOLLOW",
Full: "FULL"
};
const BusIOModbusClientBusTypeEnum = { ModbusClient: "modbus_client" };
const BusIOModbusServerBusTypeEnum = { ModbusServer: "modbus_server" };
const BusIOModbusTCPClientNetworkTypeEnum = { Tcp: "tcp" };
const BusIOModbusTCPServerNetworkTypeEnum = { Tcp: "tcp" };
const BusIOModbusVirtualBusTypeEnum = { ModbusVirtual: "modbus_virtual" };
const BusIOProfinetBusTypeEnum = { Profinet: "profinet" };
const BusIOProfinetVirtualBusTypeEnum = { ProfinetVirtual: "profinet_virtual" };
const BusIOSnap7BusTypeEnum = { Snap7: "snap7" };
/**
* Current state of the BUS input/output service.
*/
const BusIOsStateEnum = {
BusIosStateUnknown: "BUS_IOS_STATE_UNKNOWN",
BusIosStateInitializing: "BUS_IOS_STATE_INITIALIZING",
BusIosStateConnected: "BUS_IOS_STATE_CONNECTED",
BusIosStateDisconnected: "BUS_IOS_STATE_DISCONNECTED"
};
const CapsuleShapeTypeEnum = { Capsule: "capsule" };
const CloudConfigStatusConfiguredStatusEnum = { Configured: "configured" };
const CloudConfigStatusNotConfiguredStatusEnum = { NotConfigured: "not_configured" };
const CloudConnectionErrorInvalidTokenCodeEnum = { InvalidCloudToken: "invalid_cloud_token" };
const CloudConnectionErrorLeafnodeConnectionErrorCodeEnum = { LeafnodeConnectionError: "leafnode_connection_error" };
const CloudConnectionErrorLeafnodeConnectionTimeoutCodeEnum = { LeafnodeConnectionTimeout: "leafnode_connection_timeout" };
const CloudConnectionErrorLeafnodeRestartTimeoutCodeEnum = { LeafnodeRestartTimeout: "leafnode_restart_timeout" };
const CloudConnectionErrorNatsFailedCodeEnum = { NatsConnectionFailed: "nats_connection_failed" };
const CloudConnectionErrorUnexpectedResponseCodeEnum = { UnexpectedCloudResponse: "unexpected_cloud_response" };
const CloudDisconnectionStatusDisconnectedStatusEnum = { Disconnected: "disconnected" };
const CloudDisconnectionStatusDisconnectingStatusEnum = { Disconnecting: "disconnecting" };
const ColliderValueSourceEnum = { Value: "value" };
const CollisionErrorKindEnum = { CollisionError: "CollisionError" };
const CollisionSetupValueSourceEnum = { Value: "value" };
/**
* Comparator for the comparison of two values. The comparator is used to compare two values and return a boolean result. The default comparator is unknown.
*/
const Comparator = {
ComparatorEquals: "COMPARATOR_EQUALS",
ComparatorNotEquals: "COMPARATOR_NOT_EQUALS",
ComparatorGreater: "COMPARATOR_GREATER",
ComparatorGreaterEqual: "COMPARATOR_GREATER_EQUAL",
ComparatorLess: "COMPARATOR_LESS",
ComparatorLessEqual: "COMPARATOR_LESS_EQUAL"
};
const ConfigurationArchiveStatusCreatingStatusEnum = { Creating: "creating" };
const ConfigurationArchiveStatusErrorStatusEnum = { Error: "error" };
const ConfigurationArchiveStatusSuccessStatusEnum = { Success: "success" };
const ConvexHullShapeTypeEnum = { ConvexHull: "convex_hull" };
const CylinderShapeTypeEnum = { Cylinder: "cylinder" };
/**
* The direction in which the trajectory is executed. Default: Forward.
*/
const Direction = {
DirectionForward: "DIRECTION_FORWARD",
DirectionBackward: "DIRECTION_BACKWARD"
};
const DirectionConstraintConstraintNameEnum = { DirectionConstraint: "DirectionConstraint" };
const ErrorDirectionConstraintNotMetErrorFeedbackNameEnum = { ErrorDirectionConstraintNotMet: "ErrorDirectionConstraintNotMet" };
const ErrorDirectionConstraintNotNormalizedErrorFeedbackNameEnum = { ErrorDirectionConstraintNotNormalized: "ErrorDirectionConstraintNotNormalized" };
const ErrorInvalidJointCountErrorFeedbackNameEnum = { ErrorInvalidJointCount: "ErrorInvalidJointCount" };
const ErrorJointLimitExceededErrorFeedbackNameEnum = { ErrorJointLimitExceeded: "ErrorJointLimitExceeded" };
const ErrorJointPositionCollisionErrorFeedbackNameEnum = { ErrorJointPositionCollision: "ErrorJointPositionCollision" };
const ErrorMaxIterationsExceededErrorFeedbackNameEnum = { ErrorMaxIterationsExceeded: "ErrorMaxIterationsExceeded" };
const ErrorUnsupportedOperationErrorFeedbackNameEnum = { ErrorUnsupportedOperation: "ErrorUnsupportedOperation" };
const FanucControllerKindEnum = { FanucController: "FanucController" };
const FeedbackAxisRangeExceededErrorFeedbackNameEnum = { FeedbackAxisRangeExceeded: "FeedbackAxisRangeExceeded" };
const FeedbackCollisionErrorFeedbackNameEnum = { FeedbackCollision: "FeedbackCollision" };
const FeedbackCommandsMissingErrorFeedbackNameEnum = { FeedbackCommandsMissing: "FeedbackCommandsMissing" };
const FeedbackCubicSplineIsNotIncreasingErrorFeedbackNameEnum = { FeedbackCubicSplineIsNotIncreasing: "FeedbackCubicSplineIsNotIncreasing" };
const FeedbackCubicSplineNotAtStartPoseErrorFeedbackNameEnum = { FeedbackCubicSplineNotAtStartPose: "FeedbackCubicSplineNotAtStartPose" };
const FeedbackDirectionConstraintNoSolutionExistsErrorFeedbackNameEnum = { FeedbackDirectionConstraintNoSolutionExists: "FeedbackDirectionConstraintNoSolutionExists" };
const FeedbackDirectionConstraintNotMetErrorFeedbackNameEnum = { FeedbackDirectionConstraintNotMet: "FeedbackDirectionConstraintNotMet" };
const FeedbackDirectionConstraintNotNormalizedErrorFeedbackNameEnum = { FeedbackDirectionConstraintNotNormalized: "FeedbackDirectionConstraintNotNormalized" };
const FeedbackInvalidDofErrorFeedbackNameEnum = { FeedbackInvalidDof: "FeedbackInvalidDof" };
const FeedbackInvalidNanValueErrorFeedbackNameEnum = { FeedbackInvalidNanValue: "FeedbackInvalidNanValue" };
const FeedbackInvalidSamplingTimeErrorFeedbackNameEnum = { FeedbackInvalidSamplingTime: "FeedbackInvalidSamplingTime" };
const FeedbackJointLimitExceededErrorFeedbackNameEnum = { FeedbackJointLimitExceeded: "FeedbackJointLimitExceeded" };
const FeedbackNoSolutionInCurrentConfigurationErrorFeedbackNameEnum = { FeedbackNoSolutionInCurrentConfiguration: "FeedbackNoSolutionInCurrentConfiguration" };
const FeedbackOutOfWorkspaceErrorFeedbackNameEnum = { FeedbackOutOfWorkspace: "FeedbackOutOfWorkspace" };
const FeedbackSingularityErrorFeedbackNameEnum = { FeedbackSingularity: "FeedbackSingularity" };
const FeedbackStartJointsMissingErrorFeedbackNameEnum = { FeedbackStartJointsMissing: "FeedbackStartJointsMissing" };
const FeedbackTorqueExceededErrorFeedbackNameEnum = { FeedbackTorqueExceeded: "FeedbackTorqueExceeded" };
const FloatValueValueTypeEnum = { Float: "float" };
const IOBooleanValueValueTypeEnum = { Boolean: "boolean" };
/**
* Identifies the input/output type.
*/
const IODirection = {
IoTypeInput: "IO_TYPE_INPUT",
IoTypeOutput: "IO_TYPE_OUTPUT"
};
const IOFloatValueValueTypeEnum = { Float: "float" };
const IOIntegerValueValueTypeEnum = { Integer: "integer" };
/**
* States the source of the input/output signal.
*/
const IOOrigin = {
Controller: "CONTROLLER",
BusIo: "BUS_IO"
};
/**
* Data type of the input/output.
*/
const IOValueType = {
IoValueBoolean: "IO_VALUE_BOOLEAN",
IoValueAnalogFloat: "IO_VALUE_ANALOG_FLOAT",
IoValueAnalogInteger: "IO_VALUE_ANALOG_INTEGER"
};
const InconsistentTrajectorySizeErrorKindEnum = { InconsistentTrajectorySizeError: "InconsistentTrajectorySizeError" };
const InitializeJoggingRequestMessageTypeEnum = { InitializeJoggingRequest: "InitializeJoggingRequest" };
const InitializeJoggingResponseKindEnum = { InitializeReceived: "INITIALIZE_RECEIVED" };
const InitializeMovementRequestMessageTypeEnum = { InitializeMovementRequest: "InitializeMovementRequest" };
const InitializeMovementResponseKindEnum = { InitializeReceived: "INITIALIZE_RECEIVED" };
const IntegerValueValueTypeEnum = { Integer: "integer" };
const InvalidDofErrorKindEnum = { InvalidDofError: "InvalidDofError" };
const JoggingDetailsKindEnum = { Jogging: "JOGGING" };
const JoggingPausedByUserKindEnum = { PausedByUser: "PAUSED_BY_USER" };
const JoggingPausedNearCollisionKindEnum = { PausedNearCollision: "PAUSED_NEAR_COLLISION" };
const JoggingPausedNearJointLimitKindEnum = { PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT" };
const JoggingPausedNearSingularityKindEnum = { PausedNearSingularity: "PAUSED_NEAR_SINGULARITY" };
const JoggingPausedOnIOKindEnum = { PausedOnIo: "PAUSED_ON_IO" };
const JoggingRunningKindEnum = { Running: "RUNNING" };
const JointLimitExceededErrorKindEnum = { JointLimitExceededError: "JointLimitExceededError" };
const JointTypeEnum = {
RevoluteJoint: "REVOLUTE_JOINT",
PrismaticJoint: "PRISMATIC_JOINT"
};
const JointVelocityRequestMessageTypeEnum = { JointVelocityRequest: "JointVelocityRequest" };
const JointVelocityResponseKindEnum = { JointVelocityReceived: "JOINT_VELOCITY_RECEIVED" };
const JointWaypointsRequestMessageTypeEnum = { JointWaypointsRequest: "JointWaypointsRequest" };
const JointWaypointsResponseKindEnum = { JointWaypointsReceived: "JOINT_WAYPOINTS_RECEIVED" };
const KinematicBranchElbow = {
Up: "UP",
Down: "DOWN"
};
const KinematicBranchShoulder = {
Front: "FRONT",
Back: "BACK"
};
const KinematicBranchWrist = {
Flip: "FLIP",
NoFlip: "NO_FLIP"
};
const KukaControllerKindEnum = { KukaController: "KukaController" };
const LicenseStatusEnum = {
Ok: "OK",
Expired: "EXPIRED",
Suspended: "SUSPENDED",
GracePeriodOver: "GRACE_PERIOD_OVER",
NotFound: "NOT_FOUND"
};
const LinkChainValueSourceEnum = { Value: "value" };
const Manufacturer = {
Abb: "abb",
Fanuc: "fanuc",
Kuka: "kuka",
Staubli: "staubli",
Universalrobots: "universalrobots",
Yaskawa: "yaskawa"
};
const MidpointInsertionAlgorithmAlgorithmNameEnum = { MidpointInsertionAlgorithm: "MidpointInsertionAlgorithm" };
/**
* Area of the MODBUS input/output variable. Is used to interpret the corresponding bits correctly.
*/
const ModbusIOArea = {
ModbusIoAreaUnknown: "MODBUS_IO_AREA_UNKNOWN",
ModbusIoAreaCoils: "MODBUS_IO_AREA_COILS",
ModbusIoAreaDiscreteInputs: "MODBUS_IO_AREA_DISCRETE_INPUTS",
ModbusIoAreaHoldingRegisters: "MODBUS_IO_AREA_HOLDING_REGISTERS",
ModbusIoAreaInputRegisters: "MODBUS_IO_AREA_INPUT_REGISTERS"
};
/**
* Byte order of the MODBUS input/output variable. Used to interpret the corresponding bits correctly.
*/
const ModbusIOByteOrder = {
ModbusIoByteOrderUnknown: "MODBUS_IO_BYTE_ORDER_UNKNOWN",
ModbusIoByteOrderAbcd: "MODBUS_IO_BYTE_ORDER_ABCD",
ModbusIoByteOrderBadc: "MODBUS_IO_BYTE_ORDER_BADC",
ModbusIoByteOrderCdab: "MODBUS_IO_BYTE_ORDER_CDAB",
ModbusIoByteOrderDcba: "MODBUS_IO_BYTE_ORDER_DCBA"
};
/**
* Value type of the MODBUS input/output variable. Used to interpret the corresponding bits correctly.
*/
const ModbusIOTypeEnum = {
ModbusIoTypeUnknown: "MODBUS_IO_TYPE_UNKNOWN",
ModbusIoTypeBool: "MODBUS_IO_TYPE_BOOL",
ModbusIoTypeUint16: "MODBUS_IO_TYPE_UINT16",
ModbusIoTypeFloat32: "MODBUS_IO_TYPE_FLOAT32"
};
const MovementErrorResponseKindEnum = { MotionError: "MOTION_ERROR" };
const NanValueErrorKindEnum = { NanValueError: "NanValueError" };
const NetworkStateConnectionTypeEnum = {
Ethernet: "ethernet",
Wifi: "wifi",
Cellular: "cellular",
Vpn: "vpn",
Unknown: "unknown"
};
/**
* The operating state.
*/
const OperatingState = {
Active: "ACTIVE",
Inactive: "INACTIVE"
};
/**
* Current operation mode of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - OPERATION_MODE_MANUAL (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T1 (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T2 (if enabling switch is pressed) - OPERATION_MODE_AUTO (without needing to press enabling switch) All other modes are considered as non-operational.
*/
const OperationMode = {
OperationModeUnknown: "OPERATION_MODE_UNKNOWN",
OperationModeNoController: "OPERATION_MODE_NO_CONTROLLER",
OperationModeDisconnected: "OPERATION_MODE_DISCONNECTED",
OperationModePowerOn: "OPERATION_MODE_POWER_ON",
OperationModePending: "OPERATION_MODE_PENDING",
OperationModeManual: "OPERATION_MODE_MANUAL",
OperationModeManualT1: "OPERATION_MODE_MANUAL_T1",
OperationModeManualT2: "OPERATION_MODE_MANUAL_T2",
OperationModeAuto: "OPERATION_MODE_AUTO",
OperationModeRecovery: "OPERATION_MODE_RECOVERY"
};
/**
* The type of rotation description that is used to specify the orientation. **Rotation Vector notation** * The rotation is represented using an axis-angle representation: > axis = Vector[0:2] > angle = |axis| in [rad] > axis.normalized * angle **Quaternion notation** * The rotation is represented using a unit quaternion: [x, y, z, w]. * The vector part [x, y, z] is the imaginary part of the quaternion, and the scalar part [w] is the real part. **Euler notation** * *extrinsic* fixed external reference system * *intrinsic* reference system fixed to rotation body > angles = Vector[0:2] in [rad]. * ZYX, ZXZ,... - mapping of the given angles values to the (either intrinsic or extrinsic) axes in the stated order. > Example ZYX: Z = Vector[0], Y = Vector[1], X = Vector[2].
*/
const OrientationType = {
RotationVector: "ROTATION_VECTOR",
Quaternion: "QUATERNION",
EulerAnglesIntrinsicZxz: "EULER_ANGLES_INTRINSIC_ZXZ",
EulerAnglesIntrinsicXyx: "EULER_ANGLES_INTRINSIC_XYX",
EulerAnglesIntrinsicYzy: "EULER_ANGLES_INTRINSIC_YZY",
EulerAnglesIntrinsicZyz: "EULER_ANGLES_INTRINSIC_ZYZ",
EulerAnglesIntrinsicXzx: "EULER_ANGLES_INTRINSIC_XZX",
EulerAnglesIntrinsicYxy: "EULER_ANGLES_INTRINSIC_YXY",
EulerAnglesIntrinsicXyz: "EULER_ANGLES_INTRINSIC_XYZ",
EulerAnglesIntrinsicYzx: "EULER_ANGLES_INTRINSIC_YZX",
EulerAnglesIntrinsicZxy: "EULER_ANGLES_INTRINSIC_ZXY",
EulerAnglesIntrinsicXzy: "EULER_ANGLES_INTRINSIC_XZY",
EulerAnglesIntrinsicZyx: "EULER_ANGLES_INTRINSIC_ZYX",
EulerAnglesIntrinsicYxz: "EULER_ANGLES_INTRINSIC_YXZ",
EulerAnglesExtrinsicZxz: "EULER_ANGLES_EXTRINSIC_ZXZ",
EulerAnglesExtrinsicXyx: "EULER_ANGLES_EXTRINSIC_XYX",
EulerAnglesExtrinsicYzy: "EULER_ANGLES_EXTRINSIC_YZY",
EulerAnglesExtrinsicZyz: "EULER_ANGLES_EXTRINSIC_ZYZ",
EulerAnglesExtrinsicXzx: "EULER_ANGLES_EXTRINSIC_XZX",
EulerAnglesExtrinsicYxy: "EULER_ANGLES_EXTRINSIC_YXY",
EulerAnglesExtrinsicZyx: "EULER_ANGLES_EXTRINSIC_ZYX",
EulerAnglesExtrinsicXzy: "EULER_ANGLES_EXTRINSIC_XZY",
EulerAnglesExtrinsicYxz: "EULER_ANGLES_EXTRINSIC_YXZ",
EulerAnglesExtrinsicYzx: "EULER_ANGLES_EXTRINSIC_YZX",
EulerAnglesExtrinsicXyz: "EULER_ANGLES_EXTRINSIC_XYZ",
EulerAnglesExtrinsicZxy: "EULER_ANGLES_EXTRINSIC_ZXY"
};
const PathCartesianPTPPathDefinitionNameEnum = { PathCartesianPtp: "PathCartesianPTP" };
const PathCirclePathDefinitionNameEnum = { PathCircle: "PathCircle" };
const PathCubicSplinePathDefinitionNameEnum = { PathCubicSpline: "PathCubicSpline" };
const PathDirectionConstrainedCartesianPTPPathDefinitionNameEnum = { DirectionConstrainedCartesianPtp: "DirectionConstrainedCartesianPTP" };
const PathDirectionConstrainedJointPTPPathDefinitionNameEnum = { DirectionConstrainedJointPtp: "DirectionConstrainedJointPTP" };
const PathJointPTPPathDefinitionNameEnum = { PathJointPtp: "PathJointPTP" };
const PathLinePathDefinitionNameEnum = { PathLine: "PathLine" };
const PauseJoggingRequestMessageTypeEnum = { PauseJoggingRequest: "PauseJoggingRequest" };
const PauseJoggingResponseKindEnum = { PauseReceived: "PAUSE_RECEIVED" };
const PauseMovementRequestMessageTypeEnum = { PauseMovementRequest: "PauseMovementRequest" };
const PauseMovementResponseKindEnum = { PauseReceived: "PAUSE_RECEIVED" };
const PlaneShapeTypeEnum = { Plane: "plane" };
const PlaybackSpeedRequestMessageTypeEnum = { PlaybackSpeedRequest: "PlaybackSpeedRequest" };
const PlaybackSpeedResponseKindEnum = { PlaybackSpeedReceived: "PLAYBACK_SPEED_RECEIVED" };
const PoseWaypointsRequestMessageTypeEnum = { PoseWaypointsRequest: "PoseWaypointsRequest" };
const PoseWaypointsResponseKindEnum = { PoseWaypointsReceived: "POSE_WAYPOINTS_RECEIVED" };
/**
* The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g., NOVA\'s PROFINET service.
*/
const ProfinetIODirection = {
ProfinetIoDirectionInput: "PROFINET_IO_DIRECTION_INPUT",
ProfinetIoDirectionOutput: "PROFINET_IO_DIRECTION_OUTPUT",
ProfinetIoDirectionInout: "PROFINET_IO_DIRECTION_INOUT"
};
/**
* Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
*/
const ProfinetIOTypeEnum = {
ProfinetIoTypeUnknown: "PROFINET_IO_TYPE_UNKNOWN",
ProfinetIoTypeBool: "PROFINET_IO_TYPE_BOOL",
ProfinetIoTypeUsint: "PROFINET_IO_TYPE_USINT",
ProfinetIoTypeSint: "PROFINET_IO_TYPE_SINT",
ProfinetIoTypeUint: "PROFINET_IO_TYPE_UINT",
ProfinetIoTypeInt: "PROFINET_IO_TYPE_INT",
ProfinetIoTypeUdint: "PROFINET_IO_TYPE_UDINT",
ProfinetIoTypeDint: "PROFINET_IO_TYPE_DINT",
ProfinetIoTypeReal: "PROFINET_IO_TYPE_REAL",
ProfinetIoTypeLreal: "PROFINET_IO_TYPE_LREAL"
};
/**
* The state of a program run.
*/
const ProgramRunState = {
Preparing: "PREPARING",
Running: "RUNNING",
Completed: "COMPLETED",
Failed: "FAILED",
Stopped: "STOPPED"
};
const RRTConnectAlgorithmAlgorithmNameEnum = { RrtConnectAlgorithm: "RRTConnectAlgorithm" };
const RectangleShapeTypeEnum = { Rectangle: "rectangle" };
const RectangularCapsuleShapeTypeEnum = { RectangularCapsule: "rectangular_capsule" };
/**
* The channel that defines what a new Wandelbots NOVA version is. * `next` the latest version * `stable` newest patch of the current version
*/
const ReleaseChannel = {
Stable: "stable",
Next: "next"
};
/**
* Defines the current system mode of the robot system, including NOVA communicating with the robot controller. ### MODE_CONTROLLER_NOT_CONFIGURED No controller with the specified identifier is configured. Call [addRobotController](#/operations/addRobotController) to register a controller. ### MODE_INITIALIZING Indicates that a connection to the robot controller is established or reestablished in case of a disconnect. On success, the controller is set to MODE_MONITOR. On failure, the initialization process is retried until successful or cancelled by the user. ### MODE_MONITOR Read-only mode with an active controller connection. - Receives robot state and I/O signals - Move requests are rejected - No commands are sent to the controller ### MODE_CONTROL Active control mode. **Movement is possible in this mode** The robot is cyclically commanded to hold its current position. The robot state is received in sync with the controller cycle. Motion and jogging requests are accepted and executed. Input/Output interaction is enabled. ### MODE_FREE_DRIVE Read-only mode with servo motors enabled for manual movement (Free Drive). Move requests are rejected. Not supported by all robots: Use [getSupportedModes](#/operations/getSupportedModes) to check Free Drive availability.
*/
const RobotSystemMode = {
ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED",
ModeInitializing: "MODE_INITIALIZING",
ModeMonitor: "MODE_MONITOR",
ModeControl: "MODE_CONTROL",
ModeFreeDrive: "MODE_FREE_DRIVE"
};
/**
* Current safety state of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - SAFETY_STATE_NORMAL - SAFETY_STATE_REDUCED All other modes are considered as non-operational.
*/
const SafetyStateType = {
SafetyStateUnknown: "SAFETY_STATE_UNKNOWN",
SafetyStateFault: "SAFETY_STATE_FAULT",
SafetyStateNormal: "SAFETY_STATE_NORMAL",
SafetyStateMastering: "SAFETY_STATE_MASTERING",
SafetyStateConfirmSafety: "SAFETY_STATE_CONFIRM_SAFETY",
SafetyStateOperatorSafety: "SAFETY_STATE_OPERATOR_SAFETY",
SafetyStateProtectiveStop: "SAFETY_STATE_PROTECTIVE_STOP",
SafetyStateReduced: "SAFETY_STATE_REDUCED",
SafetyStateStop: "SAFETY_STATE_STOP",
SafetyStateStop0: "SAFETY_STATE_STOP_0",
SafetyStateStop1: "SAFETY_STATE_STOP_1",
SafetyStateStop2: "SAFETY_STATE_STOP_2",
SafetyStateRecovery: "SAFETY_STATE_RECOVERY",
SafetyStateDeviceEmergencyStop: "SAFETY_STATE_DEVICE_EMERGENCY_STOP",
SafetyStateRobotEmergencyStop: "SAFETY_STATE_ROBOT_EMERGENCY_STOP",
SafetyStateViolation: "SAFETY_STATE_VIOLATION"
};
const ServiceGroup = {
SystemService: "SystemService",
CellService: "CellService",
RobotController: "RobotController",
App: "App"
};
const ServiceStatusPhase = {
Terminating: "Terminating",
Initialized: "Initialized",
Running: "Running",
NoReady: "NoReady",
Completed: "Completed",
ContainerCreating: "ContainerCreating",
PodInitializing: "PodInitializing",
Unknown: "Unknown",
CrashLoopBackOff: "CrashLoopBackOff",
Error: "Error",
ImagePullBackOff: "ImagePullBackOff",
OomKilled: "OOMKilled",
Pending: "Pending",
Evicted: "Evicted"
};
const ServiceStatusSeverity = {
Info: "INFO",
Warning: "WARNING",
Error: "ERROR"
};
/**
* Defines available system modes of the robot system. Short versions (no \"ROBOT_SYSTEM_\" prefix) are provided, reusing strings from [getMode](#/operations/getMode) responses.
*/
const SettableRobotSystemMode = {
RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR",
ModeMonitor: "MODE_MONITOR",
RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL",
ModeControl: "MODE_CONTROL"
};
const SingularityTypeEnum = {
Wrist: "WRIST",
Elbow: "ELBOW",
Shoulder: "SHOULDER"
};
/**
* PLC memory area of the Snap7 input/output variable.
*/
const Snap7IOArea = {
Snap7IoAreaUnknown: "SNAP7_IO_AREA_UNKNOWN",
Snap7IoAreaProcessInputs: "SNAP7_IO_AREA_PROCESS_INPUTS",
Snap7IoAreaProcessOutputs: "SNAP7_IO_AREA_PROCESS_OUTPUTS",
Snap7IoAreaMerkers: "SNAP7_IO_AREA_MERKERS",
Snap7IoAreaDataBlock: "SNAP7_IO_AREA_DATA_BLOCK"
};
/**
* Direction of the Snap7 input/output variable from the perspective of this service.
*/
const Snap7IODirection = {
Snap7IoDirectionUnknown: "SNAP7_IO_DIRECTION_UNKNOWN",
Snap7IoDirectionInput: "SNAP7_IO_DIRECTION_INPUT",
Snap7IoDirectionOutput: "SNAP7_IO_DIRECTION_OUTPUT"
};
/**
* PLC data type of the Snap7 input/output variable. Used to interpret the corresponding PLC memory correctly.
*/
const Snap7IOTypeEnum = {
Snap7IoTypeUnknown: "SNAP7_IO_TYPE_UNKNOWN",
Snap7IoTypeBool: "SNAP7_IO_TYPE_BOOL",
Snap7IoTypeByte: "SNAP7_IO_TYPE_BYTE",
Snap7IoTypeWord: "SNAP7_IO_TYPE_WORD",
Snap7IoTypeDword: "SNAP7_IO_TYPE_DWORD",
Snap7IoTypeInt: "SNAP7_IO_TYPE_INT",
Snap7IoTypeDint: "SNAP7_IO_TYPE_DINT",
Snap7IoTypeReal: "SNAP7_IO_TYPE_REAL"
};
const SphereShapeTypeEnum = { Sphere: "sphere" };
const StartMovementRequestMessageTypeEnum = { StartMovementRequest: "StartMovementRequest" };
const StartMovementResponseKindEnum = { StartReceived: "START_RECEIVED" };
const StorageKeySourceEnum = { Key: "key" };
const TcpRequiredErrorKindEnum = { TcpRequiredError: "TcpRequiredError" };
const TcpVelocityRequestMessageTypeEnum = { TcpVelocityRequest: "TcpVelocityRequest" };
const TcpVelocityResponseKindEnum = { TcpVelocityReceived: "TCP_VELOCITY_RECEIVED" };
const ToolValueSourceEnum = { Value: "value" };
const TorqueExceededErrorKindEnum = { TorqueExceededError: "TorqueExceededError" };
const TrajectoryDataMessageTypeEnum = { TrajectoryData: "TrajectoryData" };
const TrajectoryDetailsKindEnum = { Trajectory: "TRAJECTORY" };
const TrajectoryEndedKindEnum = { EndOfTrajectory: "END_OF_TRAJECTORY" };
const TrajectoryIdMessageTypeEnum = { TrajectoryId: "TrajectoryId" };
const TrajectoryPausedByUserKindEnum = { PausedByUser: "PAUSED_BY_USER" };
const TrajectoryPausedOnIOKindEnum = { PausedOnIo: "PAUSED_ON_IO" };
const TrajectoryRunningKindEnum = { Running: "RUNNING" };
const TrajectoryWaitForIOKindEnum = { WaitForIo: "WAIT_FOR_IO" };
/**
* The unit of input/output value.
*/
const UnitType = {
UnitNone: "UNIT_NONE",
UnitKilogram: "UNIT_KILOGRAM",
UnitAmpere: "UNIT_AMPERE",
UnitKelvin: "UNIT_KELVIN",
UnitHertz: "UNIT_HERTZ",
UnitNewton: "UNIT_NEWTON",
UnitVolt: "UNIT_VOLT",
UnitCelsius: "UNIT_CELSIUS",
UnitNewtonMeter: "UNIT_NEWTON_METER",
UnitMeter: "UNIT_METER"
};
const UniversalrobotsControllerKindEnum = { UniversalrobotsController: "UniversalrobotsController" };
const VirtualControllerKindEnum = { VirtualController: "VirtualController" };
const YaskawaControllerKindEnum = { YaskawaController: "YaskawaController" };
const ZodValidationErrorErrorCodeEnum = { ValidationError: "validation_error" };
/**
* ApplicationApi - axios parameter creator
*/
const ApplicationApiAxiosParamCreator = function(configuration) {
return {
addApp: async (cell, app, completionTimeout, options = {}) => {
assertParamExists("addApp", "cell", cell);
assertParamExists("addApp", "app", app);
const localVarPath = `/cells/{cell}/apps`.replace(`{cell}`, encodeURIComponent(String(cell)));
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) baseOptions = configuration.baseOptions;
const localVarRequestOptions = {
method: "POST",
...baseOptions,
...options
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
await setBearerAuthToObject(localVarHeaderParameter, configuration);
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
localVarHeaderParameter["Content-Type"] = "application/json";
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers
};
localVarRequestOptions.data = serializeDataIfNeeded(app, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions
};
},
clearApps: async (cell, completionTimeout, options = {}) => {
assertParamExists("clearApps", "cell", cell);
const localVarPath = `/cells/{cell}/apps`.replace(`{cell}`, encodeURIComponent(String(cell)));
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) baseOptions = configuration.baseOptions;
const localVarRequestOptions = {
method: "DELETE",
...baseOptions,
...options
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
await setBearerAuthToObject(localVarHeaderParameter, configuration);
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers
};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions
};
},
deleteApp: async (cell, app, completionTimeout, options = {}) => {
assertParamExists("deleteApp", "cell", cell);
assertParamExists("deleteApp", "app", app);
const localVarPath = `/cells/{cell}/apps/{app}`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{app}`, encodeURIComponent(String(app)));
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) baseOptions = configuration.baseOptions;
const localVarRequestOptions = {
method: "DELETE",
...baseOptions,
...options
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
await setBearerAuthToObject(localVarHeaderParameter, configuration);
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers
};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions
};
},
getApp: async (cell, app, options = {}) => {
assertParamExists("getApp", "cell", cell);
assertParamExists("getApp", "app", app);
const localVarPath = `/cells/{cell}/apps/{app}`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{app}`, encodeURIComponent(String(app)));
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) baseOptions = configuration.baseOptions;
const localVarRequestOptions = {
method: "GET",
...baseOptions,
...options
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
await setBearerAuthToObject(localVarHeaderParameter, configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers
};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions
};
},
listApps: async (cell, options = {}) => {
assertParamExists("listApps", "cell", cell);
const localVarPath = `/cells/{cell}/apps`.replace(`{cell}`, encodeURIComponent(String(cell)));
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) baseOptions = configuration.baseOptions;
const localVarRequestOptions = {
method: "GET",
...baseOptions,
...options
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
await setBearerAuthToObject(localVarHeaderParameter, configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers
};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions
};
},
updateApp: async (cell, app, app2, completionTimeout, options = {}) => {
assertParamExists("updateApp", "cell", cell);
assertParamExists("updateApp", "app", app);
assertParamExists("updateApp", "app2", app2);
const localVarPath = `/cells/{cell}/apps/{app}`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{app}`, encodeURIComponent(String(app)));
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) baseOptions = configuration.baseOptions;
const localVarRequestOptions = {
method: "PUT",
...baseOptions,
...options
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
await setBearerAuthToObject(localVarHeaderParameter, configuration);
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
localVarHeaderParameter["Content-Type"] = "application/json";
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers
};
localVarRequestOptions.data = serializeDataIfNeeded(app2, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions
};
}
};
};
/**
* ApplicationApi - functional programming interface
*/
const ApplicationApiFp = function(configuration) {
const localVarAxiosParamCreator = ApplicationApiAxiosParamCreator(configuration);
return {
async addApp(cell, app, completionTimeout, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.addApp(cell, app, completionTimeout, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap["ApplicationApi.addApp"]?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
async clearApps(cell, completionTimeout, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.clearApps(cell, completionTimeout, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap["ApplicationApi.clearApps"]?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
async deleteApp(cell, app, completionTimeout, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteApp(cell, app, completionTimeout, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap["ApplicationApi.deleteApp"]?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
async getApp(cell, app, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.getApp(cell, app, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap["ApplicationApi.getApp"]?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
async listApps(cell, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.listApps(cell, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap["ApplicationApi.listApps"]?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
async updateApp(cell, app, app2, completionTimeout, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.updateApp(cell, app, app2, completionTimeout, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap["ApplicationApi.updateApp"]?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
}
};
};
/**
* ApplicationApi - factory interface
*/
const ApplicationApiFactory = function(configuration, basePath, axios) {
const localVarFp = ApplicationApiFp(configuration);
return {
addApp(cell, app, completionTimeout, options) {
return localVarFp.addApp(cell, app, completionTimeout, options).then((request) => request(axios, basePath));
},
clearApps(cell, completionTimeout, options) {
return localVarFp.clearApps(cell, completionTimeout, options).then((request) => request(axios, basePath));
},
deleteApp(cell, app, completionTimeout, options) {
return localVarFp.deleteApp(cell, app, completionTimeout, options).then((request) => request(axios, basePath));
},
getApp(cell, app, options) {
return localVarFp.getApp(cell, app, options).then((request) => request(axios, basePath));
},
listApps(cell, options) {
return localVarFp.listApps(cell, options).then((request) => request(axios, basePath));
},
updateApp(cell, app, app2, completionTimeout, options) {
return localVarFp.updateApp(cell, app, app2, completionTimeout, options).then((request) => request(axios, basePath));
}
};
};
/**
* ApplicationApi - object-oriented interface
*/
var ApplicationApi = class extends BaseAPI {
/**
* **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___ Install a basic, containerized web application to the cell to control robots with a customized frontend. #### Prerequisites - A Docker hub account or similar container registry account, with valid credentials. #### Workflow After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](https://docs.wandelbots.io/latest/developing-introduction) for more information. #### Predefined environment variables <!-- theme: NOTE --> > **NOTE** > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
* @summary Add Application
* @param {string} cell Unique identifier addressing a cell in all API calls.
* @param {App} app
* @param {number} [completionTimeout]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addApp(cell, app, completionTimeout, options) {
return ApplicationApiFp(this.configuration).addApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
}
/**
* **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___ Delete all GUI applications from the cell.
* @summary Clear Applications
* @param {string} cell Unique identifier addressing a cell in all API calls.
* @param {number} [completionTimeout]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
clearApps(cell, completionTimeout, options) {
return ApplicationApiFp(this.configuration).clearApps(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
}
/**
* **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___ Delete a GUI application from the cell.
* @summary Delete Application
* @param {string} cell Unique identifier addressing a cell in all API calls.
* @param {string} app
* @param {number} [completionTimeout]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApp(cell, app, completionTimeout, options) {
return ApplicationApiFp(this.configuration).deleteApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
}
/**
* **Required permissions:** `can_access_apps` - View application configurations ___ 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 [updateApp](#/operations/updateApp).
* @summary Configuration
* @param {string} cell Unique identifier addressing a cell in all API calls.
* @param {string} app
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getApp(cell, app, options) {
return ApplicationApiFp(this.configuration).getApp(cell, app, options).then((request) => request(this.axios, this.basePath));
}
/**
* **Required permissions:** `can_access_apps` - View application configurations ___ List all GUI applications that have been added to a cell with [addApp](#/operations/addApp). If the cell does not contain GUI applications, the list is returned empty.
* @summary List Applications
* @param {string} cell Unique identifier addressing a cell in all API calls.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listApps(cell, options) {
return ApplicationApiFp(this.configuration).listApps(cell, options).then((request) => request(this.axios, this.basePath));
}
/**
* **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___ Update the configuration of a GUI application in the cell.
* @summary Update Configuration
* @param {string} cell Unique identifier addressing a cell in all API calls.
* @param {string} app
* @param {App} app2
* @param {number} [completionTimeout]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateApp(cell, app, app2, completionTimeout, options) {
return ApplicationApiFp(this.configuration).updateApp(cell, app, app2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
}
};
/**
* BUSInputsOutputsApi - axios parameter creator
*/
const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
return {
addBusIOService: async (cell, busIOType, completionTimeout, options = {}) => {
assertParamExists("addBusIOService", "cell", cell);
assertParamExists("addBusIOService", "busIOType", busIOType);
const localVarPath = `/cells/{cell}/bus-ios`.replace(`{cell}`, encodeURIComponent(String(cell)));
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) baseOptions = configuration.baseOptions;
const localVarRequestOptions = {
method: "POST",
...baseOptions,
...options
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
await setBearerAuthToObject(localVarHeaderParameter, configuration);
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
localVarHeaderParameter["Content-Type"] = "application/json";
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers
};
localVarRequestOptions.data = serializeDataIfNeeded(busIOType, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions
};
},
addModbusIO: async (cell, io, modbusIOData, options = {}) => {
assertParamExists("addModbusIO", "cell", cell);
assertParamExists("addModbusIO", "io", io);
assertParamExists("addModbusIO", "modbusIOData", modbusIOData);
const localVarPath = `/cells/{cell}/bus-ios/modbus/ios/{io}`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{io}`, encodeURIComponent(String(io)));
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) baseOptions = configuration.baseOptions;
const localVarRequestOptions = {
method: "PUT",
...baseOptions,
...options
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
await setBearerAuthToObject(localVarHeaderParameter, configuration);
localVarHeaderParameter["Content-Type"] = "application/json";
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers
};
localVarRequestOptions.data = serializeDataIfNeeded(modbusIOData, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions
};
},
addProfinetIO: async (cell, io, profinetIOData, options = {}) => {
assertParamExists("addProfinetIO", "cell", cell);
assertParamExists("addProfinetIO", "io", io);
assertParamExists("addProfinetIO", "profinetIOData", profinetIOData);
const localVarPath = `/cells/{cell}/bus-ios/profinet/ios/{io}`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{io}`, encodeURIComponent(String(io)));
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) baseOptions = configuration.baseOptions;
const localVarRequestOptions = {
method: "PUT",
...baseOptions,
...options
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
await setBearerAuthToObject(localVarHeaderParameter, configuration);
localVarHeaderParameter["Content-Type"] = "application/json";
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,