Colour Control Interface : Server side implementation. More...

#include <colour_control.h>

Inheritance diagram for HF::Interfaces::ColourControl::IServer:

Collaboration diagram for HF::Interfaces::ColourControl::IServer:

Public Member Functions
	IServer ()
	Constructor.

virtual	~IServer ()
	Destructor.

uint8_t	supported () const
	Get the supported modes bitmask for the Colour Control server. More...

void	supported (uint8_t __value)
	Set the supported modes bitmask for the Colour Control server. More...

uint8_t	mode () const
	Get the current active mode for the Colour Control server. More...

void	mode (uint8_t __value)
	Set the current mode for the Colour Control server. More...

HF::Attributes::IAttribute *	attribute (uint8_t uid)
	Return a pointer to the interface attribute with the given `uid`. More...

HF::Attributes::UIDS	attributes (uint8_t pack_id=HF::Attributes::Pack::MANDATORY) const
	Return a vector containing the attribute UIDs, for the given pack ID. More...

Events
virtual Common::Result	move_to_hue (const Protocol::Address &addr, const MoveToHueMessage &message)
	Callback that is called when a `ColourControl::MOVE_TO_HUE_CMD`, is received. More...

virtual Common::Result	move_hue (const Protocol::Address &addr, const MoveHueMessage &message)
	Callback that is called when a `ColourControl::MOVE_HUE_CMD`, is received. More...

virtual Common::Result	step_hue (const Protocol::Address &addr, const StepHueMessage &message)
	Callback that is called when a `ColourControl::STEP_HUE_CMD`, is received. More...

virtual Common::Result	move_to_saturation (const Protocol::Address &addr, const MoveToSaturationMessage &message)
	Callback that is called when a `ColourControl::MOVE_TO_SATURATION_CMD`, is received. More...

virtual Common::Result	move_saturation (const Protocol::Address &addr, const MoveSaturationMessage &message)
	Callback that is called when a `ColourControl::MOVE_SATURATION_CMD`, is received. More...

virtual Common::Result	step_saturation (const Protocol::Address &addr, const StepSaturationMessage &message)
	Callback that is called when a `ColourControl::STEP_SATURATION_CMD`, is received. More...

virtual Common::Result	move_to_hue_and_saturation (const Protocol::Address &addr, const MoveToHueSaturationMessage &message)
	Callback that is called when a `ColourControl::MOVE_TO_HUE_AND_SATURATION_CMD`, is received. More...

virtual Common::Result	move_to_xy (const Protocol::Address &addr, const MoveToXYMessage &message)
	Callback that is called when a `ColourControl::MOVE_TO_XY_CMD`, is received. More...

virtual Common::Result	move_xy (const Protocol::Address &addr, const MoveXYMessage &message)
	Callback that is called when a `ColourControl::MOVE_XY_CMD`, is received. More...

virtual Common::Result	step_xy (const Protocol::Address &addr, const StepXYMessage &message)
	Callback that is called when a `ColourControl::STEP_XY_CMD`, is received. More...

virtual Common::Result	move_to_colour_temperature (const Protocol::Address &addr, const MoveToTemperatureMessage &message)
	Callback that is called when a `ColourControl::MOVE_TO_COLOUR_TEMPERATURE_CMD`, is received. More...

Public Member Functions inherited from HF::Interfaces::InterfaceRole< ColourControl::Base, HF::Interface::SERVER_ROLE >
HF::Interface::Role	role () const
	Return the Interface::Role this interface implements. More...

Public Member Functions inherited from HF::Interfaces::Interface< HF::Interface::COLOUR_CONTROL >
uint16_t	uid () const
	This method returns the interface UID. More...

Public Member Functions inherited from HF::Interfaces::AbstractInterface
Common::Result	handle (Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset)
	Handle incoming messages from the network. More...

void	periodic (uint32_t time)
	Handle periodic processing. More...

Protected Member Functions
Common::Result	handle_command (Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset)
	Handle incoming messages from the network. More...

Protected Member Functions inherited from HF::Interfaces::ColourControl::Base
	Base ()
	Constructor.

Protected Member Functions inherited from HF::Interfaces::Interface< HF::Interface::COLOUR_CONTROL >
bool	check_uid (uint16_t uid) const

