Intermediate
30 min

Transform your hardware management with DS2413 and PIC32MZ1024EFH064

Say goodbye to complicated device control

1-Wire Switch Click with PIC32MZ clicker

Published Apr 24, 2023

Click board™

1-Wire Switch Click

Dev Board

PIC32MZ clicker

Compiler

NECTO Studio

MCU

PIC32MZ1024EFH064

Take your device control to the next level with a programmable I/O 1-Wire switch - the easy way to remotely switch and sense devices

A

A

Hardware Overview

How does it work?

1-Wire Switch Click is based on the DS2413, a dual-channel addressable switch from Analog Devices. The DS2413 combines two programmable I/O pins and a fully featured 1-Wire interface in a single package, ensuring that PIO output changes occur error-free. The PIO outputs are configured as open-drain, operate at up to 28V (provide a high level of fault tolerance in the end application), and have an ON-resistance of 20Ω maximum. By monitoring the voltage at its programmable I/O pins, the DS2413 lets you read back the state of the load, in this case, the state of the button, which in this configuration is in the role of input, while the output state is visually detected through the red LED marked with OUT. The DS2413's power is supplied parasitically from the 1-Wire bus,

a system with a single bus controller and one or more peripherals. With that in mind, this Click board™ has one additional unpopulated header, which enables the connection of other external 1-Wire devices, thus forming a line with several peripherals on one controller. The DS2413 also has a 64-bit long registration number that guarantees unique identification. This number addresses the device in a multidrop 1-Wire network environment, where multiple devices reside on a common 1-Wire bus and operate independently. As mentioned, the 1-Wire Switch Click communicates with MCU using the 1-Wire interface that, by definition, requires only one data line (and ground) for communication with MCU. The 1-Wire communication line is routed to the SMD jumper

labeled as I/O SEL, which allows routing of the 1-Wire communication either to the GP0 pin or the GP1 pin of the mikroBUS™ socket. These pins are labeled, respectively, the same as the SMD jumper positions, making the selection of the desired pin simple and straightforward. This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the VCC SEL jumper. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. However, the Click board™ comes equipped with a library containing easy-to-use functions and an example code that can be used, as a reference, for further development.

1-Wire Switch Click hardware overview image

Features overview

Development board

PIC32MZ Clicker is a compact starter development board that brings the flexibility of add-on Click boards™ to your favorite microcontroller, making it a perfect starter kit for implementing your ideas. It comes with an onboard 32-bit PIC32MZ microcontroller with FPU from Microchip, a USB connector, LED indicators, buttons, a mikroProg connector, and a header for interfacing with external electronics. Thanks to its compact design with clear and easy-recognizable silkscreen markings, it provides a fluid and immersive working experience, allowing access anywhere and under

any circumstances. Each part of the PIC32MZ Clicker development kit contains the components necessary for the most efficient operation of the same board. In addition to the possibility of choosing the PIC32MZ Clicker programming method, using USB HID mikroBootloader, or through an external mikroProg connector for PIC, dsPIC, or PIC32 programmer, the Clicker board also includes a clean and regulated power supply module for the development kit. The USB Micro-B connection can provide up to 500mA of current, which is more than enough to operate all onboard

and additional modules. All communication methods that mikroBUS™ itself supports are on this board, including the well-established mikroBUS™ socket, reset button, and several buttons and LED indicators. PIC32MZ Clicker is an integral part of the Mikroe ecosystem, allowing you to create a new application in minutes. Natively supported by Mikroe software tools, it covers many aspects of prototyping thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

PIC32MZ clicker double side image

Microcontroller Overview

MCU Card / MCU

default

Architecture

PIC32

MCU Memory (KB)

1024

Silicon Vendor

Microchip

Pin count

64

RAM (Bytes)

524288

Used MCU Pins

mikroBUS™ mapper

1-Wire Data IN/OUT
RE4
AN
NC
NC
RST
NC
NC
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
1-Wire Data IN/OUT
RB3
PWM
NC
NC
INT
NC
NC
TX
NC
NC
RX
NC
NC
SCL
NC
NC
SDA
Power Supply
5V
5V
Ground
GND
GND
1

Take a closer look

Schematic

1-Wire Switch Click Schematic schematic

Step by step

Project assembly

PIC32MZ clicker front image hardware assembly

Start by selecting your development board and Click board™. Begin with the PIC32MZ clicker as your development board.

PIC32MZ clicker front image hardware assembly
Thermo 26 Click front image hardware assembly
Prog-cut hardware assembly
Micro B Connector clicker - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
Necto image step 5 hardware assembly
Necto image step 6 hardware assembly
Flip&Click PIC32MZ MCU step hardware assembly
Necto No Display image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Debug Image Necto Step hardware assembly

Track your results in real time

Application Output via Debug Mode

1. Once the code example is loaded, pressing the "DEBUG" button initiates the build process, programs it on the created setup, and enters Debug mode.

2. After the programming is completed, a header with buttons for various actions within the IDE becomes visible. Clicking the green "PLAY" button starts reading the results achieved with the Click board™. The achieved results are displayed in the Application Output tab.

DEBUG_Application_Output

Software Support

Library Description

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

Key functions:

  • c1wireswitch_set_pio_state 1-Wire Switch write specific programmable I/O state function.

  • c1wireswitch_get_pio_state 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.

Open Source

Code example

This example can be found in NECTO Studio. Feel free to download the code, or you can copy the code below.

/*!
 * @file main.c
 * @brief 1-Wire Switch Click 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.
 *
 * ## 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.
 *
 * @author Stefan Ilic
 *
 */

#include "board.h"
#include "log.h"
#include "c1wireswitch.h"

static c1wireswitch_t c1wireswitch;
static log_t logger;
static uint8_t state = 0;

void application_init ( void ) 
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    c1wireswitch_cfg_t c1wireswitch_cfg;  /**< Click 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 " );

    // 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 ( ; ; );
    }
    
    c1wireswitch_set_pio_state( &c1wireswitch, C1WIRESWITCH_PIOA_OFF, C1WIRESWITCH_PIOB_ON );
    
    log_info( &logger, " Application Task " );
}

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 )
        {
            c1wireswitch_set_pio_state( &c1wireswitch, C1WIRESWITCH_PIOA_ON, C1WIRESWITCH_PIOB_ON );
            log_printf( &logger, " Button is pressed, LED is ON. \r\n " );
            state = 1;
        }
        else
        {
            c1wireswitch_set_pio_state( &c1wireswitch, C1WIRESWITCH_PIOA_OFF, C1WIRESWITCH_PIOB_ON );
            log_printf( &logger, " Button is pressed, LED is OFF. \r\n " );
            state = 0;
        }
        Delay_ms( 100 );
    }
    Delay_ms( 100 );
}

void main ( void ) 
{
    application_init( );

    for ( ; ; ) 
    {
        application_task( );
    }
}

// ------------------------------------------------------------------------ END

Additional Support

Resources

Love this project?

'Buy This Kit' button takes you directly to the shopping cart where you can easily add or remove products.