Node.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//
//  Node.h
//
//  A node in the 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 _Node_H
#define _Node_H

#include <string>
#include <vector>
#include <list>
#include <map>
#include "Defs.h"
#include "value_classes/ValueID.h"
#include "value_classes/ValueList.h"
#include "Msg.h"
#include "platform/TimeStamp.h"
#include "Group.h"

class TiXmlElement;
class TiXmlNode;

namespace OpenZWave
{
    namespace Internal
    {
        namespace CC
        {
            class CommandClass;
            class Association;
            class AssociationCommandConfiguration;
            class ControllerReplication;
            class Hail;
            class ManufacturerSpecific;
            class MultiChannelAssociation;
            class MultiInstance;
            class NodeNaming;
            class Version;
            class ZWavePlusInfo;
        }
        namespace VC
        {
            class Value;
            class ValueStore;
        }
        namespace Platform
        {
            class Mutex;
        }
        class ProductDescriptor;
        class ManufacturerSpecificDB;
    }
    class Driver;
    class Group;

    class Node
    {
            friend class Manager;
            friend class Driver;
            friend class Group;
            friend class Internal::VC::Value;
            friend class ValueButton;
            friend class Internal::CC::Association;
            friend class Internal::CC::AssociationCommandConfiguration;
            friend class Internal::CC::CommandClass;
            friend class Internal::CC::ControllerReplication;
            friend class Internal::CC::Hail;
            friend class Internal::CC::ManufacturerSpecific;
            friend class Internal::CC::MultiInstance;
            friend class Internal::CC::MultiChannelAssociation;
            friend class Internal::CC::NodeNaming;
            friend class Internal::CC::Version;
            friend class Internal::CC::ZWavePlusInfo;
            friend class Internal::ManufacturerSpecificDB;

            //-----------------------------------------------------------------------------
            // Construction
            //-----------------------------------------------------------------------------
        public:
            Node(uint32 const _homeId, uint8 const _nodeId);
            virtual ~Node();

        private:
            Driver* GetDriver() const;

            //-----------------------------------------------------------------------------
            // Initialization
            //-----------------------------------------------------------------------------
        public:
            enum QueryStage
            {
                QueryStage_None, 
                QueryStage_ProtocolInfo, 
                QueryStage_Probe, 
                QueryStage_WakeUp, 
                QueryStage_ManufacturerSpecific1, 
                QueryStage_NodeInfo, 
                QueryStage_NodePlusInfo, 
                QueryStage_SecurityReport, 
                QueryStage_ManufacturerSpecific2, 
                QueryStage_Versions, 
                QueryStage_Instances, 
                QueryStage_Static, 
                QueryStage_CacheLoad, 
                QueryStage_Probe1 = QueryStage_CacheLoad, 
                QueryStage_Associations, 
                QueryStage_Neighbors, 
                QueryStage_Session, 
                QueryStage_Dynamic, 
                QueryStage_Configuration, 
                QueryStage_Complete 
            };

            void AdvanceQueries();

            void QueryStageComplete(QueryStage const _stage);

            void QueryStageRetry(QueryStage const _stage, uint8 const _maxAttempts = 0);        // maxAttempts of zero means no limit

            void SetQueryStage(QueryStage const _stage, bool const _advance = true);

            Node::QueryStage GetCurrentQueryStage()
            {
                return m_queryStage;
            }

            string GetQueryStageName(QueryStage const _stage);

            bool IsNodeAlive() const
            {
                return m_nodeAlive;
            }

            void UpdateProtocolInfo(uint8 const* _data);
            void SetProtocolInfo(uint8 const* _protocolInfo, uint8 const _length);
            void UpdateNodeInfo(uint8 const* _data, uint8 const _length);

            bool ProtocolInfoReceived() const
            {
                return m_protocolInfoReceived;
            }
            bool NodeInfoReceived() const
            {
                return m_nodeInfoReceived;
            }
            bool IsNodeZWavePlus() const
            {
                return m_nodePlusInfoReceived;
            }

            bool AllQueriesCompleted() const
            {
                return (QueryStage_Complete == m_queryStage);
            }

