magneticrotary  2.0.0.0
Main Page

Magnetic Rotary click

Magnetic rotary click is a very accurate position sensing Click boardâ„¢ which utilizes the HMC1512, a magnetic field displacement sensor IC. This integrated sensor uses two coplanar saturated-mode Wheatstone bridges which consist of four magneto-resistive elements per bridge.

click Product page


Click library

  • Author : MikroE Team
  • Date : Dec 2019.
  • Type : SPI type

Software Support

We provide a library for the MagneticRotary Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for MagneticRotary Click driver.

Standard key functions :

Example key functions :

Examples Description

This example reads a magnetic field angle calculated to degrees for channel A The angle can be measured in the range from -90 to 90 degrees.

The demo application is composed of two sections :

Application Init

Initializes peripherals, pins, SPI interface for communication with the device.

void application_init ( void )
{
log_cfg_t log_cfg;
// Logger initialization.
log_cfg.level = LOG_LEVEL_DEBUG;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
MAGNETICROTARY_MAP_MIKROBUS( cfg, MIKROBUS_1 );
magneticrotary_init( &magneticrotary, &cfg );
log_info(&logger, "Magnetic rotary successufully initialized!\r\n");
}

Application Task

Reads a magnetic field angle calculated to degrees for channel A in Single-Ended Mode and logs results.

void application_task ( void )
{
// Task implementation.
magn_angle = magnrotary_get_field_angle( &magneticrotary, MAGNROTARY_CHA_POS_GND_NEG |
log_printf( &logger, "Angle: %.2lf \r\n ", magn_angle );
Delay_ms( 500 );
}

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.MagneticRotary

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


MAGNROTARY_MSB_ZEROS_ORDER
#define MAGNROTARY_MSB_ZEROS_ORDER
Definition: magneticrotary.h:88
magnrotary_get_field_angle
double magnrotary_get_field_angle(magneticrotary_t *ctx, uint8_t cmd_byte)
Magnetic Field Angle Get function.
application_task
void application_task(void)
Definition: main.c:60
magneticrotary_cfg_t
Click configuration structure definition.
Definition: magneticrotary.h:132
MAGNETICROTARY_MAP_MIKROBUS
#define MAGNETICROTARY_MAP_MIKROBUS(cfg, mikrobus)
Definition: magneticrotary.h:56
magneticrotary_init
MAGNETICROTARY_RETVAL magneticrotary_init(magneticrotary_t *ctx, magneticrotary_cfg_t *cfg)
Initialization function.
magneticrotary_cfg_setup
void magneticrotary_cfg_setup(magneticrotary_cfg_t *cfg)
Config Object Initialization function.
MAGNROTARY_CHA_POS_GND_NEG
#define MAGNROTARY_CHA_POS_GND_NEG
Definition: magneticrotary.h:77
application_init
void application_init(void)
Definition: main.c:38