Zoltan Hudak / Mbed OS MQTT_Hello

MQTT client to test the ENC28J60-EMAC on NUCLEO-F446RE.

Dependencies:   ENC28J60-EMAC

MQTT/MQTTPacket/MQTTConnect.h@5:d9570dbf2f82, 2021-03-29 (annotated)

Committer:
hudakz
Date:
Mon Mar 29 09:32:44 2021 +0000
Revision:
5:d9570dbf2f82
Parent:
0:238f0d0c0ba3 
MQTT client to test the ENC28J60-EMAC on NUCLEO-F446RE.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hudakz 0:238f0d0c0ba3 1 /*******************************************************************************
hudakz 0:238f0d0c0ba3 2 * Copyright (c) 2014, 2017 IBM Corp.
hudakz 0:238f0d0c0ba3 3 *
hudakz 0:238f0d0c0ba3 4 * All rights reserved. This program and the accompanying materials
hudakz 0:238f0d0c0ba3 5 * are made available under the terms of the Eclipse Public License v1.0
hudakz 0:238f0d0c0ba3 6 * and Eclipse Distribution License v1.0 which accompany this distribution.
hudakz 0:238f0d0c0ba3 7 *
hudakz 0:238f0d0c0ba3 8 * The Eclipse Public License is available at
hudakz 0:238f0d0c0ba3 9 * http://www.eclipse.org/legal/epl-v10.html
hudakz 0:238f0d0c0ba3 10 * and the Eclipse Distribution License is available at
hudakz 0:238f0d0c0ba3 11 * http://www.eclipse.org/org/documents/edl-v10.php.
hudakz 0:238f0d0c0ba3 12 *
hudakz 0:238f0d0c0ba3 13 * Contributors:
hudakz 0:238f0d0c0ba3 14 * Ian Craggs - initial API and implementation and/or initial documentation
hudakz 0:238f0d0c0ba3 15 * Ian Craggs - add connack return code definitions
hudakz 0:238f0d0c0ba3 16 * Xiang Rong - 442039 Add makefile to Embedded C client
hudakz 0:238f0d0c0ba3 17 * Ian Craggs - fix for issue #64, bit order in connack response
hudakz 0:238f0d0c0ba3 18 *******************************************************************************/
hudakz 0:238f0d0c0ba3 19
hudakz 0:238f0d0c0ba3 20 #ifndef MQTTCONNECT_H_
hudakz 0:238f0d0c0ba3 21 #define MQTTCONNECT_H_
hudakz 0:238f0d0c0ba3 22
hudakz 0:238f0d0c0ba3 23 enum connack_return_codes
hudakz 0:238f0d0c0ba3 24 {
hudakz 0:238f0d0c0ba3 25 MQTT_CONNECTION_ACCEPTED = 0,
hudakz 0:238f0d0c0ba3 26 MQTT_UNNACCEPTABLE_PROTOCOL = 1,
hudakz 0:238f0d0c0ba3 27 MQTT_CLIENTID_REJECTED = 2,
hudakz 0:238f0d0c0ba3 28 MQTT_SERVER_UNAVAILABLE = 3,
hudakz 0:238f0d0c0ba3 29 MQTT_BAD_USERNAME_OR_PASSWORD = 4,
hudakz 0:238f0d0c0ba3 30 MQTT_NOT_AUTHORIZED = 5,
hudakz 0:238f0d0c0ba3 31 };
hudakz 0:238f0d0c0ba3 32
hudakz 0:238f0d0c0ba3 33 #if !defined(DLLImport)
hudakz 0:238f0d0c0ba3 34 #define DLLImport
hudakz 0:238f0d0c0ba3 35 #endif
hudakz 0:238f0d0c0ba3 36 #if !defined(DLLExport)
hudakz 0:238f0d0c0ba3 37 #define DLLExport
hudakz 0:238f0d0c0ba3 38 #endif
hudakz 0:238f0d0c0ba3 39
hudakz 0:238f0d0c0ba3 40
hudakz 0:238f0d0c0ba3 41 typedef union
hudakz 0:238f0d0c0ba3 42 {
hudakz 0:238f0d0c0ba3 43 unsigned char all; /**< all connect flags */
hudakz 0:238f0d0c0ba3 44 #if defined(REVERSED)
hudakz 0:238f0d0c0ba3 45 struct
hudakz 0:238f0d0c0ba3 46 {
hudakz 0:238f0d0c0ba3 47 unsigned int username : 1; /**< 3.1 user name */
hudakz 0:238f0d0c0ba3 48 unsigned int password : 1; /**< 3.1 password */
hudakz 0:238f0d0c0ba3 49 unsigned int willRetain : 1; /**< will retain setting */
hudakz 0:238f0d0c0ba3 50 unsigned int willQoS : 2; /**< will QoS value */
hudakz 0:238f0d0c0ba3 51 unsigned int will : 1; /**< will flag */
hudakz 0:238f0d0c0ba3 52 unsigned int cleansession : 1; /**< clean session flag */
hudakz 0:238f0d0c0ba3 53 unsigned int : 1; /**< unused */
hudakz 0:238f0d0c0ba3 54 } bits;
hudakz 0:238f0d0c0ba3 55 #else
hudakz 0:238f0d0c0ba3 56 struct
hudakz 0:238f0d0c0ba3 57 {
hudakz 0:238f0d0c0ba3 58 unsigned int : 1; /**< unused */
hudakz 0:238f0d0c0ba3 59 unsigned int cleansession : 1; /**< cleansession flag */
hudakz 0:238f0d0c0ba3 60 unsigned int will : 1; /**< will flag */
hudakz 0:238f0d0c0ba3 61 unsigned int willQoS : 2; /**< will QoS value */
hudakz 0:238f0d0c0ba3 62 unsigned int willRetain : 1; /**< will retain setting */
hudakz 0:238f0d0c0ba3 63 unsigned int password : 1; /**< 3.1 password */
hudakz 0:238f0d0c0ba3 64 unsigned int username : 1; /**< 3.1 user name */
hudakz 0:238f0d0c0ba3 65 } bits;
hudakz 0:238f0d0c0ba3 66 #endif
hudakz 0:238f0d0c0ba3 67 } MQTTConnectFlags; /**< connect flags byte */
hudakz 0:238f0d0c0ba3 68
hudakz 0:238f0d0c0ba3 69
hudakz 0:238f0d0c0ba3 70
hudakz 0:238f0d0c0ba3 71 /**
hudakz 0:238f0d0c0ba3 72 * Defines the MQTT "Last Will and Testament" (LWT) settings for
hudakz 0:238f0d0c0ba3 73 * the connect packet.
hudakz 0:238f0d0c0ba3 74 */
hudakz 0:238f0d0c0ba3 75 typedef struct
hudakz 0:238f0d0c0ba3 76 {
hudakz 0:238f0d0c0ba3 77 /** The eyecatcher for this structure. must be MQTW. */
hudakz 0:238f0d0c0ba3 78 char struct_id[4];
hudakz 0:238f0d0c0ba3 79 /** The version number of this structure. Must be 0 */
hudakz 0:238f0d0c0ba3 80 int struct_version;
hudakz 0:238f0d0c0ba3 81 /** The LWT topic to which the LWT message will be published. */
hudakz 0:238f0d0c0ba3 82 MQTTString topicName;
hudakz 0:238f0d0c0ba3 83 /** The LWT payload. */
hudakz 0:238f0d0c0ba3 84 MQTTString message;
hudakz 0:238f0d0c0ba3 85 /**
hudakz 0:238f0d0c0ba3 86 * The retained flag for the LWT message (see MQTTAsync_message.retained).
hudakz 0:238f0d0c0ba3 87 */
hudakz 0:238f0d0c0ba3 88 unsigned char retained;
hudakz 0:238f0d0c0ba3 89 /**
hudakz 0:238f0d0c0ba3 90 * The quality of service setting for the LWT message (see
hudakz 0:238f0d0c0ba3 91 * MQTTAsync_message.qos and @ref qos).
hudakz 0:238f0d0c0ba3 92 */
hudakz 0:238f0d0c0ba3 93 char qos;
hudakz 0:238f0d0c0ba3 94 } MQTTPacket_willOptions;
hudakz 0:238f0d0c0ba3 95
hudakz 0:238f0d0c0ba3 96
hudakz 0:238f0d0c0ba3 97 #define MQTTPacket_willOptions_initializer { {'M', 'Q', 'T', 'W'}, 0, {NULL, {0, NULL}}, {NULL, {0, NULL}}, 0, 0 }
hudakz 0:238f0d0c0ba3 98
hudakz 0:238f0d0c0ba3 99
hudakz 0:238f0d0c0ba3 100 typedef struct
hudakz 0:238f0d0c0ba3 101 {
hudakz 0:238f0d0c0ba3 102 /** The eyecatcher for this structure. must be MQTC. */
hudakz 0:238f0d0c0ba3 103 char struct_id[4];
hudakz 0:238f0d0c0ba3 104 /** The version number of this structure. Must be 0 */
hudakz 0:238f0d0c0ba3 105 int struct_version;
hudakz 0:238f0d0c0ba3 106 /** Version of MQTT to be used. 3 = 3.1 4 = 3.1.1
hudakz 0:238f0d0c0ba3 107 */
hudakz 0:238f0d0c0ba3 108 unsigned char MQTTVersion;
hudakz 0:238f0d0c0ba3 109 MQTTString clientID;
hudakz 0:238f0d0c0ba3 110 unsigned short keepAliveInterval;
hudakz 0:238f0d0c0ba3 111 unsigned char cleansession;
hudakz 0:238f0d0c0ba3 112 unsigned char willFlag;
hudakz 0:238f0d0c0ba3 113 MQTTPacket_willOptions will;
hudakz 0:238f0d0c0ba3 114 MQTTString username;
hudakz 0:238f0d0c0ba3 115 MQTTString password;
hudakz 0:238f0d0c0ba3 116 } MQTTPacket_connectData;
hudakz 0:238f0d0c0ba3 117
hudakz 0:238f0d0c0ba3 118 typedef union
hudakz 0:238f0d0c0ba3 119 {
hudakz 0:238f0d0c0ba3 120 unsigned char all; /**< all connack flags */
hudakz 0:238f0d0c0ba3 121 #if defined(REVERSED)
hudakz 0:238f0d0c0ba3 122 struct
hudakz 0:238f0d0c0ba3 123 {
hudakz 0:238f0d0c0ba3 124 unsigned int reserved : 7; /**< unused */
hudakz 0:238f0d0c0ba3 125 unsigned int sessionpresent : 1; /**< session present flag */
hudakz 0:238f0d0c0ba3 126 } bits;
hudakz 0:238f0d0c0ba3 127 #else
hudakz 0:238f0d0c0ba3 128 struct
hudakz 0:238f0d0c0ba3 129 {
hudakz 0:238f0d0c0ba3 130 unsigned int sessionpresent : 1; /**< session present flag */
hudakz 0:238f0d0c0ba3 131 unsigned int reserved: 7; /**< unused */
hudakz 0:238f0d0c0ba3 132 } bits;
hudakz 0:238f0d0c0ba3 133 #endif
hudakz 0:238f0d0c0ba3 134 } MQTTConnackFlags; /**< connack flags byte */
hudakz 0:238f0d0c0ba3 135
hudakz 0:238f0d0c0ba3 136 #define MQTTPacket_connectData_initializer { {'M', 'Q', 'T', 'C'}, 0, 4, {NULL, {0, NULL}}, 60, 1, 0, \
hudakz 0:238f0d0c0ba3 137 MQTTPacket_willOptions_initializer, {NULL, {0, NULL}}, {NULL, {0, NULL}} }
hudakz 0:238f0d0c0ba3 138
hudakz 0:238f0d0c0ba3 139 DLLExport int MQTTSerialize_connect(unsigned char* buf, int buflen, MQTTPacket_connectData* options);
hudakz 0:238f0d0c0ba3 140 DLLExport int MQTTDeserialize_connect(MQTTPacket_connectData* data, unsigned char* buf, int len);
hudakz 0:238f0d0c0ba3 141
hudakz 0:238f0d0c0ba3 142 DLLExport int MQTTSerialize_connack(unsigned char* buf, int buflen, unsigned char connack_rc, unsigned char sessionPresent);
hudakz 0:238f0d0c0ba3 143 DLLExport int MQTTDeserialize_connack(unsigned char* sessionPresent, unsigned char* connack_rc, unsigned char* buf, int buflen);
hudakz 0:238f0d0c0ba3 144
hudakz 0:238f0d0c0ba3 145 DLLExport int MQTTSerialize_disconnect(unsigned char* buf, int buflen);
hudakz 0:238f0d0c0ba3 146 DLLExport int MQTTSerialize_pingreq(unsigned char* buf, int buflen);
hudakz 0:238f0d0c0ba3 147
hudakz 0:238f0d0c0ba3 148 #endif /* MQTTCONNECT_H_ */
hudakz 0:238f0d0c0ba3 149