Driver.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//
//  Driver.h
//
//  Communicates with a Z-Wave network
//
//  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 _Driver_H
#define _Driver_H

#include <string>
#include <map>
#include <list>

#include "Defs.h"
#include "Group.h"
#include "value_classes/ValueID.h"
#include "Node.h"
#include "platform/Event.h"
#include "platform/Mutex.h"
#include "platform/Thread.h"
#include "platform/TimeStamp.h"
#include "aes/aescpp.h"

namespace OpenZWave
{
    class Notification;
    namespace Internal
    {
        namespace CC
        {
            class ApplicationStatus;
            class Basic;
            class CommandClass;
            class WakeUp;
            class ControllerReplication;
            class ManufacturerSpecific;
            class MultiChannelAssociation;
            class NodeNaming;
            class Security;
            class SceneActivation;
        }
        namespace VC
        {
            class Value;
            class ValueStore;
        }
        namespace Platform
        {
            class Controller;
        }
        class DNSThread;
        struct DNSLookup;
        class i_HttpClient;
        struct HttpDownload;
        class ManufacturerSpecificDB;
        class Msg;
        class TimerThread;
    }

    class OPENZWAVE_EXPORT Driver
    {
            friend class Manager;
            friend class Node;
            friend class Group;
            friend class Internal::CC::CommandClass;
            friend class Internal::CC::ControllerReplication;
            friend class Internal::DNSThread;
            friend class Internal::i_HttpClient;
            friend class Internal::VC::Value;
            friend class Internal::VC::ValueStore;
            friend class Internal::CC::Basic;
            friend class Internal::CC::ManufacturerSpecific;
            friend class Internal::CC::MultiChannelAssociation;
            friend class Internal::CC::NodeNaming;
            friend class Internal::CC::SceneActivation;
            friend class Internal::CC::WakeUp;
            friend class Internal::CC::ApplicationStatus; /* for Notification messages */
            friend class Internal::CC::Security;
            friend class Internal::Msg;
            friend class Internal::ManufacturerSpecificDB;
            friend class TimerThread;

            //-----------------------------------------------------------------------------
            //  Controller Interfaces
            //-----------------------------------------------------------------------------
        public:
            enum ControllerInterface
            {
                ControllerInterface_Unknown = 0,
                ControllerInterface_Serial,
                ControllerInterface_Hid
            };

            //-----------------------------------------------------------------------------
            // Construction / Destruction
            //-----------------------------------------------------------------------------
        private:
            Driver(string const& _controllerPath, ControllerInterface const& _interface);
            virtual ~Driver();

            void Start();
            static void DriverThreadEntryPoint(Internal::Platform::Event* _exitEvent, void* _context);
            void DriverThreadProc(Internal::Platform::Event* _exitEvent);
            bool Init(uint32 _attempts);

            void RemoveQueues(uint8 const _nodeId);

            Internal::Platform::Thread* m_driverThread; 
            Internal::DNSThread* m_dns; 
            Internal::Platform::Thread* m_dnsThread; 
            Internal::Platform::Mutex* m_initMutex; 
            bool m_exit; 
            bool m_init; 
            bool m_awakeNodesQueried; 
            bool m_allNodesQueried; 
            bool m_notifytransactions;
            Internal::Platform::TimeStamp m_startTime; 
            //-----------------------------------------------------------------------------
            //  Configuration
            //-----------------------------------------------------------------------------
        private:
            void RequestConfig();                           // Get the network configuration from the Z-Wave network
            bool ReadCache();                               // Read the configuration from a file
            void WriteCache();                              // Save the configuration to a file

            //-----------------------------------------------------------------------------
            //  Timer
            //-----------------------------------------------------------------------------
        private:
            Internal::TimerThread* m_timer; 
            Internal::Platform::Thread* m_timerThread; 
        public:
            Internal::TimerThread* GetTimer()
            {
                return m_timer;
            }

            //-----------------------------------------------------------------------------
            //  Controller
            //-----------------------------------------------------------------------------
        private:
            // Controller Capabilities (return in FUNC_ID_ZW_GET_CONTROLLER_CAPABILITIES)
            enum
            {
                ControllerCaps_Secondary = 0x01, 
                ControllerCaps_OnOtherNetwork = 0x02, 
                ControllerCaps_SIS = 0x04, 
                ControllerCaps_RealPrimary = 0x08, 
                ControllerCaps_SUC = 0x10 
            };

