Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
aws-iot-device-sdk-port/README.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
45 lines (25 sloc)
2.69 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# AWS IoT Device SDK Port Library | |
This library is a port layer implementation for the Infineon MQTT and HTTP Client libraries to work with the AWS-IoT-Device-SDK-Embedded-C library on Infineon connectivity-enabled MCU platforms. These library APIs are not expected to be called by application directly. See the MQTT and HTTP Client library documentation for more details. | |
## OTA Support | |
This aws-iot-device-sdk-port layer implementation also supports PAL APIs required by AWS-IoT-Device-SDK-Embedded-C OTA. | |
By default, OTA support is disabled. To enable OTA support follow below steps. | |
1. Add the `CY_OTA_FLASH_SUPPORT` macro in the application Makefile. The Makefile entry should look like as follows: | |
``` | |
DEFINES+=CY_OTA_FLASH_SUPPORT | |
``` | |
2. Create a *.mtb* files for anycloud-ota and serial-flash as follows and add *.mtb* file along with other dependent library *.mtb* files: | |
*anycloud-ota.mtb*: `https://github.com/Infineon/anycloud-ota#release-v4.1.0#$$ASSET_REPO$$/anycloud-ota/` | |
*serial-flash.mtb*: `https://github.com/Infineon/serial-flash#latest-v1.X#$$ASSET_REPO$$/serial-flash/` | |
3. Execute the `make getlibs` command. | |
4. The reference file *./configs/ota_config.h* that is bundled with this library provides the default configurations required for the [AWS IoT device SDK](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/202103.00) OTA library. Copy the reference file *./configs/ota_config.h* to application root folder, tune the OTA configuaration parameter as required by application and add OTA signing certificate to macro `AWS_IOT_OTA_SIGNING_CERT`. | |
5. Build application using `make build` command. | |
## Additional Information | |
- [AWS IoT Device SDK Port Library RELEASE.md](./RELEASE.md) | |
- [AWS IoT Device SDK Port Library Version](./version.xml) | |
- [AWS IoT Device SDK Port Library API Documentation](https://infineon.github.io/aws-iot-device-sdk-port/api_reference_manual/html/index.html) | |
- [Amazon's AWS-IoT-Device-SDK-Embedded-C Library](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/202103.00) | |
- [MQTT Client Library API Documentation](https://infineon.github.io/mqtt/api_reference_manual/html/index.html) | |
- [HTTP Client Library API Documentation](https://infineon.github.io/http-client/api_reference_manual/html/index.html) | |
- [Connectivity Utilities API documentation - for cy-log details](https://infineon.github.io/connectivity-utilities/api_reference_manual/html/group__logging__utils.html) | |
- [ModusToolbox™ Software Environment, Quick Start Guide, Documentation, and Videos](https://www.infineon.com/cms/en/design-support/tools/sdk/modustoolbox-software/) | |
- [ModusToolbox™ code examples](https://github.com/Infineon/Code-Examples-for-ModusToolbox-Software) |