This file contains API for EZO Carrier RTD Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_uart.h"

Data Structures
struct	ezocarrierrtd_t
	EZO Carrier RTD Click context object. More...

struct	ezocarrierrtd_cfg_t
	EZO Carrier RTD Click configuration object. More...

Macros
#define	EZOCARRIERRTD_CMD_BAUD "Baud"
	EZO Carrier RTD control commands.

#define	EZOCARRIERRTD_CMD_CONT_READ "C"

#define	EZOCARRIERRTD_CMD_CAL "Cal"

#define	EZOCARRIERRTD_CMD_DATA_LOGGER "D"

#define	EZOCARRIERRTD_CMD_EXPORT "Export"

#define	EZOCARRIERRTD_CMD_FACTORY "Factory"

#define	EZOCARRIERRTD_CMD_FIND "Find"

#define	EZOCARRIERRTD_CMD_DEV_INFO "i"

#define	EZOCARRIERRTD_CMD_I2C "I2C"

#define	EZOCARRIERRTD_CMD_IMPORT "Import"

#define	EZOCARRIERRTD_CMD_LED "L"

#define	EZOCARRIERRTD_CMD_MEM_RECALL "M"

#define	EZOCARRIERRTD_CMD_NAME "Name"

#define	EZOCARRIERRTD_CMD_PROTOCOL_LOCK "Plock"

#define	EZOCARRIERRTD_CMD_SINGLE_READ "R"

#define	EZOCARRIERRTD_CMD_SCALE "S"

#define	EZOCARRIERRTD_CMD_SLEEP "Sleep"

#define	EZOCARRIERRTD_CMD_STATUS "Status"

#define	EZOCARRIERRTD_CMD_RESP_CODES "*OK"

#define	EZOCARRIERRTD_CMD_END_COMMAND "\r"

#define	EZOCARRIERRTD_RSP_OK "*OK"
	EZO Carrier RTD response codes.

#define	EZOCARRIERRTD_RSP_ERROR "*ER"

#define	EZOCARRIERRTD_RSP_OVER_VOLT "*OV"

#define	EZOCARRIERRTD_RSP_UNDER_VOLT "*UV"

#define	EZOCARRIERRTD_RSP_RESET "*RS"

#define	EZOCARRIERRTD_RSP_READY "*RE"

#define	EZOCARRIERRTD_RSP_SLEEP "*SL"

#define	EZOCARRIERRTD_RSP_WAKE_UP "*WA"

#define	EZOCARRIERRTD_TX_DRV_BUFFER_SIZE 100
	EZO Carrier RTD driver buffer size.

#define	EZOCARRIERRTD_RX_DRV_BUFFER_SIZE 300

#define	EZOCARRIERRTD_DEVICE_ADDRESS 0x61
	EZO Carrier RTD device address setting.

#define	EZOCARRIERRTD_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	ezocarrierrtd_drv_t { EZOCARRIERRTD_DRV_SEL_I2C , EZOCARRIERRTD_DRV_SEL_UART }
	EZO Carrier EC Click driver selector. More...

enum	ezocarrierrtd_return_value_t { EZOCARRIERRTD_OK = 0 , EZOCARRIERRTD_ERROR = -1 , EZOCARRIERRTD_ERROR_TIMEOUT = -2 }
	EZO Carrier RTD Click return value data. More...

Functions
void	ezocarrierrtd_cfg_setup (ezocarrierrtd_cfg_t *cfg)
	EZO Carrier RTD configuration object setup function.

void	ezocarrierrtd_drv_interface_sel (ezocarrierrtd_cfg_t *cfg, ezocarrierrtd_drv_t drv_sel)
	EZO Carrier EC driver interface setup 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.

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 (ezocarrierrtd_t ctx, uint8_t cmd)
	Send command function.

void	ezocarrierrtd_send_cmd_with_par (ezocarrierrtd_t ctx, uint8_t cmd, uint8_t *param_buf)
	Send command function with parameter.

void	ezocarrierrtd_send_cmd_check (ezocarrierrtd_t ctx, uint8_t cmd)
	Check the sent command.

Detailed Description

This file contains API for EZO Carrier RTD Click Driver.

Enumeration Type Documentation

EZO Carrier EC Click driver selector.

Selects target driver interface of EZO Carrier EC Click driver.

Enumerator
EZOCARRIERRTD_DRV_SEL_I2C	I2C driver descriptor.
EZOCARRIERRTD_DRV_SEL_UART	UART driver descriptor.

EZO Carrier RTD Click return value data.

Predefined enum values for driver return values.

Enumerator
EZOCARRIERRTD_OK
EZOCARRIERRTD_ERROR
EZOCARRIERRTD_ERROR_TIMEOUT