            // Init Capabilities (return in FUNC_ID_SERIAL_API_GET_INIT_DATA)
            enum
            {
                InitCaps_Slave = 0x01, 
                InitCaps_TimerSupport = 0x02, 
                InitCaps_Secondary = 0x04, 
                InitCaps_SUC = 0x08 
            };

            bool IsPrimaryController() const
            {
                return ((m_initCaps & InitCaps_Secondary) == 0);
            }
            bool IsStaticUpdateController() const
            {
                return ((m_initCaps & InitCaps_SUC) != 0);
            }
            bool IsBridgeController() const
            {
                return (m_libraryType == 7);
            }
            bool IsInclusionController() const
            {
                return ((m_controllerCaps & ControllerCaps_SIS) != 0);
            }

            bool HasExtendedTxStatus() const
            {
                return m_hasExtendedTxStatus;
            }

            uint32 GetHomeId() const
            {
                return m_homeId;
            }
            uint8 GetControllerNodeId() const
            {
                return m_Controller_nodeId;
            }
            uint8 GetSUCNodeId() const
            {
                return m_SUCNodeId;
            }
            uint16 GetManufacturerId() const
            {
                return m_manufacturerId;
            }
            uint16 GetProductType() const
            {
                return m_productType;
            }
            uint16 GetProductId() const
            {
                return m_productId;
            }
            string GetControllerPath() const
            {
                return m_controllerPath;
            }
            ControllerInterface GetControllerInterfaceType() const
            {
                return m_controllerInterfaceType;
            }
            string GetLibraryVersion() const
            {
                return m_libraryVersion;
            }
            string GetLibraryTypeName() const
            {
                return m_libraryTypeName;
            }
            int32 GetSendQueueCount() const
            {
                int32 count = 0;
                for (int32 i = 0; i < MsgQueue_Count; ++i)
                {
                    count += (int32) (m_msgQueue[i].size());
                }
                return count;
            }

            Node* GetNodeUnsafe(uint8 _nodeId);
            Node* GetNode(uint8 _nodeId);

            ControllerInterface m_controllerInterfaceType;              // Specifies the controller's hardware interface
            string m_controllerPath;                            // name or path used to open the controller hardware.
            Internal::Platform::Controller* m_controller;                               // Handles communications with the controller hardware.
            uint32 m_homeId;                                    // Home ID of the Z-Wave controller.  Not valid until the DriverReady notification has been received.
            string m_libraryVersion;                            // Version of the Z-Wave Library used by the controller.
            string m_libraryTypeName;                           // Name describing the library type.
            uint8 m_libraryType;                                // Type of library used by the controller.

            uint8 m_serialAPIVersion[2];
            uint16 m_manufacturerId;
            uint16 m_productType;
            uint16 m_productId;
            uint8 m_apiMask[32];

            uint8 m_initVersion;                                // Version of the Serial API used by the controller.
            uint8 m_initCaps;                                   // Set of flags indicating the serial API capabilities (See IsSlave, HasTimerSupport, IsPrimaryController and IsStaticUpdateController above).
            uint8 m_controllerCaps;                         // Set of flags indicating the controller's capabilities (See IsInclusionController above).
            bool m_hasExtendedTxStatus;                     // True if the controller accepted SERIAL_API_SETUP_CMD_TX_STATUS_REPORT
            uint8 m_Controller_nodeId;                      // Z-Wave Controller's own node ID.
            Node* m_nodes[256];                             // Array containing all the node objects.
            Internal::Platform::Mutex* m_nodeMutex;                             // Serializes access to node data

            Internal::CC::ControllerReplication* m_controllerReplication;                   // Controller replication is handled separately from the other command classes, due to older hand-held controllers using invalid node IDs.

            uint8 m_transmitOptions;

            //-----------------------------------------------------------------------------
            //  Receiving Z-Wave messages
            //-----------------------------------------------------------------------------
        private:
            bool ReadMsg();
            void ProcessMsg(uint8* _data, uint8 _length);

