OpenZWave Library: Color.h Source File

| OpenZWave Library 1.6.0

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
31#include "command_classes/CommandClass.h"
32
33namespace OpenZWave
34{
35 class ValueByte;
36
40 class Color: public CommandClass
41 {
42 public:
43 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Color( _homeId, _nodeId ); }
44 virtual ~Color(){}
45
46 static uint8 const StaticGetCommandClassId(){ return 0x33; }
47 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_COLOR"; }
48
49 // From CommandClass
50 virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
51 virtual bool RequestValue( uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
52 bool RequestColorChannelReport( uint8 const coloridx, uint8 const _instance, Driver::MsgQueue const _queue );
53 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
54 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
55 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
56 virtual bool SetValue( Value const& _value );
57 virtual uint8 GetMaxVersion(){ return 2; }
58 virtual void SetValueBasic( uint8 const _instance, uint8 const _value );
59
60 protected:
61 virtual void CreateVars( uint8 const _instance );
62
63 private:
64 Color( uint32 const _homeId, uint8 const _nodeId );
65 bool m_refreshinprogress;
66 uint8 m_coloridxcount;
67 uint8 m_colorvalues[9];
68 };
69
70} // namespace OpenZWave
71
72#endif
73
CommandClass.h
uint16
unsigned short uint16
Definition: Defs.h:92
uint32
unsigned int uint32
Definition: Defs.h:95
uint8
unsigned char uint8
Definition: Defs.h:89
OpenZWave::Color
Implements COMMAND_CLASS_COLOR (0x33), a Z-Wave device command class.
Definition: Color.h:41
OpenZWave::Color::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: Color.h:46
OpenZWave::Color::~Color
virtual ~Color()
Definition: Color.h:44
OpenZWave::Color::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: Color.cpp:271
OpenZWave::Color::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: Color.h:53
OpenZWave::Color::SetValue
virtual bool SetValue(Value const &_value)
Definition: Color.cpp:619
OpenZWave::Color::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Color.cpp:192
OpenZWave::Color::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Color.h:43
OpenZWave::Color::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: Color.h:47
OpenZWave::Color::CreateVars
virtual void CreateVars(uint8 const _instance)
Definition: Color.cpp:1049
OpenZWave::Color::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Color.cpp:140
OpenZWave::Color::SetValueBasic
virtual void SetValueBasic(uint8 const _instance, uint8 const _value)
Definition: Color.cpp:1067
OpenZWave::Color::GetMaxVersion
virtual uint8 GetMaxVersion()
Definition: Color.h:57
OpenZWave::Color::RequestColorChannelReport
bool RequestColorChannelReport(uint8 const coloridx, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Color.cpp:221
OpenZWave::Color::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: Color.h:54
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:56
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:592
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:49
OpenZWave
Definition: Bitfield.h:35