ESPHome  2022.11.3
Public Member Functions | Protected Attributes
esphome::ledc::LEDCOutput Class Reference

#include <ledc_output.h>

Inheritance diagram for esphome::ledc::LEDCOutput:
esphome::output::FloatOutput esphome::Component esphome::output::BinaryOutput

Public Member Functions

 LEDCOutput (InternalGPIOPin *pin)
 
void set_channel (uint8_t channel)
 
void set_frequency (float frequency)
 
void update_frequency (float frequency) override
 Dynamically change frequency at runtime. More...
 
void setup () override
 Setup LEDC. More...
 
void dump_config () override
 
float get_setup_priority () const override
 HARDWARE setup priority. More...
 
void write_state (float state) override
 Override FloatOutput's write_state. More...
 
- Public Member Functions inherited from esphome::output::FloatOutput
void set_max_power (float max_power)
 Set the maximum power output of this component. More...
 
void set_min_power (float min_power)
 Set the minimum power output of this component. More...
 
void set_zero_means_zero (bool zero_means_zero)
 Sets this output to ignore min_power for a 0 state. More...
 
void set_level (float state)
 Set the level of this float output, this is called from the front-end. More...
 
float get_max_power () const
 Get the maximum power output. More...
 
float get_min_power () const
 Get the minimum power output. More...
 
- Public Member Functions inherited from esphome::output::BinaryOutput
void set_inverted (bool inverted)
 Set the inversion state of this binary output. More...
 
void set_power_supply (power_supply::PowerSupply *power_supply)
 Use this to connect up a power supply to this output. More...
 
virtual void set_state (bool state)
 Enable or disable this binary output. More...
 
virtual void turn_on ()
 Enable this binary output. More...
 
virtual void turn_off ()
 Disable this binary output. More...
 
bool is_inverted () const
 Return whether this binary output is inverted. More...
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Attributes

InternalGPIOPinpin_
 
uint8_t channel_ {}
 
uint8_t bit_depth_ {}
 
float frequency_ {}
 
float duty_ {0.0f}
 
bool initialized_ = false
 
- Protected Attributes inherited from esphome::output::FloatOutput
float max_power_ {1.0f}
 
float min_power_ {0.0f}
 
bool zero_means_zero_
 
- Protected Attributes inherited from esphome::output::BinaryOutput
bool inverted_ {false}
 
power_supply::PowerSupplyRequester power_ {}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::output::FloatOutput
void write_state (bool state) override
 Implement BinarySensor's write_enabled; this should never be called. More...
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Detailed Description

Definition at line 16 of file ledc_output.h.

Constructor & Destructor Documentation

◆ LEDCOutput()

esphome::ledc::LEDCOutput::LEDCOutput ( InternalGPIOPin pin)
inlineexplicit

Definition at line 18 of file ledc_output.h.

Member Function Documentation

◆ dump_config()

void esphome::ledc::LEDCOutput::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 117 of file ledc_output.cpp.

◆ get_setup_priority()

float esphome::ledc::LEDCOutput::get_setup_priority ( ) const
inlineoverridevirtual

HARDWARE setup priority.

Reimplemented from esphome::Component.

Definition at line 29 of file ledc_output.h.

◆ set_channel()

void esphome::ledc::LEDCOutput::set_channel ( uint8_t  channel)
inline

Definition at line 20 of file ledc_output.h.

◆ set_frequency()

void esphome::ledc::LEDCOutput::set_frequency ( float  frequency)
inline

Definition at line 21 of file ledc_output.h.

◆ setup()

void esphome::ledc::LEDCOutput::setup ( )
overridevirtual

Setup LEDC.

Reimplemented from esphome::Component.

Definition at line 78 of file ledc_output.cpp.

◆ update_frequency()

void esphome::ledc::LEDCOutput::update_frequency ( float  frequency)
overridevirtual

Dynamically change frequency at runtime.

Reimplemented from esphome::output::FloatOutput.

Definition at line 124 of file ledc_output.cpp.

◆ write_state()

void esphome::ledc::LEDCOutput::write_state ( float  state)
overridevirtual

Override FloatOutput's write_state.

Implements esphome::output::FloatOutput.

Definition at line 53 of file ledc_output.cpp.

Field Documentation

◆ bit_depth_

uint8_t esphome::ledc::LEDCOutput::bit_depth_ {}
protected

Definition at line 37 of file ledc_output.h.

◆ channel_

uint8_t esphome::ledc::LEDCOutput::channel_ {}
protected

Definition at line 36 of file ledc_output.h.

◆ duty_

float esphome::ledc::LEDCOutput::duty_ {0.0f}
protected

Definition at line 39 of file ledc_output.h.

◆ frequency_

float esphome::ledc::LEDCOutput::frequency_ {}
protected

Definition at line 38 of file ledc_output.h.

◆ initialized_

bool esphome::ledc::LEDCOutput::initialized_ = false
protected

Definition at line 40 of file ledc_output.h.

◆ pin_

InternalGPIOPin* esphome::ledc::LEDCOutput::pin_
protected

Definition at line 35 of file ledc_output.h.


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