OpenZWave Library  1.6.986
Basic.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Basic.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_BASIC
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 _Basic_H
29 #define _Basic_H
30 
32 
33 namespace OpenZWave
34 {
35  namespace Internal
36  {
37  namespace CC
38  {
42  class Basic: public CommandClass
43  {
44  public:
45  static CommandClass* Create(uint32 const _homeId, uint8 const _nodeId)
46  {
47  return new Basic(_homeId, _nodeId);
48  }
49  virtual ~Basic()
50  {
51  }
52 
54  {
55  return 0x20;
56  }
57  static string const StaticGetCommandClassName()
58  {
59  return "COMMAND_CLASS_BASIC";
60  }
61 
62  bool SetMapping(uint8 const _commandClassId, bool const _doLog = true); // Map COMMAND_CLASS_BASIC messages to another command class
63  uint8_t GetMapping()
64  {
66  }
67  ;
68  // From CommandClass
69  virtual void ReadXML(TiXmlElement const* _ccElement) override;
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 HandleIncomingMsg(uint8 const* _data, uint32 const _length, uint32 const _instance = 1) override;
82  virtual bool SetValue(Internal::VC::Value const& _value) override;
83 
84  void Set(uint8 const _level);
85 
86  protected:
87  virtual void CreateVars(uint8 const _instance) override;
88 
89  private:
90  Basic(uint32 const _homeId, uint8 const _nodeId);
91 
92  std::vector<int> m_instances;
93  };
94  } // namespace CC
95  } // namespace Internal
96 } // namespace OpenZWave
97 
98 #endif
99 
Definition: Bitfield.cpp:30
MsgQueue
Definition: Driver.h:659
static string const StaticGetCommandClassName()
Definition: Basic.h:57
virtual uint8 const GetCommandClassId() const override
Definition: Basic.h:72
virtual void ReadXML(TiXmlElement const *_ccElement) override
Definition: Basic.cpp:73
void Set(uint8 const _level)
Definition: Basic.cpp:228
unsigned short uint16
Definition: Defs.h:88
Definition: CompatOptionManager.h:55
virtual void CreateVars(uint8 const _instance) override
Definition: Basic.cpp:219
virtual ~Basic()
Definition: Basic.h:49
bool SetMapping(uint8 const _commandClassId, bool const _doLog=true)
Definition: Basic.cpp:243
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: Basic.cpp:83
Implements COMMAND_CLASS_BASIC (0x20), a Z-Wave device command class.
Definition: Basic.h:42
Base class for all Z-Wave command classes.
Definition: CommandClass.h:60
virtual string const GetCommandClassName() const override
Definition: Basic.h:76
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: Basic.cpp:102
uint8_t GetMapping()
Definition: Basic.h:63
unsigned int uint32
Definition: Defs.h:91
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Basic.h:45
virtual bool HandleIncomingMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1) override
Definition: Basic.cpp:124
virtual bool SetValue(Internal::VC::Value const &_value) override
Definition: Basic.cpp:193
CompatOptionManager m_com
Definition: CommandClass.h:230
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1) override
Definition: Basic.cpp:135
static uint8 const StaticGetCommandClassId()
Definition: Basic.h:53
uint8_t GetFlagByte(CompatOptionFlags flag, uint32_t index=-1) const
Definition: CompatOptionManager.cpp:466
Base class for values associated with a node.
Definition: Value.h:53
unsigned char uint8
Definition: Defs.h:85