Experience the future of wireless technology with SP1ML-915 and STM32F091RC
Connecting your world, beyond boundaries
Published Feb 26, 2024
Click board™
SPIRIT 2 Click
Dev. board
Nucleo-64 with STM32F091RC MCU
Compiler
NECTO Studio
MCU
STM32F091RC
Expect excellence in every byte of data transmission with our fully integrated RF module at the 915MHz ISM band, revolutionizing how you exchange information.
A
A
Hardware Overview
How does it work?
SPIRIT 2 Click is based on the SP1ML-915, a low power RF module with integrated MCU, from STMicroelectronics. The module incorporates all the necessary components packed in a very compact size of 14 x 13.4 x 2.5 mm. The STM32L1, an integrated 32-bit MCU is designed with the maximized power saving in mind, offering many power saving features. This allows even lower power consumption for the entire module, providing data rates up to 500 kbps. RF signal modulation schemes facilitate any RF transmission requirements, allowing fine-tuning of both the range and the power consumption. The primary function of the SP1ML-915 module is to be used as a wireless serial cable replacement. The Click board™ features the SWD compatible programming header, allowing custom firmware to be uploaded to the integrated MCU. However, that may destroy the factory firmware and void the warranty. Offering a simple UART interface, combined with the lowered power consumption, it represents a perfect solution for adding wireless connectivity, especially to IoT applications. Since the
module is designed to be used without an extensive RF communication experience, it is very simple to be used. The Click board™ offers two modes of operation: Operating mode and Command mode. In operating mode, data received from the host on the UART interface will be wirelessly transmitted by the module using the current configuration settings for frequency, data rate, modulation and output power. Also, any data received by the module that meets the configured filtering criteria, will be output to the UART interface. Command mode allows configuration of the SP1ML-915 module. When the Click board™ receives an escape sequence "+++", followed by at least of 500ms of RX inactivity, it will enter the Command mode. By using a number of simple AT commands, the developer has the possibility to configure the operating parameters of the device. The complete list of AT commands is provided in the datasheet of the SP1ML-915 module. A note should be taken not to send the escape sequence during the normal operation, if entering the Command mode is not intended. Besides using the aforementioned escape sequence, the module
can be put into the Command mode by driving the CMD pin of the Click board™ to a LOW logic level. A HIGH logic level on this pin will force the Click board™ into the Operating mode. The Click board™ should be reset after changing the state on this pin. To reset the SP1ML-915 module, a LOW logic level to the RST pin of the Click board™ should be applied. While there is a LOW logic level present on the RST pin, the SP1ML-915module will be held in the RESET mode. SHD pin of the Click board™ will drive the Click board™ into the power down mode by applying the LOW logic level on it. A HIGH logic level will wake-up the device. The data traffic is indicated by a LED labeled as TX/RX. However, the indicator should be enabled to use it. Consult the datasheet of the SP1ML-915 for more information. The Click board™ can be interfaced with both 3.3V and 5V MCUs without the need for any external components. Thanks to the TXB0106, 6-Bit bidirectional voltage-level translator, the Click board™ can be simply used with a wide range of different MCUs.
Features overview
Development board
Nucleo-64 with STM32F091RC MCU offers a cost-effective and adaptable platform for developers to explore new ideas and prototype their designs. This board harnesses the versatility of the STM32 microcontroller, enabling users to select the optimal balance of performance and power consumption for their projects. It accommodates the STM32 microcontroller in the LQFP64 package and includes essential components such as a user LED, which doubles as an ARDUINO® signal, alongside user and reset push-buttons, and a 32.768kHz crystal oscillator for precise timing operations. Designed with expansion and flexibility in mind, the Nucleo-64 board features an ARDUINO® Uno V3 expansion connector and ST morpho extension pin
headers, granting complete access to the STM32's I/Os for comprehensive project integration. Power supply options are adaptable, supporting ST-LINK USB VBUS or external power sources, ensuring adaptability in various development environments. The board also has an on-board ST-LINK debugger/programmer with USB re-enumeration capability, simplifying the programming and debugging process. Moreover, the board is designed to simplify advanced development with its external SMPS for efficient Vcore logic supply, support for USB Device full speed or USB SNK/UFP full speed, and built-in cryptographic features, enhancing both the power efficiency and security of projects. Additional connectivity is
provided through dedicated connectors for external SMPS experimentation, a USB connector for the ST-LINK, and a MIPI® debug connector, expanding the possibilities for hardware interfacing and experimentation. Developers will find extensive support through comprehensive free software libraries and examples, courtesy of the STM32Cube MCU Package. This, combined with compatibility with a wide array of Integrated Development Environments (IDEs), including IAR Embedded Workbench®, MDK-ARM, and STM32CubeIDE, ensures a smooth and efficient development experience, allowing users to fully leverage the capabilities of the Nucleo-64 board in their projects.
Microcontroller Overview
MCU Card / MCU
Architecture
ARM Cortex-M0
MCU Memory (KB)
256
Silicon Vendor
STMicroelectronics
Pin count
64
RAM (Bytes)
32768
You complete me!
Accessories
Click Shield for Nucleo-64 comes equipped with two proprietary mikroBUS™ sockets, allowing all the Click board™ devices to be interfaced with the STM32 Nucleo-64 board with no effort. This way, Mikroe allows its users to add any functionality from our ever-growing range of Click boards™, such as WiFi, GSM, GPS, Bluetooth, ZigBee, environmental sensors, LEDs, speech recognition, motor control, movement sensors, and many more. More than 1537 Click boards™, which can be stacked and integrated, are at your disposal. The STM32 Nucleo-64 boards are based on the microcontrollers in 64-pin packages, a 32-bit MCU with an ARM Cortex M4 processor operating at 84MHz, 512Kb Flash, and 96KB SRAM, divided into two regions where the top section represents the ST-Link/V2 debugger and programmer while the bottom section of the board is an actual development board. These boards are controlled and powered conveniently through a USB connection to program and efficiently debug the Nucleo-64 board out of the box, with an additional USB cable connected to the USB mini port on the board. Most of the STM32 microcontroller pins are brought to the IO pins on the left and right edge of the board, which are then connected to two existing mikroBUS™ sockets. This Click Shield also has several switches that perform functions such as selecting the logic levels of analog signals on mikroBUS™ sockets and selecting logic voltage levels of the mikroBUS™ sockets themselves. Besides, the user is offered the possibility of using any Click board™ with the help of existing bidirectional level-shifting voltage translators, regardless of whether the Click board™ operates at a 3.3V or 5V logic voltage level. Once you connect the STM32 Nucleo-64 board with our Click Shield for Nucleo-64, you can access hundreds of Click boards™, working with 3.3V or 5V logic voltage levels.
Used MCU Pins
mikroBUS™ mapper
Take a closer look
Click board™ Schematic
Step by step
Project assembly
Start by selecting your development board and Click board™. Begin with the Nucleo-64 with STM32F091RC MCU as your development board.
Track your results in real time
Application Output
1. Application Output - In Debug mode, the 'Application Output' window enables real-time data monitoring, offering direct insight into execution results. Ensure proper data display by configuring the environment correctly using the provided tutorial.
2. UART Terminal - Use the UART Terminal to monitor data transmission via a USB to UART converter, allowing direct communication between the Click board™ and your development system. Configure the baud rate and other serial settings according to your project's requirements to ensure proper functionality. For step-by-step setup instructions, refer to the provided tutorial.
3. Plot Output - The Plot feature offers a powerful way to visualize real-time sensor data, enabling trend analysis, debugging, and comparison of multiple data points. To set it up correctly, follow the provided tutorial, which includes a step-by-step example of using the Plot feature to display Click board™ readings. To use the Plot feature in your code, use the function: plot(*insert_graph_name*, variable_name);. This is a general format, and it is up to the user to replace 'insert_graph_name' with the actual graph name and 'variable_name' with the parameter to be displayed.
Software Support
Library Description
This library contains API for SPIRIT 2 Click driver.
Key functions:
spirit2_power_module- Function for power modespirit2_reset- Function for resetingspirit2_set_mode- Function for setting mode
Open Source
Code example
The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.
/*!
* @file main.c
* @brief SPIRIT 2 Click Example.
*
* # Description
* This example reads and processes data from SPIRIT 2 Click.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes the driver and configures the Click board.
*
* ## Application Task
* Depending on the selected mode, it reads all the received data or sends the desired message
* every 2 seconds.
*
* ## Additional Function
* - static err_t spirit2_process ( void )
*
* @author Jelena Milosavljevic
*
*/
// ------------------------------------------------------------------- INCLUDES
#include "board.h"
#include "log.h"
#include "spirit2.h"
#define PROCESS_BUFFER_SIZE 500
#define PROCESS_COUNTER 20
#define TEXT_TO_SEND "MikroE - SPIRIT 2 Click board\r\n"
#define DEMO_APP_RECEIVER
//#define DEMO_APP_TRANSMITTER
static spirit2_t spirit2;
static log_t logger;
static char app_buf[ PROCESS_BUFFER_SIZE ] = { 0 };
static int32_t app_buf_len = 0;
static int32_t app_buf_cnt = 0;
/**
* @brief SPIRIT2 2 data reading function.
* @details This function reads data from device and concatenates data to application buffer.
*
* @return @li @c 0 - Read some data.
* @li @c -1 - Nothing is read.
* @li @c -2 - Application buffer overflow.
*
* See #err_t definition for detailed explanation.
* @note None.
*/
static void spirit2_process ( void );
// ------------------------------------------------------ APPLICATION FUNCTIONS
void application_init ( void )
{
log_cfg_t log_cfg;
spirit2_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.
spirit2_cfg_setup( &cfg );
SPIRIT2_MAP_MIKROBUS( cfg, MIKROBUS_1 );
spirit2_init( &spirit2, &cfg );
Delay_ms ( 1000 );
log_info( &logger, "---- Configuring the module ----" );
spirit2_power_module( &spirit2, SPIRIT2_MODULE_WAKE_UP );
spirit2_reset( &spirit2 );
spirit2_set_mode( &spirit2, SPIRIT2_OPERATING_MODE );
Delay_ms ( 1000 );
log_printf( &logger, "COMMAND MODE\r\n" );
spirit2_send_cmd( &spirit2, SPIRIT2_CMD_ENTER_COMMAND_MODE );
spirit2_process( );
log_printf( &logger, "FIRMWARE VERSION\r\n" );
spirit2_send_cmd( &spirit2, SPIRIT2_CMD_READ_MODULE_VERSION );
spirit2_process( );
log_printf( &logger, "TXRX LED - OPEN DRAIN OUTPUT\r\n" );
spirit2_send_cmd_with_parameter( &spirit2, SPIRIT2_CMD_CFG_TXRX_LED, SPIRIT2_PCFG_TXRXLED_OPEN_DRAIN );
spirit2_process( );
log_printf( &logger, "STORE CONFIG\r\n" );
spirit2_send_cmd( &spirit2, SPIRIT2_CMD_STORE_CURRENT_CONFIG );
spirit2_process( );
log_printf( &logger, "OPERATING MODE\r\n" );
spirit2_send_cmd( &spirit2, SPIRIT2_CMD_ENTER_OPERATING_MODE );
spirit2_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 );
}
void application_task ( void ) {
#ifdef DEMO_APP_RECEIVER
spirit2_process( );
#endif
#ifdef DEMO_APP_TRANSMITTER
spirit2_generic_write( &spirit2, TEXT_TO_SEND, strlen( TEXT_TO_SEND ) );
log_info( &logger, "---- The message has been sent ----" );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
#endif
}
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 void spirit2_process ( void ) {
int32_t rsp_size;
char uart_rx_buffer[ PROCESS_BUFFER_SIZE ] = { 0 };
uint8_t process_cnt = PROCESS_COUNTER;
while( process_cnt != 0 ) {
rsp_size = spirit2_generic_read( &spirit2, &uart_rx_buffer, PROCESS_BUFFER_SIZE );
if ( rsp_size > 0 ) {
for ( uint8_t cnt = 0; cnt < rsp_size; cnt++ ) {
log_printf( &logger, "%c", uart_rx_buffer[ cnt ] );
if ( uart_rx_buffer[ cnt ] == '\n' ) {
log_printf( &logger, "-----------------------------\r\n" );
}
}
}
else {
process_cnt--;
// Process delay
Delay_ms ( 100 );
}
}
}
// ------------------------------------------------------------------------ END
Additional Support
Resources
Category:Sub-1 GHz Transceievers
