ir.h File Reference

This file contains API for IR Click Driver. More...

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

Go to the source code of this file.

Data Structures
struct	ir_t
	IR Click context object. More...
struct	ir_cfg_t
	IR Click configuration object. More...

Macros
#define	IR_STATE_HIGH   0x01
	IR control commands.
#define	IR_STATE_LOW   0x00
#define	DRV_BUFFER_SIZE   200
	IR driver buffer size.
#define	IR_DEF_FREQ   38000
	IR default PWM frequency.
#define	IR_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	ir_drv_t { IR_DRV_SEL_GPIO , IR_DRV_SEL_UART }
	IR Click driver selector. More...
enum	ir_return_value_t { IR_OK = 0 , IR_ERROR = -1 }
	IR Click return value data. More...

Functions
void	ir_cfg_setup (ir_cfg_t *cfg)
	IR configuration object setup function.
void	ir_drv_interface_selection (ir_cfg_t *cfg, ir_drv_t drv_sel)
	IR driver interface setup function.
err_t	ir_init (ir_t *ctx, ir_cfg_t *cfg)
	IR initialization function.
err_t	ir_generic_write (ir_t *ctx, char *data_buf, uint16_t len)
	IR data writing function.
err_t	ir_generic_read (ir_t *ctx, char *data_buf, uint16_t max_len)
	IR data reading function.
uint8_t	ir_get_an_state (ir_t *ctx)
	IR get AN pin state function.
void	ir_nec_send_command (ir_t *ctx, uint8_t address, uint8_t command)
	IR NEC send data function.
err_t	ir_nec_read_command (ir_t *ctx, uint8_t *address, uint8_t *command)
	IR NEC data reading function.

Detailed Description

This file contains API for IR Click Driver.

Enumeration Type Documentation

ir_drv_t

enum ir_drv_t

IR Click driver selector.

Selects target driver interface of IR Click driver.

Enumerator
IR_DRV_SEL_GPIO	GPIO driver descriptor.
IR_DRV_SEL_UART	UART driver descriptor.

ir_return_value_t

enum ir_return_value_t

IR Click return value data.

Predefined enum values for driver return values.

Enumerator
IR_OK
IR_ERROR