esphome::light::LightTraits Class Reference

This class is used to represent the capabilities of a light. More...

#include <light_traits.h>

Public Member Functions
	LightTraits ()=default
ColorModeMask	get_supported_color_modes () const
void	set_supported_color_modes (ColorModeMask supported_color_modes)
void	set_supported_color_modes (std::initializer_list< ColorMode > modes)
bool	supports_color_mode (ColorMode color_mode) const
bool	supports_color_capability (ColorCapability color_capability) const
float	get_min_mireds () const
void	set_min_mireds (float min_mireds)
float	get_max_mireds () const
void	set_max_mireds (float max_mireds)

Protected Attributes
float	min_mireds_ {0}
float	max_mireds_ {0}
ColorModeMask	supported_color_modes_ {}

Detailed Description

This class is used to represent the capabilities of a light.

Definition at line 17 of file light_traits.h.

Constructor & Destructor Documentation

LightTraits()

esphome::light::LightTraits::LightTraits ( )

default

Member Function Documentation

get_max_mireds()

float esphome::light::LightTraits::get_max_mireds ( ) const

inline

Definition at line 37 of file light_traits.h.

get_min_mireds()

float esphome::light::LightTraits::get_min_mireds ( ) const

inline

Definition at line 35 of file light_traits.h.

get_supported_color_modes()

ColorModeMask esphome::light::LightTraits::get_supported_color_modes ( ) const

inline

Definition at line 22 of file light_traits.h.

set_max_mireds()

void esphome::light::LightTraits::set_max_mireds ( float max_mireds )

inline

Definition at line 38 of file light_traits.h.

set_min_mireds()

void esphome::light::LightTraits::set_min_mireds ( float min_mireds )

inline

Definition at line 36 of file light_traits.h.

set_supported_color_modes() [1/2]

void esphome::light::LightTraits::set_supported_color_modes ( ColorModeMask supported_color_modes )

inline

Definition at line 23 of file light_traits.h.

set_supported_color_modes() [2/2]

void esphome::light::LightTraits::set_supported_color_modes ( std::initializer_list< ColorMode > modes )

inline

Definition at line 26 of file light_traits.h.

supports_color_capability()

bool esphome::light::LightTraits::supports_color_capability ( ColorCapability color_capability ) const

inline

Definition at line 31 of file light_traits.h.

supports_color_mode()

bool esphome::light::LightTraits::supports_color_mode ( ColorMode color_mode ) const

inline

Definition at line 30 of file light_traits.h.

Field Documentation

max_mireds_

float esphome::light::LightTraits::max_mireds_ {0}

protected

Definition at line 42 of file light_traits.h.

min_mireds_

float esphome::light::LightTraits::min_mireds_ {0}

protected

Definition at line 41 of file light_traits.h.

supported_color_modes_

ColorModeMask esphome::light::LightTraits::supported_color_modes_ {}

protected

Definition at line 43 of file light_traits.h.

---

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

• esphome/components/light/light_traits.h