| OpenZWave Library 1.6.0

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
31 #include "command_classes/CommandClass.h"
32
33 namespace OpenZWave
34 {
35 class ValueBool;
36 class ValueButton;
37 class ValueByte;
38
42 class SwitchMultilevel: public CommandClass
43 {
44 public:
45 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new SwitchMultilevel( _homeId, _nodeId ); }
46 virtual ~SwitchMultilevel(){}
47
48 static uint8 const StaticGetCommandClassId(){ return 0x26; }
49 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_SWITCH_MULTILEVEL"; }
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 _index, uint8 const _instance, 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 virtual bool HandleIncomingMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
58 virtual bool SetValue( Value const& _value );
59 virtual void SetValueBasic( uint8 const _instance, uint8 const _value );
60 virtual void SetVersion( uint8 const _version );
61
62 virtual uint8 GetMaxVersion(){ return 4; }
63
64 protected:
65 virtual void CreateVars( uint8 const _instance );
66
67 private:
68 enum SwitchMultilevelDirection
69 {
70 SwitchMultilevelDirection_Up = 0,
71 SwitchMultilevelDirection_Down,
72 SwitchMultilevelDirection_Inc,
73 SwitchMultilevelDirection_Dec
74 };
75
76 SwitchMultilevel( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
77
78 bool SetLevel( uint8 const _instance, uint8 const _level );
79 bool StartLevelChange( uint8 const _instance, SwitchMultilevelDirection const _direction );
80 bool StopLevelChange( uint8 const _instance );
81 };
82
83 } // namespace OpenZWave
84
85 #endif
86
uint32
unsigned int uint32
Definition: Defs.h:95
OpenZWave::SwitchMultilevel::HandleIncomingMsg
virtual bool HandleIncomingMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: SwitchMultilevel.cpp:160
OpenZWave::SwitchMultilevel::SetValue
virtual bool SetValue(Value const &_value)
Definition: SwitchMultilevel.cpp:319
OpenZWave::SwitchMultilevel::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: SwitchMultilevel.cpp:191
OpenZWave::SwitchMultilevel::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: SwitchMultilevel.h:48
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:56
uint8
unsigned char uint8
Definition: Defs.h:89
OpenZWave::SwitchMultilevel::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: SwitchMultilevel.cpp:132
OpenZWave::SwitchMultilevel::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: SwitchMultilevel.h:55
OpenZWave::SwitchMultilevel::CreateVars
virtual void CreateVars(uint8 const _instance)
Definition: SwitchMultilevel.cpp:653
OpenZWave::SwitchMultilevel::SetValueBasic
virtual void SetValueBasic(uint8 const _instance, uint8 const _value)
Definition: SwitchMultilevel.cpp:456
OpenZWave::SwitchMultilevel::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: SwitchMultilevel.h:54
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:49
OpenZWave::SwitchMultilevel::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: SwitchMultilevel.h:45
OpenZWave::SwitchMultilevel::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: SwitchMultilevel.cpp:113
CommandClass.h
OpenZWave::SwitchMultilevel
Implements COMMAND_CLASS_SWITCH_MULTILEVEL (0x26), a Z-Wave device command class.
Definition: SwitchMultilevel.h:43
OpenZWave::SwitchMultilevel::~SwitchMultilevel
virtual ~SwitchMultilevel()
Definition: SwitchMultilevel.h:46
OpenZWave::SwitchMultilevel::SetVersion
virtual void SetVersion(uint8 const _version)
Definition: SwitchMultilevel.cpp:291
OpenZWave::SwitchMultilevel::GetMaxVersion
virtual uint8 GetMaxVersion()
Definition: SwitchMultilevel.h:62
OpenZWave::CommandClass::CommandClass
CommandClass(uint32 const _homeId, uint8 const _nodeId)
Definition: CommandClass.cpp:56
OpenZWave::SwitchMultilevel::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: SwitchMultilevel.h:49
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:592
uint16
unsigned short uint16
Definition: Defs.h:92
OpenZWave
Definition: Bitfield.h:35