ESPHome  2022.1.2
Public Member Functions | Protected Attributes
esphome::graph::Graph Class Reference

#include <graph.h>

Inheritance diagram for esphome::graph::Graph:
esphome::Component

Public Member Functions

void draw (display::DisplayBuffer *buff, uint16_t x_offset, uint16_t y_offset, Color color)
 
void draw_legend (display::DisplayBuffer *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 ()
 
- 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

uint32_t duration_
 
uint32_t width_
 in seconds More...
 
uint32_t height_
 in pixels More...
 
float min_value_ {NAN}
 in pixels More...
 
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_
 
GraphLegendlegend_ {nullptr}
 
friend GraphLegend
 
- 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::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 133 of file graph.h.

Member Function Documentation

◆ add_legend()

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

Definition at line 153 of file graph.h.

◆ add_trace()

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

Definition at line 152 of file graph.h.

◆ draw()

void esphome::graph::Graph::draw ( display::DisplayBuffer 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 59 of file graph.cpp.

◆ draw_legend()

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

Plot border

Definition at line 299 of file graph.cpp.

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 355 of file graph.cpp.

◆ get_duration()

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

Definition at line 157 of file graph.h.

◆ get_height()

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

Definition at line 159 of file graph.h.

◆ get_setup_priority()

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

Reimplemented from esphome::Component.

Definition at line 139 of file graph.h.

◆ get_width()

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

Definition at line 158 of file graph.h.

◆ set_border()

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

Definition at line 151 of file graph.h.

◆ set_duration()

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

Definition at line 142 of file graph.h.

◆ set_grid_x()

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

Definition at line 149 of file graph.h.

◆ set_grid_y()

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

Definition at line 150 of file graph.h.

◆ set_height()

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

Definition at line 144 of file graph.h.

◆ set_max_range()

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

Definition at line 148 of file graph.h.

◆ set_max_value()

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

Definition at line 146 of file graph.h.

◆ set_min_range()

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

Definition at line 147 of file graph.h.

◆ set_min_value()

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

Definition at line 145 of file graph.h.

◆ set_width()

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

Definition at line 143 of file graph.h.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 349 of file graph.cpp.

Field Documentation

◆ border_

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

Definition at line 171 of file graph.h.

◆ duration_

uint32_t esphome::graph::Graph::duration_
protected

Definition at line 162 of file graph.h.

◆ GraphLegend

friend esphome::graph::Graph::GraphLegend
protected

Definition at line 175 of file graph.h.

◆ gridspacing_x_

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

Definition at line 169 of file graph.h.

◆ gridspacing_y_

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

Definition at line 170 of file graph.h.

◆ height_

uint32_t esphome::graph::Graph::height_
protected

in pixels

Definition at line 164 of file graph.h.

◆ legend_

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

Definition at line 173 of file graph.h.

◆ max_range_

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

Definition at line 168 of file graph.h.

◆ max_value_

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

Definition at line 166 of file graph.h.

◆ min_range_

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

Definition at line 167 of file graph.h.

◆ min_value_

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

in pixels

Definition at line 165 of file graph.h.

◆ traces_

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

Definition at line 172 of file graph.h.

◆ width_

uint32_t esphome::graph::Graph::width_
protected

in seconds

Definition at line 163 of file graph.h.


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