OpenZWave Library  1.6.914
Namespaces | Classes | Enumerations | Functions | Variables
OpenZWave::Internal Namespace Reference

Namespaces

 CC
 
 Platform
 
 VC
 

Classes

class  Bitfield
 
struct  CompatOptionFlagDefintions
 
struct  CompatOptionFlagStorage
 
class  CompatOptionManager
 
struct  DNSLookup
 
class  DNSThread
 the DNSThread provides Async DNS lookups for checking revision numbers of Config Files against the official database More...
 
class  HttpClient
 
struct  HttpDownload
 
class  i_HttpClient
 
class  LabelLocalizationEntry
 
class  Localization
 
struct  LockGuard
 
class  ManufacturerSpecificDB
 The _ManufacturerSpecificDB class handles the Config File Database that we use to configure devices. More...
 
class  Msg
 Message object to be passed to and from devices on the Z-Wave network. More...
 
class  NotificationCCTypes
 
class  ProductDescriptor
 
class  Scene
 Collection of ValueIDs to be treated as a unit. More...
 
class  SensorMultiLevelCCTypes
 
class  Timer
 Timer SubClass for automatically registering/unregistering Timer Callbacks if the instance goes out of scope. More...
 
class  TimerThread
 The TimerThread class makes it possible to schedule events to happen at a certain time in the future. More...
 
class  ValueLocalizationEntry
 

Enumerations

enum  CompatOptionFlags {
  COMPAT_FLAG_GETSUPPORTED, COMPAT_FLAG_OVERRIDEPRECISION, COMPAT_FLAG_FORCEVERSION, COMPAT_FLAG_CREATEVARS,
  COMPAT_FLAG_REFRESHONWAKEUP, COMPAT_FLAG_BASIC_IGNOREREMAPPING, COMPAT_FLAG_BASIC_SETASREPORT, COMPAT_FLAG_BASIC_MAPPING,
  COMPAT_FLAG_COLOR_IDXBUG, COMPAT_FLAG_MCA_FORCEINSTANCES, COMPAT_FLAG_MI_MAPROOTTOENDPOINT, COMPAT_FLAG_MI_FORCEUNIQUEENDPOINTS,
  COMPAT_FLAG_MI_IGNMCCAPREPORTS, COMPAT_FLAG_MI_ENDPOINTHINT, COMPAT_FLAG_TSSP_BASE, COMPAT_FLAG_TSSP_ALTTYPEINTERPRETATION,
  COMPAT_FLAG_UC_EXPOSERAWVALUE, COMPAT_FLAG_VERSION_GETCLASSVERSION, COMPAT_FLAG_WAKEUP_DELAYNMI, COMPAT_FLAG_MI_REMOVECC,
  COMPAT_FLAG_VERIFYCHANGED, COMPAT_FLAG_NOT_ENABLECLEAR, COMPAT_FLAG_NOT_V1ALARMTYPES_ENABLED, STATE_FLAG_CCVERSION,
  STATE_FLAG_STATIC_REQUESTS, STATE_FLAG_AFTERMARK, STATE_FLAG_ENCRYPTED, STATE_FLAG_INNIF,
  STATE_FLAG_CS_SCENECOUNT, STATE_FLAG_CS_CLEARTIMEOUT, STATE_FLAG_CCS_CHANGECOUNTER, STATE_FLAG_COLOR_CHANNELS,
  STATE_FLAG_DOORLOCK_TIMEOUT, STATE_FLAG_DOORLOCK_INSIDEMODE, STATE_FLAG_DOORLOCK_OUTSIDEMODE, STATE_FLAG_DOORLOCK_TIMEOUTMINS,
  STATE_FLAG_DOORLOCK_TIMEOUTSECS, STATE_FLAG_DOORLOCKLOG_MAXRECORDS, STATE_FLAG_USERCODE_COUNT
}
 
enum  CompatOptionFlagType {
  COMPAT_FLAG_TYPE_BOOL, COMPAT_FLAG_TYPE_BYTE, COMPAT_FLAG_TYPE_SHORT, COMPAT_FLAG_TYPE_INT,
  COMPAT_FLAG_TYPE_BOOL_ARRAY, COMPAT_FLAG_TYPE_BYTE_ARRAY, COMPAT_FLAG_TYPE_SHORT_ARRAY, COMPAT_FLAG_TYPE_INT_ARRAY
}
 
