Magnetometer

@objc(GSMagnetometer)
public protocol Magnetometer : Peripheral

Magnetometer peripheral.

Base class telling whether the magnetometer is calibrated or not. A subclass shall be used to control the calibration process, depending on the device, for instance MagnetometerWith1StepCalibration or MagnetometerWith3StepCalibration.

This peripheral can be retrieved by:

device.getPeripheral(Peripherals.magnetometer)
  • Whether the magnetometer is calibrated.

    Note

    The magnetometer should be calibrated to make positioning related actions, such as ReturnToHome, FlightPlan…

    Declaration

    Swift

    var calibrated: Bool { get }