Simple Humidity

This module contains the classes that define and implement the Simple Humidity interface API. More...

Collaboration diagram for Simple Humidity:

Data Structures
struct	HF::Interfaces::SimpleHumidity::Humidity
	Helper class to handle the Measured Humidity attribute for the Simple Humidity interface. More...
struct	HF::Interfaces::SimpleHumidity::Tolerance
	Helper class to handle the Tolerance attribute for the Simple Humidity interface. More...
struct	HF::Interfaces::SimpleHumidity::Base
	Simple Humidity Interface : Parent. More...
class	HF::Interfaces::SimpleHumidity::Server
	Simple Humidity Interface : Server side interface. More...
class	HF::Interfaces::SimpleHumidity::Client
	Level Control Interface : Client side implementation. More...

Enumerations
enum	HF::Interfaces::SimpleHumidity::Attributes { HF::Interfaces::SimpleHumidity::VALUE_ATTR = 0x01, HF::Interfaces::SimpleHumidity::TOLERANCE_ATTR = 0x02 }
	Attributes. More...

Functions
HF::Attributes::IAttribute *	HF::Interfaces::create_attribute (HF::Interfaces::SimpleHumidity::Server *server, uint8_t uid)
	Create an attribute object that can hold the attribute with the given uid. More...
HF::Attributes::IAttribute *	HF::Interfaces::SimpleHumidity::create_attribute (uint8_t uid)
	Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleHumidity::Server *,uint8_t) More...
std::ostream &	operator<< (std::ostream &stream, const HF::Interfaces::SimpleThermostat::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::SimpleThermostat::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 Simple Humidity interface API.

Enumeration Type Documentation

Attributes

enum HF::Interfaces::SimpleHumidity::Attributes

Attributes.

Enumerator
VALUE_ATTR	Measured humidity attribute UID.
TOLERANCE_ATTR	Tolerance attribute UID.

Definition at line 64 of file simple_humidity.h.

         {
            VALUE_ATTR     = 0x01, 
            TOLERANCE_ATTR = 0x02, 
            __LAST_ATTR__  = TOLERANCE_ATTR,
         } Attributes;

Function Documentation

create_attribute() [1/2]

HF::Attributes::IAttribute* HF::Interfaces::create_attribute	(	HF::Interfaces::SimpleHumidity::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::SimpleHumidity::create_attribute ( uint8_t  uid )

inline

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

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

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

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

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

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

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

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

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.

Definition at line 108 of file simple_humidity.h.

         {
            return Interfaces::create_attribute(static_cast<SimpleHumidity::Server *>(nullptr),
                                                uid);
         }

operator<<() [1/2]

std::ostream& operator<<	(	std::ostream &	stream,
		const HF::Interfaces::SimpleThermostat::CMD	command
	)

Convert the given command into a string and write it to the given stream.

Parameters

[in]	stream	out stream to write the string to.
[in]	command	role value to convert to a string.

Returns

stream

operator<<() [2/2]

std::ostream& operator<<	(	std::ostream &	stream,
		const HF::Interfaces::SimpleThermostat::Attributes	attribute
	)

Convert the given attribute into a string and write it to the given stream.

Parameters

[in]	stream	out stream to write the string to.
[in]	attribute	attribute value to convert to a string.

Returns

stream