58 lines
2.3 KiB
C++
58 lines
2.3 KiB
C++
/**
|
|
\file SimpleBrightnessStrategy.h
|
|
Copyright Notice\n
|
|
Copyright (C) 2017 Jan Rogall - developer\n
|
|
Copyright (C) 2017 Moritz Wirger - developer\n
|
|
|
|
This file is part of hueplusplus.
|
|
|
|
hueplusplus is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU Lesser General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
hueplusplus is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
|
along with hueplusplus. If not, see <http://www.gnu.org/licenses/>.
|
|
**/
|
|
|
|
#ifndef INCLUDE_HUEPLUSPLUS_SIMPLE_BRIGHTNESS_STRATEGY_H
|
|
#define INCLUDE_HUEPLUSPLUS_SIMPLE_BRIGHTNESS_STRATEGY_H
|
|
|
|
#include "BrightnessStrategy.h"
|
|
#include "Light.h"
|
|
|
|
namespace hueplusplus
|
|
{
|
|
//! Class implementing the functions of BrightnessStrategy
|
|
class SimpleBrightnessStrategy : public BrightnessStrategy
|
|
{
|
|
public:
|
|
//! \brief Function for changing a lights brightness with a specified
|
|
//! transition.
|
|
//!
|
|
//! \param bri The brightness raning from 0 = off to 255 = fully lit
|
|
//! \param transition The time it takes to fade to the new brightness in
|
|
//! multiples of 100ms, 4 = 400ms and should be seen as the default \param
|
|
//! light A reference of the light
|
|
bool setBrightness(unsigned int bri, uint8_t transition, Light& light) const override;
|
|
//! \brief Function that returns the current brightness of the light
|
|
//!
|
|
//! Updates the lights state by calling refreshState()
|
|
//! \param light A reference of the light
|
|
//! \return Unsigned int representing the brightness
|
|
unsigned int getBrightness(Light& light) const override;
|
|
//! \brief Function that returns the current brightness of the light
|
|
//!
|
|
//! \note This does not update the lights state
|
|
//! \param light A const reference of the light
|
|
//! \return Unsigned int representing the brightness
|
|
unsigned int getBrightness(const Light& light) const override;
|
|
};
|
|
} // namespace hueplusplus
|
|
|
|
#endif
|