Attribute Reporting - Server Role. More...

#include <attribute_reporting.h>

Inheritance diagram for HF::Core::AttributeReporting::Server:

Collaboration diagram for HF::Core::AttributeReporting::Server:

Public Member Functions
	Server (Unit0 &unit)
	Constructor. More...

virtual Common::Result	handle (const Report::Periodic::CreateMessage &message)
	Handle a create periodic rule command. More...

virtual Common::Result	handle (const Report::Periodic::AddEntryMessage &message)
	Handle an add periodic entries message. More...

virtual Common::Result	handle (const Report::Event::CreateMessage &message)
	Handle a create event rule command. More...

virtual Common::Result	handle (const Report::Event::AddEntryMessage &message)
	Handle an add event entries message. More...

virtual Common::Result	handle (const Report::DeleteMessage &message)
	Handle a delete rule request. More...

virtual Common::Result	handle (const Report::UpdateIntervalMessage &message)
	Handle a update periodic report interval request. More...

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

void	notify (uint8_t unit, const HF::Attributes::IAttribute &old_value, const HF::Attributes::IAttribute &new_value)
	Process an attribute change from `old_value` to `new_value` for the given `unit`. More...

uint16_t	count (Type type) const
	Get the number of rules for the given `type`. More...

Public Member Functions inherited from HF::Core::AttributeReporting::IServer
	IServer (Unit0 &unit)
	Constructor. More...

uint16_t	uid () const
	This method returns the interface UID. More...

Interface::Role	role () const
	Return the Interface::Role this interface implements. 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...

Public Member Functions inherited from HF::Core::AbstractService
Unit0 &	unit () const
	The device this unit is associated with.

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...

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...

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

Data Fields
Common::SimpleList< Periodic::Rule >	periodic_rules
	Periodic rules. More...

Common::SimpleList< Event::Rule >	event_rules
	Event rules. More...

Protected Member Functions
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...

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::Core::AttributeReporting::IServer
void	response (Protocol::Packet &packet, Reference &report, Common::Result result)
	Send the response to a command with the given `result`. More...

virtual bool	authorized (uint8_t member, Protocol::Address &source)
	Check if the given command is authorized for the device with the given address. More...

bool	check_uid (uint16_t uid) const
	Check if the given UID matches the interface UID. More...

Protected Member Functions inherited from HF::Core::AbstractService
	AbstractService (Unit0 &unit)
	Constructor. More...

void	send (const Protocol::Address &addr, Protocol::Message &message)
	Send message `msg` to the network address given by `addr`. More...

void	send (const Protocol::Address &addr, Protocol::Message &message, Transport::Link *link)
	Create and send a new packet with the given message to the given address. More...

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

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

Protected Attributes
uint32_t	last_time
	Last time the periodic function was called.

Protected Attributes inherited from HF::Core::AbstractService
Unit0 &	_unit
	Reference to the unit the service belongs to.

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

Attribute Reporting - Server Role.

Definition at line 1691 of file attribute_reporting.h.

Constructor & Destructor Documentation

◆ Server()

HF::Core::AttributeReporting::Server::Server ( Unit0 & unit )

inline

Constructor.

Parameters

[in] unit reference to the unit containing this service.

Definition at line 1701 of file attribute_reporting.h.

                                :
                IServer(unit), last_time(0)
             {}

Member Function Documentation

◆ count()

uint16_t HF::Core::AttributeReporting::Server::count ( Type type ) const

virtual

Get the number of rules for the given type.

Parameters

[in] type attribute reporting type to get the number of rules for.

Returns: number of rules for the given type.

Reimplemented from HF::Core::AttributeReporting::IServer.

◆ handle() [1/6]

virtual Common::Result HF::Core::AttributeReporting::Server::handle ( const Report::Periodic::CreateMessage & message )

virtual

Handle a create periodic rule command.

Parameters

[in] message create periodic rule message.

Return values

HF::Common::Result::FAIL_RESOURCES	if the rule could not be created.
HF::Common::Result::OK	if the rule was created.

