Achieve long-range wireless communication in the 868MHz SRD band with Tarvos-III (2609011081000) and STM32G474RE

/*!
 * @file main.c
 * @brief ISM 7 Click Example.
 *
 * # Description
 * This example demonstrates the use of ISM 7 Click board by showing
 * the communication between two Click boards.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * Initializes the driver, resets the Click board, reads the device info, and sends
 * a message to initiate the communication with other Click board.
 *
 * ## Application Task
 * Reads and parses all the received event packets and displays them the USB UART.
 * All incoming data messages received from the connected device will be echoed back.
 *
 * ## Additional Function
 * - static err_t ism7_parse_cnf ( ism7_t *ctx )
 * - static err_t ism7_parse_ind ( ism7_t *ctx )
 * - static err_t ism7_parse_event ( ism7_t *ctx )
 *
 * @author Stefan Filipovic
 *
 */

#include "board.h"
#include "log.h"
#include "ism7.h"

// Text message to send to initiate communication
#define DEMO_TEXT_MESSAGE   "MIKROE - ISM 7 Click board"

static ism7_t ism7;
static log_t logger;

/**
 * @brief ISM 7 parse cnf function.
 * @details This function parses all received confirmation packets and displays them on the USB UART.
 * @param[in] ctx : Click context object.
 * See #ism7_t object definition for detailed explanation.
 * @return @li @c 0 - Packet parsed successfully,
 *         @li @c 1 - Error.
 * See #err_t definition for detailed explanation.
 * @note None.
 */
static err_t ism7_parse_cnf ( ism7_t *ctx );

/**
 * @brief ISM 7 parse ind function.
 * @details This function parses all received indication packets and displays them on the USB UART.
 * @param[in] ctx : Click context object.
 * See #ism7_t object definition for detailed explanation.
 * @return @li @c 0 - Packet parsed successfully,
 *         @li @c 1 - Error.
 * See #err_t definition for detailed explanation.
 * @note None.
 */
static err_t ism7_parse_ind ( ism7_t *ctx );

/**
 * @brief ISM 7 parse event function.
 * @details This function parses all received packets and displays them on the USB UART.
 * @param[in] ctx : Click context object.
 * See #ism7_t object definition for detailed explanation.
 * @return @li @c 0 - Packet parsed successfully,
 *         @li @c 1 - Error.
 * See #err_t definition for detailed explanation.
 * @note None.
 */
static err_t ism7_parse_event ( ism7_t *ctx );

