node-poweredup 8.0.5 → 10.0.0

package/src/index-node.ts

@@ -1,53 +1,54 @@
-import * as Consts from "./consts";
+import * as Consts from "./consts.js";
+export * from "./consts.js";
 
-import { PoweredUP } from "./poweredup-node";
-import { Color } from "./color";
+import { PoweredUP } from "./poweredup-node.js";
+import { Color } from "./color.js";
 
-import { BaseHub } from "./hubs/basehub";
-import { DuploTrainBase } from "./hubs/duplotrainbase";
-import { Hub } from "./hubs/hub";
-import { Mario } from "./hubs/mario";
-import { MoveHub } from "./hubs/movehub";
-import { RemoteControl } from "./hubs/remotecontrol";
-import { TechnicMediumHub } from "./hubs/technicmediumhub";
-import { WeDo2SmartHub } from "./hubs/wedo2smarthub";
+import { BaseHub } from "./hubs/basehub.js";
+import { DuploTrainBase } from "./hubs/duplotrainbase.js";
+import { Hub } from "./hubs/hub.js";
+import { Mario } from "./hubs/mario.js";
+import { MoveHub } from "./hubs/movehub.js";
+import { RemoteControl } from "./hubs/remotecontrol.js";
+import { TechnicMediumHub } from "./hubs/technicmediumhub.js";
+import { WeDo2SmartHub } from "./hubs/wedo2smarthub.js";
 
