#include <graph.h>

Inheritance diagram for esphome::graph::Graph:

Public Member Functions
void	draw (display::Display *buff, uint16_t x_offset, uint16_t y_offset, Color color)

void	draw_legend (display::Display *buff, uint16_t x_offset, uint16_t y_offset, Color color)

void	setup () override

float	get_setup_priority () const override

void	dump_config () override

void	set_duration (uint32_t duration)

void	set_width (uint32_t width)

void	set_height (uint32_t height)

void	set_min_value (float val)

void	set_max_value (float val)

void	set_min_range (float val)

void	set_max_range (float val)

void	set_grid_x (float val)

void	set_grid_y (float val)

void	set_border (bool val)

void	add_trace (GraphTrace *trace)

void	add_legend (GraphLegend *legend)

uint32_t	get_duration ()

uint32_t	get_width ()

uint32_t	get_height ()

float	get_graph_limit_min ()

float	get_graph_limit_max ()

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

virtual void	mark_failed ()
	Mark this component as failed.

	ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error ()

	ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

void	set_component_source (const LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Attributes
uint32_t	duration_

uint32_t	width_
	in seconds

uint32_t	height_
	in pixels

float	graph_limit_min_ {NAN}
	in pixels

float	graph_limit_max_ {NAN}

float	min_value_ {NAN}

float	max_value_ {NAN}

float	min_range_ {1.0}

float	max_range_ {NAN}

float	gridspacing_x_ {NAN}

float	gridspacing_y_ {NAN}

bool	border_ {true}

std::vector< GraphTrace * >	traces_

GraphLegend *	legend_ {nullptr}

friend	GraphLegend

Protected Attributes inherited from esphome::Component
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Additional Inherited Members
Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

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.

void	set_retry (const char *name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

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.

bool	cancel_retry (const char *name)

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Detailed Description

Definition at line 137 of file graph.h.

Member Function Documentation

◆ add_legend()

void esphome::graph::Graph::add_legend ( GraphLegend * legend )

inline

Definition at line 157 of file graph.h.

◆ add_trace()

void esphome::graph::Graph::add_trace ( GraphTrace * trace )

inline

Definition at line 156 of file graph.h.

◆ draw()

void esphome::graph::Graph::draw	(	display::Display *	buff,
		uint16_t	x_offset,
		uint16_t	y_offset,
		Color	color )

Plot border

Determine best y-axis scale and range

Draw grid

Draw traces

Definition at line 56 of file graph.cpp.

◆ draw_legend()

void esphome::graph::Graph::draw_legend	(	display::Display *	buff,
		uint16_t	x_offset,
		uint16_t	y_offset,
		Color	color )

Plot border

Definition at line 335 of file graph.cpp.

◆ dump_config()

void esphome::graph::Graph::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 390 of file graph.cpp.

◆ get_duration()

uint32_t esphome::graph::Graph::get_duration ( )

inline

Definition at line 161 of file graph.h.

◆ get_graph_limit_max()

float esphome::graph::Graph::get_graph_limit_max ( )

inline

Definition at line 165 of file graph.h.

◆ get_graph_limit_min()

float esphome::graph::Graph::get_graph_limit_min ( )

inline

Definition at line 164 of file graph.h.

◆ get_height()

uint32_t esphome::graph::Graph::get_height ( )

inline

Definition at line 163 of file graph.h.

◆ get_setup_priority()

float esphome::graph::Graph::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 143 of file graph.h.

◆ get_width()

uint32_t esphome::graph::Graph::get_width ( )

inline

Definition at line 162 of file graph.h.

◆ set_border()

void esphome::graph::Graph::set_border ( bool val )

inline

Definition at line 155 of file graph.h.

◆ set_duration()

void esphome::graph::Graph::set_duration ( uint32_t duration )

inline

Definition at line 146 of file graph.h.

◆ set_grid_x()

void esphome::graph::Graph::set_grid_x ( float val )

inline

Definition at line 153 of file graph.h.

◆ set_grid_y()

void esphome::graph::Graph::set_grid_y ( float val )

inline

Definition at line 154 of file graph.h.

◆ set_height()

void esphome::graph::Graph::set_height ( uint32_t height )

inline

Definition at line 148 of file graph.h.

◆ set_max_range()

void esphome::graph::Graph::set_max_range ( float val )

inline

Definition at line 152 of file graph.h.

◆ set_max_value()

void esphome::graph::Graph::set_max_value ( float val )

inline

Definition at line 150 of file graph.h.

◆ set_min_range()

void esphome::graph::Graph::set_min_range ( float val )

inline

Definition at line 151 of file graph.h.

◆ set_min_value()

void esphome::graph::Graph::set_min_value ( float val )

inline

Definition at line 149 of file graph.h.

◆ set_width()

void esphome::graph::Graph::set_width ( uint32_t width )

inline

Definition at line 147 of file graph.h.

◆ setup()

void esphome::graph::Graph::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 384 of file graph.cpp.

Field Documentation

◆ border_

bool esphome::graph::Graph::border_ {true}

protected

Definition at line 179 of file graph.h.

◆ duration_

uint32_t esphome::graph::Graph::duration_

protected

Definition at line 168 of file graph.h.

◆ graph_limit_max_

float esphome::graph::Graph::graph_limit_max_ {NAN}

protected

Definition at line 172 of file graph.h.

◆ graph_limit_min_

float esphome::graph::Graph::graph_limit_min_ {NAN}

protected

in pixels

Definition at line 171 of file graph.h.

◆ GraphLegend

friend esphome::graph::Graph::GraphLegend

protected

Definition at line 183 of file graph.h.

◆ gridspacing_x_

float esphome::graph::Graph::gridspacing_x_ {NAN}

protected

Definition at line 177 of file graph.h.

◆ gridspacing_y_

float esphome::graph::Graph::gridspacing_y_ {NAN}

protected

Definition at line 178 of file graph.h.

◆ height_

uint32_t esphome::graph::Graph::height_

protected

in pixels

Definition at line 170 of file graph.h.

◆ legend_

GraphLegend* esphome::graph::Graph::legend_ {nullptr}

protected

Definition at line 181 of file graph.h.

◆ max_range_

float esphome::graph::Graph::max_range_ {NAN}

protected

Definition at line 176 of file graph.h.

◆ max_value_

float esphome::graph::Graph::max_value_ {NAN}

protected

Definition at line 174 of file graph.h.

◆ min_range_

float esphome::graph::Graph::min_range_ {1.0}

protected

Definition at line 175 of file graph.h.

◆ min_value_

float esphome::graph::Graph::min_value_ {NAN}

protected

Definition at line 173 of file graph.h.

◆ traces_

std::vector<GraphTrace *> esphome::graph::Graph::traces_

protected

Definition at line 180 of file graph.h.

◆ width_

uint32_t esphome::graph::Graph::width_

protected

in seconds

Definition at line 169 of file graph.h.

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

esphome/components/graph/graph.h
esphome/components/graph/graph.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add_legend()

◆ add_trace()

◆ draw()

◆ draw_legend()

◆ dump_config()

◆ get_duration()

◆ get_graph_limit_max()

◆ get_graph_limit_min()

◆ get_height()

◆ get_setup_priority()

◆ get_width()

◆ set_border()

◆ set_duration()

◆ set_grid_x()

◆ set_grid_y()

◆ set_height()

◆ set_max_range()

◆ set_max_value()

◆ set_min_range()

◆ set_min_value()

◆ set_width()

◆ setup()

Field Documentation

◆ border_

◆ duration_

◆ graph_limit_max_

◆ graph_limit_min_

◆ GraphLegend

◆ gridspacing_x_

◆ gridspacing_y_

◆ height_

◆ legend_

◆ max_range_

◆ max_value_

◆ min_range_

◆ min_value_

◆ traces_

◆ width_