AWS IoT Over-the-air Update  v2.0.0 (Release Candidate)
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 v2.0.0 (Release Candidate)
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 /* The macro definition for OTA_DO_NOT_USE_CUSTOM_CONFIG is for Doxygen
39  * documentation only. */
40 
51 #ifdef DOXYGEN
52  #define OTA_DO_NOT_USE_CUSTOM_CONFIG
53 #endif
54 
66 #ifndef otaconfigSTACK_SIZE
67  #define otaconfigSTACK_SIZE "Please set otaconfigSTACK_SIZE"
68 #endif
69 
78 #ifndef otaconfigAGENT_PRIORITY
79  #define otaconfigAGENT_PRIORITY "Please set otaconfigAGENT_PRIORITY"
80 #endif
81 
89 #ifndef otaconfigLOG2_FILE_BLOCK_SIZE
90  #define otaconfigLOG2_FILE_BLOCK_SIZE 12UL
91 #endif
92 
100 #ifndef otaconfigSELF_TEST_RESPONSE_WAIT_MS
101  #define otaconfigSELF_TEST_RESPONSE_WAIT_MS 16000U
102 #endif
103 
115 #ifndef otaconfigFILE_REQUEST_WAIT_MS
116  #define otaconfigFILE_REQUEST_WAIT_MS 10000U
117 #endif
118 
131 #ifndef otaconfigMAX_THINGNAME_LEN
132  #define otaconfigMAX_THINGNAME_LEN 64U
133 #endif
134 
151 #ifndef otaconfigMAX_NUM_BLOCKS_REQUEST
152  #define otaconfigMAX_NUM_BLOCKS_REQUEST 1U
153 #endif
154 
166 #ifndef otaconfigMAX_NUM_REQUEST_MOMENTUM
167  #define otaconfigMAX_NUM_REQUEST_MOMENTUM 32U
168 #endif
169 
180 #ifndef otaconfigOTA_UPDATE_STATUS_FREQUENCY
181  #define otaconfigOTA_UPDATE_STATUS_FREQUENCY 64U
182 #endif
183 
193 #ifndef otaconfigMAX_NUM_OTA_DATA_BUFFERS
194  #define otaconfigMAX_NUM_OTA_DATA_BUFFERS 1U
195 #endif
196 
209 #ifndef otaconfigAllowDowngrade
210  #define otaconfigAllowDowngrade 0U
211 #endif
212 
224 #ifndef configENABLED_CONTROL_PROTOCOL
225  #define configENABLED_CONTROL_PROTOCOL ( OTA_CONTROL_OVER_MQTT )
226 #endif
227 
240 #ifndef configENABLED_DATA_PROTOCOLS
241  #define configENABLED_DATA_PROTOCOLS ( OTA_DATA_OVER_MQTT )
242 #endif
243 
255 #ifndef configOTA_PRIMARY_DATA_PROTOCOL
256  #define configOTA_PRIMARY_DATA_PROTOCOL ( OTA_DATA_OVER_MQTT )
257 #endif
258 
276 #ifndef LogError
277  #define LogError( message )
278 #endif
279 
297 #ifndef LogWarn
298  #define LogWarn( message )
299 #endif
300 
318 #ifndef LogInfo
319  #define LogInfo( message )
320 #endif
321 
339 #ifndef LogDebug
340  #define LogDebug( message )
341 #endif
342 
343 #endif /* ifndef OTA_CONFIG_DEFAULTS_H */