Protected Member Functions inherited from HF::Interfaces::AbstractInterface
virtual void	send (const Protocol::Address &addr, Protocol::Message &message)=0
	Send message `msg` to the network address given by `addr`. More...

virtual void	notify (const HF::Attributes::IAttribute &old_value, const HF::Attributes::IAttribute &new_value) const
	Notify that an attribute value as changed. More...

Common::Result	check (Protocol::Message &message, Common::ByteArray &payload, uint16_t offset)
	Check if message has correct attributes to be processed by the interface. More...

Common::Result	check_payload_size (Protocol::Message &message, Common::ByteArray &payload, uint16_t offset)
	Check if `payload` data size if sufficient for processing the `message`. More...

virtual uint16_t	payload_size (Protocol::Message &message) const
	Return the minimal payload size that should be present for the given message. More...

virtual uint16_t	payload_size (Protocol::Message::Interface &itf) const
	Return the minimal payload size that a message should hold when addressed at the given interface. More...

template<typename _Message >
uint16_t	payload_size_helper () const
	Helper function template to retrieve minimum size required for serializing/deserializing the class given. More...

virtual Common::Result	handle_attribute (Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset)
	Handle incoming messages from the network. More...

Protected Attributes
uint8_t	_supported
	Supported modes. More...

uint8_t	_mode
	Current Active Mode. More...

Additional Inherited Members
Public Types inherited from HF::Interface
enum	Role { CLIENT_ROLE = 0, SERVER_ROLE = 1 }
	Interface roles. More...

enum	UID { DEVICE_MANAGEMENT = 0x0001, BIND_MANAGEMENT = 0x0002, GROUP_MANAGEMENT = 0x0003, IDENTIFY = 0x0004, DEVICE_INFORMATION = 0x0005, ATTRIBUTE_REPORTING = 0x0006, BATCH_PROGRAM_MANAGEMENT = 0x0007, EVENT_SCHEDULING = 0x0008, WEEKLY_SCHEDULING = 0x0009, GROUP_TABLE = 0x000A, TAMPER_ALERT = 0x0101, TIME = 0x0102, POWER = 0x0110, KEEP_ALIVE = 0x0115, RSSI = 0x0111, SUOTA = 0x0400, ALERT = 0x0100, ON_OFF = 0x0200, LEVEL_CONTROL = 0x0201, COLOUR_CONTROL = 0x0202, SIMPLE_KEYPAD = 0x0203, SIMPLE_POWER_METER = 0x0300, SIMPLE_TEMPERATURE = 0x0301, SIMPLE_HUMIDITY = 0x0302, SIMPLE_THERMOSTAT = 0x0303, SIMPLE_BUTTON = 0x0304, SIMPLE_VISUAL_EFFECTS = 0x0305, SIMPLE_AIR_PRESSURE = 0x0306, SIMPLE_LIGHT_SENSOR = 0x0307, RESERVED = 0x7F00, MAX_UID = 0x7FFE, ANY_UID = 0x7FFF }
	Interfaces Unique Identifiers (UID). More...

Static Public Attributes inherited from HF::Interface
static constexpr uint8_t	MAX_CMD_ID = 0xFF
	Maximum value for command IDs in interfaces.

Detailed Description

Colour Control Interface : Server side implementation.

This class provides the server side of the Colour Control interface.

Definition at line 1236 of file colour_control.h.

Member Function Documentation

◆ attribute()

HF::Attributes::IAttribute* HF::Interfaces::ColourControl::IServer::attribute ( uint8_t uid )

virtual

Return a pointer to the interface attribute with the given uid.

Parameters

[in] uid identifier of the attribute in the interface.

Returns: a pointer to the attribute if it exists, nullptr otherwise.

Reimplemented from HF::Interfaces::AbstractInterface.

◆ attributes()

HF::Attributes::UIDS HF::Interfaces::ColourControl::IServer::attributes ( uint8_t pack_id = HF::Attributes::Pack::MANDATORY ) const

virtual

Return a vector containing the attribute UIDs, for the given pack ID.

Parameters

[in] pack_id the Attribute pack ID to get the attributes UIDs for.

Returns: vector containing the attributes UIDs.

Reimplemented from HF::Interfaces::AbstractInterface.

◆ handle_command()

