Arduino-IRremote/src/IRFeedbackLED.hpp at master · Arduino-IRremote/Arduino-IRremote · GitHub

History

167 lines (154 loc) · 6.27 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

/**

* @file IRFeedbackLED.hpp

* @brief All Feedback LED specific functions are contained in this file.

* This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote.

*************************************************************************************

* MIT License

* Permission is hereby granted, free of charge, to any person obtaining a copy

* of this software and associated documentation files (the "Software"), to deal

* in the Software without restriction, including without limitation the rights

* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

* copies of the Software, and to permit persons to whom the Software is furnished

* to do so, subject to the following conditions:

* The above copyright notice and this permission notice shall be included in all

* copies or substantial portions of the Software.

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,

* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A

* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF

* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE

* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

************************************************************************************

#ifndef _IR_FEEDBACK_LED_HPP

#define _IR_FEEDBACK_LED_HPP

/** \addtogroup FeedbackLEDFunctions Feedback LED functions

* @{

/**

* Contains pin number and enable status of the feedback LED

struct FeedbackLEDControlStruct {

uint8_t FeedbackLEDPin = USE_DEFAULT_FEEDBACK_LED_PIN; ///< if USE_DEFAULT_FEEDBACK_LED_PIN / 0xFF, then use digitalWriteFast(LED_BUILTIN,..) otherwise use digitalWrite(FeedbackLEDPin,..)

bool LedFeedbackEnabled; ///< Disabled for receive at default. Feedback for send is always enabled and can be disabled by NO_LED_SEND_FEEDBACK_CODE or #define NO_LED_FEEDBACK_CODE macros

};

struct FeedbackLEDControlStruct FeedbackLEDControl; ///< The feedback LED control instance

/**

* @param aFeedbackLEDPin If FeedbackLEDPin != USE_DEFAULT_FEEDBACK_LED_PIN / 0xFF, then use digitalWrite / digitalWriteFast(FeedbackLEDPin,..)

* If FeedbackLEDPin == USE_DEFAULT_FEEDBACK_LED_PIN / 0xFF and LED_BUILTIN defined, then use digitalWriteFast(LED_BUILTIN,..)

* If FeedbackLEDPin == USE_DEFAULT_FEEDBACK_LED_PIN / 0xFF and no LED_BUILTIN defined, disable LED feedback

void setLEDFeedbackPin(uint8_t aFeedbackLEDPin) {

FeedbackLEDControl.FeedbackLEDPin = aFeedbackLEDPin;

// use fast macros here

if (aFeedbackLEDPin == USE_DEFAULT_FEEDBACK_LED_PIN) {

#if defined(LED_BUILTIN)

pinModeFast(LED_BUILTIN, OUTPUT);

#endif

} else {

if (__builtin_constant_p(aFeedbackLEDPin)) {

pinModeFast(aFeedbackLEDPin, OUTPUT);

} else {

pinMode(aFeedbackLEDPin, OUTPUT);

}

* Direct replacement for blink13()

void setLEDFeedback(bool aEnableLEDFeedback) {

FeedbackLEDControl.LedFeedbackEnabled = aEnableLEDFeedback;

}

* Historically this only affects receive LED

void enableLEDFeedback() {

FeedbackLEDControl.LedFeedbackEnabled = ENABLE_LED_FEEDBACK;

}

void disableLEDFeedback() {

FeedbackLEDControl.LedFeedbackEnabled = DISABLE_LED_FEEDBACK;

}

/**

* Flash LED while receiving or sending IR data. Does not check if enabled, this must be done by the caller.

* Handles the USE_DEFAULT_FEEDBACK_LED_PIN / 0xFF value of FeedbackLEDPin and the macro FEEDBACK_LED_IS_ACTIVE_LOW.

* If FeedbackLEDPin == USE_DEFAULT_FEEDBACK_LED_PIN and LED_BUILTIN is NOT defined no action is done

#if defined(ESP32) || defined(ESP8266)

IRAM_ATTR

#endif

void setFeedbackLED(bool aSwitchLedOn) {

if (aSwitchLedOn) {

// Turn user defined pin LED on

if (FeedbackLEDControl.FeedbackLEDPin == USE_DEFAULT_FEEDBACK_LED_PIN) {

#if defined(LED_BUILTIN) // use fast macros here

# if defined(FEEDBACK_LED_IS_ACTIVE_LOW)

digitalWriteFast(LED_BUILTIN, LOW); // For AVR, this generates a single cbi command

# else

digitalWriteFast(LED_BUILTIN, HIGH); // For AVR, this generates a single sbi command

# endif

#endif

} else {

#if defined(FEEDBACK_LED_IS_ACTIVE_LOW)

if (__builtin_constant_p(FeedbackLEDControl.FeedbackLEDPin) ) {

digitalWriteFast(FeedbackLEDControl.FeedbackLEDPin, LOW);

} else {

digitalWrite(FeedbackLEDControl.FeedbackLEDPin, LOW);

}

#else

if (__builtin_constant_p(FeedbackLEDControl.FeedbackLEDPin)) {

digitalWriteFast(FeedbackLEDControl.FeedbackLEDPin, HIGH);

} else {

digitalWrite(FeedbackLEDControl.FeedbackLEDPin, HIGH);

}

#endif

}

} else {

// Turn user defined pin LED off

if (FeedbackLEDControl.FeedbackLEDPin == USE_DEFAULT_FEEDBACK_LED_PIN) {

#if defined(LED_BUILTIN)

# if defined(FEEDBACK_LED_IS_ACTIVE_LOW)

digitalWriteFast(LED_BUILTIN, HIGH); // For AVR, this generates a single sbi command

# else

digitalWriteFast(LED_BUILTIN, LOW); // For AVR, this generates a single cbi command

# endif

#endif

} else {

#if defined(FEEDBACK_LED_IS_ACTIVE_LOW)

if (__builtin_constant_p(FeedbackLEDControl.FeedbackLEDPin) ) {

digitalWriteFast(FeedbackLEDControl.FeedbackLEDPin, HIGH);

} else {

digitalWrite(FeedbackLEDControl.FeedbackLEDPin, HIGH);

}

#else

if (__builtin_constant_p(FeedbackLEDControl.FeedbackLEDPin)) {

digitalWriteFast(FeedbackLEDControl.FeedbackLEDPin, LOW);

} else {

digitalWrite(FeedbackLEDControl.FeedbackLEDPin, LOW);

}

#endif

}

/**

* Old deprecated function name for setLEDFeedback() or enableLEDFeedback() / disableLEDFeedback()

void IRrecv::blink13(uint8_t aEnableLEDFeedback) {

setLEDFeedback(aEnableLEDFeedback);

}

/**

* Old deprecated function name for setLEDFeedback()

void setBlinkPin(uint8_t aBlinkPin) {

setLEDFeedbackPin(aBlinkPin);

}

/** @}*/

#endif // _IR_FEEDBACK_LED_HPP

Arduino-IRremote/src/IRFeedbackLED.hpp at master · Arduino-IRremote/Arduino-IRremote · GitHub

Uh oh!

Expand file tree

Breadcrumbs

IRFeedbackLED.hpp

Latest commit

History

Breadcrumbs

IRFeedbackLED.hpp

File metadata and controls