OpenZWave Library: SensorAlarm.h Source File

| OpenZWave Library 1.6.0

SensorAlarm.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // SensorAlarm.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_SENSOR_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 _SensorAlarm_H
29 #define _SensorAlarm_H
30
31 #include <vector>
32 #include <string>
33 #include "command_classes/CommandClass.h"
34
35 namespace OpenZWave
36 {
37 class ValueByte;
38
42 class SensorAlarm: public CommandClass
43 {
44 public:
45 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new SensorAlarm( _homeId, _nodeId ); }
46 virtual ~SensorAlarm(){}
47
48 static uint8 const StaticGetCommandClassId(){ return 0x9c; }
49 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_SENSOR_ALARM"; }
50
51 // From CommandClass
52 virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
53 virtual bool RequestValue( uint32 const _requestFlags, uint16 const _alarmType, uint8 const _dummy, Driver::MsgQueue const _queue );
54 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
55 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
56 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
57
58 private:
59 SensorAlarm( uint32 const _homeId, uint8 const _nodeId );
60
61 enum
62 {
63 SensorAlarm_General = 0,
64 SensorAlarm_Smoke,
65 SensorAlarm_CarbonMonoxide,
66 SensorAlarm_CarbonDioxide,
67 SensorAlarm_Heat,
68 SensorAlarm_Flood,
69 SensorAlarm_Count
70 };
71 };
72
73 } // namespace OpenZWave
74
75 #endif
76
77
78
uint32
unsigned int uint32
Definition: Defs.h:95
OpenZWave::SensorAlarm::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: SensorAlarm.h:45
OpenZWave::SensorAlarm::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: SensorAlarm.cpp:78
OpenZWave::SensorAlarm::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: SensorAlarm.h:49
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:56
uint8
unsigned char uint8
Definition: Defs.h:89
OpenZWave::SensorAlarm::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: SensorAlarm.h:54
OpenZWave::SensorAlarm
Implements COMMAND_CLASS_SENSOR_ALARM (0x9c), a Z-Wave device command class.
Definition: SensorAlarm.h:43
OpenZWave::SensorAlarm::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: SensorAlarm.h:48
OpenZWave::SensorAlarm::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: SensorAlarm.h:55
OpenZWave::SensorAlarm::~SensorAlarm
virtual ~SensorAlarm()
Definition: SensorAlarm.h:46
CommandClass.h
OpenZWave::SensorAlarm::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _alarmType, uint8 const _dummy, Driver::MsgQueue const _queue)
Definition: SensorAlarm.cpp:112
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:592
uint16
unsigned short uint16
Definition: Defs.h:92
OpenZWave
Definition: Bitfield.h:35
OpenZWave::SensorAlarm::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: SensorAlarm.cpp:159