Skip to content

Commit

Permalink
Updated comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
pixelpixi committed Dec 20, 2015
1 parent 16f6d7a commit 2a16735
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions src/IRRemoteModulo.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,14 @@

/// Infrared remote control transmitter and receiver
///
/// Note: this class can send and receive raw IR data as a sequence of pulse
/// lengths, but support for encoding and decoding those pulse lengths into
/// useful codes is not quite complete. Full encoding/decoding will be implemented
/// soon. Please check community.modulo.co for more information on the status
/// of this feature.
/// This class supports encoding and decoding many of the most popular IR
/// remote control protocols, including NEC, Sony, JVC, Panasonic, and LG.
///
/// If a particular remote is not supported you can still receive raw IR data
/// (a sequence of pulse lengths). If you share the raw data for a particular
/// unsupported remote on the forum ( community.modulo.co ) we may be able to
/// add support for it. You can capture the raw data using the IRTutorial
/// example sketch.
class IRRemoteModulo : public BaseModulo {

public:
Expand All @@ -30,11 +33,13 @@ class IRRemoteModulo : public BaseModulo {
/// a transmission complete.
void setBreakLength(uint16_t len);

/// A callback function.
/// The callback function type
typedef void(*ReceiveCallback)(int8_t protocol, uint32_t data,
uint16_t *rawData, uint8_t rawLen);

/// Set the function that should be called when data is received.
/// The callback will receive the decoded protocol and data, along with
/// an array containing the raw pulse widths.
void setReceiveCallback(ReceiveCallback callback);
private:

Expand Down

0 comments on commit 2a16735

Please sign in to comment.