AWS IoT Over-the-air Update  v3.1.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.1.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 
215 #ifndef otaconfigAllowDowngrade
216  #define otaconfigAllowDowngrade 0U
217 #endif
218 
228 #ifndef configOTA_FIRMWARE_UPDATE_FILE_TYPE_ID
229  #define configOTA_FIRMWARE_UPDATE_FILE_TYPE_ID 0U
230 #endif
231 
243 #ifndef configENABLED_CONTROL_PROTOCOL
244  #define configENABLED_CONTROL_PROTOCOL ( OTA_CONTROL_OVER_MQTT )
245 #endif
246 
259 #ifndef configENABLED_DATA_PROTOCOLS
260  #define configENABLED_DATA_PROTOCOLS ( OTA_DATA_OVER_MQTT )
261 #endif
262 
274 #ifndef configOTA_PRIMARY_DATA_PROTOCOL
275  #define configOTA_PRIMARY_DATA_PROTOCOL ( OTA_DATA_OVER_MQTT )
276 #endif
277 
295 #ifndef LogError
296  #define LogError( message )
297 #endif
298 
316 #ifndef LogWarn
317  #define LogWarn( message )
318 #endif
319 
337 #ifndef LogInfo
338  #define LogInfo( message )
339 #endif
340 
358 #ifndef LogDebug
359  #define LogDebug( message )
360 #endif
361 
362 /* *INDENT-OFF* */
363 #ifdef __cplusplus
364  }
365 #endif
366 /* *INDENT-ON* */
367 
368 #endif /* ifndef OTA_CONFIG_DEFAULTS_H */