#include <slow_pwm_output.h>

Inheritance diagram for esphome::slow_pwm::SlowPWMOutput:

Public Member Functions
void	set_pin (GPIOPin *pin)

void	set_period (unsigned int period)

void	set_restart_cycle_on_state_change (bool restart_cycle_on_state_change)

void	restart_cycle ()

void	setup () override
	Initialize pin. More...

void	dump_config () override

float	get_setup_priority () const override
	HARDWARE setup_priority. More...

Trigger *	get_turn_on_trigger ()

Trigger *	get_turn_off_trigger ()

Trigger< bool > *	get_state_change_trigger ()

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...

virtual void	update_frequency (float frequency)
	Set the frequency of the output for PWM outputs. 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
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 ()

bool	is_ready ()

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message="unspecified")

void	status_set_error (const char *message="unspecified")

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 Member Functions
void	loop () override

void	write_state (float state) override

void	set_output_state_ (bool state)
	turn on/off the configured output More...

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(uint8_t)> &&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(uint8_t)> &&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...

Protected Attributes
GPIOPin *	pin_ {nullptr}

std::unique_ptr< Trigger<> >	turn_on_trigger_ {nullptr}

std::unique_ptr< Trigger<> >	turn_off_trigger_ {nullptr}

std::unique_ptr< Trigger< bool > >	state_change_trigger_ {nullptr}

float	state_ {0}

bool	current_state_ {false}

unsigned int	period_start_time_ {0}

unsigned int	period_

bool	restart_cycle_on_state_change_

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}

Detailed Description

Definition at line 10 of file slow_pwm_output.h.

Member Function Documentation

◆ dump_config()

void esphome::slow_pwm::SlowPWMOutput::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 53 of file slow_pwm_output.cpp.

◆ get_setup_priority()

float esphome::slow_pwm::SlowPWMOutput::get_setup_priority ( ) const

inlineoverridevirtual

HARDWARE setup_priority.

Reimplemented from esphome::Component.

Definition at line 23 of file slow_pwm_output.h.

◆ get_state_change_trigger()

Trigger<bool>* esphome::slow_pwm::SlowPWMOutput::get_state_change_trigger ( )

inline

Definition at line 37 of file slow_pwm_output.h.

◆ get_turn_off_trigger()

Trigger* esphome::slow_pwm::SlowPWMOutput::get_turn_off_trigger ( )

inline

Definition at line 31 of file slow_pwm_output.h.

◆ get_turn_on_trigger()

Trigger* esphome::slow_pwm::SlowPWMOutput::get_turn_on_trigger ( )

inline

Definition at line 25 of file slow_pwm_output.h.

◆ loop()

void esphome::slow_pwm::SlowPWMOutput::loop ( )

overrideprotectedvirtual

Reimplemented from esphome::Component.

Definition at line 41 of file slow_pwm_output.cpp.

◆ restart_cycle()

void esphome::slow_pwm::SlowPWMOutput::restart_cycle ( )

inline

Definition at line 17 of file slow_pwm_output.h.

◆ set_output_state_()

void esphome::slow_pwm::SlowPWMOutput::set_output_state_ ( bool state )

protected

turn on/off the configured output

Definition at line 16 of file slow_pwm_output.cpp.

◆ set_period()

void esphome::slow_pwm::SlowPWMOutput::set_period ( unsigned int period )

inline

Definition at line 13 of file slow_pwm_output.h.

◆ set_pin()

void esphome::slow_pwm::SlowPWMOutput::set_pin ( GPIOPin * pin )

inline

Definition at line 12 of file slow_pwm_output.h.

◆ set_restart_cycle_on_state_change()

void esphome::slow_pwm::SlowPWMOutput::set_restart_cycle_on_state_change ( bool restart_cycle_on_state_change )

inline

Definition at line 14 of file slow_pwm_output.h.

◆ setup()

void esphome::slow_pwm::SlowPWMOutput::setup ( )

overridevirtual

Initialize pin.

Reimplemented from esphome::Component.

Definition at line 9 of file slow_pwm_output.cpp.

◆ write_state()

void esphome::slow_pwm::SlowPWMOutput::write_state ( float state )

overrideprotectedvirtual

Implements esphome::output::FloatOutput.

Definition at line 70 of file slow_pwm_output.cpp.

Field Documentation

◆ current_state_

bool esphome::slow_pwm::SlowPWMOutput::current_state_ {false}

protected

Definition at line 54 of file slow_pwm_output.h.

◆ period_

unsigned int esphome::slow_pwm::SlowPWMOutput::period_

protected

Definition at line 56 of file slow_pwm_output.h.

◆ period_start_time_

unsigned int esphome::slow_pwm::SlowPWMOutput::period_start_time_ {0}

protected

Definition at line 55 of file slow_pwm_output.h.

◆ pin_

GPIOPin* esphome::slow_pwm::SlowPWMOutput::pin_ {nullptr}

protected

Definition at line 49 of file slow_pwm_output.h.

◆ restart_cycle_on_state_change_

bool esphome::slow_pwm::SlowPWMOutput::restart_cycle_on_state_change_

protected

Definition at line 57 of file slow_pwm_output.h.

◆ state_

float esphome::slow_pwm::SlowPWMOutput::state_ {0}

protected

Definition at line 53 of file slow_pwm_output.h.

◆ state_change_trigger_

std::unique_ptr<Trigger<bool> > esphome::slow_pwm::SlowPWMOutput::state_change_trigger_ {nullptr}

protected

Definition at line 52 of file slow_pwm_output.h.

◆ turn_off_trigger_

std::unique_ptr<Trigger<> > esphome::slow_pwm::SlowPWMOutput::turn_off_trigger_ {nullptr}

protected

Definition at line 51 of file slow_pwm_output.h.

◆ turn_on_trigger_

std::unique_ptr<Trigger<> > esphome::slow_pwm::SlowPWMOutput::turn_on_trigger_ {nullptr}

protected

Definition at line 50 of file slow_pwm_output.h.

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

/opt/build/esphome/esphome/components/slow_pwm/slow_pwm_output.h
/opt/build/esphome/esphome/components/slow_pwm/slow_pwm_output.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ get_state_change_trigger()

◆ get_turn_off_trigger()

◆ get_turn_on_trigger()

◆ loop()

◆ restart_cycle()

◆ set_output_state_()

◆ set_period()

◆ set_pin()

◆ set_restart_cycle_on_state_change()

◆ setup()

◆ write_state()

Field Documentation

◆ current_state_

◆ period_

◆ period_start_time_

◆ pin_

◆ restart_cycle_on_state_change_

◆ state_

◆ state_change_trigger_

◆ turn_off_trigger_

◆ turn_on_trigger_