ph  2.0.0.0
ph.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef PH_H
29 #define PH_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define PH_CMD_CNG_BAUD_RATE "Baud,"
60 #define PH_CMD_CHK_BAUD_RATE "Baud,?"
61 #define PH_CMD_SET_CONT_READ "C,"
62 #define PH_CMD_CHK_CONT_READ "C,?"
63 #define PH_CMD_CALIB_PERF "Cal"
64 #define PH_CMD_CALIB_MID ",mid,"
65 #define PH_CMD_CALIB_LOW ",low,"
66 #define PH_CMD_CALIB_HIGH ",high,"
67 #define PH_CMD_CHK_CALIB "Cal,?"
68 #define PH_CMD_CALIB_EXP "Export"
69 #define PH_CMD_CHK_CALIB_EXP "Export,?"
70 #define PH_CMD_CALIB_IMP "Import,"
71 #define PH_CMD_EN_FTY_RST "Factory"
72 #define PH_CMD_DEV_FIND "Find"
73 #define PH_CMD_DEV_INFO "i"
74 #define PH_CMD_CNG_I2C "I2C,"
75 #define PH_CMD_EN_LED "L,"
76 #define PH_CMD_CHK_LED "L,?"
77 #define PH_CMD_SET_DEV_NAME "Name,"
78 #define PH_CMD_GET_DEV_NAME "Name,?"
79 #define PH_CMD_PROTOCOL_LOCK "Plock,"
80 #define PH_CMD_PROTOCOL_CKH "Plock,?"
81 #define PH_CMD_SET_SNGL_READ "r"
82 #define PH_CMD_ENTER_SLEEP "Sleep"
83 #define PH_CMD_RET_SLOPE "Slope,?"
84 #define PH_CMD_READ_STATUS "Status"
85 #define PH_CMD_TEMP_COMP "T,"
86 #define PH_CMD_CHK_TEMP_COMP "T,?"
87 #define PH_CMD_RSP_CODES "*OK"
88 #define PH_CMD_EN_RSP_CODES "*OK,1"
89 #define PH_CMD_DIS_RSP_CODES "*OK,0"
90 #define PH_CMD_CHK_RSP_CODES "*OK,?"
91 #define PH_CMD_END_COMMAND "\r"
92 
97 #define PH_RSP_CODE_ERROR "*ER"
98 #define PH_RSP_CODE_OV_VOLT "*OV"
99 #define PH_RSP_CODE_UN_VOLT "*UV"
100 #define PH_RSP_CODE_RESET "*RS"
101 #define PH_RSP_CODE_READY "*RE"
102 #define PH_RSP_CODE_SLEEP_EN "*SL"
103 #define PH_RSP_CODE_WAKE_UP "*WA"
104 #define PH_RSP_CODE_ALL_GOOD "*OK"
105 // Restart codes list
106 
111 #define PH_RST_CODE_POW_OFF "P"
112 #define PH_RST_CODE_SW_RST "S"
113 #define PH_RST_CODE_BRWN_OUT "B"
114 #define PH_RST_CODE_WTD "W"
115 #define PH_RST_CODE_UNKNOWN "U"
116 
121 #define PH_BAUD_RATE_300 "300"
122 #define PH_BAUD_RATE_1200 "1200"
123 #define PH_BAUD_RATE_2400 "2400"
124 #define PH_BAUD_RATE_9600 "9600"
125 #define PH_BAUD_RATE_19200 "19200"
126 #define PH_BAUD_RATE_38400 "38400"
127 #define PH_BAUD_RATE_57600 "57600"
128 #define PH_BAUD_RATE_115200 "115200"
129 
135 #define DRV_BUFFER_SIZE 200
136  // ph_cmd
138 
153 #define PH_MAP_MIKROBUS( cfg, mikrobus ) \
154  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
155  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX )
156  // ph_map // ph
158 
163 typedef struct
164 {
165  // Modules
166  uart_t uart;
168  // Buffers
169  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
170  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
172 } ph_t;
173 
178 typedef struct
179 {
180  // Communication gpio pins
181  pin_name_t rx_pin;
182  pin_name_t tx_pin;
184  // Static variable
185  uint32_t baud_rate;
187  uart_data_bits_t data_bit;
188  uart_parity_t parity_bit;
189  uart_stop_bits_t stop_bit;
191 } ph_cfg_t;
192 
197 typedef enum
198 {
199  PH_OK = 0,
200  PH_ERROR = -1
201 
203 
219 void ph_cfg_setup ( ph_cfg_t *cfg );
220 
234 err_t ph_init ( ph_t *ctx, ph_cfg_t *cfg );
235 
249 err_t ph_default_cfg ( ph_t *ctx );
250 
263 err_t ph_generic_write ( ph_t *ctx, char *data_buf, uint16_t len );
264 
277 err_t ph_generic_read ( ph_t *ctx, char *data_buf, uint16_t max_len );
278 
287 void ph_uart_write ( ph_t *ctx, uint8_t input );
288 
298 void ph_uart_read_until ( ph_t *ctx, char *p_rx_data, char delim );
299 
308 void ph_send_cmd ( ph_t *ctx, char *p_cmd );
309 
319 void ph_send_cmd_resp ( ph_t *ctx, char *p_cmd, char *p_resp );
320 
332 void ph_send_cmd_w_num ( ph_t *ctx, char *p_cmd, float flt_val, char *p_resp );
333 
343 void ph_get_cmd_resp ( ph_t *ctx, char *p_cmd, char *p_resp );
344 
354 void ph_switch_led ( ph_t *ctx, uint8_t state, char *p_resp );
355 
364 void ph_chk_led_state ( ph_t *ctx, char *p_resp );
365 
376 void ph_find_dev ( ph_t *ctx, char *p_resp );
377 
389 void ph_cont_read ( ph_t *ctx, uint8_t time, char *p_resp );
390 
399 void ph_chk_cont_read ( ph_t *ctx, char *p_resp );
400 
415 void ph_perf_calib ( ph_t *ctx, char *point, float flt_val, char *p_resp );
416 
430 void ph_chk_calib ( ph_t *ctx, char *p_resp );
431 
440 void ph_chk_slope ( ph_t *ctx, char *p_resp );
441 
452 void ph_get_calib_exp_bytes_num ( ph_t *ctx, char *p_resp );
453 
465 void ph_import_calib ( ph_t *ctx, uint8_t *in_calib, char *p_resp );
466 
475 void ph_factory_rst ( ph_t *ctx, char *p_resp );
476 
489 void ph_set_temp_comp ( ph_t *ctx, float flt_val, char *p_resp );
490 
501 void ph_get_temp_comp ( ph_t *ctx, char *p_resp );
502 
514 void ph_set_name ( ph_t *ctx, char *p_dev_name, char *p_resp );
515 
524 void ph_show_name ( ph_t *ctx, char *p_dev_name );
525 
534 void ph_get_dev_info ( ph_t *ctx, char *p_resp );
535 
544 void ph_check_status ( ph_t *ctx, char *p_resp );
545 
553 void ph_sleep ( ph_t *ctx );
554 
566 void ph_chng_baud_rate ( ph_t *ctx, char *baud_rate, char *p_resp );
567 
578 void ph_chk_baud_rate ( ph_t *ctx, char *p_resp );
579 
589 void ph_protocol_lock ( ph_t *ctx, uint8_t state, char *p_resp );
590 
599 void ph_check_protocol_lock ( ph_t *ctx, char *p_resp );
600 
612 void ph_chng_i2c_adr ( ph_t *ctx, uint32_t i2c_adr, char *p_resp );
613 
622 void ph_single_read ( ph_t *ctx, char *p_resp );
623 
632 uint8_t ph_response ( ph_t *ctx, char *p_resp );
633 
640 void ph_clr_log_buf ( char *p_str );
641 
642 #ifdef __cplusplus
643 }
644 #endif
645 #endif // PH_H
646  // ph
648 
649 // ------------------------------------------------------------------------ END
ph_chng_i2c_adr
void ph_chng_i2c_adr(ph_t *ctx, uint32_t i2c_adr, char *p_resp)
Change Device's I2C slave address function.
ph_get_calib_exp_bytes_num
void ph_get_calib_exp_bytes_num(ph_t *ctx, char *p_resp)
Export calibration data function.
ph_get_cmd_resp
void ph_get_cmd_resp(ph_t *ctx, char *p_cmd, char *p_resp)
Send get response function.
ph_protocol_lock
void ph_protocol_lock(ph_t *ctx, uint8_t state, char *p_resp)
Protocol Lock enable/disable function.
ph_chk_calib
void ph_chk_calib(ph_t *ctx, char *p_resp)
Check if Calibration was performed function.
ph_send_cmd_resp
void ph_send_cmd_resp(ph_t *ctx, char *p_cmd, char *p_resp)
Send command and get response function.
ph_cfg_t::tx_pin
pin_name_t tx_pin
Definition: ph.h:182
ph_send_cmd_w_num
void ph_send_cmd_w_num(ph_t *ctx, char *p_cmd, float flt_val, char *p_resp)
Send command with number and get response function.
ph_t::uart
uart_t uart
Definition: ph.h:166
ph_cfg_t::rx_pin
pin_name_t rx_pin
Definition: ph.h:181
ph_cont_read
void ph_cont_read(ph_t *ctx, uint8_t time, char *p_resp)
Set Continous read function.
ph_response
uint8_t ph_response(ph_t *ctx, char *p_resp)
pH Response handler function
ph_chk_led_state
void ph_chk_led_state(ph_t *ctx, char *p_resp)
Check LED state function.
ph_set_name
void ph_set_name(ph_t *ctx, char *p_dev_name, char *p_resp)
Set name function.
ph_cfg_t::uart_blocking
bool uart_blocking
Definition: ph.h:186
ph_find_dev
void ph_find_dev(ph_t *ctx, char *p_resp)
Find device function.
ph_generic_read
err_t ph_generic_read(ph_t *ctx, char *data_buf, uint16_t max_len)
pH data reading function.
ph_chk_slope
void ph_chk_slope(ph_t *ctx, char *p_resp)
Check slope function.
ph_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ph.h:189
ph_set_temp_comp
void ph_set_temp_comp(ph_t *ctx, float flt_val, char *p_resp)
Set Temperature Compensation function.
ph_clr_log_buf
void ph_clr_log_buf(char *p_str)
Clear log buffer function.
PH_ERROR
@ PH_ERROR
Definition: ph.h:200
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
pH driver buffer size.
Definition: ph.h:135
ph_check_protocol_lock
void ph_check_protocol_lock(ph_t *ctx, char *p_resp)
Check Protocol Lock function.
ph_get_dev_info
void ph_get_dev_info(ph_t *ctx, char *p_resp)
Get Device Information function.
ph_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ph.h:188
ph_get_temp_comp
void ph_get_temp_comp(ph_t *ctx, char *p_resp)
Get Temperature Compensation function.
ph_import_calib
void ph_import_calib(ph_t *ctx, uint8_t *in_calib, char *p_resp)
Import calibration data function.
ph_switch_led
void ph_switch_led(ph_t *ctx, uint8_t state, char *p_resp)
Toggle LED function.
ph_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ph.h:187
ph_chk_cont_read
void ph_chk_cont_read(ph_t *ctx, char *p_resp)
Check Continous read settings function.
ph_factory_rst
void ph_factory_rst(ph_t *ctx, char *p_resp)
Perform Factory Reset function.
ph_check_status
void ph_check_status(ph_t *ctx, char *p_resp)
Check Device Status function.
ph_uart_write
void ph_uart_write(ph_t *ctx, uint8_t input)
UART Write Single Byte function.
ph_t
pH Click context object.
Definition: ph.h:164
PH_OK
@ PH_OK
Definition: ph.h:199
ph_generic_write
err_t ph_generic_write(ph_t *ctx, char *data_buf, uint16_t len)
pH data writing function.
ph_perf_calib
void ph_perf_calib(ph_t *ctx, char *point, float flt_val, char *p_resp)
Perform Calibration function.
ph_cfg_t::baud_rate
uint32_t baud_rate
Definition: ph.h:185
ph_single_read
void ph_single_read(ph_t *ctx, char *p_resp)
Perform single read function.
ph_cfg_setup
void ph_cfg_setup(ph_cfg_t *cfg)
pH configuration object setup function.
ph_sleep
void ph_sleep(ph_t *ctx)
Enter Sleep mode function.
ph_chng_baud_rate
void ph_chng_baud_rate(ph_t *ctx, char *baud_rate, char *p_resp)
Change Baud Rate function.
ph_return_value_t
ph_return_value_t
pH Click return value data.
Definition: ph.h:198
ph_chk_baud_rate
void ph_chk_baud_rate(ph_t *ctx, char *p_resp)
Check Baud Rate applied function.
ph_default_cfg
err_t ph_default_cfg(ph_t *ctx)
pH default configuration function.
ph_show_name
void ph_show_name(ph_t *ctx, char *p_dev_name)
Show Device Name function.
ph_init
err_t ph_init(ph_t *ctx, ph_cfg_t *cfg)
pH initialization function.
ph_cfg_t
pH Click configuration object.
Definition: ph.h:179
ph_uart_read_until
void ph_uart_read_until(ph_t *ctx, char *p_rx_data, char delim)
UART read until delimiter function.
ph_send_cmd
void ph_send_cmd(ph_t *ctx, char *p_cmd)
Send command function.