1 //-----------------------------------------------------------------------------
2 //
3 //	MultiChannelAssociation.h
4 //
5 //	Implementation of the Z-Wave COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION
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 _MultiChannelAssociation_H
29 #define _MultiChannelAssociation_H
30 
31 #include <vector>
32 #include "Group.h"
33 #include "command_classes/CommandClass.h"
34 
35 namespace OpenZWave
36 {
37 	/** \brief Implements COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION (0x8E), a Z-Wave device command class.
38 	 */
39 	class MultiChannelAssociation: public CommandClass
40 	{
41 		friend class Group;
42 
43 	public:
Create(uint32 const _homeId,uint8 const _nodeId)44 		static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new MultiChannelAssociation( _homeId, _nodeId ); }
~MultiChannelAssociation()45 		virtual ~MultiChannelAssociation(){}
46 
StaticGetCommandClassId()47 		static uint8 const StaticGetCommandClassId(){ return 0x8e; }
StaticGetCommandClassName()48 		static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION"; }
49 
50 		// From CommandClass
51 		virtual void ReadXML( TiXmlElement const* _ccElement );
52 		virtual void WriteXML( TiXmlElement* _ccElement );
53 		virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
54 		virtual bool RequestValue( uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
GetCommandClassId()55 		virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
GetCommandClassName()56 		virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
57 		virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
58 
59 		void RequestAllGroups( uint32 const _requestFlags );
60 		void Set( uint8 const _group, uint8 const _nodeId, uint8 const _instance );
61 		void Remove( uint8 const _group, uint8 const _nodeId, uint8 const _instance );
62 
63 	private:
64 		MultiChannelAssociation( uint32 const _homeId, uint8 const _nodeId );
65 		void QueryGroup( uint8 _groupIdx, uint32 const _requestFlags );
66 		void AutoAssociate();
67 
68 		bool			m_queryAll;			// When true, once a group has been queried, we request the next one.
69 		uint8			m_numGroups;		// Number of groups supported by the device.  255 is reported by certain manufacturers and requires special handling.
70 		vector<InstanceAssociation>	m_pendingMembers;	// Used to build a list of group members from multiple reports
71 		bool			m_alwaysSetInstance; // Should we also set a instance, even if a instance wasn't specified (for Qubino devices - See bug #857)
72 
73 	};
74 
75 } // namespace OpenZWave
76 
77 #endif
78 
79