OpenZWave Library 1.6.1914
CentralScene.h
Go to the documentation of this file.
1//-----------------------------------------------------------------------------
2//
3// CentralScene.h
4//
5// Implementation of the Z-Wave COMMAND_CLASS_CENTRAL_SCENE
6//
7// Copyright (c) 2012 Greg Satz <satz@iranger.com>
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 _CentralScene_H
29#define _CentralScene_H
30
32#include "TimerThread.h"
33
34namespace OpenZWave
35{
36 namespace Internal
37 {
38 namespace CC
39 {
40
44 class CentralScene: public CommandClass, private Timer
45 {
46 public:
47 static CommandClass* Create(uint32 const _homeId, uint8 const _nodeId)
48 {
49 return new CentralScene(_homeId, _nodeId);
50 }
51 virtual ~CentralScene()
52 {
53 }
54
57 {
58 return 0x5B;
59 }
61 static string const StaticGetCommandClassName()
62 {
63 return "COMMAND_CLASS_CENTRAL_SCENE";
64 }
65
66 // From CommandClass
68 virtual uint8 const GetCommandClassId() const override
69 {
71 }
73 virtual string const GetCommandClassName() const override
74 {
76 }
77 virtual uint8 GetMaxVersion() override
78 {
79 return 3;
80 }
82 virtual bool HandleMsg(uint8 const* _data, uint32 const _length, uint32 const _instance = 1) override;
83 bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override;
84 bool RequestValue(uint32 const _requestFlags, uint16 const _what, uint8 const _instance, Driver::MsgQueue const _queue) override;
85 bool SetValue(Internal::VC::Value const& _value) override;
86 protected:
88 void CreateVars(uint8 const _instance) override;
89
90 private:
98 void createSupportedKeyAttributesValues(uint8 keyAttributes, uint8 sceneNumber, uint8 instance);
99 void ClearScene(uint32 sceneID);
100 CentralScene(uint32 const _homeId, uint8 const _nodeId);
101 bool m_slowrefresh;
102 uint8 m_sequence;
103 std::map<uint32, uint32> m_TimersSet;
104 };
105 } // namespace CC
106 } // namespace Internal
107} // namespace OpenZWave
108
109#endif
unsigned short uint16
Definition: Defs.h:88
unsigned int uint32
Definition: Defs.h:91
unsigned char uint8
Definition: Defs.h:85
MsgQueue
Definition: Driver.h:660
Implements COMMAND_CLASS_CENTRAL_SCENE (0x5B), a Z-Wave device command class.
Definition: CentralScene.h:45
static uint8 const StaticGetCommandClassId()
Get command class ID (1 byte) identifying this command class.
Definition: CentralScene.h:56
virtual uint8 GetMaxVersion() override
Definition: CentralScene.h:77
virtual string const GetCommandClassName() const override
Get a string containing the name of this command class. (Inherited from CommandClass)
Definition: CentralScene.h:73
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1) override
Handle a response to a message associated with this command class. (Inherited from CommandClass)
Definition: CentralScene.cpp:151
virtual ~CentralScene()
Definition: CentralScene.h:51
static string const StaticGetCommandClassName()
Get a string containing the name of this command class.
Definition: CentralScene.h:61
bool RequestValue(uint32 const _requestFlags, uint16 const _what, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: CentralScene.cpp:116
bool SetValue(Internal::VC::Value const &_value) override
Definition: CentralScene.cpp:136
virtual uint8 const GetCommandClassId() const override
Get command class ID (1 byte) identifying this command class. (Inherited from CommandClass)
Definition: CentralScene.h:68
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: CentralScene.h:47
bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: CentralScene.cpp:102
Base class for all Z-Wave command classes.
Definition: CommandClass.h:61
void CreateVars()
Definition: CommandClass.cpp:841
Timer SubClass for automatically registering/unregistering Timer Callbacks if the instance goes out o...
Definition: TimerThread.h:128
Base class for values associated with a node.
Definition: Value.h:55
Definition: Bitfield.cpp:31