ezocarrierdo  2.1.0.0
Main Page

EZO Carrier DO Click

EZO Carrier Click - Oxygen is a compact add-on board suitable for determining the dissolved oxygen of a liquid in your application. This board features the EZO-DO™, an ISO 5814 compliant embedded dissolved oxygen 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 DO 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 DO Click driver.

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of EZO Carrier DO 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 high point calibration.

void application_init ( void )
{
log_cfg_t log_cfg;
ezocarrierdo_cfg_t ezocarrierdo_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
ezocarrierdo_cfg_setup( &ezocarrierdo_cfg );
EZOCARRIERDO_MAP_MIKROBUS( ezocarrierdo_cfg, MIKROBUS_1 );
if ( UART_ERROR == ezocarrierdo_init( &ezocarrierdo, &ezocarrierdo_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
log_printf( &logger, "Device status \r\n" );
error_flag = ezocarrierdo_rsp_check( &ezocarrierdo, EZOCARRIERDO_RSP_OK );
ezocarrierdo_error_check( error_flag );
log_printf( &logger, "Factory reset \r\n" );
error_flag = ezocarrierdo_rsp_check( &ezocarrierdo, EZOCARRIERDO_RSP_READY );
ezocarrierdo_error_check( error_flag );
log_printf( &logger, "Device info \r\n" );
error_flag = ezocarrierdo_rsp_check( &ezocarrierdo, EZOCARRIERDO_RSP_OK );
ezocarrierdo_error_check( error_flag );
uint8_t n_cnt = 0;
uint8_t last_reading[ APP_BUFFER_SIZE ] = { 0 };
ezocarrierdo_clear_app_buf( );
ezocarrierdo_process ( &ezocarrierdo );
strcpy( last_reading, app_buf );
log_printf( &logger, "High point calibration \r\n" );
log_printf( &logger, "Waiting for stable readings \r\n" );
while ( n_cnt <= 5 )
{
if ( EZOCARRIERDO_OK == ezocarrierdo_process ( &ezocarrierdo ) )
{
if ( 0 == strstr( app_buf, last_reading ) )
{
n_cnt++;
}
else
{
strcpy( last_reading, app_buf );
n_cnt = 0;
}
}
log_printf( &logger, "- " );
Delay_ms ( 1000 );
ezocarrierdo_clear_app_buf( );
}
log_printf( &logger, "\r\n Calibration \r\n" );
error_flag = ezocarrierdo_rsp_check( &ezocarrierdo, EZOCARRIERDO_RSP_OK );
ezocarrierdo_error_check( error_flag );
#define DISABLE_CONT_READ "0"
log_printf( &logger, "Disable continuous reading mode \r\n" );
error_flag = ezocarrierdo_rsp_check( &ezocarrierdo, EZOCARRIERDO_RSP_OK );
ezocarrierdo_error_check( error_flag );
log_info( &logger, " Application Task " );
}

Application Task

Reads and processes all incoming dissolved oxygen data from the probe, and displays them on the USB UART in mg/L.

void application_task ( void )
{
log_printf( &logger, "Reading... \r\n" );
error_flag = ezocarrierdo_rsp_check( &ezocarrierdo, EZOCARRIERDO_RSP_OK );
ezocarrierdo_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.EZOCarrierDO

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.


EZOCARRIERDO_CMD_STATUS
#define EZOCARRIERDO_CMD_STATUS
Definition: ezocarrierdo.h:91
DISABLE_CONT_READ
#define DISABLE_CONT_READ
ezocarrierdo_cfg_t
EZO Carrier DO Click configuration object.
Definition: ezocarrierdo.h:185
ezocarrierdo_cfg_setup
void ezocarrierdo_cfg_setup(ezocarrierdo_cfg_t *cfg)
EZO Carrier DO configuration object setup function.
EZOCARRIERDO_CMD_SINGLE_READ
#define EZOCARRIERDO_CMD_SINGLE_READ
Definition: ezocarrierdo.h:88
EZOCARRIERDO_MAP_MIKROBUS
#define EZOCARRIERDO_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: ezocarrierdo.h:140
EZOCARRIERDO_CMD_FACTORY
#define EZOCARRIERDO_CMD_FACTORY
Definition: ezocarrierdo.h:78
EZOCARRIERDO_RSP_OK
#define EZOCARRIERDO_RSP_OK
EZO Carrier DO response codes.
Definition: ezocarrierdo.h:100
application_task
void application_task(void)
Definition: main.c:172
ezocarrierdo_send_cmd_check
void ezocarrierdo_send_cmd_check(ezocarrierdo_t *ctx, uint8_t *cmd)
Check the sent command.
EZOCARRIERDO_OK
@ EZOCARRIERDO_OK
Definition: ezocarrierdo.h:210
ezocarrierdo_init
err_t ezocarrierdo_init(ezocarrierdo_t *ctx, ezocarrierdo_cfg_t *cfg)
EZO Carrier DO initialization function.
EZOCARRIERDO_CMD_DEV_INFO
#define EZOCARRIERDO_CMD_DEV_INFO
Definition: ezocarrierdo.h:80
ezocarrierdo_send_cmd_with_par
void ezocarrierdo_send_cmd_with_par(ezocarrierdo_t *ctx, uint8_t *cmd, uint8_t *param_buf)
Send command function with parameter.
ezocarrierdo_send_cmd
void ezocarrierdo_send_cmd(ezocarrierdo_t *ctx, uint8_t *cmd)
Send command function.
EZOCARRIERDO_RSP_READY
#define EZOCARRIERDO_RSP_READY
Definition: ezocarrierdo.h:105
ezocarrierdo_t
EZO Carrier DO Click context object.
Definition: ezocarrierdo.h:165
application_init
void application_init(void)
Definition: main.c:89
APP_BUFFER_SIZE
#define APP_BUFFER_SIZE
Definition: main.c:33
EZOCARRIERDO_CMD_CAL
#define EZOCARRIERDO_CMD_CAL
Definition: ezocarrierdo.h:76
EZOCARRIERDO_CMD_CONT_READ
#define EZOCARRIERDO_CMD_CONT_READ
Definition: ezocarrierdo.h:75