-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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'; | ||
* | ||
* | ||
* 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; | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add
/ngx
to the import