ezocarrierorp  2.1.0.0
Main Page

EZO Carrier ORP Click

EZO Carrier Click - ORP is a compact add-on board suitable for determining a liquid's oxidation/reduction potential in your application. This board features the EZO-ORP™, an ISO 11271 compliant embedded ORP circuit board from Atlas Scientific.

Click Product page


Click library

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

Software Support

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

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of EZO Carrier ORP 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 single point calibration

with a calibration solutio with 225 mV ORP value.

void application_init ( void )
{
log_cfg_t log_cfg;
ezocarrierorp_cfg_t ezocarrierorp_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
ezocarrierorp_cfg_setup( &ezocarrierorp_cfg );
EZOCARRIERORP_MAP_MIKROBUS( ezocarrierorp_cfg, MIKROBUS_1 );
if ( UART_ERROR == ezocarrierorp_init( &ezocarrierorp, &ezocarrierorp_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
log_printf( &logger, "Device status \r\n" );
error_flag = ezocarrierorp_rsp_check( &ezocarrierorp, EZOCARRIERORP_RSP_OK );
ezocarrierorp_error_check( error_flag );
log_printf( &logger, "Factory reset \r\n" );
error_flag = ezocarrierorp_rsp_check( &ezocarrierorp, EZOCARRIERORP_RSP_READY );
ezocarrierorp_error_check( error_flag );
log_printf( &logger, "Device info \r\n" );
error_flag = ezocarrierorp_rsp_check( &ezocarrierorp, EZOCARRIERORP_RSP_OK );
ezocarrierorp_error_check( error_flag );
uint8_t n_cnt = 0;
uint8_t last_reading[ APP_BUFFER_SIZE ] = { 0 };
ezocarrierorp_clear_app_buf( );
ezocarrierorp_process ( &ezocarrierorp );
strcpy( last_reading, app_buf );
log_printf( &logger, "Place the probe into the calibration solution,\r\n" );
log_printf( &logger, "for single-point calibration \r\n" );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
log_printf( &logger, "Waiting for stable readings \r\n" );
while ( n_cnt <= 5 )
{
if ( EZOCARRIERORP_OK == ezocarrierorp_process ( &ezocarrierorp ) )
{
if ( 0 == strstr( app_buf, last_reading ) )
{
n_cnt++;
}
else
{
strcpy( last_reading, app_buf );
n_cnt = 0;
}
}
log_printf( &logger, "- " );
Delay_ms ( 1000 );
ezocarrierorp_clear_app_buf( );
}
#define CALIBRATION_VALUE "225"
log_printf( &logger, "\r\n Calibration \r\n" );
error_flag = ezocarrierorp_rsp_check( &ezocarrierorp, EZOCARRIERORP_RSP_OK );
ezocarrierorp_error_check( error_flag );
#define DISABLE_CONT_READ "0"
log_printf( &logger, "Disable continuous reading mode \r\n" );
error_flag = ezocarrierorp_rsp_check( &ezocarrierorp, EZOCARRIERORP_RSP_OK );
ezocarrierorp_error_check( error_flag );
log_info( &logger, " Application Task " );
}

Application Task

Initializes the driver, performs the Click default factory reset, and single point calibration

with a calibration solutio with 225 mV ORP value.

void application_task ( void )
{
log_printf( &logger, "Reading... \r\n" );
error_flag = ezocarrierorp_rsp_check( &ezocarrierorp, EZOCARRIERORP_RSP_OK );
ezocarrierorp_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.EZOCarrierORP

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.


EZOCARRIERORP_OK
@ EZOCARRIERORP_OK
Definition: ezocarrierorp.h:206
DISABLE_CONT_READ
#define DISABLE_CONT_READ
EZOCARRIERORP_CMD_STATUS
#define EZOCARRIERORP_CMD_STATUS
Definition: ezocarrierorp.h:88
EZOCARRIERORP_RSP_OK
#define EZOCARRIERORP_RSP_OK
EZO Carrier ORP response codes.
Definition: ezocarrierorp.h:96
ezocarrierorp_cfg_setup
void ezocarrierorp_cfg_setup(ezocarrierorp_cfg_t *cfg)
EZO Carrier ORP configuration object setup function.
application_task
void application_task(void)
Definition: main.c:180
EZOCARRIERORP_CMD_SINGLE_READ
#define EZOCARRIERORP_CMD_SINGLE_READ
Definition: ezocarrierorp.h:86
ezocarrierorp_send_cmd_check
void ezocarrierorp_send_cmd_check(ezocarrierorp_t *ctx, uint8_t *cmd)
Check the sent command.
ezocarrierorp_send_cmd
void ezocarrierorp_send_cmd(ezocarrierorp_t *ctx, uint8_t *cmd)
Send command function.
EZOCARRIERORP_CMD_CAL
#define EZOCARRIERORP_CMD_CAL
Definition: ezocarrierorp.h:76
EZOCARRIERORP_RSP_READY
#define EZOCARRIERORP_RSP_READY
Definition: ezocarrierorp.h:101
EZOCARRIERORP_CMD_DEV_INFO
#define EZOCARRIERORP_CMD_DEV_INFO
Definition: ezocarrierorp.h:80
ezocarrierorp_send_cmd_with_par
void ezocarrierorp_send_cmd_with_par(ezocarrierorp_t *ctx, uint8_t *cmd, uint8_t *param_buf)
Send command function with parameter.
application_init
void application_init(void)
Definition: main.c:90
EZOCARRIERORP_CMD_CONT_READ
#define EZOCARRIERORP_CMD_CONT_READ
Definition: ezocarrierorp.h:75
APP_BUFFER_SIZE
#define APP_BUFFER_SIZE
Definition: main.c:34
ezocarrierorp_t
EZO Carrier ORP Click context object.
Definition: ezocarrierorp.h:161
ezocarrierorp_init
err_t ezocarrierorp_init(ezocarrierorp_t *ctx, ezocarrierorp_cfg_t *cfg)
EZO Carrier ORP initialization function.
CALIBRATION_VALUE
#define CALIBRATION_VALUE
EZOCARRIERORP_MAP_MIKROBUS
#define EZOCARRIERORP_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: ezocarrierorp.h:136
EZOCARRIERORP_CMD_FACTORY
#define EZOCARRIERORP_CMD_FACTORY
Definition: ezocarrierorp.h:78
ezocarrierorp_cfg_t
EZO Carrier ORP Click configuration object.
Definition: ezocarrierorp.h:181