iot_ble_mqtt_serialize.h

Go to the documentation of this file.

/*
 * FreeRTOS BLE V2.2.0
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */


#ifndef IOT_BLE_MQTT_SERIALIZE_H
#define IOT_BLE_MQTT_SERIALIZE_H

/* bool is defined in only C99+. */
#if defined( __cplusplus ) || ( defined( __STDC_VERSION__ ) && ( __STDC_VERSION__ >= 199901L ) )
    #include <stdbool.h>
#elif !defined( bool ) && !defined( false ) && !defined( true )
    #define bool     int8_t
    #define false    ( int8_t ) 0
    #define true     ( int8_t ) 1
#endif

#define IOT_BLE_MQTT_MSG_TYPE         "w"
#define IOT_BLE_MQTT_CLIENT_ID        "d"
#define IOT_BLE_MQTT_BROKER_EP        "a"
#define IOT_BLE_MQTT_CLEAN_SESSION    "c"
#define IOT_BLE_MQTT_TOPIC            "u"
#define IOT_BLE_MQTT_TOPIC_LIST       "v"
#define IOT_BLE_MQTT_QOS              "n"
#define IOT_BLE_MQTT_QOS_LIST         "o"
#define IOT_BLE_MQTT_MESSAGE_ID       "i"
#define IOT_BLE_MQTT_PAYLOAD          "k"
#define IOT_BLE_MQTT_STATUS           "s"

#define IOT_BLE_MQTT_MSG_TYPE_CONNECT        ( 1 )
#define IOT_BLE_MQTT_MSG_TYPE_CONNACK        ( 2 )
#define IOT_BLE_MQTT_MSG_TYPE_PUBLISH        ( 3 )
#define IOT_BLE_MQTT_MSG_TYPE_PUBACK         ( 4 )
#define IOT_BLE_MQTT_MSG_TYPE_PUBREC         ( 5 )
#define IOT_BLE_MQTT_MSG_TYPE_PUBREL         ( 6 )
#define IOT_BLE_MQTT_MSG_TYPE_PUBCOMP        ( 7 )
#define IOT_BLE_MQTT_MSG_TYPE_SUBSCRIBE      ( 8 )
#define IOT_BLE_MQTT_MSG_TYPE_SUBACK         ( 9 )
#define IOT_BLE_MQTT_MSG_TYPE_UNSUBSCRIBE    ( 10 )
#define IOT_BLE_MQTT_MSG_TYPE_UNSUBACK       ( 11 )
#define IOT_BLE_MQTT_MSG_TYPE_PINGREQ        ( 12 )
#define IOT_BLE_MQTT_MSG_TYPE_PINGRESP       ( 13 )
#define IOT_BLE_MQTT_MSG_TYPE_DISCONNECT     ( 14 )
#define IOT_BLE_MQTT_MSG_TYPE_INVALID        ( 0xFF )

typedef enum
{
    IOT_BLE_MQTT_STATUS_UNKNOWN = 0,        
    IOT_BLE_MQTT_STATUS_CONNECTING,         
    IOT_BLE_MQTT_STATUS_CONNECTED,          
    IOT_BLE_MQTT_STATUS_DISCONNECTED,       
    IOT_BLE_MQTT_STATUS_CONNECTION_REFUSED, 
    IOT_BLE_MQTT_STATUS_CONNECTION_ERROR,   
    IOT_BLE_MQTT_STATUS_PROTOCOL_ERROR      
} MQTTBLEConnectStatus_t;
typedef enum MQTTBLEQoS
{
    MQTTBLEQoS0 = 0, 
    MQTTBLEQoS1 = 1, 
} MQTTBLEQoS_t;
typedef struct MQTTBLESubscribeInfo
{
    MQTTBLEQoS_t qos;

    const char * pTopicFilter;

    uint16_t topicFilterLength;
} MQTTBLESubscribeInfo_t;
typedef struct MQTTBLEConnectInfo
{
    bool cleanSession;

    uint16_t keepAliveSeconds;

    const char * pClientIdentifier;

    uint16_t clientIdentifierLength;

    const char * pUserName;

    uint16_t userNameLength;

    const char * pPassword;

    uint16_t passwordLength;
} MQTTBLEConnectInfo_t;
typedef struct MQTTBLEPublishInfo
{
    MQTTBLEQoS_t qos;

    bool retain;

    bool dup;

    const char * pTopicName;

    uint16_t topicNameLength;

    const void * pPayload;

    size_t payloadLength;

    bool pending;

    uint16_t packetIdentifier;
} MQTTBLEPublishInfo_t;
typedef enum MQTTBLEStatus
{
    MQTTBLESuccess = 0,  
    MQTTBLEBadParameter, 
    MQTTBLENoMemory,     
    MQTTBLEBadResponse,  
    MQTTBLEServerRefused 
} MQTTBLEStatus_t;


