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

#include <level_control.h>

Inheritance diagram for HF::Interfaces::LevelControl::Server:

Collaboration diagram for HF::Interfaces::LevelControl::Server:

Public Member Functions
	Server ()
	Constructor.

uint8_t	level ()
	Getter for the current level. More...

void	level (uint8_t new_level)
	Setter for the server level. More...

void	level (float new_level)
	Setter for the server level (unsigned float). 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 void	level_change (Protocol::Address &source, uint8_t old_level, uint8_t new_level)
	Callback for a `SET_ATTR_REQ` or `SET_LEVEL_CMD` message, when the level value is changed. More...

Public Member Functions inherited from HF::Interfaces::InterfaceRole< LevelControl::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::LEVEL_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_attribute (Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset)
	Handle incoming messages from the network. More...

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::LevelControl::Base
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...

void	check_and_fix (float &value)
	Make sure level percentage values is in range [0,100]. More...

void	check_and_fix (int16_t &value)
	Make sure level percentage values is in range [0,255]. More...

Protected Member Functions inherited from HF::Interfaces::Interface< HF::Interface::LEVEL_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...

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

Protected Attributes
uint8_t	_level
	Current level value.

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

Level Control Interface : Server side implementation.

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

Remarks

The _level attribute represents the level value in percentage in the [0,255] range, i.e., the 0 == 0% and the 255 == 100%.

Use the overloaded level functions with float attributes to send the values in the [0,100] range and have them converted into the proper range.

Definition at line 208 of file level_control.h.

Member Function Documentation

◆ attribute()

HF::Attributes::IAttribute* HF::Interfaces::LevelControl::Server::attribute ( uint8_t uid )

inlinevirtual

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.

Definition at line 310 of file level_control.h.

References HF::Interfaces::create_attribute(), and HF::Interfaces::Interface< HF::Interface::LEVEL_CONTROL >::uid().

             {
                return Interfaces::create_attribute(this, uid);
             }

Here is the call graph for this function:

◆ attributes()

HF::Attributes::UIDS HF::Interfaces::LevelControl::Server::attributes ( uint8_t pack_id = HF::Attributes::Pack::MANDATORY ) const

inlinevirtual

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.

Definition at line 315 of file level_control.h.

References HF::Interfaces::LevelControl::LEVEL_ATTR, and UNUSED.

             {
                UNUSED(pack_id);
                /* *INDENT-OFF* */
                return HF::Attributes::UIDS ({ LevelControl::LEVEL_ATTR });
                /* *INDENT-ON* */
             }

◆ handle_attribute()

Common::Result HF::Interfaces::LevelControl::Server::handle_attribute	(	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 attributes request/response messages, i.e. :

Protocol::Message:Type::GET_ATTR_REQ;
Protocol::Message:Type::SET_ATTR_REQ;
Protocol::Message:Type::SET_ATTR_RESP_REQ;
Protocol::Message:Type::GET_ATTR_PACK_REQ;
Protocol::Message:Type::SET_ATTR_PACK_REQ;
Protocol::Message:Type::SET_ATTR_PACK_RESP_REQ;

Reimplemented from HF::Interfaces::AbstractInterface.

◆ handle_command()

Common::Result HF::Interfaces::LevelControl::Server::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.

◆ level() [1/3]

uint8_t HF::Interfaces::LevelControl::Server::level ( )

Getter for the current level.

Returns: the current level.

◆ level() [2/3]

void HF::Interfaces::LevelControl::Server::level ( uint8_t new_level )

Setter for the server level.

Parameters

[in] new_level the new level value to use.

◆ level() [3/3]

void HF::Interfaces::LevelControl::Server::level ( float new_level )

Setter for the server level (unsigned float).

Remarks: This method converts the given new_level percentage value in the range of [0,100] to the range used by the interface [0-255].

Parameters

[in] new_level the new level value to use.

◆ level_change()

virtual void HF::Interfaces::LevelControl::Server::level_change	(	Protocol::Address &	source,
		uint8_t	old_level,
		uint8_t	new_level
	)

virtual

Callback for a SET_ATTR_REQ or SET_LEVEL_CMD message, when the level value is changed.

Remarks: When this method is called the attribute has already been updated to the new value.

Parameters

[in]	source	device address the change was received from.
[in]	old_level	the old level value to used.
[in]	new_level	the new level value to use.

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

level_control.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ attribute()

◆ attributes()

◆ handle_attribute()

◆ handle_command()

◆ level() [1/3]

◆ level() [2/3]

◆ level() [3/3]

◆ level_change()