OpenZWave Library  1.5.0
Msg.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Msg.h
4 //
5 // Represents a Z-Wave message
6 //
7 // Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
8 //
9 // SOFTWARE NOTICE AND LICENSE
10 //
11 // This file is part of OpenZWave.
12 //
13 // OpenZWave is free software: you can redistribute it and/or modify
14 // it under the terms of the GNU Lesser General Public License as published
15 // by the Free Software Foundation, either version 3 of the License,
16 // or (at your option) any later version.
17 //
18 // OpenZWave is distributed in the hope that it will be useful,
19 // but WITHOUT ANY WARRANTY; without even the implied warranty of
20 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 // GNU Lesser General Public License for more details.
22 //
23 // You should have received a copy of the GNU Lesser General Public License
24 // along with OpenZWave. If not, see <http://www.gnu.org/licenses/>.
25 //
26 //-----------------------------------------------------------------------------
27 
28 #ifndef _Msg_H
29 #define _Msg_H
30 
31 #include <cstdio>
32 #include <string>
33 #include <string.h>
34 #include "Defs.h"
35 //#include "Driver.h"
36 
37 namespace OpenZWave
38 {
39  class CommandClass;
40  class Driver;
41 
45  {
46  public:
48  {
49  m_MultiChannel = 0x01, // Indicate MultiChannel encapsulation
50  m_MultiInstance = 0x02, // Indicate MultiInstance encapsulation
51  };
52 
53  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 );
54  ~Msg(){}
55 
56  void SetInstance( CommandClass* _cc, uint8 const _instance ); // Used to enable wrapping with MultiInstance/MultiChannel during finalize.
57 
58  void Append( uint8 const _data );
59  void AppendArray( const uint8* const _data, const uint8 _length );
60  void Finalize();
61  void UpdateCallbackId();
62 
67  uint8 GetTargetNodeId()const{ return m_targetNodeId; }
68 
74  uint8 GetCallbackId()const{ return m_callbackId; }
75 
84  uint8 GetExpectedReply()const{ return m_expectedReply; }
85 
90  uint8 GetExpectedCommandClassId()const{ return m_expectedCommandClassId; }
91 
97  uint8 GetExpectedInstance()const{ return m_instance; }
98 
104 // uint8 GetExpectedIndex()const{ return m_expectedIndex; }
109  string GetLogText()const{ return m_logText; }
110 
111  uint32 GetLength()const{ return m_encrypted == true ? m_length + 20 + 6 : m_length; }
112  uint8* GetBuffer();
113  string GetAsString();
114 
115  uint8 GetSendAttempts()const{ return m_sendAttempts; }
116  void SetSendAttempts( uint8 _count ){ m_sendAttempts = _count; }
117 
118  uint8 GetMaxSendAttempts()const{ return m_maxSendAttempts; }
119  void SetMaxSendAttempts( uint8 _count ){ if( _count < MAX_MAX_TRIES ) m_maxSendAttempts = _count; }
120 
122  {
123  return( m_bFinal && (m_length==11) && (m_buffer[3]==0x13) && (m_buffer[6]==0x84) && (m_buffer[7]==0x08) );
124  }
126  {
127  return( m_bFinal && (m_length==11) && (m_buffer[3]==0x13) && (m_buffer[6]==0x00) && (m_buffer[7]==0x00) );
128  }
129 
130  bool operator == ( Msg const& _other )const
131  {
132  if( m_bFinal && _other.m_bFinal )
133  {
134  // Do not include the callback Id or checksum in the comparison.
135  uint8 length = m_length - (m_bCallbackRequired ? 2: 1 );
136  return( !memcmp( m_buffer, _other.m_buffer, length ) );
137  }
138 
139  return false;
140  }
142  if (m_buffer[3] == 0x13) {
143  return m_buffer[6];
144  }
145  return 0;
146 
147  }
148 
149  bool isEncrypted() {
150  return m_encrypted;
151  }
152  void setEncrypted() {
153  m_encrypted = true;
154  }
156  return m_noncerecvd;
157  }
158  void setNonce(uint8 nonce[8]) {
159  memcpy(m_nonce, nonce, 8);
160  m_noncerecvd = true;
161  UpdateCallbackId();
162  }
163  void clearNonce() {
164  memset((m_nonce), '\0', 8);
165  m_noncerecvd = false;
166  }
167  void SetHomeId(uint32 homeId) { m_homeId = homeId; };
168 
172  Driver* GetDriver()const;
173  private:
174 
175 
176  void MultiEncap(); // Encapsulate the data inside a MultiInstance/Multicommand message
177 
178  string m_logText;
179  bool m_bFinal;
180  bool m_bCallbackRequired;
181 
182  uint8 m_callbackId;
183  uint8 m_expectedReply;
184  uint8 m_expectedCommandClassId;
185  uint8 m_length;
186  uint8 m_buffer[256];
187  uint8 e_buffer[256];
188 
189  uint8 m_targetNodeId;
190  uint8 m_sendAttempts;
191  uint8 m_maxSendAttempts;
192 
193  uint8 m_instance;
194  uint8 m_endPoint; // Endpoint to use if the message must be wrapped in a multiInstance or multiChannel command class
195  uint8 m_flags;
196 
197  bool m_encrypted;
198  bool m_noncerecvd;
199  uint8 m_nonce[8];
200  uint32 m_homeId;
201  static uint8 s_nextCallbackId; // counter to get a unique callback id
202  };
203 
204 } // namespace OpenZWave
205 
206 #endif //_Msg_H
207 
Message object to be passed to and from devices on the Z-Wave network.
Definition: Msg.h:44
Definition: Bitfield.h:34
uint8 GetTargetNodeId() const
Identifies the Node ID of the "target" node (if any) for this function.
Definition: Msg.h:67
#define OPENZWAVE_EXPORT
Definition: Defs.h:52
#define MAX_MAX_TRIES
Definition: Defs.h:227
void clearNonce()
Definition: Msg.h:163
bool IsWakeUpNoMoreInformationCommand()
Definition: Msg.h:121
uint8 GetExpectedInstance() const
For messages that request a Report for a specified command class, identifies the expected Instance fo...
Definition: Msg.h:97
void setEncrypted()
Definition: Msg.h:152
Base class for all Z-Wave command classes.
Definition: CommandClass.h:54
void SetHomeId(uint32 homeId)
Definition: Msg.h:167
uint8 GetMaxSendAttempts() const
Definition: Msg.h:118
uint8 GetExpectedReply() const
Identifies the expected reply type (if any) for this message. The expected reply is a function code...
Definition: Msg.h:84
bool isEncrypted()
Definition: Msg.h:149
The Driver class handles communication between OpenZWave and a device attached via a serial port (typ...
Definition: Driver.h:63
~Msg()
Definition: Msg.h:54
unsigned int uint32
Definition: Defs.h:96
uint8 GetCallbackId() const
Identifies the Callback ID (if any) for this message. Callback ID is a value (OpenZWave uses sequenti...
Definition: Msg.h:74
void setNonce(uint8 nonce[8])
Definition: Msg.h:158
bool IsNoOperation()
Definition: Msg.h:125
uint8 GetExpectedCommandClassId() const
Identifies the expected Command Class ID (if any) for this message.
Definition: Msg.h:90
uint8 GetSendingCommandClass()
Definition: Msg.h:141
string GetLogText() const
For messages that request a Report for a specified command class, identifies the expected Index for t...
Definition: Msg.h:109
void SetSendAttempts(uint8 _count)
Definition: Msg.h:116
uint32 GetLength() const
Definition: Msg.h:111
bool isNonceRecieved()
Definition: Msg.h:155
void SetMaxSendAttempts(uint8 _count)
Definition: Msg.h:119
MessageFlags
Definition: Msg.h:47
uint8 GetSendAttempts() const
Definition: Msg.h:115
unsigned char uint8
Definition: Defs.h:90