ansible4ozw 0.0.2 → 0.0.3

data/lib/ansible/zwave/openzwave/src/command_classes/Configuration.cpp

@@ -0,0 +1,258 @@
+//-----------------------------------------------------------------------------
+//
+//	Configuration.cpp
+//
+//	Implementation of the Z-Wave COMMAND_CLASS_CONFIGURATION
+//
+//	Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
+//
+//	SOFTWARE NOTICE AND LICENSE
+//
+//	This file is part of OpenZWave.
+//
+//	OpenZWave is free software: you can redistribute it and/or modify
+//	it under the terms of the GNU Lesser General Public License as published
+//	by the Free Software Foundation, either version 3 of the License,
+//	or (at your option) any later version.
+//
+//	OpenZWave is distributed in the hope that it will be useful,
+//	but WITHOUT ANY WARRANTY; without even the implied warranty of
+//	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//	GNU Lesser General Public License for more details.
+//
+//	You should have received a copy of the GNU Lesser General Public License
+//	along with OpenZWave.  If not, see <http://www.gnu.org/licenses/>.
+//
+//-----------------------------------------------------------------------------
+
+#include "CommandClasses.h"
+#include "Configuration.h"
+#include "Defs.h"
+#include "Msg.h"
+#include "Driver.h"
+#include "Node.h"
+#include "Log.h"
+#include "ValueBool.h"
+#include "ValueByte.h"
+#include "ValueInt.h"
+#include "ValueList.h"
+#include "ValueShort.h"
+
+using namespace OpenZWave;
+
+enum ConfigurationCmd
+{
+	ConfigurationCmd_Set	= 0x04,
+	ConfigurationCmd_Get	= 0x05,
+	ConfigurationCmd_Report	= 0x06
+};
+
+//-----------------------------------------------------------------------------
+// <Configuration::HandleMsg>
+// Handle a message from the Z-Wave network
+//-----------------------------------------------------------------------------
+bool Configuration::HandleMsg
+(
+	uint8 const* _data,
+	uint32 const _length,
+	uint32 const _instance	// = 1
+)
+{
+	if (ConfigurationCmd_Report == (ConfigurationCmd)_data[0])
+	{
+		// Extract the parameter index and value
+		uint8 parameter = _data[1];
+		uint8 size = _data[2] & 0x07;
+		int32 paramValue = 0;
+		for( uint8 i=0; i<size; ++i )
+		{
+			paramValue <<= 8;
+			paramValue |= (int32)_data[i+3];
+		}
+
+		if ( Value* value = GetValue( 1, parameter ) ) 
+		{
+			switch ( value->GetID().GetType() ) 
+			{
+				case ValueID::ValueType_Bool:
+				{
+					ValueBool* valueBool = static_cast<ValueBool*>( value );
+					valueBool->OnValueRefreshed( paramValue != 0 );
+					break;
+				}
+				case ValueID::ValueType_Byte:
+				{
+					ValueByte* valueByte = static_cast<ValueByte*>( value );
+					valueByte->OnValueRefreshed( (uint8)paramValue );
+					break;
+				}
+				case ValueID::ValueType_Short:
+				{
+					ValueShort* valueShort = static_cast<ValueShort*>( value );
+					valueShort->OnValueRefreshed( (int16)paramValue );
+					break;
+				}
+				case ValueID::ValueType_Int:
+				{
+					ValueInt* valueInt = static_cast<ValueInt*>( value );
+					valueInt->OnValueRefreshed( paramValue );
+					break;
+				}
+				case ValueID::ValueType_List:
+				{
+					ValueList* valueList = static_cast<ValueList*>( value );
+					valueList->OnValueRefreshed( paramValue );
+					break;
+				}
+				default:
+				{
+					Log::Write( LogLevel_Info, GetNodeId(), "Invalid type (%d) for configuration parameter %d", value->GetID().GetType(), parameter );
+				}
+			}
+			value->Release();
+		}
+		else
+		{
+			char label[16];
+			snprintf( label, 16, "Parameter #%d", parameter );
+
+			// Create a new value
+			if( Node* node = GetNodeUnsafe() )
+			{
+				switch( size )
+				{
+					case 1:
+					{
+					  	node->CreateValueByte( ValueID::ValueGenre_Config, GetCommandClassId(), _instance, parameter, label, "", false, false, (uint8)paramValue, 0 );
+						break;
+					}
+					case 2:
+					{
+					  	node->CreateValueShort( ValueID::ValueGenre_Config, GetCommandClassId(), _instance, parameter, label, "", false, false, (int16)paramValue, 0 );
+						break;
+					}
+					case 4:
+					{
+					  	node->CreateValueInt( ValueID::ValueGenre_Config, GetCommandClassId(), _instance, parameter, label, "", false, false, (int32)paramValue, 0 );
+						break;
+					}
+					default:
+					{
+						Log::Write( LogLevel_Info, GetNodeId(), "Invalid size of %d bytes for configuration parameter %d", size, parameter );
+					}
+				}
+			}
+		}
+
+		Log::Write( LogLevel_Info, GetNodeId(), "Received Configuration report: Parameter=%d, Value=%d", parameter, paramValue );
+		return true;
+	}
+
+	return false;
+}
+
+//-----------------------------------------------------------------------------
+// <Configuration::SetValue>
+// Set a value in the Z-Wave device
+//-----------------------------------------------------------------------------
+bool Configuration::SetValue
+(
+	Value const& _value
+)
+{
+	uint8 param = _value.GetID().GetIndex();
+	switch( _value.GetID().GetType() )
+	{
+		case ValueID::ValueType_Bool:
+		{
+			ValueBool const& valueBool = static_cast<ValueBool const&>( _value );
+			Set( param, (int32)valueBool.GetValue(), 1 );
+			return true;
+		}
+		case ValueID::ValueType_Byte:
+		{
+			ValueByte const& valueByte = static_cast<ValueByte const&>( _value );
+			Set( param, (int32)valueByte.GetValue(), 1 );
+			return true;
+		}
+		case ValueID::ValueType_Short:
+		{
+			ValueShort const& valueShort = static_cast<ValueShort const&>( _value );
+			Set( param, (int32)valueShort.GetValue(), 2 );
+			return true;
+		}
+		case ValueID::ValueType_Int:
+		{
+			ValueInt const& valueInt = static_cast<ValueInt const&>( _value );
+			Set( param, valueInt.GetValue(), 4 );
+			return true;
+		}
+		case ValueID::ValueType_List:
+		{
+			ValueList const& valueList = static_cast<ValueList const&>( _value );
+			Set( param, valueList.GetNewItem().m_value, valueList.GetSize() );
+			return true;
+		}
+		default:
+		{
+		}
+	}
+
+	Log::Write( LogLevel_Info, GetNodeId(), "Configuration::Set failed (bad value or value type) - Parameter=%d", param );
+	return false;
+}
+
+//-----------------------------------------------------------------------------
+// <Configuration::RequestValue>												   
+// Request current parameter value from the device									   
+//-----------------------------------------------------------------------------
+bool Configuration::RequestValue
+(
+	uint32 const _requestFlags,
+	uint8 const _parameter			// parameter number is encoded as the Index portion of ValueID
+)
+{
+	Msg* msg = new Msg( "ConfigurationCmd_Get", GetNodeId(), REQUEST, FUNC_ID_ZW_SEND_DATA, true, true, FUNC_ID_APPLICATION_COMMAND_HANDLER, GetCommandClassId() );
+	msg->Append( GetNodeId() );
+	msg->Append( 3 );
+	msg->Append( GetCommandClassId() );
+	msg->Append( ConfigurationCmd_Get );
+	msg->Append( _parameter );
+	msg->Append( TRANSMIT_OPTION_ACK | TRANSMIT_OPTION_AUTO_ROUTE );
+	GetDriver()->SendMsg( msg, Driver::MsgQueue_Send );
+	return true;
+}
+
+//-----------------------------------------------------------------------------
+// <Configuration::Set>
+// Set the device's 
+//-----------------------------------------------------------------------------
+void Configuration::Set
+(
+	uint8 const _parameter,
+	int32 const _value,
+	uint8 const _size
+)
+{
+	Log::Write( LogLevel_Info, GetNodeId(), "Configuration::Set - Parameter=%d, Value=%d Size=%d", _parameter, _value, _size );
+
+	Msg* msg = new Msg( "ConfigurationCmd_Set", GetNodeId(), REQUEST, FUNC_ID_ZW_SEND_DATA, true );
+	msg->Append( GetNodeId() );
+	msg->Append( 4 + _size );
+	msg->Append( GetCommandClassId() );
+	msg->Append( ConfigurationCmd_Set );
+	msg->Append( _parameter );
+	msg->Append( _size );
+	if( _size > 2 )
+	{
+		msg->Append( (uint8)(_value>>24) );
+		msg->Append( (uint8)(_value>>16) );
+	}
+	if( _size > 1 ) 
+	{
+		msg->Append( (uint8)(_value>>8) );
+	}
+	msg->Append( (uint8)_value );
+	msg->Append( TRANSMIT_OPTION_ACK | TRANSMIT_OPTION_AUTO_ROUTE );
+	GetDriver()->SendMsg( msg, Driver::MsgQueue_Send );
+}

