ezocarrierrtd 2.1.0.0
ezocarrierrtd.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 EZOCARRIERRTD_H
29#define EZOCARRIERRTD_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38#include "drv_uart.h"
39
60#define EZOCARRIERRTD_CMD_BAUD "Baud"
61#define EZOCARRIERRTD_CMD_CONT_READ "C"
62#define EZOCARRIERRTD_CMD_CAL "Cal"
63#define EZOCARRIERRTD_CMD_DATA_LOGGER "D"
64#define EZOCARRIERRTD_CMD_EXPORT "Export"
65#define EZOCARRIERRTD_CMD_FACTORY "Factory"
66#define EZOCARRIERRTD_CMD_FIND "Find"
67#define EZOCARRIERRTD_CMD_DEV_INFO "i"
68#define EZOCARRIERRTD_CMD_I2C "I2C"
69#define EZOCARRIERRTD_CMD_IMPORT "Import"
70#define EZOCARRIERRTD_CMD_LED "L"
71#define EZOCARRIERRTD_CMD_MEM_RECALL "M"
72#define EZOCARRIERRTD_CMD_NAME "Name"
73#define EZOCARRIERRTD_CMD_PROTOCOL_LOCK "Plock"
74#define EZOCARRIERRTD_CMD_SINGLE_READ "R"
75#define EZOCARRIERRTD_CMD_SCALE "S"
76#define EZOCARRIERRTD_CMD_SLEEP "Sleep"
77#define EZOCARRIERRTD_CMD_STATUS "Status"
78#define EZOCARRIERRTD_CMD_RESP_CODES "*OK"
79#define EZOCARRIERRTD_CMD_END_COMMAND "\r"
80
85#define EZOCARRIERRTD_RSP_OK "*OK"
86#define EZOCARRIERRTD_RSP_ERROR "*ER"
87#define EZOCARRIERRTD_RSP_OVER_VOLT "*OV"
88#define EZOCARRIERRTD_RSP_UNDER_VOLT "*UV"
89#define EZOCARRIERRTD_RSP_RESET "*RS"
90#define EZOCARRIERRTD_RSP_READY "*RE"
91#define EZOCARRIERRTD_RSP_SLEEP "*SL"
92#define EZOCARRIERRTD_RSP_WAKE_UP "*WA"
93
99#define EZOCARRIERRTD_TX_DRV_BUFFER_SIZE 100
100#define EZOCARRIERRTD_RX_DRV_BUFFER_SIZE 300
101 // ezocarrierrtd_cmd
103
109#define EZOCARRIERRTD_DEVICE_ADDRESS 0x61
110
125#define EZOCARRIERRTD_MAP_MIKROBUS( cfg, mikrobus ) \
126 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
127 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
128 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
129 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX )
130 // ezocarrierrtd_map // ezocarrierrtd
133
138typedef enum
139{
144
149typedef struct
150{
151 // Modules
152 uart_t uart;
153 i2c_master_t i2c;
155 // Buffers
156 uint8_t uart_rx_buffer[ EZOCARRIERRTD_RX_DRV_BUFFER_SIZE ];
157 uint8_t uart_tx_buffer[ EZOCARRIERRTD_TX_DRV_BUFFER_SIZE ];
164
169typedef struct
170{
171 // Communication gpio pins
172 pin_name_t rx_pin;
173 pin_name_t tx_pin;
174 pin_name_t scl;
175 pin_name_t sda;
177 // Static variable
178 uint32_t baud_rate;
180 uart_data_bits_t data_bit;
181 uart_parity_t parity_bit;
182 uart_stop_bits_t stop_bit;
183 uint32_t i2c_speed;
184 uint8_t i2c_address;
188
193typedef enum
194{
198
200
217
233
248
261err_t ezocarrierrtd_generic_write ( ezocarrierrtd_t *ctx, uint8_t *data_in, uint16_t len );
262
275err_t ezocarrierrtd_generic_read ( ezocarrierrtd_t *ctx, uint8_t *data_out, uint16_t len );
276
286void ezocarrierrtd_send_cmd ( ezocarrierrtd_t *ctx, uint8_t *cmd );
287
298void ezocarrierrtd_send_cmd_with_par ( ezocarrierrtd_t *ctx, uint8_t *cmd, uint8_t *param_buf );
299
310
311#ifdef __cplusplus
312}
313#endif
314#endif // EZOCARRIERRTD_H
315 // ezocarrierrtd
317
318// ------------------------------------------------------------------------ END
ezocarrierrtd_drv_t
EZO Carrier EC Click driver selector.
Definition: ezocarrierrtd.h:139
@ EZOCARRIERRTD_DRV_SEL_UART
Definition: ezocarrierrtd.h:141
@ EZOCARRIERRTD_DRV_SEL_I2C
Definition: ezocarrierrtd.h:140
ezocarrierrtd_return_value_t
EZO Carrier RTD Click return value data.
Definition: ezocarrierrtd.h:194
@ EZOCARRIERRTD_OK
Definition: ezocarrierrtd.h:195
@ EZOCARRIERRTD_ERROR_TIMEOUT
Definition: ezocarrierrtd.h:197
@ EZOCARRIERRTD_ERROR
Definition: ezocarrierrtd.h:196
#define EZOCARRIERRTD_TX_DRV_BUFFER_SIZE
EZO Carrier RTD driver buffer size.
Definition: ezocarrierrtd.h:99
#define EZOCARRIERRTD_RX_DRV_BUFFER_SIZE
Definition: ezocarrierrtd.h:100
void ezocarrierrtd_drv_interface_sel(ezocarrierrtd_cfg_t *cfg, ezocarrierrtd_drv_t drv_sel)
EZO Carrier EC driver interface setup function.
void ezocarrierrtd_cfg_setup(ezocarrierrtd_cfg_t *cfg)
EZO Carrier RTD configuration object setup function.
err_t ezocarrierrtd_generic_read(ezocarrierrtd_t *ctx, uint8_t *data_out, uint16_t len)
EZO Carrier RTD data reading function.
void ezocarrierrtd_send_cmd_check(ezocarrierrtd_t *ctx, uint8_t *cmd)
Check the sent command.
void ezocarrierrtd_send_cmd(ezocarrierrtd_t *ctx, uint8_t *cmd)
Send command function.
err_t ezocarrierrtd_init(ezocarrierrtd_t *ctx, ezocarrierrtd_cfg_t *cfg)
EZO Carrier RTD initialization function.
err_t ezocarrierrtd_generic_write(ezocarrierrtd_t *ctx, uint8_t *data_in, uint16_t len)
EZO Carrier RTD data writing function.
void ezocarrierrtd_send_cmd_with_par(ezocarrierrtd_t *ctx, uint8_t *cmd, uint8_t *param_buf)
Send command function with parameter.
EZO Carrier RTD Click configuration object.
Definition: ezocarrierrtd.h:170
uint32_t baud_rate
Definition: ezocarrierrtd.h:178
uint32_t i2c_speed
Definition: ezocarrierrtd.h:183
ezocarrierrtd_drv_t drv_sel
Definition: ezocarrierrtd.h:185
bool uart_blocking
Definition: ezocarrierrtd.h:179
uart_data_bits_t data_bit
Definition: ezocarrierrtd.h:180
pin_name_t tx_pin
Definition: ezocarrierrtd.h:173
pin_name_t rx_pin
Definition: ezocarrierrtd.h:172
uart_stop_bits_t stop_bit
Definition: ezocarrierrtd.h:182
pin_name_t scl
Definition: ezocarrierrtd.h:174
uart_parity_t parity_bit
Definition: ezocarrierrtd.h:181
pin_name_t sda
Definition: ezocarrierrtd.h:175
uint8_t i2c_address
Definition: ezocarrierrtd.h:184
EZO Carrier RTD Click context object.
Definition: ezocarrierrtd.h:150
ezocarrierrtd_drv_t drv_sel
Definition: ezocarrierrtd.h:161
uart_t uart
Definition: ezocarrierrtd.h:152
i2c_master_t i2c
Definition: ezocarrierrtd.h:153
uint8_t slave_address
Definition: ezocarrierrtd.h:159