ICalibratable | Deep Trekker BRIDGE API

notexported

Calibratable

Example Payload

Calibration samples

Powered Reel Calibrate Sample

From ./dist/samples/json/requests/devices/reels/manualReels/calibration/manualReelCalibratorCalibrateSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "SET",
    "payload": {
        "devices": {
            "29A9AD7F7119": {
                "model": 107,
                "calibrator": false
            }
        }
    }
}

Manual Reel Cancel Sample

From ./dist/samples/json/requests/devices/reels/manualReels/calibration/manualReelCalibratorCancelSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "SET",
    "payload": {
        "devices": {
            "B0654AB4A87B": {
                "model": 107,
                "calibrator": false
            }
        }
    }
}

Manual Reel Failed Sample

From ./dist/samples/json/requests/devices/reels/manualReels/calibration/manualReelCalibratorFailedSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "SET",
    "payload": {
        "devices": {
            "F3E1FA29C215": {
                "model": 107,
                "calibrator": false
            }
        }
    }
}

Manual Reel Succeed Sample

From ./dist/samples/json/requests/devices/reels/manualReels/calibration/manualReelCalibratorSucceededSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "SET",
    "payload": {
        "devices": {
            "B6BC3E583AF2": {
                "model": 107,
                "calibrator": true
            }
        }
    }
}

Powered Reel Calibrate arbitrary Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/calibrator/poweredReelCalibratorRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F6DAF2E0DA7B": {
                "model": 108,
                "calibrator": false
            }
        }
    }
}

Powered Reel is not Calibrating Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/calibrator/poweredReelIsNotCalibratingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "8A1095713196": {
                "model": 108,
                "calibrator": false
            }
        }
    }
}

Powered Reel is Calibrating Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/calibrator/poweredReelIsCalibratingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "E547C0A0A950": {
                "model": 108,
                "calibrator": true
            }
        }
    }
}

Hierarchy

Calibratable
- ICalibratable

Index

Properties

calibrator

Properties

Optional calibrator

calibrator?: boolean

Calibrator

Calibrator	Front-end (request)	Back-end (response)
`true`	Calibrate	-
`false`	Cancel Calibration	-
`undefined`	-	-