objc

Data Structures | Typedefs | Enumerations | Functions
infrared.h File Reference

Infrared (IR) receiver interface. More...

#include <stdbool.h>
#include <stdint.h>
Include dependency graph for infrared.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  hw_infrared_rx_t
 Infrared receiver. More...
 

Typedefs

typedef struct hw_infrared_rx_t hw_infrared_rx_t
 Infrared receiver.
 
typedef enum hw_infrared_event_t hw_infrared_event_t
 Infrared events.
 
typedef void(* hw_infrared_rx_callback_t) (hw_infrared_event_t event, uint32_t duration_us, void *user_data)
 Infrared receiver.
 

Enumerations

enum  hw_infrared_event_t { HW_INFRARED_EVENT_TIMEOUT = (1 << 0), HW_INFRARED_EVENT_MARK = (1 << 1), HW_INFRARED_EVENT_SPACE = (1 << 2) }
 Infrared events.
 

Functions

hw_infrared_rx_t hw_infrared_rx_init (uint8_t gpio, hw_infrared_rx_callback_t callback, void *user_data)
 Initialize a Infrared receiver. More...
 
bool hw_infrared_rx_valid (hw_infrared_rx_t *rx)
 Check if an Infrared receiver is valid. More...
 
void hw_infrared_rx_finalize (hw_infrared_rx_t *rx)
 Finalize and release an Infrared receiver. More...
 

Detailed Description

Infrared (IR) receiver interface.

Definition in file infrared.h.