@deeptrekker/api-domain 0.41.0 → 0.43.0

package/dist/samples/requests/devices/vehicles/revolution/cameras/dtCam/whiteBalance/index.d.ts

@@ -0,0 +1,49 @@
+import { BridgeBox, TransferMethodType, TransferPayload } from "../../../../../../../../types";
+/**
+ * 4k UHD Camera Payloads
+ */
+/** Creates a **Revolution 4K UHD Camera white balance** payload.
+ *
+ * @param whiteBalance Encapsulates white balance related properties
+ * @param whiteBalance.auto
+ * @param whiteBalance.red
+ * @param whiteBalance.blue
+ * @param revolutionId  Mac address of the Revolution
+ * @param cameraId Mac address of the camera
+ *
+ * @returns BridgeBox
+ */
+export declare const revolutionDTCamWhiteBalancePayload: (whiteBalance: {
+    auto?: boolean;
+    red?: number;
+    blue?: number;
+}, revolutionId: string, cameraId: string) => BridgeBox;
+/** Creates a **Revolution 4k UHD Camera white balance** request.
+ *
+ * @param whiteBalance Encapsulates white balance related properties
+ * @param whiteBalance.auto
+ * @param whiteBalance.red
+ * @param whiteBalance.blue
+ * @param revolutionId  Mac address of the Revolution
+ *
+ * @returns TransferPayload<BridgeBox>
+ */
+export declare const revolutionDTCamWhiteBalanceRequest: (whiteBalance: {
+    auto: boolean;
+    red: number;
+    blue: number;
+}, revolutionId?: string, cameraId?: string, transferMethodType?: TransferMethodType) => TransferPayload<BridgeBox>;
+/** Creates a **Revolution 4k UHD Camera auto white balance request** sample.
+ *
+ * @param revolutionId  Mac address of the Revolution
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/revolution/cameras/DTCam/whiteBalance
+ */
+export declare const revolutionDTCamAutoWhiteBalanceSample: (revolutionId?: string, cameraId?: string) => TransferPayload<BridgeBox>;
+/** Creates a **Revolution 4k UHD Camera manual white balance request** sample.
+ *
+ * @param revolutionId  Mac address of the Revolution
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/revolution/cameras/DTCam/whiteBalance
+ */
+export declare const revolutionDTCamManualWhiteBalanceSample: (revolutionId?: string, cameraId?: string) => TransferPayload<BridgeBox>;

package/dist/samples/requests/devices/vehicles/revolution/cameras/dtCam/whiteBalance/index.js

