magneto8

\mainpage Main Page

---

Magneto 8 click

Magneto 8 Click is a compact add-on board that contains an easy-to-program magnetic rotary position sensor with incremental quadrature (A/B) and 12-bit digital outputs. This board features the AS5601, 12-bit programmable contactless encoder IC from AMS-AG.

click Product page

---

Click library

• Author : MikroE Team
• Date : Jul 2020.
• Type : I2C type

Software Support

We provide a library for the Magneto8 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 Magneto8 Click driver.

Standard key functions :

• magneto8_cfg_setup Config Object Initialization function.

void magneto8_cfg_setup ( magneto8_cfg_t *cfg ); 

• magneto8_init Initialization function.

err_t magneto8_init ( magneto8_t *ctx, magneto8_cfg_t *cfg );

• magneto8_default_cfg Click Default Configuration function.

void magneto8_default_cfg ( magneto8_t *ctx );

Example key functions :

• magneto8_get_magnitude Gets magnitude data

uint16_t magneto8_get_magnitude ( magneto8_t *ctx );

• magneto8_get_angle_data Gets Angle data

float magneto8_get_angle_data ( magneto8_t *ctx );

• magneto8_psh_pin_state Gets PSH pin state

uint8_t magneto8_psh_pin_state ( magneto8_t *ctx );

Examples Description

This example demonstrates the use of Magneto 8 Click board.

The demo application is composed of two sections :

Application Init

Initializes the driver and applies the click default configuration.

void application_init ( void )
{
    log_cfg_t log_cfg;
    magneto8_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.

    magneto8_cfg_setup( &cfg );
    MAGNETO8_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    magneto8_init( &magneto8, &cfg );

    magneto8_default_cfg( &magneto8 );
    log_printf( &logger, "--- Configuration done ---- \r\n" );
    Delay_ms ( 500 );
}
  

Application Task

Reads angle and magnitude data and displays it on the USB UART every 500ms.

void application_task ( void )
{
    float angle;
    uint16_t mag;

    mag  = magneto8_get_magnitude( &magneto8 );
    log_printf( &logger, "Magnitude: %d \r\n", mag );
    
    angle = magneto8_get_angle_data( &magneto8 );
    log_printf( &logger, "Angle : %.1f deg\r\n", angle );

    log_printf( &logger, "---------------------- \r\n" );
    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.Magneto8

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.

---