◆ handle() [2/6]

virtual Common::Result HF::Core::AttributeReporting::Server::handle ( const Report::Periodic::AddEntryMessage & message )

virtual

Handle an add periodic entries message.

Parameters

message add periodic entries message with the entries to add.

Return values

Common::Result::FAIL_ARG	if the rule cannot be found.
Common::Result::OK	if the entries where added.

◆ handle() [3/6]

virtual Common::Result HF::Core::AttributeReporting::Server::handle ( const Report::Event::CreateMessage & message )

virtual

Handle a create event rule command.

Parameters

[in] message create event rule message.

Return values

HF::Common::Result::FAIL_RESOURCES	if the rule could not be created.
HF::Common::Result::OK	if the rule was created.

◆ handle() [4/6]

virtual Common::Result HF::Core::AttributeReporting::Server::handle ( const Report::Event::AddEntryMessage & message )

virtual

Handle an add event entries message.

Parameters

message add event entries message with the entries to add.

Return values

Common::Result::FAIL_ARG	if the rule cannot be found.
Common::Result::OK	if the entries where added.

◆ handle() [5/6]

virtual Common::Result HF::Core::AttributeReporting::Server::handle ( const Report::DeleteMessage & message )

virtual

Handle a delete rule request.

Parameters

[in] message delete rule request message.

Return values

Common::Result::FAIL_ARG	if the rule cannot be found.
Common::Result::OK	if the rule was deleted.

◆ handle() [6/6]

virtual Common::Result HF::Core::AttributeReporting::Server::handle ( const Report::UpdateIntervalMessage & message )

virtual

Handle a update periodic report interval request.

Parameters

[in] message update interval request message.

Return values

Common::Result::FAIL_ARG	if the rule cannot be found.
Common::Result::OK	if the rule was deleted.

◆ handle_command()

Common::Result HF::Core::AttributeReporting::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::Core::AttributeReporting::IServer.

◆ notify()

void HF::Core::AttributeReporting::Server::notify	(	uint8_t	unit,
		const HF::Attributes::IAttribute &	old_value,
		const HF::Attributes::IAttribute &	new_value
	)

virtual

Process an attribute change from old_value to new_value for the given unit.

This method checks if the change in the given attribute matches the conditions present in any of the attribute reporting rules.

Parameters

[in]	unit	unit ID where the attribute is present.
[in]	old_value	old value for the attribute.
[in]	new_value	new value for the attribute.

Reimplemented from HF::Core::AttributeReporting::IServer.

◆ payload_size()

uint16_t HF::Core::AttributeReporting::Server::payload_size ( Protocol::Message::Interface & itf ) const

protectedvirtual

Return the minimal payload size that a message should hold when addressed at the given interface.

Parameters

[in] itf the interface being address.

Returns: the minimum number of bytes for the message for the interface.

Reimplemented from HF::Interfaces::AbstractInterface.

◆ periodic()

void HF::Core::AttributeReporting::Server::periodic ( uint32_t time )

virtual

Handle periodic processing.

Parameters

[in] time current system clock value in seconds.

Implements HF::Interface.

Field Documentation

◆ event_rules

Common::SimpleList<Event::Rule> HF::Core::AttributeReporting::Server::event_rules

Event rules.

Definition at line 1694 of file attribute_reporting.h.

◆ periodic_rules

Common::SimpleList<Periodic::Rule> HF::Core::AttributeReporting::Server::periodic_rules

Periodic rules.

Definition at line 1693 of file attribute_reporting.h.

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

attribute_reporting.h

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Server()

Member Function Documentation

◆ count()

◆ handle() [1/6]

◆ handle() [2/6]

◆ handle() [3/6]

◆ handle() [4/6]

◆ handle() [5/6]

◆ handle() [6/6]

◆ handle_command()

◆ notify()

◆ payload_size()

◆ periodic()

Field Documentation

◆ event_rules

◆ periodic_rules