hueplusplus  1.0.0
Public Member Functions | List of all members
hueplusplus::SimpleColorTemperatureStrategy Class Reference

Class implementing the functions of ColorTemperatureStrategy. More...

#include <hueplusplus/SimpleColorTemperatureStrategy.h>

+ Inheritance diagram for hueplusplus::SimpleColorTemperatureStrategy:
+ Collaboration diagram for hueplusplus::SimpleColorTemperatureStrategy:

Public Member Functions

bool setColorTemperature (unsigned int mired, uint8_t transition, Light &light) const override
 Function for changing a lights color temperature in mired with a specified transition. More...
 
bool alertTemperature (unsigned int mired, Light &light) const override
 Function that lets the light perform one breath cycle in the specified color. More...
 
unsigned int getColorTemperature (Light &light) const override
 Function that returns the current color temperature of the light. More...
 
unsigned int getColorTemperature (const Light &light) const override
 Function that returns the current color temperature of the light. More...
 
- Public Member Functions inherited from hueplusplus::ColorTemperatureStrategy
virtual ~ColorTemperatureStrategy ()=default
 Virtual dtor. More...
 

Detailed Description

Class implementing the functions of ColorTemperatureStrategy.

Member Function Documentation

◆ alertTemperature()

bool hueplusplus::SimpleColorTemperatureStrategy::alertTemperature ( unsigned int  mired,
Light light 
) const
overridevirtual

Function that lets the light perform one breath cycle in the specified color.

It uses this_thread::sleep_for to accomodate for the time an Light::alert() needs The color temperature in mired ranges from 153 to 500 whereas 153 is cold and 500 is warm.

Parameters
miredThe color temperature in mired
lightA reference of the light

Implements hueplusplus::ColorTemperatureStrategy.

◆ getColorTemperature() [1/2]

unsigned int hueplusplus::SimpleColorTemperatureStrategy::getColorTemperature ( Light light) const
overridevirtual

Function that returns the current color temperature of the light.

Updates the lights state by calling refreshState() The color temperature in mired ranges from 153 to 500 whereas 153 is cold and 500 is warm.

Parameters
lightA reference of the light
Returns
Unsigned int representing the color temperature in mired

Implements hueplusplus::ColorTemperatureStrategy.

◆ getColorTemperature() [2/2]

unsigned int hueplusplus::SimpleColorTemperatureStrategy::getColorTemperature ( const Light light) const
overridevirtual

Function that returns the current color temperature of the light.

The color temperature in mired ranges from 153 to 500 whereas 153 is cold and 500 is warm.

Note
This does not update the lights state
Parameters
lightA const reference of the light
Returns
Unsigned int representing the color temperature in mired

Implements hueplusplus::ColorTemperatureStrategy.

◆ setColorTemperature()

bool hueplusplus::SimpleColorTemperatureStrategy::setColorTemperature ( unsigned int  mired,
uint8_t  transition,
Light light 
) const
overridevirtual

Function for changing a lights color temperature in mired with a specified transition.

The color temperature in mired ranges from 153 to 500 whereas 153 is cold and 500 is warm.

Parameters
miredThe color temperature in mired
transitionThe time it takes to fade to the new color in multiples of 100ms, 4 = 400ms and should be seen as the default
lightA reference of the light

Implements hueplusplus::ColorTemperatureStrategy.


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