magneticrotary3  2.0.0.0
Main Page

Magnetic Rotary 3 click

Magnetic Rotary 3 Click is a compact add-on board for accurate magnet-position sensing. This board features the AS5147, an SPI-configurable high-resolution rotary position sensor for fast absolute angle measurement over a full 360-degree range from ams AG.

click Product page


Click library

  • Author : Stefan Filipovic
  • Date : May 2022.
  • Type : SPI type

Software Support

We provide a library for the Magnetic Rotary 3 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 from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for Magnetic Rotary 3 Click driver.

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of Magnetic Rotary 3 click board by reading and displaying the magnet's angular position in degrees.

The demo application is composed of two sections :

Application Init

Initializes the driver and logger.

void application_init ( void )
{
log_cfg_t log_cfg;
magneticrotary3_cfg_t magneticrotary3_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
magneticrotary3_cfg_setup( &magneticrotary3_cfg );
MAGNETICROTARY3_MAP_MIKROBUS( magneticrotary3_cfg, MIKROBUS_1 );
if ( SPI_MASTER_ERROR == magneticrotary3_init( &magneticrotary3, &magneticrotary3_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

Reads the magnet's angular position in degrees every 100ms and displays the results on the USB UART.

void application_task ( void )
{
float angle;
if ( MAGNETICROTARY3_OK == magneticrotary3_get_angle ( &magneticrotary3, &angle ) )
{
log_printf( &logger, " Angle: %.1f degrees\r\n\n", angle );
Delay_ms ( 100 );
}
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.MagneticRotary3

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. UART terminal is available in all MikroElektronika compilers.


magneticrotary3_write_register
err_t magneticrotary3_write_register(magneticrotary3_t *ctx, uint16_t reg, uint16_t data_in)
Magnetic Rotary 3 write register function.
magneticrotary3_cfg_t
Magnetic Rotary 3 Click configuration object.
Definition: magneticrotary3.h:166
application_task
void application_task(void)
Definition: main.c:58
magneticrotary3_read_register
err_t magneticrotary3_read_register(magneticrotary3_t *ctx, uint16_t reg, uint16_t *data_out)
Magnetic Rotary 3 read register function.
MAGNETICROTARY3_MAP_MIKROBUS
#define MAGNETICROTARY3_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: magneticrotary3.h:139
magneticrotary3_cfg_setup
void magneticrotary3_cfg_setup(magneticrotary3_cfg_t *cfg)
Magnetic Rotary 3 configuration object setup function.
magneticrotary3_t
Magnetic Rotary 3 Click context object.
Definition: magneticrotary3.h:153
magneticrotary3_init
err_t magneticrotary3_init(magneticrotary3_t *ctx, magneticrotary3_cfg_t *cfg)
Magnetic Rotary 3 initialization function.
magneticrotary3_get_angle
err_t magneticrotary3_get_angle(magneticrotary3_t *ctx, float *angle)
Magnetic Rotary 3 get angle function.
application_init
void application_init(void)
Definition: main.c:28
MAGNETICROTARY3_OK
@ MAGNETICROTARY3_OK
Definition: magneticrotary3.h:186