            void SetNodePlusInfoReceived(const bool _received)
            {
                m_nodePlusInfoReceived = _received;
            }

            void SetNodeAlive(bool const _isAlive);

        private:
            void SetStaticRequests();

            QueryStage m_queryStage;
            bool m_queryPending;
            bool m_queryConfiguration;
            uint8 m_queryRetries;
            bool m_protocolInfoReceived;
            bool m_basicprotocolInfoReceived;
            bool m_nodeInfoReceived;
            bool m_nodePlusInfoReceived;
            bool m_manufacturerSpecificClassReceived;
            bool m_nodeInfoSupported;
            bool m_refreshonNodeInfoFrame;
            bool m_nodeAlive;

            //-----------------------------------------------------------------------------
            // Capabilities
            //-----------------------------------------------------------------------------
        public:
            // Security flags
            enum
            {
                SecurityFlag_Security = 0x01,
                SecurityFlag_Controller = 0x02,
                SecurityFlag_SpecificDevice = 0x04,
                SecurityFlag_RoutingSlave = 0x08,
                SecurityFlag_BeamCapability = 0x10,
                SecurityFlag_Sensor250ms = 0x20,
                SecurityFlag_Sensor1000ms = 0x40,
                SecurityFlag_OptionalFunctionality = 0x80
            };

            // Node Ids
            enum
            {
                NodeBroadcast = 0xff
            };

            bool IsListeningDevice() const
            {
                return m_listening;
            }
            bool IsFrequentListeningDevice() const
            {
                return m_frequentListening;
            }
            bool IsBeamingDevice() const
            {
                return m_beaming;
            }
            bool IsRoutingDevice() const
            {
                return m_routing;
            }
            bool IsSecurityDevice() const
            {
                return m_security;
            }
            uint32 GetMaxBaudRate() const
            {
                return m_maxBaudRate;
            }
            uint8 GetVersion() const
            {
                return m_version;
            }
            uint8 GetSecurity() const
            {
                return m_security;
            }

            uint8 GetNodeId() const
            {
                return m_nodeId;
            }

            uint8 GetBasic() const
            {
                return m_basic;
            }
            uint8 GetGeneric() const
            {
                return m_generic;
            }
            uint8 GetSpecific() const
            {
                return m_specific;
            }
            string const& GetType() const
            {
                return m_type;
            }
            uint32 GetNeighbors(uint8** o_neighbors);
            bool IsController() const
            {
                return (m_basic == 0x01 || m_basic == 0x02) && (m_generic == 0x01 || m_generic == 0x02);
            }
            bool IsAddingNode() const
            {
                return m_addingNode;
            } /* These three *AddingNode functions are used to tell if we this node is just being discovered. Currently used by the Security CC to initiate the Network Key Exchange */
            void SetAddingNode()
            {
                m_addingNode = true;
            }
            void ClearAddingNode()
            {
                m_addingNode = false;
            }
            bool IsNodeReset();
        private:
            bool m_listening;
            bool m_frequentListening;
            bool m_beaming;
            bool m_routing;
            uint32 m_maxBaudRate;
            uint8 m_version;
            bool m_security;
            uint32 m_homeId;
            uint8 m_nodeId;
            uint8 m_basic;              //*< Basic device class (0x01-Controller, 0x02-Static Controller, 0x03-Slave, 0x04-Routing Slave
            uint8 m_generic;
            uint8 m_specific;
            string m_type;                  // Label representing the specific/generic/basic value
            uint8 m_neighbors[29];      // Bitmask containing the neighboring nodes
            uint8 m_numRouteNodes;      // number of node routes
            uint8 m_routeNodes[5];      // nodes to route to
            map<uint8, uint8> m_buttonMap;  // Map button IDs into virtual node numbers
            bool m_addingNode;