enum  CompatOptionType { CompatOptionType_Compatibility, CompatOptionType_Discovery }
 
enum  LookupType { DNS_Lookup_ConfigRevision = 1 }
 
enum  SecurityStrategy { SecurityStrategy_Essential = 0, SecurityStrategy_Supported }
 

Functions

std::string ToUpper (std::string const &_str)
 
std::string ToLower (std::string const &_str)
 
std::string & removewhitespace (std::string &s)
 
std::string & ltrim (std::string &s)
 Left Trim. More...
 
std::string & rtrim (std::string &s)
 Right Trim. More...
 
std::string & trim (std::string &s)
 Trim. More...
 
void split (std::vector< std::string > &lst, const std::string &input, const std::string &separators, bool remove_empty)
 
void PrintHex (std::string prefix, uint8_t const *data, uint32 const length)
 
string PktToString (uint8 const *data, uint32 const length)
 
string ozwdirname (string m_path)
 
string intToString (int x)
 
const char * rssi_to_string (uint8 _data)
 
bool GenerateAuthentication (uint8 const *_data, uint32 const _length, Driver *driver, uint8 const _sendingNode, uint8 const _receivingNode, uint8 *iv, uint8 *_authentication)
 
bool EncryptBuffer (uint8 *m_buffer, uint8 m_length, Driver *driver, uint8 const _sendingNode, uint8 const _receivingNode, uint8 const m_nonce[8], uint8 *e_buffer)
 
bool createIVFromPacket_inbound (uint8 const *_data, uint8 const m_nonce[8], uint8 *iv)
 
bool DecryptBuffer (uint8 *e_buffer, uint8 e_length, Driver *driver, uint8 const _sendingNode, uint8 const _receivingNode, uint8 const m_nonce[8], uint8 *m_buffer)
 
SecurityStrategy ShouldSecureCommandClass (uint8 CommandClass)
 

Variables

CompatOptionFlagDefintions availableCompatFlags []
 
uint16_t availableCompatFlagsCount = sizeof(availableCompatFlags) / sizeof(availableCompatFlags[0])
 
CompatOptionFlagDefintions availableDiscoveryFlags []
 
uint16_t availableDiscoveryFlagsCount = sizeof(availableDiscoveryFlags) / sizeof(availableDiscoveryFlags[0])
 
uint32 const c_sceneVersion = 1
 

Enumeration Type Documentation

◆ CompatOptionFlags

Enumerator
COMPAT_FLAG_GETSUPPORTED 
COMPAT_FLAG_OVERRIDEPRECISION 
COMPAT_FLAG_FORCEVERSION 
COMPAT_FLAG_CREATEVARS 
COMPAT_FLAG_REFRESHONWAKEUP 
COMPAT_FLAG_BASIC_IGNOREREMAPPING 
COMPAT_FLAG_BASIC_SETASREPORT 
COMPAT_FLAG_BASIC_MAPPING 
COMPAT_FLAG_COLOR_IDXBUG 
COMPAT_FLAG_MCA_FORCEINSTANCES 
COMPAT_FLAG_MI_MAPROOTTOENDPOINT 
COMPAT_FLAG_MI_FORCEUNIQUEENDPOINTS 
COMPAT_FLAG_MI_IGNMCCAPREPORTS 
COMPAT_FLAG_MI_ENDPOINTHINT 
COMPAT_FLAG_TSSP_BASE 
COMPAT_FLAG_TSSP_ALTTYPEINTERPRETATION 
COMPAT_FLAG_UC_EXPOSERAWVALUE 
COMPAT_FLAG_VERSION_GETCLASSVERSION 
COMPAT_FLAG_WAKEUP_DELAYNMI 
COMPAT_FLAG_MI_REMOVECC 
COMPAT_FLAG_VERIFYCHANGED 
COMPAT_FLAG_NOT_ENABLECLEAR 
COMPAT_FLAG_NOT_V1ALARMTYPES_ENABLED 
STATE_FLAG_CCVERSION 
STATE_FLAG_STATIC_REQUESTS 
STATE_FLAG_AFTERMARK 
STATE_FLAG_ENCRYPTED 
STATE_FLAG_INNIF 
STATE_FLAG_CS_SCENECOUNT 
STATE_FLAG_CS_CLEARTIMEOUT 
STATE_FLAG_CCS_CHANGECOUNTER 
STATE_FLAG_COLOR_CHANNELS 
STATE_FLAG_DOORLOCK_TIMEOUT 
STATE_FLAG_DOORLOCK_INSIDEMODE 
STATE_FLAG_DOORLOCK_OUTSIDEMODE 
STATE_FLAG_DOORLOCK_TIMEOUTMINS 
STATE_FLAG_DOORLOCK_TIMEOUTSECS 
STATE_FLAG_DOORLOCKLOG_MAXRECORDS 
STATE_FLAG_USERCODE_COUNT 

