Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: 5_Dragonfly_Cayenne_Sprint_IKS01A1
Fork of
Cayenne-MQTT-mbed-MTSAS
by 
Peter Ferland
MessageData Struct Reference
Cayenne message data passed to message handler functions. More...
#include <CayenneMQTTClient.h>
Public Member Functions | |
| const char * | getValue (size_t index=0) const |
| Get value at specified index. | |
| const char * | getUnit (size_t index=0) const |
| Get unit at specified index. | |
Data Fields | |
| const char * | clientID |
| The client ID of the message. | |
| CayenneTopic | topic |
| The topic the message was received on. | |
| unsigned int | channel |
| The channel the message was received on. | |
| const char * | id |
| The message ID, if it is a command message, otherwise NULL. | |
| const char * | type |
| The type of data in the message, if it exists, otherwise NULL. | |
| CayenneValuePair | values [CAYENNE_MAX_MESSAGE_VALUES] |
| The unit/value data pairs in the message. | |
| size_t | valueCount |
| The count of items in the values array. | |
Detailed Description
Cayenne message data passed to message handler functions.
Definition at line 32 of file CayenneMQTTClient.h.
Member Function Documentation
| const char* getUnit | ( | size_t | index = 0 ) |
const |
Get unit at specified index.
- Parameters:
-
[in] index Index of unit to retrieve, if none is specified it gets the first unit.
- Returns:
- Unit at the specified index, can be NULL.
Definition at line 54 of file CayenneMQTTClient.h.
| const char* getValue | ( | size_t | index = 0 ) |
const |
Get value at specified index.
- Parameters:
-
[in] index Index of value to retrieve, if none is specified it gets the first value.
- Returns:
- Value at the specified index, can be NULL.
Definition at line 47 of file CayenneMQTTClient.h.
Field Documentation
| unsigned int channel |
The channel the message was received on.
Definition at line 36 of file CayenneMQTTClient.h.
| const char* clientID |
The client ID of the message.
Definition at line 34 of file CayenneMQTTClient.h.
| const char* id |
The message ID, if it is a command message, otherwise NULL.
Definition at line 37 of file CayenneMQTTClient.h.
| CayenneTopic topic |
The topic the message was received on.
Definition at line 35 of file CayenneMQTTClient.h.
| const char* type |
The type of data in the message, if it exists, otherwise NULL.
Definition at line 38 of file CayenneMQTTClient.h.
| size_t valueCount |
The count of items in the values array.
Definition at line 40 of file CayenneMQTTClient.h.
| CayenneValuePair values[CAYENNE_MAX_MESSAGE_VALUES] |
The unit/value data pairs in the message.
The units and values can be NULL.
Definition at line 39 of file CayenneMQTTClient.h.
Generated on Wed Jul 13 2022 08:52:00 by
1.7.2