            //-----------------------------------------------------------------------------
            // Device Naming
            //-----------------------------------------------------------------------------
        private:
            // Manufacturer, Product and Name are stored here so they can be set by the
            // user even if the device does not support the relevant command classes.
            string GetManufacturerName() const
            {
                return m_manufacturerName;
            }
            string GetProductName() const
            {
                return m_productName;
            }
            string GetNodeName() const
            {
                return m_nodeName;
            }
            string GetLocation() const
            {
                return m_location;
            }

//          string GetManufacturerId()const{ return std::to_string(m_manufacturerId); }
            uint16 GetManufacturerId() const
            {
                return m_manufacturerId;
            }
//          string GetProductType()const{ return string(m_productType); }
            uint16 GetProductType() const
            {
                return m_productType;
            }
//          string GetProductId()const{ return string(m_productId); }
            uint16 GetProductId() const
            {
                return m_productId;
            }

            void SetManufacturerName(string const& _manufacturerName)
            {
                m_manufacturerName = _manufacturerName;
            }
            void SetProductName(string const& _productName)
            {
                m_productName = _productName;
            }
            void SetNodeName(string const& _nodeName);
            void SetLocation(string const& _location);

            void SetManufacturerId(uint16 const& _manufacturerId)
            {
                m_manufacturerId = _manufacturerId;
            }
            void SetProductType(uint16 const& _productType)
            {
                m_productType = _productType;
            }
            void SetProductId(uint16 const& _productId)
            {
                m_productId = _productId;
            }

            string m_manufacturerName;
            string m_productName;
            string m_nodeName;
            string m_location;

            uint16 m_manufacturerId;
            uint16 m_productType;
            uint16 m_productId;

            // zwave+ info
            uint16 GetDeviceType() const
            {
                return m_deviceType;
            }
            string GetDeviceTypeString();
            uint8 GetRoleType() const
            {
                return m_role;
            }
            string GetRoleTypeString();
            uint8 GetNodeType() const
            {
                return m_nodeType;
            }
            string GetNodeTypeString();

            uint16 m_deviceType;
            uint8 m_role;
            uint8 m_nodeType;

            //-----------------------------------------------------------------------------
            // Command Classes
            //-----------------------------------------------------------------------------
        public:
            Internal::CC::CommandClass* GetCommandClass(uint8 const _commandClassId) const;
            void ApplicationCommandHandler(uint8 const* _data, bool encrypted);

            void SetSecuredClasses(uint8 const* _data, uint8 const _length, uint32 const _instance = 1);
            void SetSecured(bool secure);
            bool IsSecured();
            void SetInstanceLabel(uint8 const _instance, char *label);
            string GetInstanceLabel(uint8 const _ccid, uint8 const _instance);

            uint8 GetNumInstances(uint8 const _ccid);
        private:
            Internal::CC::CommandClass* AddCommandClass(uint8 const _commandClassId);
            void RemoveCommandClass(uint8 const _commandClassId);
            void ReadXML(TiXmlElement const* _nodeElement);
            void ReadDeviceProtocolXML(TiXmlElement const* _ccsElement);
            void ReadCommandClassesXML(TiXmlElement const* _ccsElement);
            void WriteXML(TiXmlElement* _nodeElement);

            map<uint8, Internal::CC::CommandClass*> m_commandClassMap; 
            bool m_secured; 
            map<uint8, string> m_globalInstanceLabel; 
            TiXmlNode *m_nodeCache;
            //-----------------------------------------------------------------------------
            // Configuration Revision Related Classes
            //-----------------------------------------------------------------------------
        public:
            void SetProductDetails(std::shared_ptr<Internal::ProductDescriptor> product);
            string getConfigPath();
            uint32 getFileConfigRevision()
            {
                return m_fileConfigRevision;
            }
            ;
            uint32 getLoadedConfigRevision()
            {
                return m_loadedConfigRevision;
            }
            ;
            uint32 getLatestConfigRevision()
            {
                return m_latestConfigRevision;
            }
            ;
            void setFileConfigRevision(uint32 rev);
            void setLoadedConfigRevision(uint32 rev);
            void setLatestConfigRevision(uint32 rev);
            void checkLatestConfigRevision();

        private:

            std::shared_ptr<Internal::ProductDescriptor> m_Product;

            uint32 m_fileConfigRevision;
            uint32 m_loadedConfigRevision;
            uint32 m_latestConfigRevision;
            //-----------------------------------------------------------------------------
            // Basic commands (helpers that go through the basic command class)
            //-----------------------------------------------------------------------------
        public:
            void SetLevel(uint8 const _level);

