@stoprocent/noble 1.19.0 → 2.0.0

package/.editorconfig

@@ -1,11 +0,0 @@
-root = true
-[*]
-charset = utf-8
-indent_size = 2
-indent_style = space
-end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
-quote_type = single
-[*.{diff,md}]
-trim_trailing_whitespace = false

package/.nycrc.json

@@ -1,4 +0,0 @@
-{
-  "all": true,
-  "exclude": ["examples/**", "test/**", "test.js", "ws-slave.js", ".eslintrc.js", "coverage/**"]
-}

package/codecov.yml

@@ -1,5 +0,0 @@
-coverage:
-  status:
-    project:
-      server:
-        target: 90%

package/examples/cache-gatt-discovery.js

@@ -1,198 +0,0 @@
-/* eslint-disable handle-callback-err */
-/** discover a device (here, the first one where the name was resolved),
- * for the first device discover all services and characteristics,
- * store the collected GATT information into a meta-data object and write to disk.
- * Finds a temperature characteristic and registers for data.
- * Prints timing information from discovered to connected to reading states.
- */
-
-const noble = require('../index');
-const fs = require('fs');
-
-// the sensor value to scan for, number of bits and factor for displaying it
-const CHANNEL = process.env.CHANNEL ? process.env.CHANNEL : 'Temperature';
-const BITS = process.env.BITS ? 1 * process.env.BITS : 16;
-const FACTOR = process.env.FACTOR ? 1.0 * process.env.FACTOR : 0.1;
-
-const EXT = '.dump';
-
-noble.on('stateChange', function (state) {
-  if (state === 'poweredOn') {
-    noble.startScanning([], false);
-  } else {
-    noble.stopScanning();
-  }
-});
-
-let tDisco = 0; // time when device was discovered
-let tConn = 0; // time when connection to device was established
-let tRead = 0; // time when reading data starts.
-
-// collect device meta-data into this object:
-const meta = {
-  services: [], // stores an array of GATT service data objects
-  characteristics: {} // a map with key service-UUID, stores the array of characteristics
-};
-
-noble.on('discover', function (peripheral) {
-  console.log(
-    `peripheral discovered (${peripheral.id} with address <${peripheral.address}, ${peripheral.addressType}>, connectable ${peripheral.connectable}, RSSI ${peripheral.rssi}:`
-  );
-  console.log('\thello my local name is:');
-  console.log(`\t\t${peripheral.advertisement.localName}`);
-  console.log();
-
-  // connect to the first device with a valid name
-  if (peripheral.advertisement.localName) {
-    console.log(
-      `Connecting to  ${peripheral.address} ${peripheral.advertisement.localName}`
-    );
-
-    tDisco = Date.now();
-
-    connectToDevice(peripheral);
-  }
-});
-
-const connectToDevice = function (peripheral) {
-  // BLE cannot scan and connect in parallel, so we stop scanning here:
-  noble.stopScanning();
-
-  peripheral.connect((error) => {
-    // noble.startScanning([], true)
-    if (error) {
-      console.log(`Connect error: ${error}`);
-      noble.startScanning([], true);
-      return;
-    }
-    tConn = Date.now();
-    console.log('Connected!');
-
-    findServices(noble, peripheral);
-  });
-};
-
-let servicesToRead = 0;
-
-const findServices = function (noble, peripheral) {
-  meta.uuid = peripheral.uuid;
-  meta.address = peripheral.address;
-  meta.name = peripheral.advertisement.localName; // not needed but nice to have
-
-  meta.characteristics = {};
-
-  // callback triggers with GATT-relevant data
-  peripheral.on('servicesDiscovered', (peripheral, services) => {
-    console.log(`servicesDiscovered: Found ${services.length} services! `);
-    meta.services = services;
-    for (const i in services) {
-      const service = services[i];
-      console.log(`\tservice ${i} : ${JSON.stringify(service)}`);
-      // meta.services[ service.uuid ] = service
-    }
-  });
-
-  peripheral.discoverServices([], (error, services) => {
-    if (error) {
-      console.error(error);
-      return;
-    }
-
-    let sensorCharacteristic;
-
-    servicesToRead = services.length;
-    // we found the list of services, now trigger characteristics lookup for each of them:
-
-    for (let i = 0; i < services.length; i++) {
-      const service = services[i];
-
-      service.on('characteristicsDiscovered', (characteristics) => {
-        // store the list of characteristics per service
-        meta.characteristics[service.uuid] = characteristics;
-
-        console.log(`SRV\t${service.uuid} characteristic GATT data: `);
-        for (let i = 0; i < characteristics.length; i++) {
-          console.log(
-            `\t${service.uuid} chara.\t  ${i} ${JSON.stringify(
-              characteristics[i]
-            )}`
-          );
-        }
-      });
-
-      service.discoverCharacteristics([], function (error, characteristics) {
-        if (error) {
-          console.error(error);
-          return;
-        }
-
-        console.log(`SRV\t${service.uuid} characteristic decoded data: `);
-        for (let j = 0; j < characteristics.length; j++) {
-          const ch = characteristics[j];
-          console.log(`\t${service.uuid} chara.\t  ${j} ${ch}`);
-
-          if (ch.name === CHANNEL) {
-            console.log(`found ${CHANNEL} characteristic!`);
-            sensorCharacteristic = ch;
-          }
-        }
-
-        servicesToRead--;
-        if (!servicesToRead) {
-          console.log('----------------- FINISHED');
-          console.log(JSON.stringify(meta, null, 4));
-          // write to file
-          fs.writeFile(
-            meta.uuid + EXT,
-            JSON.stringify(meta, null, 2),
-            function (err) {
-              if (err) {
-                return console.log(err);
-              }
-              console.log('The data was saved to ', meta.uuid + EXT);
-            }
-          );
-
-          if (sensorCharacteristic) {
-            console.log('Listening for temperature data...');
-
-            tRead = Date.now();
-
-            sensorCharacteristic.on('data', (data) => {
-              if (BITS === 16) {
-                console.log(` new ${CHANNEL} ${data.readUInt16LE() * FACTOR}`);
-              } else if (BITS === 32) {
-                console.log(` new ${CHANNEL} ${data.readUInt32LE() * FACTOR}`);
-              } else {
-                console.log(` Cannot cope with BITS value ${BITS}`);
-              }
-            });
-            sensorCharacteristic.read();
-          }
-
-          console.log(
-            `Timespan from discovery to connected: ${tConn - tDisco} ms`
-          );
-          console.log(
-            `Timespan from connected to reading  : ${tRead - tConn} ms`
-          );
-        }
-      });
-    }
-  });
-};
-
-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/cache-gatt-reconnect.js

