### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRDaikin64-members.html Starts the Daikin64 protocol. ```APIDOC ## begin() ### Description Starts the Daikin64 protocol. ### Method [void] ### Endpoint begin() ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC-members.html Starts the IRHaierAC functionality. ```APIDOC ## begin() ### Description Starts the IRHaierAC functionality. ### Method [Method Signature: begin(void)] ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRAirtonAc-members.html Starts the IRAirtonAc functionality. ```APIDOC ## begin(void) ### Description Initializes the IRAirtonAc object and prepares it for sending IR commands. ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRCoolixAC-members.html Starts the IRCoolixAC functionality. ```APIDOC ## begin(void) ### Description Initializes the IRCoolixAC object to begin operation. ### Method begin ### Parameters None ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRVestelAc-members.html Starts the IRVestelAc functionality. ```APIDOC ## begin ### Description Starts the IRVestelAc functionality. ### Method `begin()` ### Parameters None ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRArgoACBase.html Sets up the hardware to be able to send a message. ```APIDOC ## begin() ### Description Set up hardware to be able to send a message. ### Method `void begin()` ``` -------------------------------- ### Start Clock Time Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRMitsubishiAC.html Methods to get and set the desired start time of the A/C unit. ```APIDOC ## getStartClock ### Description Get the desired start time of the A/C unit. ### Method GET ### Endpoint /AC/Mitsubishi/StartClock ### Parameters None ### Response #### Success Response (200) - **clock** (uint8_t) - The desired start time. ``` ```APIDOC ## setStartClock ### Description Set the desired start time of the A/C unit. ### Method POST ### Endpoint /AC/Mitsubishi/StartClock ### Parameters #### Request Body - **clock** (uint8_t) - The desired start time. ``` -------------------------------- ### Install Development Tools for IRRemoteESP8266 Source: https://github.com/crankyoldgit/irremoteesp8266/wiki/Library-Maintainers-Guide Installs essential development tools like pylint3 and PlatformIO, and downloads Google Test for C++ linting and compilation. This setup is required once. ```shell $ sudo apt-get install pylint3 # Install the Python Linter $ sudo pip install platformio # PlatformIO is like the Arduino IDE. It will build/compile the code. $ pio update # Ensure PlatformIO is to date. $ wget https://raw.githubusercontent.com/google/styleguide/gh-pages/cpplint/cpplint.py # Get the latest C++ linter. $ cd git/IRremoteESP8266/test $ make install-googletest ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/IRsend_8h_source.html Initializes the IRsend hardware. ```APIDOC ## begin() ### Description Initializes the IRsend hardware. ### Method void ### Endpoint begin() ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRLgAc-members.html Starts the IR remote functionality. ```APIDOC ## begin ### Description Starts the IR remote functionality. ### Method begin ### Parameters None ### Endpoint N/A (Method) ``` -------------------------------- ### Get Bits Macros (C++) Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/IRutils_8h_source.html Macros to extract a contiguous sequence of bits from integer types. Specify the data, starting offset, and number of bits to extract. ```cpp #define GETBITS8(data, offset, size) \ (((data) & ((static_cast(UINT8_MAX) >> (8 - (size))) << \ (offset))) >> (offset)) ``` ```cpp #define GETBITS16(data, offset, size) \ (((data) & ((static_cast(UINT16_MAX) >> (16 - (size))) << \ (offset))) >> (offset)) ``` ```cpp #define GETBITS32(data, offset, size) \ (((data) & ((static_cast(UINT32_MAX) >> (32 - (size))) << \ (offset))) >> (offset)) ``` ```cpp #define GETBITS64(data, offset, size) \ (((data) & ((static_cast(UINT64_MAX) >> (64 - (size))) << \ (offset))) >> (offset)) ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRAirwellAc.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## begin() ### Description Set up hardware to be able to send a message. ### Method void ### Parameters None ``` -------------------------------- ### start Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRtimer-members.html Starts or resumes the timer. ```APIDOC ## start ### Description Starts or resumes the timer. ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRKelon168Ac.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## begin() ### Description Prepares the hardware for sending IR signals. ### Method `void begin()` ``` -------------------------------- ### Get Lock State Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Haier_8h_source.html Gets the current state of the lock feature. ```APIDOC ## getLock ### Description Gets the current state of the lock feature. ### Returns - (bool) - True if the lock is active, false otherwise. ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRCarrierAc64.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## begin() ### Description Sets up hardware to be able to send a message. ### Method `void begin(void)` ``` -------------------------------- ### Get Temperature Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Haier_8h_source.html Gets the current target temperature of the air conditioner. ```APIDOC ## getTemp ### Description Gets the current target temperature of the air conditioner. ### Returns - (uint8_t) - The current target temperature. ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRCoolixAC.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## void IRCoolixAC::begin() ### Description Set up hardware to be able to send a message. ``` -------------------------------- ### Get Button Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Haier_8h_source.html Gets the currently set IR button code. ```APIDOC ## getButton ### Description Gets the currently set IR button code. ### Returns - (uint8_t) - The current button code. ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRDaikin128.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## void IRDaikin128::begin() ### Description Set up hardware to be able to send a message. ### Method void ### Endpoint begin() ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## begin() ### Description Sets up the hardware to be able to send a message. ### Method `void begin(void)` ``` -------------------------------- ### Start Clock Setting Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Mitsubishi_8h_source.html Controls the start clock setting for the AC unit. ```APIDOC ## getStartClock ### Description Retrieves the current start clock setting. ### Method `uint8_t getStartClock(void) const;` ### Returns - `uint8_t`: The current start clock setting. ``` ```APIDOC ## setStartClock ### Description Sets the start clock for the AC unit. ### Method `void setStartClock(const uint8_t clock);` ### Parameters #### Path Parameters - **clock** (uint8_t) - Required - The desired start clock setting. ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRMitsubishi112.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## void begin(void) ### Description Prepares the hardware for sending IR messages. ``` -------------------------------- ### Get Clean Mode State Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Haier_8h_source.html Gets the current state of the clean mode. ```APIDOC ## getClean ### Description Gets the current state of the clean mode. ### Returns - (bool) - True if clean mode is active, false otherwise. ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRMitsubishiAC.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## begin() ### Description Set up hardware to be able to send a message. ### Method `void IRMitsubishiAC::begin(void)` ``` -------------------------------- ### Get Power State Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Haier_8h_source.html Gets the current power state of the air conditioner. ```APIDOC ## getPower ### Description Gets the current power state of the air conditioner. ### Returns - (bool) - True if the unit is on, false if off. ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIREuromAc.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## void IREuromAc::begin() ### Description Set up hardware to be able to send a message. ### Parameters None ``` -------------------------------- ### Get Auxiliary Heating State Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Haier_8h_source.html Gets the current state of the auxiliary heating feature. ```APIDOC ## getAuxHeating ### Description Gets the current state of the auxiliary heating feature. ### Returns - (bool) - True if auxiliary heating is active, false otherwise. ``` -------------------------------- ### Get Light Toggle State Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Haier_8h_source.html Gets the current state of the light toggle feature. ```APIDOC ## getLightToggle ### Description Gets the current state of the light toggle feature. ### Returns - (bool) - True if the light toggle is active, false otherwise. ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHitachiAc3.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## begin() ### Description Set up hardware to be able to send a message. ### Method void ### Endpoint begin() ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHitachiAc1.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## IRHitachiAc1::begin ### Description Set up hardware to be able to send a message. ### Method void ### Endpoint begin() ``` -------------------------------- ### Get Fan Speed Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Haier_8h_source.html Gets the current fan speed setting of the air conditioner. ```APIDOC ## getFan ### Description Gets the current fan speed setting of the air conditioner. ### Returns - (uint8_t) - The current fan speed. ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRGoodweatherAc.html Sets up the necessary hardware for sending IR messages. ```APIDOC ## begin() ### Description Set up hardware to be able to send a message. ### Method void ### Endpoint N/A (Method call) ``` -------------------------------- ### IRGreeAC Get Model Method Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Gree_8h_source.html Gets the current remote model of the Gree AC. ```c++ gree_ac_remote_model_t getModel(void) const; ``` -------------------------------- ### Get Vertical Swing Position Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Haier_8h_source.html Gets the current vertical swing position of the air conditioner. ```APIDOC ## getSwingV ### Description Gets the current vertical swing position of the air conditioner. ### Returns - (uint8_t) - The current vertical swing position. ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRMitsubishiHeavy88Ac.html Sets up the necessary hardware to begin sending IR messages. ```APIDOC ## void begin(void) ### Description Prepares the hardware for sending IR messages. This method should be called before any send operations. ``` -------------------------------- ### Get Raw Byte Length Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRArgoAC-members.html Gets the length of the raw IR data buffer in bytes. ```APIDOC ## getRawByteLength() const ### Description Returns the length of the raw IR data buffer in bytes. ### Method uint16_t ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRAmcorAc.html Initializes the necessary hardware components to enable sending IR messages. ```APIDOC ## begin() ### Description Set up hardware to be able to send a message. ### Method `void begin(void)` ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRDelonghiAc.html Initializes the necessary hardware for sending IR signals. ```APIDOC ## begin() ### Description Sets up the hardware to be able to send an IR message. ### Method `void begin()` ``` -------------------------------- ### IREcoclimAc::set and get Off Timer Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIREcoclimAc.html Methods for setting, getting, and checking the status of the A/C's Off Timer. ```APIDOC ## setOffTimer(const uint16_t nr_of_mins) ### Description Set & enable the Off Timer for the A/C. ### Method void ### Parameters - **nr_of_mins** (const uint16_t) - The number of minutes for the timer. ``` ```APIDOC ## getOffTimer() ### Description Get the Off Timer for the A/C. ### Method uint16_t ### Parameters None ### Returns The current Off Timer value in minutes. ``` ```APIDOC ## isOffTimerEnabled() ### Description Check if the Off Timer is enabled. ### Method bool ### Parameters None ### Returns `true` if the Off Timer is enabled, `false` otherwise. ``` ```APIDOC ## disableOffTimer() ### Description Disable & clear the Off Timer. ### Method void ### Parameters None ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRLgAc.html Initializes the hardware required to send IR messages. ```APIDOC ## begin() ### Description Set up hardware to be able to send a message. ### Method void IRLgAc::begin(void) ``` -------------------------------- ### IREcoclimAc::set and get On Timer Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIREcoclimAc.html Methods for setting, getting, and checking the status of the A/C's On Timer. ```APIDOC ## setOnTimer(const uint16_t nr_of_mins) ### Description Set & enable the On Timer for the A/C. ### Method void ### Parameters - **nr_of_mins** (const uint16_t) - The number of minutes for the timer. ``` ```APIDOC ## getOnTimer() ### Description Get the On Timer for the A/C. ### Method uint16_t ### Parameters None ### Returns The current On Timer value in minutes. ``` ```APIDOC ## isOnTimerEnabled() ### Description Check if the On Timer is enabled. ### Method bool ### Parameters None ### Returns `true` if the On Timer is enabled, `false` otherwise. ``` ```APIDOC ## disableOnTimer() ### Description Disable & clear the On Timer. ### Method void ### Parameters None ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRAirwellAc.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## void begin() ### Description Set up hardware to be able to send a message. ``` -------------------------------- ### IRrecvDumpV2 Example Source: https://github.com/crankyoldgit/irremoteesp8266/wiki/Adding-support-for-a-new-AC-protocol Use this example to dump IR messages from your AC remote. It helps identify if the protocol is already supported or if it's unknown. ```C++ #include ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRCoolixAC.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## begin ### Description Set up hardware to be able to send a message. ``` -------------------------------- ### Transcold Protocol Raw Data Examples Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Transcold_8h_source.html These examples show the raw data calculations for various Transcold AC commands. They are useful for understanding the protocol structure and for debugging or custom implementations. ```text ON 24 Auto cool close (right) 111011110001000001100001100111100101010010101011 ``` ```text OFF 24 Auto cool close (right) 111011110001000001110001100011100101010010101011 ``` ```text Hot mode 24 auto hot close (right) 111010010001011010100001010111100101010010101011 ``` ```text Fan mode 0 (prev24) low fan close (right) "11101001 0001011000100001110111100101010010101011" ``` ```text Dry mode 24 low dry close (right) "11101001 0001011011000001 00111110 0101010010101011" ``` ```text Auto Mode 0(prev24) low auto close (right) "11101001 0001011011100001 00011110 0101010010101011" ``` ```text Cool Mode 24 low cool close (right) "11101001 0001011001100001 10011110 0101010010101011" ``` ```text fan Speed low 24 low cool close (right) "11101001 0001011001100001 10011110 0101010010101011" ``` ```text fan Speed medium 24 medium cool close (right) "11101101 000100100110000110011110 0101010010101011" ``` ```text fan Speed high 24 high cool close (right) "11101011 000101000110000110011110 0101010010101011" ``` ```text fan Speed auto 24 auto cool close (right) "11110111 000010000110000110011110 0101010010101011" ``` ```text Swing open 24 auto cool open (left) "11110111 000010000110000110011110 0101010010101011" ``` ```text Swing close 24 auto cool close (right) "11101111 000100000110000110011110 0101010010101011" ``` ```text temp 30degC Auto cool close (right) 111011110001000001100100100100010101010010101011 ``` ```text temp 29 Auto cool close (right) 111011110001000001101100100100010101010010101011 ``` ```text temp 28 Auto cool close (right) 111011110001000001100010100100010101010010101011 ``` ```text temp 27 Auto cool close (right) 111011110001000001101010100100010101010010101011 ``` ```text temp 26 Auto cool close (right) 111011110001000001100110100100010101010010101011 ``` ```text temp 25 Auto cool close (right) 111011110001000001101110100100010101010010101011 ``` ```text temp 24 Auto cool close (right) 111011110001000001100001100111100101010010101011 ``` ```text temp 23 Auto cool close (right) 111011110001000001101001100101100101010010101011 ``` ```text temp 22 Auto cool close (right) 111011110001000001100101100101100101010010101011 ``` ```text temp 21 Auto cool close (right) 111011110001000001101101100101100101010010101011 ``` ```text temp 20 Auto cool close (right) 111011110001000001100011100101100101010010101011 ``` ```text temp 19 Auto cool close (right) 111011110001000001101011100101100101010010101011 ``` ```text temp 18 Auto cool close (right) 111011110001000001100111100110000101010010101011 ``` ```text temp 17 Auto cool close (right) 111011110001000001100111100110000101010010101011 ``` ```text temp 16 Auto cool close (right) 111011110001000001100111100110000101010010101011 ``` -------------------------------- ### getTemp Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC160-members.html Gets the temperature. ```APIDOC ## getTemp(void) const ### Description Gets the temperature. ### Method [Method signature: getTemp(void) const] ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRPanasonicAc.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## begin ### Description Set up hardware to be able to send a message. ### Signature void begin(void) ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRMitsubishiAC.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## begin ### Description Initializes and configures the hardware (e.g., GPIO pin) required for sending IR signals. ### Method `void begin(void)` ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRCoronaAc.html Sets up the necessary hardware to enable sending IR messages. ```APIDOC ## begin() ### Description Set up hardware to be able to send a message. ### Method void ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRGreeAC-members.html Initializes the IRGreeAC communication. ```APIDOC ## begin() ### Description Starts the IR communication for the Gree AC. ### Method `void begin()` ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRBosch144AC.html Sets up the necessary hardware to begin sending IR messages. ```APIDOC ## begin ### Description Set up hardware to be able to send a message. ### Method void begin(void) ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Vestel_8h_source.html Initializes the IR Vestel AC library. ```APIDOC ## begin ### Description Initializes the IR Vestel AC library. ### Method `void begin(void);` ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRMitsubishiHeavy152Ac-members.html Initializes the IR transmitter. ```APIDOC ## begin() ### Description Initializes the IR transmitter for the Mitsubishi Heavy AC protocol. ### Method `begin` ``` -------------------------------- ### getModel Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRToshibaAC-members.html Gets the model information. ```APIDOC ## getModel() const ### Description Gets the model information of the Toshiba AC. This method is likely used for identification purposes. ### Method GET ``` -------------------------------- ### getSave Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRTecoAc-members.html Gets the save state. ```APIDOC ## getSave(void) const ### Description Returns the current save state of the air conditioner settings. ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHitachiAc424.html Sets up the hardware to be able to send an IR message. ```APIDOC ## begin ### Description Set up hardware to be able to send a message. ### Returns void ``` -------------------------------- ### getModel Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRLgAc.html Gets the model of the A/C. ```APIDOC ## getModel ### Description Gets the model of the A/C. ### Signature `lg_ac_remote_model_t getModel() const` ### Returns * lg_ac_remote_model_t - The current A/C model. ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRAmcorAc.html Sets up the necessary hardware to be able to send an IR message. ```APIDOC ## begin ### Description Set up hardware to be able to send a message. ### Method void begin() ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIREuromAc.html Sets up the necessary hardware to be able to send an IR message. ```APIDOC ## begin ### Description Sets up the hardware to be able to send a message. ### Method `void begin(void)` ``` -------------------------------- ### getTimerMode Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC160-members.html Gets the timer mode. ```APIDOC ## getTimerMode(void) const ### Description Gets the timer mode. ### Method [Method signature: getTimerMode(void) const] ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRRhossAc.html Sets up the necessary hardware to be able to send an IR message. ```APIDOC ## begin ### Description Set up hardware to be able to send a message. ### Method void begin() ### Parameters None ``` -------------------------------- ### getPower Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC160-members.html Gets the power status. ```APIDOC ## getPower(void) const ### Description Gets the power status. ### Method [Method signature: getPower(void) const] ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRAirtonAc.html Sets up the necessary hardware to be able to send an IR message. ```APIDOC ## void begin(void) ### Description Set up hardware to be able to send a message. ``` -------------------------------- ### getOnTimer Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC160-members.html Gets the on timer value. ```APIDOC ## getOnTimer(void) const ### Description Gets the on timer value. ### Method [Method signature: getOnTimer(void) const] ``` -------------------------------- ### getOffTimer Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC160-members.html Gets the off timer value. ```APIDOC ## getOffTimer(void) const ### Description Gets the off timer value. ### Method [Method signature: getOffTimer(void) const] ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRTechnibelAc-members.html Initializes the IRTechnibelAc communication. ```APIDOC ## begin() ### Description Initializes the IRTechnibelAc communication. ### Method `void begin(void)` ``` -------------------------------- ### getMode Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC160-members.html Gets the operating mode. ```APIDOC ## getMode(void) const ### Description Gets the operating mode. ### Method [Method signature: getMode(void) const] ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Voltas_8h_source.html Initializes the IRVoltas library. ```APIDOC ## void begin() ### Description Initializes the IRVoltas library, preparing it for sending commands. ``` -------------------------------- ### getLock Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC160-members.html Gets the lock status. ```APIDOC ## getLock(void) const ### Description Gets the lock status. ### Method [Method signature: getLock(void) const] ``` -------------------------------- ### getHealth Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC160-members.html Gets the health status. ```APIDOC ## getHealth(void) const ### Description Gets the health status. ### Method [Method signature: getHealth(void) const] ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRDaikin160.html Sets up the necessary hardware to enable IR message transmission. ```APIDOC ## begin ### Description Initializes the hardware components required for sending IR messages. ### Method `void begin(void)` ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRMitsubishi136.html Initializes the hardware necessary for sending IR messages. ```APIDOC ## begin() ### Description Set up hardware to be able to send a message. ``` -------------------------------- ### getFan Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC160-members.html Gets the fan speed. ```APIDOC ## getFan(void) const ### Description Gets the fan speed. ### Method [Method signature: getFan(void) const] ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRDaikin152.html Initializes the hardware necessary for sending IR messages. ```APIDOC ## begin ### Description Set up hardware to be able to send a message. ### Method `begin(void)` ``` -------------------------------- ### getClean Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC160-members.html Gets the clean status. ```APIDOC ## getClean(void) const ### Description Gets the clean status. ### Method [Method signature: getClean(void) const] ``` -------------------------------- ### getHealth() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC-members.html Gets the health status. ```APIDOC ## getHealth() ### Description Gets the health status. ### Method [Method Signature: getHealth(void) const] ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRDelonghiAc.html Initializes the hardware necessary for sending IR messages. ```APIDOC ## begin ### Description Set up hardware to be able to send a message. ### Method `void begin(void)` ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRPanasonicAc32-members.html Initializes the IR Panasonic AC 32-bit protocol. ```APIDOC ## begin() ### Description Initializes the IR Panasonic AC 32-bit protocol. ### Method void ``` -------------------------------- ### getCommand() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHaierAC-members.html Gets the current command. ```APIDOC ## getCommand() ### Description Gets the current command. ### Method [Method Signature: getCommand(void) const] ``` -------------------------------- ### getModel() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRArgoAC__WREM3.html Gets the device model. ```APIDOC ## getModel() ### Description Get device model. ### Returns - Device model ([argo_ac_remote_model_t]) ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRElectraAc.html Initializes the necessary hardware components to enable sending IR messages. ```APIDOC ## begin ### Description Set up hardware to be able to send a message. ### Method void ### Parameters None ``` -------------------------------- ### checksum() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRCarrierAc64-members.html Gets the current checksum. ```APIDOC ## checksum() ### Description Gets the current checksum. ### Returns (uint64_t) The current checksum. ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRElectraAc-members.html Initializes the Electra AC protocol. ```APIDOC ## begin(void) ### Description Initializes the Electra AC protocol. This method should be called before sending any commands. ### Method void ``` -------------------------------- ### checksum Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRAirtonAc-members.html Gets the calculated checksum. ```APIDOC ## checksum(void) ### Description Returns the currently calculated checksum value. ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRDaikin152-members.html Initializes the IR communication for the Daikin152 protocol. ```APIDOC ## begin() ### Description Starts the IR communication for the Daikin152 protocol. ### Method `void begin(void)` ``` -------------------------------- ### getStartClock() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/functions_func_g.html Retrieves the start clock setting. ```APIDOC ## getStartClock() ### Description Retrieves the configured start time for the clock function on the Mitsubishi AC. ### Method N/A (This is a getter method) ### Parameters None ### Response - Returns the start clock time value. ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRDaikin2.html Initializes the IRDaikin2 communication. ```APIDOC ## begin() ### Description Initializes the IRDaikin2 communication. ### Method `void begin(void)` ``` -------------------------------- ### begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRDelonghiAc-members.html Initializes the IR communication for the Delonghi AC. ```APIDOC ## begin(void) ### Description Initializes the IR communication. ### Method GET ``` -------------------------------- ### TimerMs::start Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classTimerMs-members.html Starts or resumes the timer. ```APIDOC ## TimerMs::start ### Description Starts or resumes the timer. ### Signature `void start()` ``` -------------------------------- ### IRArgoACBase::begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Argo_8h_source.html Sets up hardware to be able to send a message. ```APIDOC ## IRArgoACBase::begin ### Description Sets up hardware to be able to send a message. ### Signature `void begin(void)` ``` -------------------------------- ### getTime Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Vestel_8h_source.html Gets the current time in minutes. ```APIDOC ## getTime ### Description Gets the current time in minutes. ### Method `uint16_t getTime(void) const;` ### Returns The current time in minutes. ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRToshibaAC-members.html Initializes the IR Toshiba AC object. ```APIDOC ## begin(void) ### Description Initializes the IR Toshiba AC object. This method should be called before using any other methods of the class. ### Method GET ``` -------------------------------- ### getRClevel Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/functions_g.html Gets the current RC level. ```APIDOC ## getRClevel ### Description Gets the current RC level from the IR receiver. ### Method N/A (This is a C++ method) ### Endpoint N/A ### Parameters None ### Response - **level** (int) - The current RC level. ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Argo_8h_source.html Initializes the IRArgoACBase object, preparing it for operation. ```APIDOC ## begin(void) ### Description Initializes the IRArgoACBase object. This should be called before sending any commands. ``` -------------------------------- ### getWifi Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRVoltas-members.html Gets the current Wi-Fi status. ```APIDOC ## getWifi ### Description Gets the current Wi-Fi status. ### Method getWifi(void) const ### Endpoint [Endpoint Path] ### Parameters None ### Request Example None ### Response #### Success Response (bool) - **wifi** (bool) - True if Wi-Fi is enabled, false otherwise. ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRDaikin128-members.html Initializes the IR transmission. ```APIDOC ## begin(void) ### Description Starts the IR transmission process. ``` -------------------------------- ### getModel Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRWhirlpoolAc-members.html Gets the model of the Whirlpool AC. ```APIDOC ## getModel(void) const ### Description Retrieves the model information of the Whirlpool AC. ### Method `getModel` ### Parameters None ### Returns The model of the Whirlpool AC. ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRHitachiAc3-members.html Initializes the IR transmission. ```APIDOC ## begin ### Description Initializes the IR transmission. ### Method void begin(void) ``` -------------------------------- ### getTime Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRVestelAc-members.html Gets the current time setting. ```APIDOC ## getTime ### Description Gets the current time setting. ### Method `getTime(void) const` ### Parameters None ### Returns - The current time setting. ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Delonghi_8h_source.html Initializes the IRDelonghiAc library. ```APIDOC ## void begin(void) ### Description Initializes the IRDelonghiAc library. This should be called before using other methods. ``` -------------------------------- ### getOnTime Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRVoltas-members.html Gets the current on timer setting. ```APIDOC ## getOnTime ### Description Gets the current on timer setting. ### Method getOnTime(void) const ### Endpoint [Endpoint Path] ### Parameters None ### Request Example None ### Response #### Success Response (uint16_t) - **time** (uint16_t) - The on timer setting in minutes. ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIREuromAc-members.html Initializes the Eurom AC control. ```APIDOC ## begin(void) ### Description Initializes the Eurom AC control. ### Method `IREuromAc::begin()` ``` -------------------------------- ### getIon Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRVestelAc-members.html Gets the current ionizer setting. ```APIDOC ## getIon ### Description Gets the current ionizer setting. ### Method `getIon(void) const` ### Parameters None ### Returns - True if the ionizer is on, false otherwise. ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/ir__Trotec_8h_source.html Initializes the Trotec ESP control. ```APIDOC ## begin ### Description Initializes the Trotec ESP control. ``` -------------------------------- ### getTempUnit() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRTechnibelAc-members.html Gets the current temperature unit. ```APIDOC ## getTempUnit() ### Description Gets the current temperature unit. ### Method `uint8_t getTempUnit(void) const` ``` -------------------------------- ### getSwing() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRTechnibelAc-members.html Gets the current swing state. ```APIDOC ## getSwing() ### Description Gets the current swing state. ### Method `bool getSwing(void) const` ``` -------------------------------- ### begin Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRSanyoAc88-members.html Initializes the Sanyo AC protocol handler. ```APIDOC ## begin(void) ### Description Initializes the Sanyo AC protocol handler. This method should be called before sending any commands. ### Method void ``` -------------------------------- ### IRSamsungAc::begin() Source: https://github.com/crankyoldgit/irremoteesp8266/blob/master/docs/doxygen/html/classIRSamsungAc.html Initializes the hardware necessary for sending IR messages. ```APIDOC ## begin() ### Description Set up hardware to be able to send a message. ### Method void ### Endpoint N/A (Method Call) ### Parameters None ### Request Example N/A ### Response N/A ```