OpenZWave Library  1.5.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SwitchMultilevel.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // SwitchMultilevel.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_SWITCH_MULTILEVEL
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 _SwitchMultilevel_H
29 #define _SwitchMultilevel_H
30 
32 
33 namespace OpenZWave
34 {
35  class ValueBool;
36  class ValueButton;
37  class ValueByte;
38 
42  {
43  public:
44  static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new SwitchMultilevel( _homeId, _nodeId ); }
45  virtual ~SwitchMultilevel(){}
46 
47  static uint8 const StaticGetCommandClassId(){ return 0x26; }
48  static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_SWITCH_MULTILEVEL"; }
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 );
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  virtual void SetVersion( uint8 const _version );
59 
60  virtual uint8 GetMaxVersion(){ return 3; }
61 
62  protected:
63  virtual void CreateVars( uint8 const _instance );
64 
65  private:
66  enum SwitchMultilevelDirection
67  {
68  SwitchMultilevelDirection_Up = 0,
69  SwitchMultilevelDirection_Down,
70  SwitchMultilevelDirection_Inc,
71  SwitchMultilevelDirection_Dec
72  };
73 
74  SwitchMultilevel( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
75 
76  bool SetLevel( uint8 const _instance, uint8 const _level );
77  bool StartLevelChange( uint8 const _instance, SwitchMultilevelDirection const _direction );
78  bool StopLevelChange( uint8 const _instance );
79  };
80 
81 } // namespace OpenZWave
82 
83 #endif
84 
virtual void SetVersion(uint8 const _version)
Definition: SwitchMultilevel.cpp:243
MsgQueue
Definition: Driver.h:565
virtual bool SetValue(Value const &_value)
Definition: SwitchMultilevel.cpp:271
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: SwitchMultilevel.cpp:163
static uint8 const StaticGetCommandClassId()
Definition: SwitchMultilevel.h:47
static string const StaticGetCommandClassName()
Definition: SwitchMultilevel.h:48
virtual bool RequestValue(uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: SwitchMultilevel.cpp:131
Base class for all Z-Wave command classes.
Definition: CommandClass.h:46
CommandClass(uint32 const _homeId, uint8 const _nodeId)
Definition: CommandClass.cpp:55
virtual ~SwitchMultilevel()
Definition: SwitchMultilevel.h:45
virtual string const GetCommandClassName() const
Definition: SwitchMultilevel.h:54
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: SwitchMultilevel.cpp:112
unsigned int uint32
Definition: Defs.h:80
Implements COMMAND_CLASS_SWITCH_MULTILEVEL (0x26), a Z-Wave device command class. ...
Definition: SwitchMultilevel.h:41
virtual void SetValueBasic(uint8 const _instance, uint8 const _value)
Definition: SwitchMultilevel.cpp:408
virtual uint8 GetMaxVersion()
Definition: SwitchMultilevel.h:60
virtual uint8 const GetCommandClassId() const
Definition: SwitchMultilevel.h:53
Base class for values associated with a node.
Definition: Value.h:47
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: SwitchMultilevel.h:44
virtual void CreateVars(uint8 const _instance)
Definition: SwitchMultilevel.cpp:597
unsigned char uint8
Definition: Defs.h:74