Common::Result HF::Interfaces::ColourControl::IServer::handle_command	(	Protocol::Packet &	packet,
		Common::ByteArray &	payload,
		uint16_t	offset
	)

protectedvirtual

Handle incoming messages from the network.

Parameters

[in]	packet	the packet receive from the network.
[in]	payload	the byte array containing the data received from the network.
[in]	offset	the offset the payload start at in the byte array.

Returns: the result of the message processing.

Handle command request/response messages, i.e. :

Protocol::Message:Type::COMMAND_REQ;
Protocol::Message:Type::COMMAND_RESP_REQ;
Protocol::Message:Type::COMMAND_RES;

Reimplemented from HF::Interfaces::AbstractInterface.

◆ mode() [1/2]

uint8_t HF::Interfaces::ColourControl::IServer::mode ( ) const

Get the current active mode for the Colour Control server.

Returns: the current active mode.

◆ mode() [2/2]

void HF::Interfaces::ColourControl::IServer::mode ( uint8_t __value )

Set the current mode for the Colour Control server.

Parameters

[in] __value the current mode value to set the server to.

◆ move_hue()

virtual Common::Result HF::Interfaces::ColourControl::IServer::move_hue	(	const Protocol::Address &	addr,
		const MoveHueMessage &	message
	)

virtual

Callback that is called when a ColourControl::MOVE_HUE_CMD, is received.

Parameters

[in]	addr	the network address to send the message to.
[in]	message	the `MoveHueMessage` received.

Return values

Result::OK	if the request could be processed,
Result::FAIL_ARG	otherwise.

Reimplemented in HF::Interfaces::ColourControl::Server.

◆ move_saturation()

virtual Common::Result HF::Interfaces::ColourControl::IServer::move_saturation	(	const Protocol::Address &	addr,
		const MoveSaturationMessage &	message
	)

virtual

Callback that is called when a ColourControl::MOVE_SATURATION_CMD, is received.

Parameters

[in]	addr	the network address to send the message to.
[in]	message	the `MoveSaturationMessage` received.

Return values

Result::OK	if the request could be processed,
Result::FAIL_ARG	otherwise.

Reimplemented in HF::Interfaces::ColourControl::Server.

◆ move_to_colour_temperature()

virtual Common::Result HF::Interfaces::ColourControl::IServer::move_to_colour_temperature	(	const Protocol::Address &	addr,
		const MoveToTemperatureMessage &	message
	)

virtual

Callback that is called when a ColourControl::MOVE_TO_COLOUR_TEMPERATURE_CMD, is received.

Parameters

[in]	addr	the network address to send the message to.
[in]	message	the `MoveToTemperatureMessage` received.

Return values

Result::OK	if the request could be processed,
Result::FAIL_ARG	otherwise.

Reimplemented in HF::Interfaces::ColourControl::Server.

◆ move_to_hue()

virtual Common::Result HF::Interfaces::ColourControl::IServer::move_to_hue	(	const Protocol::Address &	addr,
		const MoveToHueMessage &	message
	)

virtual

Callback that is called when a ColourControl::MOVE_TO_HUE_CMD, is received.

Parameters

[in]	addr	the network address to send the message to.
[in]	message	the `MoveToHueMessage` received.

Return values

Result::OK	if the request could be processed,
Result::FAIL_ARG	otherwise.

Reimplemented in HF::Interfaces::ColourControl::Server.

◆ move_to_hue_and_saturation()

virtual Common::Result HF::Interfaces::ColourControl::IServer::move_to_hue_and_saturation	(	const Protocol::Address &	addr,
		const MoveToHueSaturationMessage &	message
	)

virtual

Callback that is called when a ColourControl::MOVE_TO_HUE_AND_SATURATION_CMD, is received.

Parameters

[in]	addr	the network address to send the message to.
[in]	message	the `MoveToHueSaturationMessage` received.

Return values

Result::OK	if the request could be processed,
Result::FAIL_ARG	otherwise.

Reimplemented in HF::Interfaces::ColourControl::Server.

◆ move_to_saturation()

virtual Common::Result HF::Interfaces::ColourControl::IServer::move_to_saturation	(	const Protocol::Address &	addr,
		const MoveToSaturationMessage &	message
	)

virtual

Callback that is called when a ColourControl::MOVE_TO_SATURATION_CMD, is received.

Parameters