            void HandleGetVersionResponse(uint8* _data);
            void HandleGetRandomResponse(uint8* _data);
            void HandleSerialAPISetupResponse(uint8* _data);
            void HandleGetControllerCapabilitiesResponse(uint8* _data);
            void HandleGetSerialAPICapabilitiesResponse(uint8* _data);
            void HandleSerialAPISoftResetResponse(uint8* _data);
            void HandleEnableSUCResponse(uint8* _data);
            void HandleSetSUCNodeIdResponse(uint8* _data);
            void HandleGetSUCNodeIdResponse(uint8* _data);
            void HandleMemoryGetIdResponse(uint8* _data);
            void HandleSerialAPIGetInitDataResponse(uint8* _data);
            void HandleGetNodeProtocolInfoResponse(uint8* _data);
            bool HandleRemoveFailedNodeResponse(uint8* _data);
            void HandleIsFailedNodeResponse(uint8* _data);
            bool HandleReplaceFailedNodeResponse(uint8* _data);
            bool HandleAssignReturnRouteResponse(uint8* _data);
            bool HandleDeleteReturnRouteResponse(uint8* _data);
            void HandleSendNodeInformationRequest(uint8* _data);
            void HandleSendDataResponse(uint8* _data, bool _replication);
            bool HandleNetworkUpdateResponse(uint8* _data);
            void HandleGetRoutingInfoResponse(uint8* _data);

            void HandleSendDataRequest(uint8* _data, uint8 _length, bool _replication);
            void HandleAddNodeToNetworkRequest(uint8* _data);
            void HandleCreateNewPrimaryRequest(uint8* _data);
            void HandleControllerChangeRequest(uint8* _data);
            void HandleSetLearnModeRequest(uint8* _data);
            void HandleRemoveFailedNodeRequest(uint8* _data);
            void HandleReplaceFailedNodeRequest(uint8* _data);
            void HandleRemoveNodeFromNetworkRequest(uint8* _data);
            void HandleApplicationCommandHandlerRequest(uint8* _data, bool encrypted);
            void HandlePromiscuousApplicationCommandHandlerRequest(uint8* _data);
            void HandleAssignReturnRouteRequest(uint8* _data);
            void HandleDeleteReturnRouteRequest(uint8* _data);
            void HandleNodeNeighborUpdateRequest(uint8* _data);
            void HandleNetworkUpdateRequest(uint8* _data);
            bool HandleApplicationUpdateRequest(uint8* _data);
            bool HandleRfPowerLevelSetResponse(uint8* _data);
            bool HandleSerialApiSetTimeoutsResponse(uint8* _data);
            bool HandleMemoryGetByteResponse(uint8* _data);
            bool HandleReadMemoryResponse(uint8* _data);
            void HandleGetVirtualNodesResponse(uint8* _data);
            bool HandleSetSlaveLearnModeResponse(uint8* _data);
            void HandleSetSlaveLearnModeRequest(uint8* _data);
            bool HandleSendSlaveNodeInfoResponse(uint8* _data);
            void HandleSendSlaveNodeInfoRequest(uint8* _data);
            void HandleApplicationSlaveCommandRequest(uint8* _data);
            void HandleSerialAPIResetRequest(uint8* _data);

            void CommonAddNodeStatusRequestHandler(uint8 _funcId, uint8* _data);

            bool m_waitingForAck;                           // True when we are waiting for an ACK from the dongle
            uint8 m_expectedCallbackId;                     // If non-zero, we wait for a message with this callback Id
            uint8 m_expectedReply;                          // If non-zero, we wait for a message with this function Id
            uint8 m_expectedCommandClassId;                 // If the expected reply is FUNC_ID_APPLICATION_COMMAND_HANDLER, this value stores the command class we're waiting to hear from
            uint8 m_expectedNodeId;                         // If we are waiting for a FUNC_ID_APPLICATION_COMMAND_HANDLER, make sure we only accept it from this node.

            //-----------------------------------------------------------------------------
            //  Polling Z-Wave devices
            //-----------------------------------------------------------------------------
        private:
            int32 GetPollInterval()
            {
                return m_pollInterval;
            }
            void SetPollInterval(int32 _milliseconds, bool _bIntervalBetweenPolls)
            {
                m_pollInterval = _milliseconds;
                m_bIntervalBetweenPolls = _bIntervalBetweenPolls;
            }
            bool EnablePoll(const ValueID &_valueId, uint8 _intensity = 1);
            bool DisablePoll(const ValueID &_valueId);
            bool isPolled(const ValueID &_valueId);
            void SetPollIntensity(const ValueID &_valueId, uint8 _intensity);
            static void PollThreadEntryPoint(Internal::Platform::Event* _exitEvent, void* _context);
            void PollThreadProc(Internal::Platform::Event* _exitEvent);

            Internal::Platform::Thread* m_pollThread;                               // Thread for polling devices on the Z-Wave network
            struct PollEntry
            {
                    ValueID m_id;
                    uint8 m_pollCounter;
            };
            list<PollEntry> m_pollList;                                 // List of nodes that need to be polled
            Internal::Platform::Mutex* m_pollMutex;                             // Serialize access to the polling list
            int32 m_pollInterval;                               // Time interval during which all nodes must be polled
            bool m_bIntervalBetweenPolls;                   // if true, the library intersperses m_pollInterval between polls; if false, the library attempts to complete all polls within m_pollInterval

