ezocarrierph.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef EZOCARRIERPH_H
#define EZOCARRIERPH_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_uart.h"
 
#define EZOCARRIERPH_CMD_BAUD                   "Baud"
#define EZOCARRIERPH_CMD_CONT_READ              "C"
#define EZOCARRIERPH_CMD_CAL                    "Cal"
#define EZOCARRIERPH_CMD_EXPORT                 "Export"
#define EZOCARRIERPH_CMD_FACTORY                "Factory"
#define EZOCARRIERPH_CMD_FIND                   "Find"
#define EZOCARRIERPH_CMD_DEV_INFO               "i"
#define EZOCARRIERPH_CMD_I2C                    "I2C"
#define EZOCARRIERPH_CMD_IMPORT                 "Import"
#define EZOCARRIERPH_CMD_LED                    "L"
#define EZOCARRIERPH_CMD_NAME                   "Name"
#define EZOCARRIERPH_CMD_EXTENDED_PH            "pHext"
#define EZOCARRIERPH_CMD_PROTOCOL_LOCK          "Plock"
#define EZOCARRIERPH_CMD_SINGLE_READ            "R"
#define EZOCARRIERPH_CMD_SLEEP                  "Sleep"
#define EZOCARRIERPH_CMD_SLOPE                  "Slope"
#define EZOCARRIERPH_CMD_STATUS                 "Status"
#define EZOCARRIERPH_CMD_TEMP_COMPENSATION      "T"
#define EZOCARRIERPH_CMD_RESP_CODES             "*OK"
#define EZOCARRIERPH_CMD_END_COMMAND            "\r"
 
#define EZOCARRIERPH_RSP_OK                     "*OK"
#define EZOCARRIERPH_RSP_ERROR                  "*ER"
#define EZOCARRIERPH_RSP_OVER_VOLT              "*OV"
#define EZOCARRIERPH_RSP_UNDER_VOLT             "*UV"
#define EZOCARRIERPH_RSP_RESET                  "*RS"
#define EZOCARRIERPH_RSP_READY                  "*RE"
#define EZOCARRIERPH_RSP_SLEEP                  "*SL"
#define EZOCARRIERPH_RSP_WAKE_UP                "*WA"
 
#define EZOCARRIERPH_TX_DRV_BUFFER_SIZE         100
#define EZOCARRIERPH_RX_DRV_BUFFER_SIZE         300
 
 // ezocarrierph_cmd
 
#define EZOCARRIERPH_DEVICE_ADDRESS             0x61
 
#define EZOCARRIERPH_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); 
 
 // ezocarrierph_map
 // ezocarrierph
 
typedef enum
{
    EZOCARRIERPH_DRV_SEL_I2C,       
    EZOCARRIERPH_DRV_SEL_UART       
} ezocarrierph_drv_t;
 
typedef struct
{
    // Modules
    uart_t uart;                                
    i2c_master_t i2c;                           
    // Buffers
    uint8_t uart_rx_buffer[ EZOCARRIERPH_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ EZOCARRIERPH_TX_DRV_BUFFER_SIZE ];  
    uint8_t slave_address;                      
    ezocarrierph_drv_t drv_sel;                 
} ezocarrierph_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                          
    pin_name_t tx_pin;                          
    pin_name_t scl;                             
    pin_name_t sda;                             
    // Static variable
    uint32_t         baud_rate;                 
    bool             uart_blocking;             
    uart_data_bits_t data_bit;                  
    uart_parity_t    parity_bit;                
    uart_stop_bits_t stop_bit;                  
    uint32_t   i2c_speed;                       
    uint8_t    i2c_address;                     
    ezocarrierph_drv_t drv_sel;                 
} ezocarrierph_cfg_t;
 
typedef enum
{
    EZOCARRIERPH_OK = 0,
    EZOCARRIERPH_ERROR = -1,
    EZOCARRIERPH_ERROR_TIMEOUT = -2
 
} ezocarrierph_return_value_t;
 
void ezocarrierph_cfg_setup ( ezocarrierph_cfg_t *cfg );
 
void ezocarrierph_drv_interface_sel ( ezocarrierph_cfg_t *cfg, ezocarrierph_drv_t drv_sel );
 
err_t ezocarrierph_init ( ezocarrierph_t *ctx, ezocarrierph_cfg_t *cfg );
 
err_t ezocarrierph_generic_write ( ezocarrierph_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t ezocarrierph_generic_read ( ezocarrierph_t *ctx, uint8_t *data_out, uint16_t len );
 
 
void ezocarrierph_send_cmd ( ezocarrierph_t *ctx, uint8_t *cmd );
 
void ezocarrierph_send_cmd_with_par ( ezocarrierph_t *ctx, uint8_t *cmd, uint8_t *param_buf );
 
void ezocarrierph_send_cmd_check ( ezocarrierph_t *ctx, uint8_t *cmd );
 
#ifdef __cplusplus
}
#endif
#endif // EZOCARRIERPH_H
 
 // ezocarrierph
 
// ------------------------------------------------------------------------ END