AWS IoT Over-the-air Update v3.4.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.4.0
3 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4 *
5 * SPDX-License-Identifier: MIT
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy of
8 * this software and associated documentation files (the "Software"), to deal in
9 * the Software without restriction, including without limitation the rights to
10 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11 * the Software, and to permit persons to whom the Software is furnished to do so,
12 * subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in all
15 * copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
37#ifndef OTA_CONFIG_DEFAULTS_H
38#define OTA_CONFIG_DEFAULTS_H
39
40/* *INDENT-OFF* */
41#ifdef __cplusplus
42 extern "C" {
43#endif
44/* *INDENT-ON* */
45
46/* The macro definition for OTA_DO_NOT_USE_CUSTOM_CONFIG is for Doxygen
47 * documentation only. */
48
59#ifdef DOXYGEN
60 #define OTA_DO_NOT_USE_CUSTOM_CONFIG
61#endif
62
74#ifndef otaconfigSTACK_SIZE
75 #define otaconfigSTACK_SIZE "Please set otaconfigSTACK_SIZE"
76#endif
77
86#ifndef otaconfigAGENT_PRIORITY
87 #define otaconfigAGENT_PRIORITY "Please set otaconfigAGENT_PRIORITY"
88#endif
89
97#ifndef otaconfigLOG2_FILE_BLOCK_SIZE
98 #define otaconfigLOG2_FILE_BLOCK_SIZE 12UL
99#endif
100
108#ifndef otaconfigSELF_TEST_RESPONSE_WAIT_MS
109 #define otaconfigSELF_TEST_RESPONSE_WAIT_MS 16000U
110#endif
111
123#ifndef otaconfigFILE_REQUEST_WAIT_MS
124 #define otaconfigFILE_REQUEST_WAIT_MS 10000U
125#endif
126
139#ifndef otaconfigMAX_THINGNAME_LEN
140 #define otaconfigMAX_THINGNAME_LEN 64U
141#endif
142
159#ifndef otaconfigMAX_NUM_BLOCKS_REQUEST
160 #define otaconfigMAX_NUM_BLOCKS_REQUEST 1U
161#endif
162
174#ifndef otaconfigMAX_NUM_REQUEST_MOMENTUM
175 #define otaconfigMAX_NUM_REQUEST_MOMENTUM 32U
176#endif
177
188#ifndef otaconfigOTA_UPDATE_STATUS_FREQUENCY
189 #define otaconfigOTA_UPDATE_STATUS_FREQUENCY 64U
190#endif
191
201#ifndef otaconfigMAX_NUM_OTA_DATA_BUFFERS
202 #define otaconfigMAX_NUM_OTA_DATA_BUFFERS 1U
203#endif
204
214#ifndef otaconfigOTA_FILE_TYPE
215 #if defined( WIN32 ) || defined( __linux__ )
216 #define otaconfigOTA_FILE_TYPE FILE
217 #else
218 #define otaconfigOTA_FILE_TYPE uint8_t
219 #endif
220#endif
221
234#ifndef otaconfigAllowDowngrade
235 #define otaconfigAllowDowngrade 0U
236#endif
237
247#ifndef configOTA_FIRMWARE_UPDATE_FILE_TYPE_ID
248 #define configOTA_FIRMWARE_UPDATE_FILE_TYPE_ID 0U
249#endif
250
262#ifndef configENABLED_CONTROL_PROTOCOL
263 #define configENABLED_CONTROL_PROTOCOL ( OTA_CONTROL_OVER_MQTT )
264#endif
265
278#ifndef configENABLED_DATA_PROTOCOLS
279 #define configENABLED_DATA_PROTOCOLS ( OTA_DATA_OVER_MQTT )
280#endif
281
293#ifndef configOTA_PRIMARY_DATA_PROTOCOL
294 #define configOTA_PRIMARY_DATA_PROTOCOL ( OTA_DATA_OVER_MQTT )
295#endif
296
303#ifndef configOTA_POLLING_EVENTS_TIMEOUT_MS
304 #define configOTA_POLLING_EVENTS_TIMEOUT_MS ( 1000U )
305#endif
306
324#ifndef LogError
325 #define LogError( message )
326#endif
327
345#ifndef LogWarn
346 #define LogWarn( message )
347#endif
348
366#ifndef LogInfo
367 #define LogInfo( message )
368#endif
369
387#ifndef LogDebug
388 #define LogDebug( message )
389#endif
390
391/* *INDENT-OFF* */
392#ifdef __cplusplus
393 }
394#endif
395/* *INDENT-ON* */
396
397#endif /* ifndef OTA_CONFIG_DEFAULTS_H */