OpenZWave Library  1.6.1914
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
OpenZWave::Internal::CC::Basic Class Reference

Implements COMMAND_CLASS_BASIC (0x20), a Z-Wave device command class. More...

#include <Basic.h>

+ Inheritance diagram for OpenZWave::Internal::CC::Basic:
+ Collaboration diagram for OpenZWave::Internal::CC::Basic:

Public Member Functions

virtual ~Basic ()
bool SetMapping (uint8 const _commandClassId)
uint8_t GetMapping ()
virtual void ReadXML (TiXmlElement const *_ccElement) override
virtual bool RequestState (uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override
virtual bool RequestValue (uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override
virtual uint8 const GetCommandClassId () const override
virtual string const GetCommandClassName () const override
virtual bool HandleMsg (uint8 const *_data, uint32 const _length, uint32 const _instance=1) override
virtual bool HandleIncomingMsg (uint8 const *_data, uint32 const _length, uint32 const _instance=1) override
virtual bool SetValue (Internal::VC::Value const &_value) override
void Set (uint8 const _level)
virtual uint8 GetMaxVersion () override
- Public Member Functions inherited from OpenZWave::Internal::CC::CommandClass
 CommandClass (uint32 const _homeId, uint8 const _nodeId)
virtual ~CommandClass ()
virtual void WriteXML (TiXmlElement *_ccElement)
virtual void refreshValuesOnWakeup ()
string const GetCommandClassLabel ()
void SetCommandClassLabel (string label)
virtual void SetValueBasic (uint8 const _instance, uint8 const _level)
virtual void SetVersion (uint8 const _version)
bool RequestStateForAllInstances (uint32 const _requestFlags, Driver::MsgQueue const _queue)
bool CheckForRefreshValues (Internal::VC::Value const *_value)
uint8 GetVersion () const
Bitfield const * GetInstances () const
uint32 GetHomeId () const
uint8 GetNodeId () const
DriverGetDriver () const
NodeGetNodeUnsafe () const
Internal::VC::ValueGetValue (uint8 const _instance, uint16 const _index)
bool RemoveValue (uint8 const _instance, uint16 const _index)
uint8 GetEndPoint (uint8 const _instance)
uint8 GetInstance (uint8 const _endPoint)
virtual bool supportsMultiInstance ()
void SetInstances (uint8 const _instances)
void SetInstance (uint8 const _endPoint)
virtual void SetInstanceLabel (uint8 const _instance, char *label)
string GetInstanceLabel (uint8 const _instance)
uint8 GetNumInstances ()
void SetAfterMark ()
void SetEndPoint (uint8 const _instance, uint8 const _endpoint)
bool IsAfterMark () const
bool IsSecured () const
void SetSecured ()
bool IsSecureSupported () const
void ClearSecureSupport ()
void SetSecureSupport ()
void SetInNIF ()
bool IsInNIF ()
string ExtractValue (uint8 const *_data, uint8 *_scale, uint8 *_precision, uint8 _valueOffset=1) const
uint32 decodeDuration (uint8 data) const
uint8 encodeDuration (uint32 seconds) const
void AppendValue (Msg *_msg, string const &_value, uint8 const _scale) const
uint8 const GetAppendValueSize (string const &_value) const
int32 ValueToInteger (string const &_value, uint8 *o_precision, uint8 *o_size) const
void UpdateMappedClass (uint8 const _instance, uint8 const _classId, uint8 const _value)
void CreateVars ()
bool HasStaticRequest (uint8_t _request) const
void SetStaticRequest (uint8_t _request)
void ClearStaticRequest (uint8_t _request)
uint32 GetSentCnt () const
uint32 GetReceivedCnt () const
void SentCntIncr ()
void ReceivedCntIncr ()

Static Public Member Functions

static CommandClassCreate (uint32 const _homeId, uint8 const _nodeId)
static uint8 const StaticGetCommandClassId ()
static string const StaticGetCommandClassName ()

Protected Member Functions

virtual void CreateVars (uint8 const _instance) override
- Protected Member Functions inherited from OpenZWave::Internal::CC::CommandClass
void ReadValueRefreshXML (TiXmlElement const *_ccElement)

Additional Inherited Members

- Public Types inherited from OpenZWave::Internal::CC::CommandClass
enum  { RequestFlag_Static = 0x00000001, RequestFlag_Session = 0x00000002, RequestFlag_Dynamic = 0x00000004, RequestFlag_AfterMark = 0x00000008 }
enum  StaticRequest { StaticRequest_Instances = 0x01, StaticRequest_Values = 0x02, StaticRequest_Version = 0x04 }
typedef struct OpenZWave::Internal::CC::CommandClass::RefreshValue RefreshValue
- Protected Attributes inherited from OpenZWave::Internal::CC::CommandClass
CompatOptionManager m_com
CompatOptionManager m_dom

Detailed Description

Implements COMMAND_CLASS_BASIC (0x20), a Z-Wave device command class.

Constructor & Destructor Documentation

◆ ~Basic()

virtual OpenZWave::Internal::CC::Basic::~Basic ( )

Member Function Documentation

◆ Create()

static CommandClass* OpenZWave::Internal::CC::Basic::Create ( uint32 const  _homeId,
uint8 const  _nodeId 

◆ CreateVars()

void OpenZWave::Internal::CC::Basic::CreateVars ( uint8 const  _instance)

◆ GetCommandClassId()

virtual uint8 const OpenZWave::Internal::CC::Basic::GetCommandClassId ( ) const

◆ GetCommandClassName()

virtual string const OpenZWave::Internal::CC::Basic::GetCommandClassName ( ) const

◆ GetMapping()

uint8_t OpenZWave::Internal::CC::Basic::GetMapping ( )

◆ GetMaxVersion()

virtual uint8 OpenZWave::Internal::CC::Basic::GetMaxVersion ( )

◆ HandleIncomingMsg()

bool OpenZWave::Internal::CC::Basic::HandleIncomingMsg ( uint8 const *  _data,
uint32 const  _length,
uint32 const  _instance = 1 

◆ HandleMsg()

bool OpenZWave::Internal::CC::Basic::HandleMsg ( uint8 const *  _data,
uint32 const  _length,
uint32 const  _instance = 1 

◆ ReadXML()

void OpenZWave::Internal::CC::Basic::ReadXML ( TiXmlElement const *  _ccElement)

◆ RequestState()

bool OpenZWave::Internal::CC::Basic::RequestState ( uint32 const  _requestFlags,
uint8 const  _instance,
Driver::MsgQueue const  _queue 

◆ RequestValue()

bool OpenZWave::Internal::CC::Basic::RequestValue ( uint32 const  _requestFlags,
uint16 const  _index,
uint8 const  _instance,
Driver::MsgQueue const  _queue 

◆ Set()

void OpenZWave::Internal::CC::Basic::Set ( uint8 const  _level)

◆ SetMapping()

bool OpenZWave::Internal::CC::Basic::SetMapping ( uint8 const  _commandClassId)

◆ SetValue()

bool OpenZWave::Internal::CC::Basic::SetValue ( Internal::VC::Value const &  _value)

◆ StaticGetCommandClassId()

static uint8 const OpenZWave::Internal::CC::Basic::StaticGetCommandClassId ( )

◆ StaticGetCommandClassName()

static string const OpenZWave::Internal::CC::Basic::StaticGetCommandClassName ( )

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