Skip to content

Commit

Permalink
updates README to highlight the tilt-compensated nature of the headin…
Browse files Browse the repository at this point in the history
…g computations.
  • Loading branch information
ryantm committed Jan 21, 2011
1 parent 3e28b8a commit 2b30edb
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.textile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ http://www.pololu.com/

h2. Summary

This is a library for the Arduino that interfaces with the "Pololu LSM303DLH":http://www.pololu.com/catalog/product/1250 carrier board.
This is a library for the Arduino that interfaces with the "Pololu LSM303DLH":http://www.pololu.com/catalog/product/1250 carrier board. It can compute the tilt-compensated heading.

h2. Getting Started

Expand Down Expand Up @@ -53,5 +53,5 @@ vector m_min - the minimum magnetometer readings found, use for calibration.
LSM303DLH() - Constructor
void enable(void) - Turns on the magnetometer and accelerometer
void read(void) - Takes a reading and stores the values in the vectors a and m.
int heading(void) - Returns the degrees headed away from the -Y axis
int heading(vector from) - Returns the degrees headed away from from
int heading(void) - Returns the tilt-compensated degrees headed away from the -Y axis
int heading(vector from) - Returns the tilt-compensated degrees headed away from from

0 comments on commit 2b30edb

Please sign in to comment.