OpenZWave Library  1.6.1280
Indicator.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Indicator.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_INDICATOR
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 _Indicator_H
29 #define _Indicator_H
30 
32 #include "TimerThread.h"
33 
34 
35 namespace OpenZWave
36 {
37  namespace Internal
38  {
39  namespace CC
40  {
41 
45  class Indicator: public CommandClass, private Timer
46  {
47  public:
48  static CommandClass* Create(uint32 const _homeId, uint8 const _nodeId)
49  {
50  return new Indicator(_homeId, _nodeId);
51  }
52  virtual ~Indicator()
53  {
54  }
55 
57  {
58  return 0x87;
59  }
60  static string const StaticGetCommandClassName()
61  {
62  return "COMMAND_CLASS_INDICATOR";
63  }
64 
65  // From CommandClass
66  virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override;
67  virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override;
68  virtual uint8 const GetCommandClassId() const override
69  {
70  return StaticGetCommandClassId();
71  }
72  virtual string const GetCommandClassName() const override
73  {
75  }
76  virtual bool HandleMsg(uint8 const* _data, uint32 const _length, uint32 const _instance = 1) override;
77  virtual bool SetValue(Internal::VC::Value const& _value) override;
78  virtual uint8 GetMaxVersion() override
79  {
80  return 4;
81  }
82  virtual void SetValueBasic(uint8 const _instance, uint8 const _value) override;
83  protected:
84  virtual void CreateVars(uint8 const _instance) override;
85 
86  private:
87  struct Properties {
88  uint8 id;
89  uint8 instance;
90  uint8 properties;
91  string label;
92  };
93  void createIndicatorConfigValues(uint8 id);
94  void setIndicatorValue(uint8 id, uint8 _instance, uint8 property, uint8 value);
95  void refreshIndicator(uint32 id);
96  Indicator(uint32 const _homeId, uint8 const _nodeId);
97  std::map<uint8, std::shared_ptr<Properties> > m_indicatorLists;
98  };
99  } // namespace CC
100  } // namespace Internal
101 } // namespace OpenZWave
102 
103 #endif
104 
virtual uint8 const GetCommandClassId() const override
Definition: Indicator.h:68
Definition: Bitfield.cpp:30
MsgQueue
Definition: Driver.h:659
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: Indicator.cpp:220
unsigned short uint16
Definition: Defs.h:88
virtual bool SetValue(Internal::VC::Value const &_value) override
Definition: Indicator.cpp:454
virtual uint8 GetMaxVersion() override
Definition: Indicator.h:78
void CreateVars()
Definition: CommandClass.cpp:841
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Indicator.h:48
Base class for all Z-Wave command classes.
Definition: CommandClass.h:60
static uint8 const StaticGetCommandClassId()
Definition: Indicator.h:56
virtual void SetValueBasic(uint8 const _instance, uint8 const _value) override
Definition: Indicator.cpp:847
unsigned int uint32
Definition: Defs.h:91
Timer SubClass for automatically registering/unregistering Timer Callbacks if the instance goes out o...
Definition: TimerThread.h:127
virtual ~Indicator()
Definition: Indicator.h:52
virtual string const GetCommandClassName() const override
Definition: Indicator.h:72
static string const StaticGetCommandClassName()
Definition: Indicator.h:60
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: Indicator.cpp:260
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1) override
Definition: Indicator.cpp:302
Base class for values associated with a node.
Definition: Value.h:54
Implements COMMAND_CLASS_INDICATOR (0x87), a Z-Wave device command class.
Definition: Indicator.h:45
unsigned char uint8
Definition: Defs.h:85