boost-movehub/src/messages/PortInputFormatSetup.js

Connects with your Lego Boost Movehub vie Bluetooth Low Energy (BLE).

const PortInputFormat = require("./PortInputFormat");
const { int32ToArray } = require("../helpers");

/**
 * Downstream message to setup receiving single value sensor updates
 *
 * As defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-input-format-setup-single
 */
class PortInputFormatSetup extends PortInputFormat {
  constructor(...args) {
    super(...args);
    this.displayName = "PortInputFormatSetup";
  }
}

/**
 * Instantiates a proper PortInputFormatSetup to send to Hub
 *
 * @param {number} portId Port ID to subscribe updates for
 * @param {Object} [options]
 * @param {number} [options.mode]
 * @param {number} [options.deltaInterval] Interval of change the value has to change to trigger update (1 is kind of live data).
 * @param {number} [options.notificationEnabled] Defines if messages should be send back on a regular base.
 * @returns {PortInputFormatSetup}
 */
PortInputFormatSetup.build = function build(portId, options = {}) {
  const mode = options.mode || 0x00;
  const deltaInterval = options.deltaInterval || 1;
  const notificationEnabled =
    options.notificationEnabled !== undefined
      ? options.notificationEnabled
      : PortInputFormatSetup.ENABLE_NOTIFICATONS;
  return new PortInputFormatSetup(
    Buffer.from([
      0x0a,
      0x00,
      PortInputFormatSetup.TYPE,
      portId,
      mode,
      ...int32ToArray(deltaInterval),
      notificationEnabled
    ])
  );
};

PortInputFormatSetup.TYPE = 0x41;

PortInputFormatSetup.DISABLE_NOTIFICATONS = 0x00;
PortInputFormatSetup.ENABLE_NOTIFICATONS = 0x01;

module.exports = PortInputFormatSetup;