◆ CompatOptionFlagType

Enumerator
COMPAT_FLAG_TYPE_BOOL 
COMPAT_FLAG_TYPE_BYTE 
COMPAT_FLAG_TYPE_SHORT 
COMPAT_FLAG_TYPE_INT 
COMPAT_FLAG_TYPE_BOOL_ARRAY 
COMPAT_FLAG_TYPE_BYTE_ARRAY 
COMPAT_FLAG_TYPE_SHORT_ARRAY 
COMPAT_FLAG_TYPE_INT_ARRAY 

◆ CompatOptionType

Enumerator
CompatOptionType_Compatibility 
CompatOptionType_Discovery 

◆ LookupType

Enumerator
DNS_Lookup_ConfigRevision 

◆ SecurityStrategy

Enumerator
SecurityStrategy_Essential 
SecurityStrategy_Supported 

Function Documentation

◆ createIVFromPacket_inbound()

bool OpenZWave::Internal::createIVFromPacket_inbound ( uint8 const *  _data,
uint8 const  m_nonce[8],
uint8 iv 
)

◆ DecryptBuffer()

bool OpenZWave::Internal::DecryptBuffer ( uint8 e_buffer,
uint8  e_length,
Driver driver,
uint8 const  _sendingNode,
uint8 const  _receivingNode,
uint8 const  m_nonce[8],
uint8 m_buffer 
)

◆ EncryptBuffer()

bool OpenZWave::Internal::EncryptBuffer ( uint8 m_buffer,
uint8  m_length,
Driver driver,
uint8 const  _sendingNode,
uint8 const  _receivingNode,
uint8 const  m_nonce[8],
uint8 e_buffer 
)

◆ GenerateAuthentication()

bool OpenZWave::Internal::GenerateAuthentication ( uint8 const *  _data,
uint32 const  _length,
Driver driver,
uint8 const  _sendingNode,
uint8 const  _receivingNode,
uint8 iv,
uint8 _authentication 
)

◆ intToString()

string OpenZWave::Internal::intToString ( int  x)

◆ ltrim()

std::string & OpenZWave::Internal::ltrim ( std::string &  s)

Left Trim.

Trims whitespace from the left end of the provided std::string

Parameters
[out]sThe std::string to trim
Returns
The modified std::string&

◆ ozwdirname()

string OpenZWave::Internal::ozwdirname ( string  m_path)

◆ PktToString()

string OpenZWave::Internal::PktToString ( uint8 const *  data,
uint32 const  length 
)

◆ PrintHex()

void OpenZWave::Internal::PrintHex ( std::string  prefix,
uint8_t const *  data,
uint32 const  length 
)

◆ removewhitespace()

std::string & OpenZWave::Internal::removewhitespace ( std::string &  s)

remove all Whitespace from of a string.

Parameters
sthe string to trim
Returns
the trimmed string

◆ rssi_to_string()

const char * OpenZWave::Internal::rssi_to_string ( uint8  _data)

◆ rtrim()

std::string & OpenZWave::Internal::rtrim ( std::string &  s)

Right Trim.

Trims whitespace from the right end of the provided std::string