            //-----------------------------------------------------------------------------
            //  Retrieving Node information
            //-----------------------------------------------------------------------------
        public:
            uint8 GetNodeNumber(Internal::Msg const* _msg) const
            {
                return (_msg == NULL ? 0 : _msg->GetTargetNodeId());
            }

        private:
            void InitNode(uint8 const _nodeId, bool newNode = false, bool secure = false, uint8 const *_protocolInfo = NULL, uint8 const _length = 0);

            void InitAllNodes();                                                // Delete all nodes and fetch the data from the Z-Wave network again.

            bool IsNodeListeningDevice(uint8 const _nodeId);
            bool IsNodeFrequentListeningDevice(uint8 const _nodeId);
            bool IsNodeBeamingDevice(uint8 const _nodeId);
            bool IsNodeRoutingDevice(uint8 const _nodeId);
            bool IsNodeSecurityDevice(uint8 const _nodeId);
            uint32 GetNodeMaxBaudRate(uint8 const _nodeId);
            uint8 GetNodeVersion(uint8 const _nodeId);
            uint8 GetNodeSecurity(uint8 const _nodeId);
            uint8 GetNodeBasic(uint8 const _nodeId);
            uint8 GetNodeGeneric(uint8 const _nodeId);
            uint8 GetNodeSpecific(uint8 const _nodeId);
            string GetNodeType(uint8 const _nodeId);
            uint32 GetNodeNeighbors(uint8 const _nodeId, uint8** o_neighbors);

            string GetNodeManufacturerName(uint8 const _nodeId);
            string GetNodeProductName(uint8 const _nodeId);
            string GetNodeName(uint8 const _nodeId);
            string GetNodeLocation(uint8 const _nodeId);
            uint16 GetNodeDeviceType(uint8 const _nodeId);
            string GetNodeDeviceTypeString(uint8 const _nodeId);
            uint8 GetNodeRole(uint8 const _nodeId);
            string GetNodeRoleString(uint8 const _nodeId);
            uint8 GetNodePlusType(uint8 const _nodeId);
            string GetNodePlusTypeString(uint8 const _nodeId);
            bool IsNodeZWavePlus(uint8 const _nodeId);

            uint16 GetNodeManufacturerId(uint8 const _nodeId);
            uint16 GetNodeProductType(uint8 const _nodeId);
            uint16 GetNodeProductId(uint8 const _nodeId);
            void SetNodeManufacturerName(uint8 const _nodeId, string const& _manufacturerName);
            void SetNodeProductName(uint8 const _nodeId, string const& _productName);
            void SetNodeName(uint8 const _nodeId, string const& _nodeName);
            void SetNodeLocation(uint8 const _nodeId, string const& _location);
            void SetNodeLevel(uint8 const _nodeId, uint8 const _level);
            void SetNodeOn(uint8 const _nodeId);
            void SetNodeOff(uint8 const _nodeId);

            Internal::VC::Value* GetValue(ValueID const& _id);

            bool IsAPICallSupported(uint8 const _apinum) const
            {
                return ((m_apiMask[(_apinum - 1) >> 3] & (1 << ((_apinum - 1) & 0x07))) != 0);
            }
            void SetAPICall(uint8 const _apinum, bool _toSet)
            {
                if (_toSet)
                {
                    m_apiMask[(_apinum - 1) >> 3] |= (1 << ((_apinum - 1) & 0x07));
                }
                else
                {
                    m_apiMask[(_apinum - 1) >> 3] &= ~(1 << ((_apinum - 1) & 0x07));
                }
            }
            uint8 NodeFromMessage(uint8 const* buffer);

            //-----------------------------------------------------------------------------
            // Controller commands
            //-----------------------------------------------------------------------------
        public:
            enum ControllerCommand
            {
                ControllerCommand_None = 0, 
                ControllerCommand_AddDevice, 
                ControllerCommand_CreateNewPrimary, 
                ControllerCommand_ReceiveConfiguration, 
                ControllerCommand_RemoveDevice, 
                ControllerCommand_RemoveFailedNode, 
                ControllerCommand_HasNodeFailed, 
                ControllerCommand_ReplaceFailedNode, 
                ControllerCommand_TransferPrimaryRole, 
                ControllerCommand_RequestNetworkUpdate, 
                ControllerCommand_RequestNodeNeighborUpdate, 
                ControllerCommand_AssignReturnRoute, 
                ControllerCommand_DeleteAllReturnRoutes, 
                ControllerCommand_SendNodeInformation, 
                ControllerCommand_ReplicationSend, 
                ControllerCommand_CreateButton, 
                ControllerCommand_DeleteButton 
            };

