turbidity  2.0.0.0
Main Page

Turbidity Click

Turbidity Click is an adapter Click boardâ„¢, used to interface a compatible turbidity sensor with the host MCU. This board features one 1x3 2.5mm connector suitable for connecting a TSD-10 Turbidity Sensor via an additional 3-wire cable for Turbidity Click specially made for this purpose. It allows users to upgrade their projects with a sensor that senses the cloudiness or haziness of a fluid caused by large numbers of individual particles invisible to the naked eye. This sensor also measures temperature as well as turbidity.

Click Product page


Click library

  • Author : Nenad Filipovic
  • Date : Nov 2021.
  • Type : I2C type

Software Support

We provide a library for the Turbidity 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 from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for Turbidity Click driver.

Standard key functions :

Example key functions :

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

nitialization of I2C module and log UART. After driver initialization, default settings turn on the device.

void application_init ( void )
{
log_cfg_t log_cfg;
turbidity_cfg_t turbidity_cfg;
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 );
}

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.

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 );
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Turbidity

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. UART terminal is available in all MikroElektronika compilers.


turbidity_get_ntu
err_t turbidity_get_ntu(turbidity_t *ctx, float *ntu)
Turbidity get NTU function.
turbidity_t
Turbidity Click context object.
Definition: turbidity.h:109
turbidity_read_adc
err_t turbidity_read_adc(turbidity_t *ctx, uint16_t *adc_val)
Turbidity read ADC function.
application_task
void application_task(void)
Definition: main.c:70
TURBIDITY_MAP_MIKROBUS
#define TURBIDITY_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: turbidity.h:97
TURBIDITY_ERROR
@ TURBIDITY_ERROR
Definition: turbidity.h:139
turbidity_cfg_setup
void turbidity_cfg_setup(turbidity_cfg_t *cfg)
Turbidity configuration object setup function.
turbidity_cfg_t
Turbidity Click configuration object.
Definition: turbidity.h:123
turbidity_default_cfg
err_t turbidity_default_cfg(turbidity_t *ctx)
Turbidity default configuration function.
application_init
void application_init(void)
Definition: main.c:32
turbidity_init
err_t turbidity_init(turbidity_t *ctx, turbidity_cfg_t *cfg)
Turbidity initialization function.
turbidity_get_adc_voltage
err_t turbidity_get_adc_voltage(turbidity_t *ctx, float *voltage)
Turbidity get voltage function.