ansible4ozw 0.0.2 → 0.0.3

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

@@ -0,0 +1,73 @@
+//-----------------------------------------------------------------------------
+//
+//	Protection.h
+//
+//	Implementation of the Z-Wave COMMAND_CLASS_PROTECTION
+//
+//	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 _Protection_H
+#define _Protection_H
+
+#include "CommandClass.h"
+
+namespace OpenZWave
+{
+	class ValueList;
+
+	/** \brief Implements COMMAND_CLASS_PROTECTION (0x75), a Z-Wave device command class.
+	 */
+	class Protection: public CommandClass
+	{
+	public:
+		enum ProtectionEnum
+		{
+			Protection_Unprotected = 0,
+			Protection_Sequence,
+			Protection_NOP
+		};
+
+		static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Protection( _homeId, _nodeId ); }
+		virtual ~Protection(){}
+
+		static uint8 const StaticGetCommandClassId(){ return 0x75; }
+		static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_PROTECTION"; }
+
+		// From CommandClass
+		virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
+		virtual bool RequestValue( uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
+		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 );
+
+	protected:
+		virtual void CreateVars( uint8 const _instance );
+
+	private:
+		Protection( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
+	};
+
+} // namespace OpenZWave
+
+#endif
+

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

@@ -0,0 +1,208 @@
+//-----------------------------------------------------------------------------
+//
+//	SensorAlarm.cpp
+//
+//	Implementation of the Z-Wave COMMAND_CLASS_SENSOR_ALARM
+//
+//	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 "SensorAlarm.h"
+#include "Defs.h"
+#include "Msg.h"
+#include "Node.h"
+#include "Driver.h"
+#include "Log.h"
+
+#include "ValueByte.h"
+
+using namespace OpenZWave;
+
+enum SensorAlarmCmd
+{
+	SensorAlarmCmd_Get				= 0x01,
+	SensorAlarmCmd_Report			= 0x02,
+	SensorAlarmCmd_SupportedGet		= 0x03,
+	SensorAlarmCmd_SupportedReport	= 0x04
+};
+
+static char const* c_alarmTypeName[] = 
+{
+	"General",
+	"Smoke",
+	"Carbon Monoxide",
+	"Carbon Dioxide",
+	"Heat",
+	"Flood"
+};
+
+
+//-----------------------------------------------------------------------------
+// <SensorAlarm::SensorAlarm>
+// Constructor
+//-----------------------------------------------------------------------------
+SensorAlarm::SensorAlarm
+(
+	uint32 const _homeId,
+	uint8 const _nodeId
+):
+	CommandClass( _homeId, _nodeId )
+{
+	SetStaticRequest( StaticRequest_Values ); 
+}
+
+//-----------------------------------------------------------------------------
+// <SensorAlarm::RequestState>
+// Get the static thermostat setpoint details from the device
+//-----------------------------------------------------------------------------
+bool SensorAlarm::RequestState
+(
+	uint32 const _requestFlags,
+	uint8 const _instance,
+	Driver::MsgQueue const _queue
+)
+{
+	bool requests = false;
+	if( ( _requestFlags & RequestFlag_Static ) && HasStaticRequest( StaticRequest_Values ) )
+	{
+		requests = RequestValue( _requestFlags, 0xff, _instance, _queue );
+	}
+
+	if( _requestFlags & RequestFlag_Dynamic )
+	{
+		for( uint8 i=0; i<SensorAlarm_Count; ++i )
+		{
+			Value* value = GetValue( 1, i );
+			if( value != NULL )
+			{
+				value->Release();
+				// There is a value for this alarm type, so request it
+				requests |= RequestValue( _requestFlags, i, _instance, _queue );
+			}
+		}
+	}
+
+	return requests;
+}
+
+//-----------------------------------------------------------------------------
+// <SensorAlarm::RequestValue>
+// Get the sensor alarm details from the device
+//-----------------------------------------------------------------------------
+bool SensorAlarm::RequestValue
+(
+	uint32 const _requestFlags,
+	uint8 const _alarmType,
+	uint8 const _instance,
+	Driver::MsgQueue const _queue
+)
+{
+	if( _alarmType == 0xff )
+	{
+		// Request the supported alarm types
+		Msg* msg = new Msg( "Request Supported Alarm Types", GetNodeId(), REQUEST, FUNC_ID_ZW_SEND_DATA, true, true, FUNC_ID_APPLICATION_COMMAND_HANDLER, GetCommandClassId() );
+		msg->SetInstance( this, _instance );
+		msg->Append( GetNodeId() );
+		msg->Append( 2 );
+		msg->Append( GetCommandClassId() );
+		msg->Append( SensorAlarmCmd_SupportedGet );
+		msg->Append( TRANSMIT_OPTION_ACK | TRANSMIT_OPTION_AUTO_ROUTE );
+		GetDriver()->SendMsg( msg, _queue );
+	}
+	else
+	{
+		// Request the alarm state
+		Msg* msg = new Msg( "Request alarm state", GetNodeId(), REQUEST, FUNC_ID_ZW_SEND_DATA, true, true, FUNC_ID_APPLICATION_COMMAND_HANDLER, GetCommandClassId() );
+		msg->SetInstance( this, _instance );
+		msg->Append( GetNodeId() );
+		msg->Append( 3 );
+		msg->Append( GetCommandClassId() );
+		msg->Append( SensorAlarmCmd_Get );
+		msg->Append( _alarmType );
+		msg->Append( TRANSMIT_OPTION_ACK | TRANSMIT_OPTION_AUTO_ROUTE );
+		GetDriver()->SendMsg( msg, _queue );
+	}
+	return true;
+}
+
+//-----------------------------------------------------------------------------
+// <SensorAlarm::HandleMsg>
+// Handle a message from the Z-Wave network
+//-----------------------------------------------------------------------------
+bool SensorAlarm::HandleMsg
+(
+	uint8 const* _data,
+	uint32 const _length,
+	uint32 const _instance	// = 1
+)
+{
+	if( SensorAlarmCmd_Report == (SensorAlarmCmd)_data[0] )
+	{
+		// We have received an alarm state report from the Z-Wave device
+		if( ValueByte* value = static_cast<ValueByte*>( GetValue( _instance, _data[2] ) ) )
+		{
+			uint8 sourceNodeId = _data[1];
+			uint8 state = _data[3];
+			// uint16 time = (((uint16)_data[4])<<8) | (uint16)_data[5];  Don't know what to do with this yet.
+
+			value->OnValueRefreshed( state );
+			value->Release();
+			Log::Write( LogLevel_Info, GetNodeId(), "Received alarm state report from node %d: %s = %d", sourceNodeId, value->GetLabel().c_str(), state );
+		}
+
+		return true;
+	}
+			
+	if( SensorAlarmCmd_SupportedReport == (SensorAlarmCmd)_data[0] )
+	{
+		if( Node* node = GetNodeUnsafe() )
+		{
+			// We have received the supported alarm types from the Z-Wave device
+			Log::Write( LogLevel_Info, GetNodeId(), "Received supported alarm types" );		
+
+			// Parse the data for the supported alarm types
+			uint8 numBytes = _data[1];
+			for( uint32 i=0; i<numBytes; ++i )
+			{
+				for( int32 bit=0; bit<8; ++bit )
+				{
+					if( ( _data[i+2] & (1<<bit) ) != 0 )
+					{
+						// Add supported setpoint
+						int32 index = (int32)(i<<3) + bit;
+						if( index < SensorAlarm_Count )
+						{
+						  	node->CreateValueByte( ValueID::ValueGenre_User, GetCommandClassId(), _instance, index, c_alarmTypeName[index], "", true, false, 0, 0 );
+							Log::Write( LogLevel_Info, GetNodeId(), "    Added alarm type: %s", c_alarmTypeName[index] );
+						}
+					}
+				}
+			}
+		}
+
+		ClearStaticRequest( StaticRequest_Values );
+		return true;
+	}
+
+	return false;
+}
+

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

