OpenZWave Library: SwitchToggleMultilevel.h Source File

| OpenZWave Library 1.6.0

SwitchToggleMultilevel.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // SwitchToggleMultilevel.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_SWITCH_TOGGLE_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 _SwitchToggleMultilevel_H
29 #define _SwitchToggleMultilevel_H
30
31 #include "command_classes/CommandClass.h"
32
33 namespace OpenZWave
34 {
35 class ValueByte;
36
40 class SwitchToggleMultilevel: public CommandClass
41 {
42 public:
43 enum SwitchToggleMultilevelDirection
44 {
45 SwitchToggleMultilevelDirection_Up = 0x00,
46 SwitchToggleMultilevelDirection_Down = 0x40
47 };
48
49 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new SwitchToggleMultilevel( _homeId, _nodeId ); }
50 virtual ~SwitchToggleMultilevel(){}
51
52 static uint8 const StaticGetCommandClassId(){ return 0x29; }
53 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_SWITCH_TOGGLE_MULTILEVEL"; }
54
55 void StartLevelChange( SwitchToggleMultilevelDirection const _direction, bool const _bIgnoreStartLevel, bool const _bRollover );
56 void StopLevelChange();
57
58 // From CommandClass
59 virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
60 virtual bool RequestValue( uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
61 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
62 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
63 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
64 virtual bool SetValue( Value const& _value );
65
66 protected:
67 virtual void CreateVars( uint8 const _instance );
68
69 private:
70 SwitchToggleMultilevel( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
71 };
72
73 } // namespace OpenZWave
74
75 #endif
76
OpenZWave
Definition: Bitfield.h:34
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:591
uint16
unsigned short uint16
Definition: Defs.h:92
OpenZWave::SwitchToggleMultilevel::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: SwitchToggleMultilevel.h:49
CommandClass.h
OpenZWave::SwitchToggleMultilevel::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: SwitchToggleMultilevel.cpp:55
OpenZWave::SwitchToggleMultilevel::StartLevelChange
void StartLevelChange(SwitchToggleMultilevelDirection const _direction, bool const _bIgnoreStartLevel, bool const _bRollover)
Definition: SwitchToggleMultilevel.cpp:150
OpenZWave::SwitchToggleMultilevel::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: SwitchToggleMultilevel.h:53
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:55
OpenZWave::SwitchToggleMultilevel::StopLevelChange
void StopLevelChange()
Definition: SwitchToggleMultilevel.cpp:175
OpenZWave::SwitchToggleMultilevel::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: SwitchToggleMultilevel.h:62
OpenZWave::SwitchToggleMultilevel::SwitchToggleMultilevelDirection_Up
Definition: SwitchToggleMultilevel.h:45
OpenZWave::SwitchToggleMultilevel::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: SwitchToggleMultilevel.cpp:74
OpenZWave::SwitchToggleMultilevel::SwitchToggleMultilevelDirection
SwitchToggleMultilevelDirection
Definition: SwitchToggleMultilevel.h:43
uint32
unsigned int uint32
Definition: Defs.h:95
OpenZWave::SwitchToggleMultilevel::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: SwitchToggleMultilevel.cpp:103
OpenZWave::SwitchToggleMultilevel::CreateVars
virtual void CreateVars(uint8 const _instance)
Definition: SwitchToggleMultilevel.cpp:192
OpenZWave::SwitchToggleMultilevel::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: SwitchToggleMultilevel.h:52
OpenZWave::SwitchToggleMultilevel::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: SwitchToggleMultilevel.h:61
OpenZWave::SwitchToggleMultilevel
Implements COMMAND_CLASS_SWITCH_TOGGLE_MULTILEVEL (0x29), a Z-Wave device command class.
Definition: SwitchToggleMultilevel.h:40
OpenZWave::SwitchToggleMultilevel::SwitchToggleMultilevelDirection_Down
Definition: SwitchToggleMultilevel.h:46
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:48
OpenZWave::SwitchToggleMultilevel::SetValue
virtual bool SetValue(Value const &_value)
Definition: SwitchToggleMultilevel.cpp:129
OpenZWave::SwitchToggleMultilevel::~SwitchToggleMultilevel
virtual ~SwitchToggleMultilevel()
Definition: SwitchToggleMultilevel.h:50
uint8
unsigned char uint8
Definition: Defs.h:89