-import { ColorDistanceSensor } from "./devices/colordistancesensor";
-import { CurrentSensor } from "./devices/currentsensor";
-import { Device } from "./devices/device";
-import { DuploTrainBaseColorSensor } from "./devices/duplotrainbasecolorsensor";
-import { DuploTrainBaseMotor } from "./devices/duplotrainbasemotor";
-import { DuploTrainBaseSpeaker } from "./devices/duplotrainbasespeaker";
-import { DuploTrainBaseSpeedometer } from "./devices/duplotrainbasespeedometer";
-import { HubLED } from "./devices/hubled";
-import { Light } from "./devices/light";
-import { MediumLinearMotor } from "./devices/mediumlinearmotor";
-import { MotionSensor } from "./devices/motionsensor";
-import { MoveHubMediumLinearMotor } from "./devices/movehubmediumlinearmotor";
-import { MoveHubTiltSensor } from "./devices/movehubtiltsensor";
-import { PiezoBuzzer } from "./devices/piezobuzzer";
-import { RemoteControlButton } from "./devices/remotecontrolbutton";
-import { SimpleMediumLinearMotor } from "./devices/simplemediumlinearmotor";
-import { TechnicColorSensor } from "./devices/techniccolorsensor";
-import { TechnicDistanceSensor } from "./devices/technicdistancesensor";
-import { TechnicForceSensor } from "./devices/technicforcesensor";
-import { TechnicLargeAngularMotor } from "./devices/techniclargeangularmotor";
-import { TechnicLargeLinearMotor } from "./devices/techniclargelinearmotor";
-import { TechnicSmallAngularMotor } from "./devices/technicsmallangularmotor";
-import { TechnicMediumAngularMotor } from "./devices/technicmediumangularmotor";
-import { TechnicMediumHubAccelerometerSensor } from "./devices/technicmediumhubaccelerometersensor";
-import { TechnicMediumHubGyroSensor } from "./devices/technicmediumhubgyrosensor";
-import { TechnicMediumHubTiltSensor } from "./devices/technicmediumhubtiltsensor";
-import { TechnicXLargeLinearMotor } from "./devices/technicxlargelinearmotor";
-import { Technic3x3ColorLightMatrix } from "./devices/technic3x3colorlightmatrix";
-import { TiltSensor } from "./devices/tiltsensor";
-import { TrainMotor } from "./devices/trainmotor";
-import { VoltageSensor } from "./devices/voltagesensor";
-import { TachoMotor } from "./devices/tachomotor";
-import { AbsoluteMotor } from "./devices/absolutemotor";
-import { BasicMotor } from "./devices/basicmotor";
+import { ColorDistanceSensor } from "./devices/colordistancesensor.js";
+import { CurrentSensor } from "./devices/currentsensor.js";
+import { Device } from "./devices/device.js";
+import { DuploTrainBaseColorSensor } from "./devices/duplotrainbasecolorsensor.js";
+import { DuploTrainBaseMotor } from "./devices/duplotrainbasemotor.js";
+import { DuploTrainBaseSpeaker } from "./devices/duplotrainbasespeaker.js";
+import { DuploTrainBaseSpeedometer } from "./devices/duplotrainbasespeedometer.js";
+import { HubLED } from "./devices/hubled.js";
+import { Light } from "./devices/light.js";
+import { MediumLinearMotor } from "./devices/mediumlinearmotor.js";
+import { MotionSensor } from "./devices/motionsensor.js";
+import { MoveHubMediumLinearMotor } from "./devices/movehubmediumlinearmotor.js";
+import { MoveHubTiltSensor } from "./devices/movehubtiltsensor.js";
+import { PiezoBuzzer } from "./devices/piezobuzzer.js";
+import { RemoteControlButton } from "./devices/remotecontrolbutton.js";
+import { SimpleMediumLinearMotor } from "./devices/simplemediumlinearmotor.js";
+import { TechnicColorSensor } from "./devices/techniccolorsensor.js";
+import { TechnicDistanceSensor } from "./devices/technicdistancesensor.js";
+import { TechnicForceSensor } from "./devices/technicforcesensor.js";
+import { TechnicLargeAngularMotor } from "./devices/techniclargeangularmotor.js";
+import { TechnicLargeLinearMotor } from "./devices/techniclargelinearmotor.js";
+import { TechnicSmallAngularMotor } from "./devices/technicsmallangularmotor.js";
+import { TechnicMediumAngularMotor } from "./devices/technicmediumangularmotor.js";
+import { TechnicMediumHubAccelerometerSensor } from "./devices/technicmediumhubaccelerometersensor.js";
+import { TechnicMediumHubGyroSensor } from "./devices/technicmediumhubgyrosensor.js";
+import { TechnicMediumHubTiltSensor } from "./devices/technicmediumhubtiltsensor.js";
+import { TechnicXLargeLinearMotor } from "./devices/technicxlargelinearmotor.js";
+import { Technic3x3ColorLightMatrix } from "./devices/technic3x3colorlightmatrix.js";
+import { TiltSensor } from "./devices/tiltsensor.js";
+import { TrainMotor } from "./devices/trainmotor.js";
+import { VoltageSensor } from "./devices/voltagesensor.js";
+import { TachoMotor } from "./devices/tachomotor.js";
+import { AbsoluteMotor } from "./devices/absolutemotor.js";
+import { BasicMotor } from "./devices/basicmotor.js";
 
