@stoprocent/noble 1.9.2-16

package/lib/hci-uart/bindings.js

@@ -0,0 +1,569 @@
+const events = require('events');
+const util = require('util');
+
+const AclStream = require('../hci-socket/acl-stream');
+const Gatt = require('../hci-socket/gatt');
+const Gap = require('../hci-socket/gap');
+const Hci = require('./hci');
+const Signaling = require('../hci-socket/signaling');
+
+const NobleBindings = function (options) {
+  this._state = null;
+
+  this._addresses = {};
+  this._addresseTypes = {};
+  this._connectable = {};
+
+  this._pendingConnectionUuid = null;
+  this._connectionQueue = [];
+
+  this._handles = {};
+  this._gatts = {};
+  this._aclStreams = {};
+  this._signalings = {};
+
+  this._hci = new Hci(options);
+  this._gap = new Gap(this._hci);
+};
+
+util.inherits(NobleBindings, events.EventEmitter);
+
+NobleBindings.prototype.setScanParameters = function (interval, window) {
+  this._gap.setScanParameters(interval, window);
+};
+
+NobleBindings.prototype.startScanning = function (serviceUuids, allowDuplicates) {
+  this._scanServiceUuids = serviceUuids || [];
+
+  this._gap.startScanning(allowDuplicates);
+};
+
+NobleBindings.prototype.stopScanning = function () {
+  this._gap.stopScanning();
+};
+
+NobleBindings.prototype.connect = function (peripheralUuid, parameters) {
+  const address = this._addresses[peripheralUuid];
+  const addressType = this._addresseTypes[peripheralUuid];
+
+  if (!this._pendingConnectionUuid) {
+    this._pendingConnectionUuid = peripheralUuid;
+
+    this._hci.createLeConn(address, addressType, parameters);
+  } else {
+    this._connectionQueue.push({ id: peripheralUuid, params: parameters });
+  }
+};
+
+NobleBindings.prototype.disconnect = function (peripheralUuid) {
+  this._hci.disconnect(this._handles[peripheralUuid]);
+};
+
+NobleBindings.prototype.cancelConnect = function (peripheralUuid) {
+  // TODO: check if it was not in the queue and only then issue cancel on hci
+  this._connectionQueue = this._connectionQueue.filter(c => c.id !== peripheralUuid);
+  this._hci.cancelConnect(this._handles[peripheralUuid]);
+};
+
+NobleBindings.prototype.reset = function () {
+  this._hci.reset();
+};
+
+NobleBindings.prototype.updateRssi = function (peripheralUuid) {
+  this._hci.readRssi(this._handles[peripheralUuid]);
+};
+
+NobleBindings.prototype.init = function () {
+  this.onSigIntBinded = this.onSigInt.bind(this);
+
+  this._gap.on('scanParametersSet', this.onScanParametersSet.bind(this));
+  this._gap.on('scanStart', this.onScanStart.bind(this));
+  this._gap.on('scanStop', this.onScanStop.bind(this));
+  this._gap.on('discover', this.onDiscover.bind(this));
+
+  this._hci.on('stateChange', this.onStateChange.bind(this));
+  this._hci.on('addressChange', this.onAddressChange.bind(this));
+  this._hci.on('leConnComplete', this.onLeConnComplete.bind(this));
+  this._hci.on('leConnUpdateComplete', this.onLeConnUpdateComplete.bind(this));
+  this._hci.on('rssiRead', this.onRssiRead.bind(this));
+  this._hci.on('disconnComplete', this.onDisconnComplete.bind(this));
+  this._hci.on('encryptChange', this.onEncryptChange.bind(this));
+  this._hci.on('aclDataPkt', this.onAclDataPkt.bind(this));
+
+  this._hci.init();
+
+  /* Add exit handlers after `init()` has completed. If no adaptor
+  is present it can throw an exception - in which case we don't
+  want to try and clear up afterwards (issue #502) */
+  process.on('SIGINT', this.onSigIntBinded);
+  process.on('exit', this.onExit.bind(this));
+};
+
+NobleBindings.prototype.onSigInt = function () {
+  const sigIntListeners = process.listeners('SIGINT');
+
+  if (sigIntListeners[sigIntListeners.length - 1] === this.onSigIntBinded) {
+    // We need to cleanup queue processing uart messages
+    this._hci.cleanup();
+    // we are the last listener, so exit
+    // this will trigger onExit, and clean up
+    process.exit(1);
+  }
+};
+
+NobleBindings.prototype.onExit = function () {
+  this.stopScanning();
+
+  for (const handle in this._aclStreams) {
+    this._hci.disconnect(handle);
+  }
+};
+
+NobleBindings.prototype.onStateChange = function (state) {
+  if (this._state === state) {
+    return;
+  }
+  this._state = state;
+
+  if (state === 'unauthorized') {
+    console.log('noble warning: adapter state unauthorized, please run as root or with sudo');
+    console.log('               or see README for information on running without root/sudo:');
+    console.log('               https://github.com/sandeepmistry/noble#running-on-linux');
+  } else if (state === 'unsupported') {
+    console.log('noble warning: adapter does not support Bluetooth Low Energy (BLE, Bluetooth Smart).');
+    console.log('               Try to run with environment variable:');
+    console.log('               [sudo] NOBLE_HCI_DEVICE_ID=x node ...');
+  }
+
+  this.emit('stateChange', state);
+};
+
+NobleBindings.prototype.onAddressChange = function (address) {
+  this.emit('addressChange', address);
+};
+
+NobleBindings.prototype.onScanParametersSet = function () {
+  this.emit('scanParametersSet');
+};
+
+NobleBindings.prototype.onScanStart = function (filterDuplicates) {
+  this.emit('scanStart', filterDuplicates);
+};
+
+NobleBindings.prototype.onScanStop = function () {
+  this.emit('scanStop');
+};
+
+NobleBindings.prototype.onDiscover = function (status, address, addressType, connectable, advertisement, rssi) {
+  if (this._scanServiceUuids === undefined) {
+    return;
+  }
+
+  let serviceUuids = advertisement.serviceUuids || [];
+  const serviceData = advertisement.serviceData || [];
+  let hasScanServiceUuids = (this._scanServiceUuids.length === 0);
+
+  if (!hasScanServiceUuids) {
+    let i;
+
+    serviceUuids = serviceUuids.slice();
+
+    for (i in serviceData) {
+      serviceUuids.push(serviceData[i].uuid);
+    }
+
+    for (i in serviceUuids) {
+      hasScanServiceUuids = (this._scanServiceUuids.indexOf(serviceUuids[i]) !== -1);
+
+      if (hasScanServiceUuids) {
+        break;
+      }
+    }
+  }
+
+  if (hasScanServiceUuids) {
+    const uuid = address.split(':').join('');
+    this._addresses[uuid] = address;
+    this._addresseTypes[uuid] = addressType;
+    this._connectable[uuid] = connectable;
+
+    this.emit('discover', uuid, address, addressType, connectable, advertisement, rssi);
+  }
+};
+
+NobleBindings.prototype.onLeConnComplete = function (status, handle, role, addressType, address, interval, latency, supervisionTimeout, masterClockAccuracy) {
+  if (role !== 0) {
+    // not master, ignore
+    return;
+  }
+  let uuid = null;
+
+  let error = null;
+
+  if (status === 0) {
+    uuid = address.split(':').join('').toLowerCase();
+
+    const aclStream = new AclStream(this._hci, handle, this._hci.addressType, this._hci.address, addressType, address);
+    const gatt = new Gatt(address, aclStream);
+    const signaling = new Signaling(handle, aclStream);
+
+    this._gatts[uuid] = this._gatts[handle] = gatt;
+    this._signalings[uuid] = this._signalings[handle] = signaling;
+    this._aclStreams[handle] = aclStream;
+    this._handles[uuid] = handle;
+    this._handles[handle] = uuid;
+
+    this._gatts[handle].on('mtu', this.onMtu.bind(this));
+    this._gatts[handle].on('servicesDiscover', this.onServicesDiscovered.bind(this));
+    this._gatts[handle].on('servicesDiscovered', this.onServicesDiscoveredEX.bind(this));
+    this._gatts[handle].on('includedServicesDiscover', this.onIncludedServicesDiscovered.bind(this));
+    this._gatts[handle].on('characteristicsDiscover', this.onCharacteristicsDiscovered.bind(this));
+    this._gatts[handle].on('characteristicsDiscovered', this.onCharacteristicsDiscoveredEX.bind(this));
+    this._gatts[handle].on('read', this.onRead.bind(this));
+    this._gatts[handle].on('write', this.onWrite.bind(this));
+    this._gatts[handle].on('broadcast', this.onBroadcast.bind(this));
+    this._gatts[handle].on('notify', this.onNotify.bind(this));
+    this._gatts[handle].on('notification', this.onNotification.bind(this));
+    this._gatts[handle].on('descriptorsDiscover', this.onDescriptorsDiscovered.bind(this));
+    this._gatts[handle].on('valueRead', this.onValueRead.bind(this));
+    this._gatts[handle].on('valueWrite', this.onValueWrite.bind(this));
+    this._gatts[handle].on('handleRead', this.onHandleRead.bind(this));
+    this._gatts[handle].on('handleWrite', this.onHandleWrite.bind(this));
+    this._gatts[handle].on('handleNotify', this.onHandleNotify.bind(this));
+
+    this._signalings[handle].on('connectionParameterUpdateRequest', this.onConnectionParameterUpdateRequest.bind(this));
+
+    setTimeout(() => {
+      this._gatts[handle].exchangeMtu();
+    }, 0);
+  } else {
+    uuid = this._pendingConnectionUuid;
+    let statusMessage = Hci.STATUS_MAPPER[status] || 'HCI Error: Unknown';
+    const errorCode = ` (0x${status.toString(16)})`;
+    statusMessage = statusMessage + errorCode;
+    error = new Error(statusMessage);
+  }
+
+  this.emit('connect', uuid, error);
+
+  if (this._connectionQueue.length > 0) {
+    const queueItem = this._connectionQueue.shift();
+    const peripheralUuid = queueItem.id;
+
+    address = this._addresses[peripheralUuid];
+    addressType = this._addresseTypes[peripheralUuid];
+
+    this._pendingConnectionUuid = peripheralUuid;
+
+    this._hci.createLeConn(address, addressType, queueItem.params);
+  } else {
+    this._pendingConnectionUuid = null;
+  }
+};
+
+NobleBindings.prototype.onLeConnUpdateComplete = function (handle, interval, latency, supervisionTimeout) {
+  // no-op
+};
+
+NobleBindings.prototype.onDisconnComplete = function (handle, reason) {
+  const uuid = this._handles[handle];
+
+  if (uuid) {
+    this._aclStreams[handle].push(null, null);
+    this._gatts[handle].removeAllListeners();
+    this._signalings[handle].removeAllListeners();
+
+    delete this._gatts[uuid];
+    delete this._gatts[handle];
+    delete this._signalings[uuid];
+    delete this._signalings[handle];
+    delete this._aclStreams[handle];
+    delete this._handles[uuid];
+    delete this._handles[handle];
+
+    this.emit('disconnect', uuid); // TODO: handle reason?
+  } else {
+    console.warn(`noble warning: unknown handle ${handle} disconnected!`);
+  }
+};
+
+NobleBindings.prototype.onEncryptChange = function (handle, encrypt) {
+  const aclStream = this._aclStreams[handle];
+
+  if (aclStream) {
+    aclStream.pushEncrypt(encrypt);
+  }
+};
+
+NobleBindings.prototype.onMtu = function (address, mtu) {
+  const uuid = address.split(':').join('').toLowerCase();
+  this.emit('onMtu', uuid, mtu);
+};
+
+NobleBindings.prototype.onRssiRead = function (handle, rssi) {
+  this.emit('rssiUpdate', this._handles[handle], rssi);
+};
+
+NobleBindings.prototype.onAclDataPkt = function (handle, cid, data) {
+  const aclStream = this._aclStreams[handle];
+
+  if (aclStream) {
+    aclStream.push(cid, data);
+  }
+};
+
+NobleBindings.prototype.addService = function (peripheralUuid, service) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.addService(service);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.discoverServices = function (peripheralUuid, uuids) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.discoverServices(uuids || []);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.onServicesDiscovered = function (address, serviceUuids) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('servicesDiscover', uuid, serviceUuids);
+};
+
+NobleBindings.prototype.onServicesDiscoveredEX = function (address, services) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('servicesDiscovered', uuid, services);
+};
+
+NobleBindings.prototype.discoverIncludedServices = function (peripheralUuid, serviceUuid, serviceUuids) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.discoverIncludedServices(serviceUuid, serviceUuids || []);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.onIncludedServicesDiscovered = function (address, serviceUuid, includedServiceUuids) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('includedServicesDiscover', uuid, serviceUuid, includedServiceUuids);
+};
+
+NobleBindings.prototype.addCharacteristics = function (peripheralUuid, serviceUuid, characteristics) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.addCharacteristics(serviceUuid, characteristics);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.discoverCharacteristics = function (peripheralUuid, serviceUuid, characteristicUuids) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.discoverCharacteristics(serviceUuid, characteristicUuids || []);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.onCharacteristicsDiscovered = function (address, serviceUuid, characteristics) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('characteristicsDiscover', uuid, serviceUuid, characteristics);
+};
+
+NobleBindings.prototype.onCharacteristicsDiscoveredEX = function (address, serviceUuid, characteristics) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('characteristicsDiscovered', uuid, serviceUuid, characteristics);
+};
+
+NobleBindings.prototype.read = function (peripheralUuid, serviceUuid, characteristicUuid) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.read(serviceUuid, characteristicUuid);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.onRead = function (address, serviceUuid, characteristicUuid, data) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('read', uuid, serviceUuid, characteristicUuid, data, false);
+};
+
+NobleBindings.prototype.write = function (peripheralUuid, serviceUuid, characteristicUuid, data, withoutResponse) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.write(serviceUuid, characteristicUuid, data, withoutResponse);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.onWrite = function (address, serviceUuid, characteristicUuid) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('write', uuid, serviceUuid, characteristicUuid);
+};
+
+NobleBindings.prototype.broadcast = function (peripheralUuid, serviceUuid, characteristicUuid, broadcast) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.broadcast(serviceUuid, characteristicUuid, broadcast);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.onBroadcast = function (address, serviceUuid, characteristicUuid, state) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('broadcast', uuid, serviceUuid, characteristicUuid, state);
+};
+
+NobleBindings.prototype.notify = function (peripheralUuid, serviceUuid, characteristicUuid, notify) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.notify(serviceUuid, characteristicUuid, notify);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.onNotify = function (address, serviceUuid, characteristicUuid, state) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('notify', uuid, serviceUuid, characteristicUuid, state);
+};
+
+NobleBindings.prototype.onNotification = function (address, serviceUuid, characteristicUuid, data) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('read', uuid, serviceUuid, characteristicUuid, data, true);
+};
+
+NobleBindings.prototype.discoverDescriptors = function (peripheralUuid, serviceUuid, characteristicUuid) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.discoverDescriptors(serviceUuid, characteristicUuid);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.onDescriptorsDiscovered = function (address, serviceUuid, characteristicUuid, descriptorUuids) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('descriptorsDiscover', uuid, serviceUuid, characteristicUuid, descriptorUuids);
+};
+
+NobleBindings.prototype.readValue = function (peripheralUuid, serviceUuid, characteristicUuid, descriptorUuid) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.readValue(serviceUuid, characteristicUuid, descriptorUuid);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.onValueRead = function (address, serviceUuid, characteristicUuid, descriptorUuid, data) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('valueRead', uuid, serviceUuid, characteristicUuid, descriptorUuid, data);
+};
+
+NobleBindings.prototype.writeValue = function (peripheralUuid, serviceUuid, characteristicUuid, descriptorUuid, data) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.writeValue(serviceUuid, characteristicUuid, descriptorUuid, data);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.onValueWrite = function (address, serviceUuid, characteristicUuid, descriptorUuid) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('valueWrite', uuid, serviceUuid, characteristicUuid, descriptorUuid);
+};
+
+NobleBindings.prototype.readHandle = function (peripheralUuid, attHandle) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.readHandle(attHandle);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.onHandleRead = function (address, handle, data) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('handleRead', uuid, handle, data);
+};
+
+NobleBindings.prototype.writeHandle = function (peripheralUuid, attHandle, data, withoutResponse) {
+  const handle = this._handles[peripheralUuid];
+  const gatt = this._gatts[handle];
+
+  if (gatt) {
+    gatt.writeHandle(attHandle, data, withoutResponse);
+  } else {
+    console.warn(`noble warning: unknown peripheral ${peripheralUuid}`);
+  }
+};
+
+NobleBindings.prototype.onHandleWrite = function (address, handle) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('handleWrite', uuid, handle);
+};
+
+NobleBindings.prototype.onHandleNotify = function (address, handle, data) {
+  const uuid = address.split(':').join('').toLowerCase();
+
+  this.emit('handleNotify', uuid, handle, data);
+};
+
+NobleBindings.prototype.onConnectionParameterUpdateRequest = function (handle, minInterval, maxInterval, latency, supervisionTimeout) {
+  this._hci.connUpdateLe(handle, minInterval, maxInterval, latency, supervisionTimeout);
+};
+
+module.exports = NobleBindings;

