DoorLock.h
Go to the documentation of this file.
//-----------------------------------------------------------------------------
//
// DoorLock.h
//
// Implementation of the Z-Wave COMMAND_CLASS_DOOR_LOCK
//
// Copyright (c) 2014 Justin Hammond <justin@dynam.ac>
//
// 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 _DoorLock_H
#define _DoorLock_H
#include "CommandClass.h"
namespace OpenZWave
{
class ValueBool;
class DoorLock: public CommandClass
{
public:
static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new DoorLock( _homeId, _nodeId ); }
virtual ~DoorLock(){}
static uint8 const StaticGetCommandClassId(){ return 0x62; }
static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_DOOR_LOCK"; }
// 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 );
virtual void SetValueBasic( uint8 const _instance, uint8 const _value );
protected:
virtual void CreateVars( uint8 const _instance );
private:
DoorLock( uint32 const _homeId, uint8 const _nodeId );
uint8 m_timeoutsupported;
uint8 m_insidehandlemode;
uint8 m_outsidehandlemode;
uint8 m_timeoutmins;
uint8 m_timeoutsecs;
};
} // namespace OpenZWave
#endif
OpenZWave::DoorLock::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: DoorLock.cpp:272
OpenZWave::DoorLock::SetValueBasic
virtual void SetValueBasic(uint8 const _instance, uint8 const _value)
Definition: DoorLock.cpp:514
OpenZWave
Definition: Bitfield.h:34
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:565
OpenZWave::DoorLock
Implements COMMAND_CLASS_DOOR_LOCK (0x62), a Z-Wave device command class.
Definition: DoorLock.h:39
OpenZWave::DoorLock::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: DoorLock.h:54
CommandClass.h
OpenZWave::DoorLock::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: DoorLock.h:53
OpenZWave::DoorLock::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: DoorLock.cpp:228
OpenZWave::DoorLock::SetValue
virtual bool SetValue(Value const &_value)
Definition: DoorLock.cpp:351
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:46
OpenZWave::DoorLock::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: DoorLock.h:45
OpenZWave::DoorLock::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: DoorLock.h:46
uint32
unsigned int uint32
Definition: Defs.h:80
OpenZWave::DoorLock::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: DoorLock.cpp:200
OpenZWave::DoorLock::ReadXML
virtual void ReadXML(TiXmlElement const *_ccElement)
Definition: DoorLock.cpp:135
OpenZWave::DoorLock::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: DoorLock.h:42
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:47
OpenZWave::DoorLock::CreateVars
virtual void CreateVars(uint8 const _instance)
Definition: DoorLock.cpp:549
OpenZWave::DoorLock::~DoorLock
virtual ~DoorLock()
Definition: DoorLock.h:43
OpenZWave::DoorLock::WriteXML
virtual void WriteXML(TiXmlElement *_ccElement)
Definition: DoorLock.cpp:169
uint8
unsigned char uint8
Definition: Defs.h:74