@stoprocent/noble 1.10.2 → 1.10.4

package/.github/workflows/build.yml

@@ -0,0 +1,77 @@
+name: Build
+on:
+  push:
+    branches:
+      - master
+      - beta
+concurrency:
+  group: build-${{ github.ref }}
+  cancel-in-progress: false
+jobs:
+  prebuild:
+    strategy:
+      matrix:
+        include:
+          - name: darwin
+            os: macos-11  
+            node: x64
+            command: prebuildify
+            args: --arch x64+arm64 --target 18.0.0
+          - name: win32-x86
+            os: windows-2019
+            node: x86
+            command: prebuildify
+            args: --target 14.0.0
+          - name: win32-x64
+            os: windows-2019
+            node: x64
+            command: prebuildify
+            args: --target 14.0.0
+          - name: linux-x64
+            os: ubuntu-latest
+            command: prebuildify-cross
+            args: -i centos7-devtoolset7 -i alpine
+          - name: linux-arm
+            os: ubuntu-latest
+            command: prebuildify-cross
+            args: -i linux-arm64-lts -i linux-armv7 -i linux-armv6
+          - name: android-arm
+            os: ubuntu-latest
+            command: prebuildify-cross
+            args: -i android-arm64 -i android-armv7
+    name: Build ${{ matrix.name }}
+    runs-on: ${{ matrix.os }}
+    steps:
+      - if: matrix.node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          architecture: ${{ matrix.node }}
+      - uses: actions/checkout@v3
+      - run: npm ci
+      - run: npm run ${{ matrix.command }} -- ${{ matrix.args }}
+      - uses: actions/upload-artifact@v3
+        with:
+          name: build-artifacts
+          path: prebuilds/
+          if-no-files-found: error
+      - if: failure()
+        run: npx shx ls -lA
+  release:
+    needs: prebuild
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
+        with:
+          name: build-artifacts
+          path: prebuilds
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+      - run: npm ci
+      - run: npm run semantic-release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/nodepackage.yml

@@ -13,23 +13,14 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-18.04, ubuntu-latest, macos-latest, windows-2016]
-        node: [12, 14]
+        os: [ubuntu-20.04, ubuntu-latest, macos-latest, windows-2019]
+        node: [14, 16, 18, 20]
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
-      - name: Install dependencies (ubuntu-18.04)
-        # Use g++-4.8 only on 'ubuntu-18.04'
-        if: ${{ matrix.os == 'ubuntu-18.04' }}
-        run: |
-          sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
-          sudo apt -qq update
-          sudo apt install -y g++-4.8
-          export CC="g++-4.8"
       - name: Install dependencies (ubuntu-latest)
-        # Use g++-9 only on versions after 'ubuntu-18.04'
         if: ${{ matrix.os == 'ubuntu-latest' }}
         run: |
           sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
@@ -51,9 +42,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⬇️ Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: 💽 Setup nodejs
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: '14'
       - name: 📇 Use npm cache

package/README.md

@@ -1,5 +1,7 @@
 # ![noble](assets/noble-logo.png)
 
