node-poweredup 8.0.5 → 10.0.0

package/src/devices/colordistancesensor.ts

@@ -1,9 +1,9 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
-import { parseColor } from "../utils";
+import * as Consts from "../consts.js";
+import { parseColor } from "../utils.js";
 
 /**
  * @class ColorDistanceSensor
@@ -157,7 +157,6 @@ export class ColorDistanceSensor extends Device {
      * Switches the IR receiver into extended channel mode. After setting this, use channels 5-8 instead of 1-4 for this receiver.
      *
      * NOTE: Calling this with channel 5-8 with switch off extended channel mode for this receiver.
-     * @method ColorDistanceSensor#setPFExtendedChannel
      * @param {number} channel Channel number, between 1-8
      * @returns {Promise} Resolved upon successful issuance of the command.
      */
@@ -177,7 +176,6 @@ export class ColorDistanceSensor extends Device {
 
     /**
      * Set the power of a Power Functions motor via IR
-     * @method ColorDistanceSensor#setPFPower
      * @param {number} channel Channel number, between 1-4
      * @param {string} output Outport port, "RED" (A) or "BLUE" (B)
      * @param {number} power -7 (full reverse) to 7 (full forward). 0 is stop. 8 is brake.
@@ -201,10 +199,9 @@ export class ColorDistanceSensor extends Device {
      * Start Power Functions motors running via IR
      *
      * NOTE: This command is designed for bang-bang style operation. To keep the motors running, the sensor needs to be within range of the IR receiver constantly.
-     * @method ColorDistanceSensor#startPFMotors
-     * @param {Buffer} channel Channel number, between 1-4
-     * @param {Buffer} powerA -7 (full reverse) to 7 (full forward). 0 is stop. 8 is brake.
-     * @param {Buffer} powerB -7 (full reverse) to 7 (full forward). 0 is stop. 8 is brake.
+     * @param {number} channel Channel number, between 1-4
+     * @param {number} powerBlue -7 (full reverse) to 7 (full forward). 0 is stop. 8 is brake.
+     * @param {number} powerRed -7 (full reverse) to 7 (full forward). 0 is stop. 8 is brake.
      * @returns {Promise} Resolved upon successful issuance of the command.
      */
     public startPFMotors (channel: number, powerBlue: number, powerRed: number) {
@@ -223,7 +220,6 @@ export class ColorDistanceSensor extends Device {
 
     /**
      * Send a raw Power Functions IR command
-     * @method ColorDistanceSensor#sendPFIRMessage
      * @param {Buffer} message 2 byte payload making up a Power Functions protocol command. NOTE: Only specify nibbles 1-3, nibble 4 should be zeroed.
      * @returns {Promise} Resolved upon successful issuance of the command.
      */
@@ -242,7 +238,6 @@ export class ColorDistanceSensor extends Device {
 
     /**
      * Set the color of the LED on the sensor via a color value.
-     * @method ColorDistanceSensor#setColor
      * @param {Color} color
      * @returns {Promise} Resolved upon successful issuance of the command.
      */
@@ -263,8 +258,7 @@ export class ColorDistanceSensor extends Device {
 
     /**
      * Set the distance count value.
-     * @method ColorDistanceSensor#setDistanceCount
-     * @param {count} distance count between 0 and 2^32
+     * @param {number} count distance count between 0 and 2^32
      * @returns {Promise} Resolved upon successful issuance of the command.
      */
     public setDistanceCount (count: number) {

package/src/devices/currentsensor.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class CurrentSensor

package/src/devices/device.ts

@@ -1,8 +1,8 @@
 import { EventEmitter } from "events";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class Device
@@ -25,7 +25,7 @@ export class Device extends EventEmitter {
 
     private _isWeDo2SmartHub: boolean;
     private _isVirtualPort: boolean = false;
-    private _eventTimer: NodeJS.Timer | null = null;
+    private _eventTimer: NodeJS.Timeout | null = null;
 
     constructor (hub: IDeviceInterface, portId: number, modeMap: {[event: string]: number} = {}, type: Consts.DeviceType = Consts.DeviceType.UNKNOWN) {
         super();
@@ -178,7 +178,7 @@ export class Device extends EventEmitter {
         }
     }
 
-    public setEventTimer (timer: NodeJS.Timer) {
+    public setEventTimer (timer: NodeJS.Timeout) {
         this._eventTimer = timer;
     }
 

package/src/devices/duplotrainbasecolorsensor.ts

@@ -1,9 +1,9 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
-import { parseColor } from "../utils";
+import * as Consts from "../consts.js";
+import { parseColor } from "../utils.js";
 
 /**
  * @class DuploTrainBaseColorSensor

package/src/devices/duplotrainbasemotor.ts

@@ -1,8 +1,8 @@
-import { BasicMotor } from "./basicmotor";
+import { BasicMotor } from "./basicmotor.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class DuploTrainBaseMotor

package/src/devices/duplotrainbasespeaker.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class DuploTrainBaseSpeaker
@@ -16,7 +16,6 @@ export class DuploTrainBaseSpeaker extends Device {
 
     /**
      * Play a built-in train sound.
-     * @method DuploTrainBaseSpeaker#playSound
      * @param {DuploTrainBaseSound} sound
      * @returns {Promise} Resolved upon successful issuance of the command.
      */
@@ -30,7 +29,6 @@ export class DuploTrainBaseSpeaker extends Device {
 
     /**
      * Play a built-in system tone.
-     * @method DuploTrainBaseSpeaker#playTone
      * @param {number} tone
      * @returns {Promise} Resolved upon successful issuance of the command.
      */

package/src/devices/duplotrainbasespeedometer.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class DuploTraniBaseSpeedometer

package/src/devices/hubled.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class HubLED
@@ -18,7 +18,6 @@ export class HubLED extends Device {
 
     /**
      * Set the color of the LED on the Hub via a color value.
-     * @method HubLED#setColor
      * @param {Color} color
      * @returns {Promise} Resolved upon successful issuance of the command.
      */
@@ -41,7 +40,6 @@ export class HubLED extends Device {
 
     /**
      * Set the color of the LED on the Hub via RGB values.
-     * @method HubLED#setRGB
      * @param {number} red
      * @param {number} green
      * @param {number} blue

package/src/devices/light.ts

@@ -1,9 +1,9 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
-import { calculateRamp } from "../utils";
+import * as Consts from "../consts.js";
+import { calculateRamp } from "../utils.js";
 
 /**
  * @class Light
@@ -19,7 +19,6 @@ export class Light extends Device {
 
     /**
      * Set the light brightness.
-     * @method Light#setBrightness
      * @param {number} brightness Brightness value between 0-100 (0 is off)
      * @returns {Promise} Resolved upon successful completion of command.
      */
@@ -36,7 +35,6 @@ export class Light extends Device {
 
     /**
      * Ramp the light brightness.
-     * @method Light#rampBrightness
      * @param {number} fromBrightness Brightness value between 0-100 (0 is off)
      * @param {number} toBrightness Brightness value between 0-100 (0 is off)
      * @param {number} time How long the ramp should last (in milliseconds).

package/src/devices/marioaccelerometer.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class MarioAccelerometer

package/src/devices/mariobarcodesensor.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class MarioBarcodeSensor

package/src/devices/mariopantssensor.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class MarioPantsSensor

package/src/devices/mediumlinearmotor.ts

@@ -1,8 +1,8 @@
-import { TachoMotor } from "./tachomotor";
+import { TachoMotor } from "./tachomotor.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class MediumLinearMotor

package/src/devices/motionsensor.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class MotionSensor

package/src/devices/movehubmediumlinearmotor.ts

@@ -1,8 +1,8 @@
-import { TachoMotor } from "./tachomotor";
+import { TachoMotor } from "./tachomotor.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class MoveHubMediumLinearMotor

package/src/devices/movehubtiltsensor.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class MoveHubTiltSensor

package/src/devices/piezobuzzer.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class PiezoBuzzer
@@ -18,7 +18,6 @@ export class PiezoBuzzer extends Device {
 
     /**
      * Play a tone on the Hub's in-built buzzer
-     * @method PiezoBuzzer#playTone
      * @param {number} frequency
      * @param {number} time How long the tone should play for (in milliseconds).
      * @returns {Promise} Resolved upon successful completion of command (ie. once the tone has finished playing).

package/src/devices/remotecontrolbutton.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class RemoteControlButton
@@ -21,7 +21,7 @@ export class RemoteControlButton extends Device {
             case Mode.BUTTON_EVENTS:
                 /**
                  * Emits when a button on the remote is pressed or released.
-                 * @event RemoteControlButton#button
+                 * @event RemoteControlButton#remoteButton
                  * @type {object}
                  * @param {number} event
                  */

package/src/devices/simplemediumlinearmotor.ts

@@ -1,8 +1,8 @@
-import { BasicMotor } from "./basicmotor";
+import { BasicMotor } from "./basicmotor.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class SimpleMediumLinearMotor

package/src/devices/tachomotor.ts

@@ -1,9 +1,9 @@
-import { BasicMotor } from "./basicmotor";
+import { BasicMotor } from "./basicmotor.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
-import { mapSpeed } from "../utils";
+import * as Consts from "../consts.js";
+import { mapSpeed } from "../utils.js";
 
 /**
  * @class TachoMotor
@@ -42,7 +42,6 @@ export class TachoMotor extends BasicMotor {
      * Set the braking style of the motor.
      *
      * Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-     * @method TachoMotor#setBrakingStyle
      * @param {number} style Either BRAKE or HOLD
      */
     public setBrakingStyle (style: Consts.BrakingStyle) {
@@ -54,8 +53,7 @@ export class TachoMotor extends BasicMotor {
      * Set the max power of the motor.
      *
      * Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-     * @method TachoMotor#setMaxPower
-     * @param {number} style Either BRAKE or HOLD
+     * @param {number} maxPower Maximum power level (0-100)
      */
     public setMaxPower (maxPower: number) {
         this._maxPower = maxPower;
@@ -64,7 +62,6 @@ export class TachoMotor extends BasicMotor {
 
     /**
      * Set the global acceleration time
-     * @method TachoMotor#setAccelerationTime
      * @param {number} time How long acceleration should last (in milliseconds).
      * @returns {Promise} Resolved upon successful completion of command (ie. once the motor is finished).
      */
@@ -77,7 +74,6 @@ export class TachoMotor extends BasicMotor {
 
     /**
      * Set the global deceleration time
-     * @method TachoMotor#setDecelerationTime
      * @param {number} time How long deceleration should last (in milliseconds).
      * @returns {Promise} Resolved upon successful completion of command (ie. once the motor is finished).
      */
@@ -90,7 +86,6 @@ export class TachoMotor extends BasicMotor {
 
     /**
      * Set the motor speed.
-     * @method TachoMotor#setSpeed
      * @param {number} speed For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.
      * @param {number} time How long the motor should run for (in milliseconds).
      * @returns {Promise} Resolved upon successful issuance of the command.
@@ -131,7 +126,6 @@ export class TachoMotor extends BasicMotor {
 
     /**
      * Rotate a motor by a given amount of degrees.
-     * @method TachoMotor#rotateByDegrees
      * @param {number} degrees How much the motor should be rotated (in degrees).
      * @param {number} [speed=100] For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100.
      * @returns {Promise} Resolved upon successful completion of command (ie. once the motor is finished).

package/src/devices/technic3x3colorlightmatrix.ts

@@ -1,10 +1,10 @@
-import { Color } from "../color";
+import { Color } from "../color.js";
 
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class Technic3x3ColorLightMatrix
@@ -20,7 +20,6 @@ export class Technic3x3ColorLightMatrix extends Device {
 
     /**
      * Set the LED matrix, one color per LED
-     * @method Technic3x3ColorLightMatrix#setMatrix
      * @param {Color[] | Color} colors Array of 9 colors, 9 Color objects, or a single color
      * @returns {Promise} Resolved upon successful issuance of the command.
      */

package/src/devices/techniccolorsensor.ts

@@ -1,9 +1,9 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
-import { parseColor } from "../utils";
+import * as Consts from "../consts.js";
+import { parseColor } from "../utils.js";
 
 /**
  * @class TechnicColorSensor
@@ -61,7 +61,6 @@ export class TechnicColorSensor extends Device {
 
     /**
      * Set the brightness (or turn on/off) of the lights around the sensor.
-     * @method TechnicColorSensor#setBrightness
      * @param {number} firstSegment First light segment. 0-100 brightness.
      * @param {number} secondSegment Second light segment. 0-100 brightness.
      * @param {number} thirdSegment Third light segment. 0-100 brightness.

package/src/devices/technicdistancesensor.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class TechnicDistanceSensor
@@ -46,7 +46,6 @@ export class TechnicDistanceSensor extends Device {
 
     /**
      * Set the brightness (or turn on/off) of the lights around the eyes.
-     * @method TechnicDistanceSensor#setBrightness
      * @param {number} topLeft Top left quadrant (above left eye). 0-100 brightness.
      * @param {number} bottomLeft Bottom left quadrant (below left eye). 0-100 brightness.
      * @param {number} topRight Top right quadrant (above right eye). 0-100 brightness.

package/src/devices/technicforcesensor.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class TechnicForceSensor

package/src/devices/techniclargeangularmotor.ts

@@ -1,8 +1,8 @@
-import { AbsoluteMotor } from "./absolutemotor";
+import { AbsoluteMotor } from "./absolutemotor.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class TechnicLargeAngularMotor

package/src/devices/techniclargelinearmotor.ts

@@ -1,8 +1,8 @@
-import { AbsoluteMotor } from "./absolutemotor";
+import { AbsoluteMotor } from "./absolutemotor.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class TechnicLargeLinearMotor

package/src/devices/technicmediumangularmotor.ts

@@ -1,8 +1,8 @@
-import { AbsoluteMotor } from "./absolutemotor";
+import { AbsoluteMotor } from "./absolutemotor.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class TechnicMediumAngularMotor

package/src/devices/technicmediumhubaccelerometersensor.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class TechnicMediumHubAccelerometerSensor

package/src/devices/technicmediumhubgyrosensor.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class TechnicMediumHubGyroSensor

package/src/devices/technicmediumhubtiltsensor.ts

@@ -1,8 +1,8 @@
-import { Device } from "./device";
+import { Device } from "./device.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class TechnicMediumHubTiltSensor
@@ -57,15 +57,14 @@ export class TechnicMediumHubTiltSensor extends Device {
                  * @type {object}
                  * @param {number} number of impact events.
                  */
-                this.notify("tiltCount", { count });
+                this.notify("impactCount", { count });
                 break;
         }
     }
 
     /**
      * Set the impact count value.
-     * @method TechnicMediumHubTiltSensor#setImpactCount
-     * @param {count} impact count between 0 and 2^32
+     * @param {number} count impact count between 0 and 2^32
      * @returns {Promise} Resolved upon successful issuance of the command.
      */
     public setImpactCount (count: number) {
@@ -80,8 +79,7 @@ export class TechnicMediumHubTiltSensor extends Device {
 
     /**
      * Set the impact threshold.
-     * @method TechnicMediumHubTiltSensor#setImpactThreshold
-     * @param {threshold} value between 1 and 127
+     * @param {number} threshold value between 1 and 127
      * @returns {Promise} Resolved upon successful issuance of the command.
      */
     public setImpactThreshold (threshold: number) {
@@ -94,8 +92,7 @@ export class TechnicMediumHubTiltSensor extends Device {
 
     /**
      * Set the impact holdoff time.
-     * @method TechnicMediumHubTiltSensor#setImpactHoldoff
-     * @param {holdoff} value between 1 and 127
+     * @param {number} holdoff value between 1 and 127
      * @returns {Promise} Resolved upon successful issuance of the command.
      */
     public setImpactHoldoff (holdoff: number) {

package/src/devices/technicsmallangularmotor.ts

@@ -1,8 +1,8 @@
-import { AbsoluteMotor } from "./absolutemotor";
+import { AbsoluteMotor } from "./absolutemotor.js";
 
-import { IDeviceInterface } from "../interfaces";
+import { IDeviceInterface } from "../interfaces.js";
 
-import * as Consts from "../consts";
+import * as Consts from "../consts.js";
 
 /**
  * @class TechnicSmallAngularMotor