mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-01-31 18:49:43 +08:00
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
This commit is contained in:
parent
13f6da69ef
commit
07d7ace97d
66
src/@ionic-native/plugins/dfu-update/index.ts
Normal file
66
src/@ionic-native/plugins/dfu-update/index.ts
Normal file
@ -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;
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user