BeeeOn Gateway  v2020.3.1-2-g6f737dc
Platform to interconnect the IoT world
Data Structures | Public Member Functions
BeeeOn::DeviceDescription Class Reference

The class wraps information about a device's type. It describes its properties and provided sensor types. More...

#include <DeviceDescription.h>

Data Structures

class  Builder
 

Public Member Functions

void setID (const DeviceID &id)
 
DeviceID id () const
 
void setVendor (const std::string &vendor)
 
std::string vendor () const
 
void setProductName (const std::string &name)
 
std::string productName () const
 
void setDataTypes (const std::list< ModuleType > &types)
 
std::list< ModuleTypedataTypes () const
 
void setRefreshTime (const RefreshTime &time)
 
RefreshTime refreshTime () const
 
void setName (const std::string &name)
 
std::string name () const
 
void setFirmware (const std::string &firmware)
 
std::string firmware () const
 
void setIPAddress (const Poco::Net::IPAddress &ipAddress)
 
Poco::Nullable
< Poco::Net::IPAddress > 
ipAddress () const
 
void setMACAddress (const MACAddress &macAddress)
 
Poco::Nullable< MACAddressmacAddress () const
 
void setSerialNumber (uint64_t serial)
 
Poco::Nullable< uint64_t > serialNumber () const
 
std::string toString () const
 
std::string toPrettyString () const
 

Detailed Description

The class wraps information about a device's type. It describes its properties and provided sensor types.

Member Function Documentation

RefreshTime DeviceDescription::refreshTime ( ) const

Refresh time can be in one of three forms:

  • positive value - initial refresh time of the device
  • 0 - initially, device does not report data periodically, it can be changed to a positive value
  • negative - refresh time is unsupported
Returns
refresh time of the device

The documentation for this class was generated from the following files: