OpenZWave Library  1.6.953
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  namespace Internal
36  {
37  namespace CC
38  {
39 
44  {
45  public:
46  static CommandClass* Create(uint32 const _homeId, uint8 const _nodeId)
47  {
48  return new SwitchMultilevel(_homeId, _nodeId);
49  }
51  {
52  }
53 
55  {
56  return 0x26;
57  }
58  static string const StaticGetCommandClassName()
59  {
60  return "COMMAND_CLASS_SWITCH_MULTILEVEL";
61  }
62 
63  // From CommandClass
64  virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override;
65  virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override;
66  virtual uint8 const GetCommandClassId() const override
67  {
68  return StaticGetCommandClassId();
69  }
70  virtual string const GetCommandClassName() const override
71  {
73  }
74  virtual bool HandleMsg(uint8 const* _data, uint32 const _length, uint32 const _instance = 1) override;
75  virtual bool HandleIncomingMsg(uint8 const* _data, uint32 const _length, uint32 const _instance = 1) override;
76  virtual bool SetValue(Internal::VC::Value const& _value) override;
77  virtual void SetValueBasic(uint8 const _instance, uint8 const _value) override;
78  virtual void SetVersion(uint8 const _version) override;
79 
80  virtual uint8 GetMaxVersion() override
81  {
82  return 4;
83  }
84 
85  protected:
86  virtual void CreateVars(uint8 const _instance) override;
87 
88  private:
89  enum SwitchMultilevelDirection
90  {
91  SwitchMultilevelDirection_Up = 0,
92  SwitchMultilevelDirection_Down,
93  SwitchMultilevelDirection_Inc,
94  SwitchMultilevelDirection_Dec
95  };
96 
97  SwitchMultilevel(uint32 const _homeId, uint8 const _nodeId) :
98  CommandClass(_homeId, _nodeId)
99  {
100  }
101 
102  bool SetLevel(uint8 const _instance, uint8 const _level);
103  bool StartLevelChange(uint8 const _instance, SwitchMultilevelDirection const _direction);
104  bool StopLevelChange(uint8 const _instance);
105  };
106  } // namespace CC
107  } // namespace Internal
108 } // namespace OpenZWave
109 
110 #endif
111 
virtual uint8 const GetCommandClassId() const override
Definition: SwitchMultilevel.h:66
virtual bool SetValue(Internal::VC::Value const &_value) override
Definition: SwitchMultilevel.cpp:261
Definition: Bitfield.cpp:30
MsgQueue
Definition: Driver.h:656
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1) override
Definition: SwitchMultilevel.cpp:139
unsigned short uint16
Definition: Defs.h:88
static string const StaticGetCommandClassName()
Definition: SwitchMultilevel.h:58
Implements COMMAND_CLASS_SWITCH_MULTILEVEL (0x26), a Z-Wave device command class.
Definition: SwitchMultilevel.h:43
virtual void CreateVars(uint8 const _instance) override
Definition: SwitchMultilevel.cpp:585
Base class for all Z-Wave command classes.
Definition: CommandClass.h:60
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: SwitchMultilevel.cpp:75
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: SwitchMultilevel.cpp:89
virtual bool HandleIncomingMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1) override
Definition: SwitchMultilevel.cpp:113
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: SwitchMultilevel.h:46
unsigned int uint32
Definition: Defs.h:91
virtual uint8 GetMaxVersion() override
Definition: SwitchMultilevel.h:80
CommandClass(uint32 const _homeId, uint8 const _nodeId)
Definition: CommandClass.cpp:62
static uint8 const StaticGetCommandClassId()
Definition: SwitchMultilevel.h:54
virtual ~SwitchMultilevel()
Definition: SwitchMultilevel.h:50
virtual void SetValueBasic(uint8 const _instance, uint8 const _value) override
Definition: SwitchMultilevel.cpp:395
virtual void SetVersion(uint8 const _version) override
Definition: SwitchMultilevel.cpp:236
Base class for values associated with a node.
Definition: Value.h:53
virtual string const GetCommandClassName() const override
Definition: SwitchMultilevel.h:70
unsigned char uint8
Definition: Defs.h:85