@@ -0,0 +1,77 @@
+//-----------------------------------------------------------------------------
+//
+//	SensorAlarm.h
+//
+//	Implementation of the Z-Wave COMMAND_CLASS_SENSOR_ALARM
+//
+//	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 _SensorAlarm_H
+#define _SensorAlarm_H
+
+#include <vector>
+#include <string>
+#include "CommandClass.h"
+
+namespace OpenZWave
+{
+	class ValueByte;
+
+	/** \brief Implements COMMAND_CLASS_SENSOR_ALARM (0x9c), a Z-Wave device command class.
+	 */
+	class SensorAlarm: public CommandClass
+	{
+	public:
+		static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new SensorAlarm( _homeId, _nodeId ); }
+		virtual ~SensorAlarm(){} 
+
+		static uint8 const StaticGetCommandClassId(){ return 0x9c; }		
+		static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_SENSOR_ALARM"; }
+
+		// From CommandClass
+		virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
+		virtual bool RequestValue( uint32 const _requestFlags, uint8 const _alarmType, uint8 const _dummy, Driver::MsgQueue const _queue );
+		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 );
+
+	private:
+		SensorAlarm( uint32 const _homeId, uint8 const _nodeId );
+
+		enum
+		{
+			SensorAlarm_General = 0,
+			SensorAlarm_Smoke,
+			SensorAlarm_CarbonMonoxide,
+			SensorAlarm_CarbonDioxide,
+			SensorAlarm_Heat,
+			SensorAlarm_Flood,
+			SensorAlarm_Count
+		};
+	};
+
+} // namespace OpenZWave
+
+#endif
+
+
+

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

