![]() |
OpenZWave Library 1.6.0
|
Message object to be passed to and from devices on the Z-Wave network. More...
#include <Msg.h>
Public Types | |
| enum | MessageFlags { m_MultiChannel = 0x01 , m_MultiInstance = 0x02 } |
Public Member Functions | |
| 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 (CommandClass *_cc, uint8 const _instance) |
| void | Append (uint8 const _data) |
| void | AppendArray (const uint8 *const _data, const uint8 _length) |
| void | Finalize () |
| void | UpdateCallbackId () |
| uint8 | GetTargetNodeId () const |
| Identifies the Node ID of the "target" node (if any) for this function. | |
| uint8 | GetCallbackId () const |
| Identifies the Callback ID (if any) for this message. Callback ID is a value (OpenZWave uses sequential IDs) that helps the application associate message responses with the original message request. | |
| uint8 | GetExpectedReply () const |
| Identifies the expected reply type (if any) for this message. The expected reply is a function code...one of the FUNC_ID... values defined in Defs.h. Many Z-Wave functions generate responses with the same function code (for example, a FUNC_ID_ZW_GET_VERSION message generates a FUNC_ID_ZW_GET_VERSION response. But other functions generate a different response. FUNC_ID_ZW_SEND_DATA triggers several responses, but ultimately, a "Get" sent with this function should result in a FUNC_ID_APPLICATION_COMMAND_HANDLER response. | |
| uint8 | GetExpectedCommandClassId () const |
| Identifies the expected Command Class ID (if any) for this message. | |
| uint8 | GetExpectedInstance () const |
| For messages that request a Report for a specified command class, identifies the expected Instance for the variable being obtained in the report. | |
| string | GetLogText () const |
| For messages that request a Report for a specified command class, identifies the expected Index for the variable being obtained in the report. | |
| uint32 | GetLength () const |
| uint8 * | GetBuffer () |
| string | GetAsString () |
| uint8 | GetSendAttempts () const |
| void | SetSendAttempts (uint8 _count) |
| uint8 | GetMaxSendAttempts () const |
| void | SetMaxSendAttempts (uint8 _count) |
| bool | IsWakeUpNoMoreInformationCommand () |
| bool | IsNoOperation () |
| bool | operator== (Msg const &_other) const |
| uint8 | GetSendingCommandClass () |
| bool | isEncrypted () |
| void | setEncrypted () |
| bool | isNonceRecieved () |
| void | setNonce (uint8 nonce[8]) |
| void | clearNonce () |
| void | SetHomeId (uint32 homeId) |
| Driver * | GetDriver () const |
Message object to be passed to and from devices on the Z-Wave network.
| Msg::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 ) |
|
inline |
| void Msg::Append | ( | uint8 const | _data | ) |
|
inline |
| void Msg::Finalize | ( | ) |
| string Msg::GetAsString | ( | ) |
| uint8 * Msg::GetBuffer | ( | ) |
|
inline |
Identifies the Callback ID (if any) for this message. Callback ID is a value (OpenZWave uses sequential IDs) that helps the application associate message responses with the original message request.
| Driver * Msg::GetDriver | ( | ) | const |
Returns a pointer to the driver (interface with a Z-Wave controller) associated with this node.
|
inline |
Identifies the expected Command Class ID (if any) for this message.
|
inline |
For messages that request a Report for a specified command class, identifies the expected Instance for the variable being obtained in the report.
|
inline |
Identifies the expected reply type (if any) for this message. The expected reply is a function code...one of the FUNC_ID... values defined in Defs.h. Many Z-Wave functions generate responses with the same function code (for example, a FUNC_ID_ZW_GET_VERSION message generates a FUNC_ID_ZW_GET_VERSION response. But other functions generate a different response. FUNC_ID_ZW_SEND_DATA triggers several responses, but ultimately, a "Get" sent with this function should result in a FUNC_ID_APPLICATION_COMMAND_HANDLER response.
|
inline |
|
inline |
For messages that request a Report for a specified command class, identifies the expected Index for the variable being obtained in the report.
get the LogText Associated with this message
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
| void Msg::SetInstance | ( | CommandClass * | _cc, |
| uint8 const | _instance ) |
|
inline |
|
inline |
|
inline |
| void Msg::UpdateCallbackId | ( | ) |