HAN-FUN API  1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
device_information.h File Reference

This file contains the definition for the core Device Information interface of the HAN-FUN protocol. More...

#include "hanfun/common.h"
#include "hanfun/interface.h"
#include "hanfun/core.h"
+ Include dependency graph for device_information.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  HF::Core::DeviceInformation::FriendlyName
 Data type to contain the Friendly name attribute. More...
 
struct  HF::Core::DeviceInformation::FriendlyName::Unit
 Data type representing a unit0's friendly name. More...
 
class  HF::Core::DeviceInformation::Base
 Parent class for the Device Information interface implementation. More...
 
struct  HF::Core::DeviceInformation::Server
 Device Information interface : Server side. More...
 

Namespaces

 HF
 Top-level namespace for the HAN-FUN library.
 
 HF::Core
 This is the top-level namespace for the Core Services and Interfaces implementation.
 
 HF::Core::DeviceInformation
 This namespace contains the classes that implement the Device Information service.
 

Macros

#define HF_DEVICE_MANUFACTURER_CODE   0x0000
 Device Electronic Manufacturer Code.
 
#define HF_APPLICATION_VERSION   ""
 Application version.
 
#define HF_HARDWARE_VERSION   ""
 Hardware Version.
 
#define HF_MANUFACTURER_NAME   ""
 Manufacturer name.
 

Enumerations

enum  HF::Core::DeviceInformation::Attributes {
  HF::Core::DeviceInformation::CORE_VERSION_ATTR = 0x01, HF::Core::DeviceInformation::PROFILE_VERSION_ATTR = 0x02, HF::Core::DeviceInformation::INTERFACE_VERSION_ATTR = 0x03, HF::Core::DeviceInformation::EXTRA_CAP_ATTR = 0x04,
  HF::Core::DeviceInformation::MIN_SLEEP_TIME_ATTR = 0x05, HF::Core::DeviceInformation::ACTUAL_RESP_TIME_ATTR = 0x06, HF::Core::DeviceInformation::APP_VERSION_ATTR = 0x07, HF::Core::DeviceInformation::HW_VERSION_ATTR = 0x08,
  HF::Core::DeviceInformation::EMC_ATTR = 0x09, HF::Core::DeviceInformation::DECT_ID_ATTR = 0x0A, HF::Core::DeviceInformation::MANUFACTURER_NAME_ATTR = 0x0B, HF::Core::DeviceInformation::LOCATION_ATTR = 0x0C,
  HF::Core::DeviceInformation::ENABLED_ATTR = 0x0D, HF::Core::DeviceInformation::FRIENDLY_NAME_ATTR = 0x0E, HF::Core::DeviceInformation::UID_ATTR = 0x0F, HF::Core::DeviceInformation::SERIAL_NUMBER_ATTR = 0x10
}
 Attributes. More...
 

Functions

HF::Attributes::IAttributeHF::Core::create_attribute (HF::Core::DeviceInformation::Server *server, uint8_t uid)
 Create an attribute object that can hold the attribute with the given uid. More...
 
HF::Attributes::IAttributeHF::Core::DeviceInformation::create_attribute (uint8_t uid)
 Create an attribute object that can hold the attribute with the given uid. (HF::Core::DeviceInformation::Server *,uint8_t) More...
 
Protocol::Message * HF::Core::DeviceInformation::mandatory ()
 Create a message that can be used to retrieve the mandatory attributes on a remote device. More...
 
Protocol::Message * HF::Core::DeviceInformation::all ()
 Create a message that can be used to retrieve all the attributes on a remote device. More...
 
Protocol::Message * HF::Core::DeviceInformation::get (HF::Attributes::UIDS &uids)
 Create a message that can be used to retrieve the attributes with the given uids of the device information interface on a remote device. More...
 
Protocol::Message * HF::Core::DeviceInformation::get (uint8_t uid)
 Create a message that can be used to retrieve the attribute with the given uid. More...
 
std::ostream & operator<< (std::ostream &stream, const HF::Core::DeviceInformation::Attributes attribute)
 Convert the given attribute into a string and write it to the given stream. More...
 

Detailed Description

This file contains the definition for the core Device Information interface of the HAN-FUN protocol.

Version
1.5.3

For licensing information, please see the file 'LICENSE' in the root folder.

Initial development by Bithium S.A. [http://www.bithium.com]

Definition in file device_information.h.