diff --git a/README.md b/README.md index 7f9b1c1..cef24de 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -#Accelerometer +# Accelerometer Driver for the accel-mma84 Tessel accelerometer module. The hardware documentation for this module can be found [here](https://github.com/tessel/hardware/blob/master/modules-overview.md#accelerometer). If you run into any issues you can ask for support on the [Accelerometer Module Forums](http://forums.tessel.io/category/accelerometer). -###Installation +### Installation ```sh npm install accel-mma84 ``` -###Example +### Example ```js /********************************************* This basic accelerometer example logs a stream @@ -34,39 +34,39 @@ accel.on('error', function(err){ }); ``` -###Methods +### Methods - # accel.availableOutputRates() - Logs the available interrupt rates in Hz. +* accel.availableOutputRates() +Logs the available interrupt rates in Hz. - # accel.availableScaleRanges() +* accel.availableScaleRanges() Logs the available accelerometer ranges (in units of Gs). - # accel.enableDataInterrupts( trueOrFalse, callback(err) ) - Enables or disables data interrupts, and thus, `data` events. Set the first param truthy to enable, falsy to disable. +* accel.enableDataInterrupts( trueOrFalse, callback(err) ) +Enables or disables data interrupts, and thus, `data` events. Set the first param truthy to enable, falsy to disable. - # accel.getAcceleration( callback(err, xyz) ) - Gets the acceleration from the device, outputs as array [x, y, z]. +* accel.getAcceleration( callback(err, xyz) ) +Gets the acceleration from the device, outputs as array [x, y, z]. - # accel.setOutputRate( rateInHz, callback(err) ) +* accel.setOutputRate( rateInHz, callback(err) ) Sets the output rate of the data (1.56-800 Hz). - # accel.setScaleRange( scaleRange, callback(err) ) +* accel.setScaleRange( scaleRange, callback(err) ) Sets the accelerometer to read up to 2, 4, or 8 Gs of acceleration (smaller range = better precision). -###Events - # accel.on( 'data', callback(xyz) ) - Emitted when data is available. xyz is an array in the form of [x, y, z]. +### Events +* accel.on( 'data', callback(xyz) ) +Emitted when data is available. xyz is an array in the form of [x, y, z]. - # accel.on( 'error', callback(err) ) - Emitted upon error. +* accel.on( 'error', callback(err) ) +Emitted upon error. - # accel.on( 'ready', callback() ) - Emitted upon first successful communication between the Tessel and the module. +* accel.on( 'ready', callback() ) +Emitted upon first successful communication between the Tessel and the module. -###Further Examples +### Further Examples * [Change Rates](https://github.com/tessel/accel-mma84/blob/master/examples/change-rates.js). This more advanced accelerometer example logs a stream of x, y, and z data, then stops the stream, changes the polling rate, and resumes streaming from the accelerometer. * [Show Axes](https://github.com/tessel/accel-mma84/blob/master/examples/show-axes.js). Demonstrates axes by turning on a different LED per axis (x, y, z) only when that axis has positive acceleration. Also prints +/- per axis to the console. -###Licensing +### Licensing MIT or Apache 2.0, at your option