TOP Contributors

  1. MIKROE (2642 codes)
  2. Alcides Ramos (347 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (112 codes)
  5. Chisanga Mumba (90 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 (136220 times)
  2. FAT32 Library (69487 times)
  3. Network Ethernet Library (55705 times)
  4. USB Device Library (45991 times)
  5. Network WiFi Library (41639 times)
  6. FT800 Library (40781 times)
  7. GSM click (28788 times)
  8. PID Library (26330 times)
  9. mikroSDK (26053 times)
  10. microSD click (25140 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

3D Hall 8 click

Rating:

0

Author: MIKROE

Last Updated: 2024-01-31

Package Version: 2.1.0.11

mikroSDK Library: 2.0.0.0

Category: Magnetic

Downloaded: 62 times

Not followed.

License: MIT license  

3D Hall 8 Click is a compact add-on board containing an ultra-small 3D-magnetic sensor for industrial and consumer applications.

No Abuse Reported

Do you want to subscribe in order to receive notifications regarding "3D Hall 8 click" changes.

Do you want to unsubscribe in order to stop receiving notifications regarding "3D Hall 8 click" changes.

Do you want to report abuse regarding "3D Hall 8 click".

  • Information
  • Comments (0)

mikroSDK Library Blog


3D Hall 8 click

3D Hall 8 Click is a compact add-on board containing an ultra-small 3D-magnetic sensor for industrial and consumer applications.

3d_hall_8_click.png

click Product page


Click library

  • Author : Luka Filipovic
  • Date : Jan 2021.
  • Type : I2C type

Software Support

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

Standard key functions :

  • c3dhall8_cfg_setup Config Object Initialization function.

    void c3dhall8_cfg_setup ( c3dhall8_cfg_t *cfg );
  • c3dhall8_init Initialization function.

    C3DHALL8_RETVAL c3dhall8_init ( c3dhall8_t *ctx, c3dhall8_cfg_t *cfg );
  • c3dhall8_default_cfg Click Default Configuration function.

    void c3dhall8_default_cfg ( c3dhall8_t *ctx );

Example key functions :

  • c3dhall8_generic_write 3D Hall 8 I2C writing function.

    err_t c3dhall8_generic_write ( c3dhall8_t *ctx, uint8_t reg, uint8_t tx_buf )
  • c3dhall8_read_sensor_data Reading sensor data function.

    void c3dhall8_read_sensor_data ( c3dhall8_t *ctx, c3dhall8_data_t *sensor_data );
  • c3dhall8_get_xyz_magnetic_matching Calculating magnetic matching.

    float c3dhall8_get_xyz_magnetic_matching ( c3dhall8_t *ctx, c3dhall8_data_t sensor_data );

Example Description

This application shows capability of 3D Hall 8 Click board. It configures device and reads sensor data. Sensor is capeable of reading magnetic flux density from 3 axes and temperature.

The demo application is composed of two sections :

Application Init

Initialization of device communication and application log and configures device.


void application_init ( void ) 
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    c3dhall8_cfg_t c3dhall8_cfg;  /**< Click config object. */
    uint8_t rx_data;

    /** 
     * 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.

    c3dhall8_cfg_setup( &c3dhall8_cfg );
    C3DHALL8_MAP_MIKROBUS( c3dhall8_cfg, MIKROBUS_1 );
    err_t init_flag = c3dhall8_init( &c3dhall8, &c3dhall8_cfg );
    if ( init_flag == I2C_MASTER_ERROR ) 
    {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }

    log_printf( &logger," > Setting configuration...\r\n" );
    c3dhall8_default_cfg ( &c3dhall8 ); 

    log_info( &logger, " Application Task " );
    log_printf( &logger, "**************************************\r\n" );
    Delay_ms( 1000 );
}

Application Task

Reads data from the device and logs it in span of 500ms.


void application_task ( void ) 
{
    c3dhall8_data_t sens_data;
    c3dhall8_read_sensor_data( &c3dhall8, &sens_data );

    log_printf( &logger, "> X[mT]: %.2f\r\n> Y[mT]: %.2f\r\n> Z[mT]: %.2f \r\n> Temperature[C]: %.2f\r\n", 
                sens_data.x_axis, sens_data.y_axis, sens_data.z_axis, sens_data.temperature );
    float magnetic_match = c3dhall8_get_xyz_magnetic_matching( &c3dhall8, sens_data );
    log_printf( &logger, "> XYZ magnetic matching: %.2f\r\n", magnetic_match );
    log_printf( &logger, "**************************************\r\n" );

    Delay_ms( 500 );
}

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.3DHall8

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.


ALSO FROM THIS AUTHOR

Gyro click

0

Gyro click is an add-on board in mikroBUS form factor. It features L3GD20 three-axis digital gyroscope module capable of providing the measured angular rate, as well as ambient temperature.

[Learn More]

LCD Demo

0

The application demonstrates LCD functionality.

[Learn More]

DAC click

0

DAC click is an accessory board in mikroBUS form factor. It includes a 12-bit Digital-to-Analog Converter MCP4921 that features an optional 2x buffered output and SPI interface.

[Learn More]