@@ -1,164 +0,0 @@
-/* eslint-disable handle-callback-err */
-/** reconnect to a device that has been discovered earlier on using cache-gatt-discovery:
- * If a device is discovered and a dump file exists, load it and connect to it, re-initializing service
- * and characteristic objects in the noble stack.
- * Finds a temperature characteristic and registers for data.
- * Prints timing information from discovered to connected to reading states.
- */
-
-const noble = require('../index');
-const fs = require('fs');
-
-// the sensor value to scan for, number of bits and factor for displaying it
-const CHANNEL = process.env.CHANNEL ? process.env.CHANNEL : 'Temperature';
-const BITS = process.env.BITS ? 1 * process.env.BITS : 16;
-const FACTOR = process.env.FACTOR ? 1.0 * process.env.FACTOR : 0.1;
-
-const EXT = '.dump';
-
-noble.on('stateChange', function (state) {
-  if (state === 'poweredOn') {
-    noble.startScanning([], false);
-  } else {
-    noble.stopScanning();
-  }
-});
-
-let tDisco = 0; // time when device was discovered
-let tConn = 0; // time when connection to device was established
-let tRead = 0; // time when reading data starts.
-
-// collect device meta-data into this object:
-let meta = {
-  services: {}, // a map indexted by service-UUID -> contains service data
-  characteristics: {} // an map with key service-UUID, stores the array of characteristics
-};
-
-noble.on('discover', function (peripheral) {
-  console.log(
-    `peripheral discovered (${peripheral.id} with address <${peripheral.address}, ${peripheral.addressType}>, connectable ${peripheral.connectable}, RSSI ${peripheral.rssi}:`
-  );
-  console.log('\thello my local name is:');
-  console.log(`\t\t${peripheral.advertisement.localName}`);
-  console.log();
-
-  // Check if a dump  exists in the current directory.
-  fs.access(peripheral.uuid + EXT, fs.constants.F_OK, (err) => {
-    if (!err) {
-      console.log(`found dump file for ${peripheral.uuid}`);
-
-      tDisco = Date.now();
-
-      quickConnect(peripheral);
-    }
-  });
-});
-
-const quickConnect = function (peripheral) {
-  // BLE cannot scan and connect in parallel, so we stop scanning here:
-  noble.stopScanning();
-
-  peripheral.connect((error) => {
-    if (error) {
-      console.log(`Connect error: ${error}`);
-      noble.startScanning([], true);
-      return;
-    }
-    tConn = Date.now();
-    console.log('Connected!');
-
-    // load stored data. This needs to be done when connected, as we need a handle at GATT level
-    meta = loadData(peripheral);
-
-    // initialize the service and charateristics objects in Noble; return a temperature characteristic, if found
-    const sensorCharacteristic = setData(peripheral, meta);
-
-    if (!sensorCharacteristic) {
-      console.log('Warning - no temperature characteristic found.');
-    } else {
-      console.log('Listening for temperature data...');
-
-      tRead = Date.now();
-
-      sensorCharacteristic.on('data', (data) => {
-        if (BITS === 16) {
-          console.log(` new ${CHANNEL} ${data.readUInt16LE() * FACTOR}`);
-        } else if (BITS === 32) {
-          console.log(` new ${CHANNEL} ${data.readUInt32LE() * FACTOR}`);
-        } else {
-          console.log(` Cannot cope with BITS value ${BITS}`);
-        }
-      });
-      sensorCharacteristic.read();
-
-      console.log(`Timespan from discovery to connected: ${tConn - tDisco} ms`);
-      console.log(`Timespan from connected to reading  : ${tRead - tConn} ms`);
-    }
-  });
-};
-
-const loadData = function (peripheral) {
-  const dump = fs.readFileSync(peripheral.uuid + EXT);
-  const data = JSON.parse(dump);
-
-  // verify data: console.log(JSON.stringify(data,null,2))
-  return data;
-};
-
-const setData = function (peripheral, meta) {
-  // first, create the service objects:
-  console.log('initializing services... ');
-
-  // addServices returns an array of initialized service objects
-  const services = noble.addServices(peripheral.uuid, meta.services);
-
-  console.log('initialized services: ');
-  for (const i in services) {
-    const service = services[i];
-    console.log(`\tservice ${i} ${service}`);
-  }
-  console.log();
-
-  let sensorCharacteristic;
-
-  console.log('initializing characteristics... ');
-  // now, for each service, set the characteristics:
-  for (const i in services) {
-    const service = services[i];
-    const charas = meta.characteristics[service.uuid];
-    console.log(`\tservice ${i} ${service} ${JSON.stringify(charas)}`);
-
-    const characteristics = noble.addCharacteristics(
-      peripheral.uuid,
-      service.uuid,
-      charas
-    );
-
-    for (const j in characteristics) {
-      const characteristic = characteristics[j];
-      console.log(
-        `\t\tcharac ${service.uuid} ${j} ${characteristic} ${characteristic.rawProps}`
-      );
-      if (characteristic.name === CHANNEL) {
-        console.log(`\t\t\t-->found ${CHANNEL} characteristic!`);
-        sensorCharacteristic = characteristic;
-      }
-    }
-  }
-  return sensorCharacteristic;
-};
-
-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/ext-advertisement-discovery.js

