c1wireswitch 2.1.0.0
Main Page

1-Wire Switch click

‍1-Wire Switch Click is a compact add-on board that allows you to switch a device remotely using a 1-wire signal. This board features the DS2413, a dual-channel programmable I/O 1-Wire switch from Analog Devices.

click Product page


Click library

  • Author : Stefan Ilic
  • Date : Jan 2023.
  • Type : One Wire type

Software Support

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

Standard key functions :

Example key functions :

  • c1wireswitch_set_pio_state 1-Wire Switch write specific programmable I/O state function.
    err_t c1wireswitch_set_pio_state ( c1wireswitch_t *ctx, uint8_t pio_a, uint8_t pio_b );
    err_t c1wireswitch_set_pio_state(c1wireswitch_t *ctx, uint8_t pio_a, uint8_t pio_b)
    1-Wire Switch write specific programmable I/O state function.
  • c1wireswitch_get_pio_state 1-Wire Switch read specific programmable I/O state function.
    err_t c1wireswitch_get_pio_state ( c1wireswitch_t *ctx, uint8_t *pio_a, uint8_t *pio_b );
    err_t c1wireswitch_get_pio_state(c1wireswitch_t *ctx, uint8_t *pio_a, uint8_t *pio_b)
    1-Wire Switch read specific programmable I/O state function.
  • c1wireswitch_get_pio_latch_state 1-Wire Switch read programmable I/O latch state function.
    err_t c1wireswitch_get_pio_latch_state ( c1wireswitch_t *ctx, uint8_t *pio_a_latch, uint8_t *pio_b_latch );
    err_t c1wireswitch_get_pio_latch_state(c1wireswitch_t *ctx, uint8_t *pio_a_latch, uint8_t *pio_b_latch)
    1-Wire Switch read programmable I/O latch state function.

Example Description

‍This library contains API for 1-Wire Switch Click driver.

The library initializes and defines the 1-Wire bus drivers to write and read data for state programmable I/O, as well as the default configuration.

The demo application is composed of two sections :

Application Init

‍Initializes the driver and performs default configuration and sets

the PIO A to OFF and PIO B to ON state.

void application_init ( void )
{
log_cfg_t log_cfg;
c1wireswitch_cfg_t c1wireswitch_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
c1wireswitch_cfg_setup( &c1wireswitch_cfg );
C1WIRESWITCH_MAP_MIKROBUS( c1wireswitch_cfg, MIKROBUS_1 );
if ( ONE_WIRE_ERROR == c1wireswitch_init( &c1wireswitch, &c1wireswitch_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( C1WIRESWITCH_ERROR == c1wireswitch_default_cfg ( &c1wireswitch ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}
@ C1WIRESWITCH_ERROR
Definition c1wireswitch.h:201
#define C1WIRESWITCH_PIOB_ON
Definition c1wireswitch.h:97
#define C1WIRESWITCH_PIOA_OFF
Definition c1wireswitch.h:100
#define C1WIRESWITCH_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition c1wireswitch.h:148
void application_init(void)
Definition main.c:34

Application Task

‍This example demonstrates the use of the 1-Wire Switch Click board by changing the PIO A state,

which is controlling the LED, every time the state of PIO B changes. Change on the PIO B happens when the button is pushed.

void application_task ( void )
{
uint8_t pio_a = 0;
uint8_t pio_b = 0;
c1wireswitch_get_pio_state( &c1wireswitch, &pio_a, &pio_b );
if ( pio_b == C1WIRESWITCH_PIOB_OFF )
{
if ( state == 0 )
{
log_printf( &logger, " Button is pressed, LED is ON. \r\n " );
state = 1;
}
else
{
log_printf( &logger, " Button is pressed, LED is OFF. \r\n " );
state = 0;
}
Delay_ms ( 100 );
}
Delay_ms ( 100 );
}
#define C1WIRESWITCH_PIOB_OFF
Definition c1wireswitch.h:98
#define C1WIRESWITCH_PIOA_ON
Definition c1wireswitch.h:99
void application_task(void)
Definition main.c:72

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

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.