UserCode.h
Go to the documentation of this file.
//-----------------------------------------------------------------------------
//
// UserCode.h
//
// Implementation of the Z-Wave COMMAND_CLASS_USER_CODE
//
// Copyright (c) 2012 Greg Satz <satz@iranger.com>
//
// SOFTWARE NOTICE AND LICENSE
//
// This file is part of OpenZWave.
//
// OpenZWave is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
// OpenZWave is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenZWave. If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------
#ifndef _UserCode_H
#define _UserCode_H
#include "command_classes/CommandClass.h"
namespace OpenZWave
{
class UserCode: public CommandClass
{
public:
enum UserCodeStatus
{
UserCode_Available = 0x00,
UserCode_Occupied = 0x01,
UserCode_Reserved = 0x02,
UserCode_NotAvailable = 0xfe,
UserCode_Unset = 0xff
};
static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new UserCode( _homeId, _nodeId ); }
virtual ~UserCode(){}
static uint8 const StaticGetCommandClassId(){ return 0x63; }
static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_USER_CODE"; }
// From CommandClass
virtual void ReadXML( TiXmlElement const* _ccElement );
virtual void WriteXML( TiXmlElement* _ccElement );
virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
virtual bool RequestValue( uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
virtual bool SetValue( Value const& _value );
protected:
virtual void CreateVars( uint8 const _instance );
private:
UserCode( uint32 const _homeId, uint8 const _nodeId );
string CodeStatus( uint8 const _byte )
{
switch( _byte )
{
case UserCode_Available:
{
return "Available";
}
case UserCode_Occupied:
{
return "Occupied";
}
case UserCode_Reserved:
{
return "Reserved";
}
case UserCode_NotAvailable:
{
return "Not Available";
}
case UserCode_Unset:
{
return "Unset";
}
default:
{
return "Unknown";
}
}
}
bool m_queryAll; // True while we are requesting all the user codes.
uint8 m_currentCode;
uint8 m_userCodeCount;
uint8 m_userCodesStatus[256];
bool m_refreshUserCodes;
};
} // namespace OpenZWave
#endif
OpenZWave::UserCode::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: UserCode.cpp:117
OpenZWave::UserCode::~UserCode
virtual ~UserCode()
Definition: UserCode.h:50
OpenZWave::UserCode::UserCode_Available
Definition: UserCode.h:42
OpenZWave
Definition: Bitfield.h:34
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:565
OpenZWave::UserCode::CreateVars
virtual void CreateVars(uint8 const _instance)
Definition: UserCode.cpp:351
OpenZWave::UserCode::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: UserCode.h:53
OpenZWave::UserCode
Implements COMMAND_CLASS_USER_CODE (0x63), a Z-Wave device command class.
Definition: UserCode.h:37
OpenZWave::UserCode::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: UserCode.cpp:197
CommandClass.h
OpenZWave::UserCode::UserCodeStatus
UserCodeStatus
Definition: UserCode.h:40
OpenZWave::UserCode::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: UserCode.h:49
OpenZWave::UserCode::SetValue
virtual bool SetValue(Value const &_value)
Definition: UserCode.cpp:304
OpenZWave::UserCode::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: UserCode.h:60
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:46
OpenZWave::UserCode::UserCode_NotAvailable
Definition: UserCode.h:45
OpenZWave::UserCode::UserCode_Occupied
Definition: UserCode.h:43
uint32
unsigned int uint32
Definition: Defs.h:80
OpenZWave::UserCode::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: UserCode.h:52
OpenZWave::UserCode::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: UserCode.cpp:147
OpenZWave::UserCode::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: UserCode.h:61
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:47
OpenZWave::UserCode::UserCode_Unset
Definition: UserCode.h:46
OpenZWave::UserCode::ReadXML
virtual void ReadXML(TiXmlElement const *_ccElement)
Definition: UserCode.cpp:83
OpenZWave::UserCode::WriteXML
virtual void WriteXML(TiXmlElement *_ccElement)
Definition: UserCode.cpp:101
OpenZWave::UserCode::UserCode_Reserved
Definition: UserCode.h:44
uint8
unsigned char uint8
Definition: Defs.h:74