OpenZWave Library  1.6.784
SoundSwitch.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // SoundSwitch.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_SOUND_SWITCH
6 //
7 // Copyright (c) 2014 Justin Hammond <Justin@dynam.ac>
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 _SoundSwitch_H
29 #define _SoundSwitch_H
30 
32 
33 namespace OpenZWave
34 {
35  namespace Internal
36  {
37  namespace CC
38  {
39 
43  class SoundSwitch: public CommandClass
44  {
45  private:
46  struct SoundSwitchToneInfo
47  {
48  uint16 duration;
49  string name;
50  };
51  public:
52  static CommandClass* Create(uint32 const _homeId, uint8 const _nodeId)
53  {
54  return new SoundSwitch(_homeId, _nodeId);
55  }
56  virtual ~SoundSwitch()
57  {
58  }
59 
61  {
62  return 0x79;
63  }
64  static string const StaticGetCommandClassName()
65  {
66  return "COMMAND_CLASS_SOUND_SWITCH";
67  }
68 
69  // From CommandClass
70  virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override;
71  virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override;
72  virtual uint8 const GetCommandClassId() const override
73  {
74  return StaticGetCommandClassId();
75  }
76  virtual string const GetCommandClassName() const override
77  {
79  }
80  virtual bool HandleMsg(uint8 const* _data, uint32 const _length, uint32 const _instance = 1) override;
81  virtual bool SetValue(Internal::VC::Value const& _value) override;
82 
83  protected:
84  virtual void CreateVars(uint8 const _instance) override;
85 
86  private:
87  SoundSwitch(uint32 const _homeId, uint8 const _nodeId);
88 
89  uint8 m_toneCount;
90  std::map<uint8, SoundSwitchToneInfo> m_toneInfo;
91  };
92  } // namespace CC
93  } // namespace Internal
94 } // namespace OpenZWave
95 
96 #endif
97 
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1) override
Definition: SoundSwitch.cpp:117
Definition: Bitfield.cpp:30
MsgQueue
Definition: Driver.h:658
virtual uint8 const GetCommandClassId() const override
Definition: SoundSwitch.h:72
unsigned short uint16
Definition: Defs.h:89
virtual void CreateVars(uint8 const _instance) override
Definition: SoundSwitch.cpp:291
static string const StaticGetCommandClassName()
Definition: SoundSwitch.h:64
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: SoundSwitch.cpp:73
static uint8 const StaticGetCommandClassId()
Definition: SoundSwitch.h:60
Base class for all Z-Wave command classes.
Definition: CommandClass.h:60
Implements COMMAND_CLASS_SOUND_SWITCH (0x79), a Z-Wave device command class.
Definition: SoundSwitch.h:43
virtual ~SoundSwitch()
Definition: SoundSwitch.h:56
virtual bool SetValue(Internal::VC::Value const &_value) override
Definition: SoundSwitch.cpp:229
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: SoundSwitch.h:52
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: SoundSwitch.cpp:88
unsigned int uint32
Definition: Defs.h:92
virtual string const GetCommandClassName() const override
Definition: SoundSwitch.h:76
Base class for values associated with a node.
Definition: Value.h:54
unsigned char uint8
Definition: Defs.h:86