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 (141339 times)
  2. FAT32 Library (74183 times)
  3. Network Ethernet Library (58761 times)
  4. USB Device Library (48850 times)
  5. Network WiFi Library (44560 times)
  6. FT800 Library (44145 times)
  7. GSM click (30881 times)
  8. mikroSDK (29724 times)
  9. PID Library (27368 times)
  10. microSD click (27305 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 5 Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.21

mikroSDK Library: 2.0.0.0

Category: Magnetic

Downloaded: 403 times

Not followed.

License: MIT license  

3D HALL 5 Click is a very accurate, magnetic field sensing Click board, used to measure the intensity of the magnetic field across three perpendicular axes.

No Abuse Reported

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

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

Do you want to report abuse regarding "3D Hall 5 Click".

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


3D Hall 5 Click

3D HALL 5 Click is a very accurate, magnetic field sensing Click board, used to measure the intensity of the magnetic field across three perpendicular axes.

3dhall5_click.png

Click Product page


Click library

  • Author : Katarina Perendic
  • Date : okt 2019.
  • Type : I2C/SPI type

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    void c3dhall5_cfg_setup ( c3dhall5_cfg_t *cfg );

  • Initialization function.

    C3DHALL5_RETVAL c3dhall5_init ( c3dhall5_t ctx, c3dhall5_cfg_t cfg );

  • Click Default Configuration function.

    void c3dhall5_default_cfg ( c3dhall5_t *ctx );

Example key functions :

  • Axis data

    int16_t c3dhall5_get_axis_data ( c3dhall5_t *ctx, uint8_t axis );

  • Set offest

    void c3dhall5_set_offset ( c3dhall5_t *ctx, uint8_t offset_axis, int16_t offset );

  • Interrupt state

    uint8_t c3dhall5_get_interrupt_state ( c3dhall5_t *ctx );

Examples Description

The Demo application displays and reads 3 magnetic axes.

The demo application is composed of two sections :

Application Init

Configuring clicks and log objects. Reads device ID for check communication.

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

    c3dhall5_cfg_setup( &cfg );
    C3DHALL5_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    c3dhall5_init( &c3dhall5, &cfg );

    c3dhall5_default_cfg ( &c3dhall5 );

    device_id = c3dhall5_get_device_id ( &c3dhall5 );
    log_info( &logger, "** Device ID: 0x%x", device_id );
}

Application Task

Reads the magnetics X / Y / Z axis data every 1 seconds.

void application_task ( void )
{
    int16_t axis_X;
    int16_t axis_Y;
    int16_t axis_Z;

    //  Task implementation.

    axis_X = c3dhall5_get_axis_data( &c3dhall5, C3DHALL5_AXIS_X );
    axis_Y = c3dhall5_get_axis_data( &c3dhall5, C3DHALL5_AXIS_Y );
    axis_Z = c3dhall5_get_axis_data( &c3dhall5, C3DHALL5_AXIS_Z );

    log_printf( &logger, "----- AXIS -----\r\n" );
    log_printf( &logger, "** X: %d \r\n", axis_X );
    log_printf( &logger, "** Y: %d \r\n", axis_Y );
    log_printf( &logger, "** Z: %d \r\n", axis_Z );
    log_printf( &logger, "----------------\r\n" );

    Delay_ms ( 1000 );
}

Note

Default communication that is set is I2C communication. If you want to use SPI, you have to set up the cfg structure.

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

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

DIGI POT 8 Click

0

DIGI POT 8 Click is a compact add-on board used as a digitally controlled potentiometer. This board features the AD5206, 6-channel 256-position digitally controlled variable resistor device from Analog Devices.

[Learn More]

BATT-MON 2 Click

0

BATT-MON 2 Click is a compact add-on board representing a battery monitoring solution. This board features the MAX17262, an ultra-low power I2C-configurable fuel-gauge IC which implements the ModelGauge™ m5 algorithm from Analog Devices. The MAX17262 monitors a single-cell battery pack (best performance for batteries with 100mAhr to 6Ahr capacity), providing precision measurements of current, voltage, and temperature, and supporting internal current sensing for up to 3.1A pulse current. The battery pack's temperature is measured using an internal temperature sensor or external thermistor.

[Learn More]

UWB 4 Click

0

UWB 4 Click is a compact add-on board for precise indoor positioning and location-based applications. This board features the Sera NX040 (453-00174C) from Ezurio, featuring NXP's SR040 chipset for ultra-wideband (UWB) and Nordic Semiconductor's nRF52833 for Bluetooth LE. The module supports IEEE 802.15.4/4z HPR UWB operations, providing exceptional ranging accuracy of less than ±10 cm with a typical receiver sensitivity of -92 dBm.

[Learn More]