driver_ir_remote.h File Reference

driver ir remote header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>

Include dependency graph for driver_ir_remote.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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
#define	DRIVER_IR_REMOTE_LINK_INIT(HANDLE, STRUCTURE)
	initialize ir_remote_handle_t structure
#define	DRIVER_IR_REMOTE_LINK_TIMESTAMP_READ(HANDLE, FUC)
	link timestamp_read function
#define	DRIVER_IR_REMOTE_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_IR_REMOTE_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function
#define	DRIVER_IR_REMOTE_LINK_RECEIVE_CALLBACK(HANDLE, FUC)
	link receive_callback function

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

driver ir remote header file

Copyright (c) 2015 - present LibDriver All rights reserved

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version

1.0.0

Author

Shifeng Li

Date

2023-03-31

history

Date	Version	Author	Description
2023/03/31	1.0	Shifeng Li	first upload

Definition in file driver_ir_remote.h.