groundsdk 7.7.2 API/com.parrot.drone.groundsdk.device.peripheral/Updater

Updater

interface Updater : Peripheral

Updater peripheral interface for Drone and RemoteControl devices.

Allows to:

  • list and download available updates for the device from remote server.
  • list locally available updates and apply them to the connected device
This peripheral is always available even when the device is not connected, so that remote firmware updates may be downloaded at all times (unless internet connection is unavailable).

Updating requires the device to be connected; however, this peripheral provides the ability to apply several firmware updates in a row (mainly used in the presence of trampoline updates), and will maintain proper state across device reboot/reconnection after each update is applied.

This peripheral can be obtained from a peripheral providing device (such as a drone or a remote control) using: 

device.getPeripheral(Updater.class)
Content copied to clipboard

See also

Peripheral.Provider

Types

Link copied to clipboard
abstract class Download
Ongoing firmware download state and progress.
Link copied to clipboard
abstract class Update
Ongoing firmware update state and progress.

Functions

Link copied to clipboard
@NonNull
abstract fun applicableFirmwares(): List<FirmwareInfo>
Lists all firmwares that require to be applied to update the device to the latest available version.
Link copied to clipboard
abstract fun cancelDownload(): Boolean
Cancels an ongoing firmware(s) download operation.
Link copied to clipboard
abstract fun cancelUpdate(): Boolean
Cancels an ongoing firmware(s) update operation.
Link copied to clipboard
@Nullable
abstract fun currentDownload(): Updater.Download
Gives current firmware download operation state, if any is ongoing.
Link copied to clipboard
@Nullable
abstract fun currentUpdate(): Updater.Update
Gives current firmware update operation state, if any is ongoing.
Link copied to clipboard
@NonNull
abstract fun downloadableFirmwares(): List<FirmwareInfo>
Lists all firmwares that require to be downloaded to update the device to the latest available version.
Link copied to clipboard
abstract fun downloadAllFirmwares(): Boolean
Requests download of all downloadable firmware that should be applied to update the device to the latest available version.
Link copied to clipboard
abstract fun downloadNextFirmware(): Boolean
Requests download of the next downloadable firmware that should be applied to update the device towards the latest available version.
Link copied to clipboard
@NonNull
abstract fun downloadUnavailabilityReasons(): EnumSet<Updater.Download.UnavailabilityReason>
Tells why it is currently impossible to download remote firmwares.
Link copied to clipboard
@Nullable
abstract fun idealVersion(): FirmwareVersion
Retrieves the ideal version.
Link copied to clipboard
open fun isUpToDate(): Boolean
Tells whether the device is currently up-to-date.
Link copied to clipboard
abstract fun updateToLatestFirmware(): Boolean
Requests device update to the latest applicable firmware version.
Link copied to clipboard
abstract fun updateToNextFirmware(): Boolean
Requests device update to the next currently applicable firmware version.
Link copied to clipboard
@NonNull
abstract fun updateUnavailabilityReasons(): EnumSet<Updater.Update.UnavailabilityReason>
Tells why it is currently impossible to apply firmware updates.