Skip to content
This repository was archived by the owner on Jan 29, 2023. It is now read-only.

Commit dc852cc

Browse files
authored
v1.2.1
### Releases v1.2.1 1. Clean-up all compiler warnings possible. 2. Add Table of Contents
1 parent e06840b commit dc852cc

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -789,9 +789,13 @@ The following info is taken and modified from [SSLClient README](https://github.
789789

790790
Using EthernetSSLClient is similar to using any other Arduino-based Client class. There are a few extra things, however, that you will need to get started:
791791

792-
1. **Board and Network Peripheral** - Your board should have a lot of resources (>110kb flash and >7kb RAM), and your network peripheral should have a large internal buffer (>7kb).
792+
##### 1. Board and Network Peripheral Requirements
793793

794-
2. **Trust Anchors (TA)** - You will need a header containing array of trust anchors ([trust_anchors](examples/WebClient_SSL/trust_anchors.h)), which are used to verify the SSL connection later on. **This file must generated for every project if connecting to different TLS/SSL WebServers.** Check out [TrustAnchors.md](./TrustAnchors.md#generating-trust-anchors) on how to generate this file for your project, and for more information about what a trust anchor is.
794+
Your board should have a lot of resources (>110kb flash and >7kb RAM), and your network peripheral should have a large internal buffer (>7kb).
795+
796+
##### 2. How to use Trust Anchors TA
797+
798+
You will need a header containing array of trust anchors ([trust_anchors](examples/WebClient_SSL/trust_anchors.h)), which are used to verify the SSL connection later on. **This file must generated for every project if connecting to different TLS/SSL WebServers.** Check out [TrustAnchors.md](./TrustAnchors.md#generating-trust-anchors) on how to generate this file for your project, and for more information about what a trust anchor is.
795799

796800

797801
Once all those are ready, you can create an SSLClient object like this:
@@ -840,7 +844,9 @@ else
840844
}
841845
```
842846

843-
**Note**: `sslClient.connect("www.arduino.cc", 443)` can take 5-15 seconds to finish. This an unavoidable consequence of the SSL protocol, and is detailed in [Implementation Notes](#resources).
847+
##### 3. Note
848+
849+
`sslClient.connect("www.arduino.cc", 443)` can take 5-15 seconds to finish. This an unavoidable consequence of the SSL protocol, and is detailed in [Implementation Notes](#resources).
844850

845851
For more information on `EthernetSSLClient`, check out the [examples](./examples), [API documentation](https://openslab-osu.github.io/SSLClient/index.html), or the rest of this README.
846852

@@ -1049,10 +1055,6 @@ If for some unfortunate reason you need SSL 3.0 or SSL 2.0, you will need to mod
10491055

10501056
* When using PubSubClient on the ESP32, a stack overflow will occur if the user does not flush the buffer immediately after writing. The cause of this issue is under active investigation. More information in issue [PubSubClient on ESP32 overflows the stack](https://github.com/OPEnSLab-OSU/SSLClient/issues/9).
10511057

1052-
1053-
---
1054-
---
1055-
10561058
---
10571059
---
10581060

0 commit comments

Comments
 (0)