Intermediate
20 min
0

Elevate your remote monitoring capabilities with 32001345 and PIC18F45K22

Stay connected, no matter the distance - 868MHz transceivers at your service

LR 3 Click with EasyPIC v8

Published Nov 09, 2023

Click board™

LR 3 Click

Development board

EasyPIC v8

Compiler

NECTO Studio

MCU

PIC18F45K22

Our 868MHz long-range transceiver is designed to empower your projects with seamless, low-power, and long-distance connectivity, making it ideal for remote monitoring and IoT applications.

A

A

Hardware Overview

How does it work?

LR 3 Click is based on the 32001345, a low-power, long-range RF technology-based transceiver module from Mipot. It offers a long-range spread spectrum communication with high interference immunity. The network is implemented as a star topology, where endpoints work in duty cycle mode, significantly reducing the overall power consumption. Coupled with the AES128 message encryption and low current consumption, LR 3 Click offers an easy and reliable solution for developing low-power, highly integrated IoT networks, security systems, alarm networks, and similar applications that require simple and reliable networking solutions. This Click board™ can be configured as either END or MASTER NODE, using simple AT commands. While working as the MASTER NODE, the Click board™

can use a set of master-specific commands, such as the pairing command. This command will add the end node, which requested pairing, to the master network table. While working as the END NODE, LR 3 Click can issue slave-specific commands/requests, such as the pairing request command, allowing that end node to be paired with the master. LR 3 Click communicates with MCU using the UART interface with commonly used UART RX and TX pins at data rates up to 115200bps for data transfer. In addition to these features, the 32001345 also uses several GPIO pins connected to the mikroBUS™ socket. The WK pin routed on the CS pin of the mikroBUS™ represents the Wake-up function used for waking up the device, while the RST pin on the mikroBUS™ socket can perform a Hardware Reset

function by putting this pin in a logic low state. This Click board™ also has an indicator routed on the INT pin of the mikroBUS ™ socket, which will provide the user with feedback after a successfully received package and verified checksum. LR 3 Click features the SMA antenna connector with an impedance of 50Ω, so it can be equipped with the appropriate 868MHz compliant antenna that MIKROE offers. 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. Also, this 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.

LR 3 Click hardware overview image

Features overview

Development board

EasyPIC v8 is a development board specially designed for the needs of rapid development of embedded applications. It supports many high pin count 8-bit PIC microcontrollers from Microchip, regardless of their number of pins, and a broad set of unique functions, such as the first-ever embedded debugger/programmer. The development board is well organized and designed so that the end-user has all the necessary elements, such as switches, buttons, indicators, connectors, and others, in one place. Thanks to innovative manufacturing technology, EasyPIC v8 provides a fluid and immersive working experience, allowing access anywhere and under any

circumstances at any time. Each part of the EasyPIC v8 development board contains the components necessary for the most efficient operation of the same board. In addition to the advanced integrated CODEGRIP programmer/debugger module, which offers many valuable programming/debugging options and seamless integration with the Mikroe software environment, the board also includes a clean and regulated power supply module for the development board. It can use a wide range of external power sources, including a battery, an external 12V power supply, and a power source via the USB Type-C (USB-C) connector.

Communication options such as USB-UART, USB DEVICE, and CAN are also included, including the well-established mikroBUS™ standard, two display options (graphical and character-based LCD), and several different DIP sockets. These sockets cover a wide range of 8-bit PIC MCUs, from the smallest PIC MCU devices with only eight up to forty pins. EasyPIC v8 is an integral part of the Mikroe ecosystem for rapid development. Natively supported by Mikroe software tools, it covers many aspects of prototyping and development thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

EasyPIC v8 horizontal image

Microcontroller Overview

MCU Card / MCU

PIC18F45K22

Architecture

PIC

MCU Memory (KB)

32

Silicon Vendor

Microchip

Pin count

40

RAM (Bytes)

1536

You complete me!

Accessories

868MHz right-angle rubber antenna is a compact and versatile solution for wireless communication. Operating within the frequency range of 868-915MHz, it ensures optimal signal reception and transmission. With a 50-ohm impedance, it's compatible with various devices and systems. This antenna boasts a 2dB gain, enhancing signal strength and extending communication range. Its vertical polarization further contributes to signal clarity. Designed to handle up to 50W of input power, it's a robust choice for various applications. Measuring just 48mm in length, this antenna is both discreet and practical. Its SMA male connector ensures a secure and reliable connection to your equipment. Whether you're working with IoT devices, remote sensors, or other wireless technologies, the 868MHz right-angle antenna offers the performance and flexibility you need for seamless communication.