@@ -0,0 +1,134 @@
+//-----------------------------------------------------------------------------
+//
+//	SensorBinary.cpp
+//
+//	Implementation of the Z-Wave COMMAND_CLASS_SENSOR_BINARY
+//
+//	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 "SensorBinary.h"
+#include "Defs.h"
+#include "Msg.h"
+#include "Node.h"
+#include "Driver.h"
+#include "Log.h"
+
+#include "ValueBool.h"
+
+using namespace OpenZWave;
+
+enum SensorBinaryCmd
+{
+	SensorBinaryCmd_Get		= 0x02,
+	SensorBinaryCmd_Report	= 0x03
+};
+
+//-----------------------------------------------------------------------------
+// <SensorBinary::RequestState>												   
+// Request current state from the device									   
+//-----------------------------------------------------------------------------
+bool SensorBinary::RequestState
+(
+	uint32 const _requestFlags,
+	uint8 const _instance,
+	Driver::MsgQueue const _queue
+)
+{
+	if( _requestFlags & RequestFlag_Dynamic )
+	{
+		return RequestValue( _requestFlags, 0, _instance, _queue );
+	}
+
+	return false;
+}
+
+//-----------------------------------------------------------------------------
+// <SensorBinary::RequestValue>												   
+// Request current value from the device									   
+//-----------------------------------------------------------------------------
+bool SensorBinary::RequestValue
+(
+	uint32 const _requestFlags,
+	uint8 const _dummy1,	// = 0 (not used)
+	uint8 const _instance,
+	Driver::MsgQueue const _queue
+)
+{
+	Msg* msg = new Msg( "SensorBinaryCmd_Get", GetNodeId(), REQUEST, FUNC_ID_ZW_SEND_DATA, true, true, FUNC_ID_APPLICATION_COMMAND_HANDLER, GetCommandClassId() );
+	msg->SetInstance( this, _instance );
+	msg->Append( GetNodeId() );
+	msg->Append( 2 );
+	msg->Append( GetCommandClassId() );
+	msg->Append( SensorBinaryCmd_Get );
+	msg->Append( TRANSMIT_OPTION_ACK | TRANSMIT_OPTION_AUTO_ROUTE );
+	GetDriver()->SendMsg( msg, _queue );
+	return true;
+}
+
+//-----------------------------------------------------------------------------
+// <SensorBinary::HandleMsg>
+// Handle a message from the Z-Wave network
+//-----------------------------------------------------------------------------
+bool SensorBinary::HandleMsg
+(
+	uint8 const* _data,
+	uint32 const _length,
+	uint32 const _instance	// = 1
+)
+{
+	if (SensorBinaryCmd_Report == (SensorBinaryCmd)_data[0])
+	{
+		Log::Write( LogLevel_Info, GetNodeId(), "Received SensorBinary report: State=%s", _data[1] ? "On" : "Off" );
+
+		if( ValueBool* value = static_cast<ValueBool*>( GetValue( _instance, 0 ) ) )
+		{
+			value->OnValueRefreshed( _data[1] != 0 );
+			value->Release();
+		}
+		return true;
+	}
+
+	return false;
+}
+
+//-----------------------------------------------------------------------------
+// <SensorBinary::CreateVars>
+// Create the values managed by this command class
+//-----------------------------------------------------------------------------
+void SensorBinary::CreateVars
+(
+	uint8 const _instance
+)
+{
+	if( Node* node = GetNodeUnsafe() )
+	{
+	  	node->CreateValueBool(  ValueID::ValueGenre_User, GetCommandClassId(), _instance, 0, "Sensor", "", true, false, false, 0 );
+	}
+}
+
+
+
+
+
+
+