zephyr-dfu

This Capacitor plugin provides an implementation of the McuManager protocol supported by Zephyr.

It is based on the following libraries:

Android: https://github.com/NordicSemiconductor/Android-nRF-Connect-Device-Manager

iOS: https://github.com/NordicSemiconductor/IOS-nRF-Connect-Device-Manager

Install

npm install zephyr-dfu
npx cap sync

Any questions? Mail me at: [email protected]

API

• updateFirmware(...)
• getVersion(...)
• Interfaces
• Type Aliases

updateFirmware(...)

updateFirmware(options: { fileURL: string; deviceIdentifier: string; }, callback: firmwareUpdateCallback) => Promise<CallbackID>

| Param | Type | | -------------- | ------------------------------------------------------------------------- | | options | { fileURL: string; deviceIdentifier: string; } | | callback | firmwareUpdateCallback |

Returns: Promise<string>

getVersion(...)

getVersion(options: { deviceIdentifier: string; }) => Promise<string>

| Param | Type | | ------------- | ------------------------------------------ | | options | { deviceIdentifier: string; } |

Returns: Promise<string>

Interfaces

String

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

| Prop | Type | Description | | ------------ | ------------------- | ------------------------------------------------------------ | | length | number | Returns the length of a String object. |

| Method | Signature | Description | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | | toString | () => string | Returns a string representation of a string. | | charAt | (pos: number) => string | Returns the character at the specified index. | | charCodeAt | (index: number) => number | Returns the Unicode value of the character at the specified location. | | concat | (...strings: string[]) => string | Returns a string that contains the concatenation of two or more strings. | | indexOf | (searchString: string, position?: number | undefined) => number | Returns the position of the first occurrence of a substring. | | lastIndexOf | (searchString: string, position?: number | undefined) => number | Returns the last occurrence of a substring in the string. | | localeCompare | (that: string) => number | Determines whether two strings are equivalent in the current locale. | | match | (regexp: string | RegExp) => RegExpMatchArray | null | Matches a string with a regular expression, and returns an array containing the results of that search. | | replace | (searchValue: string | RegExp, replaceValue: string) => string | Replaces text in a string, using a regular expression or search string. | | replace | (searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string) => string | Replaces text in a string, using a regular expression or search string. | | search | (regexp: string | RegExp) => number | Finds the first substring match in a regular expression search. | | slice | (start?: number | undefined, end?: number | undefined) => string | Returns a section of a string. | | split | (separator: string | RegExp, limit?: number | undefined) => string[] | Split a string into substrings using the specified separator and return them as an array. | | substring | (start: number, end?: number | undefined) => string | Returns the substring at the specified location within a String object. | | toLowerCase | () => string | Converts all the alphabetic characters in a string to lowercase. | | toLocaleLowerCase | (locales?: string | string[] | undefined) => string | Converts all alphabetic characters to lowercase, taking into account the host environment's current locale. | | toUpperCase | () => string | Converts all the alphabetic characters in a string to uppercase. | | toLocaleUpperCase | (locales?: string | string[] | undefined) => string | Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale. | | trim | () => string | Removes the leading and trailing white space and line terminator characters from a string. | | substr | (from: number, length?: number | undefined) => string | Gets a substring beginning at the specified location and having the specified length. | | valueOf | () => string | Returns the primitive value of the specified object. |

RegExpMatchArray

| Prop | Type | | ----------- | ------------------- | | index | number | | input | string |

RegExp

| Prop | Type | Description | | ---------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | source | string | Returns a copy of the text of the regular expression pattern. Read-only. The regExp argument is a Regular expression object. It can be a variable name or a literal. | | global | boolean | Returns a Boolean value indicating the state of the global flag (g) used with a regular expression. Default is false. Read-only. | | ignoreCase | boolean | Returns a Boolean value indicating the state of the ignoreCase flag (i) used with a regular expression. Default is false. Read-only. | | multiline | boolean | Returns a Boolean value indicating the state of the multiline flag (m) used with a regular expression. Default is false. Read-only. | | lastIndex | number | |

| Method | Signature | Description | | ----------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | exec | (string: string) => RegExpExecArray | null | Executes a search on a string using a regular expression pattern, and returns an array containing the results of that search. | | test | (string: string) => boolean | Returns a Boolean value that indicates whether or not a pattern exists in a searched string. | | compile | () => this | |

RegExpExecArray

| Prop | Type | | ----------- | ------------------- | | index | number | | input | string |

Type Aliases

firmwareUpdateCallback

(msg: String | null, err?: any): void

CallbackID

string