aws_shadow.h

Go to the documentation of this file.

/*
 * FreeRTOS
 * Copyright (C) 2017 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 _AWS_SHADOW_H_
#define _AWS_SHADOW_H_

#include "FreeRTOS.h"

#include "aws_mqtt_agent.h"


typedef void * ShadowClientHandle_t;

#define eShadowJSMNPart     ( -3 )
#define eShadowJSMNInval    ( -2 )
#define eShadowJSMNNoMem    ( -1 )

#define eShadowSuccess      ( 0 )

#define eShadowTimeout      ( 1 )

#define eShadowFailure      ( 2 )

#define eShadowUnknown      ( 3 )

#define eShadowRejectedBadRequest              ( 400 )
#define eShadowRejectedUnauthorized            ( 401 )
#define eShadowRejectedForbidden               ( 403 )
#define eShadowRejectedNotFound                ( 404 )
#define eShadowRejectedConflict                ( 409 )
#define eShadowRejectedPayloadTooLarge         ( 413 )
#define eShadowRejectedUnsupportedMediaType    ( 415 )
#define eShadowRejectedTooManyRequests         ( 429 )
#define eShadowRejectedInternalServerError     ( 500 )
typedef int16_t ShadowReturnCode_t;
typedef enum ShadowMQTTClientType
{
    eSharedMQTTClient,
    eDedicatedMQTTClient
} ShadowMQTTClientType_t;

typedef struct ShadowCreateParams
{
    ShadowMQTTClientType_t xMQTTClientType;

    MQTTAgentHandle_t xMQTTClientHandle;
} ShadowCreateParams_t;

typedef struct ShadowOperationParams
{
    const char * pcThingName;

    const char * pcData;

    uint32_t ulDataLength;

    MQTTBufferHandle_t xBuffer;

    uint8_t ucKeepSubscriptions;

    MQTTQoS_t xQoS;
} ShadowOperationParams_t;

typedef BaseType_t ( * ShadowUpdatedCallback_t )( void * pvUserData,
                                                  const char * const pcThingName,
                                                  const char * const pcUpdateDocument,
                                                  uint32_t ulDocumentLength,
                                                  MQTTBufferHandle_t xBuffer );

typedef void ( * ShadowDeletedCallback_t )( void * pvUserData,
                                            const char * const pcThingName );

typedef BaseType_t ( * ShadowDeltaCallback_t )( void * pvUserData,
                                                const char * const pcThingName,
                                                const char * const pcDeltaDocument,
                                                uint32_t ulDocumentLength,
                                                MQTTBufferHandle_t xBuffer );

typedef struct ShadowCallbackParams
{
    const char * pcThingName;

    ShadowUpdatedCallback_t xShadowUpdatedCallback;

    ShadowDeletedCallback_t xShadowDeletedCallback;

    ShadowDeltaCallback_t xShadowDeltaCallback;
} ShadowCallbackParams_t;

ShadowReturnCode_t SHADOW_ClientCreate( ShadowClientHandle_t * pxShadowClientHandle,
                                        const ShadowCreateParams_t * const pxShadowCreateParams );

ShadowReturnCode_t SHADOW_ClientConnect( ShadowClientHandle_t xShadowClientHandle,
                                         MQTTAgentConnectParams_t * const pxConnectParams,
                                         TickType_t xTimeoutTicks );

ShadowReturnCode_t SHADOW_ClientDisconnect( ShadowClientHandle_t xShadowClientHandle );

ShadowReturnCode_t SHADOW_ClientDelete( ShadowClientHandle_t xShadowClientHandle );

ShadowReturnCode_t SHADOW_Update( ShadowClientHandle_t xShadowClientHandle,
                                  ShadowOperationParams_t * const pxUpdateParams,
                                  TickType_t xTimeoutTicks );

ShadowReturnCode_t SHADOW_Get( ShadowClientHandle_t xShadowClientHandle,
                               ShadowOperationParams_t * const pxGetParams,
                               TickType_t xTimeoutTicks );

ShadowReturnCode_t SHADOW_Delete( ShadowClientHandle_t xShadowClientHandle,
                                  ShadowOperationParams_t * const pxDeleteParams,
                                  TickType_t xTimeoutTicks );

ShadowReturnCode_t SHADOW_RegisterCallbacks( ShadowClientHandle_t xShadowClientHandle,
                                             ShadowCallbackParams_t * const pxCallbackParams,
                                             TickType_t xTimeoutTicks );

ShadowReturnCode_t SHADOW_ReturnMQTTBuffer( ShadowClientHandle_t xShadowClientHandle,
                                            MQTTBufferHandle_t xBufferHandle );

#endif /* _AWS_SHADOW_H_ */