data/lib/ansible/zwave/openzwave/src/command_classes/Configuration.h

@@ -0,0 +1,67 @@
+//-----------------------------------------------------------------------------
+//
+//	Configuration.h
+//
+//	Implementation of the Z-Wave COMMAND_CLASS_CONFIGURATION
+//
+//	Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
+//
+//	SOFTWARE NOTICE AND LICENSE
+//
+//	This file is part of OpenZWave.
+//
+//	OpenZWave is free software: you can redistribute it and/or modify
+//	it under the terms of the GNU Lesser General Public License as published
+//	by the Free Software Foundation, either version 3 of the License,
+//	or (at your option) any later version.
+//
+//	OpenZWave is distributed in the hope that it will be useful,
+//	but WITHOUT ANY WARRANTY; without even the implied warranty of
+//	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//	GNU Lesser General Public License for more details.
+//
+//	You should have received a copy of the GNU Lesser General Public License
+//	along with OpenZWave.  If not, see <http://www.gnu.org/licenses/>.
+//
+//-----------------------------------------------------------------------------
+
+#ifndef _Configuration_H
+#define _Configuration_H
+
+#include <list>
+#include "CommandClass.h"
+
+namespace OpenZWave
+{
+	class Value;
+
+	/** \brief Implements COMMAND_CLASS_CONFIGURATION (x70), a Z-Wave device command class.
+	 */
+	class Configuration: public CommandClass
+	{
+		friend class Node;
+
+	public:
+		static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Configuration( _homeId, _nodeId ); }
+		virtual ~Configuration(){}
+
+		static uint8 const StaticGetCommandClassId(){ return 0x70; }
+		static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_CONFIGURATION"; }
+
+		bool RequestValue( uint32 const _requestFlags, uint8 const _parameter );
+		void Set( uint8 const _parameter, int32 const _value, uint8 const _size );
+
+		// From CommandClass
+		virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
+		virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
+		virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
+		virtual bool SetValue( Value const& _value );
+
+	private:
+		Configuration( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
+	};
+
+} // namespace OpenZWave
+
+#endif
+