package/lib/hci-uart/hci-serial-parser.js

@@ -0,0 +1,70 @@
+const debug = require('debug')('hci-serial-parser');
+const { Transform } = require('stream');
+
+const HCI_COMMAND_PKT = 0x01;
+const HCI_ACLDATA_PKT = 0x02;
+const HCI_EVENT_PKT = 0x04;
+
+class HciSerialParser extends Transform {
+  constructor (options) {
+    super();
+    this.reset();
+  }
+
+  _transform (chunk, encoding, cb) {
+    this.packetData = Buffer.concat([this.packetData, chunk]);
+
+    debug('HciPacketParser._transform: ', this.packetData.toString('hex'));
+
+    if (this.packetType === -1) {
+      this.packetType = this.packetData.readUInt8(0);
+    }
+
+    if (this.listenerCount('raw') > 0) {
+      this.emit('raw', this.packetData);
+    }
+
+    let skipPacket = false;
+    while (this.packetData.length >= this.packetSize + this.prePacketSize && !skipPacket) {
+      if (this.packetSize === 0 && (this.packetType === HCI_EVENT_PKT || this.packetType === HCI_COMMAND_PKT) && this.packetData.length >= 3) {
+        this.packetSize = this.packetData.readUInt8(2);
+        this.prePacketSize = 3;
+      } else if (this.packetSize === 0 && this.packetType === HCI_ACLDATA_PKT && this.packetData.length >= 5) {
+        this.packetSize = this.packetData.readUInt16LE(3);
+        this.prePacketSize = 5;
+      }
+
+      if (this.packetData.length < this.packetSize + this.prePacketSize || this.packetSize == 0) {
+        skipPacket = true; continue;
+      }
+
+      this.push(this.packetData.subarray(0, this.packetSize + this.prePacketSize));
+
+      this.packetData = this.packetData.subarray(this.packetSize + this.prePacketSize);
+      this.packetSize = 0;
+      this.prePacketSize = 0;
+
+      if (this.packetData.length > 0) {
+        this.packetType = this.packetData.readUInt8(0);
+      } else {
+        this.packetType = -1;
+      }
+    }
+    cb();
+  }
+
+  reset () {
+    this.packetSize = 0;
+    this.prePacketSize = 0;
+    this.packetType = -1;
+    this.packetData = Buffer.alloc(0);
+  }
+
+  _flush (cb) {
+    this.emit('raw', this.packetData);
+    this.reset();
+    cb();
+  }
+}
+
+module.exports = HciSerialParser;