Skip to content

Commit

Permalink
Upload wifi-connection-manager 2.0.0.532
Browse files Browse the repository at this point in the history
  • Loading branch information
gitlab-runner committed Oct 6, 2020
1 parent 96dddee commit 7cd783f
Show file tree
Hide file tree
Showing 94 changed files with 2,951 additions and 1,243 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
# Cypress Wi-Fi Connection Manager (WCM)
# Wi-Fi Connection Manager (WCM)
WCM is a library which helps application developers to manage Wi-Fi Connectivity. The library provides a set of APIs that can be used to establish and monitor Wi-Fi connections on Cypress platforms that support Wi-Fi connectivity.

The library APIs are thread-safe. The library monitors the Wi-Fi connection and can notifies connection state changes through an event notification mechanism. The library also provides APIs to connect to a Wi-Fi network using Wi-Fi Protected Setup (WPS) methods.
The library APIs are thread-safe. The library monitors the Wi-Fi connection and can notifies connection state changes through an event notification mechanism. The library also provides APIs to connect to a Wi-Fi network using Wi-Fi Protected Setup (WPS) methods.

## Features and Functionality
The current implementation has the following features and functionality:
* Supports only STA mode. AP and Concurrent AP + STA modes will be added in future.
* Supports STA, SoftAP, and Concurrent(simultaneous Soft-AP + STA) modes.
* Support for WPS - Enrollee role.
* Exposes Wi-Fi APIs to scan, join, and leave the Wi-Fi network.
* Connection monitoring: Monitors active connections and link events. Automatically reconnects to the AP if the connection with the AP is lost intermittently. Notifies connection state change through an event notification registration mechanism.
* Connection monitoring: Monitors active connections and link events. Automatically reconnects to the AP if the connection with the AP is lost intermittently. Notifies the connection state change through event notification registration mechanism.
* This library is part of AnyCloud framework that supports connectivity applications based on FreeRTOS, lwIP, and mbed TLS.
* The library is built on top of the abstraction-rtos library that provides the RTOS abstraction API for FreeRTOS.


## Supported Platforms
This library and its features are supported on the following Cypress platforms:
* [PSoC 6 Wi-Fi BT Prototyping Kit (CY8CPROTO-062-4343W)](https://www.cypress.com/documentation/development-kitsboards/psoc-6-wi-fi-bt-prototyping-kit-cy8cproto-062-4343w)

* [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)

* [PSoC 6 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)

## Dependent Libraries
This library depends on the following:
* [Wi-Fi Middleware Core](https://github.com/cypresssemiconductorco/wifi-mw-core)
Expand All @@ -39,6 +42,10 @@ This library depends on the following:

- See [connectivity-utilities library API documentation](https://cypresssemiconductorco.github.io/connectivity-utilities/api_reference_manual/html/group__logging__utils.html).

* WPS is disabled by default. WPS uses Mbed TLS security stack. Enable the following components for WPS.
```
COMPONENTS+=WPS MBEDTLS
```

## Additional Information
* [Wi-Fi Connection Manager RELEASE.md](./RELEASE.md)
Expand Down
34 changes: 18 additions & 16 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Cypress Wi-Fi Connection Manager (WCM)
# Wi-Fi Connection Manager (WCM)

## What's Included?
See the [README.md](./README.md) for a complete description of the Wi-Fi Connection Manager.
Expand All @@ -7,41 +7,43 @@ See the [README.md](./README.md) for a complete description of the Wi-Fi Connect
| Problem | Workaround |
| ------- | ---------- |
| The `cy_wcm_deinit` API does not bring down the network stack as the default underlying lwIP stack does not have an implementation for deinit. Therefore, the expectation is that `cy_wcm_init` and `cy_wcm_deinit` APIs should be invoked only once. | No workaround. Support will be added in a future release. |
| This release does not support AP and Concurrent AP + STA mode. | No workaround. Support will be added in a future release. |

## Changelog
### v2.0.0
* Added support for Soft-AP and concurrent (simultaneous Soft-AP + STA) modes.
* Documentation updates.

### v1.1.0
* Introduced APIs to get the following:
- Connected AP information
- WLAN interface statistics
- IPv6 link local address
- IPv6 link-local address
- Gateway IP address
- Netmask IP address
- Gateway MAC address
* Introduced API to ping IPv4 address.
* Minor documentation updates.
* Introduced API to ping IPv4 address
* Minor documentation updates

### v1.0.1
* Code snippets added to the documentation.
* Code snippets added to the documentation

### v1.0.0
* Initial release for Wi-Fi Connection Manager.
* Initial release for Wi-Fi Connection Manager

* Includes support for Wi-Fi Protected Setup (WPS) - Enrollee role.
* Includes support for Wi-Fi Protected Setup (WPS) - Enrollee role

* Exposes Wi-Fi APIs to scan, join, and leave a Wi-Fi network.

* Connection monitoring: Monitor active connections and link events. Provides a mechanism to register for event notification. Re-authenticates the connection with AP in case of intermittent connection loss.
* Connection monitoring: Monitor active connections and link events. Provides a mechanism to register for event notification. Re-authenticates the connection with the AP in case of intermittent connection loss.

### Supported Software and Tools
This version of the library was validated for compatibility with the following Software and Tools:

| Software and Tools | Version |
| :--- | :----: |
| ModusToolbox Software Environment | 2.1 |
| - ModusToolbox Device Configurator | 2.1 |
| - ModusToolbox CSD Personality in Device Configurator | 2.0 |
| - ModusToolbox CapSense Configurator / Tuner tools | 3.0 |
| PSoC 6 Peripheral Driver Library (PDL) | 1.5.0 |
| GCC Compiler | 7.2.1 |
| IAR Compiler | 8.32 |
| ModusToolbox Software Environment | 2.2 |
| - ModusToolbox Device Configurator | 2.20 |
| - ModusToolbox CapSense Configurator / Tuner tools | 3.10 |
| PSoC 6 Peripheral Driver Library (PDL) | 2.0.0 |
| GCC Compiler | 9.3.1 |
| IAR Compiler (only for AnyCloud) | 8.32 |
Loading

0 comments on commit 7cd783f

Please sign in to comment.