LR 3 Click accessories image

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
Reset
RE1
RST
Wake up
RE0
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power supply
3.3V
3.3V
Ground
GND
GND
NC
NC
PWM
Data TX indication
RB0
INT
UART TX
RC6
TX
UART RX
RC7
RX
NC
NC
SCL
NC
NC
SDA
Power supply
5V
5V
Ground
GND
GND
1

Take a closer look

Schematic

LR 3 Click Schematic schematic

Step by step

Project assembly

EasyPIC v8 front image hardware assembly

Start by selecting your development board and Click board™. Begin with the EasyPIC v8 as your development board.

EasyPIC v8 front image hardware assembly
GNSS2 Click front image hardware assembly
MCU DIP 40 hardware assembly
GNSS2 Click complete accessories setup image hardware assembly
EasyPIC v8 Access DIPMB 1 - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
NECTO Compiler Selection Step Image hardware assembly
NECTO Output Selection Step Image hardware assembly
Necto image step 6 hardware assembly
Necto DIP image step 7 hardware assembly
Necto image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Necto PreFlash Image hardware assembly

Track your results in real time

Application Output

After pressing the "FLASH" button on the left-side panel, it is necessary to open the UART terminal to display the achieved results. By clicking on the Tools icon in the right-hand panel, multiple different functions are displayed, among which is the UART Terminal. Click on the offered "UART Terminal" icon.

UART Application Output Step 1

Once the UART terminal is opened, the window takes on a new form. At the top of the tab are two buttons, one for adjusting the parameters of the UART terminal and the other for connecting the UART terminal. The tab's lower part is reserved for displaying the achieved results. Before connecting, the terminal has a Disconnected status, indicating that the terminal is not yet active. Before connecting, it is necessary to check the set parameters of the UART terminal. Click on the "OPTIONS" button.

UART Application Output Step 2

In the newly opened UART Terminal Options field, we check if the terminal settings are correct, such as the set port and the Baud rate of UART communication. If the data is not displayed properly, it is possible that the Baud rate value is not set correctly and needs to be adjusted to 115200. If all the parameters are set correctly, click on "CONFIGURE".

UART Application Output Step 3

The next step is to click on the "CONNECT" button, after which the terminal status changes from Disconnected to Connected in green, and the data is displayed in the Received data field.

UART Application Output Step 4

Software Support

Library Description

This library contains API for LR 3 Click driver.

Key functions:

  • lr3_factory_reset - Function performs the recovery of EEPROM default values.

  • lr3_write_eeprom - Function writes data to EEPROM.

  • lr3_tx_message - Function performs the transmission of radio frames.

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 
 * \brief LR3 Click example
 * 
 * # Description
 * This example reads and processes data from LR 3 clicks.
 *
 * The demo application is composed of two sections :
 * 
 * ## Application Init 
 * Initializes the driver, enables the click board and configures it for the selected mode.
 * 
 * ## Application Task  
 * Depending on the selected mode, it reads all the received data or sends a desired message
 * every 3 seconds. All data is being displayed on the USB UART.
 * 
 * ## Additional Function
 * - indication_handler - Logs results on USB UART when device gets indication status.
 * 
 * \author MikroE Team
 *
 */
// ------------------------------------------------------------------- INCLUDES

#include "board.h"
#include "log.h"
#include "lr3.h"
#include "string.h"

// ------------------------------------------------------------------ VARIABLES

#define MASTER
// #define END_NODE

#define TEXT_TO_SEND "MikroE"

static lr3_t lr3;
static lr3_tx_msg_t lr3_tx_msg;
static log_t logger;

static lr3_message_t tmp_msg;

// -------------------------------------------------------- ADDITIONAL FUNCTIONS

static void indication_handler( uint8_t *cmd, uint8_t *pl_size, uint8_t *pl_buffer )
{
    if ( *cmd == LR3_INDICATES_RX_MSG )
    {
        if ( pl_buffer[ 0 ] == 0x00 )
        {
            log_printf( &logger, "Message received!\r\n" );
            int16_t rssi = ( pl_buffer[ 2 ] << 8 ) | pl_buffer[ 1 ];
            log_printf( &logger, "RSSI in dBm: %d\r\n", rssi );
            log_printf( &logger, "Signal-to-Noise Ratio: %u\r\n", ( uint16_t ) pl_buffer[ 3 ] );
            log_printf( &logger, "Source ID: 0x%.2X%.2X%.2X%.2X\r\n", ( uint16_t ) pl_buffer[ 7 ],
                                                                      ( uint16_t ) pl_buffer[ 6 ],
                                                                      ( uint16_t ) pl_buffer[ 5 ],
                                                                      ( uint16_t ) pl_buffer[ 4 ] );
            log_printf( &logger, "Message content: " );
            for ( uint8_t cnt = 8; cnt < *pl_size; cnt++ )
            {
                log_printf( &logger, "%c", ( uint16_t ) pl_buffer[ cnt ] );
            }
            log_printf( &logger, "\r\nChecksum: %u", ( uint16_t ) pl_buffer[ *pl_size ] );
            log_printf( &logger, "\r\n------------------------\r\n" );
        }
        else
        {
            log_printf( &logger, "Error!\r\n" );
        }
    }
    else
    {
        log_printf( &logger, "IND TYPE: 0x%.2X\r\n", ( uint16_t ) *cmd );
        log_printf( &logger, "PAYLOAD : " );
        
        for ( uint8_t cnt = 0; cnt <= *pl_size; cnt++ )
        {
            log_printf( &logger, "0x%.2X ", ( uint16_t ) pl_buffer[ cnt ] );
        }
        log_printf( &logger, "\r\n------------------------\r\n" );
    }
        
}

