Msg.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//
//  Msg.h
//
//  Represents a Z-Wave message
//
//  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 _Msg_H
#define _Msg_H

#include <cstdio>
#include <string>
#include <string.h>
#include "Defs.h"
//#include "Driver.h"

namespace OpenZWave
{
    class Driver;

    namespace Internal
    {
        namespace CC
        {
            class CommandClass;
        }

        class OPENZWAVE_EXPORT Msg
        {
            public:
                enum MessageFlags
                {
                    m_MultiChannel = 0x01,      // Indicate MultiChannel encapsulation
                    m_MultiInstance = 0x02,     // Indicate MultiInstance encapsulation
                    m_Supervision = 0x04,       // Indicate Supervision encapsulation
                };

                Msg(string const& _logtext, uint8 _targetNodeId, uint8 const _msgType, uint8 const _function, bool const _bCallbackRequired, bool const _bReplyRequired = true, uint8 const _expectedReply = 0, uint8 const _expectedCommandClassId = 0);
                ~Msg()
                {
                }

                void SetInstance(OpenZWave::Internal::CC::CommandClass * _cc, uint8 const _instance);   // Used to enable wrapping with MultiInstance/MultiChannel during finalize.
                void SetSupervision(uint8 _session_id);

                void Append(uint8 const _data);
                void AppendArray(const uint8* const _data, const uint8 _length);
                void Finalize();
                void UpdateCallbackId();

                uint8 GetTargetNodeId() const
                {
                    return m_targetNodeId;
                }

                uint8 GetCallbackId() const
                {
                    return m_callbackId;
                }

                uint8 GetExpectedReply() const
                {
                    return m_expectedReply;
                }

                uint8 GetExpectedCommandClassId() const
                {
                    return m_expectedCommandClassId;
                }

                uint8 GetExpectedInstance() const
                {
                    return m_instance;
                }

//      uint8 GetExpectedIndex()const{ return m_expectedIndex; }
                string GetLogText() const
                {
                    return m_logText;
                }

                uint32 GetLength() const
                {
                    return m_encrypted == true ? m_length + 20 + 6 : m_length;
                }
                uint8* GetBuffer();
                string GetAsString();

                uint8 GetSendAttempts() const
                {
                    return m_sendAttempts;
                }
                void SetSendAttempts(uint8 _count)
                {
                    m_sendAttempts = _count;
                }

                uint8 GetMaxSendAttempts() const
                {
                    return m_maxSendAttempts;
                }
                void SetMaxSendAttempts(uint8 _count)
                {
                    if (_count < MAX_MAX_TRIES)
                        m_maxSendAttempts = _count;
                }

                bool IsWakeUpNoMoreInformationCommand()
                {
                    return (m_bFinal && (m_length == 11) && (m_buffer[3] == 0x13) && (m_buffer[6] == 0x84) && (m_buffer[7] == 0x08));
                }
                bool IsNoOperation()
                {
                    return (m_bFinal && (m_length == 11) && (m_buffer[3] == 0x13) && (m_buffer[6] == 0x00) && (m_buffer[7] == 0x00));
                }

                bool operator ==(Msg const& _other) const
                {
                    if (m_bFinal && _other.m_bFinal)
                    {
                        // Do not include the callback Id or checksum in the comparison.
                        uint8 length = m_length - (m_bCallbackRequired ? 2 : 1);
                        return (!memcmp(m_buffer, _other.m_buffer, length));
                    }

                    return false;
                }
                uint8 GetSendingCommandClass()
                {
                    if (m_buffer[3] == 0x13)
                    {
                        return m_buffer[6];
                    }
                    return 0;
                }
                bool isEncrypted()
                {
                    return m_encrypted;
                }
                void setEncrypted()
                {
                    m_encrypted = true;
                }
                bool isNonceRecieved()
                {
                    return m_noncerecvd;
                }
                void setNonce(uint8 nonce[8])
                {
                    memcpy(m_nonce, nonce, 8);
                    m_noncerecvd = true;
                    UpdateCallbackId();
                }
                void clearNonce()
                {
                    memset((m_nonce), '\0', 8);
                    m_noncerecvd = false;
                }
                void SetHomeId(uint32 homeId)
                {
                    m_homeId = homeId;
                }
                void setResendDuetoCANorNAK()
                {
                    m_resendDuetoCANorNAK = true;
                }
                bool isResendDuetoCANorNAK()
                {
                    return m_resendDuetoCANorNAK;
                }

                Driver* GetDriver() const;
            private:

                void MultiEncap();                      // Encapsulate the data inside a MultiInstance/Multicommand message
                void SupervisionEncap();                // Encapsulate the data inside a Supervision message
                string m_logText;
                bool m_bFinal;
                bool m_bCallbackRequired;

                uint8 m_callbackId;
                uint8 m_expectedReply;
                uint8 m_expectedCommandClassId;
                uint8 m_length;
                uint8 m_buffer[256];
                uint8 e_buffer[256];

                uint8 m_targetNodeId;
                uint8 m_sendAttempts;
                uint8 m_maxSendAttempts;

                uint8 m_instance;
                uint8 m_endPoint;               // Endpoint to use if the message must be wrapped in a multiInstance or multiChannel command class
                uint8 m_flags;
                uint8 m_supervision_session_id;

                bool m_encrypted;
                bool m_noncerecvd;
                uint8 m_nonce[8];
                uint32 m_homeId;
                static uint8 s_nextCallbackId;      // counter to get a unique callback id
                /* we are resending this message due to CAN or NAK messages */
                bool m_resendDuetoCANorNAK;
        };
    } // namespace Internal
} // namespace OpenZWave

#endif //_Msg_H