Parameters
[out]sThe std::string to trim
Returns
The modified std::string&

◆ ShouldSecureCommandClass()

SecurityStrategy OpenZWave::Internal::ShouldSecureCommandClass ( uint8  CommandClass)

◆ split()

void OpenZWave::Internal::split ( std::vector< std::string > &  lst,
const std::string &  input,
const std::string &  separators,
bool  remove_empty = true 
)

Split a String into a Vector, separated by separators

Parameters
lstthe vector to store the results in
inputthe input string to split
separatorsa string containing a list of valid separators
remove_emptyif after splitting a string, the any of the results are a empty string, should we preserve them or not

◆ ToLower()

std::string OpenZWave::Internal::ToLower ( string const &  _str)

Convert a string to all lower-case.

Parameters
_strthe string to be converted.
Returns
the lower-case string.
See also
ToUpper, Trim

◆ ToUpper()

std::string OpenZWave::Internal::ToUpper ( string const &  _str)

Convert a string to all upper-case.

Parameters
_strthe string to be converted.
Returns
the upper-case string.
See also
ToLower, Trim

◆ trim()

std::string & OpenZWave::Internal::trim ( std::string &  s)

Trim.

Trims whitespace from both ends of the provided std::string

Parameters
[out]sThe std::string to trim
Returns
The modified std::string&

Variable Documentation

◆ availableCompatFlags

CompatOptionFlagDefintions OpenZWave::Internal::availableCompatFlags[]
Initial value:
=
{
{ "EnableNotificationClear", COMPAT_FLAG_NOT_ENABLECLEAR, COMPAT_FLAG_TYPE_BOOL },
}
Definition: CompatOptionManager.h:95
Definition: CompatOptionManager.h:55
Definition: CompatOptionManager.h:48
Definition: CompatOptionManager.h:61
Definition: CompatOptionManager.h:62
Definition: CompatOptionManager.h:51
Definition: CompatOptionManager.h:68
Definition: CompatOptionManager.h:69
Definition: CompatOptionManager.h:67
Definition: CompatOptionManager.h:56
Definition: CompatOptionManager.h:49
Definition: CompatOptionManager.h:54
Definition: CompatOptionManager.h:52
Definition: CompatOptionManager.h:60
Definition: CompatOptionManager.h:92
Definition: CompatOptionManager.h:50
Definition: CompatOptionManager.h:91
Definition: CompatOptionManager.h:64
Definition: CompatOptionManager.h:94
Definition: CompatOptionManager.h:53
Definition: CompatOptionManager.h:57
Definition: CompatOptionManager.h:66
Definition: CompatOptionManager.h:58

◆ availableCompatFlagsCount

uint16_t OpenZWave::Internal::availableCompatFlagsCount = sizeof(availableCompatFlags) / sizeof(availableCompatFlags[0])

◆ availableDiscoveryFlags

CompatOptionFlagDefintions OpenZWave::Internal::availableDiscoveryFlags[]
Initial value:
=
{
Definition: CompatOptionManager.h:78
Definition: CompatOptionManager.h:79
Definition: CompatOptionManager.h:83
Definition: CompatOptionManager.h:74
Definition: CompatOptionManager.h:72
Definition: CompatOptionManager.h:84
Definition: CompatOptionManager.h:93
Definition: CompatOptionManager.h:71
Definition: CompatOptionManager.h:75
Definition: CompatOptionManager.h:80
Definition: CompatOptionManager.h:73
Definition: CompatOptionManager.h:77
Definition: CompatOptionManager.h:81
Definition: CompatOptionManager.h:92
Definition: CompatOptionManager.h:86
Definition: CompatOptionManager.h:85
Definition: CompatOptionManager.h:82
Definition: CompatOptionManager.h:91
Definition: CompatOptionManager.h:94
Definition: CompatOptionManager.h:76

◆ availableDiscoveryFlagsCount

uint16_t OpenZWave::Internal::availableDiscoveryFlagsCount = sizeof(availableDiscoveryFlags) / sizeof(availableDiscoveryFlags[0])

◆ c_sceneVersion

uint32 const OpenZWave::Internal::c_sceneVersion = 1