AWS IoT Over-the-air Update v3.3.0
Client library for AWS IoT OTA
ota_cbor_private.h
Go to the documentation of this file.
1/*
2 * AWS IoT Over-the-air Update v3.3.0
3 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9 * the Software, and to permit persons to whom the Software is furnished to do so,
10 * subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 */
22
28#ifndef OTA_CBOR_H
29#define OTA_CBOR_H
30
31/* *INDENT-OFF* */
32#ifdef __cplusplus
33 extern "C" {
34#endif
35/* *INDENT-ON* */
36
42#define OTA_CBOR_CLIENTTOKEN_KEY "c"
43#define OTA_CBOR_FILEID_KEY "f"
44#define OTA_CBOR_BLOCKSIZE_KEY "l"
45#define OTA_CBOR_BLOCKOFFSET_KEY "o"
46#define OTA_CBOR_BLOCKBITMAP_KEY "b"
47#define OTA_CBOR_STREAMDESCRIPTION_KEY "d"
48#define OTA_CBOR_STREAMFILES_KEY "r"
49#define OTA_CBOR_FILESIZE_KEY "z"
50#define OTA_CBOR_BLOCKID_KEY "i"
51#define OTA_CBOR_BLOCKPAYLOAD_KEY "p"
52#define OTA_CBOR_NUMBEROFBLOCKS_KEY "n"
57bool OTA_CBOR_Decode_GetStreamResponseMessage( const uint8_t * pMessageBuffer,
58 size_t messageSize,
59 int32_t * pFileId,
60 int32_t * pBlockId,
61 int32_t * pBlockSize,
62 uint8_t ** pPayload,
63 size_t * pPayloadSize );
64
70bool OTA_CBOR_Encode_GetStreamRequestMessage( uint8_t * pMessageBuffer,
71 size_t messageBufferSize,
72 size_t * pEncodedMessageSize,
73 const char * pClientToken,
74 int32_t fileId,
75 int32_t blockSize,
76 int32_t blockOffset,
77 uint8_t * pBlockBitmap,
78 size_t blockBitmapSize,
79 int32_t numOfBlocksRequested );
80
81/* *INDENT-OFF* */
82#ifdef __cplusplus
83 }
84#endif
85/* *INDENT-ON* */
86
87#endif /* ifndef OTA_CBOR_H */
bool OTA_CBOR_Decode_GetStreamResponseMessage(const uint8_t *pMessageBuffer, size_t messageSize, int32_t *pFileId, int32_t *pBlockId, int32_t *pBlockSize, uint8_t **pPayload, size_t *pPayloadSize)
Decode a Get Stream response message from AWS IoT OTA.
Definition: ota_cbor.c:74
bool OTA_CBOR_Encode_GetStreamRequestMessage(uint8_t *pMessageBuffer, size_t messageBufferSize, size_t *pEncodedMessageSize, const char *pClientToken, int32_t fileId, int32_t blockSize, int32_t blockOffset, uint8_t *pBlockBitmap, size_t blockBitmapSize, int32_t numOfBlocksRequested)
Create an encoded Get Stream Request message for the AWS IoT OTA service. The service allows block co...
Definition: ota_cbor.c:236