Example3_AngleCalculations.ino

/*
 * ---------------------------------------------------------------------------------
 * Copyright (c) 2025, SparkFun Electronics Inc.
 *
 * SPDX-License-Identifier: MIT
 * ---------------------------------------------------------------------------------
 */

/*
 * Example 3: Angle Calculations
 * -------------------------
 * This example demonstrates how to configure the TMAG5273 sensor to perform angle calculations
 *
 * * Hardware Connections:
 * - Connect the TMAG5273 sensor to the SparkFun Qwiic connector on your SparkFun microcontroller board.
 *
 * Note: Make sure to install the SparkFun TMAG5273 Arduino Library before running this example.
 * You can install it via the Arduino Library Manager or download it from:
 *      https://github.com/sparkfun/SparkFun_TMAG5273_Arduino_Library
 *
 */
#include "SparkFun_TMAG5273_Arduino_Library.h" // Used to send and recieve specific information from our sensor
#include <Wire.h>                              // Used to establish serial communication on the I2C bus

// Create a new sensor object
TMAG5273 sensor;

// I2C default address
uint8_t i2cAddress = TMAG5273_I2C_ADDRESS_INITIAL;

// Set constants for setting up device
uint8_t conversionAverage = TMAG5273_X32_CONVERSION;
uint8_t magneticChannel = TMAG5273_XYX_ENABLE;
uint8_t angleCalculation = TMAG5273_XY_ANGLE_CALCULATION;

void setup()
{
    delay(1000);
    Wire.begin();
    // Start serial communication at 115200 baud
    Serial.begin(115200);

    // Begin example of the magnetic sensor code (and add whitespace for easy reading)
    Serial.println("");
    Serial.println("------------------------------------------------------------------");
    Serial.println("TMAG5273 Example 3: Angle Calculations");
    Serial.println("------------------------------------------------------------------");

    Serial.println("");
    // If begin is successful (0), then start example
    if (sensor.begin(i2cAddress, Wire) == true)
    {
        Serial.println("Begin");
    }
    else // Otherwise, infinite loop
    {
        Serial.println("Device failed to setup - Freezing code.");
        while (1)
            ; // Runs forever
    }

    // Set the device at 32x average mode
    sensor.setConvAvg(conversionAverage);

    // Choose new angle to calculate from
    // Can calculate angles between XYX, YXY, YZY, and XZX
    sensor.setMagneticChannel(magneticChannel);

    // Enable the angle calculation register
    // Can choose between XY, YZ, or XZ priority
    sensor.setAngleEn(angleCalculation);
}

void loop()
{
    if ((sensor.getMagneticChannel() != 0) &&
        (sensor.getAngleEn() != 0)) // Checks if mag channels are on - turns on in setup
    {
        float angleCalculation = sensor.getAngleResult();

        Serial.print("XYX: ");
        Serial.print(angleCalculation, 4);
        Serial.println("°");
    }
    else
    {
        Serial.println("Mag Channels disabled, stopping..");
        while (1)
            ;
    }

    delay(1000);
}