uart1wire.h File Reference

This file contains API for UART 1-Wire Click driver. More...

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

Go to the source code of this file.

Data Structures
struct	uart1wire_t
	Click ctx object definition. More...
struct	uart1wire_cfg_t
	Click configuration structure definition. More...

Macros
#define	UART1WIRE_MAP_MIKROBUS(cfg, mikrobus)
#define	UART1WIRE_RETVAL   uint8_t
#define	UART1WIRE_OK   0
#define	UART1WIRE_ERROR   -1
#define	UART1WIRE_COMMAND_MODE   0xE3
#define	UART1WIRE_DATA_MODE   0xE1
#define	UART1WIRE_RESET   0xC1
#define	UART1WIRE_SKIP_ROM   0xCC
#define	UART1WIRE_CONVERT_TEMPERATURE   0x44
#define	UART1WIRE_READ_SCRATCHPAD   0xBE
#define	UART1WIRE_READ_SEQ   0xFF
#define	UART1WIRE_TEMP_SENSOR_RESOLUTION_12BIT   12
#define	UART1WIRE_TEMP_SENSOR_RESOLUTION_11BIT   11
#define	UART1WIRE_TEMP_SENSOR_RESOLUTION_10BIT   10
#define	UART1WIRE_TEMP_SENSOR_RESOLUTION_9BIT   9
#define	DRV_RX_BUFFER_SIZE   300
#define	DRV_TX_BUFFER_SIZE   100

Typedefs
typedef uint8_t	uart1wire_error_t
	Error type.

Functions
void	uart1wire_cfg_setup (uart1wire_cfg_t *cfg)
	Config Object Initialization function.
UART1WIRE_RETVAL	uart1wire_init (uart1wire_t *ctx, uart1wire_cfg_t *cfg)
	Initialization function.
void	uart1wire_generic_write (uart1wire_t *ctx, char *data_buf, uint16_t len)
	Generic write function.
int32_t	uart1wire_generic_read (uart1wire_t *ctx, char *data_buf, uint16_t max_len)
	Generic read function.
void	uart1wire_write_command (uart1wire_t *ctx, uint8_t cmd)
	Write command function.
uint8_t	uart1wire_read_byte (uart1wire_t *ctx)
	Read byte function.
void	uart1wire_reset (uart1wire_t *ctx)
	Reset function.
int8_t	uart1wire_read_data (uart1wire_t *ctx, uint8_t *data_out, uint8_t num_bytes)
	Read data function.
int8_t	uart1wire_read_temperature (uart1wire_t *ctx, float *temperature, uint8_t resolution)
	Read temperature function.

Detailed Description

This file contains API for UART 1-Wire Click driver.