OpenZWave Library 1.2
Alarm.h
Go to the documentation of this file.
1//-----------------------------------------------------------------------------
2//
3// Alarm.h
4//
5// Implementation of the Z-Wave COMMAND_CLASS_ALARM
6//
7// Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
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 _Alarm_H
29#define _Alarm_H
30
32
33namespace OpenZWave
34{
35 class ValueByte;
36
39 class Alarm: public CommandClass
40 {
41 public:
42 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Alarm( _homeId, _nodeId ); }
43 virtual ~Alarm(){}
44
46 static uint8 const StaticGetCommandClassId(){ return 0x71; }
48 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_ALARM"; }
49
50 // From CommandClass
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 );
54 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
56 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
58 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
59
60 virtual uint8 GetMaxVersion(){ return 2; }
61
62 protected:
63 virtual void CreateVars( uint8 const _instance );
64
65 private:
66 Alarm( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
67 };
68
69} // namespace OpenZWave
70
71#endif
unsigned int uint32
Definition: Defs.h:69
unsigned char uint8
Definition: Defs.h:63
Implements COMMAND_CLASS_ALARM (0x71), a Z-Wave device command class.
Definition: Alarm.h:40
virtual string const GetCommandClassName() const
Get a string containing the name of this command class. (Inherited from CommandClass)
Definition: Alarm.h:56
virtual uint8 const GetCommandClassId() const
Get command class ID (1 byte) identifying this command class. (Inherited from CommandClass)
Definition: Alarm.h:54
virtual bool RequestValue(uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Alarm.cpp:76
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Alarm.h:42
virtual void CreateVars(uint8 const _instance)
Definition: Alarm.cpp:138
static uint8 const StaticGetCommandClassId()
Get command class ID (1 byte) identifying this command class.
Definition: Alarm.h:46
virtual ~Alarm()
Definition: Alarm.h:43
static string const StaticGetCommandClassName()
Get a string containing the name of this command class.
Definition: Alarm.h:48
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Alarm.cpp:57
virtual uint8 GetMaxVersion()
Definition: Alarm.h:60
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Handle a response to a message associated with this command class. (Inherited from CommandClass)
Definition: Alarm.cpp:105
Base class for all Z-Wave command classes.
Definition: CommandClass.h:47
MsgQueue
Definition: Driver.h:584
Definition: Bitfield.h:35