@deeptrekker/api-domain 1.0.20-x4networktable.5 → 1.0.20-x4networktable.8
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/constants/schema/schema.json +2 -0
- package/dist/constants/versions/index.d.ts +1 -1
- package/dist/constants/versions/index.js +1 -1
- package/dist/types/devices/index.d.ts +10 -5
- package/dist/types/devices/index.js +6 -1
- package/dist/types/devices/vehicles/x4/index.d.ts +5 -0
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const API_VERSION = "1.0.20-x4networktable.
|
|
1
|
+
export declare const API_VERSION = "1.0.20-x4networktable.8";
|
|
@@ -26,7 +26,10 @@ export declare enum DeviceModel {
|
|
|
26
26
|
X4Thruster = 114,
|
|
27
27
|
X4Lights = 115,
|
|
28
28
|
X4CameraHead = 116,
|
|
29
|
-
SensorPodX =
|
|
29
|
+
SensorPodX = 117,
|
|
30
|
+
X4GrabberModel = 118,
|
|
31
|
+
X4BrushedMotor = 116,
|
|
32
|
+
X4OculusSonar = 246,
|
|
30
33
|
RevolutionCameraHead = 102,
|
|
31
34
|
PivotCameraHead = 103,
|
|
32
35
|
A200CameraHead = 106,
|
|
@@ -109,7 +112,7 @@ export declare const VEHICLE_DEVICE_MODEL_LABELS: {
|
|
|
109
112
|
export declare const PERIPHERAL_DEVICE_MODEL_LABELS: {
|
|
110
113
|
readonly 101: "Sensor Pod";
|
|
111
114
|
readonly 100: "Sensor Pod+";
|
|
112
|
-
readonly
|
|
115
|
+
readonly 117: "Sensor Pod X";
|
|
113
116
|
readonly 110: "ROV GPS";
|
|
114
117
|
readonly 111: "Serial Interface Box";
|
|
115
118
|
readonly 200: "WaterLinked UGPS";
|
|
@@ -125,6 +128,7 @@ export declare const PERIPHERAL_DEVICE_MODEL_LABELS: {
|
|
|
125
128
|
readonly 113: "Power Distribution Module";
|
|
126
129
|
readonly 114: "Thruster";
|
|
127
130
|
readonly 115: "Lights";
|
|
131
|
+
readonly 118: "Grabber";
|
|
128
132
|
};
|
|
129
133
|
/**
|
|
130
134
|
* Deep Trekker's Camera Head Device Model Labels
|
|
@@ -162,7 +166,7 @@ export declare const DEVICE_MODEL_LABELS: {
|
|
|
162
166
|
readonly BRIDGEBOX: "BridgeBox";
|
|
163
167
|
readonly 101: "Sensor Pod";
|
|
164
168
|
readonly 100: "Sensor Pod+";
|
|
165
|
-
readonly
|
|
169
|
+
readonly 117: "Sensor Pod X";
|
|
166
170
|
readonly 110: "ROV GPS";
|
|
167
171
|
readonly 111: "Serial Interface Box";
|
|
168
172
|
readonly 200: "WaterLinked UGPS";
|
|
@@ -178,6 +182,7 @@ export declare const DEVICE_MODEL_LABELS: {
|
|
|
178
182
|
readonly 113: "Power Distribution Module";
|
|
179
183
|
readonly 114: "Thruster";
|
|
180
184
|
readonly 115: "Lights";
|
|
185
|
+
readonly 118: "Grabber";
|
|
181
186
|
readonly 107: "Tether Reel";
|
|
182
187
|
readonly 108: "Powered Tether Reel";
|
|
183
188
|
readonly 109: "A-150 Camera Head";
|
|
@@ -237,13 +242,13 @@ export declare const SENSOR_POD_DEVICE_MODELS: readonly [DeviceModel.SensorPod,
|
|
|
237
242
|
* @group Devices
|
|
238
243
|
* @category Gen4 Peripherals
|
|
239
244
|
*/
|
|
240
|
-
export declare const X4_PERIPHERAL_DEVICE_MODELS: readonly [DeviceModel.X4PDM, DeviceModel.X4Thruster, DeviceModel.X4Lights];
|
|
245
|
+
export declare const X4_PERIPHERAL_DEVICE_MODELS: readonly [DeviceModel.X4PDM, DeviceModel.X4Thruster, DeviceModel.X4Lights, DeviceModel.X4GrabberModel];
|
|
241
246
|
/**
|
|
242
247
|
* All External Peripheral Device Models
|
|
243
248
|
* @group Devices
|
|
244
249
|
* @category Peripherals
|
|
245
250
|
*/
|
|
246
|
-
export declare const PERIPHERAL_DEVICE_MODELS: readonly [DeviceModel.RovGps, DeviceModel.SerialBox, DeviceModel.WaterlinkedGps, DeviceModel.Seatrac, DeviceModel.DVL, DeviceModel.PathfindrDVL, DeviceModel.OculusSonar, DeviceModel.GeminiSonar, DeviceModel.Echosounder, DeviceModel.WATERLINKED_3D_SONAR, DeviceModel.SensorPod, DeviceModel.SensorPodPlus, DeviceModel.SensorPodX, DeviceModel.X4PDM, DeviceModel.X4Thruster, DeviceModel.X4Lights];
|
|
251
|
+
export declare const PERIPHERAL_DEVICE_MODELS: readonly [DeviceModel.RovGps, DeviceModel.SerialBox, DeviceModel.WaterlinkedGps, DeviceModel.Seatrac, DeviceModel.DVL, DeviceModel.PathfindrDVL, DeviceModel.OculusSonar, DeviceModel.GeminiSonar, DeviceModel.Echosounder, DeviceModel.WATERLINKED_3D_SONAR, DeviceModel.SensorPod, DeviceModel.SensorPodPlus, DeviceModel.SensorPodX, DeviceModel.X4PDM, DeviceModel.X4Thruster, DeviceModel.X4Lights, DeviceModel.X4GrabberModel];
|
|
247
252
|
/**
|
|
248
253
|
* Device Version is a base interface for hardware and software version sample payloads.
|
|
249
254
|
* -1 hardware versions and 0.0 software versions refer to not applicable
|
|
@@ -70,7 +70,10 @@ var DeviceModel;
|
|
|
70
70
|
DeviceModel[DeviceModel["X4Thruster"] = 114] = "X4Thruster";
|
|
71
71
|
DeviceModel[DeviceModel["X4Lights"] = 115] = "X4Lights";
|
|
72
72
|
DeviceModel[DeviceModel["X4CameraHead"] = 116] = "X4CameraHead";
|
|
73
|
-
DeviceModel[DeviceModel["SensorPodX"] =
|
|
73
|
+
DeviceModel[DeviceModel["SensorPodX"] = 117] = "SensorPodX";
|
|
74
|
+
DeviceModel[DeviceModel["X4GrabberModel"] = 118] = "X4GrabberModel";
|
|
75
|
+
DeviceModel[DeviceModel["X4BrushedMotor"] = 116] = "X4BrushedMotor";
|
|
76
|
+
DeviceModel[DeviceModel["X4OculusSonar"] = 246] = "X4OculusSonar";
|
|
74
77
|
/* Camera Heads */
|
|
75
78
|
DeviceModel[DeviceModel["RevolutionCameraHead"] = 102] = "RevolutionCameraHead";
|
|
76
79
|
DeviceModel[DeviceModel["PivotCameraHead"] = 103] = "PivotCameraHead";
|
|
@@ -177,6 +180,7 @@ exports.PERIPHERAL_DEVICE_MODEL_LABELS = (_c = {},
|
|
|
177
180
|
_c[DeviceModel.X4PDM] = "Power Distribution Module",
|
|
178
181
|
_c[DeviceModel.X4Thruster] = "Thruster",
|
|
179
182
|
_c[DeviceModel.X4Lights] = "Lights",
|
|
183
|
+
_c[DeviceModel.X4GrabberModel] = "Grabber",
|
|
180
184
|
_c);
|
|
181
185
|
/**
|
|
182
186
|
* Deep Trekker's Camera Head Device Model Labels
|
|
@@ -279,6 +283,7 @@ exports.X4_PERIPHERAL_DEVICE_MODELS = [
|
|
|
279
283
|
DeviceModel.X4PDM,
|
|
280
284
|
DeviceModel.X4Thruster,
|
|
281
285
|
DeviceModel.X4Lights,
|
|
286
|
+
DeviceModel.X4GrabberModel,
|
|
282
287
|
];
|
|
283
288
|
/**
|
|
284
289
|
* All External Peripheral Device Models
|
|
@@ -101,6 +101,10 @@ export type X4Thruster = {
|
|
|
101
101
|
* @category Controls
|
|
102
102
|
*/
|
|
103
103
|
export type X4DriveCommand = {
|
|
104
|
+
/**
|
|
105
|
+
* Flag dictating if rosbag recording should be active.
|
|
106
|
+
*/
|
|
107
|
+
rosbag?: boolean;
|
|
104
108
|
/**
|
|
105
109
|
* The reference frame for the drive command, which can be used to specify the coordinate system in which the command is issued.
|
|
106
110
|
* This allows the user to control the vehicle's movement in a specific frame of reference. The value must correspond to a valid reference frame in the system (mac address of a camera or camera head).
|
|
@@ -656,6 +660,7 @@ export type X4MediaSession = {
|
|
|
656
660
|
* @category Core
|
|
657
661
|
*/
|
|
658
662
|
export type X4 = {
|
|
663
|
+
rosbag?: boolean;
|
|
659
664
|
/**
|
|
660
665
|
* A record of network devices associated with the X4 vehicle. They are identified by their unique MAC address.
|
|
661
666
|
* Each device contains properties such as model, IP address, software version, hardware version,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@deeptrekker/api-domain",
|
|
3
|
-
"version": "1.0.20-x4networktable.
|
|
3
|
+
"version": "1.0.20-x4networktable.8",
|
|
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": {
|