IBattery | Deep Trekker BRIDGE API

notexported

See type declaration

🔋 Battery

Hierarchy

Battery
- IBattery

Index

Properties

Optional charging

charging?: boolean

Battery charging state

description: Represents whether the battery is being charged or not

Optional diagnostics

diagnostics?: BatteryDiagnostics

Optional leak

leak?: boolean

Optional percent

percent?: number

Battery charge percentage

minimum: 0
maximum: 100
tjs-type: integer

Optional resetChargeCycles

resetChargeCycles?: boolean

Battery charge cycles reset

description

exposes a control to reset charge cycles on supported batteries.

A200 Crawler sample request to reset battery charge cycles.

From ./dist/samples/json/requests/devices/vehicles/a200/battery/resetChargeCycles/a200BatteryResetChargeCyclesSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "C867AC98DE54": {
                "model": 19,
                "battery": {
                    "resetChargeCycles": true
                }
            }
        }
    }
}

A150 Crawler sample request to reset battery charge cycles.

From ./dist/samples/json/requests/devices/vehicles/a150/battery/resetChargeCycles/a150BatteryResetChargeCyclesSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "3CFA0B5944A3": {
                "model": 20,
                "battery": {
                    "resetChargeCycles": true
                }
            }
        }
    }
}

Optional voltage

voltage?: number

Battery voltage