Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(dfu-update): add DfuUpdate Plugin Wrapper #3514

Merged
merged 4 commits into from
Nov 19, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
66 changes: 66 additions & 0 deletions src/@ionic-native/plugins/dfu-update/index.ts
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;
}
}