AWS IoT Over-the-air Update v3.3.0
Client library for AWS IoT OTA
ota_config_defaults.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
35#ifndef OTA_CONFIG_DEFAULTS_H
36#define OTA_CONFIG_DEFAULTS_H
37
38/* *INDENT-OFF* */
39#ifdef __cplusplus
40 extern "C" {
41#endif
42/* *INDENT-ON* */
43
44/* The macro definition for OTA_DO_NOT_USE_CUSTOM_CONFIG is for Doxygen
45 * documentation only. */
46
57#ifdef DOXYGEN
58 #define OTA_DO_NOT_USE_CUSTOM_CONFIG
59#endif
60
72#ifndef otaconfigSTACK_SIZE
73 #define otaconfigSTACK_SIZE "Please set otaconfigSTACK_SIZE"
74#endif
75
84#ifndef otaconfigAGENT_PRIORITY
85 #define otaconfigAGENT_PRIORITY "Please set otaconfigAGENT_PRIORITY"
86#endif
87
95#ifndef otaconfigLOG2_FILE_BLOCK_SIZE
96 #define otaconfigLOG2_FILE_BLOCK_SIZE 12UL
97#endif
98
106#ifndef otaconfigSELF_TEST_RESPONSE_WAIT_MS
107 #define otaconfigSELF_TEST_RESPONSE_WAIT_MS 16000U
108#endif
109
121#ifndef otaconfigFILE_REQUEST_WAIT_MS
122 #define otaconfigFILE_REQUEST_WAIT_MS 10000U
123#endif
124
137#ifndef otaconfigMAX_THINGNAME_LEN
138 #define otaconfigMAX_THINGNAME_LEN 64U
139#endif
140
157#ifndef otaconfigMAX_NUM_BLOCKS_REQUEST
158 #define otaconfigMAX_NUM_BLOCKS_REQUEST 1U
159#endif
160
172#ifndef otaconfigMAX_NUM_REQUEST_MOMENTUM
173 #define otaconfigMAX_NUM_REQUEST_MOMENTUM 32U
174#endif
175
186#ifndef otaconfigOTA_UPDATE_STATUS_FREQUENCY
187 #define otaconfigOTA_UPDATE_STATUS_FREQUENCY 64U
188#endif
189
199#ifndef otaconfigMAX_NUM_OTA_DATA_BUFFERS
200 #define otaconfigMAX_NUM_OTA_DATA_BUFFERS 1U
201#endif
202
212#ifndef otaconfigOTA_FILE_TYPE
213 #if defined( WIN32 ) || defined( __linux__ )
214 #define otaconfigOTA_FILE_TYPE FILE
215 #else
216 #define otaconfigOTA_FILE_TYPE uint8_t
217 #endif
218#endif
219
232#ifndef otaconfigAllowDowngrade
233 #define otaconfigAllowDowngrade 0U
234#endif
235
245#ifndef configOTA_FIRMWARE_UPDATE_FILE_TYPE_ID
246 #define configOTA_FIRMWARE_UPDATE_FILE_TYPE_ID 0U
247#endif
248
260#ifndef configENABLED_CONTROL_PROTOCOL
261 #define configENABLED_CONTROL_PROTOCOL ( OTA_CONTROL_OVER_MQTT )
262#endif
263
276#ifndef configENABLED_DATA_PROTOCOLS
277 #define configENABLED_DATA_PROTOCOLS ( OTA_DATA_OVER_MQTT )
278#endif
279
291#ifndef configOTA_PRIMARY_DATA_PROTOCOL
292 #define configOTA_PRIMARY_DATA_PROTOCOL ( OTA_DATA_OVER_MQTT )
293#endif
294
312#ifndef LogError
313 #define LogError( message )
314#endif
315
333#ifndef LogWarn
334 #define LogWarn( message )
335#endif
336
354#ifndef LogInfo
355 #define LogInfo( message )
356#endif
357
375#ifndef LogDebug
376 #define LogDebug( message )
377#endif
378
379/* *INDENT-OFF* */
380#ifdef __cplusplus
381 }
382#endif
383/* *INDENT-ON* */
384
385#endif /* ifndef OTA_CONFIG_DEFAULTS_H */