// ------------------------------------------------------ APPLICATION FUNCTIONS

void application_init ( void )
{
    log_cfg_t log_cfg;
    lr3_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_info( &logger, "---- Application Init ----" );

    //  Click initialization.

    lr3_cfg_setup( &cfg );
    LR3_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    lr3_init( &lr3, &cfg );

    Delay_ms( 100 );
    lr3_set_ind_handler( &lr3, indication_handler );
    lr3_hard_reset( &lr3 );
    lr3_factory_reset( &lr3 );
    Delay_ms( 1000 );
    
#ifdef MASTER
    // Set device as MASTER
    tmp_msg.payload[ 0 ] = 0;

    if( lr3_write_eeprom( &lr3, 0x00, 1, &tmp_msg.payload[ 0 ] ) )
    {
        log_error( &logger, "Setting device as MASTER!\r\n" );
        for( ; ; );
    }
    
    log_printf( &logger, "Device configured as MASTER!\r\n" );
    Delay_ms( 1000 );
    
    // Delete all network table
    if( lr3_delete_all_network_table( &lr3 ) )
    {
        log_error( &logger, "Deleting all paired devices!\r\n" );
        for( ; ; );
    }
    log_printf( &logger, "All paired devices deleted!\r\n" );
    Delay_ms( 1000 );
    
    // Enable pairing
    if( lr3_enable_pairing( &lr3, 1 ) )
    {
        log_error( &logger, "Pairing not enabled!\r\n" );
        for( ; ; );
    }
    log_printf( &logger, "Pairing enabled!\r\n" );
    Delay_ms( 1000 );
#endif

#ifdef END_NODE
    // Set device as END_NODE
    tmp_msg.payload[ 0 ] = 1;
    
    if( lr3_write_eeprom( &lr3, 0x00, 1, &tmp_msg.payload[ 0 ] ) )
    {
        log_error( &logger, "Setting device as END_NODE!\r\n" );
        for( ; ; );
    }
    
    log_printf( &logger, "Device configured as END_NODE!\r\n" );
    Delay_ms( 1000 );
    
    // Send pairing request and displays MASTER ID
    uint8_t master_id[ 4 ] = { 0 };
    do
    {
        lr3_get_pairing_request( &lr3 );
        Delay_ms( 1000 );
    }
    while ( lr3_get_activation_status( &lr3, master_id ) != 1 );
    log_printf( &logger, "Paired to a network!\r\n" );
    log_printf( &logger, "Master ID: 0x%.2X%.2X%.2X%.2X\r\n", ( uint16_t ) master_id[ 3 ],
                                                              ( uint16_t ) master_id[ 2 ],
                                                              ( uint16_t ) master_id[ 1 ],
                                                              ( uint16_t ) master_id[ 0 ] );
    
#endif
}

void application_task ( void )
{
#ifdef END_NODE
    strcpy( tmp_msg.payload, TEXT_TO_SEND );
   
    lr3_tx_msg.data_in = &tmp_msg.payload[ 0 ];
    lr3_tx_msg.n_bytes = strlen( TEXT_TO_SEND );
    lr3_tx_msg.destination_id = LR3_BROADCAST_MESSAGE;
    lr3_tx_msg.option = LR3_UNCONFIRMED_DATA_TX;
    if ( lr3_tx_message( &lr3, &lr3_tx_msg ) == 0 )
    {
        log_printf( &logger, "Message: \"%s\" sent to MASTER...\r\n", ( uint8_t * ) TEXT_TO_SEND );
        log_printf( &logger, "------------------------\r\n" );
    }
    
    Delay_ms( 3000 );
#endif
#ifdef MASTER
    lr3_read_message_process( &lr3 );
#endif
}

void main ( void )
{
    application_init( );

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


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

Additional Support

Resources