Shinichiro Nakamura / RemoteIR

RemoteIR.

Dependents:   RemoteIR_TestProgram SerialGPS_TestProgram StarBoardOrangeExpansion1 Door_Slamming_Device ... more

Embed: (wiki syntax)

« Back to documentation index

ReceiverIR Class Reference
Public Types | Public Member Functions

ReceiverIR Class Reference

IR receiver class. More...

#include <ReceiverIR.h>

Public Types

enum  State
 

State.

More...

Public Member Functions

 ReceiverIR (PinName rxpin)
 Constructor.
 ~ReceiverIR ()
 Destructor.
State getState ()
 Get state.
int getData (RemoteIR::Format *format, uint8_t *buf, int bitlength)
 Get data.

Detailed Description

IR receiver class.

Definition at line 18 of file ReceiverIR.h.

Member Enumeration Documentation

enum State

State.

Definition at line 36 of file ReceiverIR.h.

Constructor & Destructor Documentation

ReceiverIR ( PinName  rxpin ) [explicit]

Constructor.

Parameters:
rxpinPin for receive IR signal.

Definition at line 20 of file ReceiverIR.cpp.

~ReceiverIR (  )

Destructor.

Definition at line 31 of file ReceiverIR.cpp.

Member Function Documentation

int getData ( RemoteIR::Format *  format,
uint8_t *  buf,
int  bitlength 
)

Get data.

Parameters:
formatPointer to format.
bufBuffer of a data.
bitlengthBit length of the buffer.
Returns:
Data bit length.

Definition at line 55 of file ReceiverIR.cpp.

ReceiverIR::State getState (  )

Get state.

Returns:
Current state.

Definition at line 39 of file ReceiverIR.cpp.

Generated on Tue Jul 12 2022 12:35:51 by  doxygen 1.7.2