ansible4ozw 0.0.2 → 0.0.3

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

@@ -0,0 +1,76 @@
+//-----------------------------------------------------------------------------
+//
+//	ThermostatMode.h
+//
+//	Implementation of the Z-Wave COMMAND_CLASS_THERMOSTAT_MODE
+//
+//	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 _ThermostatMode_H
+#define _ThermostatMode_H
+
+#include <vector>
+#include <string>
+#include "CommandClass.h"
+#include "ValueList.h"
+
+namespace OpenZWave
+{
+	class ValueList;
+
+	/** \brief Implements COMMAND_CLASS_THERMOSTAT_MODE (0x40), a Z-Wave device command class.
+	 */
+	class ThermostatMode: public CommandClass
+	{
+	public:
+		static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new ThermostatMode( _homeId, _nodeId ); }
+		virtual ~ThermostatMode(){}
+
+		static uint8 const StaticGetCommandClassId(){ return 0x40; }		
+		static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_THERMOSTAT_MODE"; }
+
+		// From CommandClass
+		virtual void ReadXML( TiXmlElement const* _ccElement );
+		virtual void WriteXML( TiXmlElement* _ccElement );
+		virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
+		virtual bool RequestValue( uint32 const _requestFlags, uint8 const _getTypeEnum, 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 );
+		virtual bool SetValue( Value const& _value );
+
+	protected:
+		virtual void CreateVars( uint8 const _instance );
+
+	private:
+		ThermostatMode( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){ SetStaticRequest( StaticRequest_Values ); }
+
+		vector<ValueList::Item>		m_supportedModes;
+	};
+
+} // namespace OpenZWave
+
+#endif
+
+
+
+

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

