compass.js

A minimal javascript library for accessing the compass direction of a user relative to North.

<script src="https://unpkg.com/@joeyklee/compass.js@latest/dist/compass.js"></script>

Quickstart

Include the reference to the script:

<script src="https://unpkg.com/@joeyklee/compass.js@latest/dist/compass.js"></script>

Using Async/Await

window.addEventListener("DOMContentLoaded", async() => {
  const compass = new Compass();
  await compass.init();

  const bearingToNorth = compass.getBearingToNorth();
  console.log(bearingToNorth); // 0;
})

Using Callbacks

window.addEventListener("DOMContentLoaded", () => {
  const compass = new Compass();
  compass.init(compassLoaded);


  function compassLoaded(){
    const bearingToNorth = compass.getBearingToNorth();
    console.log(bearingToNorth); // 0;
  }
  
});

Docs

You can read the docs to get a better understanding of the Compass class.

See: Docs

Examples

Here's a few examples to get you started:

• p5 example
• Vanillajs example
• Mapboxgl example;

Develop

To develop the Compass you can install the development dependencies and run the tests below.

Setup

$ npm install

Tests

$ npm run test

Generate Docs

$ npm run docs

Examples

$ npm run examples

TODO

• [ ] Add webpack build
• [ ] Allow customization for device orientation access trigger

Credits

• Built by Joey Lee

Notes

• A note on new iphone devices
  • device orientation requires user to confirm with a gesture
• A note on compass directions:
  • 0 deg = north
  • 90 deg = east
  • 180 deg = south
  • 270 deg = west