OpenZWave Library  1.5.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Color.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Color.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_COLOR
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 _Color_H
29 #define _Color_H
30 
32 
33 namespace OpenZWave
34 {
35  class ValueByte;
36 
39  class Color: public CommandClass
40  {
41  public:
42  static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Color( _homeId, _nodeId ); }
43  virtual ~Color(){}
44 
45  static uint8 const StaticGetCommandClassId(){ return 0x33; }
46  static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_COLOR"; }
47 
48  // From CommandClass
49  virtual void ReadXML( TiXmlElement const* _ccElement );
50  virtual void WriteXML( TiXmlElement* _ccElement );
51  virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
52  virtual bool RequestValue( uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
53  bool RequestColorChannelReport( uint8 const coloridx, uint8 const _instance, Driver::MsgQueue const _queue );
54  virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
55  virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
56  virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
57  virtual bool SetValue( Value const& _value );
58  virtual uint8 GetMaxVersion(){ return 2; }
59  virtual void SetValueBasic( uint8 const _instance, uint8 const _value );
60 
61  protected:
62  virtual void CreateVars( uint8 const _instance );
63 
64  private:
65  Color( uint32 const _homeId, uint8 const _nodeId );
66  uint16 m_capabilities;
67  bool m_coloridxbug; // Fibaro RGBW before version 25.25 always reported the coloridx as 3 in the Report Message. Work around it
68  bool m_refreshinprogress;
69  uint8 m_coloridxcount;
70  uint8 m_colorvalues[9];
71  };
72 
73 } // namespace OpenZWave
74 
75 #endif
76 
static uint8 const StaticGetCommandClassId()
Definition: Color.h:45
MsgQueue
Definition: Driver.h:565
unsigned short uint16
Definition: Defs.h:77
virtual void CreateVars(uint8 const _instance)
Definition: Color.cpp:1095
virtual bool SetValue(Value const &_value)
Definition: Color.cpp:667
virtual void WriteXML(TiXmlElement *_ccElement)
Definition: Color.cpp:165
Base class for all Z-Wave command classes.
Definition: CommandClass.h:46
virtual uint8 GetMaxVersion()
Definition: Color.h:58
virtual bool RequestValue(uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Color.cpp:242
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Color.h:42
virtual uint8 const GetCommandClassId() const
Definition: Color.h:54
unsigned int uint32
Definition: Defs.h:80
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: Color.cpp:321
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Color.cpp:190
static string const StaticGetCommandClassName()
Definition: Color.h:46
virtual ~Color()
Definition: Color.h:43
bool RequestColorChannelReport(uint8 const coloridx, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Color.cpp:271
virtual string const GetCommandClassName() const
Definition: Color.h:55
virtual void SetValueBasic(uint8 const _instance, uint8 const _value)
Definition: Color.cpp:1113
Implements COMMAND_CLASS_COLOR (0x33), a Z-Wave device command class.
Definition: Color.h:39
Base class for values associated with a node.
Definition: Value.h:47
virtual void ReadXML(TiXmlElement const *_ccElement)
Definition: Color.cpp:140
unsigned char uint8
Definition: Defs.h:74