Infrared4Arduino 1.2.3
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
IrSenderPwmHard Class Reference

Sending function using timer PWM. More...

#include <IrSenderPwmHard.h>

Inheritance diagram for IrSenderPwmHard:
Inheritance graph
[legend]
Collaboration diagram for IrSenderPwmHard:
Collaboration graph
[legend]

Public Member Functions

 IrSenderPwmHard (pin_t outputPin=Board::getInstance() ->defaultPwmPin())
 
virtual ~IrSenderPwmHard ()
 
- Public Member Functions inherited from IrSender
pin_t getPin () const
 
virtual ~IrSender ()
 
virtual void send (const IrSequence &irSequence, frequency_t frequency=IrSignal::defaultFrequency, dutycycle_t dutyCycle=Board::defaultDutyCycle)
 Sends an IrSequence with the prescribed frequency. More...
 
void sendIrSignal (const IrSignal &irSignal, unsigned int noSends=1)
 Sends the IrSignal given as argument the prescribed number of times. More...
 
void sendWhile (const IrSignal &irSignal, bool(*trigger)())
 Send an IrSignal, when and as long as trigger() returns true. More...
 
void mute ()
 Force output pin inactive. More...
 

Static Public Member Functions

static IrSenderPwmHardgetInstance (bool create=false, pin_t ouputPin=Board::getInstance() ->defaultPwmPin())
 Returns a pointer to the instance, or nullptr if not initialized. More...
 
static IrSenderPwmHardnewInstance (pin_t ouputPin=Board::getInstance() ->defaultPwmPin())
 Creates a new instance (if not existing) and returns it. More...
 
static void deleteInstance ()
 
- Static Public Member Functions inherited from IrSenderPwm
static unsigned int getDutyCycle ()
 
static IrSenderPwmgetInstance (bool create=false, pin_t outputPin=Board::getInstance() ->defaultPwmPin())
 Returns a pointer to the instance, or nullptr if not initialized. More...
 
static IrSenderPwmnewInstance (pin_t outputPin)
 Creates a new instance (if not existing) and returns it. More...
 
static void deleteInstance ()
 

Additional Inherited Members

- Protected Member Functions inherited from IrSenderPwm
 IrSenderPwm (pin_t sendPin)
 
virtual ~IrSenderPwm ()
 
- Protected Member Functions inherited from IrSender
void writeHigh ()
 
void writeLow ()
 
 IrSender (pin_t pin)
 
virtual void enable (frequency_t frequency, dutycycle_t dutyCycle=Board::defaultDutyCycle)=0
 
virtual void sendSpace (microseconds_t time)
 
virtual void sendMark (microseconds_t time)=0
 
- Static Protected Member Functions inherited from IrSender
static void barfForInvalidPin (pin_t sendPin __attribute__((unused)))
 

Detailed Description

Sending function using timer PWM.

Due to the nature of the timers, this is a Highlander, ("There can only be one"), so the class is a singleton class, with private constructor, a factory method that enforces the "highlander property".

Definition at line 33 of file IrSenderPwmHard.h.

Constructor & Destructor Documentation

◆ IrSenderPwmHard()

IrSenderPwmHard::IrSenderPwmHard ( pin_t  outputPin = Board::getInstance()->defaultPwmPin())

Definition at line 26 of file IrSenderPwmHard.cpp.

◆ ~IrSenderPwmHard()

IrSenderPwmHard::~IrSenderPwmHard ( )
virtual

Definition at line 29 of file IrSenderPwmHard.cpp.

Member Function Documentation

◆ deleteInstance()

static void IrSenderPwmHard::deleteInstance ( )
inlinestatic

Definition at line 60 of file IrSenderPwmHard.h.

◆ getInstance()

IrSenderPwmHard * IrSenderPwmHard::getInstance ( bool  create = false,
pin_t  ouputPin = Board::getInstance()->defaultPwmPin() 
)
static

Returns a pointer to the instance, or nullptr if not initialized.

If argument true, in the latter case creates a new instance and returns it.

Definition at line 40 of file IrSenderPwmHard.cpp.

◆ newInstance()

IrSenderPwmHard * IrSenderPwmHard::newInstance ( pin_t  ouputPin = Board::getInstance()->defaultPwmPin())
static

Creates a new instance (if not existing) and returns it.

Returns nullptr if an instance already exists.

Definition at line 33 of file IrSenderPwmHard.cpp.


The documentation for this class was generated from the following files: