mirror of
https://github.com/thegecko/web-bluetooth-dfu.git
synced 2025-12-13 12:38:13 +08:00
101 lines
4.9 KiB
Markdown
101 lines
4.9 KiB
Markdown
# Web Bluetooth DFU
|
|
|
|
[](https://circleci.com/gh/thegecko/web-bluetooth-dfu)
|
|
[](http://bower.io/search/?q=web-bluetooth-dfu)
|
|
[](https://www.npmjs.com/package/web-bluetooth-dfu)
|
|
[](http://opensource.org/licenses/MIT)
|
|
|
|
Update device firmware via Nordic's DFU protocols using [Web Bluetooth](https://webbluetoothcg.github.io/web-bluetooth/).
|
|
|
|
## Versions
|
|
|
|
Since version 12 of Nordic's SDK, the device firmware update protocol has changed to be made secure. The protocol can be seen here:
|
|
|
|
http://infocenter.nordicsemi.com/topic/com.nordic.infocenter.sdk5.v12.0.0/lib_dfu_transport_ble.html
|
|
|
|
Earlier protocols were insecure, so it is recommended to use the secure protocol version in this package.
|
|
|
|
## Features
|
|
|
|
- Supports continuation of failed transfers and skipping of any init packet if already valid
|
|
- Supports [Buttonless DFU](http://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.sdk5.v13.0.0%2Fble_sdk_app_buttonless_dfu.html) activation
|
|
- Uses ES6 syntax assuming that all JS engines supporting Web Bluetooth are also ES6 compatible
|
|
- Written with [TypeScript](https://www.typescriptlang.org/) to promote type safety
|
|
|
|
## Live Example
|
|
|
|
This repo has a live web example of the secure DFU. Open this site in a [Web Bluetooth](https://webbluetoothcg.github.io/web-bluetooth/) enabled browser:
|
|
|
|
https://thegecko.github.io/web-bluetooth-dfu/
|
|
|
|
- Supports drag-and-drop or uploading of firmware packages
|
|
- Supports unzipping of the firmware package in-browser
|
|
- Supports multiple firmware images in a single package (softdevice, bootloader, application)
|
|
|
|
## Prerequisites
|
|
|
|
[Node.js > v4.8.0](https://nodejs.org), which includes `npm`.
|
|
|
|
## Installation
|
|
|
|
The package is distributed using npm. To install the package in your project:
|
|
|
|
$ npm install web-bluetooth-dfu
|
|
|
|
## Device Configuration
|
|
|
|
You will need a [Nordic](http://www.nordicsemi.com/) [nRF51822](http://www.nordicsemi.com/eng/Products/nRF51-DK), [nRF52832](http://www.nordicsemi.com/eng/Products/Bluetooth-low-energy/nRF52-DK) or [nRF52840](http://www.nordicsemi.com/eng/Products/nRF52840-Preview-DK) development kit running the latest softdevice. Secure DFU supports softdevices from S130.
|
|
|
|
Softdevices can be found on Nordic's site:
|
|
|
|
- [S130](http://www.nordicsemi.com/eng/Products/S130-SoftDevice) (for nRF51)
|
|
- [S132](http://www.nordicsemi.com/eng/Products/S132-SoftDevice) (for nRF52)
|
|
- [S140](http://www.nordicsemi.com/eng/Products/S140-SoftDevice) (for nRF52)
|
|
|
|
Upon flashing the device will be in bootloader mode and ready to receive a DFU transfer.
|
|
|
|
Example packages to update can be found in the [firmware](https://github.com/thegecko/web-bluetooth-dfu/tree/master/firmware) folder.
|
|
|
|
## Device Development
|
|
|
|
An excellent article exists with a walkthrough of using the device firmware update here:
|
|
|
|
https://devzone.nordicsemi.com/blogs/1085/getting-started-with-nordics-secure-dfu-bootloader/
|
|
|
|
tl;dr
|
|
|
|
__Download / Install__
|
|
- Download [Nordic SDK](https://developer.nordicsemi.com/nRF5_SDK/)
|
|
- Install [J-Link Software Package](https://www.segger.com/downloads/jlink)
|
|
- Install [nRF5x Command Line Tools](https://www.nordicsemi.com/eng/Products/nRF52840#Downloads) (includes nrfjprog)
|
|
- Install __nrfutil__: `$ pip install nrfutil`
|
|
|
|
__Flashing SoftDevice__
|
|
- Erase the chip: `$ nrfjprog --family NRF52 --eraseall`
|
|
- Grab the relevant softdevice from website (links above) or the SDK (components/softdevice/\<SoftDevice\>/hex)
|
|
- Flash the softdevice: `$ nrfjprog --family NRF52 --program <softdevice.hex> --sectorerase --reset`
|
|
|
|
__Using Test DFU Bootloader__
|
|
- Grab the relevant bootloader from the SDK (examples/dfu/bootloader_secure_ble/\<chip\>/hex)
|
|
- Flash the bootloader: `$ nrfjprog --family NRF52 --program <bootloader.hex> --sectoranduicrerase --reset`
|
|
|
|
__Signing Keys__
|
|
- Create a [signing key](http://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.sdk5.v13.0.0%2Fble_sdk_app_buttonless_dfu.html): `$ nrfutil keys generate private.key`
|
|
- Generate the __.c__ file for the key: `$ nrfutil keys display --key pk --format code private.key --out_file dfu_public_key.c`
|
|
|
|
__Developing an Application__
|
|
- Ensure you have a machine with relevant build tools such as `gcc`, linux is easiest
|
|
- Rebuild the bootloader with your new key (Update the Makefile to use your new key file)
|
|
- Flash the bootloader: `$ nrfjprog --family NRF52 --program <bootloader.hex> --sectoranduicrerase --reset`
|
|
- Build your application using your new key file
|
|
|
|
__Building DFU Package__
|
|
|
|
Refer to this document:
|
|
|
|
http://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.sdk5.v13.0.0%2Fble_sdk_app_dfu_bootloader.html
|
|
|
|
e.g.:
|
|
|
|
$ nrfutil pkg generate --debug-mode --application <your_app.hex> --key-file private.key dfu_app.zip
|