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 (141318 times)
  2. FAT32 Library (74154 times)
  3. Network Ethernet Library (58737 times)
  4. USB Device Library (48834 times)
  5. Network WiFi Library (44544 times)
  6. FT800 Library (44120 times)
  7. GSM click (30857 times)
  8. mikroSDK (29699 times)
  9. PID Library (27359 times)
  10. microSD click (27273 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

REED Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.17

mikroSDK Library: 2.0.0.0

Category: Magnetic

Downloaded: 379 times

Not followed.

License: MIT license  

REED Click is a simple board that carries a standard (Single Pole Single Throw Normally Open) reed switch. A reed switch comprises of two thin magnetic contacts sealed inside a casing.

No Abuse Reported

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

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

Do you want to report abuse regarding "REED Click".

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


REED Click

REED Click is a simple board that carries a standard (Single Pole Single Throw Normally Open) reed switch. A reed switch comprises of two thin magnetic contacts sealed inside a casing.

reed_click.png

Click Product page


Click library

  • Author : Nenad Filipovic
  • Date : Dec 2019.
  • Type : GPIO type

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    void reed_cfg_setup ( reed_cfg_t *cfg );

  • Initialization function.

    REED_RETVAL reed_init ( reed_t ctx, reed_cfg_t cfg );

  • Click Default Configuration function.

    void reed_default_cfg ( reed_t *ctx );

Example key functions :

  • Get magnetic detected status function.

    uint8_t reed_get_status ( reed_t *ctx );

Examples Description

This is a example which demonstrates the use of REED Click board.

The demo application is composed of two sections :

Application Init

Configuring clicks and log objects.


void application_init ( void )
{
    log_cfg_t log_cfg;
    reed_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_printf(&logger, "- Application Init -\r\n");

    //  Click initialization.

    reed_cfg_setup( &cfg );
    REED_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    reed_init( &reed, &cfg );

    reed_state = REED_NO_MAGNETIC_FIELD;
    reed_state_old = REED_NO_MAGNETIC_FIELD;

    log_printf(&logger, "--------------------\r\n");
    log_printf(&logger, "     REED Click\r\n");
    log_printf(&logger, "--------------------\r\n");
    Delay_100ms();
}

Application Task

Detect the magnetic field near the REED Click. Results are being sent to the Usart Terminal where you can track their changes. All data logs on usb uart when magnetic field is detected.


void application_task ( void )
{
    reed_state = reed_get_status( &reed );

    if ( ( reed_state == REED_MAGNETIC_FIELD_DETECTED ) && ( reed_state_old == REED_NO_MAGNETIC_FIELD ) )
    {
        reed_state_old = REED_MAGNETIC_FIELD_DETECTED;
        log_printf(&logger, "     ~ LOCKED ~\r\n");
        log_printf(&logger, "--------------------\r\n");
    }

    if ( ( reed_state == REED_NO_MAGNETIC_FIELD ) && ( reed_state_old == REED_MAGNETIC_FIELD_DETECTED ) )
    {
        log_printf(&logger, "    ~ UNLOCKED ~\r\n");
        log_printf(&logger, "--------------------\r\n");
        reed_state_old = REED_NO_MAGNETIC_FIELD;
    }
} 

Note

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

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

Mikromedia 4 for STM32F7 Capacitive

0

This project contains example for testing modules on Mikromedia 4 for STM32F7 Capacitive.

[Learn More]

Hall Current 7 click

5

Hall Current 7 Click is a compact add-on board that provides economical and precise solutions for AC or DC current sensing.

[Learn More]

RTC 20 Click

0

RTC 20 Click is a compact add-on board that measures the passage of real-time. This board features the AB0805, an I2C-configurable real-time clock with a highly sophisticated feature set from Abracon LLC. The AB0805 provides information like seconds, minutes, hours, days, months, years, and dates based on a 32.768kHz quartz crystal through an I2C serial interface to transmit time and calendar data to the MCU. It also has automatic leap year compensation, low power consumption, and full RTC functions such as battery backup, programmable counters, and alarms for timer and watchdog functions.

[Learn More]