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 (141175 times)
  2. FAT32 Library (73987 times)
  3. Network Ethernet Library (58601 times)
  4. USB Device Library (48756 times)
  5. Network WiFi Library (44452 times)
  6. FT800 Library (44025 times)
  7. GSM click (30784 times)
  8. mikroSDK (29510 times)
  9. PID Library (27331 times)
  10. microSD click (27188 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

ClickID

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.5

mikroSDK Library: 2.0.0.0

Category: ID

Downloaded: 156 times

Not followed.

License: MIT license  

Hardware and software solution based on a secure authenticator device (EEPROM) that enables the hot-plugging of peripheral add-on Click Boards™ to any mikroBUS™ compatible system.

No Abuse Reported

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

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

Do you want to report abuse regarding "ClickID".

  • Information
  • Comments (0)

mikroSDK Library Blog


ClickID

Hardware and software solution based on a secure authenticator device (EEPROM) that enables the hot-plugging of peripheral add-on Click Boards™ to any mikroBUS™ compatible system.

clickid.png

Product page


Library

  • Author : Stefan Filipovic
  • Date : Aug 2023.
  • Type : One Wire type

Software Support

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

Standard key functions :

  • clickid_cfg_setup Config Object Initialization function.

    void clickid_cfg_setup ( clickid_cfg_t *cfg );
  • clickid_init Initialization function.

    err_t clickid_init ( clickid_t *ctx, clickid_cfg_t *cfg );

Example key functions :

  • clickid_check_communication This function checks the communication by reading the ROM address as well as verifying family code and CRC 8.

    err_t clickid_check_communication ( clickid_t *ctx );
  • clickid_read_memory This function reads a desired number of data bytes starting from the selected address of the EEPROM memory using One Wire communication protocol.

    err_t clickid_read_memory ( clickid_t *ctx, uint16_t address, uint8_t *data_out, uint16_t len );
  • clickid_read_information This function reads the Click board information from the permanent data memory.

    err_t clickid_read_information ( clickid_t *ctx, clickid_information_t *info );

Example Description

This example reads the information from ClickID permanent memory.

The demo application is composed of two sections :

Application Init

Initializes the driver and checks the communication with the Click board.


void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    clickid_cfg_t clickid_cfg;  /**< ClickID config object. */

    /** 
     * 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 " );

    // ClickID initialization.
    clickid_cfg_setup( &clickid_cfg );
    CLICKID_MAP_MIKROBUS( clickid_cfg, MIKROBUS_1 );
    if ( ONE_WIRE_ERROR == clickid_init( &clickid, &clickid_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }

    if ( CLICKID_ERROR == clickid_check_communication ( &clickid ) )
    {
        log_error( &logger, " Communication fail." );
        log_printf( &logger, "Check if the Click is attached to the correct " );
        log_printf( &logger, "MIKROBUS socket, and try again.\r\n" );
        for ( ; ; );
    }

    log_info( &logger, " Application Task " );
}

Application Task

Reads the information from ClickID permanent manifest every 5 seconds.

void application_task ( void )
{
    clickid_information_t info;
    if ( CLICKID_OK == clickid_read_information ( &clickid, &info ) )
    {
        log_printf ( &logger, "\r\n --- Click info ---\r\n" );
        log_printf ( &logger, " Name: %s\r\n", info.name );
        log_printf ( &logger, " PID: MIKROE-%u\r\n", info.serial );
        log_printf ( &logger, " HW REV.: %u.%.2u\r\n", 
                     ( uint16_t ) info.hw_rev.major, ( uint16_t ) info.hw_rev.minor );
        log_printf ( &logger, " Type: 0x%.4X\r\n", info.type );
        log_printf ( &logger, " Custom: 0x%.2X\r\n", ( uint16_t ) info.custom );
    }

    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
}

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

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

DIGI IN Click

0

DIGI IN Click is a compact add-board that converts industrial inputs into serialized SPI-compatible output. This board features the MAX22199, an octal industrial digital input from Analog Devices. It stands out for its compliance with the IEC 61131-2 standard, ensuring reliability and efficiency.

[Learn More]

Color 10 click

5

Color 10 Click is carrying VEML3328 sensor for RGB and IR light sensing as well as the RGB diode incorporated on the board which makes it good color detection device when its combined with a white LED.

[Learn More]

TouchClamp click

7

TouchClamp click is a mikroBUS add-on board with NXP’s MPR121 proximity capacitive touch sensor controller. TouchClamp click communicates with the target MCU through the mikroBUSINT pin and I2C interface ( SCL, SDA ). The board has an onboard ADDR. SEL. jumper for choosing I2C addresses. Designed to use a 3.3V power supply only.

[Learn More]