            enum ControllerState
            {
                ControllerState_Normal = 0, 
                ControllerState_Starting, 
                ControllerState_Cancel, 
                ControllerState_Error, 
                ControllerState_Waiting, 
                ControllerState_Sleeping, 
                ControllerState_InProgress, 
                ControllerState_Completed, 
                ControllerState_Failed, 
                ControllerState_NodeOK, 
                ControllerState_NodeFailed 
            };

            enum ControllerError
            {
                ControllerError_None = 0,
                ControllerError_ButtonNotFound, 
                ControllerError_NodeNotFound, 
                ControllerError_NotBridge, 
                ControllerError_NotSUC, 
                ControllerError_NotSecondary, 
                ControllerError_NotPrimary, 
                ControllerError_IsPrimary, 
                ControllerError_NotFound, 
                ControllerError_Busy, 
                ControllerError_Failed, 
                ControllerError_Disabled, 
                ControllerError_Overflow 
            };

            typedef void (*pfnControllerCallback_t)(ControllerState _state, ControllerError _err, void* _context);

        private:
            // The public interface is provided via the wrappers in the Manager class
            void ResetController(Internal::Platform::Event* _evt);
            void SoftReset();
            void RequestNodeNeighbors(uint8 const _nodeId, uint32 const _requestFlags);

            bool BeginControllerCommand(ControllerCommand _command, pfnControllerCallback_t _callback, void* _context, bool _highPower, uint8 _nodeId, uint8 _arg);
            bool CancelControllerCommand();
            void AddNodeStop(uint8 const _funcId);                  // Handle different controller behaviors

            struct ControllerCommandItem
            {
                    ControllerState m_controllerState;
                    bool m_controllerStateChanged;
                    bool m_controllerCommandDone;
                    ControllerCommand m_controllerCommand;
                    pfnControllerCallback_t m_controllerCallback;
                    ControllerError m_controllerReturnError;
                    void* m_controllerCallbackContext;
                    bool m_highPower;
                    bool m_controllerAdded;
                    uint8 m_controllerCommandNode;
                    uint8 m_controllerCommandArg;
                    uint8 m_controllerDeviceProtocolInfo[254];
                    uint8 m_controllerDeviceProtocolInfoLength;
            };

            ControllerCommandItem* m_currentControllerCommand;

            void DoControllerCommand();
            void UpdateControllerState(ControllerState const _state, ControllerError const _error = ControllerError_None);

            uint8 m_SUCNodeId;

            void UpdateNodeRoutes(uint8 const_nodeId, bool _doUpdate = false);

            Internal::Platform::Event* m_controllerResetEvent;

            //-----------------------------------------------------------------------------
            //  Sending Z-Wave messages
            //-----------------------------------------------------------------------------
        public:
            enum MsgQueue
            {
                MsgQueue_Command = 0,
                MsgQueue_NoOp,
                MsgQueue_Controller,
                MsgQueue_WakeUp,
                MsgQueue_Send,
                MsgQueue_Query,
                MsgQueue_Poll,
                MsgQueue_Count      // Number of message queues
            };

            void SendMsg(Internal::Msg* _msg, MsgQueue const _queue);

            uint8 GetTransmitOptions() const
            {
                return m_transmitOptions;
            }

        private:
            bool WriteNextMsg(MsgQueue const _queue);                           // Extracts the first message from the queue, and makes it the current one.
            bool WriteMsg(string const &str);                                   // Sends the current message to the Z-Wave network
            void RemoveCurrentMsg();                                            // Deletes the current message and cleans up the callback etc states
            bool MoveMessagesToWakeUpQueue(uint8 const _targetNodeId, bool const _move);        // If a node does not respond, and is of a type that can sleep, this method is used to move all its pending messages to another queue ready for when it wakes up next.
            bool HandleErrorResponse(uint8 const _error, uint8 const _nodeId, char const* _funcStr, bool _sleepCheck = false);                                      // Handle data errors and process consistently. If message is moved to wake-up queue, return true.
            bool IsExpectedReply(uint8 const _nodeId);                      // Determine if reply message is the one we are expecting
            void SendQueryStageComplete(uint8 const _nodeId, Node::QueryStage const _stage);
            void RetryQueryStageComplete(uint8 const _nodeId, Node::QueryStage const _stage);
            void CheckCompletedNodeQueries();                                   // Send notifications if all awake and/or sleeping nodes have completed their queries

