Develop an adapter solution that seamlessly integrates with a wide range of turbidity sensors, enhancing their ability to measure and interpret fluid cloudiness across diverse applications accurately
A
A
Hardware Overview
How does it work?
Turbidity Click is an adapter Click board™ that simplifies the interface of the Turbidity Sensor with the host MCU. This Click board™ represents a small-size PCB that can be connected to the mikroBUS™ socket like any other Click board™, with a 1x3 2.5mm pitch vertical type board connector placed on itself used for the turbidity sensor connection. Each of the connector pins corresponds to a pin of the turbidity sensor. Each connector pin corresponds to the turbidity sensor pins connected to this same connector via an additional 3-wire Turbidity Click cable specially made for this purpose. This way allows easy pin access and manipulation while always retaining
a perfect connection quality. This Click board™ allows users to upgrade their projects with a sensor that senses the cloudiness or haziness of a liquid caused by large numbers of individual particles invisible to the naked eye. The turbidity level is determined based on a comparison between clean water measurements and, later on, the water used at the end of usage; more precisely, the turbidity sensor measures the amount of transmitted light to determine the turbidity of the liquid. As well as turbidity, this sensor also measures liquid temperature. The analog output voltage of the Turbidity Sensor can be converted to a digital value using MCP3221,
a successive approximation A/D converter with a 12-bit resolution from Microchip, using a 2-wire I2C compatible interface. Using MCP3221 and I2C interface, data transfers at 100kbit/s in the Standard and 400kbit/s in the Fast Mode. 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.
Features overview
Development board
Nucleo-64 with STM32G474R 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-M4
MCU Memory (KB)
512
Silicon Vendor
STMicroelectronics
Pin count
64
RAM (Bytes)
128k
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
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.
Software Support
Library Description
This library contains API for Turbidity Click driver.
Key functions:
turbidity_get_ntu
- Turbidity get NTU functionturbidity_read_adc
- Turbidity read ADC functionturbidity_get_adc_voltage
- Turbidity get voltage 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 Turbidity Click example
*
* # Description
* This library contains API for the Turbidity Click driver.
* The demo application reads ADC value, ADC voltage and
* Nephelometric Turbidity Units ( NTU ).
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initialization of I2C module and log UART.
* After driver initialization, default settings turn on the device.
*
* ## Application Task
* This example demonstrates the use of the Turbidity Click board™.
* In this example, we monitor and display Nephelometric Turbidity Units ( NTU ).
* Results are being sent to the Usart Terminal, where you can track their changes.
*
* @author Nenad Filipovic
*
*/
#include "board.h"
#include "log.h"
#include "turbidity.h"
static turbidity_t turbidity;
static log_t logger;
void application_init ( void )
{
log_cfg_t log_cfg; /**< Logger config object. */
turbidity_cfg_t turbidity_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.
turbidity_cfg_setup( &turbidity_cfg );
TURBIDITY_MAP_MIKROBUS( turbidity_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == turbidity_init( &turbidity, &turbidity_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( TURBIDITY_ERROR == turbidity_default_cfg ( &turbidity ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
log_printf( &logger, "----------------------------\r\n" );
Delay_ms( 100 );
}
void application_task ( void )
{
static float ntu;
turbidity_get_ntu( &turbidity, &ntu );
log_printf( &logger, "\tNTU : %.2f\r\n", ntu );
log_printf( &logger, "----------------------------\r\n" );
Delay_ms( 1000 );
}
void main ( void )
{
application_init( );
for ( ; ; )
{
application_task( );
}
}
// ------------------------------------------------------------------------ END