ezocarrierdo 2.1.0.0
ezocarrierdo.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 EZOCARRIERDO_H
29#define EZOCARRIERDO_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 EZOCARRIERDO_CMD_BAUD "Baud"
71#define EZOCARRIERDO_CMD_CONT_READ "C"
72#define EZOCARRIERDO_CMD_CAL "Cal"
73#define EZOCARRIERDO_CMD_EXPORT "Export"
74#define EZOCARRIERDO_CMD_FACTORY "Factory"
75#define EZOCARRIERDO_CMD_FIND "Find"
76#define EZOCARRIERDO_CMD_DEV_INFO "i"
77#define EZOCARRIERDO_CMD_I2C "I2C"
78#define EZOCARRIERDO_CMD_IMPORT "Import"
79#define EZOCARRIERDO_CMD_LED "L"
80#define EZOCARRIERDO_CMD_NAME "Name"
81#define EZOCARRIERDO_CMD_PARAMETERS "O"
82#define EZOCARRIERDO_CMD_PRES_COMPENSATION "P"
83#define EZOCARRIERDO_CMD_PROTOCOL_LOCK "Plock"
84#define EZOCARRIERDO_CMD_SINGLE_READ "R"
85#define EZOCARRIERDO_CMD_SALINITY_COMPENSATION "S"
86#define EZOCARRIERDO_CMD_SLEEP "Sleep"
87#define EZOCARRIERDO_CMD_STATUS "Status"
88#define EZOCARRIERDO_CMD_TEMP_COMPENSATION "T"
89#define EZOCARRIERDO_CMD_RESP_CODES "*OK"
90#define EZOCARRIERDO_CMD_END_COMMAND "\r"
91
96#define EZOCARRIERDO_RSP_OK "*OK"
97#define EZOCARRIERDO_RSP_ERROR "*ER"
98#define EZOCARRIERDO_RSP_OVER_VOLT "*OV"
99#define EZOCARRIERDO_RSP_UNDER_VOLT "*UV"
100#define EZOCARRIERDO_RSP_RESET "*RS"
101#define EZOCARRIERDO_RSP_READY "*RE"
102#define EZOCARRIERDO_RSP_SLEEP "*SL"
103#define EZOCARRIERDO_RSP_WAKE_UP "*WA"
104
110#define EZOCARRIERDO_TX_DRV_BUFFER_SIZE 100
111#define EZOCARRIERDO_RX_DRV_BUFFER_SIZE 300
112 // ezocarrierdo_cmd
114
120#define EZOCARRIERDO_DEVICE_ADDRESS 0x61
121
136#define EZOCARRIERDO_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 // ezocarrierdo_map // ezocarrierdo
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[ EZOCARRIERDO_RX_DRV_BUFFER_SIZE ];
168 uint8_t uart_tx_buffer[ EZOCARRIERDO_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 ezocarrierdo_generic_write ( ezocarrierdo_t *ctx, uint8_t *data_in, uint16_t len );
273
286err_t ezocarrierdo_generic_read ( ezocarrierdo_t *ctx, uint8_t *data_out, uint16_t len );
287
297void ezocarrierdo_send_cmd ( ezocarrierdo_t *ctx, uint8_t *cmd );
298
309void ezocarrierdo_send_cmd_with_par ( ezocarrierdo_t *ctx, uint8_t *cmd, uint8_t *param_buf );
310
320void ezocarrierdo_send_cmd_check ( ezocarrierdo_t *ctx, uint8_t *cmd );
321
322#ifdef __cplusplus
323}
324#endif
325#endif // EZOCARRIERDO_H
326 // ezocarrierdo
328
329// ------------------------------------------------------------------------ END
ezocarrierdo_return_value_t
EZO Carrier DO Click return value data.
Definition: ezocarrierdo.h:205
@ EZOCARRIERDO_ERROR
Definition: ezocarrierdo.h:207
@ EZOCARRIERDO_ERROR_TIMEOUT
Definition: ezocarrierdo.h:208
@ EZOCARRIERDO_OK
Definition: ezocarrierdo.h:206
ezocarrierdo_drv_t
EZO Carrier DO Click driver selector.
Definition: ezocarrierdo.h:150
@ EZOCARRIERDO_DRV_SEL_UART
Definition: ezocarrierdo.h:152
@ EZOCARRIERDO_DRV_SEL_I2C
Definition: ezocarrierdo.h:151
#define EZOCARRIERDO_RX_DRV_BUFFER_SIZE
Definition: ezocarrierdo.h:111
#define EZOCARRIERDO_TX_DRV_BUFFER_SIZE
EZO Carrier DO driver buffer size.
Definition: ezocarrierdo.h:110
void ezocarrierdo_send_cmd(ezocarrierdo_t *ctx, uint8_t *cmd)
Send command function.
err_t ezocarrierdo_generic_read(ezocarrierdo_t *ctx, uint8_t *data_out, uint16_t len)
EZO Carrier DO data reading function.
err_t ezocarrierdo_generic_write(ezocarrierdo_t *ctx, uint8_t *data_in, uint16_t len)
EZO Carrier DO data writing function.
void ezocarrierdo_send_cmd_check(ezocarrierdo_t *ctx, uint8_t *cmd)
Check the sent command.
void ezocarrierdo_send_cmd_with_par(ezocarrierdo_t *ctx, uint8_t *cmd, uint8_t *param_buf)
Send command function with parameter.
err_t ezocarrierdo_init(ezocarrierdo_t *ctx, ezocarrierdo_cfg_t *cfg)
EZO Carrier DO initialization function.
void ezocarrierdo_cfg_setup(ezocarrierdo_cfg_t *cfg)
EZO Carrier DO configuration object setup function.
void ezocarrierdo_drv_interface_sel(ezocarrierdo_cfg_t *cfg, ezocarrierdo_drv_t drv_sel)
EZO Carrier DO driver interface setup function.
EZO Carrier DO Click configuration object.
Definition: ezocarrierdo.h:181
ezocarrierdo_drv_t drv_sel
Definition: ezocarrierdo.h:196
uint32_t baud_rate
Definition: ezocarrierdo.h:189
uint32_t i2c_speed
Definition: ezocarrierdo.h:194
bool uart_blocking
Definition: ezocarrierdo.h:190
uart_data_bits_t data_bit
Definition: ezocarrierdo.h:191
pin_name_t tx_pin
Definition: ezocarrierdo.h:184
pin_name_t rx_pin
Definition: ezocarrierdo.h:183
uart_stop_bits_t stop_bit
Definition: ezocarrierdo.h:193
pin_name_t scl
Definition: ezocarrierdo.h:185
uart_parity_t parity_bit
Definition: ezocarrierdo.h:192
pin_name_t sda
Definition: ezocarrierdo.h:186
uint8_t i2c_address
Definition: ezocarrierdo.h:195
EZO Carrier DO Click context object.
Definition: ezocarrierdo.h:161
ezocarrierdo_drv_t drv_sel
Definition: ezocarrierdo.h:172
uart_t uart
Definition: ezocarrierdo.h:163
i2c_master_t i2c
Definition: ezocarrierdo.h:164
uint8_t slave_address
Definition: ezocarrierdo.h:170