ezocarrierph 2.1.0.0
ezocarrierph.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 EZOCARRIERPH_H
29#define EZOCARRIERPH_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "mikrosdk_version.h"
36
37#ifdef __GNUC__
38#if mikroSDK_GET_VERSION < 20800ul
39#include "rcu_delays.h"
40#else
41#include "delays.h"
42#endif
43#endif
44
45#include "drv_digital_out.h"
46#include "drv_digital_in.h"
47#include "drv_i2c_master.h"
48#include "drv_uart.h"
49
70#define EZOCARRIERPH_CMD_BAUD "Baud"
71#define EZOCARRIERPH_CMD_CONT_READ "C"
72#define EZOCARRIERPH_CMD_CAL "Cal"
73#define EZOCARRIERPH_CMD_EXPORT "Export"
74#define EZOCARRIERPH_CMD_FACTORY "Factory"
75#define EZOCARRIERPH_CMD_FIND "Find"
76#define EZOCARRIERPH_CMD_DEV_INFO "i"
77#define EZOCARRIERPH_CMD_I2C "I2C"
78#define EZOCARRIERPH_CMD_IMPORT "Import"
79#define EZOCARRIERPH_CMD_LED "L"
80#define EZOCARRIERPH_CMD_NAME "Name"
81#define EZOCARRIERPH_CMD_EXTENDED_PH "pHext"
82#define EZOCARRIERPH_CMD_PROTOCOL_LOCK "Plock"
83#define EZOCARRIERPH_CMD_SINGLE_READ "R"
84#define EZOCARRIERPH_CMD_SLEEP "Sleep"
85#define EZOCARRIERPH_CMD_SLOPE "Slope"
86#define EZOCARRIERPH_CMD_STATUS "Status"
87#define EZOCARRIERPH_CMD_TEMP_COMPENSATION "T"
88#define EZOCARRIERPH_CMD_RESP_CODES "*OK"
89#define EZOCARRIERPH_CMD_END_COMMAND "\r"
90
95#define EZOCARRIERPH_RSP_OK "*OK"
96#define EZOCARRIERPH_RSP_ERROR "*ER"
97#define EZOCARRIERPH_RSP_OVER_VOLT "*OV"
98#define EZOCARRIERPH_RSP_UNDER_VOLT "*UV"
99#define EZOCARRIERPH_RSP_RESET "*RS"
100#define EZOCARRIERPH_RSP_READY "*RE"
101#define EZOCARRIERPH_RSP_SLEEP "*SL"
102#define EZOCARRIERPH_RSP_WAKE_UP "*WA"
103
109#define EZOCARRIERPH_TX_DRV_BUFFER_SIZE 100
110#define EZOCARRIERPH_RX_DRV_BUFFER_SIZE 300
111 // ezocarrierph_cmd
113
119#define EZOCARRIERPH_DEVICE_ADDRESS 0x61
120
135#define EZOCARRIERPH_MAP_MIKROBUS( cfg, mikrobus ) \
136 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
137 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
138 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
139 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX );
140 // ezocarrierph_map // ezocarrierph
143
148typedef enum
149{
154
159typedef struct
160{
161 // Modules
162 uart_t uart;
163 i2c_master_t i2c;
165 // Buffers
166 uint8_t uart_rx_buffer[ EZOCARRIERPH_RX_DRV_BUFFER_SIZE ];
167 uint8_t uart_tx_buffer[ EZOCARRIERPH_TX_DRV_BUFFER_SIZE ];
174
179typedef struct
180{
181 // Communication gpio pins
182 pin_name_t rx_pin;
183 pin_name_t tx_pin;
184 pin_name_t scl;
185 pin_name_t sda;
187 // Static variable
188 uint32_t baud_rate;
190 uart_data_bits_t data_bit;
191 uart_parity_t parity_bit;
192 uart_stop_bits_t stop_bit;
193 uint32_t i2c_speed;
194 uint8_t i2c_address;
198
203typedef enum
204{
208
210
227
243
258
271err_t ezocarrierph_generic_write ( ezocarrierph_t *ctx, uint8_t *data_in, uint16_t len );
272
285err_t ezocarrierph_generic_read ( ezocarrierph_t *ctx, uint8_t *data_out, uint16_t len );
286
287
297void ezocarrierph_send_cmd ( ezocarrierph_t *ctx, uint8_t *cmd );
298
309void ezocarrierph_send_cmd_with_par ( ezocarrierph_t *ctx, uint8_t *cmd, uint8_t *param_buf );
310
320void ezocarrierph_send_cmd_check ( ezocarrierph_t *ctx, uint8_t *cmd );
321
322#ifdef __cplusplus
323}
324#endif
325#endif // EZOCARRIERPH_H
326 // ezocarrierph
328
329// ------------------------------------------------------------------------ END
ezocarrierph_drv_t
EZO Carrier pH Click driver selector.
Definition: ezocarrierph.h:149
@ EZOCARRIERPH_DRV_SEL_UART
Definition: ezocarrierph.h:151
@ EZOCARRIERPH_DRV_SEL_I2C
Definition: ezocarrierph.h:150
ezocarrierph_return_value_t
EZO Carrier pH Click return value data.
Definition: ezocarrierph.h:204
@ EZOCARRIERPH_ERROR_TIMEOUT
Definition: ezocarrierph.h:207
@ EZOCARRIERPH_OK
Definition: ezocarrierph.h:205
@ EZOCARRIERPH_ERROR
Definition: ezocarrierph.h:206
#define EZOCARRIERPH_TX_DRV_BUFFER_SIZE
EZO Carrier pH driver buffer size.
Definition: ezocarrierph.h:109
#define EZOCARRIERPH_RX_DRV_BUFFER_SIZE
Definition: ezocarrierph.h:110
void ezocarrierph_send_cmd(ezocarrierph_t *ctx, uint8_t *cmd)
Send command function.
err_t ezocarrierph_generic_write(ezocarrierph_t *ctx, uint8_t *data_in, uint16_t len)
EZO Carrier pH data writing function.
err_t ezocarrierph_generic_read(ezocarrierph_t *ctx, uint8_t *data_out, uint16_t len)
EZO Carrier pH data reading function.
err_t ezocarrierph_init(ezocarrierph_t *ctx, ezocarrierph_cfg_t *cfg)
EZO Carrier pH initialization function.
void ezocarrierph_cfg_setup(ezocarrierph_cfg_t *cfg)
EZO Carrier pH configuration object setup function.
void ezocarrierph_drv_interface_sel(ezocarrierph_cfg_t *cfg, ezocarrierph_drv_t drv_sel)
EZO Carrier pH driver interface setup function.
void ezocarrierph_send_cmd_check(ezocarrierph_t *ctx, uint8_t *cmd)
Check the sent command.
void ezocarrierph_send_cmd_with_par(ezocarrierph_t *ctx, uint8_t *cmd, uint8_t *param_buf)
Send command function with parameter.
EZO Carrier pH Click configuration object.
Definition: ezocarrierph.h:180
uint32_t baud_rate
Definition: ezocarrierph.h:188
uint32_t i2c_speed
Definition: ezocarrierph.h:193
bool uart_blocking
Definition: ezocarrierph.h:189
uart_data_bits_t data_bit
Definition: ezocarrierph.h:190
pin_name_t tx_pin
Definition: ezocarrierph.h:183
pin_name_t rx_pin
Definition: ezocarrierph.h:182
uart_stop_bits_t stop_bit
Definition: ezocarrierph.h:192
pin_name_t scl
Definition: ezocarrierph.h:184
ezocarrierph_drv_t drv_sel
Definition: ezocarrierph.h:195
uart_parity_t parity_bit
Definition: ezocarrierph.h:191
pin_name_t sda
Definition: ezocarrierph.h:185
uint8_t i2c_address
Definition: ezocarrierph.h:194
EZO Carrier pH Click context object.
Definition: ezocarrierph.h:160
uart_t uart
Definition: ezocarrierph.h:162
i2c_master_t i2c
Definition: ezocarrierph.h:163
uint8_t slave_address
Definition: ezocarrierph.h:169
ezocarrierph_drv_t drv_sel
Definition: ezocarrierph.h:171