ezocarrierec 2.1.0.0
ezocarrierec.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 EZOCARRIEREC_H
29#define EZOCARRIEREC_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 EZOCARRIEREC_CMD_BAUD "Baud"
71#define EZOCARRIEREC_CMD_CONT_READ "C"
72#define EZOCARRIEREC_CMD_CAL "Cal"
73#define EZOCARRIEREC_CMD_EXPORT "Export"
74#define EZOCARRIEREC_CMD_FACTORY "Factory"
75#define EZOCARRIEREC_CMD_FIND "Find"
76#define EZOCARRIEREC_CMD_DEV_INFO "i"
77#define EZOCARRIEREC_CMD_I2C "I2C"
78#define EZOCARRIEREC_CMD_IMPORT "Import"
79#define EZOCARRIEREC_CMD_SET_PROBE_TYPE "K"
80#define EZOCARRIEREC_CMD_LED "L"
81#define EZOCARRIEREC_CMD_NAME "Name"
82#define EZOCARRIEREC_CMD_PARAMETERS "O"
83#define EZOCARRIEREC_CMD_PROTOCOL_LOCK "Plock"
84#define EZOCARRIEREC_CMD_SINGLE_READ "R"
85#define EZOCARRIEREC_CMD_SLEEP "Sleep"
86#define EZOCARRIEREC_CMD_STATUS "Status"
87#define EZOCARRIEREC_CMD_TEMP_COMPENSATION "T"
88#define EZOCARRIEREC_CMD_TDS "TDS"
89#define EZOCARRIEREC_CMD_RESP_CODES "*OK"
90#define EZOCARRIEREC_CMD_END_COMMAND "\r"
91
96#define EZOCARRIEREC_RSP_OK "*OK"
97#define EZOCARRIEREC_RSP_ERROR "*ER"
98#define EZOCARRIEREC_RSP_OVER_VOLT "*OV"
99#define EZOCARRIEREC_RSP_UNDER_VOLT "*UV"
100#define EZOCARRIEREC_RSP_RESET "*RS"
101#define EZOCARRIEREC_RSP_READY "*RE"
102#define EZOCARRIEREC_RSP_SLEEP "*SL"
103#define EZOCARRIEREC_RSP_WAKE_UP "*WA"
104
110#define EZOCARRIEREC_TX_DRV_BUFFER_SIZE 100
111#define EZOCARRIEREC_RX_DRV_BUFFER_SIZE 300
112 // ezocarrierec_cmd
114
120#define EZOCARRIEREC_DEVICE_ADDRESS 0x61
121
136#define EZOCARRIEREC_MAP_MIKROBUS( cfg, mikrobus ) \
137 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
138 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
139 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
140 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX )
141 // ezocarrierec_map // ezocarrierec
144
149typedef enum
150{
155
160typedef struct
161{
162 // Modules
163 uart_t uart;
164 i2c_master_t i2c;
166 // Buffers
167 uint8_t uart_rx_buffer[ EZOCARRIEREC_RX_DRV_BUFFER_SIZE ];
168 uint8_t uart_tx_buffer[ EZOCARRIEREC_TX_DRV_BUFFER_SIZE ];
175
180typedef struct
181{
182 // Communication gpio pins
183 pin_name_t rx_pin;
184 pin_name_t tx_pin;
185 pin_name_t scl;
186 pin_name_t sda;
188 // Static variable
189 uint32_t baud_rate;
191 uart_data_bits_t data_bit;
192 uart_parity_t parity_bit;
193 uart_stop_bits_t stop_bit;
194 uint32_t i2c_speed;
195 uint8_t i2c_address;
199
204typedef enum
205{
209
211
228
244
259
272err_t ezocarrierec_generic_write ( ezocarrierec_t *ctx, uint8_t *data_in, uint16_t len );
273
286err_t ezocarrierec_generic_read ( ezocarrierec_t *ctx, uint8_t *data_out, uint16_t len );
287
297void ezocarrierec_send_cmd ( ezocarrierec_t *ctx, uint8_t *cmd );
298
309void ezocarrierec_send_cmd_with_par ( ezocarrierec_t *ctx, uint8_t *cmd, uint8_t *param_buf );
310
320void ezocarrierec_send_cmd_check ( ezocarrierec_t *ctx, uint8_t *cmd );
321
322#ifdef __cplusplus
323}
324#endif
325#endif // EZOCARRIEREC_H
326 // ezocarrierec
328
329// ------------------------------------------------------------------------ END
ezocarrierec_return_value_t
EZO Carrier EC Click return value data.
Definition: ezocarrierec.h:205
@ EZOCARRIEREC_ERROR_TIMEOUT
Definition: ezocarrierec.h:208
@ EZOCARRIEREC_ERROR
Definition: ezocarrierec.h:207
@ EZOCARRIEREC_OK
Definition: ezocarrierec.h:206
ezocarrierec_drv_t
EZO Carrier EC Click driver selector.
Definition: ezocarrierec.h:150
@ EZOCARRIEREC_DRV_SEL_I2C
Definition: ezocarrierec.h:151
@ EZOCARRIEREC_DRV_SEL_UART
Definition: ezocarrierec.h:152
void ezocarrierec_send_cmd(ezocarrierec_t *ctx, uint8_t *cmd)
Send command function.
void ezocarrierec_cfg_setup(ezocarrierec_cfg_t *cfg)
EZO Carrier EC configuration object setup function.
err_t ezocarrierec_init(ezocarrierec_t *ctx, ezocarrierec_cfg_t *cfg)
EZO Carrier EC initialization function.
void ezocarrierec_send_cmd_with_par(ezocarrierec_t *ctx, uint8_t *cmd, uint8_t *param_buf)
Send command function with parameter.
void ezocarrierec_send_cmd_check(ezocarrierec_t *ctx, uint8_t *cmd)
Check the sent command.
err_t ezocarrierec_generic_write(ezocarrierec_t *ctx, uint8_t *data_in, uint16_t len)
EZO Carrier EC data writing function.
err_t ezocarrierec_generic_read(ezocarrierec_t *ctx, uint8_t *data_out, uint16_t len)
EZO Carrier EC data reading function.
void ezocarrierec_drv_interface_sel(ezocarrierec_cfg_t *cfg, ezocarrierec_drv_t drv_sel)
EZO Carrier EC driver interface setup function.
EZO Carrier EC Click configuration object.
Definition: ezocarrierec.h:181
uint32_t baud_rate
Definition: ezocarrierec.h:189
uint32_t i2c_speed
Definition: ezocarrierec.h:194
bool uart_blocking
Definition: ezocarrierec.h:190
uart_data_bits_t data_bit
Definition: ezocarrierec.h:191
pin_name_t tx_pin
Definition: ezocarrierec.h:184
pin_name_t rx_pin
Definition: ezocarrierec.h:183
uart_stop_bits_t stop_bit
Definition: ezocarrierec.h:193
pin_name_t scl
Definition: ezocarrierec.h:185
ezocarrierec_drv_t drv_sel
Definition: ezocarrierec.h:196
uart_parity_t parity_bit
Definition: ezocarrierec.h:192
pin_name_t sda
Definition: ezocarrierec.h:186
uint8_t i2c_address
Definition: ezocarrierec.h:195
EZO Carrier EC Click context object.
Definition: ezocarrierec.h:161
uart_t uart
Definition: ezocarrierec.h:163
i2c_master_t i2c
Definition: ezocarrierec.h:164
uint8_t slave_address
Definition: ezocarrierec.h:170
ezocarrierec_drv_t drv_sel
Definition: ezocarrierec.h:172