ezocarrierph  2.1.0.0
Main Page

EZO Carrier pH click

EZO Carrier Click - pH is a compact add-on board that allows you to measure the potential of hydrogen (the power of hydrogen) in your application. This board features the EZO™ pH, a pH measurement interface circuit board from Atlas Scientific.

click Product page


Click library

  • Author : Stefan Ilic
  • Date : Oct 2023.
  • Type : UART type

Software Support

We provide a library for the EZO Carrier pH 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 EZO Carrier pH Click driver.

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of EZO Carrier pH click board by processing

the incoming data and displaying them on the USB UART.

The demo application is composed of two sections :

Application Init

Initializes the driver, performs the click default factory reset, and mid point calibration.

void application_init ( void )
{
log_cfg_t log_cfg;
ezocarrierph_cfg_t ezocarrierph_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
ezocarrierph_cfg_setup( &ezocarrierph_cfg );
EZOCARRIERPH_MAP_MIKROBUS( ezocarrierph_cfg, MIKROBUS_1 );
if ( UART_ERROR == ezocarrierph_init( &ezocarrierph, &ezocarrierph_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
log_printf( &logger, "Device status \r\n" );
error_flag = ezocarrierph_rsp_check( &ezocarrierph, EZOCARRIERPH_RSP_OK );
ezocarrierph_error_check( error_flag );
log_printf( &logger, "Factory reset \r\n" );
error_flag = ezocarrierph_rsp_check( &ezocarrierph, EZOCARRIERPH_RSP_READY );
ezocarrierph_error_check( error_flag );
log_printf( &logger, "Device info \r\n" );
error_flag = ezocarrierph_rsp_check( &ezocarrierph, EZOCARRIERPH_RSP_OK );
ezocarrierph_error_check( error_flag );
uint8_t n_cnt = 0;
uint8_t last_reading[ APP_BUFFER_SIZE ] = { 0 };
ezocarrierph_clear_app_buf( );
ezocarrierph_process ( &ezocarrierph );
strcpy( last_reading, app_buf );
log_printf( &logger, "Mid point calibration \r\n" );
log_printf( &logger, "- - - - - - - - - - - - - - -\r\n" );
log_printf( &logger, "Place probe into pH neutral solution \r\n" );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
log_printf( &logger, "Starting calibration \r\n" );
log_printf( &logger, "- - - - - - - - - - - - - - -\r\n" );
log_printf( &logger, "Waiting for stable readings \r\n" );
while ( n_cnt <= 5 )
{
if ( EZOCARRIERPH_OK == ezocarrierph_process ( &ezocarrierph ) )
{
if ( 0 == strstr( app_buf, last_reading ) )
{
n_cnt++;
}
else
{
strcpy( last_reading, app_buf );
n_cnt = 0;
}
}
log_printf( &logger, "- " );
Delay_ms ( 1000 );
ezocarrierph_clear_app_buf( );
}
#define MID_POINT_CALIB "mid,7.00"
log_printf( &logger, "\r\n Calibration \r\n" );
error_flag = ezocarrierph_rsp_check( &ezocarrierph, EZOCARRIERPH_RSP_OK );
ezocarrierph_error_check( error_flag );
#define DISABLE_CONT_READ "0"
log_printf( &logger, "Disable continuous reading mode \r\n" );
error_flag = ezocarrierph_rsp_check( &ezocarrierph, EZOCARRIERPH_RSP_OK );
ezocarrierph_error_check( error_flag );
log_info( &logger, " Application Task " );
}

Application Task

Reads and processes all incoming pH value data and displays them on the USB UART.

void application_task ( void )
{
log_printf( &logger, "Reading... \r\n" );
error_flag = ezocarrierph_rsp_check( &ezocarrierph, EZOCARRIERPH_RSP_OK );
ezocarrierph_error_check( error_flag );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
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.EZOCarrierpH

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.


ezocarrierph_cfg_t
EZO Carrier pH Click configuration object.
Definition: ezocarrierph.h:184
DISABLE_CONT_READ
#define DISABLE_CONT_READ
EZOCARRIERPH_CMD_FACTORY
#define EZOCARRIERPH_CMD_FACTORY
Definition: ezocarrierph.h:78
EZOCARRIERPH_CMD_STATUS
#define EZOCARRIERPH_CMD_STATUS
Definition: ezocarrierph.h:90
EZOCARRIERPH_RSP_OK
#define EZOCARRIERPH_RSP_OK
EZO Carrier pH response codes.
Definition: ezocarrierph.h:99
EZOCARRIERPH_OK
@ EZOCARRIERPH_OK
Definition: ezocarrierph.h:209
ezocarrierph_send_cmd_with_par
void ezocarrierph_send_cmd_with_par(ezocarrierph_t *ctx, uint8_t *cmd, uint8_t *param_buf)
Send command function with parameter.
ezocarrierph_init
err_t ezocarrierph_init(ezocarrierph_t *ctx, ezocarrierph_cfg_t *cfg)
EZO Carrier pH initialization function.
EZOCARRIERPH_CMD_DEV_INFO
#define EZOCARRIERPH_CMD_DEV_INFO
Definition: ezocarrierph.h:80
EZOCARRIERPH_CMD_CAL
#define EZOCARRIERPH_CMD_CAL
Definition: ezocarrierph.h:76
application_task
void application_task(void)
Definition: main.c:182
ezocarrierph_send_cmd
void ezocarrierph_send_cmd(ezocarrierph_t *ctx, uint8_t *cmd)
Send command function.
EZOCARRIERPH_CMD_SINGLE_READ
#define EZOCARRIERPH_CMD_SINGLE_READ
Definition: ezocarrierph.h:87
ezocarrierph_send_cmd_check
void ezocarrierph_send_cmd_check(ezocarrierph_t *ctx, uint8_t *cmd)
Check the sent command.
MID_POINT_CALIB
#define MID_POINT_CALIB
EZOCARRIERPH_MAP_MIKROBUS
#define EZOCARRIERPH_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: ezocarrierph.h:139
EZOCARRIERPH_RSP_READY
#define EZOCARRIERPH_RSP_READY
Definition: ezocarrierph.h:104
ezocarrierph_cfg_setup
void ezocarrierph_cfg_setup(ezocarrierph_cfg_t *cfg)
EZO Carrier pH configuration object setup function.
application_init
void application_init(void)
Definition: main.c:89
EZOCARRIERPH_CMD_CONT_READ
#define EZOCARRIERPH_CMD_CONT_READ
Definition: ezocarrierph.h:75
APP_BUFFER_SIZE
#define APP_BUFFER_SIZE
Definition: main.c:33
ezocarrierph_t
EZO Carrier pH Click context object.
Definition: ezocarrierph.h:164