IR.Proximity

The IR.Proximity class constructs an object that represents a single Infrared Proximity sensor.

• Proximity
  • GP2Y0A21YK, Analog
  • GP2D120XJ00F, Analog
  • GP2Y0A02YK0F, Analog
  • GP2Y0A41SK0F, Analog

NOTE: The IR.Proximity is deprecated. Please use the Proximity class.

Parameters

• options An object of property parameters.

  Property	Type	Value/Description	Default	Required
  pin	Number, String	Analog Pin. The Number or String address of the pin the sensor is attached to, ie. 9, “D7”		yes
  controller	String	"GP2Y0A21YK", "GP2D120XJ00F", "GP2Y0A02YK0F", "GP2Y0A41SK0F". The name of the controller to use		yes

Shape

{
  id: A user definable id value. Defaults to a generated uid
  pin: The pin address that the Sensor is attached to
  cm: Distance to obstruction in centimeters. READONLY
  in: Distance to obstruction in inches. READONLY
}

Component Initialization

Analog

new five.IR.Proximity({
  controller: "GP2Y0A21YK",
  pin: "A0"
});

Usage

var five = require("johnny-five");
var board = new five.Board();
var controller = process.argv[2] || "GP2Y0A02YK0F";

board.on("ready", function() {
  var proximity = new five.IR.Proximity({
    controller: controller,
    pin: "A0"
  });

  proximity.on("data", function() {
    console.log("inches: ", this.inches);
    console.log("cm: ", this.cm);
  });
});

Events

• data The "data" event is fired as frequently as the user defined freq will allow in milliseconds. ("data" replaced the "read" event)

• change The "change" event is fired when the distance to obstruction reading changes within the observable range of the IR.Proximity sensor.