OpenZWave Library 1.2
DoorLock.h
Go to the documentation of this file.
1//-----------------------------------------------------------------------------
2//
3// DoorLock.h
4//
5// Implementation of the Z-Wave COMMAND_CLASS_DOOR_LOCK
6//
7// Copyright (c) 2014 Justin Hammond <justin@dynam.ac>
8//
9// SOFTWARE NOTICE AND LICENSE
10//
11// This file is part of OpenZWave.
12//
13// OpenZWave is free software: you can redistribute it and/or modify
14// it under the terms of the GNU Lesser General Public License as published
15// by the Free Software Foundation, either version 3 of the License,
16// or (at your option) any later version.
17//
18// OpenZWave is distributed in the hope that it will be useful,
19// but WITHOUT ANY WARRANTY; without even the implied warranty of
20// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21// GNU Lesser General Public License for more details.
22//
23// You should have received a copy of the GNU Lesser General Public License
24// along with OpenZWave. If not, see <http://www.gnu.org/licenses/>.
25//
26//-----------------------------------------------------------------------------
27
28#ifndef _DoorLock_H
29#define _DoorLock_H
30
31#include "CommandClass.h"
32
33namespace OpenZWave
34{
35 class ValueBool;
36
39 class DoorLock: public CommandClass
40 {
41 public:
42 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new DoorLock( _homeId, _nodeId ); }
43 virtual ~DoorLock(){}
44
45 static uint8 const StaticGetCommandClassId(){ return 0x62; }
46 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_DOOR_LOCK"; }
47
48 // From CommandClass
49 virtual void ReadXML( TiXmlElement const* _ccElement );
50 virtual void WriteXML( TiXmlElement* _ccElement );
51 virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
52 virtual bool RequestValue( uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
53 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
54 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
55 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
56 virtual bool SetValue( Value const& _value );
57 virtual void SetValueBasic( uint8 const _instance, uint8 const _value );
58
59
60 protected:
61 virtual void CreateVars( uint8 const _instance );
62
63 private:
64 DoorLock( uint32 const _homeId, uint8 const _nodeId );
65 uint8 m_timeoutsupported;
66 uint8 m_insidehandlemode;
67 uint8 m_outsidehandlemode;
68 uint8 m_timeoutmins;
69 uint8 m_timeoutsecs;
70
71 };
72
73} // namespace OpenZWave
74
75#endif
76
unsigned int uint32
Definition: Defs.h:69
unsigned char uint8
Definition: Defs.h:63
Base class for all Z-Wave command classes.
Definition: CommandClass.h:47
Implements COMMAND_CLASS_DOOR_LOCK (0x62), a Z-Wave device command class.
Definition: DoorLock.h:40
virtual uint8 const GetCommandClassId() const
Definition: DoorLock.h:53
virtual void WriteXML(TiXmlElement *_ccElement)
Definition: DoorLock.cpp:169
virtual void CreateVars(uint8 const _instance)
Definition: DoorLock.cpp:545
static uint8 const StaticGetCommandClassId()
Definition: DoorLock.h:45
virtual bool RequestValue(uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: DoorLock.cpp:228
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: DoorLock.h:42
virtual void SetValueBasic(uint8 const _instance, uint8 const _value)
Definition: DoorLock.cpp:510
virtual bool SetValue(Value const &_value)
Definition: DoorLock.cpp:351
virtual string const GetCommandClassName() const
Definition: DoorLock.h:54
virtual ~DoorLock()
Definition: DoorLock.h:43
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: DoorLock.cpp:272
static string const StaticGetCommandClassName()
Definition: DoorLock.h:46
virtual void ReadXML(TiXmlElement const *_ccElement)
Definition: DoorLock.cpp:135
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: DoorLock.cpp:200
MsgQueue
Definition: Driver.h:584
Base class for values associated with a node.
Definition: Value.h:45
Definition: Bitfield.h:35