void application_init ( void ) 
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    ism7_cfg_t ism7_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.
    ism7_cfg_setup( &ism7_cfg );
    ISM7_MAP_MIKROBUS( ism7_cfg, MIKROBUS_1 );
    if ( UART_ERROR == ism7_init( &ism7, &ism7_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    log_printf( &logger, ">> Reset device.\r\n" );
    if ( ISM7_ERROR == ism7_reset_device ( &ism7 ) )
    {
        log_error( &logger, " Reset device." );
        for ( ; ; );
    }
    
    log_printf( &logger, ">> Get device info.\r\n" );
    if ( ISM7_OK == ism7_get_user_setting ( &ism7, ISM7_SET_IDX_FACTORY_SETTINGS ) ) 
    {
        log_printf( &logger, " < Serial number: 0x%.2X%.2X%.2X%.2X\r\n", 
                    ( uint16_t ) ism7.evt_pkt.payload[ 4 ], 
                    ( uint16_t ) ism7.evt_pkt.payload[ 3 ], 
                    ( uint16_t ) ism7.evt_pkt.payload[ 2 ], 
                    ( uint16_t ) ism7.evt_pkt.payload[ 1 ] );
        log_printf( &logger, "   Hardware version: %u.%u.%u\r\n", 
                    ( uint16_t ) ism7.evt_pkt.payload[ 5 ], 
                    ( uint16_t ) ism7.evt_pkt.payload[ 6 ], 
                    ( uint16_t ) ism7.evt_pkt.payload[ 7 ] );
        log_printf( &logger, "   Frequency correction factor: %u\r\n",  
                    ( uint16_t ) ism7.evt_pkt.payload[ 8 ] );
    }

    log_printf( &logger, ">> Get FW version.\r\n" );
    if ( ISM7_OK == ism7_get_user_setting ( &ism7, ISM7_SET_IDX_FIRMWARE_VERSION ) ) 
    {
        log_printf( &logger, " < FW version: %u.%u.%u\r\n\n", 
                    ( uint16_t ) ism7.evt_pkt.payload[ 3 ], 
                    ( uint16_t ) ism7.evt_pkt.payload[ 2 ], 
                    ( uint16_t ) ism7.evt_pkt.payload[ 1 ] );
    }

    log_printf( &logger, ">> Send message to initiate communication.\r\n" );
    ism7.cmd_pkt.cmd = ISM7_CMD_REQ_DATA;
    ism7.cmd_pkt.payload_len = strlen ( DEMO_TEXT_MESSAGE );
    strcpy ( ism7.cmd_pkt.payload, DEMO_TEXT_MESSAGE );
    if ( ISM7_OK == ism7_send_cmd ( &ism7 ) )
    {
        if ( ISM7_OK == ism7_wait_for_event ( &ism7, ISM7_CMD_CNF_DATA, ISM7_WAIT_TIME_1S ) ) 
        {
            ism7_parse_event ( &ism7 );
        }
    }

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

void application_task ( void ) 
{
    if ( ISM7_OK == ism7_read_event ( &ism7 ) ) 
    {
        ism7_parse_event ( &ism7 );
    }
}

int main ( void ) 
{
    /* Do not remove this line or clock might not be set correctly. */
    #ifdef PREINIT_SUPPORTED
    preinit();
    #endif
    
    application_init( );
    
    for ( ; ; ) 
    {
        application_task( );
    }

    return 0;
}

static err_t ism7_parse_cnf ( ism7_t *ctx )
{
    err_t error_flag = ISM7_OK;
    uint16_t byte_cnt = 0;

    if ( ISM7_CMD_TYPE_CNF == ( ctx->evt_pkt.cmd & ISM7_CMD_TYPE_MASK ) )
    {
        // Parse confirmation packet
        switch ( ctx->evt_pkt.cmd )
        {
            case ISM7_CMD_CNF_GET:
            {
                log_printf( &logger, " < GET_CNF -> " );
                switch ( ctx->evt_pkt.payload[ 0 ] )
                {
                    case ISM7_CNF_GET_STATUS_OK:
                    {
                        log_printf( &logger, "Request successfully received and processed" );
                        break;
                    }
                    case ISM7_CNF_GET_STATUS_FAILED:
                    {
                        log_printf( &logger, "Request not successful" );
                        break;
                    }
                    default:
                    {
                        log_printf( &logger, "Unknown status: 0x%.2X", ( uint16_t ) ctx->evt_pkt.payload[ 0 ] );
                        break;
                    }
                }
                if ( ctx->evt_pkt.payload_len > 1 )
                {
                    log_printf( &logger, "\r\n   Setting: " );
                    for ( byte_cnt = 1; byte_cnt < ctx->evt_pkt.payload_len; byte_cnt++ )
                    {
                        log_printf( &logger, "0x%.2X ", ( uint16_t ) ctx->evt_pkt.payload[ byte_cnt ] );
                    }
                }
                break;
            }
            case ISM7_CMD_CNF_DATA:
            {
                log_printf( &logger, " < DATA_CNF -> " );
                switch ( ctx->evt_pkt.payload[ 0 ] )
                {
                    case ISM7_CNF_DATA_STATUS_ACK:
                    {
                        log_printf( &logger, "ACK received or not requested" );
                        break;
                    }
                    case ISM7_CNF_DATA_STATUS_NACK:
                    {
                        log_printf( &logger, "No ACK received within a time-out " );
                        break;
                    }
                    case ISM7_CNF_DATA_STATUS_INVALID_CH:
                    {
                        log_printf( &logger, "Invalid channel selected" );
                        break;
                    }
                    case ISM7_CNF_DATA_STATUS_RADIO_CH_BUSY:
                    {
                        log_printf( &logger, "Radio channel busy (LBT)" );
                        break;
                    }
                    case ISM7_CNF_DATA_STATUS_MODULE_BUSY:
                    {
                        log_printf( &logger, "Module is currently busy" );
                        break;
                    }
                    case ISM7_CNF_DATA_STATUS_INVALID:
                    {
                        log_printf( &logger, "Invalid (payload too long)" );
                        break;
                    }
                    default:
                    {
                        log_printf( &logger, "Unknown status: 0x%.2X", ( uint16_t ) ctx->evt_pkt.payload[ 0 ] );
                        break;
                    }
                }
                Delay_ms ( 1000 );
                break;
            }
            default:
            {
                log_printf( &logger, " < CMD_CNF 0x%.2X -> ", ( uint16_t ) ctx->evt_pkt.cmd );
                for ( byte_cnt = 0; byte_cnt < ctx->evt_pkt.payload_len; byte_cnt++ )
                {
                    log_printf( &logger, "0x%.2X ", ( uint16_t ) ctx->evt_pkt.payload[ byte_cnt ] );
                }
                break;
            }
        }
        log_printf( &logger, "\r\n\n" );
    }
    else
    {
        // Wrong packet type
        error_flag |= ISM7_ERROR;
    }
    return error_flag;
}

static err_t ism7_parse_ind ( ism7_t *ctx )
{
    err_t error_flag = ISM7_OK;
    uint16_t byte_cnt = 0;

    if ( ISM7_CMD_TYPE_IND == ( ctx->evt_pkt.cmd & ISM7_CMD_TYPE_MASK ) )
    {
        // Parse indication packet
        switch ( ctx->evt_pkt.cmd )
        {
            case ISM7_CMD_IND_DATAEX:
            {
                log_printf( &logger, " < DATAEX_IND -> " );
                log_printf( &logger, "Field strength: %d\r\n", 
                            ( int16_t ) ( ( int8_t ) ctx->evt_pkt.payload[ ctx->evt_pkt.payload_len - 1 ] ) );
                log_printf( &logger, "   Data (HEX): " );
                for ( byte_cnt = 0; byte_cnt < ( ctx->evt_pkt.payload_len - 1 ); byte_cnt++ )
                {
                    log_printf( &logger, "0x%.2X ", ( uint16_t ) ctx->evt_pkt.payload[ byte_cnt ] );
                }
                Delay_ms ( 10 );
                ctx->evt_pkt.payload[ ctx->evt_pkt.payload_len - 1 ] = 0;
                log_printf( &logger, "\r\n   Data (STR): %s", &ctx->evt_pkt.payload[ 0 ] );
                
                log_printf( &logger, "\r\n\n>> Echo back the received message." );
                ctx->cmd_pkt.cmd = ISM7_CMD_REQ_DATA;
                ctx->cmd_pkt.payload_len = ctx->evt_pkt.payload_len - 1;
                memcpy ( &ctx->cmd_pkt.payload[ 0 ], &ctx->evt_pkt.payload[ 0 ], ctx->evt_pkt.payload_len - 1 );
                error_flag |= ism7_send_cmd ( ctx );
                break;
            }
            default:
            {
                log_printf( &logger, " < CMD_IND 0x%.2X -> ", ( uint16_t ) ctx->evt_pkt.cmd );
                for ( byte_cnt = 0; byte_cnt < ctx->evt_pkt.payload_len; byte_cnt++ )
                {
                    log_printf( &logger, "0x%.2X ", ( uint16_t ) ctx->evt_pkt.payload[ byte_cnt ] );
                }
                break;
            }
        }
        log_printf( &logger, "\r\n\n" );
    }
    else
    {
        // Wrong packet type
        error_flag |= ISM7_ERROR;
    }
    return error_flag;
}

static err_t ism7_parse_event ( ism7_t *ctx )
{
    err_t error_flag = ISM7_OK;

    if ( ISM7_CMD_TYPE_CNF == ( ctx->evt_pkt.cmd & ISM7_CMD_TYPE_MASK ) )
    {
        error_flag |= ism7_parse_cnf ( ctx );
    }
    else if ( ISM7_CMD_TYPE_IND == ( ctx->evt_pkt.cmd & ISM7_CMD_TYPE_MASK ) )
    {
        error_flag |= ism7_parse_ind ( ctx );
    }
    else
    {
        // Error packet should not be a command request
        error_flag |= ISM7_ERROR;
    }
    return error_flag;
}

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