@@ -0,0 +1,91 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.revolutionDTCamManualWhiteBalanceSample = exports.revolutionDTCamAutoWhiteBalanceSample = exports.revolutionDTCamWhiteBalanceRequest = exports.revolutionDTCamWhiteBalancePayload = void 0;
+var __1 = require("../../..");
+var types_1 = require("../../../../../../../../types");
+var core_1 = require("../../../../../../../core");
+/**
+ * 4k UHD Camera Payloads
+ */
+/** Creates a **Revolution 4K UHD Camera white balance** payload.
+ *
+ * @param whiteBalance Encapsulates white balance related properties
+ * @param whiteBalance.auto
+ * @param whiteBalance.red
+ * @param whiteBalance.blue
+ * @param revolutionId  Mac address of the Revolution
+ * @param cameraId Mac address of the camera
+ *
+ * @returns BridgeBox
+ */
+var revolutionDTCamWhiteBalancePayload = function (whiteBalance, revolutionId, cameraId) {
+    var _a, _b;
+    return ({
+        devices: (_a = {},
+            _a[revolutionId] = __assign(__assign({}, (0, __1.getRevolutionDevice)()), { cameras: (_b = {},
+                    _b[cameraId] = __assign(__assign({}, (0, core_1.getDTCam)()), { whiteBalance: whiteBalance }),
+                    _b) }),
+            _a),
+    });
+};
+exports.revolutionDTCamWhiteBalancePayload = revolutionDTCamWhiteBalancePayload;
+/** Creates a **Revolution 4k UHD Camera white balance** request.
+ *
+ * @param whiteBalance Encapsulates white balance related properties
+ * @param whiteBalance.auto
+ * @param whiteBalance.red
+ * @param whiteBalance.blue
+ * @param revolutionId  Mac address of the Revolution
+ *
+ * @returns TransferPayload<BridgeBox>
+ */
+var revolutionDTCamWhiteBalanceRequest = function (whiteBalance, revolutionId, cameraId, transferMethodType) {
+    if (revolutionId === void 0) { revolutionId = (0, core_1.macAddressId)(); }
+    if (cameraId === void 0) { cameraId = (0, core_1.macAddressId)(); }
+    if (transferMethodType === void 0) { transferMethodType = types_1.TransferMethodType.Set; }
+    return (__assign(__assign({}, (0, core_1.getApiRequest)(transferMethodType)), { payload: __assign({}, (0, exports.revolutionDTCamWhiteBalancePayload)(whiteBalance, revolutionId, cameraId)) }));
+};
+exports.revolutionDTCamWhiteBalanceRequest = revolutionDTCamWhiteBalanceRequest;
+/** Creates a **Revolution 4k UHD Camera auto white balance request** sample.
+ *
+ * @param revolutionId  Mac address of the Revolution
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/revolution/cameras/DTCam/whiteBalance
+ */
+var revolutionDTCamAutoWhiteBalanceSample = function (revolutionId, cameraId) {
+    if (revolutionId === void 0) { revolutionId = (0, core_1.macAddressId)(); }
+    if (cameraId === void 0) { cameraId = (0, core_1.macAddressId)(); }
+    return (__assign({}, (0, exports.revolutionDTCamWhiteBalanceRequest)({
+        auto: true,
+        red: 0,
+        blue: 0
+    }, revolutionId, cameraId)));
+};
+exports.revolutionDTCamAutoWhiteBalanceSample = revolutionDTCamAutoWhiteBalanceSample;
+/** Creates a **Revolution 4k UHD Camera manual white balance request** sample.
+ *
+ * @param revolutionId  Mac address of the Revolution
+ * @returns TransferPayload<BridgeBox>
+ * @outputSample requests/devices/vehicles/revolution/cameras/DTCam/whiteBalance
+ */
+var revolutionDTCamManualWhiteBalanceSample = function (revolutionId, cameraId) {
+    if (revolutionId === void 0) { revolutionId = (0, core_1.macAddressId)(); }
+    if (cameraId === void 0) { cameraId = (0, core_1.macAddressId)(); }
+    return (__assign({}, (0, exports.revolutionDTCamWhiteBalanceRequest)({
+        auto: false,
+        red: 50,
+        blue: 45
+    }, revolutionId, cameraId)));
+};
+exports.revolutionDTCamManualWhiteBalanceSample = revolutionDTCamManualWhiteBalanceSample;

package/dist/samples/requests/devices/vehicles/revolution/cameras/index.d.ts

