@deeptrekker/api-domain 1.0.37 → 1.0.39

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.
@@ -1 +1 @@
1
- export declare const API_VERSION = "1.0.37";
1
+ export declare const API_VERSION = "1.0.39";
@@ -2,4 +2,4 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.API_VERSION = void 0;
4
4
  /* AUTO GENERATED FILE */
5
- exports.API_VERSION = "1.0.37";
5
+ exports.API_VERSION = "1.0.39";
@@ -55,13 +55,16 @@ export type TransferPayload<T> = {
55
55
  payload: T;
56
56
  };
57
57
  export declare enum ReferencePoints {
58
- Body = "body",
59
58
  Altitude = "altitude",
60
59
  Depth = "depth",
61
60
  Global = "global",
62
61
  Local = "local",
63
62
  Distance = "distance"
64
63
  }
64
+ export declare enum ControlFrames {
65
+ Body = "body",
66
+ Footprint = "footprint"
67
+ }
65
68
  /**
66
69
  * Movement
67
70
  *
@@ -99,6 +102,11 @@ export type Movement = {
99
102
  * A reference to the position or heading that the vehicle should target and base its locking on.
100
103
  */
101
104
  reference?: ReferencePoints;
105
+ /**
106
+ * @remarks
107
+ * The frame of reference for the movement. This is used to determine how the vehicle should interpret the movement command.
108
+ */
109
+ controlFrame?: ControlFrames;
102
110
  };
103
111
  /**
104
112
  * The different kinds of payload requests that can be sent and received.
@@ -15,16 +15,20 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  var _a;
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
- exports.ERROR_MESSAGES = exports.ErrorCode = exports.TransferMethodType = exports.ReferencePoints = void 0;
18
+ exports.ERROR_MESSAGES = exports.ErrorCode = exports.TransferMethodType = exports.ControlFrames = exports.ReferencePoints = void 0;
19
19
  var ReferencePoints;
20
20
  (function (ReferencePoints) {
21
- ReferencePoints["Body"] = "body";
22
21
  ReferencePoints["Altitude"] = "altitude";
23
22
  ReferencePoints["Depth"] = "depth";
24
23
  ReferencePoints["Global"] = "global";
25
24
  ReferencePoints["Local"] = "local";
26
25
  ReferencePoints["Distance"] = "distance";
27
26
  })(ReferencePoints || (exports.ReferencePoints = ReferencePoints = {}));
27
+ var ControlFrames;
28
+ (function (ControlFrames) {
29
+ ControlFrames["Body"] = "body";
30
+ ControlFrames["Footprint"] = "footprint";
31
+ })(ControlFrames || (exports.ControlFrames = ControlFrames = {}));
28
32
  /**
29
33
  * The different kinds of payload requests that can be sent and received.
30
34
  * @category Core
@@ -15,4 +15,4 @@ export type Cameras = Camera | TamronHarrierZoomCamera | DTCam | OcleaCam | Tamr
15
15
  * @group Devices
16
16
  * @category Cameras
17
17
  */
18
- export type CameraModels = DeviceModel.TamronHarrierZoomCamera | DeviceModel.TamronOcleaZoomCamera | DeviceModel.DTCam | DeviceModel.OcleaCam | DeviceModel.MiniAuxCamera;
18
+ export type CameraModels = DeviceModel.TamronHarrierZoomCamera | DeviceModel.TamronOcleaZoomCamera | DeviceModel.DTCam | DeviceModel.OcleaCam | DeviceModel.MiniAuxCamera | DeviceModel.X4Cam;
@@ -158,6 +158,11 @@ export type X4DriveCommand = {
158
158
  * See {@link ControlMode | ControlMode} for more details.
159
159
  */
160
160
  controlMode?: ControlMode;
161
+ /**
162
+ * The velocity control option for the drive command, which can be used to specify whether the vehicle should use velocity control or position control.
163
+ * If true the vehicle is locked to velocity control.
164
+ */
165
+ useVelocityControl?: boolean;
161
166
  /**
162
167
  * The forward movement command, which includes speed and position.
163
168
  * This allows the user to control the vehicle's forward movement. (Forward and backward)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deeptrekker/api-domain",
3
- "version": "1.0.37",
3
+ "version": "1.0.39",
4
4
  "description": "A business domain of types and schemas that the Deep Trekker topside communicates with via an API.",
5
5
  "main": "dist/index.js",
6
6
  "engines": {