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