Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICalibratable

notexported

📖 See type definition

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.5",
    "method": "SET",
    "payload": {
        "devices": {
            "AC914C2DBCD4": {
                "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.5",
    "method": "SET",
    "payload": {
        "devices": {
            "E1BB681BE5E0": {
                "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.5",
    "method": "SET",
    "payload": {
        "devices": {
            "6A35990EBBE8": {
                "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.5",
    "method": "SET",
    "payload": {
        "devices": {
            "BE64B784D66C": {
                "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.5",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "2F8449236D7E": {
                "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.5",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "52C6AD6E777B": {
                "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.5",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "0FD3A8944C91": {
                "model": 108,
                "calibrator": true
            }
        }
    }
}

Hierarchy

Index

Properties

Properties

Optional calibrator

calibrator?: boolean

Calibrator

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