            // Requests to be sent to nodes are assigned to one of five queues.
            // From highest to lowest priority, these are
            //
            // 0)   The security queue, for handling encrypted messages.  This is the
            //              highest priority send queue, because the security process inserts
            //              messages to handle the encryption process that must be sent before
            //              a new message can be wrapped.
            //
            // 1)   The command queue, for controller commands.  This is the 2nd highest
            //      priority send queue, because the controller command processes are not
            //      permitted to be interrupted by other requests.
            //
            // 2)   The controller queue exists to handle multi-step controller commands. These
            //      typically require user interaction or affect the network in some way.
            //
            // 3)   The No Operation command class queue. This is used for device probing
            //      at startup as well as network diagnostics.
            //
            // 4)   The wakeup queue.  This holds messages that have been held for a
            //      sleeping device that has now woken up.  These get a high priority
            //      because such devices do not stay awake for very long.
            //
            // 5)   The send queue.  This is for normal messages, usually triggered by
            //      a user interaction with the application.
            //
            // 6)   The query queue.  For node query messages sent when a new node is
            //      discovered.  The query process generates a large number of requests,
            //      so the query queue has a low priority to avoid making the system
            //      unresponsive.
            //
            // 7)   The poll queue.  Requests to devices that need their state polling
            //      at regular intervals.  These are of the lowest priority, and are only
            //      sent when nothing else is going on
            //
            enum MsgQueueCmd
            {
                MsgQueueCmd_SendMsg = 0,
                MsgQueueCmd_QueryStageComplete,
                MsgQueueCmd_Controller,
                MsgQueueCmd_ReloadNode
            };

            class MsgQueueItem
            {
                public:
                    MsgQueueItem() :
                            m_msg(NULL), m_nodeId(0), m_queryStage(Node::QueryStage_None), m_retry(false), m_cci(NULL)
                    {
                    }

                    bool operator ==(MsgQueueItem const& _other) const
                    {
                        if (_other.m_command == m_command)
                        {
                            if (m_command == MsgQueueCmd_SendMsg)
                            {
                                return ((*_other.m_msg) == (*m_msg));
                            }
                            else if (m_command == MsgQueueCmd_QueryStageComplete)
                            {
                                return ((_other.m_nodeId == m_nodeId) && (_other.m_queryStage == m_queryStage));
                            }
                            else if (m_command == MsgQueueCmd_Controller)
                            {
                                return ((_other.m_cci->m_controllerCommand == m_cci->m_controllerCommand) && (_other.m_cci->m_controllerCallback == m_cci->m_controllerCallback));
                            }
                            else if (m_command == MsgQueueCmd_ReloadNode)
                            {
                                return (_other.m_nodeId == m_nodeId);
                            }

                        }

                        return false;
                    }

                    MsgQueueCmd m_command;
                    Internal::Msg* m_msg;
                    uint8 m_nodeId;
                    Node::QueryStage m_queryStage;
                    bool m_retry;
                    ControllerCommandItem* m_cci;
            };

            list<MsgQueueItem> m_msgQueue[MsgQueue_Count];
            Internal::Platform::Event* m_queueEvent[MsgQueue_Count];        // Events for each queue, which are signaled when the queue is not empty
            Internal::Platform::Mutex* m_sendMutex;                     // Serialize access to the queues
            Internal::Msg* m_currentMsg;
            MsgQueue m_currentMsgQueueSource;           // identifies which queue held m_currentMsg
            Internal::Platform::TimeStamp m_resendTimeStamp;

            //-----------------------------------------------------------------------------
            // Network functions
            //-----------------------------------------------------------------------------
        private:
            void TestNetwork(uint8 const _nodeId, uint32 const _count);

            //-----------------------------------------------------------------------------
            // Virtual Node commands
            //-----------------------------------------------------------------------------
        public:
        private:
            uint32 GetVirtualNeighbors(uint8** o_neighbors);
            void RequestVirtualNeighbors(MsgQueue const _queue);
            bool IsVirtualNode(uint8 const _nodeId) const
            {
                return ((m_virtualNeighbors[(_nodeId - 1) >> 3] & 1 << ((_nodeId - 1) & 0x07)) != 0);
            }
            void SendVirtualNodeInfo(uint8 const _fromNodeId, uint8 const _ToNodeId);
            void SendSlaveLearnModeOff();
            void SaveButtons();
            void ReadButtons(uint8 const _nodeId);

