-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(dfu-update): add DfuUpdate Plugin Wrapper (#3514)
* feat(dfu-update): add DfuUpdate Plugin Wrapper * repo url changed * updateFirmware options are now presented via Object * import fixed
- Loading branch information
1 parent
13f6da6
commit 07d7ace
Showing
1 changed file
with
66 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
import { Injectable } from '@angular/core'; | ||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core'; | ||
import { Observable } from 'rxjs'; | ||
|
||
export interface UpdateOptions { | ||
/** | ||
* A string that contains the identifier for the Bluetooth LE device to update. It will either be a MAC address (on Android) or a UUID (on iOS). | ||
*/ | ||
deviceId: string; | ||
|
||
/** | ||
* A string that is the path to the file to use in the update. It can be either in either `cdvfile://` or `file://` format. | ||
*/ | ||
fileUrl: string; | ||
|
||
/** | ||
* The PacketReceiptNotificationsValue (Default to 10) | ||
*/ | ||
packetReceiptNotificationsValue?: number; | ||
} | ||
|
||
/** | ||
* @name Dfu Update | ||
* @description | ||
* This plugin is a Wrapper to use Nordic Semiconductor's Device Firmware Update (DFU) service to update a Bluetooth LE device. | ||
* | ||
* @usage | ||
* ```typescript | ||
* import { DfuUpdate } from '@ionic-native/dfu-update/ngx'; | ||
* | ||
* | ||
* constructor(private dfuUpdate: DfuUpdate) { } | ||
* | ||
* ... | ||
* | ||
* | ||
* this.dfuUpdate.updateFirmware('fileURL', 'deviceIdentifier') | ||
* .then((res: any) => console.log(res)) | ||
* .catch((error: any) => console.error(error)); | ||
* | ||
* ``` | ||
*/ | ||
@Plugin({ | ||
pluginName: 'DfuUpdate', | ||
plugin: 'cordova-plugin-dfu-update', | ||
pluginRef: 'window.DfuUpdate', | ||
repo: 'https://github.com/EinfachHans/cordova-plugin-dfu-update', | ||
install: 'ionic cordova plugin add cordova-plugin-dfu-update --variable ANDROID_NORDIC_VERSION="1.11.0"', | ||
installVariables: ['ANDROID_NORDIC_VERSION'], | ||
platforms: ['Android', 'iOS'], | ||
}) | ||
@Injectable() | ||
export class DfuUpdate extends IonicNativePlugin { | ||
/** | ||
* Start the Firmware-Update-Process | ||
* @param options - Options for the process | ||
* @return {Observable<any>} Returns a Observable that emits when something happens | ||
*/ | ||
@Cordova({ | ||
observable: true, | ||
callbackOrder: 'reverse', | ||
}) | ||
updateFirmware(options: UpdateOptions): Observable<any> { | ||
return; | ||
} | ||
} |