+[![npm version](https://badgen.net/npm/v/@abandonware/noble)](https://www.npmjs.com/package/@abandonware/noble)
+[![npm downloads](https://badgen.net/npm/dt/@abandonware/noble)](https://www.npmjs.com/package/@abandonware/noble)
 [![Build Status](https://travis-ci.org/abandonware/noble.svg?branch=master)](https://travis-ci.org/abandonware/noble)
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/abandonware/noble?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![OpenCollective](https://opencollective.com/noble/backers/badge.svg)](#backers)
 [![OpenCollective](https://opencollective.com/noble/sponsors/badge.svg)](#sponsors)
@@ -23,7 +25,7 @@ __Note:__ macOS / Mac OS X, Linux, FreeBSD and Windows are currently the only su
 ```javascript
 // Read the battery level of the first found peripheral exposing the Battery Level characteristic
 
-const noble = require('@abandonware/noble')({extended: false});
+const noble = require('@abandonware/noble');
 
 noble.on('stateChange', async (state) => {
   if (state === 'poweredOn') {
@@ -42,6 +44,12 @@ noble.on('discover', async (peripheral) => {
   await peripheral.disconnectAsync();
   process.exit(0);
 });
+```
+## Use Noble With BLE5 Extended Features With HCI 
+
+```javascript
+const noble = require('@abandonware/noble/with-custom-binding')({extended: true});
+
 ```
 
 ## Installation
@@ -60,27 +68,9 @@ noble.on('discover', async (peripheral) => {
 
 ### Prerequisites
 
-#### UART
-
-The reason for this fork was to create more universal transport that can work across multiple operating systems.
-Idea is to use Zephyr HCI over UART firmware and create noble driver to interface with HCI over UART.
-
-##### Known Issues
-What I have found so far that when using extended MTU and sending large amount of data Zephyr stops responding in rare cases. I have played with Zephyr configuration parameters in order to increase buffer sizes but with some luck. Sometimes when transfering fast, large payloads, with high MTU you can still hit the limit and Zephyr needs to be rebooted.
-
-##### How to use this?
+#### UART (Any OS)
 
-1. You will need NRF5x module (e.g. nRF52840 PDK)
-2. 	If you have `nRF52840 PDK` you can in fact just use compiled HEX [misc/nrf52840dk.hex](misc/nrf52840dk.hex) (Buad Rate set to `1000000`)
-3. If you want to compile it yourself:
-	1. You will need to install Zephyr ([https://docs.zephyrproject.org/latest/getting_started/index.html](https://docs.zephyrproject.org/latest/getting_started/index.html))
-	2. Compile HCI UART Example - `west build -p auto -b <your-board-name> zephyr/samples/bluetooth/hci_uart`
-		- e.g. When using `nRF52840 PDK` call `west build -p auto -b nrf52840dk_nrf52840 zephyr/samples/bluetooth/hci_uart`
-4. Flash the firmware to Nordic Board e.g. using `nrfjprog`
-		- e.g. `nrfjprog -f NRF52 --program misc/nrf52840dk.hex –-chiperase --reset`
-5. When you get a nordic board connected to the PC/Mac etc. with UART interface you are good to go.
-6. In order to run any example from the examples folder or your own code you have to provide UART port by defining env variable: `NOBLE_HCI_UART_PORT`. Optionally if you use different Baud Rate you can change it by specifing `NOBLE_HCI_UART_BAUD_RATE`. Default value is `1000000`
-7. e.g. `NOBLE_HCI_UART_PORT=/dev/tty.usbmodem0006837533091 node examples/peripheral-explorer.js b8:27:eb:83:9b:19`
+Please refer to [https://github.com/stoprocent/node-bluetooth-hci-socket#uartserial-any-os](https://github.com/stoprocent/node-bluetooth-hci-socket#uartserial-any-os)
 
 #### OS X
 
@@ -181,7 +171,7 @@ set BLUETOOTH_HCI_SOCKET_USB_PID=xxx
 ```
 
 ```javascript
-const noble = require('@abandonware/noble')({extended: false});
+const noble = require('@abandonware/noble');
 ```
 
 ## API docs
@@ -693,7 +683,7 @@ const Noble = require('@abandonware/noble/lib/noble');
 const params = {
   deviceId: 0,
   userChannel: true,
-  extended: false
+  extended: false //ble5 extended features
 };
 
 const noble = new Noble(new HCIBindings(params));

package/binding.gyp

@@ -0,0 +1,22 @@
+{
+  'variables': {
+    'openssl_fips' : '' 
+  },
+  'targets': [
+    {
+      'target_name': 'noble',
+      'conditions': [
+        ['OS=="mac"', {
+          'dependencies': [
+            'lib/mac/binding.gyp:binding',
+          ],
+        }],
+        ['OS=="win"', {
+          'dependencies': [
+            'lib/win/binding.gyp:binding',
+          ],
+        }],
+      ],
+    },
+  ],
+}

package/examples/advertisement-discovery.js

@@ -1,4 +1,4 @@
-const noble = require('../index')({ extended: false });
+const noble = require('../index');
 
 noble.on('stateChange', function (state) {
   if (state === 'poweredOn') {

package/examples/cache-gatt-discovery.js

@@ -6,7 +6,7 @@
  * Prints timing information from discovered to connected to reading states.
  */
 
-const noble = require('../index')({ extended: false });
+const noble = require('../index');
 const fs = require('fs');
 
 // the sensor value to scan for, number of bits and factor for displaying it

package/examples/cache-gatt-reconnect.js

@@ -6,7 +6,7 @@
  * Prints timing information from discovered to connected to reading states.
  */
 
-const noble = require('../index')({ extended: false });
+const noble = require('../index');
 const fs = require('fs');
 
 // the sensor value to scan for, number of bits and factor for displaying it

package/examples/echo.js

@@ -6,7 +6,7 @@
 // start an interval to write data to the characteristic
 
 // const noble = require('noble');
-const noble = require('..')({ extended: false });
+const noble = require('..');
 
 const ECHO_SERVICE_UUID = 'ec00';
 const ECHO_CHARACTERISTIC_UUID = 'ec0e';

package/examples/enter-exit.js

@@ -7,7 +7,7 @@
 
   based on code provided by: Mattias Ask (http://www.dittlof.com)
 */
-const noble = require('../index')({ extended: false });
+const noble = require('../index');
 
 const RSSI_THRESHOLD = -90;
 const EXIT_GRACE_PERIOD = 2000; // milliseconds
@@ -25,7 +25,7 @@ noble.on('discover', function (peripheral) {
 
   if (entered) {
     inRange[id] = {
-      peripheral: peripheral
+      peripheral
     };
 
     console.log(

package/examples/ext-advertisement-discovery.js

@@ -0,0 +1,65 @@
+const noble = require('../with-custom-binding')({ extended: true });
+
+noble.on('stateChange', function (state) {
+  if (state === 'poweredOn') {
+    noble.startScanning([], false);
+  } else {
+    noble.stopScanning();
+  }
+});
+
+noble.on('discover', function (peripheral) {
+  console.log(`${new Date()}`);
+  console.log(
+    `Peripheral discovered (${peripheral.id} with address <${peripheral.address}, ${peripheral.addressType}>, connectable: ${peripheral.connectable}, scannable: ${peripheral.scannable}, RSSI ${peripheral.rssi}:`
+  );
+  console.log('\thello my local name is:');
+  console.log(`\t\t${peripheral.advertisement.localName}`);
+  console.log(
+    '\tcan I interest you in any of the following advertised services:'
+  );
+  console.log(`\t\t${JSON.stringify(peripheral.advertisement.serviceUuids)}`);
+  const serviceData = peripheral.advertisement.serviceData;
+
+  if (serviceData && serviceData.length) {
+    console.log('\there is my service data:');
+    for (const i in serviceData) {
+      console.log(
+        `\t\t${JSON.stringify(serviceData[i].uuid)}: ${JSON.stringify(
+          serviceData[i].data.toString('hex')
+        )}`
+      );
+    }
+  }
+
+  if (peripheral.advertisement.manufacturerData) {
+    console.log('\there is my manufacturer data:');
+    console.log(
+      `\t\t${JSON.stringify(
+        peripheral.advertisement.manufacturerData.toString('hex')
+      )}`
+    );
+  }
+
+  if (peripheral.advertisement.txPowerLevel !== undefined) {
+    console.log('\tmy TX power level is:');
+    console.log(`\t\t${peripheral.advertisement.txPowerLevel}`);
+  }
+
+  console.log();
+});
+
+process.on('SIGINT', function () {
+  console.log('Caught interrupt signal');
+  noble.stopScanning(() => process.exit());
+});
+
+process.on('SIGQUIT', function () {
+  console.log('Caught interrupt signal');
+  noble.stopScanning(() => process.exit());
+});
+
+process.on('SIGTERM', function () {
+  console.log('Caught interrupt signal');
+  noble.stopScanning(() => process.exit());
+});

package/examples/peripheral-explorer-async.js

@@ -1,4 +1,4 @@
-const noble = require('../')({ extended: false });
+const noble = require('../');
 
 const peripheralIdOrAddress = process.argv[2].toLowerCase();
 

package/examples/peripheral-explorer.js

@@ -1,6 +1,6 @@
 /* eslint-disable handle-callback-err */
 const async = require('async');
-const noble = require('../index')({ extended: false });
+const noble = require('../index');
 
 const peripheralIdOrAddress = process.argv[2].toLowerCase();
 

package/examples/pizza/central.js

@@ -1,5 +1,5 @@
 /* eslint-disable handle-callback-err */
-const noble = require('../..')({ extended: false });
+const noble = require('../..');
 const pizza = require('./pizza');
 
 const pizzaServiceUuid = '13333333333333333333333333333337';