@getquip/expo-nordic-dfu 0.1.0

package/.eslintrc.js

@@ -0,0 +1,2 @@
+// @generated by expo-module-scripts
+module.exports = require('expo-module-scripts/eslintrc.base.js');

package/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+*       @getquip/ecomm

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/workflows/actionlint.yml

@@ -0,0 +1,21 @@
+name: Actionlint
+on:
+  pull_request:
+concurrency:
+  group: actionlint-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        uses: actions/checkout@v4
+      -
+        name: Download actionlint
+        id: get_actionlint
+        shell: bash
+        run: bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash)
+      -
+        name: Check Workflow Files
+        shell: bash
+        run: ${{ steps.get_actionlint.outputs.executable }} -color -verbose

package/.nvmrc

@@ -0,0 +1 @@
+20.19.1

package/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributor License Agreement (CLA)
+
+Thank you for your interest in contributing to this project.
+
+To protect the interests of the project and its users, contributors must agree to the following terms before their contributions can be accepted.
+
+## Agreement
+
+By submitting code, documentation, or other content (a “Contribution”) to this project, you agree that:
+
+1. **You are legally permitted to contribute.** You affirm that your Contribution is your original work, or that you have the necessary rights to submit it. If you are submitting on behalf of an organization or employer, you confirm you are authorized to do so.
+
+2. **You grant a license to use your Contribution.** You grant quip NYC, Inc. a perpetual, worldwide, royalty-free, irrevocable license to use, copy, modify, publish, and distribute your Contribution as part of this project and derivative works, under any license.
+
+3. **You make no warranties.** You provide your Contribution "as is," without warranties or conditions of any kind, either express or implied.
+
+By submitting a pull request or other Contribution, you agree to the terms of this CLA.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Pilloxa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,108 @@
+# Expo Nordic DFU
+
+*Note*: First release is not out yet!
+
+This project was highly inspired by the original React Native project at [Pilloxa/react-native-nordic-dfu](https://github.com/Pilloxa/react-native-nordic-dfu). We continued the work so it functions with modern [Expo](http://expo.dev/) projects that use [Expo Modules](https://docs.expo.dev/modules/overview/).
+
+This module allows you to perform a Secure Device Firmware Update (DFU) for Nordic Semiconductors on Expo React Native bridgeless projects. It wraps the official libraries at [NordicSemiconductor/Android-DFU-Library](https://github.com/NordicSemiconductor/Android-DFU-Library) and [NordicSemiconductor/IOS-DFU-Library](https://github.com/NordicSemiconductor/IOS-DFU-Library). This will not support Legacy DFU out of the box!
+
+Our intention is to maintain this code for modern Expo projects only. We will not officially support old Expo SDKs or old Nordic SDKs. Please keep in mind the our availability to maintain is limited and is based on our project needs.
+
+This project does not provide an interface for scanning/connecting devices via BLE. Check the example app for libraries that can do that.
+
+## Requirements
+
+- Nordic zip firmware file
+- Android 14 or 15
+- iOS 17 or 18
+- Expo SDK 52
+- React Native Bridgeless (new architecture) enabled
+
+## Usage
+
+Please checkout the [example app](example)!
+
+### Bluetooth permissions
+
+You need the various Bluetooth permission enabled on Expo project. If you use a Bluetooth management library like [react-native-ble-manager](https://github.com/innoveit/react-native-ble-manager), this might be done for you. For android, you also need Foreground services enabled for the DFU process.
+
+```typescript
+// Expo app.json
+
+// Android
+expo.android.permissions: [
+  "android.permission.FOREGROUND_SERVICE",
+  "android.permission.FOREGROUND_SERVICE_CONNECTED_DEVICE",
+  "android.permission.BLUETOOTH",
+  "android.permission.BLUETOOTH_SCAN", // You might need to set "neverForLocation"
+  "android.permission.BLUETOOTH_ADMIN",
+  "android.permission.BLUETOOTH_CONNECT"
+]
+
+// iOS
+expo.ios.infoPlist: [
+  "NSBluetoothAlwaysUsageDescription": "Uses Bluetooth to connect to Bluetooth enabled device.",
+  "NSBluetoothPeripheralUsageDescription": "Uses Bluetooth to connect to Bluetooth enabled device.",
+]
+```
+
+### Listeners
+
+The listeners work mostly the same as the original @ [Pilloxa/react-native-nordic-dfu](https://github.com/Pilloxa/react-native-nordic-dfu)
+
+- `DFUProgress`: Reports back progress and extra values like upload speed
+- `DFUStateChanged`: Reports back when major DFU flow miletones happen. It will also tell you if the DFU finished, failed or was aborted
+
+```typescript
+ExpoNordicDfu.module.addListener('DFUProgress', (progress) => {
+  console.info('DFUProgress:', progress)
+})
+ExpoNordicDfu.module.addListener('DFUStateChanged', ({ state }) => {
+  console.info('DFUStateChanged:', state)
+})
+```
+
+### DFU
+
+Starting a DFU operation is simple. Setup your listeners (see above) then call
+
+```typescript
+await ExpoNordicDfu.startDfu({
+  deviceAddress,
+  fileUri,
+  // There are many optional parameters and some are OS-specific
+  // ...,
+  // android: {
+  //   ...
+  // },
+  // ios: {
+  //   ...
+  // },
+})
+```
+
+Refer to the base Nordic DFU library to understand how the optional parameters works
+
+[IOS-DFU-Library documentation](https://nordicsemiconductor.github.io/IOS-DFU-Library/documentation/nordicdfu/dfuserviceinitiator)
+
+[Android-DFU-Library documentation](https://nordicsemiconductor.github.io/Android-DFU-Library/html/lib/dfu/no.nordicsemi.android.dfu/-dfu-service-initiator/index.html)
+
+### Example App
+
+[Example App](example)
+
+```bash
+cd example
+cp .env.example .env
+# Fill in your .env as needed
+npm install
+npx expo prebuild --clean # Run this on first setup and whenever you change native files
+# Android
+npx expo run:android --device
+# iOS
+npx expo run:ios --device
+```
+
+## Contributing
+
+Before we can accept a pull request from you, you'll need to read and agree to our [Contributor License Agreement (CLA)](https://github.com/getquip/expo-nordic-dfu/blob/main/CONTRIBUTING.md).

package/android/.gradle/buildOutputCleanup/cache.properties

@@ -0,0 +1,2 @@
+#Fri Apr 25 09:20:46 CDT 2025
+gradle.version=8.9

package/android/.gradle/config.properties

@@ -0,0 +1,2 @@
+#Mon Apr 21 13:03:26 CDT 2025
+java.home=/Applications/Android Studio.app/Contents/jbr/Contents/Home

package/android/.idea/AndroidProjectSystem.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AndroidProjectSystem">
+    <option name="providerId" value="com.android.tools.idea.GradleProjectSystem" />
+  </component>
+</project>