hmc5883l-pi/README.md

Module to read from the HMC5883L Magnetometer

# hcm5883l-pi

Access to the HCM5883L digital compass on the Raspberry Pi.

## install

$ npm install hcm5883l-pi

## Usage
The package provides a single method called `readMag()` that returns an object containing the `x`, `y` and `z` portions of the vector.

```
var HMC5883L = require("hmc5883l-pi");
var data = HMC5883L.readMag();
console.log("Got compass data!");
console.dir(data);
console.log("x=" + data.x + ", y=" + data.y + ", z=" + data.z);
```