Deep Trekker BRIDGE API - v1.0.3
    Preparing search index...

    Type Alias SWUpdate

    SWUpdate

    An endpoint to facilitate the software update process.

    type SWUpdate = {
        file?: FileTransfer;
        log?: string;
        offlineUpdates?: OfflineUpdateState;
        progress?: number;
        releaseInfo?: string;
    }
    Index

    Properties

    file? log? offlineUpdates? progress? releaseInfo?

    Properties

    file?: FileTransfer

    File

    Define the update package tar file to be transferred.

    log?: string

    Log

    Provides messages driven by state of the update. WebApp may choose to display these messages as they are delivered.

    offlineUpdates?: OfflineUpdateState

    Description

    Informs user of the current state of offline updates. User can also set this state to start offline updates or check for available ones.

    JSON Examples

    {
      "apiVersion": "1.0.0",
      "method": "UPDATE",
      "payload": {
        "swupdate": {
          "offlineUpdates": 1
        }
      }
    }

    {
      "apiVersion": "1.0.0",
      "method": "UPDATE",
      "payload": {
        "swupdate": {
          "offlineUpdates": 1
        }
      }
    }

    {
      "apiVersion": "1.0.0",
      "method": "SET",
      "payload": {
        "swupdate": {
          "offlineUpdates": 4
        }
      }
    }
    progress?: number

    Progress

    Percentage complete indicator.

    0

    100

    releaseInfo?: string

    ReleaseInfo

    Returns a valid stringified JSON that contains a map of device models to their latest available versions. These latest versions could be the same as the current versions of the robot/peripherals in which case, there would be no available update.

    Settings

    Member Visibility

    On This Page

    Properties