            bool m_virtualNeighborsReceived;
            uint8 m_virtualNeighbors[NUM_NODE_BITFIELD_BYTES];      // Bitmask containing virtual neighbors

            //-----------------------------------------------------------------------------
            // SwitchAll
            //-----------------------------------------------------------------------------
        private:
            // The public interface is provided via the wrappers in the Manager class
            void SwitchAllOn();
            void SwitchAllOff();

            //-----------------------------------------------------------------------------
            // Configuration Parameters (wrappers for the Node methods)
            //-----------------------------------------------------------------------------
        private:
            // The public interface is provided via the wrappers in the Manager class
            bool SetConfigParam(uint8 const _nodeId, uint8 const _param, int32 _value, uint8 const _size);
            void RequestConfigParam(uint8 const _nodeId, uint8 const _param);

            //-----------------------------------------------------------------------------
            // Groups (wrappers for the Node methods)
            //-----------------------------------------------------------------------------
        private:
            // The public interface is provided via the wrappers in the Manager class
            uint8 GetNumGroups(uint8 const _nodeId);
            uint32 GetAssociations(uint8 const _nodeId, uint8 const _groupIdx, uint8** o_associations);
            uint32 GetAssociations(uint8 const _nodeId, uint8 const _groupIdx, InstanceAssociation** o_associations);
            uint8 GetMaxAssociations(uint8 const _nodeId, uint8 const _groupIdx);
            bool IsMultiInstance(uint8 const _nodeId, uint8 const _groupIdx);
            string GetGroupLabel(uint8 const _nodeId, uint8 const _groupIdx);
            void AddAssociation(uint8 const _nodeId, uint8 const _groupIdx, uint8 const _targetNodeId, uint8 const _instance = 0x00);
            void RemoveAssociation(uint8 const _nodeId, uint8 const _groupIdx, uint8 const _targetNodeId, uint8 const _instance = 0x00);

            //-----------------------------------------------------------------------------
            //  Notifications
            //-----------------------------------------------------------------------------
        private:
            void QueueNotification(Notification* _notification);                // Adds a notification to the list.  Notifications are queued until a point in the thread where we know we do not have any nodes locked.
            void NotifyWatchers();                                              // Passes the notifications to all the registered watcher callbacks in turn.
            list<Notification*> m_notifications;
            Internal::Platform::Event* m_notificationsEvent;

            //-----------------------------------------------------------------------------
            //  Statistics
            //-----------------------------------------------------------------------------
        public:
            struct DriverData
            {
                    uint32 m_SOFCnt;            // Number of SOF bytes received
                    uint32 m_ACKWaiting;        // Number of unsolicited messages while waiting for an ACK
                    uint32 m_readAborts;        // Number of times read were aborted due to timeouts
                    uint32 m_badChecksum;       // Number of bad checksums
                    uint32 m_readCnt;           // Number of messages successfully read
                    uint32 m_writeCnt;          // Number of messages successfully sent
                    uint32 m_CANCnt;            // Number of CAN bytes received
                    uint32 m_NAKCnt;            // Number of NAK bytes received
                    uint32 m_ACKCnt;            // Number of ACK bytes received
                    uint32 m_OOFCnt;            // Number of bytes out of framing
                    uint32 m_dropped;           // Number of messages dropped & not delivered
                    uint32 m_retries;           // Number of messages retransmitted
                    uint32 m_callbacks;         // Number of unexpected callbacks
                    uint32 m_badroutes;         // Number of failed messages due to bad route response
                    uint32 m_noack;             // Number of no ACK returned errors
                    uint32 m_netbusy;           // Number of network busy/failure messages
                    uint32 m_notidle;           // Number of RF Network Busy messages
                    uint32 m_txverified;        // Number of TX Verified messages
                    uint32 m_nondelivery;       // Number of messages not delivered to network
                    uint32 m_routedbusy;        // Number of messages received with routed busy status
                    uint32 m_broadcastReadCnt;  // Number of broadcasts read
                    uint32 m_broadcastWriteCnt; // Number of broadcasts sent
            };
            void LogDriverStatistics();

        private:
            void GetDriverStatistics(DriverData* _data);
            void GetNodeStatistics(uint8 const _nodeId, Node::NodeData* _data);