MQTTBLEStatus_t IotBleMqtt_SerializeConnect( const MQTTBLEConnectInfo_t * const pConnectInfo,
                                             uint8_t ** const pConnectPacket,
                                             size_t * const pPacketSize );

MQTTBLEStatus_t IotBleMqtt_DeserializeConnack( const uint8_t * pBuffer,
                                               size_t length );

MQTTBLEStatus_t IotBleMqtt_SerializePublish( const MQTTBLEPublishInfo_t * const pPublishInfo,
                                             uint8_t ** const pPublishPacket,
                                             size_t * const pPacketSize,
                                             uint16_t packetIdentifier );

void IotBleMqtt_PublishSetDup( uint8_t * const pPublishPacket,
                               uint8_t * pPacketIdentifierHigh,
                               uint16_t * const pNewPacketIdentifier );

MQTTBLEStatus_t IotBleMqtt_DeserializePublish( uint8_t * pBuffer,
                                               size_t length,
                                               MQTTBLEPublishInfo_t * publishInfo,
                                               uint16_t * packetIdentifier );

MQTTBLEStatus_t IotBleMqtt_SerializePuback( uint16_t packetIdentifier,
                                            uint8_t ** const pPubackPacket,
                                            size_t * const pPacketSize );

MQTTBLEStatus_t IotBleMqtt_DeserializePuback( uint8_t * pBuffer,
                                              size_t length,
                                              uint16_t * packetIdentifier );

MQTTBLEStatus_t IotBleMqtt_SerializeSubscribe( const MQTTBLESubscribeInfo_t * const pSubscriptionList,
                                               size_t subscriptionCount,
                                               uint8_t ** const pSubscribePacket,
                                               size_t * const pPacketSize,
                                               uint16_t * const pPacketIdentifier );

MQTTBLEStatus_t IotBleMqtt_DeserializeSuback( const uint8_t * pBuffer,
                                              size_t length,
                                              uint16_t * packetIdentifier,
                                              uint8_t * pStatusCode );

MQTTBLEStatus_t IotBleMqtt_SerializeUnsubscribe( const MQTTBLESubscribeInfo_t * const pSubscriptionList,
                                                 size_t subscriptionCount,
                                                 uint8_t ** const pUnsubscribePacket,
                                                 size_t * const pPacketSize,
                                                 uint16_t * const pPacketIdentifier );

MQTTBLEStatus_t IotBleMqtt_DeserializeUnsuback( uint8_t * pBuffer,
                                                size_t length,
                                                uint16_t * packetIdentifier );

MQTTBLEStatus_t IotBleMqtt_SerializeDisconnect( uint8_t ** const pDisconnectPacket,
                                                size_t * const pPacketSize );

MQTTBLEStatus_t IotBleMqtt_SerializePingreq( uint8_t ** const pPingreqPacket,
                                             size_t * const pPacketSize );

MQTTBLEStatus_t IotBleMqtt_DeserializePingresp( const uint8_t * pBuffer,
                                                size_t length );

uint8_t IotBleMqtt_GetPacketType( const uint8_t * pBuffer,
                                  size_t length );


void IotBleMqtt_FreePacket( uint8_t * pPacket );

#endif /* IOT_MQTT_SERIALIZE_BLE_H */