            //-----------------------------------------------------------------------------
            // On/Off commands (helpers that go through the basic or switchall command class)
            //-----------------------------------------------------------------------------
        public:
            void SetNodeOn();
            void SetNodeOff();

            //-----------------------------------------------------------------------------
            // Values (handled by the command classes)
            //-----------------------------------------------------------------------------
        public:
            ValueID CreateValueID(ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex, ValueID::ValueType const _type);

            Internal::VC::Value* GetValue(ValueID const& _id);
            Internal::VC::Value* GetValue(uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex);
            bool RemoveValue(uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex);

            // Helpers for creating values
            bool CreateValueBitSet(ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, int32 const _default, uint8 const _pollIntensity);
            bool CreateValueBool(ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, bool const _default, uint8 const _pollIntensity);
            bool CreateValueButton(ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex, string const& _label, uint8 const _pollIntensity);
            bool CreateValueByte(ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, uint8 const _default, uint8 const _pollIntensity);
            bool CreateValueDecimal(ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, string const& _default, uint8 const _pollIntensity);
            bool CreateValueInt(ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, int32 const _default, uint8 const _pollIntensity);
            bool CreateValueList(ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, uint8 const _size, vector<Internal::VC::ValueList::Item> const& _items, int32 const _default, uint8 const _pollIntensity);
            bool CreateValueRaw(ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, uint8 const* _default, uint8 const _length, uint8 const _pollIntensity);
            bool CreateValueSchedule(ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, uint8 const _pollIntensity);
            bool CreateValueShort(ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, int16 const _default, uint8 const _pollIntensity);
            bool CreateValueString(ValueID::ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint16 const _valueIndex, string const& _label, string const& _units, bool const _readOnly, bool const _writeOnly, string const& _default, uint8 const _pollIntensity);

            // helpers for removing values
            void RemoveValueList(Internal::VC::ValueList* _value);

            void ReadValueFromXML(uint8 const _commandClassId, TiXmlElement const* _valueElement);
            bool CreateValueFromXML(uint8 const _commandClassId, TiXmlElement const* _valueElement);

        private:
            Internal::VC::ValueStore* GetValueStore() const
            {
                return m_values;
            }

            Internal::VC::ValueStore* m_values;         // Values reported via command classes

            //-----------------------------------------------------------------------------
            // Configuration Parameters (handled by the Configuration command class)
            //-----------------------------------------------------------------------------
        private:
            bool SetConfigParam(uint8 const _param, int32 _value, uint8 const _size);
            void RequestConfigParam(uint8 const _param);
            bool RequestAllConfigParams(uint32 const _requestFlags);

            //-----------------------------------------------------------------------------
            // Dynamic Values (used by query and other command classes for updating)
            //-----------------------------------------------------------------------------
        private:
            bool RequestDynamicValues();
        public:
            //-----------------------------------------------------------------------------
            // Refresh Dynamic Values from CommandClasses on Wakeup
            //-----------------------------------------------------------------------------
            void RefreshValuesOnWakeup();
            //-----------------------------------------------------------------------------
            // Groups
            //-----------------------------------------------------------------------------
        private:
            // The public interface is provided via the wrappers in the Manager class
            uint8 GetNumGroups();
            uint32 GetAssociations(uint8 const _groupIdx, uint8** o_associations);
            uint32 GetAssociations(uint8 const _groupIdx, InstanceAssociation** o_associations);
            uint8 GetMaxAssociations(uint8 const _groupIdx);
            bool IsMultiInstance(uint8 const _groupIdx);
            string GetGroupLabel(uint8 const _groupIdx);
            void AddAssociation(uint8 const _groupIdx, uint8 const _targetNodeId, uint8 const _instance = 0x00);
            void RemoveAssociation(uint8 const _groupIdx, uint8 const _targetNodeId, uint8 const _instance = 0x00);
            void AutoAssociate();

            // The following methods are not exposed
            Group* GetGroup(uint8 const _groupIdx);                         // Get a pointer to a Group object.  This must only be called while holding the node Lock.
            void AddGroup(Group* _group);                                       // The groups are fixed properties of a device, so there is no need for a matching RemoveGroup.
            void WriteGroups(TiXmlElement* _associationsElement);               // Write the group data out to XNL

