Intermediate
30 min

Explore the captivating world of magnetism through the lens of HMC1512 and TM4C129LNCZAD

Beyond the spin

Magnetic rotary Click with Fusion for ARM v8

Published Sep 15, 2023

Click board™

Magnetic rotary Click

Dev. board

Fusion for ARM v8

Compiler

NECTO Studio

MCU

TM4C129LNCZAD

Learn how magnetic rotary sensors go beyond mere rotations, serving as indispensable tools for innovation, enabling advancements in navigation systems, medical devices, and more

A

A

Hardware Overview

How does it work?

Magnetic rotary Click is based on the HMC1512, a magnetic displacement sensor, from Honeywell. The key feature of the HMC1512 IC is the high accuracy of the magnetic field sensing. Unlike most of the magnetic sensors on the market which rely on the Hall-effect, the integrated sensors of the HMC1512 IC are produced using the Honeywell proprietary Anisotropic Magneto-Resistive (AMR) technology, which yields an absolute magnetic field position sensing with the angular error of only 0.05° in the range of ±90°. The magneto-resistive sensing elements form a saturated-mode Wheatstone bridge, positioned in the XZ plane (parallel with the surface of the IC). The HMC1512 contains two such integrated bridges, bridge A, and bridge B. These bridges are positioned at the middle of the IC casing, which is the optimal position for rotary applications. One bridge is physically rotated by 45° from the other, allowing the HMC1512 IC to cover the full range of ±90° (2x45°), maintaining its sensing accuracy. The IC outputs an analog differential voltage with respect to the angle of the magnetic field. The

voltage from the selected mikroBUS™ power rail is directly applied to the internal Wheatstone bridge of the HMC1512. By construction, in the absence of the magnetic field, its outputs will be set at half the supply voltage (with the small offset of 3mV/V typically). If there is a magnetic field positioned at 0° in respect to one of the bridges, it will cause no disbalance of the magneto-resistive elements for that bridge. However, in the other bridge, the same magnetic field will cause it to reach its peak output value, since that bridge is rotated by 45°. The outputs of the Wheatstone bridges are routed to the dual operational amplifier, which serves as the buffer for the A/D converter. As a dual operational amplifier, the MCP6022 from Microchip is used. This op-amp is biased to half the power supply voltage and has a gain of 25. Two buffered signals are then used as inputs for each channel of the A/D converter. Magnetic rotary click uses the MCP3202, a two-channel, 12-bit A/D converter (ADC) with SPI Interface, by Microchip. This ADC has a high resolution which can be used even for more demanding applications.

At 0°, the ADC will output half of its full-scale (FS) value, and it will swing towards 0 if the sign of the orientation of the magnetic field is positioned towards the negative direction, and 4095 if the orientation of the magnetic field is positioned towards the positive direction. Each bridge output is routed to a separate ADC input, so it can be independently converted. The MCP3202 uses the power supply as the reference voltage, allowing ADC conversion within the range of the input signal. Converted output values can be read via the SPI interface, routed to the mikroBUS™ SPI pins for easy interfacing with a vast number of different microcontrollers (MCUs). This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the PWR SEL jumper. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. Also, this Click board™ comes equipped with a library containing easy-to-use functions and an example code that can be used as a reference for further development.

Magnetic rotary Click top side image
Magnetic rotary Click bottom side image

Features overview

Development board

Fusion for ARM v8 is a development board specially designed for the needs of rapid development of embedded applications. It supports a wide range of microcontrollers, such as different ARM® Cortex®-M based MCUs regardless of their number of pins, and a broad set of unique functions, such as the first-ever embedded debugger/programmer over WiFi. The development board is well organized and designed so that the end-user has all the necessary elements, such as switches, buttons, indicators, connectors, and others, in one place. Thanks to innovative manufacturing technology, Fusion for ARM v8 provides a fluid and immersive working experience, allowing access anywhere and under any

circumstances at any time. Each part of the Fusion for ARM v8 development board contains the components necessary for the most efficient operation of the same board. An advanced integrated CODEGRIP programmer/debugger module offers many valuable programming/debugging options, including support for JTAG, SWD, and SWO Trace (Single Wire Output)), and seamless integration with the Mikroe software environment. Besides, it also includes a clean and regulated power supply module for the development board. It can use a wide range of external power sources, including a battery, an external 12V power supply, and a power source via the USB Type-C (USB-C) connector.

Communication options such as USB-UART, USB HOST/DEVICE, CAN (on the MCU card, if supported), and Ethernet is also included. In addition, it also has the well-established mikroBUS™ standard, a standardized socket for the MCU card (SiBRAIN standard), and two display options for the TFT board line of products and character-based LCD. Fusion for ARM v8 is an integral part of the Mikroe ecosystem for rapid development. Natively supported by Mikroe software tools, it covers many aspects of prototyping and development thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

Fusion for ARM v8 horizontal image

Microcontroller Overview

MCU Card / MCU

default

Type

8th Generation

