SUOTA Interfaces::Interface : Client side implementation. More...

#include <suota.h>

Inheritance diagram for HF::Core::SUOTA::Client:

Collaboration diagram for HF::Core::SUOTA::Client:

Public Member Functions
Commands
void	upgrade_complete (const Protocol::Address &addr, UpgradeStatus::Code status, std::string version="")
	Send a HAN-FUN message containing a `SUOTA::UPGRADE_COMPLETE_CMD`, to the given network address. More...

void	upgrade_complete (UpgradeStatus::Code status, std::string version="")
	Send a HAN-FUN message containing a `SUOTA::UPGRADE_COMPLETE_CMD`, to the broadcast network address. More...

Events
virtual NewVersionResponse	new_version_available (const Protocol::Address &addr, const Version &version)
	Callback that is called when a `SUOTA::NEW_VERSION_AVAILABLE_CMD`, is received. More...

virtual void	check_version (const Protocol::Address &addr, const CheckVersionResponse &response)
	Callback that is called when a response to a `SUOTA::CHECK_VERSION_CMD`, is received. More...

Public Member Functions inherited from HF::Core::ServiceRole< SUOTA::Base, HF::Interface::CLIENT_ROLE >
Interface::Role	role () const
	Return the Interface::Role this interface implements. More...

Public Member Functions inherited from HF::Core::Service< HF::Interface::SUOTA >
uint16_t	uid () const
	This method returns the interface UID. 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...

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::Core::ServiceRole< SUOTA::Base, HF::Interface::CLIENT_ROLE >
	ServiceRole (Unit0 &unit)
	Constructor. More...

Protected Member Functions inherited from HF::Core::SUOTA::Base
	Base (HF::Core::Unit0 &unit0)
	Constructor.

Protected Member Functions inherited from HF::Core::Service< HF::Interface::SUOTA >
	Service (Unit0 &unit)
	Constructor. More...

bool	check_uid (uint16_t uid) const
	Check if the given `uid` value matches the service's `UID` value. 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...

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

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.

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

Detailed Description

SUOTA Interfaces::Interface : Client side implementation.

This class provides the client side of the SUOTA interface.

Definition at line 401 of file suota.h.

Member Function Documentation

◆ check_version()

virtual void HF::Core::SUOTA::Client::check_version	(	const Protocol::Address &	addr,
		const CheckVersionResponse &	response
	)

virtual

Callback that is called when a response to a SUOTA::CHECK_VERSION_CMD, is received.

Parameters

[in]	addr	the network address the message was received from.
[in]	response	the response received.

◆ handle_command()

Common::Result HF::Core::SUOTA::Client::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.

◆ new_version_available()

virtual NewVersionResponse HF::Core::SUOTA::Client::new_version_available	(	const Protocol::Address &	addr,
		const Version &	version
	)

virtual

Callback that is called when a SUOTA::NEW_VERSION_AVAILABLE_CMD, is received.

Warning: by default this method simply returns NewVersionResponse::FAIL_UNKNOWN

Note: Implementing classes should override this method to actually do something.

Parameters

[in]	addr	the network address the message was received from.
[in]	version	the version parameters for the command.

Returns: the response code for the command.

See also: NewVersionResponse

◆ upgrade_complete() [1/2]

void HF::Core::SUOTA::Client::upgrade_complete	(	const Protocol::Address &	addr,
		UpgradeStatus::Code	status,
		std::string	version = `""`
	)

Send a HAN-FUN message containing a SUOTA::UPGRADE_COMPLETE_CMD, to the given network address.

Parameters

[in]	addr	the network address to send the message to.
[in]	status	upgrade operation status.
[in]	version	version of the new software.

Referenced by upgrade_complete().

Here is the caller graph for this function:

◆ upgrade_complete() [2/2]

void HF::Core::SUOTA::Client::upgrade_complete	(	UpgradeStatus::Code	status,
		std::string	version = `""`
	)

inline

Send a HAN-FUN message containing a SUOTA::UPGRADE_COMPLETE_CMD, to the broadcast network address.

Parameters

[in]	status	upgrade operation status.
[in]	version	version of the new software.

Definition at line 452 of file suota.h.

References upgrade_complete().

             {
                Protocol::Address addr;
                upgrade_complete(addr, status, version);
             }

Here is the call graph for this function:

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

suota.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ check_version()

◆ handle_command()

◆ new_version_available()

◆ upgrade_complete() [1/2]

◆ upgrade_complete() [2/2]