@@ -0,0 +1,147 @@
+//-----------------------------------------------------------------------------
+//
+//	ThermostatOperatingState.cpp
+//
+//	Implementation of the Z-Wave COMMAND_CLASS_THERMOSTAT_OPERATING_STATE
+//
+//	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 "ThermostatOperatingState.h"
+#include "Defs.h"
+#include "Msg.h"
+#include "Node.h"
+#include "Driver.h"
+#include "Log.h"
+
+#include "ValueString.h"
+
+using namespace OpenZWave;
+
+enum ThermostatOperatingStateCmd
+{
+	ThermostatOperatingStateCmd_Get				= 0x02,
+	ThermostatOperatingStateCmd_Report			= 0x03
+};
+
+static char const* c_stateName[] = 
+{
+	"Idle",
+	"Heating",
+	"Cooling",
+	"Fan Only",
+	"Pending Heat",
+	"Pending Cool",
+	"Vent / Economizer",
+	"State 07",				// Undefined states.  May be used in the future.
+	"State 08", 
+	"State 09", 
+	"State 10", 
+	"State 11", 
+	"State 12", 
+	"State 13", 
+	"State 14", 
+	"State 15"
+};
+
+//-----------------------------------------------------------------------------
+// <ThermostatOperatingState::RequestState>
+// Get the static thermostat mode details from the device
+//-----------------------------------------------------------------------------
+bool ThermostatOperatingState::RequestState
+(
+	uint32 const _requestFlags,
+	uint8 const _instance,
+	Driver::MsgQueue const _queue
+)
+{
+	if( _requestFlags & RequestFlag_Dynamic )
+	{
+		return RequestValue( _requestFlags, 0, _instance, _queue );
+	}
+	return false;
+}
+
+//-----------------------------------------------------------------------------
+// <ThermostatOperatingState::RequestValue>
+// Get a thermostat mode value from the device
+//-----------------------------------------------------------------------------
+bool ThermostatOperatingState::RequestValue
+(
+	uint32 const _requestFlags,
+	uint8 const _dummy1,	// = 0 (not used)
+	uint8 const _instance,
+	Driver::MsgQueue const _queue
+)
+{
+	Msg* msg = new Msg( "Request Current Thermostat Operating 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( 2 );
+	msg->Append( GetCommandClassId() );
+	msg->Append( ThermostatOperatingStateCmd_Get );
+	msg->Append( TRANSMIT_OPTION_ACK | TRANSMIT_OPTION_AUTO_ROUTE );
+	GetDriver()->SendMsg( msg, _queue );
+	return true;
+}
+
+//-----------------------------------------------------------------------------
+// <ThermostatOperatingState::HandleMsg>
+// Handle a message from the Z-Wave network
+//-----------------------------------------------------------------------------
+bool ThermostatOperatingState::HandleMsg
+(
+	uint8 const* _data,
+	uint32 const _length,
+	uint32 const _instance	// = 1
+)
+{
+	if( ThermostatOperatingStateCmd_Report == (ThermostatOperatingStateCmd)_data[0] )
+	{
+		// We have received the thermostat operating state from the Z-Wave device
+		if( ValueString* valueString = static_cast<ValueString*>( GetValue( _instance, 0 ) ) )
+		{
+			valueString->OnValueRefreshed( c_stateName[_data[1]&0x0f] );
+			valueString->Release();
+			Log::Write( LogLevel_Info, GetNodeId(), "Received thermostat operating state: %s", valueString->GetValue().c_str() );		
+		}
+		return true;
+	}
+
+	return false;
+}
+
+//-----------------------------------------------------------------------------
+// <ThermostatOperatingState::CreateVars>
+// Create the values managed by this command class
+//-----------------------------------------------------------------------------
+void ThermostatOperatingState::CreateVars
+(
+	uint8 const _instance
+)
+{
+	if( Node* node = GetNodeUnsafe() )
+	{
+	  	node->CreateValueString( ValueID::ValueGenre_User, GetCommandClassId(), _instance, 0, "Operating State", "", true, false, c_stateName[0], 0 );
+	}
+}
+

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

@@ -0,0 +1,71 @@
+//-----------------------------------------------------------------------------
+//
+//	ThermostatOperatingState.h
+//
+//	Implementation of the Z-Wave COMMAND_CLASS_THERMOSTAT_OPERATING_STATE
+//
+//	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 _ThermostatOperatingState_H
+#define _ThermostatOperatingState_H
+
+#include <vector>
+#include <string>
+#include "CommandClass.h"
+#include "ValueList.h"
+
+namespace OpenZWave
+{
+	class ValueString;
+
+	/** \brief Implements COMMAND_CLASS_THERMOSTAT_OPERATING_STATE (0x42), a Z-Wave device command class.
+	 */
+	class ThermostatOperatingState: public CommandClass
+	{
+	public:
+		static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new ThermostatOperatingState( _homeId, _nodeId ); }
+		virtual ~ThermostatOperatingState(){}
+
+		static uint8 const StaticGetCommandClassId(){ return 0x42; }		
+		static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_THERMOSTAT_OPERATING_STATE"; }
+
+		// 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 );
+
+	protected:
+		virtual void CreateVars( uint8 const _instance );
+
+	private:
+		ThermostatOperatingState( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
+	};
+
+} // namespace OpenZWave
+
+#endif
+
+
+
+

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

@@ -0,0 +1,317 @@
+//-----------------------------------------------------------------------------
+//
+//	ThermostatSetpoint.cpp
+//
+//	Implementation of the Z-Wave COMMAND_CLASS_THERMOSTAT_SETPOINT
+//
+//	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 "ThermostatSetpoint.h"
+#include "Defs.h"
+#include "Msg.h"
+#include "Node.h"
+#include "Driver.h"
+#include "Log.h"
+
+#include "ValueDecimal.h"
+
+using namespace OpenZWave;
+
+enum ThermostatSetpointCmd
+{
+	ThermostatSetpointCmd_Set				= 0x01,
+	ThermostatSetpointCmd_Get				= 0x02,
+	ThermostatSetpointCmd_Report			= 0x03,
+	ThermostatSetpointCmd_SupportedGet		= 0x04,
+	ThermostatSetpointCmd_SupportedReport	= 0x05
+};
+
+enum
+{
+	ThermostatSetpoint_Unused0	= 0,
+	ThermostatSetpoint_Heating1,
+	ThermostatSetpoint_Cooling1,
+	ThermostatSetpoint_Unused3,
+	ThermostatSetpoint_Unused4,
+	ThermostatSetpoint_Unused5,
+	ThermostatSetpoint_Unused6,
+	ThermostatSetpoint_Furnace,
+	ThermostatSetpoint_DryAir,
+	ThermostatSetpoint_MoistAir,
+	ThermostatSetpoint_AutoChangeover,
+	ThermostatSetpoint_HeatingEcon,
+	ThermostatSetpoint_CoolingEcon,
+	ThermostatSetpoint_AwayHeating,
+	ThermostatSetpoint_Count
+};
+
+static char const* c_setpointName[] = 
+{
+	"Unused 0",
+	"Heating 1",
+	"Cooling 1",
+	"Unused 3",
+	"Unused 4",
+	"Unused 5",
+	"Unused 6",
+	"Furnace",
+	"Dry Air",
+	"Moist Air",
+	"Auto Changeover",
+	"Heating Econ",
+	"Cooling Econ",
+	"Away Heating"
+};
+
+//-----------------------------------------------------------------------------
+// <ThermostatSetpoint::ThermostatSetpoint>
+// Constructor
+//-----------------------------------------------------------------------------
+ThermostatSetpoint::ThermostatSetpoint
+(
+	uint32 const _homeId,
+	uint8 const _nodeId
+):
+	CommandClass( _homeId, _nodeId ), m_setPointBase( 1 )
+{
+	SetStaticRequest( StaticRequest_Values ); 
+}
+
+//-----------------------------------------------------------------------------
+// <ThermostatSetpoint::ReadXML>
+// Read the saved change-counter value
+//-----------------------------------------------------------------------------
+void ThermostatSetpoint::ReadXML
+( 
+	TiXmlElement const* _ccElement
+)
+{
+	CommandClass::ReadXML( _ccElement );
+
+	int intVal;
+	if( TIXML_SUCCESS == _ccElement->QueryIntAttribute( "base", &intVal ) )
+	{
+		m_setPointBase = (uint8)intVal;
+	}
+}
+
+//-----------------------------------------------------------------------------
+// <ThermostatSetpoint::WriteXML>
+// Write the change-counter value
+//-----------------------------------------------------------------------------
+void ThermostatSetpoint::WriteXML
+( 
+	TiXmlElement* _ccElement
+)
+{
+	CommandClass::WriteXML( _ccElement );
+
+	char str[8];
+	snprintf( str, 8, "%d", m_setPointBase );
+	_ccElement->SetAttribute( "base", str );
+}
+
+//-----------------------------------------------------------------------------
+// <ThermostatSetpoint::RequestState>
+// Get the static thermostat setpoint details from the device
+//-----------------------------------------------------------------------------
+bool ThermostatSetpoint::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_Session )
+	{
+		for( uint8 i=0; i<ThermostatSetpoint_Count; ++i )
+		{
+			requests |= RequestValue( _requestFlags, i, _instance, _queue );
+		}
+	}
+
+	return requests;
+}
+
+//-----------------------------------------------------------------------------
+// <ThermostatSetpoint::RequestValue>												   
+// Request current state from the device									   
+//-----------------------------------------------------------------------------
+bool ThermostatSetpoint::RequestValue
+(
+	uint32 const _requestFlags,
+	uint8 const _setPointIndex,
+	uint8 const _instance,
+	Driver::MsgQueue const _queue
+)
+{
+	if( _setPointIndex == 0xff )		// check for supportedget
+	{
+		// Request the supported setpoints
+		Msg* msg = new Msg( "Request Supported Thermostat Setpoints", 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( ThermostatSetpointCmd_SupportedGet );
+		msg->Append( TRANSMIT_OPTION_ACK | TRANSMIT_OPTION_AUTO_ROUTE );
+		GetDriver()->SendMsg( msg, _queue );
+		return true;
+	}
+
+	Value* value = GetValue( 1, _setPointIndex );
+	if( value != NULL )
+	{
+		value->Release();
+		// Request the setpoint value
+		Msg* msg = new Msg( "Request Current Thermostat Setpoint", 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( ThermostatSetpointCmd_Get );
+		msg->Append( _setPointIndex );
+		msg->Append( TRANSMIT_OPTION_ACK | TRANSMIT_OPTION_AUTO_ROUTE );
+		GetDriver()->SendMsg( msg, _queue );
+		return true;
+	}
+	return false;
+}
+
+//-----------------------------------------------------------------------------
+// <ThermostatSetpoint::HandleMsg>
+// Handle a message from the Z-Wave network
+//-----------------------------------------------------------------------------
+bool ThermostatSetpoint::HandleMsg
+(
+	uint8 const* _data,
+	uint32 const _length,
+	uint32 const _instance	// = 1
+)
+{
+	if( ThermostatSetpointCmd_Report == (ThermostatSetpointCmd)_data[0] )
+	{
+		// We have received a thermostat setpoint value from the Z-Wave device
+		if( ValueDecimal* value = static_cast<ValueDecimal*>( GetValue( _instance, _data[1] ) ) )
+		{
+			uint8 scale;
+			uint8 precision = 0;
+			string temperature = ExtractValue( &_data[2], &scale, &precision );
+
+			value->SetUnits( scale ? "F" : "C" );
+			value->OnValueRefreshed( temperature );
+			if( value->GetPrecision() != precision )
+			{
+				value->SetPrecision( precision );
+			}
+			value->Release();
+
+			Log::Write( LogLevel_Info, GetNodeId(), "Received thermostat setpoint report: Setpoint %s = %s%s", value->GetLabel().c_str(), value->GetValue().c_str(), value->GetUnits().c_str() );		
+		}
+		return true;
+	}
+			
+	if( ThermostatSetpointCmd_SupportedReport == (ThermostatSetpointCmd)_data[0] )
+	{
+		if( Node* node = GetNodeUnsafe() )
+		{
+			// We have received the supported thermostat setpoints from the Z-Wave device
+			Log::Write( LogLevel_Info, GetNodeId(), "Received supported thermostat setpoints" );		
+
+			// Parse the data for the supported setpoints
+			for( uint32 i=1; i<_length-1; ++i )
+			{
+				for( int32 bit=0; bit<8; ++bit )
+				{
+					if( ( _data[i] & (1<<bit) ) != 0 )
+					{
+						// Add supported setpoint
+						int32 index = (int32)((i-1)<<3) + bit + m_setPointBase;
+						if( index < ThermostatSetpoint_Count )
+						{
+						  	node->CreateValueDecimal( ValueID::ValueGenre_User, GetCommandClassId(), _instance, index, c_setpointName[index], "C", false, false, "0.0", 0 );
+							Log::Write( LogLevel_Info, GetNodeId(), "    Added setpoint: %s", c_setpointName[index] );
+						}
+					}
+				}
+			}
+		}
+
+		ClearStaticRequest( StaticRequest_Values );
+		return true;
+	}
+
+	return false;
+}
+
+//-----------------------------------------------------------------------------
+// <ThermostatSetpoint::SetValue>
+// Set a thermostat setpoint temperature
+//-----------------------------------------------------------------------------
+bool ThermostatSetpoint::SetValue
+(
+	Value const& _value
+)
+{
+	if( ValueID::ValueType_Decimal == _value.GetID().GetType() )
+	{
+		ValueDecimal const* value = static_cast<ValueDecimal const*>(&_value);
+		uint8 scale = strcmp( "C", value->GetUnits().c_str() ) ? 1 : 0;
+
+		Msg* msg = new Msg( "Set Thermostat Setpoint", GetNodeId(), REQUEST, FUNC_ID_ZW_SEND_DATA, true );
+		msg->SetInstance( this, _value.GetID().GetInstance() );
+		msg->Append( GetNodeId() );
+		msg->Append( 4 + GetAppendValueSize( value->GetValue() ) );
+		msg->Append( GetCommandClassId() );
+		msg->Append( ThermostatSetpointCmd_Set );
+		msg->Append( value->GetID().GetIndex() );
+		AppendValue( msg, value->GetValue(), scale );
+		msg->Append( TRANSMIT_OPTION_ACK | TRANSMIT_OPTION_AUTO_ROUTE );
+		GetDriver()->SendMsg( msg, Driver::MsgQueue_Send );
+		return true;
+	}
+
+	return false;
+}
+
+//-----------------------------------------------------------------------------
+// <ThermostatSetpoint::CreateVars>
+// Create the values managed by this command class
+//-----------------------------------------------------------------------------
+void ThermostatSetpoint::CreateVars
+(
+	uint8 const _instance,
+	uint8 const _index
+)
+{
+	if( Node* node = GetNodeUnsafe() )
+	{
+	  	node->CreateValueDecimal( ValueID::ValueGenre_User, GetCommandClassId(), _instance, _index, "Setpoint", "C", false, false, "0.0", 0  );
+	}
+}