Showing content from https://crankyoldgit.github.io/IRremoteESP8266/doxygen/html/classIRFujitsuAC.html below:
IRremoteESP8266: IRFujitsuAC Class Reference
Class for handling detailed Fujitsu A/C messages. More...
#include <ir_Fujitsu.h>
Collaboration diagram for IRFujitsuAC:
Private Member Functions void checkSum (void) Calculate and set the checksum values for the internal state. More...
bool updateUseLongOrShort (void) Update the length (size) of the state code for the current configuration. More...
void buildFromState (const uint16_t length) Build the internal state/config from the current (raw) A/C message. More...
void setOffSleepTimer (const uint16_t nr_mins) Set the Off/Sleep Timer time for the A/C. More...
Detailed Description
Class for handling detailed Fujitsu A/C messages.
Constructor & Destructor Documentation ◆ IRFujitsuAC()
Class Constructor.
-
Parameters
-
[in] pin GPIO to be used when sending. [in] model The enum for the model of A/C to be emulated. [in] inverted Is the output signal to be inverted? [in] use_modulation Is frequency modulation to be used?
Member Function Documentation ◆ begin() void IRFujitsuAC::begin ( void )
Set up hardware to be able to send a message.
◆ buildFromState() void IRFujitsuAC::buildFromState ( const uint16_t length ) private
Build the internal state/config from the current (raw) A/C message.
-
Parameters
-
[in] length Size of the current/used (raw) A/C message array.
◆ calibrate() int8_t IRFujitsuAC::calibrate ( void ) inline
Run the calibration to calculate uSec timing offsets for this platform.
-
Returns
-
The uSec timing offset needed per modulation of the IR Led.
-
Note
-
This will produce a 65ms IR signal pulse at 38kHz. Only ever needs to be run once per object instantiation, if at all.
◆ checkSum() void IRFujitsuAC::checkSum ( void ) private
Calculate and set the checksum values for the internal state.
◆ convertFan()
Convert a stdAc::fanspeed_t enum into it's native speed.
-
Parameters
-
[in] speed The enum to be converted.
-
Returns
-
The native equivalent of the enum.
◆ convertMode()
Convert a stdAc::opmode_t enum into its native mode.
-
Parameters
-
[in] mode The enum to be converted.
-
Returns
-
The native equivalent of the enum.
◆ get10CHeat() bool IRFujitsuAC::get10CHeat ( void ) const
Get the 10C heat status of the A/C.
-
Returns
-
true, the setting is on. false, the setting is off.
◆ getCelsius() bool IRFujitsuAC::getCelsius ( void ) const
Get the Clean mode status of the A/C.
-
Returns
-
true, the setting is on. false, the setting is off.
◆ getClean() bool IRFujitsuAC::getClean ( void ) const
Get the Clean mode status of the A/C.
-
Returns
-
true, the setting is on. false, the setting is off.
◆ getCmd() uint8_t IRFujitsuAC::getCmd ( void ) const
Set the requested (special) command part for the A/C message.
-
Returns
-
The special command code.
◆ getFanSpeed() uint8_t IRFujitsuAC::getFanSpeed ( void ) const
Get the current fan speed setting.
-
Returns
-
The current fan speed.
◆ getFilter() bool IRFujitsuAC::getFilter ( void ) const
Get the Filter mode status of the A/C.
-
Returns
-
true, the setting is on. false, the setting is off.
◆ getId() uint8_t IRFujitsuAC::getId ( void ) const
Get the current device's remote ID number.
-
Returns
-
The current device's remote ID number.
◆ getMode() uint8_t IRFujitsuAC::getMode ( void ) const
Get the operating mode setting of the A/C.
-
Returns
-
The current operating mode setting.
◆ getModel()
Get the currently emulated/detected model of the A/C.
-
Returns
-
The enum representing the model of A/C.
◆ getOffSleepTimer() uint16_t IRFujitsuAC::getOffSleepTimer ( void ) const
Get the Off/Sleep Timer setting of the A/C.
-
Returns
-
nr of minutes left on the timer. 0 means disabled/not supported.
◆ getOnTimer() uint16_t IRFujitsuAC::getOnTimer ( void ) const
Get the On Timer setting of the A/C.
-
Returns
-
nr of minutes left on the timer. 0 means disabled/not supported.
◆ getOutsideQuiet() bool IRFujitsuAC::getOutsideQuiet ( void ) const
Get the Outside Quiet mode status of the A/C.
-
Returns
-
true, the setting is on. false, the setting is off.
◆ getPower() bool IRFujitsuAC::getPower ( void ) const
Get the value of the current power setting.
-
Returns
-
true, the setting is on. false, the setting is off.
◆ getRaw() uint8_t * IRFujitsuAC::getRaw ( void )
Get a PTR to the internal state/code for this protocol.
-
Returns
-
PTR to a code for this protocol based on the current internal state.
◆ getStateLength() uint8_t IRFujitsuAC::getStateLength ( void )
Get the length (size) of the state code for the current configuration.
-
Returns
-
The length of the state array required for this config.
◆ getSwing() uint8_t IRFujitsuAC::getSwing ( void ) const
Get the requested swing operation mode of the A/C unit.
-
Returns
-
The contents of the swing state/mode.
◆ getTemp() float IRFujitsuAC::getTemp ( void ) const
Get the current temperature setting.
-
Returns
-
The current setting for temp. in degrees of the currently set units.
◆ getTimerType() uint8_t IRFujitsuAC::getTimerType ( void ) const
Get the Timer type of the A/C message.
-
Returns
-
The current timer type in numeric form.
◆ isLongCode() bool IRFujitsuAC::isLongCode ( void ) const
Is the current binary state representation a long or a short code?
-
Returns
-
true, if long; false, if short.
◆ off() void IRFujitsuAC::off ( void )
Set the requested power state of the A/C to off.
◆ on() void IRFujitsuAC::on ( void )
Set the requested power state of the A/C to on.
◆ send()
Send the current internal state as an IR message.
-
Parameters
-
[in] repeat Nr. of times the message will be repeated.
◆ set10CHeat() void IRFujitsuAC::set10CHeat ( const bool on )
Set the 10C heat status of the A/C.
-
Parameters
-
[in] on true, the setting is on. false, the setting is off.
◆ setCelsius() void IRFujitsuAC::setCelsius ( const bool on )
Set the Temperature units for the A/C.
-
Parameters
-
[in] on true, use Celsius. false, use Fahrenheit.
◆ setClean() void IRFujitsuAC::setClean ( const bool on )
Set the Clean mode of the A/C.
-
Parameters
-
[in] on true, the setting is on. false, the setting is off.
◆ setCmd() void IRFujitsuAC::setCmd ( const uint8_t cmd )
Set the requested (special) command part for the A/C message.
-
Parameters
-
[in] cmd The special command code.
◆ setFanSpeed() void IRFujitsuAC::setFanSpeed ( const uint8_t fanSpeed )
Set the speed of the fan.
-
Parameters
-
[in] fanSpeed The desired setting.
◆ setFilter() void IRFujitsuAC::setFilter ( const bool on )
Set the Filter mode status of the A/C.
-
Parameters
-
[in] on true, the setting is on. false, the setting is off.
◆ setId() void IRFujitsuAC::setId ( const uint8_t num )
Set the device's remote ID number.
-
Parameters
-
[in] num The ID for the remote. Valid number range is 0 to 3.
◆ setMode() void IRFujitsuAC::setMode ( const uint8_t mode )
Set the operating mode of the A/C.
-
Parameters
-
[in] mode The desired operating mode.
◆ setModel()
Set the currently emulated model of the A/C.
-
Parameters
-
[in] model An enum representing the model to support/emulate.
◆ setOffSleepTimer() void IRFujitsuAC::setOffSleepTimer ( const uint16_t nr_mins ) inlineprivate
Set the Off/Sleep Timer time for the A/C.
-
Parameters
-
[in] nr_mins Nr. of minutes to set the timer to. 0 means disabled.
◆ setOffTimer() void IRFujitsuAC::setOffTimer ( const uint16_t nr_mins )
Set the Off Timer time for the A/C.
-
Parameters
-
[in] nr_mins Nr. of minutes to set the timer to. 0 means disabled.
◆ setOnTimer() void IRFujitsuAC::setOnTimer ( const uint16_t nr_mins )
Set the On Timer setting of the A/C.
-
Parameters
-
[in] nr_mins Nr. of minutes to set the timer to. 0 means disabled.
◆ setOutsideQuiet() void IRFujitsuAC::setOutsideQuiet ( const bool on )
Set the Outside Quiet mode of the A/C.
-
Parameters
-
[in] on true, the setting is on. false, the setting is off.
◆ setPower() void IRFujitsuAC::setPower ( const bool on )
Change the power setting.
-
Parameters
-
[in] on true, the setting is on. false, the setting is off.
◆ setRaw() bool IRFujitsuAC::setRaw ( const uint8_t newState[], const uint16_t length )
Set the internal state from a valid code for this protocol.
-
Parameters
-
[in] newState A valid code for this protocol. [in] length Size of the newState array.
-
Returns
-
true, if successful; Otherwise false. (i.e. size check)
◆ setSleepTimer() void IRFujitsuAC::setSleepTimer ( const uint16_t nr_mins )
Set the Sleep Timer time for the A/C.
-
Parameters
-
[in] nr_mins Nr. of minutes to set the timer to. 0 means disabled.
◆ setSwing() void IRFujitsuAC::setSwing ( const uint8_t swingMode )
Set the requested swing operation mode of the A/C unit.
-
Parameters
-
[in] swingMode The swingMode code for the A/C. Vertical, Horizon, or Both. See constants for details.
-
Note
-
Not all models support all possible swing modes.
◆ setTemp() void IRFujitsuAC::setTemp ( const float temp, const bool useCelsius = true )
Set the temperature.
-
Parameters
-
[in] temp The temperature in degrees. [in] useCelsius Use Celsius or Fahrenheit?
◆ setTimerType() void IRFujitsuAC::setTimerType ( const uint8_t timertype )
Set the Timer type of the A/C message.
-
Parameters
-
[in] timertype The kind of timer to use for the message.
◆ stateReset() void IRFujitsuAC::stateReset ( void )
Reset the state of the remote to a known good state/sequence.
◆ stepHoriz() void IRFujitsuAC::stepHoriz ( void )
Request the A/C to step the Horizontal Swing.
◆ stepVert() void IRFujitsuAC::stepVert ( void )
Request the A/C to step the Vertical Swing.
◆ toCommon()
Convert the current internal state into its stdAc::state_t equivalent.
-
Parameters
-
[in] prev Ptr to a previous state.
-
Returns
-
The stdAc equivalent of the native settings.
◆ toCommonFanSpeed()
Convert a native fan speed into its stdAc equivalent.
-
Parameters
-
[in] speed The native setting to be converted.
-
Returns
-
The stdAc equivalent of the native setting.
◆ toCommonMode()
Convert a native mode into its stdAc equivalent.
-
Parameters
-
[in] mode The native setting to be converted.
-
Returns
-
The stdAc equivalent of the native setting.
◆ toggleSwingHoriz() void IRFujitsuAC::toggleSwingHoriz ( const bool update = true )
Request the A/C to toggle the Horizontal Swing mode.
-
Parameters
-
[in] update Do we need to update the general swing config?
◆ toggleSwingVert() void IRFujitsuAC::toggleSwingVert ( const bool update = true )
Request the A/C to toggle the Vertical Swing mode.
-
Parameters
-
[in] update Do we need to update the general swing config?
◆ toString() String IRFujitsuAC::toString ( void ) const
Convert the current internal state into a human readable string.
-
Returns
-
A human readable string.
◆ updateUseLongOrShort() bool IRFujitsuAC::updateUseLongOrShort ( void ) private
Update the length (size) of the state code for the current configuration.
-
Returns
-
true, if use long codes; false, use short codes.
◆ validChecksum() bool IRFujitsuAC::validChecksum ( uint8_t * state, const uint16_t length ) static
Verify the checksum is valid for a given state.
-
Parameters
-
[in] state The array to verify the checksum of. [in] length The length of the state array.
-
Returns
-
true, if the state has a valid checksum. Otherwise, false.
Member Data Documentation ◆ _ ◆ _cmd uint8_t IRFujitsuAC::_cmd private ◆ _irsend
Instance of the IR send class.
◆ _model ◆ _rawstatemodified bool IRFujitsuAC::_rawstatemodified private ◆ _state_length uint8_t IRFujitsuAC::_state_length private ◆ _state_length_short uint8_t IRFujitsuAC::_state_length_short private
The documentation for this class was generated from the following files:
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4