npm package: @systemic-games/react-native-nordic-nrf5-dfu
Description: React Native package for running DFUs on Nordic Semiconductor nRF5 devices.
Author: Systemic Games
Latest version: 1.3.0

# react-native-nordic-nrf5-dfu

React Native package for running DFUs on Nordic Semiconductor nRF5 devices.

Inspired by Pilloxa [react-native-nordic-dfu](
    https://github.com/Pilloxa/react-native-nordic-dfu
) package.

Find the latest published version on [NPM](
  https://www.npmjs.com/package/@systemic-games/react-native-nordic-nrf5-dfu
).

## Installation

```sh
npm install @systemic-games/react-native-nordic-nrf5-dfu
```

Note: this package is using Nordic DFU libraries for [Android](
  https://github.com/NordicSemiconductor/Android-DFU-Library
) and [iOS](
  https://github.com/NordicSemiconductor/IOS-DFU-Library
).

## Usage

```js
import { startDfu } from "@systemic-games/react-native-nordic-nrf5-dfu";

async function uploadFirmware(
  firmwareZipPathname: string,
  deviceAddress: string,
  deviceName?: string
) {
  await startDfu(deviceAddress, firmwareZipPathname, {
    deviceName: deviceName,
    retries: 3,
    dfuStateListener: ({ state }) => console.log("DFU state:", state),
    dfuProgressListener: ({ percent }) => console.log("DFU progress:", percent),
  });
}
```

Android requires that you have `FOREGROUND_SERVICE` permissions.
You will need the following in your AndroidManifest.xml

```
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
```

## Development workflow

To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:

```sh
yarn
```

> While it's possible to use [`npm`](https://github.com/npm/cli), the tooling is built around [`yarn`](https://classic.yarnpkg.com/), so you'll have an easier time if you use `yarn` for development.

While developing, you can run the [example app](/example/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.

To start the packager:

```sh
yarn example start
```

To run the example app on Android:

```sh
yarn example android
```

To run the example app on iOS:

```sh
yarn example ios
```

Make sure your code passes TypeScript and ESLint. Run the following to verify:

```sh
yarn typescript
yarn lint
```

To fix formatting errors, run the following:

```sh
yarn lint --fix
```

Remember to add tests for your change if possible. Run the unit tests by:

```sh
yarn test
```

To edit the Objective-C files, open `example/ios/NordicNrf5DfuExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > react-native-nordic-nrf5-dfu`.

To edit the Kotlin files, open `example/android` in Android studio and find the source files at `reactnativenordicnrf5dfu` under `Android`.

### Commit message convention

We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:

- `fix`: bug fixes, e.g. fix crash due to deprecated method.
- `feat`: new features, e.g. add new method to the module.
- `refactor`: code refactor, e.g. migrate from class components to hooks.
- `docs`: changes into documentation, e.g. add usage example for the module..
- `test`: adding or updating tests, e.g. add integration tests using detox.
- `chore`: tooling changes, e.g. change CI config.

Our pre-commit hooks verify that your commit message matches this format when committing.

### Linting and tests

[ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)

We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.

Our pre-commit hooks verify that the linter and tests pass when committing.

### Publishing to npm

We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.

To publish new versions, run the following:

```sh
yarn release
```

### Scripts

The `package.json` file contains various scripts for common tasks:

- `yarn bootstrap`: setup project by installing all dependencies and pods.
- `yarn typescript`: type-check files with TypeScript.
- `yarn lint`: lint files with ESLint.
- `yarn test`: run unit tests with Jest.
- `yarn example start`: start the Metro server for the example app.
- `yarn example android`: run the example app on Android.
- `yarn example ios`: run the example app on iOS.

## License

MIT

---

Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)