johnny-five/docs/ping.md

The JavaScript Arduino Programming Framework.

# Ping

Run with:
```bash
node eg/ping.js
```


```javascript
var five = require("johnny-five"),
  board, ping;

board = new five.Board();

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

  // Create a new `ping` hardware instance.
  ping = new five.Ping(7);

  // Properties

  // ping.microseconds
  //
  // Roundtrip distance in microseconds
  //

  // ping.inches
  //
  // Calculated distance to object in inches
  //

  // ping.cm
  //
  // Calculated distance to object in centimeters
  //


  // Ping Event API

  // "data" get the current reading from the ping
  ping.on("data", function(err, value) {
    console.log("data", value);
  });

  ping.on("change", function(err, value) {

    console.log(typeof this.inches);
    console.log("Object is " + this.inches + "inches away");
  });
});

```


## Breadboard/Illustration


![docs/breadboard/ping.png](breadboard/ping.png)
[docs/breadboard/ping.fzz](breadboard/ping.fzz)









## Contributing
All contributions must adhere to the [Idiomatic.js Style Guide](https://github.com/rwldrn/idiomatic.js),
by maintaining the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/cowboy/grunt).

## License
Copyright (c) 2012 Rick Waldron <waldron.rick@gmail.com>
Licensed under the MIT license.