            map<uint8, Group*> m_groups;                                            // Maps group indices to Group objects.

            //-----------------------------------------------------------------------------
            // Device Classes (static data read from the device_classes.xml file)
            //-----------------------------------------------------------------------------
        private:
            // Container for device class info
            class DeviceClass
            {
                public:
                    DeviceClass(TiXmlElement const* _el);
                    ~DeviceClass()
                    {
                        delete[] m_mandatoryCommandClasses;
                    }

                    uint8 const* GetMandatoryCommandClasses()
                    {
                        return m_mandatoryCommandClasses;
                    }
                    uint8 GetBasicMapping()
                    {
                        return m_basicMapping;
                    }
                    string const& GetLabel()
                    {
                        return m_label;
                    }

                private:
                    uint8* m_mandatoryCommandClasses;                       // Zero terminated array of mandatory command classes for this device type.
                    uint8 m_basicMapping;                                   // Command class that COMMAND_CLASS_BASIC maps on to, or zero if there is no mapping.
                    string m_label;                                     // Descriptive label for the device.
            };

            // Container for generic device class info
            class GenericDeviceClass: public DeviceClass
            {
                public:
                    GenericDeviceClass(TiXmlElement const* _el);
                    ~GenericDeviceClass();

                    DeviceClass* GetSpecificDeviceClass(uint8 const& _specific);

                private:
                    map<uint8, DeviceClass*> m_specificDeviceClasses;
            };

            bool SetDeviceClasses(uint8 const _basic, uint8 const _generic, uint8 const _specific); // Set the device class data for the node
            bool SetPlusDeviceClasses(uint8 const _role, uint8 const _nodeType, uint16 const _deviceType);  // Set the device class data for the node based on the Zwave+ info report
            bool AddMandatoryCommandClasses(uint8 const* _commandClasses);                          // Add mandatory command classes as specified in the device_classes.xml to the node.
            void ReadDeviceClasses();                                                                   // Read the static device class data from the device_classes.xml file
            string GetEndPointDeviceClassLabel(uint8 const _generic, uint8 const _specific);

            static bool s_deviceClassesLoaded;      // True if the xml file has already been loaded
            static map<uint8, string> s_basicDeviceClasses;     // Map of basic device classes.
            static map<uint8, GenericDeviceClass*> s_genericDeviceClasses;      // Map of generic device classes.
            static map<uint8, DeviceClass*> s_roleDeviceClasses;        // Map of Zwave+ role device classes.
            static map<uint16, DeviceClass*> s_deviceTypeClasses;       // Map of Zwave+ device type device classes.
            static map<uint8, DeviceClass*> s_nodeTypes;                // Map of ZWave+ Node Types

            //-----------------------------------------------------------------------------
            //  Statistics
            //-----------------------------------------------------------------------------
        public:
            struct CommandClassData
            {
                    uint8 m_commandClassId;
                    uint32 m_sentCnt;
                    uint32 m_receivedCnt;
            };

            struct NodeData
            {
                    uint32 m_sentCnt;
                    uint32 m_sentFailed;
                    uint32 m_retries;
                    uint32 m_receivedCnt;
                    uint32 m_receivedDups;
                    uint32 m_receivedUnsolicited;
                    string m_sentTS;
                    string m_receivedTS;
                    uint32 m_lastRequestRTT;
                    uint32 m_averageRequestRTT;             // ms
                    uint32 m_lastResponseRTT;
                    uint32 m_averageResponseRTT;
                    uint8 m_quality;                    // Node quality measure
                    uint8 m_lastReceivedMessage[254];
                    list<CommandClassData> m_ccData;
                    bool m_txStatusReportSupported;
                    uint16 m_txTime;
                    uint8 m_hops;
                    char m_rssi_1[8];
                    char m_rssi_2[8];
                    char m_rssi_3[8];
                    char m_rssi_4[8];
                    char m_rssi_5[8];
                    uint8 m_ackChannel;
                    uint8 m_lastTxChannel;
                    TXSTATUS_ROUTING_SCHEME m_routeScheme;
                    char m_routeUsed[9];
                    TXSTATUS_ROUTE_SPEED m_routeSpeed;
                    uint8 m_routeTries;
                    uint8 m_lastFailedLinkFrom;
                    uint8 m_lastFailedLinkTo;
            };