@@ -24,3 +24,4 @@ export declare const revolutionCamerasRequest: (cameras?: Record<string, Removab
 export declare const revolutionCamerasDeleteSample: (cameras?: Record<string, Removable<Cameras>>, revolutionId?: string) => TransferPayload<BridgeBox>;
 export * from "./tamronHarrier";
 export * from "./ocleaCam";
+export * from "./dtCam";

package/dist/samples/requests/devices/vehicles/revolution/cameras/index.js

@@ -72,3 +72,4 @@ var revolutionCamerasDeleteSample = function (cameras, revolutionId) {
 exports.revolutionCamerasDeleteSample = revolutionCamerasDeleteSample;
 __exportStar(require("./tamronHarrier"), exports);
 __exportStar(require("./ocleaCam"), exports);
+__exportStar(require("./dtCam"), exports);

package/dist/samples/requests/devices/vehicles/revolution/cameras/ocleaCam/exposure/index.d.ts

@@ -15,10 +15,10 @@ import { BridgeBox, TransferMethodType, TransferPayload } from "../../../../../.
  * @returns BridgeBox
  */
 export declare const revolutionOcleaCamExposurePayload: (exposure: {
-    auto: boolean;
-    autoExposureCompensation: number;
-    sensorGain: number;
-    shutterTime: string;
+    auto?: boolean;
+    autoExposureCompensation?: number;
+    sensorGain?: number;
+    shutterTime?: string;
 }, revolutionId: string, cameraId: string) => BridgeBox;
 /** Creates a **Revolution 4k UHD Camera exposure** request.
  *

package/dist/samples/requests/devices/vehicles/revolution/cameras/ocleaCam/whiteBalance/index.d.ts

@@ -14,9 +14,9 @@ import { BridgeBox, TransferMethodType, TransferPayload } from "../../../../../.
  * @returns BridgeBox
  */
 export declare const revolutionOcleaCamWhiteBalancePayload: (whiteBalance: {
-    auto: boolean;
-    red: number;
-    blue: number;
+    auto?: boolean;
+    red?: number;
+    blue?: number;
 }, revolutionId: string, cameraId: string) => BridgeBox;
 /** Creates a **Revolution 4k UHD Camera white balance** request.
  *

package/dist/schemas/schema.json

@@ -598,10 +598,10 @@
     },
     "DTCam": {
       "additionalProperties": false,
-      "description": "{@link  IdtCam 📖 See extended definition } \n\n📷 DT Cam",
+      "description": "{@link  IDtCam 📖 See extended definition } \n\n📷 DT Cam",
       "properties": {
         "brightness": {
-          "description": "💡 Camera Brightness\n\n### Example Payload (Standard 1080p Camera)\n\n#### Brightness Samples (A150) ##### A150 at Max Brightness {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/brightness/a150DTCamBrightnessMaxSample.json}\n\n##### A150 at Min Brightness {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/brightness/a150DTCamBrightnessMinSample.json}\n\n##### A150 at Random Brightness {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/brightness/a150DTCamBrightnessRandomSample.json}\n\n#### Brightness Samples (A200) ##### A200 at Max Brightness {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/brightness/a200DTCamBrightnessMaxSample.json}\n\n##### A200 at Min Brightness {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/brightness/a200DTCamBrightnessMinSample.json}\n\n##### A200 at Random Brightness {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/brightness/a200DTCamBrightnessRandomSample.json}\n\n<br /> <br />",
+          "description": "💡 Camera Brightness\n\n### Example Payload (Standard 1080p Camera) #### Brightness Samples (A150/A200) {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/brightness/a150DTCamBrightnessRandomSample.json} <br />",
           "maximum": 100,
           "minimum": 0,
           "type": "number"
@@ -625,7 +625,7 @@
           "description": "On screen display\n\nModify osd settings\n\n\n### Example Payload (Standard 1080p Camera)\n\n#### Osd Samples (A150) ##### A150 with Osd Enabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/osd/a150DTCamOsdEnabledSample.json}\n\n##### A150 with Osd Disabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/osd/a150DTCamOsdDisabledSample.json}\n\n##### A150 with Random Osd {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/osd/a150DTCamOsdRandomSample.json}\n\n#### Osd Samples (A200) ##### A200 with Osd Enabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/osd/a200DTCamOsdEnabledSample.json}\n\n##### A200 with Osd Disabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/osd/a200DTCamOsdDisabledSample.json}\n\n##### A200 with Random Osd {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/osd/a200DTCamOsdRandomSample.json}\n\n### Example Payload (Tamron Harrier Zoom Camera)\n\n#### Osd Samples (A150) ##### A150 with Osd Enabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/osd/a150TamronHarrierZoomCameraOsdEnabledSample.json}\n\n##### A150 with Osd Disabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/osd/a150TamronHarrierZoomCameraOsdDisabledSample.json}\n\n##### A150 with Random Osd {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/osd/a150TamronHarrierZoomCameraOsdRandomSample.json}\n\n#### Osd Samples (A200) ##### A200 with Osd Enabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/osd/a200TamronHarrierZoomCameraOsdEnabledSample.json}\n\n##### A200 with Osd Disabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/osd/a200TamronHarrierZoomCameraOsdDisabledSample.json}\n\n##### A200 with Random Osd {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/osd/a200TamronHarrierZoomCameraOsdRandomSample.json}\n\n<br /> <br />"
         },
         "saturation": {
-          "description": "🎨 Camera Saturation\n\n### Example Payload (Standard 1080p Camera)\n\n#### Saturation Samples (A150) ##### A150 at Saturation Level Max {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/saturation/a150DTCamSaturationMaxSample.json}\n\n##### A150 at Saturation Level Min {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/saturation/a150DTCamSaturationMinSample.json}\n\n##### A150 at Saturation Level Random {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/saturation/a150DTCamSaturationRandomSample.json}\n\n#### Saturation Samples (A200) ##### A200 at Saturation Level Max {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/saturation/a200DTCamSaturationMaxSample.json}\n\n##### A200 at Saturation Level Min {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/saturation/a200DTCamSaturationMinSample.json}\n\n##### A200 at Saturation Level Random {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/saturation/a200DTCamSaturationRandomSample.json}\n\n<br /> <br />",
+          "description": "🎨 Camera Saturation\n\n### Example Payload (Standard 1080p Camera) #### Saturation Samples (A150/A200) {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/saturation/a150DTCamSaturationRandomSample.json} <br />",
           "maximum": 100,
           "minimum": 0,
           "type": "number"
@@ -648,6 +648,35 @@
         "version": {
           "$ref": "#/definitions/DeviceVersion",
           "description": "Version"
+        },
+        "whiteBalance": {
+          "additionalProperties": false,
+          "description": "White Balance\n\n####  White Balance Sample (A150/A200) ##### Auto White Balance {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/whiteBalance/a150DTCamAutoWhiteBalanceSample.json}\n\n##### Manual White Balance {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/whiteBalance/a150DTCamManualWhiteBalanceSample.json}\n\n#### White Balance Samples (Pivot) ##### Auto White Balance {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/pivot/cameras/DTCam/whiteBalance/pivotDTCamAutoWhiteBalanceSample.json}\n\n##### Manual White Balance {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/pivot/cameras/DTCam/whiteBalance/pivotDTCamManualWhiteBalanceSample.json}\n\n####  White Balance Samples (Revolution) ##### Auto White Balance {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cameras/DTCam/whiteBalance/revolutionDTCamAutoWhiteBalanceSample.json}\n\n##### Manual White Balance {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cameras/DTCam/whiteBalance/revolutionDTCamManualWhiteBalanceSample.json}\n\n\n</br>",
+          "properties": {
+            "auto": {
+              "description": "Enable/Disable auto white balance mode. </br>",
+              "type": "boolean"
+            },
+            "blue": {
+              "description": "Blue Control </br>",
+              "maximum": 100,
+              "minimum": 0,
+              "type": "number"
+            },
+            "green": {
+              "description": "Green Control </br>",
+              "maximum": 100,
+              "minimum": 0,
+              "type": "number"
+            },
+            "red": {
+              "description": "Red Control </br>",
+              "maximum": 100,
+              "minimum": 0,
+              "type": "number"
+            }
+          },
+          "type": "object"
         }
       },
       "required": [
@@ -1127,7 +1156,7 @@
           "description": "On screen display\n\nModify osd settings\n\n\n### Example Payload (Standard 1080p Camera)\n\n#### Osd Samples (A150) ##### A150 with Osd Enabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/osd/a150DTCamOsdEnabledSample.json}\n\n##### A150 with Osd Disabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/osd/a150DTCamOsdDisabledSample.json}\n\n##### A150 with Random Osd {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/osd/a150DTCamOsdRandomSample.json}\n\n#### Osd Samples (A200) ##### A200 with Osd Enabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/osd/a200DTCamOsdEnabledSample.json}\n\n##### A200 with Osd Disabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/osd/a200DTCamOsdDisabledSample.json}\n\n##### A200 with Random Osd {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/osd/a200DTCamOsdRandomSample.json}\n\n### Example Payload (Tamron Harrier Zoom Camera)\n\n#### Osd Samples (A150) ##### A150 with Osd Enabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/osd/a150TamronHarrierZoomCameraOsdEnabledSample.json}\n\n##### A150 with Osd Disabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/osd/a150TamronHarrierZoomCameraOsdDisabledSample.json}\n\n##### A150 with Random Osd {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/osd/a150TamronHarrierZoomCameraOsdRandomSample.json}\n\n#### Osd Samples (A200) ##### A200 with Osd Enabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/osd/a200TamronHarrierZoomCameraOsdEnabledSample.json}\n\n##### A200 with Osd Disabled {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/osd/a200TamronHarrierZoomCameraOsdDisabledSample.json}\n\n##### A200 with Random Osd {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/osd/a200TamronHarrierZoomCameraOsdRandomSample.json}\n\n<br /> <br />"
         },
         "saturation": {
-          "description": "🎨 Camera Saturation\n\n#### Saturation Sample (Revolution/Pivot) {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cameras/ocleaCam/saturation/revolutionOcleaCamSaturationSample.json} </br>     *",
+          "description": "🎨 Camera Saturation\n\n#### Saturation Sample (Revolution/Pivot) {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cameras/ocleaCam/saturation/revolutionOcleaCamSaturationSample.json} </br>",
           "maximum": 100,
           "minimum": 0,
           "type": "number"
@@ -1153,7 +1182,7 @@
         },
         "whiteBalance": {
           "additionalProperties": false,
-          "description": "White Balance\n\n####  White Balance Sample (Revolution/Pivot) ##### Auto White Balance {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cameras/ocleaCam/whiteBalance/revolutionOcleaCamAutoWhiteBalanceSample.json}\n\n##### Manual White Balance {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cameras/ocleaCam/whiteBalance/revolutionOcleaCamManualWhiteBalanceSample.json} </br>",
+          "description": "White Balance\n\n####  White Balance Sample (Revolution/Pivot) ##### Auto White Balance {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cameras/ocleaCam/whiteBalance/revolutionOcleaCamAutoWhiteBalanceSample.json}\n\n{@codeblock ~~/dist/samples/generated/requests/devices/vehicles/pivot/cameras/ocleaCam/whiteBalance/pivotOcleaCamAutoWhiteBalanceSample.json}\n\n##### Manual White Balance {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cameras/ocleaCam/whiteBalance/revolutionOcleaCamManualWhiteBalanceSample.json}\n\n{@codeblock ~~/dist/samples/generated/requests/devices/vehicles/pivot/cameras/ocleaCam/whiteBalance/pivotOcleaCamManualWhiteBalanceSample.json}  </br>",
           "properties": {
             "auto": {
               "description": "Enable/Disable auto white balance mode. 4K UHD only supports red & blue channels.  </br>",

package/dist/types/core/index.js

@@ -157,7 +157,6 @@ exports.ERROR_MESSAGES = (_a = {},
     _a[ErrorCode.Unauthorized403] = "Unauthorized to perform this action.",
     _a[ErrorCode.ServiceUnavailable503] = "Service is currently unavailable for communication.",
     _a[ErrorCode.ServerError500] = "Something went wrong on the other end...",
-    _a[ErrorCode.ServiceUnavailable503] = "The communicating device is unavailable",
     _a[ErrorCode.NotAccepted405] = "This payload cannot be sent for this request type",
     _a[ErrorCode.SystemUpdateError519] = "Error with system updating.",
     _a);

package/dist/types/devices/cameras/dtCam/index.d.ts

@@ -1,6 +1,6 @@
 import { Camera, DeviceModel } from "../..";
 /**
- * {@link IdtCam | 📖 See extended definition}
+ * {@link IDtCam | 📖 See extended definition}
  *
  *  📷 DT Cam
  *
@@ -12,32 +12,10 @@ export type DTCam = {
      *
      * @remarks Either {@link DTCam.contrast} or {@link DTCam.saturation}, but not both.
      *
-     *
      * ### Example Payload (Standard 1080p Camera)
-     *
-     * #### Contrast Samples (A150)
-     * ##### A150 at Contrast Level Max
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/contrast/a150DTCamContrastMaxSample.json}
-     *
-     * ##### A150 at Contrast Level Min
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/contrast/a150DTCamContrastMinSample.json}
-     *
-     * ##### A150 at Contrast Level Random
+     * #### Contrast Samples (A150/A200)
      * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/contrast/a150DTCamContrastRandomSample.json}
-     *
-     * #### Contrast Samples (A200)
-     * ##### A200 at Contrast Level Max
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/contrast/a200DTCamContrastMaxSample.json}
-     *
-     * ##### A200 at Contrast Level Min
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/contrast/a200DTCamContrastMinSample.json}
-     *
-     * ##### A200 at Contrast Level Random
-     * {@/codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/contrast/a200DTCamContrastRandomSample.json}
-     *
      * <br />
-     * <br />
-     *
      * @minimum 0
      * @maximum 100
      */
@@ -45,30 +23,9 @@ export type DTCam = {
     /** 💡 Camera Brightness
      *
      * ### Example Payload (Standard 1080p Camera)
-     *
-     * #### Brightness Samples (A150)
-     * ##### A150 at Max Brightness
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/brightness/a150DTCamBrightnessMaxSample.json}
-     *
-     * ##### A150 at Min Brightness
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/brightness/a150DTCamBrightnessMinSample.json}
-     *
-     * ##### A150 at Random Brightness
+     * #### Brightness Samples (A150/A200)
      * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/brightness/a150DTCamBrightnessRandomSample.json}
-     *
-     * #### Brightness Samples (A200)
-     * ##### A200 at Max Brightness
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/brightness/a200DTCamBrightnessMaxSample.json}
-     *
-     * ##### A200 at Min Brightness
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/brightness/a200DTCamBrightnessMinSample.json}
-     *
-     * ##### A200 at Random Brightness
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/brightness/a200DTCamBrightnessRandomSample.json}
-     *
-     * <br />
      * <br />
-     *
      * @minimum 0
      * @maximum 100
      */
@@ -76,32 +33,61 @@ export type DTCam = {
     /** 🎨 Camera Saturation
      *
      * ### Example Payload (Standard 1080p Camera)
+     * #### Saturation Samples (A150/A200)
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/saturation/a150DTCamSaturationRandomSample.json}
+     * <br />
+     * @minimum 0
+     * @maximum 100
+     */
+    saturation?: number;
+    /** White Balance
      *
-     * #### Saturation Samples (A150)
-     * ##### A150 at Saturation Level Max
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/saturation/a150DTCamSaturationMaxSample.json}
+     * ####  White Balance Sample (A150/A200)
+     * ##### Auto White Balance
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/whiteBalance/a150DTCamAutoWhiteBalanceSample.json}
      *
-     * ##### A150 at Saturation Level Min
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/saturation/a150DTCamSaturationMinSample.json}
+     * ##### Manual White Balance
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/whiteBalance/a150DTCamManualWhiteBalanceSample.json}
      *
-     * ##### A150 at Saturation Level Random
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a150/cameras/dtCam/saturation/a150DTCamSaturationRandomSample.json}
+     * #### White Balance Samples (Pivot)
+     * ##### Auto White Balance
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/pivot/cameras/DTCam/whiteBalance/pivotDTCamAutoWhiteBalanceSample.json}
      *
-     * #### Saturation Samples (A200)
-     * ##### A200 at Saturation Level Max
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/saturation/a200DTCamSaturationMaxSample.json}
+     * ##### Manual White Balance
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/pivot/cameras/DTCam/whiteBalance/pivotDTCamManualWhiteBalanceSample.json}
      *
-     * ##### A200 at Saturation Level Min
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/saturation/a200DTCamSaturationMinSample.json}
+     * ####  White Balance Samples (Revolution)
+     * ##### Auto White Balance
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cameras/DTCam/whiteBalance/revolutionDTCamAutoWhiteBalanceSample.json}
      *
-     * ##### A200 at Saturation Level Random
-     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/a200/cameras/dtCam/saturation/a200DTCamSaturationRandomSample.json}
+     * ##### Manual White Balance
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cameras/DTCam/whiteBalance/revolutionDTCamManualWhiteBalanceSample.json}
      *
-     * <br />
-     * <br />
      *
-     * @minimum 0
-     * @maximum 100
+     * </br>
      */
-    saturation?: number;
+    whiteBalance?: {
+        /** Enable/Disable auto white balance mode.
+         * </br>
+        */
+        auto?: boolean;
+        /** Red Control
+         * </br>
+         * @minimum 0
+         * @maximum 100
+        */
+        red?: number;
+        /** Blue Control
+         * </br>
+         * @minimum 0
+         * @maximum 100
+        */
+        blue?: number;
+        /** Green Control
+         * </br>
+         * @minimum 0
+         * @maximum 100
+        */
+        green?: number;
+    };
 } & Camera;

package/dist/types/devices/cameras/ocleaCam/index.d.ts

@@ -21,7 +21,7 @@ export type OcleaCam = Camera & {
      *
      * #### Saturation Sample (Revolution/Pivot)
      * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cameras/ocleaCam/saturation/revolutionOcleaCamSaturationSample.json}
-     * </br>     *
+     * </br>
      * @minimum 0
      * @maximum 100
      */
@@ -41,9 +41,13 @@ export type OcleaCam = Camera & {
      * ##### Auto White Balance
      * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cameras/ocleaCam/whiteBalance/revolutionOcleaCamAutoWhiteBalanceSample.json}
      *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/pivot/cameras/ocleaCam/whiteBalance/pivotOcleaCamAutoWhiteBalanceSample.json}
+     *
      * ##### Manual White Balance
      * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/revolution/cameras/ocleaCam/whiteBalance/revolutionOcleaCamManualWhiteBalanceSample.json}
-     *  </br>
+     *
+     * {@codeblock ~~/dist/samples/generated/requests/devices/vehicles/pivot/cameras/ocleaCam/whiteBalance/pivotOcleaCamManualWhiteBalanceSample.json}
+     * </br>
     */
     whiteBalance?: {
         /** Enable/Disable auto white balance mode. 4K UHD only supports red & blue channels.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deeptrekker/api-domain",
-    "version": "0.41.0",
+    "version": "0.43.0",
     "description": "A business domain of types and schemas that the DeepTrekker topside communicates with via an API.",
     "main": "dist/index.js",
     "files": [

package/readme.md

@@ -359,6 +359,18 @@ continue to live on.
 
     > 💡 We refer to this channel as the **video channel**.
 
+    -   How to request a camera stream
+
+        Locate the Camera section in the API and identify the camera you want to
+        request the camera stream from. Additionally, there will be multiple
+        streams under each camera. Each
+        [stream](https://docs.api.deeptrekker.com/modules.html#Stream) property
+        has an active property. By setting the active property to true for a
+        desired stream, a new video channel will be created with a stream ID
+        matching the camera ID. This will request a camera stream from the
+        vehicle. Set the active property of the previous camera stream to false
+        to decrease bandwith consumption.
+
 -   **Data Channel**
 
     Another data channel exists which conveys our API messages between the