-import { isWebBluetooth } from "./utils";
+import { isWebBluetooth } from "./utils.js";
 
 export default PoweredUP;
 export {

package/src/interfaces.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from "events";
 
-import * as Consts from "./consts";
+import * as Consts from "./consts.js";
 
 export interface IBLEAbstraction extends EventEmitter {
     uuid: string;
@@ -12,7 +12,7 @@ export interface IBLEAbstraction extends EventEmitter {
     discoverCharacteristicsForService: (uuid: string) => Promise<void>;
     subscribeToCharacteristic: (uuid: string, callback: (data: Buffer) => void) => void;
     addToCharacteristicMailbox: (uuid: string, data: Buffer) => void;
-    readFromCharacteristic: (uuid: string, callback: (err: string | null, data: Buffer | null) => void) => void;
+    readFromCharacteristic: (uuid: string, callback: (err: Error | null, data: Buffer | null) => void) => void;
     writeToCharacteristic: (uuid: string, data: Buffer) => Promise<void>;
 }
 

package/src/nobleabstraction.ts

@@ -1,8 +1,8 @@
-import { Characteristic, Peripheral, Service } from "@abandonware/noble";
+import { Characteristic, Peripheral, Service } from "@stoprocent/noble";
 
-import Debug = require("debug");
+import Debug from "debug";
 import { EventEmitter } from "events";
-import { IBLEAbstraction } from "./interfaces";
+import { IBLEAbstraction } from "./interfaces.js";
 const debug = Debug("bledevice");
 
 
@@ -63,7 +63,7 @@ export class NobleDevice extends EventEmitter implements IBLEAbstraction {
     public connect () {
         return new Promise<void>((resolve, reject) => {
             this._connecting = true;
-            this._noblePeripheral.connect((err: string) => {
+            this._noblePeripheral.connect((err: Error | undefined) => {
                 if(err) {
                     return reject(err);
                 }
@@ -89,7 +89,7 @@ export class NobleDevice extends EventEmitter implements IBLEAbstraction {
     public discoverCharacteristicsForService (uuid: string) {
         return new Promise<void>(async (discoverResolve, discoverReject) => {
             uuid = this._sanitizeUUID(uuid);
-            this._noblePeripheral.discoverServices([uuid], (err: string, services: Service[]) => {
+            this._noblePeripheral.discoverServices([uuid], (err: Error | undefined, services: Service[]) => {
                 if (err) {
                     return discoverReject(err);
                 }
@@ -120,9 +120,9 @@ export class NobleDevice extends EventEmitter implements IBLEAbstraction {
         this._characteristics[uuid].on("data", (data: Buffer) => {
             return callback(data);
         });
-        this._characteristics[uuid].subscribe((err) => {
+        this._characteristics[uuid].subscribe((err: Error | undefined) => {
             if (err) {
-                throw new Error(err);
+                throw err;
             }
         });
     }
@@ -133,10 +133,10 @@ export class NobleDevice extends EventEmitter implements IBLEAbstraction {
     }
 
 
-    public readFromCharacteristic (uuid: string, callback: (err: string | null, data: Buffer | null) => void) {
+    public readFromCharacteristic (uuid: string, callback: (err: Error | null, data: Buffer | null) => void) {
         uuid = this._sanitizeUUID(uuid);
-        this._characteristics[uuid].read((err: string, data: Buffer) => {
-            return callback(err, data);
+        this._characteristics[uuid].read((err: Error | undefined, data: Buffer) => {
+            return callback(err ?? null, data);
         });
     }
 

package/src/poweredup-browser.ts

@@ -1,21 +1,23 @@
-import { WebBLEDevice } from "./webbleabstraction";
+/// <reference types="web-bluetooth" />
 
-import { BaseHub } from "./hubs/basehub";
-import { DuploTrainBase } from "./hubs/duplotrainbase";
-import { Hub } from "./hubs/hub";
-import { Mario } from "./hubs/mario";
-import { MoveHub } from "./hubs/movehub";
-import { RemoteControl } from "./hubs/remotecontrol";
-import { TechnicMediumHub } from "./hubs/technicmediumhub";
-import { WeDo2SmartHub } from "./hubs/wedo2smarthub";
+import { WebBLEDevice } from "./webbleabstraction.js";
 
-import * as Consts from "./consts";
+import { BaseHub } from "./hubs/basehub.js";
+import { DuploTrainBase } from "./hubs/duplotrainbase.js";
+import { Hub } from "./hubs/hub.js";
+import { Mario } from "./hubs/mario.js";
+import { MoveHub } from "./hubs/movehub.js";
+import { RemoteControl } from "./hubs/remotecontrol.js";
+import { TechnicMediumHub } from "./hubs/technicmediumhub.js";
+import { WeDo2SmartHub } from "./hubs/wedo2smarthub.js";
+
+import * as Consts from "./consts.js";
 
 import { EventEmitter } from "events";
 
-import Debug = require("debug");
-import { IBLEAbstraction } from "./interfaces";
-import { TechnicSmallHub } from "./hubs/technicsmallhub";
+import Debug from "debug";
+import { IBLEAbstraction } from "./interfaces.js";
+import { TechnicSmallHub } from "./hubs/technicsmallhub.js";
 const debug = Debug("poweredup");
 
 
@@ -37,7 +39,6 @@ export class PoweredUP extends EventEmitter {
 
     /**
      * Begin scanning for Powered UP Hub devices.
-     * @method PoweredUP#scan
      */
     public async scan () {
 
@@ -77,7 +78,6 @@ export class PoweredUP extends EventEmitter {
 
     /**
      * Retrieve a list of Powered UP Hubs.
-     * @method PoweredUP#getHubs
      * @returns {BaseHub[]}
      */
     public getHubs () {
@@ -87,7 +87,6 @@ export class PoweredUP extends EventEmitter {
 
     /**
      * Retrieve a Powered UP Hub by UUID.
-     * @method PoweredUP#getHubByUUID
      * @param {string} uuid
      * @returns {BaseHub | null}
      */
@@ -98,7 +97,6 @@ export class PoweredUP extends EventEmitter {
 
     /**
      * Retrieve a Powered UP Hub by primary MAC address.
-     * @method PoweredUP#getHubByPrimaryMACAddress
      * @param {string} address
      * @returns {BaseHub}
      */
@@ -109,7 +107,6 @@ export class PoweredUP extends EventEmitter {
 
     /**
      * Retrieve a list of Powered UP Hub by name.
-     * @method PoweredUP#getHubsByName
      * @param {string} name
      * @returns {BaseHub[]}
      */
@@ -120,7 +117,6 @@ export class PoweredUP extends EventEmitter {
 
     /**
      * Retrieve a list of Powered UP Hub by type.
-     * @method PoweredUP#getHubsByType
      * @param {string} name
      * @returns {BaseHub[]}
      */
@@ -130,9 +126,9 @@ export class PoweredUP extends EventEmitter {
 
 
     private _determineLPF2HubType (device: IBLEAbstraction): Promise<Consts.HubType> {
-        return new Promise((resolve) => {
+        return new Promise(async (resolve) => {
             let buf: Buffer = Buffer.alloc(0);
-            device.subscribeToCharacteristic(Consts.BLECharacteristic.LPF2_ALL, (data: Buffer) => {
+            await device.subscribeToCharacteristic(Consts.BLECharacteristic.LPF2_ALL, (data: Buffer) => {
                 buf = Buffer.concat([buf, data]);
                 while (buf[0] <= buf.length) {
                     const len = buf[0];
@@ -158,6 +154,9 @@ export class PoweredUP extends EventEmitter {
                             case Consts.BLEManufacturerData.TECHNIC_MEDIUM_HUB_ID:
                                 resolve(Consts.HubType.TECHNIC_MEDIUM_HUB);
                                 break;
+                            case Consts.BLEManufacturerData.MARIO_ID:
+                                resolve(Consts.HubType.MARIO);
+                                break;
                         }
                         debug("Hub type determined");
                     } else {

package/src/poweredup-node.ts

@@ -1,24 +1,24 @@
-import { Peripheral } from "@abandonware/noble";
+import { Peripheral } from "@stoprocent/noble";
 
-import { NobleDevice } from "./nobleabstraction";
+import { NobleDevice } from "./nobleabstraction.js";
 
-import { BaseHub } from "./hubs/basehub";
-import { DuploTrainBase } from "./hubs/duplotrainbase";
-import { Hub } from "./hubs/hub";
-import { Mario } from "./hubs/mario";
-import { MoveHub } from "./hubs/movehub";
-import { RemoteControl } from "./hubs/remotecontrol";
-import { TechnicMediumHub } from "./hubs/technicmediumhub";
-import { WeDo2SmartHub } from "./hubs/wedo2smarthub";
+import { BaseHub } from "./hubs/basehub.js";
+import { DuploTrainBase } from "./hubs/duplotrainbase.js";
+import { Hub } from "./hubs/hub.js";
+import { Mario } from "./hubs/mario.js";
+import { MoveHub } from "./hubs/movehub.js";
+import { RemoteControl } from "./hubs/remotecontrol.js";
+import { TechnicMediumHub } from "./hubs/technicmediumhub.js";
+import { WeDo2SmartHub } from "./hubs/wedo2smarthub.js";
 
-import * as Consts from "./consts";
+import * as Consts from "./consts.js";
 
 import { EventEmitter } from "events";
 
-import Debug = require("debug");
+import Debug from "debug";
 const debug = Debug("poweredup");
-import noble = require("@abandonware/noble");
-import { TechnicSmallHub } from "./hubs/technicsmallhub";
+import noble from "@stoprocent/noble";
+import { TechnicSmallHub } from "./hubs/technicsmallhub.js";
 
 let ready = false;
 let wantScan = false;
@@ -67,7 +67,6 @@ export class PoweredUP extends EventEmitter {
 
     /**
      * Begin scanning for Powered UP Hub devices.
-     * @method PoweredUP#scan
      */
     public async scan () {
         wantScan = true;
@@ -85,7 +84,6 @@ export class PoweredUP extends EventEmitter {
 
     /**
      * Stop scanning for Powered UP Hub devices.
-     * @method PoweredUP#stop
      */
     public stop () {
         wantScan = false;
@@ -97,7 +95,6 @@ export class PoweredUP extends EventEmitter {
 
     /**
      * Retrieve a list of Powered UP Hubs.
-     * @method PoweredUP#getHubs
      * @returns {BaseHub[]}
      */
     public getHubs () {
@@ -107,7 +104,6 @@ export class PoweredUP extends EventEmitter {
 
     /**
      * Retrieve a Powered UP Hub by UUID.
-     * @method PoweredUP#getHubByUUID
      * @param {string} uuid
      * @returns {BaseHub | null}
      */
@@ -118,7 +114,6 @@ export class PoweredUP extends EventEmitter {
 
     /**
      * Retrieve a Powered UP Hub by primary MAC address.
-     * @method PoweredUP#getHubByPrimaryMACAddress
      * @param {string} address
      * @returns {BaseHub}
      */
@@ -129,7 +124,6 @@ export class PoweredUP extends EventEmitter {
 
     /**
      * Retrieve a list of Powered UP Hub by name.
-     * @method PoweredUP#getHubsByName
      * @param {string} name
      * @returns {BaseHub[]}
      */
@@ -140,8 +134,7 @@ export class PoweredUP extends EventEmitter {
 
     /**
      * Retrieve a list of Powered UP Hub by type.
-     * @method PoweredUP#getHubsByType
-     * @param {string} name
+     * @param {number} hubType
      * @returns {BaseHub[]}
      */
     public getHubsByType (hubType: number) {

package/src/utils.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from "events";
-import { Device } from "./devices/device";
+import { Device } from "./devices/device.js";
 
 // @ts-ignore
 export const isWebBluetooth = !!(typeof navigator !== "undefined" && navigator && navigator.bluetooth);

package/src/webbleabstraction.ts

@@ -1,6 +1,6 @@
-import Debug = require("debug");
+import Debug from "debug";
 import { EventEmitter } from "events";
-import { IBLEAbstraction } from "./interfaces";
+import { IBLEAbstraction } from "./interfaces.js";
 const debug = Debug("bledevice");
 
 
@@ -85,7 +85,7 @@ export class WebBLEDevice extends EventEmitter implements IBLEAbstraction {
     }
 
 
-    public subscribeToCharacteristic (uuid: string, callback: (data: Buffer) => void) {
+    public subscribeToCharacteristic (uuid: string, callback: (data: Buffer) => void): Promise<any> {
         if (this._listeners[uuid]) {
             this._characteristics[uuid].removeEventListener("characteristicvaluechanged", this._listeners[uuid]);
         }
@@ -108,7 +108,7 @@ export class WebBLEDevice extends EventEmitter implements IBLEAbstraction {
             callback(data);
         }
 
-        this._characteristics[uuid].startNotifications();
+        return this._characteristics[uuid].startNotifications();
     }
 
 
@@ -117,7 +117,7 @@ export class WebBLEDevice extends EventEmitter implements IBLEAbstraction {
     }
 
 
-    public readFromCharacteristic (uuid: string, callback: (err: string | null, data: Buffer | null) => void) {
+    public readFromCharacteristic (uuid: string, callback: (err: Error | null, data: Buffer | null) => void) {
         // @ts-ignore
         this._characteristics[uuid].readValue().then((data) => {
             const buf = Buffer.alloc(data.buffer.byteLength);

package/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/color.ts","./src/consts.ts","./src/index-browser.ts","./src/index-node.ts","./src/interfaces.ts","./src/nobleabstraction.ts","./src/poweredup-browser.ts","./src/poweredup-node.ts","./src/utils.ts","./src/webbleabstraction.ts","./src/devices/absolutemotor.ts","./src/devices/basicmotor.ts","./src/devices/colordistancesensor.ts","./src/devices/currentsensor.ts","./src/devices/device.ts","./src/devices/duplotrainbasecolorsensor.ts","./src/devices/duplotrainbasemotor.ts","./src/devices/duplotrainbasespeaker.ts","./src/devices/duplotrainbasespeedometer.ts","./src/devices/hubled.ts","./src/devices/light.ts","./src/devices/marioaccelerometer.ts","./src/devices/mariobarcodesensor.ts","./src/devices/mariopantssensor.ts","./src/devices/mediumlinearmotor.ts","./src/devices/motionsensor.ts","./src/devices/movehubmediumlinearmotor.ts","./src/devices/movehubtiltsensor.ts","./src/devices/piezobuzzer.ts","./src/devices/remotecontrolbutton.ts","./src/devices/simplemediumlinearmotor.ts","./src/devices/tachomotor.ts","./src/devices/technic3x3colorlightmatrix.ts","./src/devices/techniccolorsensor.ts","./src/devices/technicdistancesensor.ts","./src/devices/technicforcesensor.ts","./src/devices/techniclargeangularmotor.ts","./src/devices/techniclargelinearmotor.ts","./src/devices/technicmediumangularmotor.ts","./src/devices/technicmediumhubaccelerometersensor.ts","./src/devices/technicmediumhubgyrosensor.ts","./src/devices/technicmediumhubtiltsensor.ts","./src/devices/technicsmallangularmotor.ts","./src/devices/technicxlargelinearmotor.ts","./src/devices/tiltsensor.ts","./src/devices/trainmotor.ts","./src/devices/voltagesensor.ts","./src/hubs/basehub.ts","./src/hubs/duplotrainbase.ts","./src/hubs/hub.ts","./src/hubs/lpf2hub.ts","./src/hubs/mario.ts","./src/hubs/movehub.ts","./src/hubs/remotecontrol.ts","./src/hubs/technicmediumhub.ts","./src/hubs/technicsmallhub.ts","./src/hubs/wedo2smarthub.ts"],"version":"5.9.3"}

package/typedoc.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/index-node.ts"],
+  "out": "docs",
+  "name": "node-poweredup",
+  "readme": "README.md",
+  "excludePrivate": true,
+  "excludeProtected": true,
+  "excludeInternal": true,
+  "intentionallyNotExported": ["IDeviceInterface", "IBLEAbstraction", "Output"],
+  "navigationLinks": {
+    "GitHub": "https://github.com/nathankellenicki/node-poweredup"
+  }
+}

package/.jsdoc.json

@@ -1,41 +0,0 @@
-{
-    "tags": {
-        "allowUnknownTags": true,
-        "dictionaries": ["jsdoc"]
-    },
-    "source": {
-        "include": [ "README.md", "dist/node" ],
-        "includePattern": ".js$"
-    },
-    "plugins": ["plugins/markdown"],
-    "templates": {
-        "referenceTitle": "node-poweredup Reference",
-        "logoFile": "",
-        "cleverLinks": false,
-        "monospaceLinks": false,
-        "dateFormat": "ddd MMM Do YYYY",
-        "outputSourceFiles": true,
-        "outputSourcePath": true,
-        "systemName": "node-poweredup",
-        "footer": "",
-        "copyright": "node-poweredup by Nathan Kellenicki licensed under the MIT license.",
-        "navType": "vertical",
-        "theme": "simplex",
-        "linenums": true,
-        "collapseSymbols": false,
-        "inverseNav": true,
-        "protocol": "html://",
-        "methodHeadingReturns": false
-    },
-    "markdown": {
-        "parser": "gfm",
-        "hardwrap": true
-    },
-    "opts": {
-        "destination": "./docs/",
-        "encoding": "utf8",
-        "private": true,
-        "recurse": true,
-        "template": "./jsdoc-template/braintree"
-    }
-}

package/abandonware-noble.d.ts

@@ -1,129 +0,0 @@
-declare module "@abandonware/noble" {
-    // Type definitions for noble
-    // Project: https://github.com/sandeepmistry/noble
-    // Definitions by: Seon-Wook Park <https://github.com/swook>
-    //                 Shantanu Bhadoria <https://github.com/shantanubhadoria>
-    //                 Luke Libraro <https://github.com/lukel99>
-    //                 Dan Chao <https://github.com/bioball>
-    //                 Michal Lower <https://github.com/keton>
-    //                 Rob Moran <https://github.com/thegecko>
-    // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-
-    /// <reference types="node" />
-
-    import events = require("events");
-
-    export function startScanning(callback?: (error?: Error) => void): void;
-    export function startScanning(serviceUUIDs: string[], callback?: (error?: Error) => void): void;
-    export function startScanning(serviceUUIDs: string[], allowDuplicates: boolean, callback?: (error?: Error) => void): void;
-    export function stopScanning(callback?: () => void): void;
-
-    export function on(event: "stateChange", listener: (state: string) => void): events.EventEmitter;
-    export function on(event: "scanStart", listener: () => void): events.EventEmitter;
-    export function on(event: "scanStop", listener: () => void): events.EventEmitter;
-    export function on(event: "discover", listener: (peripheral: Peripheral) => void): events.EventEmitter;
-    export function on(event: string, listener: Function): events.EventEmitter;
-
-    export function removeListener(event: "stateChange", listener: (state: string) => void): events.EventEmitter;
-    export function removeListener(event: "scanStart", listener: () => void): events.EventEmitter;
-    export function removeListener(event: "scanStop", listener: () => void): events.EventEmitter;
-    export function removeListener(event: "discover", listener: (peripheral: Peripheral) => void): events.EventEmitter;
-    export function removeListener(event: string, listener: Function): events.EventEmitter;
-
-    export var state:string;
-
-    export class Peripheral extends events.EventEmitter {
-        id:            string;
-        uuid:          string;
-        address:       string;
-        addressType:   string;
-        connectable:   boolean;
-        advertisement: Advertisement;
-        rssi:          number;
-        services:      Service[];
-        state:         'error' | 'connecting' | 'connected' | 'disconnecting' | 'disconnected';
-
-        connect(callback?: (error: string) => void): void;
-        disconnect(callback?: () => void): void;
-        updateRssi(callback?: (error: string, rssi: number) => void): void;
-        discoverServices(serviceUUIDs: string[], callback?: (error: string, services: Service[]) => void): void;
-        discoverAllServicesAndCharacteristics(callback?: (error: string, services: Service[], characteristics: Characteristic[]) => void): void;
-        discoverSomeServicesAndCharacteristics(serviceUUIDs: string[], characteristicUUIDs: string[], callback?: (error: string, services: Service[], characteristics: Characteristic[]) => void): void;
-
-        readHandle(handle: Buffer, callback: (error: string, data: Buffer) => void): void;
-        writeHandle(handle: Buffer, data: Buffer, withoutResponse: boolean, callback: (error: string) => void): void;
-        toString(): string;
-
-        on(event: "connect", listener: (error: string) => void): this;
-        on(event: "disconnect", listener: (error: string) => void): this;
-        on(event: "rssiUpdate", listener: (rssi: number) => void): this;
-        on(event: "servicesDiscover", listener: (services: Service[]) => void): this;
-        on(event: string, listener: Function): this;
-    }
-
-    export interface Advertisement {
-        localName: string;
-        serviceData: {
-            uuid: string,
-            data: Buffer
-        };
-        txPowerLevel: number;
-        manufacturerData: Buffer;
-        serviceUuids: string[];
-    }
-
-    export class Service extends events.EventEmitter {
-        uuid: string;
-        name: string;
-        type: string;
-        includedServiceUuids: string[];
-        characteristics: Characteristic[];
-
-        discoverIncludedServices(serviceUUIDs: string[], callback?: (error: string, includedServiceUuids: string[]) => void): void;
-        discoverCharacteristics(characteristicUUIDs: string[], callback?: (error: string, characteristics: Characteristic[]) => void): void;
-        toString(): string;
-
-        on(event: "includedServicesDiscover", listener: (includedServiceUuids: string[]) => void): this;
-        on(event: "characteristicsDiscover", listener: (characteristics: Characteristic[]) => void): this;
-        on(event: string, listener: Function): this;
-    }
-
-    export class Characteristic extends events.EventEmitter {
-        uuid: string;
-        name: string;
-        type: string;
-        properties: string[];
-        descriptors: Descriptor[];
-
-        read(callback?: (error: string, data: Buffer) => void): void;
-        write(data: Buffer, notify: boolean, callback?: (error: string) => void): void;
-        broadcast(broadcast: boolean, callback?: (error: string) => void): void;
-        notify(notify: boolean, callback?: (error: string) => void): void;
-        discoverDescriptors(callback?: (error: string, descriptors: Descriptor[]) => void): void;
-        toString(): string;
-        subscribe(callback?: (error: string) => void): void;
-        unsubscribe(callback?: (error: string) => void): void;
-
-        on(event: "read", listener: (data: Buffer, isNotification: boolean) => void): this;
-        on(event: "write", withoutResponse: boolean, listener: (error: string) => void): this;
-        on(event: "broadcast", listener: (state: string) => void): this;
-        on(event: "notify", listener: (state: string) => void): this;
-        on(event: "descriptorsDiscover", listener: (descriptors: Descriptor[]) => void): this;
-        on(event: string, listener: Function): this;
-        on(event: string, option: boolean, listener: Function): this;
-    }
-
-    export class Descriptor extends events.EventEmitter {
-        uuid: string;
-        name: string;
-        type: string;
-
-        readValue(callback?: (error: string, data: Buffer) => void): void;
-        writeValue(data: Buffer, callback?: (error: string) => void): void;
-        toString(): string;
-
-        on(event: "valueRead", listener: (error: string, data: Buffer) => void): this;
-        on(event: "valueWrite", listener: (error: string) => void): this;
-        on(event: string, listener: Function): this;
-    }
-}