This module contains the classes that define and implement the On-Off interface API. More...

Collaboration diagram for On-Off:

Data Structures
struct	HF::Interfaces::OnOff::State
	Helper class to handle the State attribute for the On-Off interface. More...

struct	HF::Interfaces::OnOff::Base
	On-Off Interface : Parent. More...

class	HF::Interfaces::OnOff::Server
	On-Off Interface : Server side implementation. More...

struct	HF::Interfaces::OnOff::Client
	On-Off Interface : Client side implementation. More...

Enumerations
enum	HF::Interfaces::OnOff::CMD { HF::Interfaces::OnOff::ON_CMD = 0x01, HF::Interfaces::OnOff::OFF_CMD = 0x02, HF::Interfaces::OnOff::TOGGLE_CMD = 0x03 }
	Command IDs. More...

enum	HF::Interfaces::OnOff::Attributes { HF::Interfaces::OnOff::STATE_ATTR = 0x01 }
	Attributes. More...

Functions
HF::Attributes::IAttribute *	HF::Interfaces::create_attribute (OnOff::Server *server, uint8_t uid)
	Create an attribute object that can hold the attribute with the given `uid`. More...

HF::Attributes::IAttribute *	HF::Interfaces::OnOff::create_attribute (uint8_t uid)
	Create an attribute object that can hold the attribute with the given `uid`. (HF::Interfaces::OnOff::Server *,uint8_t) More...

std::ostream &	operator<< (std::ostream &stream, const HF::Interfaces::OnOff::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::OnOff::Attributes attribute)
	Convert the given `attribute` into a string and write it to the given `stream`. More...

Detailed Description

This module contains the classes that define and implement the On-Off interface API.

Enumeration Type Documentation

◆ Attributes

enum HF::Interfaces::OnOff::Attributes

Attributes.

Enumerator
STATE_ATTR	State attribute UID.

Definition at line 71 of file on_off.h.

          {
             STATE_ATTR    = 0x01, 
             __LAST_ATTR__ = STATE_ATTR,
          } Attributes;

◆ CMD

enum HF::Interfaces::OnOff::CMD

Command IDs.

Enumerator
ON_CMD	On Command ID.
OFF_CMD	Off Command ID.
TOGGLE_CMD	Toggle Command ID.

Definition at line 62 of file on_off.h.

          {
             ON_CMD       = 0x01, 
             OFF_CMD      = 0x02, 
             TOGGLE_CMD   = 0x03, 
             __LAST_CMD__ = TOGGLE_CMD,
          } CMD;

Function Documentation

◆ create_attribute() [1/2]

HF::Attributes::IAttribute* HF::Interfaces::create_attribute	(	OnOff::Server *	server,
		uint8_t	uid
	)

Create an attribute object that can hold the attribute with the given uid.

If server is not equal to nullptr then initialize it with the current value.

Parameters

[in]	server	pointer to the object to read the current value from.
[in]	uid	attribute's UID to create the attribute object for.

Returns: pointer to an attribute object or nullptr if the attribute UID does not exist.

◆ create_attribute() [2/2]

HF::Attributes::IAttribute* HF::Interfaces::OnOff::create_attribute ( uint8_t uid )

inline

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::OnOff::Server *,uint8_t)

See also: HF::Interfaces::create_attribute (HF::Interfaces::OnOff::Server *,uint8_t)

Parameters

[in] uid attribute UID to create the attribute object for.

Return values

pointer	to an attribute object
<tt>nullptr</tt>	if the attribute UID does not exist.

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::OnOff::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::LevelControl::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::ColourControl::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::Alert::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::Scheduling::Weekly::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::Time::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SUOTA::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::RSSI::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::GroupTable::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid.

Create an attribute object that can hold the attribute with the given uid. (HF::Core::Scheduling::Event::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::DeviceManagement::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::DeviceInformation::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::BindManagement::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::BatchProgramManagement::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::AttributeReporting::Server *,uint8_t)

See also: HF::Interfaces::create_attribute (HF::Interfaces::SimpleHumidity::Server *,uint8_t)

Parameters

[in] uid attribute UID to create the attribute object for.

Returns: pointer to an attribute object or nullptr if the attribute UID does not exist.