MCPcopy Create free account
hub / github.com/Arduino-IRremote/Arduino-IRremote / IRrecv

Class IRrecv

src/IRremoteInt.h:218–417  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

216 */
217#define USE_DEFAULT_FEEDBACK_LED_PIN 0xFF // we need it here
218class IRrecv {
219public:
220
221 IRrecv();
222#if defined(SUPPORT_MULTIPLE_RECEIVER_INSTANCES)
223 IRrecv(uint_fast8_t aReceivePin);
224 IRrecv(uint_fast8_t aReceivePin, uint_fast8_t aFeedbackLEDPin);
225#else
226 IRrecv(
227 uint_fast8_t aReceivePin)
228 __attribute__ ((deprecated ("Please use the default IRrecv instance \"IrReceiver\" and IrReceiver.begin(), and not your own IRrecv instance.")));
229 IRrecv(uint_fast8_t aReceivePin,
230 uint_fast8_t aFeedbackLEDPin)
231 __attribute__ ((deprecated ("Please use the default IRrecv instance \"IrReceiver\" and IrReceiver.begin(), and not your own IRrecv instance..")));
232#endif
233 void setReceivePin(uint_fast8_t aReceivePinNumber);
234#if !defined(IR_REMOTE_DISABLE_RECEIVE_COMPLETE_CALLBACK)
235 void registerReceiveCompleteCallback(void (*aReceiveCompleteCallbackFunction)(void));
236#endif
237 void ReceiveInterruptHandler();
238
239 /*
240 * Stream like API
241 */
242 void begin(uint_fast8_t aReceivePin, bool aEnableLEDFeedback = false, uint_fast8_t aFeedbackLEDPin =
243 USE_DEFAULT_FEEDBACK_LED_PIN);
244 void start();
245 void enableIRIn(); // alias for start
246 void restartTimer();
247 void restartTimer(uint32_t aMicrosecondsToAddToGapCounter);
248 void restartTimerWithTicksToAdd(uint16_t aTicksToAddToGapCounter);
249 void restartAfterSend();
250
251 bool available();
252 IRData* read(); // returns decoded data
253 // write is a method of class IRsend below
254 // size_t write(IRData *aIRSendData, int_fast8_t aNumberOfRepeats = NO_REPEATS);
255 void stopTimer();
256 void stop();
257 void disableIRIn(); // alias for stop
258 void end(); // alias for stop
259
260 bool isIdle();
261
262 /*
263 * The main functions
264 */
265 bool decode(); // Check if available and try to decode
266 void resume(); // Enable receiving of the next value
267
268 /*
269 * Useful info and print functions
270 */
271 void printIRResultMinimal(Print *aSerial);
272 void printIRDuration(Print *aSerial, bool aOutputMicrosecondsInsteadOfTicks);
273 void printIRResultRawFormatted(Print *aSerial, bool aOutputMicrosecondsInsteadOfTicks = true);
274 void printIRResultAsCVariables(Print *aSerial);
275 uint8_t getMaximumMarkTicksFromRawData();

Callers

nothing calls this directly

Calls

no outgoing calls

Tested by

no test coverage detected