colour_control.h File Reference

This file contains the definitions for the Colour Control interface. More...

#include "hanfun/protocol.h"
#include "hanfun/interface.h"

Include dependency graph for colour_control.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	HF::Interfaces::ColourControl::HS_Colour
	Helper class that supports the Hue and Saturation colour mode. More...
struct	HF::Interfaces::ColourControl::XY_Colour
	Helper class that supports the XY colour mode. More...
struct	HF::Interfaces::ColourControl::Supported
	Helper class to handle the Supported attribute for the Colour Control interface. More...
struct	HF::Interfaces::ColourControl::Mode
	Helper class to handle the Mode attribute for the Colour Control interface. More...
struct	HF::Interfaces::ColourControl::HueAndSaturation
	Helper class to handle the Hue And Saturation attribute for the Colour Control interface. More...
struct	HF::Interfaces::ColourControl::Xy
	Helper class to handle the XY attribute for the Colour Control interface. More...
struct	HF::Interfaces::ColourControl::ColourTemperature
	Helper class to handle the Colour Temperature attribute for the Colour Control interface. More...
struct	HF::Interfaces::ColourControl::MoveToHueMessage
	Move to Hue message class. More...
struct	HF::Interfaces::ColourControl::MoveHueMessage
	Move Hue Message class. More...
struct	HF::Interfaces::ColourControl::StepHueMessage
	Step Hue Message class. More...
struct	HF::Interfaces::ColourControl::MoveToSaturationMessage
	Move to Saturation Message class. More...
struct	HF::Interfaces::ColourControl::MoveSaturationMessage
	Move Saturation Message class. More...
struct	HF::Interfaces::ColourControl::StepSaturationMessage
	Step Saturation Message class. More...
struct	HF::Interfaces::ColourControl::MoveToHueSaturationMessage
	Move to Hue and Saturation Message class. More...
struct	HF::Interfaces::ColourControl::MoveToXYMessage
	Move to XY Message class. More...
struct	HF::Interfaces::ColourControl::MoveXYMessage
	Move XY Message class. More...
struct	HF::Interfaces::ColourControl::StepXYMessage
	Step XY Message class. More...
struct	HF::Interfaces::ColourControl::MoveToTemperatureMessage
	Move to Colour Temperature Message class. More...
struct	HF::Interfaces::ColourControl::Base
	Colour Control Interface : Parent. More...
struct	HF::Interfaces::ColourControl::ITransition
	Interface API for the Transitions. More...
struct	HF::Interfaces::ColourControl::Hue_Transition
	Hue Transition. More...
struct	HF::Interfaces::ColourControl::Saturation_Transition
	Saturation Transition. More...
struct	HF::Interfaces::ColourControl::HS_Transition
	Hue and Saturation Transition. More...
struct	HF::Interfaces::ColourControl::XY_Transition
	XY Transition. More...
struct	HF::Interfaces::ColourControl::XY_Transition_Continuous
	XY Transition. More...
struct	HF::Interfaces::ColourControl::Temperature_Transition
	Colour Temperature Transition. More...
class	HF::Interfaces::ColourControl::IServer
	Colour Control Interface : Server side implementation. More...
struct	HF::Interfaces::ColourControl::Server
	Colour Control Interface : Server side implementation. More...
struct	HF::Interfaces::ColourControl::Client
	Colour Control Interface : Client side implementation. More...

Namespaces
	HF
	Top-level namespace for the HAN-FUN library.
	HF::Interfaces
	This is the top-level namespace for the implemented Interfaces.
	HF::Interfaces::ColourControl
	This namespace contains the implementation of the Colour Control interface.

Enumerations
enum	HF::Interfaces::ColourControl::CMD {   HF::Interfaces::ColourControl::MOVE_TO_HUE_CMD = 0x01, HF::Interfaces::ColourControl::MOVE_HUE_CMD = 0x02, HF::Interfaces::ColourControl::STEP_HUE_CMD = 0x03, HF::Interfaces::ColourControl::MOVE_TO_SATURATION_CMD = 0x04,   HF::Interfaces::ColourControl::MOVE_SATURATION_CMD = 0x05, HF::Interfaces::ColourControl::STEP_SATURATION_CMD = 0x06, HF::Interfaces::ColourControl::MOVE_TO_HUE_AND_SATURATION_CMD = 0x07, HF::Interfaces::ColourControl::MOVE_TO_XY_CMD = 0x08,   HF::Interfaces::ColourControl::MOVE_XY_CMD = 0x09, HF::Interfaces::ColourControl::STEP_XY_CMD = 0x0a, HF::Interfaces::ColourControl::MOVE_TO_COLOUR_TEMPERATURE_CMD = 0x0b, HF::Interfaces::ColourControl::STOP_CMD = 0x0c }
	Command IDs. More...
enum	HF::Interfaces::ColourControl::Attributes {   HF::Interfaces::ColourControl::SUPPORTED_ATTR = 0x01, HF::Interfaces::ColourControl::MODE_ATTR = 0x02, HF::Interfaces::ColourControl::HUE_AND_SATURATION_ATTR = 0x03, HF::Interfaces::ColourControl::XY_ATTR = 0x04,   HF::Interfaces::ColourControl::COLOUR_TEMPERATURE_ATTR = 0x05 }
	Attributes. More...
enum	HF::Interfaces::ColourControl::Mask : uint8_t { HF::Interfaces::ColourControl::HS_MODE = 0x01, HF::Interfaces::ColourControl::XY_MODE = 0x02, HF::Interfaces::ColourControl::TEMPERATURE_MODE = 0x04 }
	Mask elements for Colour Modes. More...
enum	HF::Interfaces::ColourControl::Direction : uint8_t
	Direction of movement.

Functions
HF::Attributes::IAttribute *	HF::Interfaces::create_attribute (ColourControl::IServer *server, uint8_t uid)
	Create an attribute object that can hold the attribute with the given uid. More...
HF::Attributes::IAttribute *	HF::Interfaces::ColourControl::create_attribute (uint8_t uid)
	Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::ColourControl::Server *,uint8_t) More...
std::ostream &	operator<< (std::ostream &stream, const HF::Interfaces::ColourControl::CMD command)
	Convert the given command into a string and write it to the given stream. More...
std::ostream &	operator<< (std::ostream &stream, const HF::Interfaces::ColourControl::Attributes attribute)
	Convert the given attribute into a string and write it to the given stream. More...

Detailed Description

This file contains the definitions for the Colour Control interface.

Version

1.5.3

Copyright

Copyright ©   2017 ULE Alliance

For licensing information, please see the file 'LICENSE' in the root folder.

Initial development by Bithium S.A. [http://www.bithium.com]

Definition in file colour_control.h.