Go to the documentation of this file.
28 #ifndef EZOCARRIERPH_H
29 #define EZOCARRIERPH_H
35 #include "mikrosdk_version.h"
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
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"
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"
109 #define EZOCARRIERPH_TX_DRV_BUFFER_SIZE 100
110 #define EZOCARRIERPH_RX_DRV_BUFFER_SIZE 300
119 #define EZOCARRIERPH_DEVICE_ADDRESS 0x61
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 );
325 #endif // EZOCARRIERPH_H
pin_name_t rx_pin
Definition: ezocarrierph.h:182
EZO Carrier pH Click configuration object.
Definition: ezocarrierph.h:180
#define EZOCARRIERPH_TX_DRV_BUFFER_SIZE
EZO Carrier pH driver buffer size.
Definition: ezocarrierph.h:109
ezocarrierph_drv_t
EZO Carrier pH Click driver selector.
Definition: ezocarrierph.h:149
@ EZOCARRIERPH_OK
Definition: ezocarrierph.h:205
void ezocarrierph_send_cmd_with_par(ezocarrierph_t *ctx, uint8_t *cmd, uint8_t *param_buf)
Send command function with parameter.
err_t ezocarrierph_init(ezocarrierph_t *ctx, ezocarrierph_cfg_t *cfg)
EZO Carrier pH initialization function.
uint32_t baud_rate
Definition: ezocarrierph.h:188
@ EZOCARRIERPH_DRV_SEL_I2C
Definition: ezocarrierph.h:150
bool uart_blocking
Definition: ezocarrierph.h:189
void ezocarrierph_drv_interface_sel(ezocarrierph_cfg_t *cfg, ezocarrierph_drv_t drv_sel)
EZO Carrier pH driver interface setup function.
i2c_master_t i2c
Definition: ezocarrierph.h:163
pin_name_t sda
Definition: ezocarrierph.h:185
void ezocarrierph_send_cmd(ezocarrierph_t *ctx, uint8_t *cmd)
Send command function.
uint32_t i2c_speed
Definition: ezocarrierph.h:193
uint8_t slave_address
Definition: ezocarrierph.h:169
pin_name_t scl
Definition: ezocarrierph.h:184
void ezocarrierph_send_cmd_check(ezocarrierph_t *ctx, uint8_t *cmd)
Check the sent command.
@ EZOCARRIERPH_DRV_SEL_UART
Definition: ezocarrierph.h:151
#define EZOCARRIERPH_RX_DRV_BUFFER_SIZE
Definition: ezocarrierph.h:110
err_t ezocarrierph_generic_read(ezocarrierph_t *ctx, uint8_t *data_out, uint16_t len)
EZO Carrier pH data reading function.
pin_name_t tx_pin
Definition: ezocarrierph.h:183
err_t ezocarrierph_generic_write(ezocarrierph_t *ctx, uint8_t *data_in, uint16_t len)
EZO Carrier pH data writing function.
ezocarrierph_return_value_t
EZO Carrier pH Click return value data.
Definition: ezocarrierph.h:204
ezocarrierph_drv_t drv_sel
Definition: ezocarrierph.h:171
void ezocarrierph_cfg_setup(ezocarrierph_cfg_t *cfg)
EZO Carrier pH configuration object setup function.
@ EZOCARRIERPH_ERROR_TIMEOUT
Definition: ezocarrierph.h:207
ezocarrierph_drv_t drv_sel
Definition: ezocarrierph.h:195
uart_stop_bits_t stop_bit
Definition: ezocarrierph.h:192
uint8_t i2c_address
Definition: ezocarrierph.h:194
uart_t uart
Definition: ezocarrierph.h:162
@ EZOCARRIERPH_ERROR
Definition: ezocarrierph.h:206
uart_parity_t parity_bit
Definition: ezocarrierph.h:191
uart_data_bits_t data_bit
Definition: ezocarrierph.h:190
EZO Carrier pH Click context object.
Definition: ezocarrierph.h:160