AWS IoT Over-the-air Update v3.4.0
Client library for AWS IoT OTA
 
Loading...
Searching...
No Matches
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
143#ifndef otaconfigMAX_THINGNAME_LEN
144 #define otaconfigMAX_THINGNAME_LEN 128U
145#endif
146
163#ifndef otaconfigMAX_NUM_BLOCKS_REQUEST
164 #define otaconfigMAX_NUM_BLOCKS_REQUEST 1U
165#endif
166
178#ifndef otaconfigMAX_NUM_REQUEST_MOMENTUM
179 #define otaconfigMAX_NUM_REQUEST_MOMENTUM 32U
180#endif
181
192#ifndef otaconfigOTA_UPDATE_STATUS_FREQUENCY
193 #define otaconfigOTA_UPDATE_STATUS_FREQUENCY 64U
194#endif
195
205#ifndef otaconfigMAX_NUM_OTA_DATA_BUFFERS
206 #define otaconfigMAX_NUM_OTA_DATA_BUFFERS 1U
207#endif
208
218#ifndef otaconfigOTA_FILE_TYPE
219 #if defined( WIN32 ) || defined( __linux__ )
220 #define otaconfigOTA_FILE_TYPE FILE
221 #else
222 #define otaconfigOTA_FILE_TYPE uint8_t
223 #endif
224#endif
225
238#ifndef otaconfigAllowDowngrade
239 #define otaconfigAllowDowngrade 0U
240#endif
241
251#ifndef configOTA_FIRMWARE_UPDATE_FILE_TYPE_ID
252 #define configOTA_FIRMWARE_UPDATE_FILE_TYPE_ID 0U
253#endif
254
266#ifndef configENABLED_CONTROL_PROTOCOL
267 #define configENABLED_CONTROL_PROTOCOL ( OTA_CONTROL_OVER_MQTT )
268#endif
269
282#ifndef configENABLED_DATA_PROTOCOLS
283 #define configENABLED_DATA_PROTOCOLS ( OTA_DATA_OVER_MQTT )
284#endif
285
297#ifndef configOTA_PRIMARY_DATA_PROTOCOL
298 #define configOTA_PRIMARY_DATA_PROTOCOL ( OTA_DATA_OVER_MQTT )
299#endif
300
307#ifndef configOTA_POLLING_EVENTS_TIMEOUT_MS
308 #define configOTA_POLLING_EVENTS_TIMEOUT_MS ( 1000U )
309#endif
310
322#ifndef OTA_USE_NONCONST_APPVERSION
323 #define OTA_USE_NONCONST_APPVERSION ( 0U )
324#endif
325
343#ifndef LogError
344 #define LogError( message )
345#endif
346
364#ifndef LogWarn
365 #define LogWarn( message )
366#endif
367
385#ifndef LogInfo
386 #define LogInfo( message )
387#endif
388
406#ifndef LogDebug
407 #define LogDebug( message )
408#endif
409
410/* *INDENT-OFF* */
411#ifdef __cplusplus
412 }
413#endif
414/* *INDENT-ON* */
415
416#endif /* ifndef OTA_CONFIG_DEFAULTS_H */