        private:
            void GetNodeStatistics(NodeData* _data);

            uint32 m_sentCnt;                   // Number of messages sent from this node.
            uint32 m_sentFailed;                // Number of sent messages failed
            uint32 m_retries;                   // Number of message retries
            uint32 m_receivedCnt;               // Number of messages received from this node.
            uint32 m_receivedDups;              // Number of duplicated messages received;
            uint32 m_receivedUnsolicited;       // Number of messages received unsolicited
            uint32 m_lastRequestRTT;            // Last message request RTT
            uint32 m_lastResponseRTT;           // Last message response RTT
            Internal::Platform::TimeStamp m_sentTS;                 // Last message sent time
            Internal::Platform::TimeStamp m_receivedTS;             // Last message received time
            uint32 m_averageRequestRTT;         // Average Request round trip time.
            uint32 m_averageResponseRTT;        // Average Response round trip time.
            uint8 m_quality;                    // Node quality measure
            uint8 m_lastReceivedMessage[254];   // Place to hold last received message
            uint8 m_errors;
            bool m_txStatusReportSupported;     // if Extended Status Reports are available
            uint16 m_txTime;                    // Time Taken to Transmit the last frame
            uint8 m_hops;                       // Hops taken in transmitting last frame
            char m_rssi_1[8];                   // RSSI Level of last transmission
            char m_rssi_2[8];                   // RSSI Level of last transmission
            char m_rssi_3[8];                   // RSSI Level of last transmission
            char m_rssi_4[8];                   // RSSI Level of last transmission
            char m_rssi_5[8];                   // RSSI Level of last transmission
            uint8 m_ackChannel;                 // Channel we received the last ACK on
            uint8 m_lastTxChannel;              // Channel we transmitted the last frame on
            TXSTATUS_ROUTING_SCHEME m_routeScheme;              // The Scheme used to route the last frame
            uint8 m_routeUsed[4];               // The Route Taken in the last frame
            TXSTATUS_ROUTE_SPEED m_routeSpeed;                  // Baud Rate of the last frame
            uint8 m_routeTries;                 // The number of attempts to route the last frame
            uint8 m_lastFailedLinkFrom;         // The last failed link from
            uint8 m_lastFailedLinkTo;           // The last failed link to

            //-----------------------------------------------------------------------------
            //  Encryption Related
            //-----------------------------------------------------------------------------
        public:

            uint8 *GenerateNonceKey();
            uint8 *GetNonceKey(uint32 nonceid);

        private:
            uint8 m_lastnonce;
            uint8 m_nonces[8][8];

            //-----------------------------------------------------------------------------
            //  MetaData Related
            //-----------------------------------------------------------------------------

        public:
            enum MetaDataFields
            {
                MetaData_OzwInfoPage_URL,
                MetaData_ZWProductPage_URL,
                MetaData_ProductPic,
                MetaData_Description,
                MetaData_ProductManual_URL,
                MetaData_ProductPage_URL,
                MetaData_InclusionHelp,
                MetaData_ExclusionHelp,
                MetaData_ResetHelp,
                MetaData_WakeupHelp,
                MetaData_ProductSupport_URL,
                MetaData_Frequency,
                MetaData_Name,
                MetaData_Identifier,
                MetaData_Invalid = 255
            };

            struct ChangeLogEntry
            {
                    string author;
                    string date;
                    int revision;
                    string description;
            };
            string const GetMetaData(MetaDataFields);
            MetaDataFields GetMetaDataId(string);
            string const GetMetaDataString(MetaDataFields);
            ChangeLogEntry const GetChangeLog(uint32_t);

        private:
            void ReadMetaDataFromXML(TiXmlElement const* _valueElement);
            void WriteMetaDataXML(TiXmlElement*);
            map<MetaDataFields, string> m_metadata;
            map<uint32_t, ChangeLogEntry> m_changeLog;
    };

} //namespace OpenZWave

#endif //_Node_H