The Cayenne MQTT mbed Library provides functions to easily connect to the Cayenne IoT project builder.
Dependents: Cayenne-ESP8266Interface Cayenne-WIZnet_Library Cayenne-WIZnetInterface Cayenne-X-NUCLEO-IDW01M1 ... more
MessageData Struct Reference
Cayenne message data passed to message handler functions. More...
#include <CayenneMQTTClient.h>
Public Member Functions | |
const char * | getValue () const |
Get message value. | |
const char * | getUnit () const |
Get message unit. | |
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. | |
const char * | unit |
The unit of data in the message, if it exists, otherwise NULL. | |
const char * | value |
The value of data in the message, if it exists, otherwise NULL. |
Detailed Description
Cayenne message data passed to message handler functions.
Definition at line 31 of file CayenneMQTTClient.h.
Member Function Documentation
const char* getUnit | ( | ) | const |
Get message unit.
- Returns:
- Message unit, can be NULL.
Definition at line 51 of file CayenneMQTTClient.h.
const char* getValue | ( | ) | const |
Get message value.
- Returns:
- Message value, can be NULL.
Definition at line 45 of file CayenneMQTTClient.h.
Field Documentation
unsigned int channel |
The channel the message was received on.
Definition at line 35 of file CayenneMQTTClient.h.
const char* clientID |
The client ID of the message.
Definition at line 33 of file CayenneMQTTClient.h.
const char* id |
The message ID, if it is a command message, otherwise NULL.
Definition at line 36 of file CayenneMQTTClient.h.
CayenneTopic topic |
The topic the message was received on.
Definition at line 34 of file CayenneMQTTClient.h.
const char* type |
The type of data in the message, if it exists, otherwise NULL.
Definition at line 37 of file CayenneMQTTClient.h.
const char* unit |
The unit of data in the message, if it exists, otherwise NULL.
Definition at line 38 of file CayenneMQTTClient.h.
const char* value |
The value of data in the message, if it exists, otherwise NULL.
Definition at line 39 of file CayenneMQTTClient.h.
Generated on Wed Jul 13 2022 15:49:29 by 1.7.2