[in]	addr	the network address to send the message to.
[in]	message	the `MoveToSaturationMessage` received.

Return values

Result::OK	if the request could be processed,
Result::FAIL_ARG	otherwise.

Reimplemented in HF::Interfaces::ColourControl::Server.

◆ move_to_xy()

virtual Common::Result HF::Interfaces::ColourControl::IServer::move_to_xy	(	const Protocol::Address &	addr,
		const MoveToXYMessage &	message
	)

virtual

Callback that is called when a ColourControl::MOVE_TO_XY_CMD, is received.

Parameters

[in]	addr	the network address to send the message to.
[in]	message	the `MoveToXYMessage` received.

Return values

Result::OK	if the request could be processed,
Result::FAIL_ARG	otherwise.

Reimplemented in HF::Interfaces::ColourControl::Server.

◆ move_xy()

virtual Common::Result HF::Interfaces::ColourControl::IServer::move_xy	(	const Protocol::Address &	addr,
		const MoveXYMessage &	message
	)

virtual

Callback that is called when a ColourControl::MOVE_XY_CMD, is received.

Parameters

[in]	addr	the network address to send the message to.
[in]	message	the `MoveXYMessage` received.

Return values

Result::OK	if the request could be processed,
Result::FAIL_ARG	otherwise.

Reimplemented in HF::Interfaces::ColourControl::Server.

◆ step_hue()

virtual Common::Result HF::Interfaces::ColourControl::IServer::step_hue	(	const Protocol::Address &	addr,
		const StepHueMessage &	message
	)

virtual

Callback that is called when a ColourControl::STEP_HUE_CMD, is received.

Parameters

[in]	addr	the network address to send the message to.
[in]	message	the `StepHueMessage` received.

Return values

Result::OK	if the request could be processed,
Result::FAIL_ARG	otherwise.

Reimplemented in HF::Interfaces::ColourControl::Server.

◆ step_saturation()

virtual Common::Result HF::Interfaces::ColourControl::IServer::step_saturation	(	const Protocol::Address &	addr,
		const StepSaturationMessage &	message
	)

virtual

Callback that is called when a ColourControl::STEP_SATURATION_CMD, is received.

Parameters

[in]	addr	the network address to send the message to.
[in]	message	the `StepSaturationMessage` received.

Return values

Result::OK	if the request could be processed,
Result::FAIL_ARG	otherwise.

Reimplemented in HF::Interfaces::ColourControl::Server.

◆ step_xy()

virtual Common::Result HF::Interfaces::ColourControl::IServer::step_xy	(	const Protocol::Address &	addr,
		const StepXYMessage &	message
	)

virtual

Callback that is called when a ColourControl::STEP_XY_CMD, is received.

Parameters

[in]	addr	the network address to send the message to.
[in]	message	the `StepXYMessage` received.

Return values

Result::OK	if the request could be processed,
Result::FAIL_ARG	otherwise.

Reimplemented in HF::Interfaces::ColourControl::Server.

◆ supported() [1/2]

uint8_t HF::Interfaces::ColourControl::IServer::supported ( ) const

Get the supported modes bitmask for the Colour Control server.

Returns: the supported modes bitmask.

◆ supported() [2/2]

void HF::Interfaces::ColourControl::IServer::supported ( uint8_t __value )

Set the supported modes bitmask for the Colour Control server.

Parameters

[in] __value the supported modes bitmask value to set the server to.

Field Documentation

◆ _mode

uint8_t HF::Interfaces::ColourControl::IServer::_mode

protected

Current Active Mode.

Definition at line 1241 of file colour_control.h.

◆ _supported

uint8_t HF::Interfaces::ColourControl::IServer::_supported

protected

Supported modes.

Definition at line 1240 of file colour_control.h.

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

colour_control.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ attribute()

◆ attributes()

◆ handle_command()

◆ mode() [1/2]

◆ mode() [2/2]

◆ move_hue()

◆ move_saturation()

◆ move_to_colour_temperature()

◆ move_to_hue()

◆ move_to_hue_and_saturation()

◆ move_to_saturation()

◆ move_to_xy()

◆ move_xy()

◆ step_hue()

◆ step_saturation()

◆ step_xy()

◆ supported() [1/2]

◆ supported() [2/2]

Field Documentation

◆ _mode

◆ _supported