Go to the documentation of this file.
9 #define __STDC_LIMIT_MACROS
21 uint64_t
reverseBits(uint64_t input, uint16_t nbits);
34 uint8_t
sumBytes(
const uint8_t *
const start,
const uint16_t length,
35 const uint8_t init = 0);
36 uint8_t
xorBytes(
const uint8_t *
const start,
const uint16_t length,
37 const uint8_t init = 0);
38 uint16_t
countBits(
const uint8_t *
const start,
const uint16_t length,
39 const bool ones =
true,
const uint16_t init = 0);
40 uint16_t
countBits(
const uint64_t data,
const uint8_t length,
41 const bool ones =
true,
const uint16_t init = 0);
42 uint64_t
invertBits(
const uint64_t data,
const uint16_t nbits);
50 const bool precomma =
true);
52 const bool precomma =
true);
54 const bool precomma =
true);
56 const bool precomma =
true);
59 const bool precomma =
true);
61 const bool precomma =
true);
63 const bool precomma =
true);
65 const bool precomma =
true);
67 const uint8_t cool,
const uint8_t heat,
68 const uint8_t dry,
const uint8_t fan);
70 const uint8_t low,
const uint8_t automatic,
71 const uint8_t quiet,
const uint8_t medium,
72 const uint8_t maximum = 0xFF);
74 const uint8_t maxleft,
const uint8_t left,
76 const uint8_t right,
const uint8_t maxright,
78 const uint8_t leftright,
const uint8_t rightleft,
79 const uint8_t threed,
const uint8_t wide);
81 const uint8_t highest,
const uint8_t high,
82 const uint8_t uppermiddle,
84 const uint8_t lowermiddle,
85 const uint8_t low,
const uint8_t lowest,
86 const uint8_t off,
const uint8_t swing,
87 const uint8_t breeze,
const uint8_t circulate);
89 const bool precomma =
true);
93 uint8_t
sumNibbles(
const uint8_t *
const start,
const uint16_t length,
94 const uint8_t init = 0);
95 uint8_t
sumNibbles(
const uint64_t data,
const uint8_t count = 16,
96 const uint8_t init = 0,
const bool nibbleonly =
true);
97 uint16_t
sumBytes(
const uint64_t data,
const uint8_t count = 8,
98 const uint8_t init = 0,
const bool byteonly =
true);
101 bool getBit(
const uint64_t data,
const uint8_t position,
102 const uint8_t size = 64);
103 bool getBit(
const uint8_t data,
const uint8_t position);
104 #define GETBIT8(a, b) ((a) & ((uint8_t)1 << (b)))
105 #define GETBIT16(a, b) ((a) & ((uint16_t)1 << (b)))
106 #define GETBIT32(a, b) ((a) & ((uint32_t)1 << (b)))
107 #define GETBIT64(a, b) ((a) & ((uint64_t)1 << (b)))
108 #define GETBITS8(data, offset, size) \
109 (((data) & (((uint8_t)UINT8_MAX >> (8 - (size))) << (offset))) >> (offset))
110 #define GETBITS16(data, offset, size) \
111 (((data) & (((uint16_t)UINT16_MAX >> (16 - (size))) << (offset))) >> \
113 #define GETBITS32(data, offset, size) \
114 (((data) & (((uint32_t)UINT32_MAX >> (32 - (size))) << (offset))) >> \
116 #define GETBITS64(data, offset, size) \
117 (((data) & (((uint64_t)UINT64_MAX >> (64 - (size))) << (offset))) >> \
119 uint64_t
setBit(
const uint64_t data,
const uint8_t position,
120 const bool on =
true,
const uint8_t size = 64);
121 uint8_t
setBit(
const uint8_t data,
const uint8_t position,
122 const bool on =
true);
123 void setBit(uint8_t *
const data,
const uint8_t position,
124 const bool on =
true);
125 void setBit(uint32_t *
const data,
const uint8_t position,
126 const bool on =
true);
127 void setBit(uint64_t *
const data,
const uint8_t position,
128 const bool on =
true);
129 void setBits(uint8_t *
const dst,
const uint8_t offset,
const uint8_t nbits,
131 void setBits(uint32_t *
const dst,
const uint8_t offset,
const uint8_t nbits,
132 const uint32_t data);
133 void setBits(uint64_t *
const dst,
const uint8_t offset,
const uint8_t nbits,
134 const uint64_t data);
String addTempToString(const uint16_t degrees, const bool celsius, const bool precomma)
Create a String of human output for a given temperature. e.g. "Temp: 25C".
Definition: IRutils.cpp:718
decode_type_t
Enumerator for defining and numbering of supported IR protocol.
Definition: IRremoteESP8266.h:917
String addDayToString(const uint8_t day_of_week, const int8_t offset, const bool precomma)
Create a String of the 3-letter day of the week from a numerical day of the week. e....
Definition: IRutils.cpp:777
uint16_t * resultToRawArray(const decode_results *const decode)
Convert a decode_results into an array suitable for sendRaw().
Definition: IRutils.cpp:419
String addFanToString(const uint8_t speed, const uint8_t high, const uint8_t low, const uint8_t automatic, const uint8_t quiet, const uint8_t medium, const uint8_t maximum)
Create a String of human output for the given fan speed. e.g. "Fan: 0 (Auto)".
Definition: IRutils.cpp:806
void setBits(uint8_t *const dst, const uint8_t offset, const uint8_t nbits, const uint8_t data)
Alter an uint8_t value by overwriting an arbitrary given number of bits.
Definition: IRutils.cpp:1177
String resultToSourceCode(const decode_results *const results)
Return a String containing the key values of a decode_results structure in a C/C++ code style format.
Definition: IRutils.cpp:244
Results returned from the decoder.
Definition: IRrecv.h:99
uint16_t getCorrectedRawLength(const decode_results *const results)
Return the corrected length of a 'raw' format array structure after over-large values are converted i...
Definition: IRutils.cpp:230
String addModelToString(const decode_type_t protocol, const int16_t model, const bool precomma)
Create a String of human output for a given protocol model number. e.g. "Model: JKE".
Definition: IRutils.cpp:700
String addSignedIntToString(const int16_t value, const String label, const bool precomma)
Create a String with a colon separated labeled Integer suitable for Humans. e.g. "Foo: 23".
Definition: IRutils.cpp:582
uint16_t countBits(const uint8_t *const start, const uint16_t length, const bool ones=true, const uint16_t init=0)
Count the number of bits of a certain type in an array.
Definition: IRutils.cpp:470
String msToString(uint32_t const msecs)
Convert a nr. of milliSeconds into a Human-readable string. e.g. "1 Day 6 Hours 34 Minutes 17 Seconds...
Definition: IRutils.cpp:980
uint8_t lowLevelSanityCheck(void)
Perform a low level bit manipulation sanity check for the given cpu architecture and the compiler ope...
Definition: IRutils.cpp:1266
String addModeToString(const uint8_t mode, const uint8_t automatic, const uint8_t cool, const uint8_t heat, const uint8_t dry, const uint8_t fan)
Create a String of human output for the given operating mode. e.g. "Mode: 1 (Cool)".
Definition: IRutils.cpp:752
String resultToHumanReadableBasic(const decode_results *const results)
Dump out the decode_results structure into a human readable format.
Definition: IRutils.cpp:390
String resultToTimingInfo(const decode_results *const results)
Dump out the decode_results structure.
Definition: IRutils.cpp:338
std::string String
Definition: IRremoteESP8266.h:1373
const uint8_t kNibbleSize
Definition: IRutils.h:17
String modelToStr(const decode_type_t protocol, const int16_t model)
Generate the model string for a given Protocol/Model pair.
Definition: IRutils.cpp:593
const uint8_t kLowNibble
Definition: IRutils.h:18
uint8_t uint8ToBcd(const uint8_t integer)
Convert an Integer into a byte of Binary Coded Decimal(BCD).
Definition: IRutils.cpp:1082
decode_type_t strToDecodeType(const char *str)
Convert a C-style string to a decode_type_t.
Definition: IRutils.cpp:119
bool checkInvertedBytePairs(const uint8_t *const ptr, const uint16_t length)
Check an array to see if every second byte of a pair is a bit inverted/flipped copy of the first/prev...
Definition: IRutils.cpp:1244
const uint8_t kHighNibble
Definition: IRutils.h:19
uint8_t sumNibbles(const uint8_t *const start, const uint16_t length, const uint8_t init)
Sum all the nibbles together in a series of bytes.
Definition: IRutils.cpp:1032
String uint64ToString(uint64_t input, uint8_t base=10)
Convert a uint64_t (unsigned long long) to a string. Arduino String/toInt/Serial.print() can't handle...
Definition: IRutils.cpp:65
float celsiusToFahrenheit(const float deg)
Convert degrees Celsius to degrees Fahrenheit.
Definition: IRutils.cpp:518
String addIntToString(const uint16_t value, const String label, const bool precomma)
Create a String with a colon separated labeled Integer suitable for Humans. e.g. "Foo: 23".
Definition: IRutils.cpp:570
uint8_t xorBytes(const uint8_t *const start, const uint16_t length, const uint8_t init=0)
Calculate a rolling XOR of all the bytes of an array.
Definition: IRutils.cpp:456
String addSwingVToString(const uint8_t position, const uint8_t automatic, const uint8_t highest, const uint8_t high, const uint8_t uppermiddle, const uint8_t middle, const uint8_t lowermiddle, const uint8_t low, const uint8_t lowest, const uint8_t off, const uint8_t swing, const uint8_t breeze, const uint8_t circulate)
Create a String of human output for the given vertical swing setting. e.g. "Swing(V): 0 (Auto)".
Definition: IRutils.cpp:899
String addTempFloatToString(const float degrees, const bool celsius, const bool precomma)
Create a String of human output for a given temperature. e.g. "Temp: 25.5C".
Definition: IRutils.cpp:732
const uint8_t kModeBitsSize
Definition: IRutils.h:20
bool getBit(const uint64_t data, const uint8_t position, const uint8_t size)
Return the value of positionth bit of an Integer.
Definition: IRutils.cpp:1092
uint16_t sumBytes(const uint64_t data, const uint8_t count, const uint8_t init, const bool byteonly)
Sum all the bytes together in an integer.
Definition: IRutils.cpp:1062
float fahrenheitToCelsius(const float deg)
Convert degrees Fahrenheit to degrees Celsius.
Definition: IRutils.cpp:521
uint8_t sumBytes(const uint8_t *const start, const uint16_t length, const uint8_t init=0)
Sum all the bytes of an array and return the least significant 8-bits of the result.
Definition: IRutils.cpp:443
String addSwingHToString(const uint8_t position, const uint8_t automatic, const uint8_t maxleft, const uint8_t left, const uint8_t middle, const uint8_t right, const uint8_t maxright, const uint8_t off, const uint8_t leftright, const uint8_t rightleft, const uint8_t threed, const uint8_t wide)
Create a String of human output for the given horizontal swing setting. e.g. "Swing(H): 0 (Auto)".
Definition: IRutils.cpp:840
String typeToString(const decode_type_t protocol, const bool isRepeat=false)
Convert a protocol type (enum etc) to a human readable string.
Definition: IRutils.cpp:140
String addToggleToString(const bool toggle, const String label, const bool precomma)
Create a String with a colon separated toggle flag suitable for Humans. e.g. "Light: Toggle",...
Definition: IRutils.cpp:558
String resultToHexidecimal(const decode_results *const result)
Convert the decode_results structure's value/state to simple hexadecimal.
Definition: IRutils.cpp:370
String addBoolToString(const bool value, const String label, const bool precomma)
Create a String with a colon separated flag suitable for Humans. e.g. "Power: On".
Definition: IRutils.cpp:547
String minsToString(const uint16_t mins)
Convert a nr. of minutes into a 24h clock format Human-readable string. e.g. "23:59".
Definition: IRutils.cpp:1017
uint8_t * invertBytePairs(uint8_t *ptr, const uint16_t length)
Create byte pairs where the second byte of the pair is a bit inverted/flipped copy of the first/previ...
Definition: IRutils.cpp:1229
uint8_t bcdToUint8(const uint8_t bcd)
Convert a byte of Binary Coded Decimal(BCD) into an Integer.
Definition: IRutils.cpp:1074
Namespace for covering common functions & procedures for advancd protocol handlers.
Definition: IRutils.cpp:523
uint64_t reverseBits(uint64_t input, uint16_t nbits)
Reverse the order of the requested least significant nr. of bits.
Definition: IRutils.cpp:45
bool isRepeat(const uint64_t data, const uint16_t nbits)
Test if an XMP message code is a repeat or not.
Definition: ir_Xmp.cpp:85
String htmlEscape(const String unescaped)
Escape any special HTML (unsafe) characters in a string. e.g. anti-XSS.
Definition: IRutils.cpp:948
bool hasACState(const decode_type_t protocol)
Does the given protocol use a complex state as part of the decode?
Definition: IRutils.cpp:170
uint64_t setBit(const uint64_t data, const uint8_t position, const bool on, const uint8_t size)
Return the value of an Integer with the positionth bit changed.
Definition: IRutils.cpp:1112
void serialPrintUint64(uint64_t input, uint8_t base=10)
Print a uint64_t/unsigned long long to the Serial port Serial.print() can't handle printing long long...
Definition: IRutils.cpp:111
String int64ToString(int64_t input, uint8_t base=10)
Convert a int64_t (signed long long) to a string. Arduino String/toInt/Serial.print() can't handle pr...
Definition: IRutils.cpp:96
String addLabeledString(const String value, const String label, const bool precomma)
Create a String with a colon separated "label: value" pair suitable for Humans.
Definition: IRutils.cpp:530
uint64_t invertBits(const uint64_t data, const uint16_t nbits)
Invert/Flip the bits in an Integer.
Definition: IRutils.cpp:507