ph.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 PH_H
#define PH_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_uart.h"
 
#define PH_CMD_CNG_BAUD_RATE  "Baud,"
#define PH_CMD_CHK_BAUD_RATE  "Baud,?"
#define PH_CMD_SET_CONT_READ  "C,"
#define PH_CMD_CHK_CONT_READ  "C,?"
#define PH_CMD_CALIB_PERF     "Cal"
#define PH_CMD_CALIB_MID      ",mid,"
#define PH_CMD_CALIB_LOW      ",low,"
#define PH_CMD_CALIB_HIGH     ",high,"
#define PH_CMD_CHK_CALIB      "Cal,?"
#define PH_CMD_CALIB_EXP      "Export"
#define PH_CMD_CHK_CALIB_EXP  "Export,?"
#define PH_CMD_CALIB_IMP      "Import,"
#define PH_CMD_EN_FTY_RST     "Factory"
#define PH_CMD_DEV_FIND       "Find"
#define PH_CMD_DEV_INFO       "i"
#define PH_CMD_CNG_I2C        "I2C,"
#define PH_CMD_EN_LED         "L,"
#define PH_CMD_CHK_LED        "L,?"
#define PH_CMD_SET_DEV_NAME   "Name,"
#define PH_CMD_GET_DEV_NAME   "Name,?"
#define PH_CMD_PROTOCOL_LOCK  "Plock,"
#define PH_CMD_PROTOCOL_CKH   "Plock,?"
#define PH_CMD_SET_SNGL_READ  "r"
#define PH_CMD_ENTER_SLEEP    "Sleep"
#define PH_CMD_RET_SLOPE      "Slope,?"
#define PH_CMD_READ_STATUS    "Status"
#define PH_CMD_TEMP_COMP      "T,"
#define PH_CMD_CHK_TEMP_COMP  "T,?"
#define PH_CMD_RSP_CODES      "*OK"
#define PH_CMD_EN_RSP_CODES   "*OK,1"
#define PH_CMD_DIS_RSP_CODES  "*OK,0"
#define PH_CMD_CHK_RSP_CODES  "*OK,?"
#define PH_CMD_END_COMMAND    "\r"
 
#define PH_RSP_CODE_ERROR     "*ER"
#define PH_RSP_CODE_OV_VOLT   "*OV"
#define PH_RSP_CODE_UN_VOLT   "*UV"
#define PH_RSP_CODE_RESET     "*RS"
#define PH_RSP_CODE_READY     "*RE"
#define PH_RSP_CODE_SLEEP_EN  "*SL"
#define PH_RSP_CODE_WAKE_UP   "*WA"
#define PH_RSP_CODE_ALL_GOOD  "*OK"
// Restart codes list
 
#define PH_RST_CODE_POW_OFF   "P"
#define PH_RST_CODE_SW_RST    "S"
#define PH_RST_CODE_BRWN_OUT  "B"
#define PH_RST_CODE_WTD       "W"
#define PH_RST_CODE_UNKNOWN   "U"
 
#define PH_BAUD_RATE_300            "300"
#define PH_BAUD_RATE_1200           "1200"
#define PH_BAUD_RATE_2400           "2400"
#define PH_BAUD_RATE_9600           "9600"
#define PH_BAUD_RATE_19200          "19200"
#define PH_BAUD_RATE_38400          "38400"
#define PH_BAUD_RATE_57600          "57600"
#define PH_BAUD_RATE_115200         "115200"
 
#define DRV_BUFFER_SIZE                       200
 
 // ph_cmd
 
#define PH_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX )
 // ph_map
 // ph
 
typedef struct
{
    // Modules
    uart_t uart;                                    
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];         
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];         
} ph_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                                  
    pin_name_t tx_pin;                                  
    // 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;                         
} ph_cfg_t;
 
typedef enum
{
    PH_OK = 0,
    PH_ERROR = -1
 
} ph_return_value_t;
 
void ph_cfg_setup ( ph_cfg_t *cfg );
 
err_t ph_init ( ph_t *ctx, ph_cfg_t *cfg );
 
err_t ph_default_cfg ( ph_t *ctx );
 
err_t ph_generic_write ( ph_t *ctx, uint8_t *data_buf, uint16_t len );
 
err_t ph_generic_read ( ph_t *ctx, uint8_t *data_buf, uint16_t max_len );
 
void ph_uart_write ( ph_t *ctx, uint8_t input );
 
void ph_uart_read_until ( ph_t *ctx, char *p_rx_data, char *delim );
 
void ph_send_cmd ( ph_t *ctx, char *p_cmd );
 
void ph_send_cmd_resp ( ph_t *ctx, char *p_cmd, char *p_resp );
 
void ph_send_cmd_w_num ( ph_t *ctx, char *p_cmd, char *flt_val, char *p_resp );
 
void ph_get_cmd_resp ( ph_t *ctx, char *p_cmd, char *p_resp );
 
void ph_switch_led ( ph_t *ctx, uint8_t state, char *p_resp );
 
void ph_chk_led_state ( ph_t *ctx, char *p_resp );
 
void ph_find_dev ( ph_t *ctx, char *p_resp );
 
void ph_cont_read ( ph_t *ctx, uint8_t time, char *p_resp );
 
void ph_chk_cont_read ( ph_t *ctx, char *p_resp );
 
void ph_perf_calib ( ph_t *ctx, char *point, float flt_val, char *p_resp );
 
void ph_chk_calib ( ph_t *ctx, char *p_resp );
 
void ph_chk_slope ( ph_t *ctx, char *p_resp );
 
void ph_get_calib_exp_bytes_num ( ph_t *ctx, char *p_resp );
 
void ph_import_calib ( ph_t *ctx, uint8_t *in_calib, char *p_resp );
 
void ph_factory_rst ( ph_t *ctx, char *p_resp );
 
void ph_set_temp_comp ( ph_t *ctx, float flt_val, char *p_resp );
 
void ph_get_temp_comp ( ph_t *ctx, char *p_resp );
 
void ph_set_name ( ph_t *ctx, char *p_dev_name, char *p_resp );
 
void ph_show_name ( ph_t *ctx, char *p_dev_name );
 
void ph_get_dev_info ( ph_t *ctx, char *p_resp );
 
void ph_check_status ( ph_t *ctx, char *p_resp );
 
void ph_sleep ( ph_t *ctx );
 
void ph_chng_baud_rate ( ph_t *ctx, char *baud_rate, char *p_resp  );
 
void ph_chk_baud_rate ( ph_t *ctx, char *p_resp );
 
void ph_protocol_lock ( ph_t *ctx, uint8_t state, char *p_resp );
 
void ph_check_protocol_lock ( ph_t *ctx, char *p_resp );
 
void ph_chng_i2c_adr ( ph_t *ctx, uint32_t i2c_adr, char *p_resp );
 
void ph_single_read ( ph_t *ctx, char *p_resp );
 
uint8_t ph_response ( ph_t *ctx, char *p_resp );
 
void ph_clr_log_buf ( char *p_str );
 
#ifdef __cplusplus
}
#endif
#endif // PH_H
 
 // ph
 
// ------------------------------------------------------------------------ END