            uint32 m_SOFCnt;            // Number of SOF bytes received
            uint32 m_ACKWaiting;        // Number of unsolicited messages while waiting for an ACK
            uint32 m_readAborts;        // Number of times read were aborted due to timeouts
            uint32 m_badChecksum;       // Number of bad checksums
            uint32 m_readCnt;           // Number of messages successfully read
            uint32 m_writeCnt;          // Number of messages successfully sent
            uint32 m_CANCnt;            // Number of CAN bytes received
            uint32 m_NAKCnt;            // Number of NAK bytes received
            uint32 m_ACKCnt;            // Number of ACK bytes received
            uint32 m_OOFCnt;            // Number of bytes out of framing
            uint32 m_dropped;           // Number of messages dropped & not delivered
            uint32 m_retries;           // Number of retransmitted messages
            uint32 m_callbacks;         // Number of unexpected callbacks
            uint32 m_badroutes;         // Number of failed messages due to bad route response
            uint32 m_noack;             // Number of no ACK returned errors
            uint32 m_netbusy;           // Number of network busy/failure messages
            uint32 m_notidle;           // Number of not idle messages
            uint32 m_txverified;        // Number of TX Verified messages
            uint32 m_nondelivery;       // Number of messages not delivered to network
            uint32 m_routedbusy;        // Number of messages received with routed busy status
            uint32 m_broadcastReadCnt;  // Number of broadcasts read
            uint32 m_broadcastWriteCnt; // Number of broadcasts sent
            //time_t m_commandStart;    // Start time of last command
            //time_t m_timeoutLost;     // Cumulative time lost to timeouts

            //-----------------------------------------------------------------------------
            //  Security Command Class Related (Version 1.1)
            //-----------------------------------------------------------------------------
        public:
            aes_encrypt_ctx *GetAuthKey();
            aes_encrypt_ctx *GetEncKey();
            bool isNetworkKeySet();

        private:
            bool initNetworkKeys(bool newnode);
            uint8 *GetNetworkKey();
            bool SendEncryptedMessage();
            bool SendNonceRequest(string logmsg);
            void SendNonceKey(uint8 nodeId, uint8 *nonce);
            aes_encrypt_ctx *AuthKey;
            aes_encrypt_ctx *EncryptKey;
            uint8 m_nonceReportSent;
            uint8 m_nonceReportSentAttempt;
            bool m_inclusionkeySet;

            //-----------------------------------------------------------------------------
            //  Event Signaling for DNS and HTTP Threads
            //-----------------------------------------------------------------------------
        private:
            struct EventMsg
            {
                    enum EventType
                    {
                        Event_DNS = 1,
                        Event_Http
                    };
                    EventType type;
                    union
                    {
                            Internal::DNSLookup *lookup;
                            Internal::HttpDownload *httpdownload;
                    } event;
            };

            void SubmitEventMsg(EventMsg *);
            void ProcessEventMsg();
            list<EventMsg *> m_eventQueueMsg;
            Internal::Platform::Event* m_queueMsgEvent;             // Events for each queue, which are signalled when the queue is not empty
            Internal::Platform::Mutex* m_eventMutex;                        // Serialize access to the queues

            //-----------------------------------------------------------------------------
            //  DNS Related
            //-----------------------------------------------------------------------------

        public:
            bool CheckNodeConfigRevision(Node *);
            bool CheckMFSConfigRevision();
            void ReloadNode(uint8 const _nodeId);

        private:
            void processConfigRevision(Internal::DNSLookup *);

            //-----------------------------------------------------------------------------
            //  HTTP Client Related
            //-----------------------------------------------------------------------------

        public:
            bool setHttpClient(Internal::i_HttpClient *client);
        private:
            bool startConfigDownload(uint16 _manufacturerId, uint16 _productType, uint16 _productId, string configfile, uint8 node = 0);
            bool startMFSDownload(string configfile);
            bool refreshNodeConfig(uint8 node);
            void processDownload(Internal::HttpDownload *);
            Internal::i_HttpClient *m_httpClient;

            //-----------------------------------------------------------------------------
            //  Metadata Related
            //-----------------------------------------------------------------------------

        public:
            string const GetMetaData(uint8 const _nodeId, Node::MetaDataFields _metadata);
            Node::ChangeLogEntry const GetChangeLog(uint8 const _nodeId, uint32_t revision);

            //-----------------------------------------------------------------------------
            //  ManufacturerSpecificDB Related
            //-----------------------------------------------------------------------------

        public:
            Internal::ManufacturerSpecificDB *GetManufacturerSpecificDB();
            bool downloadConfigRevision(Node *);
            bool downloadMFSRevision();
        private:
            Internal::ManufacturerSpecificDB *m_mfs;

    };

} // namespace OpenZWave

#endif // _Driver_H