i2c1wire2  2.1.0.0
Main Page

I2C 1-Wire 2 Click

I2C 1-Wire 2 Click is a compact add-on board bridging I2C master interfaces with 1-Wire slave devices, ideal for simplifying complex communication protocols. This board features the DS2485, an advanced 1-Wire master with memory from Analog Devices. It features adjustable internal timers for precise 1-Wire signal management, relieving the host processor of timing-sensitive operations, and supports standard and overdrive communication speeds.

Click Product page


Click library

  • Author : Stefan Ilic
  • Date : Dec 2023.
  • Type : I2C type

Software Support

We provide a library for the I2C 1-Wire 2 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 I2C 1-Wire 2 Click driver.

Standard key functions :

Example key functions :

  • i2c1wire2_master_reset This function is used to reset device, and return all configuration registers to the default values.
  • i2c1wire2_write_port_cfg This function is used to write a 1-Wire configuration register.
    err_t i2c1wire2_write_port_cfg ( i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_in );
  • i2c1wire2_search This function is used to perform 1-Wire Search algorithm and return one device ROMID.
    err_t i2c1wire2_search ( i2c1wire2_t *ctx, uint8_t *flag, uint8_t *rom_id, uint8_t *last_flag, uint8_t param_data, uint8_t command_code );

Example Description

This example demonstrates the use of the I2C 1-Wire 2 Click board

by searching if a device is connected and reading its ROMID.

The demo application is composed of two sections :

Application Init

Initialization of I2C module, log UART and perform Click default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
i2c1wire2_cfg_t i2c1wire2_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
i2c1wire2_cfg_setup( &i2c1wire2_cfg );
I2C1WIRE2_MAP_MIKROBUS( i2c1wire2_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == i2c1wire2_init( &i2c1wire2, &i2c1wire2_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( I2C1WIRE2_ERROR == i2c1wire2_default_cfg ( &i2c1wire2 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

Performing 1-Wire Search algorithm to find if any device is connected.

If a device is connected and detected, its ROMID will be read and displayed.

void application_task ( void )
{
err_t error_flag;
uint8_t flag;
uint8_t last_flag;
uint8_t rom_id[ 8 ] = { 0 };
#define I2C1WIRE2_DEVICE_SEARCH_CODE 0xF0
error_flag = i2c1wire2_search ( &i2c1wire2, &flag, rom_id, &last_flag, I2C1WIRE2_SEARCH_RESET |
if ( I2C1WIRE2_OK == error_flag )
{
if ( I2C1WIRE2_RESULT_BYTE_OK == flag )
{
log_printf( &logger, " Device found: \r\n" );
log_printf( &logger, " Device ROMID: 0x" );
for ( uint8_t n_cnt = 0; n_cnt < 8; n_cnt++ )
{
log_printf( &logger, "%.2X", ( uint16_t ) rom_id[ n_cnt ] );
}
log_printf( &logger, " \r\n" );
log_printf( &logger, " Last device flag %d \r\n", last_flag );
}
else if ( I2C1WIRE2_NO_DEVICE_DETECTED == flag )
{
log_printf( &logger, " No device detected \r\n" );
}
else if ( I2C1WIRE2_NO_PRESENCE_PULS == flag )
{
log_printf( &logger, " No presence puls \r\n" );
}
}
else
{
log_printf( &logger, " ERROR \r\n" );
}
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.I2C1Wire2

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.


i2c1wire2_search
err_t i2c1wire2_search(i2c1wire2_t *ctx, uint8_t *flag, uint8_t *rom_id, uint8_t *last_flag, uint8_t param_data, uint8_t command_code)
I2C 1-Wire 2 search function.
i2c1wire2_default_cfg
err_t i2c1wire2_default_cfg(i2c1wire2_t *ctx)
I2C 1-Wire 2 default configuration function.
I2C1WIRE2_NO_PRESENCE_PULS
#define I2C1WIRE2_NO_PRESENCE_PULS
Definition: i2c1wire2.h:160
I2C1WIRE2_SEARCH_RESET
#define I2C1WIRE2_SEARCH_RESET
Definition: i2c1wire2.h:152
i2c1wire2_master_reset
err_t i2c1wire2_master_reset(i2c1wire2_t *ctx)
I2C 1-Wire 2 master reset function.
I2C1WIRE2_MAP_MIKROBUS
#define I2C1WIRE2_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: i2c1wire2.h:188
i2c1wire2_write_port_cfg
err_t i2c1wire2_write_port_cfg(i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_in)
I2C 1-Wire 2 write port configuration function.
application_task
void application_task(void)
Definition: main.c:65
I2C1WIRE2_RESULT_BYTE_OK
#define I2C1WIRE2_RESULT_BYTE_OK
I2C 1-Wire 2 Result byte setting.
Definition: i2c1wire2.h:158
i2c1wire2_t
I2C 1-Wire 2 Click context object.
Definition: i2c1wire2.h:200
I2C1WIRE2_OK
@ I2C1WIRE2_OK
Definition: i2c1wire2.h:229
i2c1wire2_init
err_t i2c1wire2_init(i2c1wire2_t *ctx, i2c1wire2_cfg_t *cfg)
I2C 1-Wire 2 initialization function.
i2c1wire2_cfg_t
I2C 1-Wire 2 Click configuration object.
Definition: i2c1wire2.h:214
I2C1WIRE2_ERROR
@ I2C1WIRE2_ERROR
Definition: i2c1wire2.h:230
application_init
void application_init(void)
Definition: main.c:29
I2C1WIRE2_NO_DEVICE_DETECTED
#define I2C1WIRE2_NO_DEVICE_DETECTED
Definition: i2c1wire2.h:161
I2C1WIRE2_DEVICE_SEARCH_CODE
#define I2C1WIRE2_DEVICE_SEARCH_CODE
I2C1WIRE2_SEARCH_1WIRE_RESET
#define I2C1WIRE2_SEARCH_1WIRE_RESET
I2C 1-Wire 2 search command setting.
Definition: i2c1wire2.h:150
i2c1wire2_cfg_setup
void i2c1wire2_cfg_setup(i2c1wire2_cfg_t *cfg)
I2C 1-Wire 2 configuration object setup function.