@@ -1,65 +0,0 @@
-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.js

@@ -1,225 +0,0 @@
-/* eslint-disable handle-callback-err */
-const async = require('async');
-const noble = require('../index');
-
-const peripheralIdOrAddress = process.argv[2].toLowerCase();
-
-noble.on('stateChange', function (state) {
-  if (state === 'poweredOn') {
-    noble.startScanning([], false);
-  } else {
-    noble.stopScanning();
-  }
-});
-
-noble.on('discover', function (peripheral) {
-  if (
-    peripheral.id === peripheralIdOrAddress ||
-    peripheral.address === peripheralIdOrAddress
-  ) {
-    noble.stopScanning();
-
-    console.log(`peripheral with ID ${peripheral.id} found`);
-    const advertisement = peripheral.advertisement;
-
-    const localName = advertisement.localName;
-    const txPowerLevel = advertisement.txPowerLevel;
-    const manufacturerData = advertisement.manufacturerData;
-    const serviceData = advertisement.serviceData;
-    const serviceUuids = advertisement.serviceUuids;
-
-    if (localName) {
-      console.log(`  Local Name        = ${localName}`);
-    }
-
-    if (txPowerLevel) {
-      console.log(`  TX Power Level    = ${txPowerLevel}`);
-    }
-
-    if (manufacturerData) {
-      console.log(`  Manufacturer Data = ${manufacturerData.toString('hex')}`);
-    }
-
-    if (serviceData) {
-      console.log(
-        `  Service Data      = ${JSON.stringify(serviceData, null, 2)}`
-      );
-    }
-
-    if (serviceUuids) {
-      console.log(`  Service UUIDs     = ${serviceUuids}`);
-    }
-
-    console.log();
-
-    explore(peripheral);
-  }
-});
-
-function explore (peripheral) {
-  console.log('services and characteristics:');
-
-  peripheral.on('disconnect', function () {
-    process.exit(0);
-  });
-
-  peripheral.connect(function (error) {
-    if (error) {
-      console.error(error);
-      return;
-    }
-
-    peripheral.discoverServices([], function (error, services) {
-      if (error) {
-        console.error(error);
-        return;
-      }
-
-      let serviceIndex = 0;
-
-      async.whilst(
-        function () {
-          return serviceIndex < services.length;
-        },
-        function (callback) {
-          const service = services[serviceIndex];
-          let serviceInfo = service.uuid;
-
-          if (service.name) {
-            serviceInfo += ` (${service.name})`;
-          }
-          console.log(serviceInfo);
-
-          service.discoverCharacteristics(
-            [],
-            function (error, characteristics) {
-              if (error) {
-                console.error(error);
-                return;
-              }
-
-              let characteristicIndex = 0;
-
-              async.whilst(
-                function () {
-                  return characteristicIndex < characteristics.length;
-                },
-                function (callback) {
-                  const characteristic = characteristics[characteristicIndex];
-                  let characteristicInfo = `  ${characteristic.uuid}`;
-
-                  if (characteristic.name) {
-                    characteristicInfo += ` (${characteristic.name})`;
-                  }
-
-                  async.series([
-                    function (callback) {
-                      characteristic.discoverDescriptors(function (
-                        error,
-                        descriptors
-                      ) {
-                        if (error) {
-                          console.error(error);
-                          return;
-                        }
-
-                        async.detect(
-                          descriptors,
-                          function (descriptor, callback) {
-                            if (descriptor.uuid === '2901') {
-                              return callback(descriptor);
-                            } else {
-                              return callback();
-                            }
-                          },
-                          function (userDescriptionDescriptor) {
-                            if (userDescriptionDescriptor) {
-                              userDescriptionDescriptor.readValue(function (
-                                error,
-                                data
-                              ) {
-                                if (error) {
-                                  console.error(error);
-                                }
-
-                                if (data) {
-                                  characteristicInfo += ` (${data.toString()})`;
-                                }
-                                callback();
-                              });
-                            } else {
-                              callback();
-                            }
-                          }
-                        );
-                      });
-                    },
-                    function (callback) {
-                      characteristicInfo += `\n    properties  ${characteristic.properties.join(
-                        ', '
-                      )}`;
-
-                      if (characteristic.properties.indexOf('read') !== -1) {
-                        characteristic.read(function (error, data) {
-                          if (error) {
-                            console.error(error);
-                          }
-
-                          if (data) {
-                            const string = data.toString('ascii');
-
-                            characteristicInfo += `\n    value       ${data.toString(
-                              'hex'
-                            )} | '${string}'`;
-                          }
-                          callback();
-                        });
-                      } else {
-                        callback();
-                      }
-                    },
-                    function () {
-                      console.log(characteristicInfo);
-                      characteristicIndex++;
-                      callback();
-                    }
-                  ]);
-                },
-                function (error) {
-                  if (error) {
-                    console.error(error);
-                  }
-
-                  serviceIndex++;
-                  callback();
-                }
-              );
-            }
-          );
-        },
-        function (error) {
-          if (error) {
-            console.error(error);
-          }
-
-          peripheral.disconnect();
-        }
-      );
-    });
-  });
-}
-
-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());
-});