Fork of TxIR

Fork of TxIR by Nordic Pucks

Embed: (wiki syntax)

« Back to documentation index

TxIR Class Reference

TxIR Class Reference

A low-level ifrared transmit library. More...

#include <TxIR.hpp>

Public Member Functions

 TxIR (PinName pin)
 Initialize the TxIR library.
bool inUse ()
 If something is currently being sent.
bool txSeq (unsigned freq, unsigned len, const unsigned *data)
 Transmit an IR sequence.

Detailed Description

A low-level ifrared transmit library.

Definition at line 36 of file TxIR.hpp.


Constructor & Destructor Documentation

TxIR ( PinName  pin )

Initialize the TxIR library.

Parameters:
pina pin on the mbed that is PWM capable

Definition at line 68 of file TxIR.hpp.


Member Function Documentation

bool inUse (  )

If something is currently being sent.

Returns:
is something being tranmitted currently

Definition at line 76 of file TxIR.hpp.

bool txSeq ( unsigned  freq,
unsigned  len,
const unsigned *  data 
)

Transmit an IR sequence.

Parameters:
freqthe modulation frequency in us normally ~40kHz -> 26us
lenthe number of modulation changes to send (length of data)
dataan array of on/off times in us that will be transmitted
Returns:
transmission has begun

Definition at line 38 of file TxIR.cpp.