Andrew Reed / Mbed OS CITY1082-i2c_master_wifi_mqtt

CITY3032-wifi-mqtt

connectivity-utilities/README.md@5:f62a9e4a499a, 2021-11-13 (annotated)

Committer:
reedas
Date:
Sat Nov 13 12:02:49 2021 +0000
Revision:
5:f62a9e4a499a
Parent:
4:7ebc3d28bcb2 
trying to include mbed

Who changed what in which revision?

UserRevisionLine numberNew contents of line
reedas 4:7ebc3d28bcb2 1 ## Introduction
reedas 4:7ebc3d28bcb2 2 The connectivity utilities library is a collection of general purpose middleware utilities. Several connectivity middleware libraries shall depend on this utilities library.
reedas 4:7ebc3d28bcb2 3 Currently, the following utilities are included:
reedas 4:7ebc3d28bcb2 4
reedas 4:7ebc3d28bcb2 5 ## Features
reedas 4:7ebc3d28bcb2 6 ### JSON parser
reedas 4:7ebc3d28bcb2 7 The JSON format is often used for serializing and transmitting structured data over a network connection. It is used primarily to transmit data between a server and web application, serving as an alternative to XML. JSON is JavaScript Object Notation. The JSON parser utility library provides helper functions to parse JSON objects and calls the function registered by the caller
reedas 4:7ebc3d28bcb2 8
reedas 4:7ebc3d28bcb2 9 Refer to the [cy_json_parser.h](./JSON_parser/cy_json_parser.h) for API documentation
reedas 4:7ebc3d28bcb2 10
reedas 4:7ebc3d28bcb2 11 ### Linked list
reedas 4:7ebc3d28bcb2 12 This is a generic linked list library with helper functions to add, insert, delete and find nodes in a list.
reedas 4:7ebc3d28bcb2 13
reedas 4:7ebc3d28bcb2 14 Refer to the [cy_linked_list.h](./linked_list/cy_linked_list.h) for API documentation
reedas 4:7ebc3d28bcb2 15
reedas 4:7ebc3d28bcb2 16 ### String utilities
reedas 4:7ebc3d28bcb2 17 The string utilities module is a collection of string conversion helpers to convert between integer and strings.
reedas 4:7ebc3d28bcb2 18
reedas 4:7ebc3d28bcb2 19 Refer to the [cy_string_utils.h](./cy_string/cy_string_utils.h) for API documentation
reedas 4:7ebc3d28bcb2 20
reedas 4:7ebc3d28bcb2 21 ### Network helpers
reedas 4:7ebc3d28bcb2 22 This is a collection of network helper functions to fetch IPv4 address of the local device, notify IPv4 address change via callback and conversion utilities.
reedas 4:7ebc3d28bcb2 23
reedas 4:7ebc3d28bcb2 24 Refer to the [cy_nw_helper.h](./network/cy_nw_helper.h) for API documentation
reedas 4:7ebc3d28bcb2 25
reedas 4:7ebc3d28bcb2 26 ### Logging functions
reedas 4:7ebc3d28bcb2 27 This module is a logging subsystem that allows run time control for the logging level. Log messages are passed back to the application for output. A time callback can be provided by the application for the timestamp for each output line. Log messages are mutex protected across threads so that log messages do not interrupt each other.
reedas 4:7ebc3d28bcb2 28
reedas 4:7ebc3d28bcb2 29 Refer to the [cy_log.h](./cy_log/cy_log.h) for API documenmtation
reedas 4:7ebc3d28bcb2 30
reedas 4:7ebc3d28bcb2 31 ### Middleware Error codes
reedas 4:7ebc3d28bcb2 32 The utilities library includes a collection of middleware error codes for various middleware libraries such as AWS IoT, HTTP server, Enterprise security etc.
reedas 4:7ebc3d28bcb2 33
reedas 4:7ebc3d28bcb2 34 Refer to [cy_result_mw.h](./cy_result_mw.h) for details
reedas 4:7ebc3d28bcb2 35
reedas 4:7ebc3d28bcb2 36 ## Supported platforms
reedas 4:7ebc3d28bcb2 37 This middleware library and its features are supported on following PSoC 6 platforms:
reedas 4:7ebc3d28bcb2 38 * [PSoC6 WiFi-BT Prototyping Kit (CY8CPROTO-062-4343W)](https://www.cypress.com/documentation/development-kitsboards/psoc-6-wi-fi-bt-prototyping-kit-cy8cproto-062-4343w)
reedas 4:7ebc3d28bcb2 39 * [PSoC6 WiFi-BT Pioneer Kit (CY8CKIT-062-WiFi-BT)](https://www.cypress.com/documentation/development-kitsboards/psoc-6-wifi-bt-pioneer-kit-cy8ckit-062-wifi-bt)
reedas 4:7ebc3d28bcb2 40 * [PSoC 62S2 Wi-Fi BT Pioneer Kit (CY8CKIT-062S2-43012)](https://www.cypress.com/documentation/development-kitsboards/psoc-62s2-wi-fi-bt-pioneer-kit-cy8ckit-062s2-43012)
reedas 4:7ebc3d28bcb2 41 * [PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-LAI-4373M2)](https://www.cypress.com/documentation/development-kitsboards/psoc-62s2-evaluation-kit-cy8ceval-062s2)
reedas 4:7ebc3d28bcb2 42
reedas 4:7ebc3d28bcb2 43 ## Integration Notes
reedas 4:7ebc3d28bcb2 44 * The connectivity utilities library has been designed to work with both the ARM mbed ecosystem and ModusToolbox™ environment.
reedas 4:7ebc3d28bcb2 45 * It is adequate to include this library in the desired ecosystem to use these utilities. Depending on the ecosystem, the respective source files will get picked up and linked. This is accomplished using the COMPONENT_ model.
reedas 4:7ebc3d28bcb2 46 * In order to ease integration of Wi-Fi connectivity components to code examples, this connectivity utilities library has been bundled into the [Wi-Fi middleware core library v2.0.0](https://github.com/cypresssemiconductorco/wifi-mw-core).
reedas 4:7ebc3d28bcb2 47 * For mbed ecosystem, this library has to be included by the respective code examples.
reedas 4:7ebc3d28bcb2 48 * NOTE: Refer to the COMPOMENT_ folders for implementation details pertinent to the ecosystem. For instance, certain network helper functions are not implemented on AnyCloud, and are leveraged from Wi-Fi Connection Manager
reedas 4:7ebc3d28bcb2 49
reedas 4:7ebc3d28bcb2 50 ## Additional Information
reedas 4:7ebc3d28bcb2 51 * [Connectivity Utilities RELEASE.md](./RELEASE.md)
reedas 4:7ebc3d28bcb2 52 * [Connectivity Utilities API reference guide](https://cypresssemiconductorco.github.io/connectivity-utilities/api_reference_manual/html/index.html)
reedas 4:7ebc3d28bcb2 53 * [Connectivity Utilities version](./version.xml)
reedas 4:7ebc3d28bcb2 54