Detailed Description

The light capabilities.

This is the capabilities of the light, not the current state.

Definition at line 14 of file LightCapabilities.h.

#include <LightCapabilities.h>

Public Member Functions
	LightCapabilities ()
	Default constructor.

	LightCapabilities (uint16_t minDimLevel, uint16_t maxLumen, uint16_t minColorTemperature, uint16_t maxColorTemperature)
	Constructor.

String	toJson () const
	Convert the light capabilities to a JSON string.

Public Attributes
uint16_t	minDimLevel
	The minimum value that the bri attribute can be set to.

uint16_t	maxLumen
	The maximum value that the bri attribute can be set to.

char	colorGamutType
	The color gamut type, this is the closest matching gamut type as provided by the Philips Hue documentation.

XYPoint	colorGamut [3]
	The color gamut of the light, this is the closest matching gamut as provided by the Philips Hue documentation.

uint16_t	minColorTemperature
	The minimum and maximum mired color temperature the light is capable of.

uint16_t	maxColorTemperature
	The minimum and maximum mired color temperature the light is capable of.

bool	certified = false
	Whether the light is "certified" by Philips.

bool	streamingRenderer = true
	Whether the light supports streaming renderer.

bool	streamingProxy = false
	Whether the light supports streaming proxy.

Constructor & Destructor Documentation

◆ LightCapabilities() [1/2]

LightCapabilities::LightCapabilities ( )

Default constructor.

This will set the default values for the light capabilities.

Definition at line 7 of file LightCapabilities.cpp.

◆ LightCapabilities() [2/2]

LightCapabilities::LightCapabilities	(	uint16_t	minDimLevel,
		uint16_t	maxLumen,
		uint16_t	minColorTemperature,
		uint16_t	maxColorTemperature
	)

Constructor.

This will set the values for the light capabilities.

Parameters

minDimLevel	The minimum value that the bri attribute can be set to.
maxLumen	The maximum value that the bri attribute can be set to.
minColorTemperature	The minimum value that the ct attribute can be set to.
maxColorTemperature	The maximum value that the ct attribute can be set to.

Definition at line 12 of file LightCapabilities.cpp.

Member Function Documentation

◆ toJson()

String LightCapabilities::toJson ( ) const

Convert the light capabilities to a JSON string.

Definition at line 23 of file LightCapabilities.cpp.

Member Data Documentation

◆ certified

bool LightCapabilities::certified = false

Whether the light is "certified" by Philips.

Definition at line 96 of file LightCapabilities.h.

◆ colorGamut

XYPoint LightCapabilities::colorGamut[3]

The color gamut of the light, this is the closest matching gamut as provided by the Philips Hue documentation.

The gamut types are A, B and C. The CIE color space consists of three primary colors (red, green and blue), each having its own x and y coordinate. The color gamut describes the total colors that can be created using these three primary colors. The color gamut is defined by three points, one for each primary color. The color gamut of a light can be found by analyzing the three primary colors of the light. The CIE color space is a cartesian coordinate system, where x represents the amount of green and y represents the amount of red. The color gamut of a light can be found by analyzing the three primary colors of the light. The CIE color space is a cartesian coordinate system, where x represents the amount of green and y represents the amount of red.

json key: colorgamut

Definition at line 77 of file LightCapabilities.h.

◆ colorGamutType

char LightCapabilities::colorGamutType

The color gamut type, this is the closest matching gamut type as provided by the Philips Hue documentation.

The gamut types are A, B and C. The CIE color space consists of three primary colors (red, green and blue), each having its own x and y coordinate. The color gamut describes the total colors that can be created using these three primary colors. The color gamut is defined by three points, one for each primary color. The color gamut of a light can be found by analyzing the three primary colors of the light. The CIE color space is a cartesian coordinate system, where x represents the amount of green and y represents the amount of red. The color gamut of a light can be found by analyzing the three primary colors of the light. The CIE color space is a cartesian coordinate system, where x represents the amount of green and y represents the amount of red.

json key: colorgamuttype

Definition at line 62 of file LightCapabilities.h.

◆ maxColorTemperature

uint16_t LightCapabilities::maxColorTemperature

The minimum and maximum mired color temperature the light is capable of.

json key: ct.max

Definition at line 91 of file LightCapabilities.h.

◆ maxLumen

uint16_t LightCapabilities::maxLumen

The maximum value that the bri attribute can be set to.

This is the maximum that the light is capable of.

json key: maxlumen

Definition at line 47 of file LightCapabilities.h.

◆ minColorTemperature

uint16_t LightCapabilities::minColorTemperature

The minimum and maximum mired color temperature the light is capable of.

json key: ct.min

Definition at line 84 of file LightCapabilities.h.

◆ minDimLevel

uint16_t LightCapabilities::minDimLevel

The minimum value that the bri attribute can be set to.

This is the minimum that the light is capable of, note, a brightness of 1 is not off.

json key: mindimlevel

Definition at line 39 of file LightCapabilities.h.

◆ streamingProxy

bool LightCapabilities::streamingProxy = false

Whether the light supports streaming proxy.

Definition at line 106 of file LightCapabilities.h.

◆ streamingRenderer

bool LightCapabilities::streamingRenderer = true

Whether the light supports streaming renderer.

Definition at line 101 of file LightCapabilities.h.

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

/home/runner/work/fauxmoESP/fauxmoESP/src/LightCapabilities.h
/home/runner/work/fauxmoESP/fauxmoESP/src/LightCapabilities.cpp