Skip to main content
Use this API to listen for compass heading changes. The callback provides the device’s current heading direction.

​
Parameters

PropertyTypeRequiredDescription
callbackFunctionYesCallback function when compass heading changes

​
Callback Parameters

PropertyTypeDescription
directionNumberHeading in degrees (0-360), where 0 is North

​
Code Example

​
Basic Usage

my.onCompassChange((res) => {
  console.log('Direction:', res.direction);
});

​
Compass Display

Page({
  data: {
    direction: 0,
    cardinalDirection: 'N'
  },

  onLoad() {
    my.onCompassChange((res) => {
      this.setData({
        direction: Math.round(res.direction),
        cardinalDirection: this.getCardinalDirection(res.direction)
      });
    });
  },

  getCardinalDirection(degrees) {
    const directions = ['N', 'NE', 'E', 'SE', 'S', 'SW', 'W', 'NW'];
    const index = Math.round(degrees / 45) % 8;
    return directions[index];
  },

  onUnload() {
    my.offCompassChange();
  }
});

Page({
  data: {
    targetBearing: 45, // Target is NE
    arrowRotation: 0
  },

  onLoad() {
    my.onCompassChange((res) => {
      // Calculate rotation to point at target
      const rotation = this.data.targetBearing - res.direction;
      this.setData({ arrowRotation: rotation });
    });
  }
});
Call my.startCompass before using this API to begin receiving compass data.

my.offCompassChange

Stop listening for changes

my.startCompass

Start compass