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

The class provides interface for obtaining of measured data, for detecting of supported modules that can be specific for general or some own protocol. More...

#include <DPAProtocol.h>

Inheritance diagram for BeeeOn::DPAProtocol:
BeeeOn::DPAMappedProtocol BeeeOn::DPAIQHomeProtocol

Data Structures

struct  ProductInfo
 Vendor and product name for each paired device. It can be filled from IQRF repository or statically from code. More...
 

Public Types

typedef Poco::SharedPtr
< DPAProtocol
Ptr
 

Public Member Functions

virtual DPARequest::Ptr pingRequest (DPAMessage::NetworkAddress address) const =0
 DPA request for detecting that specific device communicates using the same protocols as implemented protocol. More...
 
virtual DPARequest::Ptr dpaProductInfoRequest (DPAMessage::NetworkAddress address) const =0
 
virtual ProductInfo extractProductInfo (const std::vector< uint8_t > &msg, uint16_t hwPID) const =0
 Obtaining of information from received response on the dpaProductInfoRequest(). More...
 
virtual DPARequest::Ptr dpaModulesRequest (DPAMessage::NetworkAddress node) const =0
 
virtual std::list< ModuleTypeextractModules (const std::vector< uint8_t > &message) const =0
 
virtual DPARequest::Ptr dpaValueRequest (DPAMessage::NetworkAddress node, const std::list< ModuleType > &type) const =0
 
virtual SensorData parseValue (const std::list< ModuleType > &modules, const std::vector< uint8_t > &msg) const =0
 Obtains measured values from the given byte message. The contents of the message must conform with the list of module types. More...
 

Detailed Description

The class provides interface for obtaining of measured data, for detecting of supported modules that can be specific for general or some own protocol.

Member Function Documentation

virtual DPARequest::Ptr BeeeOn::DPAProtocol::dpaModulesRequest ( DPAMessage::NetworkAddress  node) const
pure virtual
Returns
DPA request to detect available modules on the specific device.

Implemented in BeeeOn::DPAIQHomeProtocol.

virtual DPARequest::Ptr BeeeOn::DPAProtocol::dpaProductInfoRequest ( DPAMessage::NetworkAddress  address) const
pure virtual
Returns
DPA request for detecting of product info about specific device (vendor name and product name).

Implemented in BeeeOn::DPAIQHomeProtocol.

virtual DPARequest::Ptr BeeeOn::DPAProtocol::dpaValueRequest ( DPAMessage::NetworkAddress  node,
const std::list< ModuleType > &  type 
) const
pure virtual
Returns
DPA request to obtain measured values from a specific IQRF node.

Implemented in BeeeOn::DPAIQHomeProtocol.

virtual std::list<ModuleType> BeeeOn::DPAProtocol::extractModules ( const std::vector< uint8_t > &  message) const
pure virtual
Returns
list of module types encoded in the given message

Implemented in BeeeOn::DPAMappedProtocol, and BeeeOn::DPAIQHomeProtocol.

virtual ProductInfo BeeeOn::DPAProtocol::extractProductInfo ( const std::vector< uint8_t > &  msg,
uint16_t  hwPID 
) const
pure virtual

Obtaining of information from received response on the dpaProductInfoRequest().

Returns
product information as encoded in the given message

Implemented in BeeeOn::DPAIQHomeProtocol.

virtual SensorData BeeeOn::DPAProtocol::parseValue ( const std::list< ModuleType > &  modules,
const std::vector< uint8_t > &  msg 
) const
pure virtual

Obtains measured values from the given byte message. The contents of the message must conform with the list of module types.

Returns
measured values encoded in the given message

Implemented in BeeeOn::DPAMappedProtocol, and BeeeOn::DPAIQHomeProtocol.

virtual DPARequest::Ptr BeeeOn::DPAProtocol::pingRequest ( DPAMessage::NetworkAddress  address) const
pure virtual

DPA request for detecting that specific device communicates using the same protocols as implemented protocol.

Returns
DPARequest that can be used as a ping message.

Implemented in BeeeOn::DPAIQHomeProtocol.


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