spirit  2.0.0.0
Main Page

SPIRIT click

SPIRIT click carries the SP1ML 868MHz ultra low-power RF module.

click Product page - SPIRIT click

click Product page - SPIRIT 2 click


Click library

  • Author : MikroE Team
  • Date : Apr 2020.
  • Type : UART type

Software Support

We provide a library for the Spirit 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for Spirit Click driver.

Standard key functions :

  • Config Object Initialization function.

    void spirit_cfg_setup ( spirit_cfg_t *cfg );

  • Initialization function.

    SPIRIT_RETVAL spirit_init ( spirit_t *ctx, spirit_cfg_t *cfg );

  • Power module function.

    void spirit_power_module ( spirit_t *ctx, uint8_t power_state );

Example key functions :

  • Set mode function.

    void spirit_set_mode ( spirit_t *ctx, uint8_t mode );

  • Generic read function.

    int32_t spirit_generic_read ( spirit_t *ctx, char *data_buf, uint16_t max_len );

  • Send command function.

    void spirit_send_command ( spirit_t *ctx, char *command );

Examples Description

This example reads and processes data from SPIRIT clicks.

The demo application is composed of two sections :

Application Init

Initializes the driver and configures the click board.

void application_init ( void )
{
log_cfg_t log_cfg;
// Logger initialization.
LOG_MAP_USB_UART( log_cfg );
log_cfg.level = LOG_LEVEL_DEBUG;
log_cfg.baud = 115200;
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
SPIRIT_MAP_MIKROBUS( cfg, MIKROBUS_1 );
spirit_init( &spirit, &cfg );
Delay_ms( 1000 );
log_info( &logger, "---- Configuring the module ----" );
spirit_reset( &spirit );
Delay_ms( 1000 );
log_printf( &logger, "COMMAND MODE\r\n" );
spirit_process( );
log_printf( &logger, "FIRMWARE VERSION\r\n" );
spirit_process( );
log_printf( &logger, "TXRX LED - OPEN DRAIN OUTPUT\r\n" );
spirit_process( );
log_printf( &logger, "STORE CONFIG\r\n" );
spirit_process( );
log_printf( &logger, "OPERATING MODE\r\n" );
spirit_process( );
log_info( &logger, "---- The module has been configured ----" );
#ifdef DEMO_APP_RECEIVER
log_info( &logger, "---- RECEIVER MODE ----" );
#endif
#ifdef DEMO_APP_TRANSMITTER
log_info( &logger, "---- TRANSMITTER MODE ----" );
#endif
Delay_ms( 1000 );
}

Application Task

Depending on the selected mode, it reads all the received data or sends the desired message every 2 seconds.

void application_task ( void )
{
#ifdef DEMO_APP_RECEIVER
spirit_process( );
#endif
#ifdef DEMO_APP_TRANSMITTER
log_info( &logger, "---- The message has been sent ----" );
Delay_ms( 2000 );
#endif
}

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Spirit

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. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


spirit_set_mode
void spirit_set_mode(spirit_t *ctx, uint8_t mode)
Set mode function.
SPIRIT_MAP_MIKROBUS
#define SPIRIT_MAP_MIKROBUS(cfg, mikrobus)
Definition: spirit.h:52
application_task
void application_task(void)
Definition: main.c:129
spirit_power_module
void spirit_power_module(spirit_t *ctx, uint8_t power_state)
Power module function.
spirit_init
SPIRIT_RETVAL spirit_init(spirit_t *ctx, spirit_cfg_t *cfg)
Initialization function.
SPIRIT_CMD_ENTER_OPERATING_MODE
#define SPIRIT_CMD_ENTER_OPERATING_MODE
Definition: spirit.h:102
spirit_reset
void spirit_reset(spirit_t *ctx)
Software reset function.
SPIRIT_CMD_STORE_CURRENT_CONFIG
#define SPIRIT_CMD_STORE_CURRENT_CONFIG
Definition: spirit.h:105
SPIRIT_CMD_CFG_TXRX_LED
#define SPIRIT_CMD_CFG_TXRX_LED
Definition: spirit.h:151
SPIRIT_PCFG_TXRXLED_OPEN_DRAIN
#define SPIRIT_PCFG_TXRXLED_OPEN_DRAIN
Definition: spirit.h:204
spirit_cfg_setup
void spirit_cfg_setup(spirit_cfg_t *cfg)
Config Object Initialization function.
TEXT_TO_SEND
#define TEXT_TO_SEND
Definition: main.c:33
SPIRIT_OPERATING_MODE
#define SPIRIT_OPERATING_MODE
Definition: spirit.h:90
SPIRIT_CMD_READ_MODULE_VERSION
#define SPIRIT_CMD_READ_MODULE_VERSION
Definition: spirit.h:103
application_init
void application_init(void)
Definition: main.c:79
spirit_generic_write
void spirit_generic_write(spirit_t *ctx, char *data_buf, uint16_t len)
Generic write function.
spirit_cfg_t
Click configuration structure definition.
Definition: spirit.h:258
SPIRIT_MODULE_WAKE_UP
#define SPIRIT_MODULE_WAKE_UP
Definition: spirit.h:93
SPIRIT_CMD_ENTER_COMMAND_MODE
#define SPIRIT_CMD_ENTER_COMMAND_MODE
Definition: spirit.h:101
spirit_send_cmd_with_parameter
void spirit_send_cmd_with_parameter(spirit_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
spirit_send_cmd
void spirit_send_cmd(spirit_t *ctx, char *cmd)
Send command function.