data/lib/ansible/zwave/openzwave/src/command_classes/ControllerReplication.cpp

@@ -0,0 +1,142 @@
+//-----------------------------------------------------------------------------
+//
+//	ControllerReplication.cpp
+//
+//	Implementation of the Z-Wave COMMAND_CLASS_CONTROLLER_REPLICATION
+//
+//	Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
+//
+//	SOFTWARE NOTICE AND LICENSE
+//
+//	This file is part of OpenZWave.
+//
+//	OpenZWave is free software: you can redistribute it and/or modify
+//	it under the terms of the GNU Lesser General Public License as published
+//	by the Free Software Foundation, either version 3 of the License,
+//	or (at your option) any later version.
+//
+//	OpenZWave is distributed in the hope that it will be useful,
+//	but WITHOUT ANY WARRANTY; without even the implied warranty of
+//	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//	GNU Lesser General Public License for more details.
+//
+//	You should have received a copy of the GNU Lesser General Public License
+//	along with OpenZWave.  If not, see <http://www.gnu.org/licenses/>.
+//
+//-----------------------------------------------------------------------------
+
+#include "CommandClasses.h"
+#include "ControllerReplication.h"
+#include "Defs.h"
+#include "Msg.h"
+#include "Driver.h"
+#include "Node.h"
+#include "Log.h"
+
+using namespace OpenZWave;
+
+//static enum ControllerReplicationCmd
+//{
+//	CtrlReplicationTransferGroup = 0x31
+//		Sequence number: type=BYTE
+//		Group id: type=BYTE
+//		Node id: type=BYTE
+//	CtrlReplicationTransferGroupName = 0x32
+//		Sequence number: type=BYTE
+//		Group id: type=BYTE
+//		Group name: type=ARRAY
+//	CtrlReplicationTransferScene = 0x33
+//		Sequence number: type=BYTE
+//		Scene id: type=BYTE
+//		Node id: type=BYTE
+//		Level: type=BYTE
+//	CtrlReplicationTransferSceneName = 0x34
+//		Sequence number: type=BYTE
+//		Scene id: type=BYTE
+//		Scene name: type=ARRAY
+//};
+
+enum ControllerReplicationCmd
+{
+	ControllerReplicationCmd_TransferGroup		= 0x31,
+	ControllerReplicationCmd_TransferGroupName	= 0x32,
+	ControllerReplicationCmd_TransferScene		= 0x33,
+	ControllerReplicationCmd_TransferSceneName	= 0x34
+};
+
+
+//-----------------------------------------------------------------------------
+// <ControllerReplication::HandleMsg>
+// Handle a message from the Z-Wave network
+//-----------------------------------------------------------------------------
+bool ControllerReplication::HandleMsg
+(
+	uint8 const* _data,
+	uint32 const _length,
+	uint32 const _instance	// = 1
+)
+{
+	// When creating replication messages, use FUNC_ID_ZW_SEND_REPLICATION_DATA instead of FUNC_ID_ZW_SEND_DATA
+	// e.g. Msg* msg = new Msg( "TransferGroup", GetNodeId(), REQUEST, FUNC_ID_ZW_SEND_REPLICATION_DATA, true, false );
+
+	switch( _data[0] )
+	{
+		case ControllerReplicationCmd_TransferGroup:
+		{
+			break;
+		}
+		case ControllerReplicationCmd_TransferGroupName:
+		{
+			break;
+		}
+		case  ControllerReplicationCmd_TransferScene:
+		{
+			break;
+		}
+		case ControllerReplicationCmd_TransferSceneName:
+		{
+			break;
+		}
+	}
+
+	Msg* msg = new Msg( "ControllerReplication - Command Complete", GetNodeId(), REQUEST, FUNC_ID_ZW_REPLICATION_COMMAND_COMPLETE, false, false );
+	GetDriver()->SendMsg( msg, Driver::MsgQueue_Send );
+	return true;
+}
+
+//-----------------------------------------------------------------------------
+// <ControllerReplication::StartReplication>
+// Set up the group and scene data to be sent to the other controller
+//-----------------------------------------------------------------------------
+void ControllerReplication::StartReplication
+(
+	uint8 const _targetNodeId,
+	uint8 const _funcId
+)
+{
+	// Store the Z-Wave command we should use when replication has completed.
+	m_funcId = _funcId;	
+
+	// Set up the groups and scenes to be sent
+	SendNextData( _targetNodeId );
+}
+
+//-----------------------------------------------------------------------------
+// <ControllerReplication::SendNextData>
+// Send the next block of replication data
+//-----------------------------------------------------------------------------
+void ControllerReplication::SendNextData
+(
+	uint8 const _targetNodeId
+)
+{
+	// To do: Send scene and group data from the controller.
+	// It may well be that we never need to implement this - scenes will be handled 
+	// by OpenZWave, not the Z-Wave scene classes, and PC controllers don't seem
+	// to hold any associations.
+
+	// For now, we stop the replication process.
+	Msg* msg = new Msg( "Replication Stop", 0xff, REQUEST, m_funcId, true );
+	msg->Append( ADD_NODE_STOP );
+	GetDriver()->SendMsg( msg, Driver::MsgQueue_Send );
+}