ph2.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 PH2_H
#define PH2_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_analog_in.h"
#include "drv_i2c_master.h"
#include "drv_one_wire.h"
 
#define PH2_CMD_CONVERT_TEMPERATURE     0x44
#define PH2_CMD_WRITE_SCRATCHPAD        0x4E
#define PH2_CMD_READ_SCRATCHPAD         0xBE
#define PH2_CMD_COPY_SCRATCHPAD         0x48
#define PH2_CMD_RECALL_SCRATCHPAD       0xB8
#define PH2_CMD_READ_POWER_SUPPLY       0xB4
 
 // ph2_cmd
 
#define PH2_PH_CALCULATION_COEF     0.18
 
#define PH2_CONFIG_ADDRESS          0x10
#define PH2_ADC_RESOLUTION          0x0FFF
#define PH2_VREF_3V3                3.3
#define PH2_VREF_5V                 5.0
 
#define PH2_SET_DEV_ADDR            0x4D
 
#define PH2_FAMILY_CODE             0x28
 
#define PH2_CONFIG_RESOLUTION_9BIT      0x00
#define PH2_CONFIG_RESOLUTION_10BIT     0x20
#define PH2_CONFIG_RESOLUTION_11BIT     0x40
#define PH2_CONFIG_RESOLUTION_12BIT     0x60
#define PH2_CONFIG_RESOLUTION_BIT_MASK  0x60
#define PH2_CONFIG_RESERVED_BITS        0x10
 
#define PH2_DATA_RESOLUTION             0.0625
 
#define PH2_DEFAULT_ADDRESS             PH2_CONFIG_ADDRESS
#define PH2_DEFAULT_RESOLUTION          PH2_CONFIG_RESOLUTION_12BIT
#define PH2_DEFAULT_TEMP_HIGH_ALARM     0xFF
#define PH2_DEFAULT_TEMP_LOW_ALARM      0x00
 
 // ph2_set
 
#define PH2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.dq = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.st1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.st2 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // ph2_map
 // ph2
 
typedef enum
{
    PH2_DRV_SEL_ADC,       
    PH2_DRV_SEL_I2C        
} ph2_drv_t;
 
typedef struct
{
    digital_out_t st1;              
    digital_out_t st2;              
    analog_in_t  adc;               
    i2c_master_t i2c;               
    one_wire_t ow;                  
    float pH_val;
    float pH_vol;
 
    one_wire_rom_address_t rom_addr;    
    uint8_t config;                     
    uint8_t      slave_address;     
    float        vref;              
    ph2_drv_t drv_sel;              
} ph2_t;
 
typedef struct
{
    pin_name_t an;              
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t dq;              
    pin_name_t st1;             
    pin_name_t st2;             
    analog_in_resolution_t resolution;              
    float                  vref;                    
    uint32_t               i2c_speed;               
    uint8_t                i2c_address;             
    ph2_drv_t drv_sel;                
} ph2_cfg_t;
 
typedef enum
{
    PH2_OK = 0,
    PH2_ERROR = -1
 
} ph2_return_value_t;
 
void ph2_cfg_setup ( ph2_cfg_t *cfg );
 
void ph2_drv_interface_selection ( ph2_cfg_t *cfg, ph2_drv_t drv_sel );
 
err_t ph2_init ( ph2_t *ctx, ph2_cfg_t *cfg );
 
err_t ph2_read_raw_adc ( ph2_t *ctx, uint16_t *raw_adc );
 
err_t ph2_read_voltage ( ph2_t *ctx, float *voltage );
 
err_t ph2_set_vref ( ph2_t *ctx, float vref );
 
err_t ph2_calibrate ( ph2_t *ctx, float pH_value );
 
err_t ph2_calculate_ph ( ph2_t *ctx, float *pH_value );
 
void ph2_calibrate_offset ( ph2_t *ctx );
 
void ph2_enable_st1 ( ph2_t *ctx );
 
void ph2_disable_st1 ( ph2_t *ctx );
 
void ph2_enable_st2 ( ph2_t *ctx );
 
void ph2_disable_st2 ( ph2_t *ctx );
 
err_t ph2_ds18b20_init ( ph2_t *ctx, ph2_cfg_t *cfg );
 
err_t ph2_ds18b20_check_communication ( ph2_t *ctx );
 
err_t ph2_ds18b20_select_device ( ph2_t *ctx );
 
err_t ph2_ds18b20_read_scratchpad ( ph2_t *ctx, uint8_t *scratchpad );
 
err_t ph2_ds18b20_write_scratchpad ( ph2_t *ctx, uint8_t temp_high, uint8_t temp_low, uint8_t config );
 
err_t ph2_ds18b20_default_cfg ( ph2_t *ctx );
 
err_t ph2_ds18b20_start_measurement ( ph2_t *ctx );
 
err_t ph2_ds18b20_read_temperature ( ph2_t *ctx, float *temperature );
 
#ifdef __cplusplus
}
#endif
#endif // PH2_H
 
 // ph2
 
// ------------------------------------------------------------------------ END