nRF Connect SDK API 0.1.0
Loading...
Searching...
No Matches

◆ fota_download_any()

int fota_download_any ( const char *  host,
const char *  file,
const int *  sec_tag_list,
uint8_t  sec_tag_count,
uint8_t  pdn_id,
size_t  fragment_size 
)

#include <include/net/fota_download.h>

Start downloading the given file of any image type from the given host.

When the download is complete, the secondary slot of MCUboot is tagged as having valid firmware inside it. The completion is reported through an event.

URI parameters (host and file) are not copied, so pointers must stay valid until download is finished.

Parameters
hostName of host to start downloading from. Can include scheme and port number, e.g. https://google.com:443
filePath to the file you wish to download. May be either a single file path, relative to host (for example "path/to/binary.bin"), or, if bootloader FOTA is enabled, can be two paths (both relative to host), separated by a space (for example "path/to/s0.bin path/to/s1.bin"). If two paths are provided, the download will be assumed to be a bootloader download, both paths will be treated as upgradable bootloader slot 0 and slot 1 binaries respectively, and only the binary corresponding to the currently inactive bootloader slot will be selected and downloaded. See Secure Bootloader Chain Docs for details regarding the upgradable bootloader slots.
sec_tag_listSecurity tags that you want to use with HTTPS. Pass NULL to disable TLS.
sec_tag_countNumber of TLS security tags in list. Pass 0 to disable TLS.
pdn_idPacket Data Network ID to use for the download, or 0 to use the default.
fragment_sizeFragment size to be used for the download. If 0,
embed:rst:inline :kconfig:option:`CONFIG_DOWNLOAD_CLIENT_HTTP_FRAG_SIZE` 
is used.
Return values
0If download has started successfully.
-EALREADYIf download is already ongoing.
-E2BIGIf sec_tag_count is larger than
embed:rst:inline :kconfig:option:`CONFIG_FOTA_DOWNLOAD_SEC_TAG_LIST_SIZE_MAX` 
Otherwise, a negative value is returned.