Architecture

ARM Cortex-M4

MCU Memory (KB)

1024

Silicon Vendor

Texas Instruments

Pin count

212

RAM (Bytes)

262144

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
NC
NC
RST
SPI Chip Select
PE7
CS
SPI Clock
PA2
SCK
SPI Data OUT
PA5
MISO
SPI Data IN
PA4
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
NC
NC
PWM
NC
NC
INT
NC
NC
TX
NC
NC
RX
NC
NC
SCL
NC
NC
SDA
Power Supply
5V
5V
Ground
GND
GND
1

Take a closer look

Click board™ Schematic

Magnetic rotary Click Schematic schematic

Step by step

Project assembly

Fusion for PIC v8 front image hardware assembly

Start by selecting your development board and Click board™. Begin with the Fusion for ARM v8 as your development board.

Fusion for PIC v8 front image hardware assembly
GNSS2 Click front image hardware assembly
SiBRAIN for PIC32MZ1024EFK144 front image hardware assembly
Board mapper by product7 hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
NECTO Compiler Selection Step Image hardware assembly
NECTO Output Selection Step Image hardware assembly
Necto image step 6 hardware assembly
Necto image step 7 hardware assembly
Necto image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Necto PreFlash Image hardware assembly

Track your results in real time

Application Output

1. Application Output - In Debug mode, the 'Application Output' window enables real-time data monitoring, offering direct insight into execution results. Ensure proper data display by configuring the environment correctly using the provided tutorial.

2. UART Terminal - Use the UART Terminal to monitor data transmission via a USB to UART converter, allowing direct communication between the Click board™ and your development system. Configure the baud rate and other serial settings according to your project's requirements to ensure proper functionality. For step-by-step setup instructions, refer to the provided tutorial.

3. Plot Output - The Plot feature offers a powerful way to visualize real-time sensor data, enabling trend analysis, debugging, and comparison of multiple data points. To set it up correctly, follow the provided tutorial, which includes a step-by-step example of using the Plot feature to display Click board™ readings. To use the Plot feature in your code, use the function: plot(*insert_graph_name*, variable_name);. This is a general format, and it is up to the user to replace 'insert_graph_name' with the actual graph name and 'variable_name' with the parameter to be displayed.

Software Support

Library Description

This library contains API for Magnetic rotary Click driver.

Key functions:

  • magnrotary_read_adc - This function returns a 12bit result of AD conversion

  • magnrotary_out_volt_adc - This function returns ADC voltage value calculated to millivolts, depending on the voltage selection

  • magnrotary_get_field_angle - This function returns a magnetic field angle calculated to degrees,from -90 to 90 degrees.

Open Source

Code example

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.

/*!
 * \file 
 * \brief MagneticRotary Click example
 * 
 * # Description
 * On every 500 miliseconds reads a magnetic field angle calculated to degrees for channel A
 * in Single-Ended Mode and logs results on uart terminal. 
 *
 * The demo application is composed of two sections :
 * 
 * ## Application Init 
 * Initializes peripherals, pins, SPI interface for communication with the device.
 * 
 * ## Application Task  
 * Reads a magnetic field angle calculated to degrees for channel A
 * in Single-Ended Mode and logs results on uart terminal.
 * Repeats operation every 500 milliseconds.
 * Note : The angle can be measured in the range from -90 to 90 degrees.
 * 
 *
 * \author MikroE Team
 *
 */
// ------------------------------------------------------------------- INCLUDES

#include "board.h"
#include "log.h"
#include "magneticrotary.h"

// ------------------------------------------------------------------ VARIABLES

static magneticrotary_t magneticrotary;
static log_t logger;

static double magn_angle;
// ------------------------------------------------------ APPLICATION FUNCTIONS

void application_init ( void )
{
    log_cfg_t log_cfg;
    magneticrotary_cfg_t cfg;

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, "---- Application Init ----" );

    //  Click initialization.

    magneticrotary_cfg_setup( &cfg );
    MAGNETICROTARY_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    magneticrotary_init( &magneticrotary, &cfg );
    log_info(&logger, "Magnetic rotary successufully initialized!\r\n");

}

void application_task ( void )
{
    //  Task implementation.

    magn_angle = magnrotary_get_field_angle( 
                                            &magneticrotary, MAGNROTARY_CHA_POS_GND_NEG | 
                                                             MAGNROTARY_MSB_ZEROS_ORDER );
    
    log_printf( &logger, "Angle:    %.2lf \r\n ", magn_angle );
    
    Delay_ms ( 500 );
}

int main ( void ) 
{
    /* Do not remove this line or clock might not be set correctly. */
    #ifdef PREINIT_SUPPORTED
    preinit();
    #endif
    
    application_init( );
    
    for ( ; ; ) 
    {
        application_task( );
    }

    return 0;
}

// ------------------------------------------------------------------------ END

Additional Support

Resources

Love this project?

'Buy This Kit' button takes you directly to the shopping cart where you can easily add or remove products.