TOP Contributors

  1. MIKROE (2784 codes)
  2. Alcides Ramos (405 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (133 codes)
  5. Bugz Bensce (97 codes)
  6. S P (73 codes)
  7. dany (71 codes)
  8. MikroBUS.NET Team (35 codes)
  9. NART SCHINACKOW (34 codes)
  10. Armstrong Subero (27 codes)

Most Downloaded

  1. Timer Calculator (141804 times)
  2. FAT32 Library (74941 times)
  3. Network Ethernet Library (59303 times)
  4. USB Device Library (49299 times)
  5. Network WiFi Library (45096 times)
  6. FT800 Library (44658 times)
  7. GSM click (31276 times)
  8. mikroSDK (30205 times)
  9. microSD click (27656 times)
  10. PID Library (27561 times)
Libstock prefers package manager

Package Manager

We strongly encourage users to use Package manager for sharing their code on Libstock website, because it boosts your efficiency and leaves the end user with no room for error. [more info]

< Back
mikroSDK Library

MAGNETO 4 Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.18

mikroSDK Library: 2.0.0.0

Category: Magnetic

Downloaded: 562 times

Not followed.

License: MIT license  

Magneto 4 Click is a high-resolution magnetic encoder Click board™ which allows contactless motion sensing down to 0.5µm.

No Abuse Reported

Do you want to subscribe in order to receive notifications regarding "MAGNETO 4 Click" changes.

Do you want to unsubscribe in order to stop receiving notifications regarding "MAGNETO 4 Click" changes.

Do you want to report abuse regarding "MAGNETO 4 Click".

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


MAGNETO 4 Click

Magneto 4 Click is a high-resolution magnetic encoder Click board™ which allows contactless motion sensing down to 0.5µm.

magneto4_click.png

Click Product page


Click library

  • Author : Luka Filipovic
  • Date : Nov 2019.
  • Type : SPI type

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    void magneto4_cfg_setup ( magneto4_cfg_t *cfg );

  • Initialization function.

    MAGNETO4_RETVAL magneto4_init ( magneto4_t ctx, magneto4_cfg_t cfg );

  • Click Default Configuration function.

    void magneto4_default_cfg ( magneto4_t *ctx );

Example key functions :

  • Get Magnetic measurement status

    uint8_t magneto4_get_magnetic_status ( magneto4_t ctx, mag_status_t mag_status );

  • Encoder position

    void magneto4_get_encoder_position ( magneto4_t *ctx );

  • Encoder direction

    uint8_t magneto4_get_encoder_direction ( magneto4_t ctx, mag_status_t mag_status );

Examples Description

Reads and logs magnetic field strength values if magnetic field strength values bigger than 3000, start magnetic linear position mode,
when moving the sensor from left to right the position for 1 step is reduced.

The demo application is composed of two sections :

Application Init

Initializes Driver init and sets start encoder position on the zero. Reads and logs magnetic field strength values. For starting an encoder, it is necessary that the magnetic field strength is greater than 3000.


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

    magneto4_cfg_setup( &cfg );
    MAGNETO4_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    magneto4_init( &magneto4, &cfg );

    magneto4_default_cfg ( &magneto4 );

    log_printf( &logger, " --- Please, bring the magnet close ---\r\n" );

    while ( magnetic_field < MAGNETO4_MAX_MAGNETIC_FIELD_VALUE )
    {
        magnetic_field = magneto4_get_magnetic_field( &magneto4 );
        log_printf( &logger, " Magnetic field strength : %d\r\n", magnetic_field );
        Delay_ms ( 1000 );
    }

    Delay_ms ( 1000 );
    Delay_ms ( 500 );
    log_printf( &logger, " --- Magnetic Linear Position ---\r\n" );
}

Application Task

When moving the sensor from left to right, one step is added and when moving from right to left, the position for 1 step is reduced.


void application_task ( void )
{
    //  Task implementation.

    magneto4_get_encoder_position( &magneto4 );

    enc_position = magneto4.encoder_position;

    if ( old_position != enc_position )
    {
        log_printf( &logger, " Encoder position : %d\r\n", enc_position );
        log_printf( &logger, " ------------------------\r\n" );
    }

    old_position = enc_position;
}  

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.Magneto4

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.


ALSO FROM THIS AUTHOR

DAC click

0

This example demonstrates usage of the DAC click board in mikroBUS form factor. Board features 12-bit Digital-to-Analog Converter MCP4921 that features SPI interface and an optional double buffered output.

[Learn More]

Solar Energy 2 Click

0

Solar Energy 2 Click is a compact add-on board that can recharge a battery by harvesting the solar power of the Sun or by other means. This board features the EM8500, a power management controller with an energy harvesting interface from EM Microelectronic. The controller is specifically designed for efficient harvesting over various DC sources such as photovoltaic (solar) or thermal electric generators (TEG). It can recharge the connected LiPo battery or supercapacitor (or even a conventional capacitor). In addition, the EM8500 can use the same battery as a power source for powering the connected system.

[Learn More]

NeoMesh 915MHz Click

0

NeoMesh Click - 915MHz is a compact add-on board with a low-power, long-range transceiver, ideal for Mesh wireless networking. This board features the NC1000C-9, a wireless Mesh network module from NeoCortec. With an additional antenna that MikroE offers connected to the module’s u.Fl connector, you can create a fully functional wireless Mesh network node that will work in the Sub-GHz frequency band of 915MHz. The module has a generic application layer that can configured to suit applications.

[Learn More]