BeeeOn Gateway  v2020.3.1-2-g6f737dc
Platform to interconnect the IoT world
Public Types | Public Member Functions
BeeeOn::DPAOSPeripheralInfoResponse Class Referencefinal
Inheritance diagram for BeeeOn::DPAOSPeripheralInfoResponse:
BeeeOn::DPAResponse BeeeOn::DPAMessage

Public Types

typedef Poco::SharedPtr
< DPAOSPeripheralInfoResponse
Ptr
 
- Public Types inherited from BeeeOn::DPAResponse
enum  Type { PERIPHERAL_INFO = 0x80, BONDED_NODES = 0x82, BOND_NODE = 0x84, REMOVE_NODE = 0x85 }
 
typedef Poco::SharedPtr
< DPAResponse
Ptr
 
- Public Types inherited from BeeeOn::DPAMessage
typedef Poco::SharedPtr
< DPAMessage
Ptr
 
typedef uint16_t NetworkAddress
 

Public Member Functions

uint32_t mid () const
 
int8_t rssi () const
 
double rssiPercentage () const
 Converts RSSI value ([dBm]) of incoming RF signal to percentage. More...
 
double supplyVoltage () const
 
double percentageSupplyVoltage () const
 
- Public Member Functions inherited from BeeeOn::DPAResponse
void setErrorCode (uint8_t errCode)
 
uint8_t errorCode () const
 
void setDPAValue (uint8_t dpaValue)
 
uint8_t dpaValue () const
 
virtual std::string toDPAString () const override
 Converts the header items and peripheral data to string that is divided by dots.
 
- Public Member Functions inherited from BeeeOn::DPAMessage
void setNetworkAddress (NetworkAddress node)
 Network device address. More...
 
NetworkAddress networkAddress () const
 
void setPeripheralNumber (uint8_t pNumber)
 Peripheral number: More...
 
uint8_t peripheralNumber () const
 
void setPeripheralCommand (uint8_t pCommand)
 Command specifying an action to be taken. Actually allowed value range depends on the peripheral type. The most significant bit is reserved for indication of DPA response message. More...
 
uint8_t peripheralCommand () const
 
void setHWPID (uint16_t hwPID)
 HW profile ID uniquely specifies the functionality of the device, the user peripherals it implements, its behavior etc. The only device having the same HWPID as the DPA request will execute the request. When 0xFFFF is specified then the device with any HW profile ID will execute the request. Note - HWPID numbers used throughout this document are fictitious ones. More...
 
uint16_t HWPID () const
 
void setPeripheralData (const std::vector< uint8_t > &data)
 An array of bytes. More...
 
std::vector< uint8_t > peripheralData () const
 

Additional Inherited Members

- Static Public Member Functions inherited from BeeeOn::DPAResponse
static DPAResponse::Ptr fromRaw (const std::string &data)
 Parses given message into general or specific response.
 
- Static Public Attributes inherited from BeeeOn::DPAMessage
static uint16_t COORDINATOR_NODE_ADDRESS = 0x0000
 
static uint16_t DEFAULT_HWPID = 0xffff
 
- Protected Member Functions inherited from BeeeOn::DPAResponse
 DPAResponse (DPAMessage::NetworkAddress node, uint8_t pNumber, uint8_t pCommand, uint16_t hwPID, const std::vector< uint8_t > &pData, uint8_t errorCode, uint8_t dpaValue)
 
- Protected Member Functions inherited from BeeeOn::DPAMessage
 DPAMessage (NetworkAddress node, uint8_t pNumber, uint8_t pCommand, uint16_t hwPID, const std::vector< uint8_t > &pData)
 Creates message with DPA content that includes address of node, number of peripheral, command for peripheral and hw PID.
 

Member Function Documentation

uint32_t DPAOSPeripheralInfoResponse::mid ( ) const
Returns
Module ID - 4B identification code unique for each TR module.
int8_t DPAOSPeripheralInfoResponse::rssi ( ) const
Returns
RSSI value ([dBm]) of incoming RF signal (11dBm - 11dBm).
See Also
https://www.iqrf.org/IQRF-OS-Reference-guide/
http://iqrf.org/weben/downloads.php?id=333
double DPAOSPeripheralInfoResponse::rssiPercentage ( ) const

Converts RSSI value ([dBm]) of incoming RF signal to percentage.

See Also
https://www.adriangranados.com/blog/dbm-to-percent-conversion
double DPAOSPeripheralInfoResponse::supplyVoltage ( ) const
Returns
Power supply measurement (up to 3.84V), low battery state: voltage < 2.93V.
See Also
https://www.iqrf.org/IQRF-OS-Reference-guide/

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