ir_remote basic driver function

ir_remote basic driver modules More...

Collaboration diagram for ir_remote basic driver function:

Data Structures
struct	ir_remote_s
	ir_remote structure definition More...
struct	ir_remote_time_s
	ir_remote time structure definition More...
struct	ir_remote_decode_s
	ir_remote decode structure definition More...
struct	ir_remote_handle_s
	ir_remote handle structure definition More...
struct	ir_remote_info_s
	ir_remote information structure definition More...

Macros
#define	IR_REMOTE_MAX_RANGE   0.20f
	ir_remote max range definition

Typedefs
typedef struct ir_remote_s	ir_remote_t
	ir_remote structure definition
typedef struct ir_remote_time_s	ir_remote_time_t
	ir_remote time structure definition
typedef struct ir_remote_decode_s	ir_remote_decode_t
	ir_remote decode structure definition
typedef struct ir_remote_handle_s	ir_remote_handle_t
	ir_remote handle structure definition
typedef struct ir_remote_info_s	ir_remote_info_t
	ir_remote information structure definition

Enumerations
enum	ir_remote_status_t {   IR_REMOTE_STATUS_OK = 0x00 , IR_REMOTE_STATUS_REPEAT = 0x01 , IR_REMOTE_STATUS_ADDR_ERR = 0x02 , IR_REMOTE_STATUS_CMD_ERR = 0x03 ,   IR_REMOTE_STATUS_FRAME_INVALID = 0x04 }
	ir_remote status enumeration definition More...

Functions
uint8_t	ir_remote_info (ir_remote_info_t *info)
	get chip's information
uint8_t	ir_remote_irq_handler (ir_remote_handle_t *handle)
	irq handler
uint8_t	ir_remote_init (ir_remote_handle_t *handle)
	initialize the chip
uint8_t	ir_remote_deinit (ir_remote_handle_t *handle)
	close the chip

Detailed Description

ir_remote basic driver modules

Macro Definition Documentation

IR_REMOTE_MAX_RANGE

#define IR_REMOTE_MAX_RANGE   0.20f

ir_remote max range definition

20%

Definition at line 63 of file driver_ir_remote.h.

Typedef Documentation

ir_remote_decode_t

typedef struct ir_remote_decode_s ir_remote_decode_t

ir_remote decode structure definition

ir_remote_handle_t

typedef struct ir_remote_handle_s ir_remote_handle_t

ir_remote handle structure definition

ir_remote_info_t

typedef struct ir_remote_info_s ir_remote_info_t

ir_remote information structure definition

ir_remote_t

typedef struct ir_remote_s ir_remote_t

ir_remote structure definition

ir_remote_time_t

typedef struct ir_remote_time_s ir_remote_time_t

ir_remote time structure definition

Enumeration Type Documentation

ir_remote_status_t

enum ir_remote_status_t

ir_remote status enumeration definition

Enumerator
IR_REMOTE_STATUS_OK	ok
IR_REMOTE_STATUS_REPEAT	repeat
IR_REMOTE_STATUS_ADDR_ERR	addr error
IR_REMOTE_STATUS_CMD_ERR	cmd error
IR_REMOTE_STATUS_FRAME_INVALID	frame invalid

Definition at line 69 of file driver_ir_remote.h.

Function Documentation

ir_remote_deinit()

uint8_t ir_remote_deinit

(

ir_remote_handle_t *

handle

)

close the chip

Parameters

[in]

*handle

pointer to an ir_remote handle structure

Returns

status code

• 0 success
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 587 of file driver_ir_remote.c.

ir_remote_info()

uint8_t ir_remote_info

(

ir_remote_info_t *

info

)

get chip's information

Parameters

[out]

*info

pointer to an ir_remote info structure

Returns

status code

• 0 success
• 2 handle is NULL

Note

none

Definition at line 611 of file driver_ir_remote.c.

ir_remote_init()

uint8_t ir_remote_init

(

ir_remote_handle_t *

handle

)

initialize the chip

Parameters

[in]

*handle

pointer to an ir_remote handle structure

Returns

status code

• 0 success
• 1 gpio initialization failed
• 2 handle is NULL
• 3 linked functions is NULL

Note

none

Definition at line 528 of file driver_ir_remote.c.

ir_remote_irq_handler()

uint8_t ir_remote_irq_handler

(

ir_remote_handle_t *

handle

)

irq handler

Parameters

[in]

*handle

pointer to an ir_remote handle structure

Returns

status code

• 0 success
• 1 run failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 454 of file driver_ir_remote.c.