The Multi class constructs objects that represent a single "breakout" module attached to the physical board. The "breakout" module will itself contain 2 or more components, such as a thermistor and a hygrometer, or an altimeter and a pressure sensor.

Supported multi sensor modules:

This list will continue to be updated as more component support is implemented.

Parameters

  • General Options

    PropertyTypeValue/DescriptionDefaultRequired
    controllerstringBMP180, BMP280, BME280, HTU21D, HIH6130, MPL115A2, MPL3115A2, SI7020, SI7021, MS5611, TH02. The Name of the controller to useyes

Shape

Some of these properties may or may not exist depending on whether the multi sensor supports it.

Property NameDescriptionRead Only
accelerometerAn instance of Accelerometer class.Yes
altimeterAn instance of Altimeter class.Yes
barometerAn instance of Barometer class.Yes
gyroAn instance of Gyro class.Yes
hygrometerAn instance of Hygrometer class.Yes
thermometerAn instance of Thermometer class.Yes
temperatureAn instance of Thermometer class.Yes

Component Initialization

BMP180

new five.Multi({
  controller: "BMP180"
});
Property NameDescriptionRead Only
barometerAn instance of Barometer class.Yes
thermometerAn instance of Thermometer class.Yes
temperatureAn instance of Thermometer class.Yes

HTU21D

new five.Multi({
  controller: "HTU21D"
});
Shape
Property NameDescriptionRead Only
hygrometerAn instance of Hygrometer class.Yes
thermometerAn instance of Thermometer class.Yes
temperatureAn instance of Thermometer class.Yes

HTU21D HTU21D HTU21D HTU21D

HIH6130

new five.Multi({
  controller: "HIH6130"
});

HIH6130

MPL115A2

new five.Multi({
  controller: "MPL115A2"
});
Property NameDescriptionRead Only
barometerAn instance of Barometer class.Yes
thermometerAn instance of Thermometer class.Yes
temperatureAn instance of Thermometer class.Yes

MPL3115A2

new five.Multi({
  controller: "MPL3115A2"
});
Property NameDescriptionRead Only
altimeterAn instance of Altimeter class.Yes
barometerAn instance of Barometer class.Yes
thermometerAn instance of Thermometer class.Yes
temperatureAn instance of Thermometer class.Yes

SI7020

new five.Multi({
  controller: "SI7020"
});
Property NameDescriptionRead Only
hygrometerAn instance of Hygrometer class.Yes
thermometerAn instance of Thermometer class.Yes

SI7021

new five.Multi({
  controller: "SI7021"
});
Property NameDescriptionRead Only
hygrometerAn instance of Hygrometer class.Yes
thermometerAn instance of Thermometer class.Yes

MS5611

new five.Multi({
  controller: "MS5611"
});

MS5611

Property NameDescriptionRead Only
altimeterAn instance of Altimeter class.Yes
barometerAn instance of Barometer class.Yes
thermometerAn instance of Thermometer class.Yes

TH02

new five.Multi({
  controller: "TH02"
});

TH02

Property NameDescriptionRead Only
hygrometerAn instance of Hygrometer class.Yes
thermometerAn instance of Thermometer class.Yes

DHT11_I2C_NANO_BACKPACK

new five.Multi({
  controller: "DHT11_I2C_NANO_BACKPACK"
});

DHT11_I2C_NANO_BACKPACK

Property NameDescriptionRead Only
hygrometerAn instance of Hygrometer class.Yes
thermometerAn instance of Thermometer class.Yes

DHT21_I2C_NANO_BACKPACK

new five.Multi({
  controller: "DHT21_I2C_NANO_BACKPACK"
});

DHT21_I2C_NANO_BACKPACK

Property NameDescriptionRead Only
hygrometerAn instance of Hygrometer class.Yes
thermometerAn instance of Thermometer class.Yes

DHT22_I2C_NANO_BACKPACK

new five.Multi({
  controller: "DHT22_I2C_NANO_BACKPACK"
});

DHT22_I2C_NANO_BACKPACK

Property NameDescriptionRead Only
hygrometerAn instance of Hygrometer class.Yes
thermometerAn instance of Thermometer class.Yes

Usage

var five = require("johnny-five");
var board = new five.Board();

board.on("ready", function() {

  var multi = new five.Multi({
    controller: "MPL115A2"
  });

  multi.on("data", function() {
    console.log("Barometer: %d", this.barometer.pressure);
    console.log("Temperature: %d", this.temperature.celsius);
  });
});
var five = require("johnny-five");
var board = new five.Board();

board.on("ready", function() {
  var multi = new five.Multi({
    controller: "HTU21D"
  });

  multi.on("change", function() {
    console.log("temperature");
    console.log("  celsius           : ", this.temperature.celsius);
    console.log("  fahrenheit        : ", this.temperature.fahrenheit);
    console.log("  kelvin            : ", this.temperature.kelvin);
    console.log("--------------------------------------");

    console.log("Hygrometer");
    console.log("  relative humidity : ", this.hygrometer.relativeHumidity);
    console.log("--------------------------------------");
  });
});

API

The Multi class does not have an explicit API. Refer to the individual components for their APIs

Events

  • data The "data" event is fired as frequently as new data becomes available.

  • change The "change" event is fired whenever a corresponding "change" is fired from a component.

Examples

Hi! The Johnny-Five community is building new projects every day. We made this newsletter to tell you about what's new, what's good, and what's next for Open Source robotics. Join us in exploring what we can make together.

Fork me on GitHub