| OpenZWave Library 1.6.0

Powerlevel.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Powerlevel.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_POWERLEVEL
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 _Powerlevel_H
29 #define _Powerlevel_H
30
31 #include "command_classes/CommandClass.h"
32
33 namespace OpenZWave
34 {
35 class ValueList;
36
40 class Powerlevel: public CommandClass
41 {
42 public:
43 enum PowerLevelEnum
44 {
45 PowerLevel_Normal = 0,
46 PowerLevel_Minus1dB,
47 PowerLevel_Minus2dB,
48 PowerLevel_Minus3dB,
49 PowerLevel_Minus4dB,
50 PowerLevel_Minus5dB,
51 PowerLevel_Minus6dB,
52 PowerLevel_Minus7dB,
53 PowerLevel_Minus8dB,
54 PowerLevel_Minus9dB
55 };
56
57 enum PowerLevelStatusEnum
58 {
59 PowerLevelStatus_Failed = 0,
60 PowerLevelStatus_Success,
61 PowerLevelStatus_InProgress
62 };
63
64 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Powerlevel( _homeId, _nodeId ); }
65 virtual ~Powerlevel(){}
66
67 static uint8 const StaticGetCommandClassId(){ return 0x73; }
68 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_POWERLEVEL"; }
69
70 // From CommandClass
71 virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
72 virtual bool RequestValue( uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
73 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
74 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
75 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
76 virtual bool SetValue( Value const& _value );
77
78 protected:
79 virtual void CreateVars( uint8 const _instance );
80
81 private:
82 Powerlevel( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
83
84 bool Set( uint8 const _instance );
85 bool Test( uint8 const _instance );
86 bool Report( uint8 const _instance );
87 };
88
89 } // namespace OpenZWave
90
91 #endif
92
uint32
unsigned int uint32
Definition: Defs.h:95
OpenZWave::Powerlevel::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: Powerlevel.h:67
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:56
OpenZWave::Powerlevel::PowerLevel_Minus4dB
@ PowerLevel_Minus4dB
Definition: Powerlevel.h:49
uint8
unsigned char uint8
Definition: Defs.h:89
OpenZWave::Powerlevel::PowerLevel_Minus1dB
@ PowerLevel_Minus1dB
Definition: Powerlevel.h:46
OpenZWave::Powerlevel::PowerLevel_Minus7dB
@ PowerLevel_Minus7dB
Definition: Powerlevel.h:52
OpenZWave::Powerlevel::PowerLevel_Minus8dB
@ PowerLevel_Minus8dB
Definition: Powerlevel.h:53
OpenZWave::Powerlevel::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: Powerlevel.h:74
OpenZWave::Powerlevel::PowerLevelStatus_Success
@ PowerLevelStatus_Success
Definition: Powerlevel.h:60
OpenZWave::Powerlevel
Implements COMMAND_CLASS_POWERLEVEL (0x73), a Z-Wave device command class.
Definition: Powerlevel.h:41
OpenZWave::Powerlevel::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Powerlevel.cpp:116
OpenZWave::Powerlevel::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Powerlevel.cpp:97
OpenZWave::Powerlevel::PowerLevelStatus_InProgress
@ PowerLevelStatus_InProgress
Definition: Powerlevel.h:61
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:49
OpenZWave::Powerlevel::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: Powerlevel.h:73
OpenZWave::Powerlevel::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: Powerlevel.cpp:148
CommandClass.h
OpenZWave::Powerlevel::PowerLevel_Minus2dB
@ PowerLevel_Minus2dB
Definition: Powerlevel.h:47
OpenZWave::Powerlevel::~Powerlevel
virtual ~Powerlevel()
Definition: Powerlevel.h:65
OpenZWave::Powerlevel::PowerLevel_Minus9dB
@ PowerLevel_Minus9dB
Definition: Powerlevel.h:54
OpenZWave::Powerlevel::PowerLevel_Minus6dB
@ PowerLevel_Minus6dB
Definition: Powerlevel.h:51
OpenZWave::Powerlevel::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Powerlevel.h:64
OpenZWave::Powerlevel::PowerLevel_Minus5dB
@ PowerLevel_Minus5dB
Definition: Powerlevel.h:50
OpenZWave::Powerlevel::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: Powerlevel.h:68
OpenZWave::Powerlevel::PowerLevelEnum
PowerLevelEnum
Definition: Powerlevel.h:44
OpenZWave::Powerlevel::CreateVars
virtual void CreateVars(uint8 const _instance)
Definition: Powerlevel.cpp:470
OpenZWave::Powerlevel::PowerLevel_Normal
@ PowerLevel_Normal
Definition: Powerlevel.h:45
OpenZWave::Powerlevel::SetValue
virtual bool SetValue(Value const &_value)
Definition: Powerlevel.cpp:216
OpenZWave::Powerlevel::PowerLevelStatus_Failed
@ PowerLevelStatus_Failed
Definition: Powerlevel.h:59
OpenZWave::Powerlevel::PowerLevel_Minus3dB
@ PowerLevel_Minus3dB
Definition: Powerlevel.h:48
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:592
uint16
unsigned short uint16
Definition: Defs.h:92
OpenZWave
Definition: Bitfield.h:35
OpenZWave::Powerlevel::PowerLevelStatusEnum
PowerLevelStatusEnum
Definition: Powerlevel.h:58