Skip to content

Commit e3725e5

Browse files
committed
docs
1 parent 36f7d73 commit e3725e5

26 files changed

+71
-124
lines changed

README.md

+43-117
Large diffs are not rendered by default.

assets/api.jpg

-71.7 KB
Binary file not shown.

assets/bundle2.jpg

-159 KB
Binary file not shown.

assets/compare.jpg

-210 KB
Binary file not shown.

assets/frag.jpg

-136 KB
Binary file not shown.

assets/graph1.jpg

-126 KB
Binary file not shown.

assets/lwip.jpg

4.24 KB
Loading

assets/pbspec.jpg

-63.8 KB
Binary file not shown.

assets/pv2.jpg

-31.3 KB
Binary file not shown.

assets/pv3mqtt.jpg

-22.7 KB
Binary file not shown.

assets/qos1fail.jpg

-111 KB
Binary file not shown.

assets/qos2working.JPG

-100 KB
Binary file not shown.

assets/random1.jpg

-314 KB
Binary file not shown.

assets/random2.jpg

-32.5 KB
Binary file not shown.

assets/soak.jpg

-16.9 KB
Binary file not shown.

assets/sr1a.jpg

-36.3 KB
Binary file not shown.

assets/sr1p.jpg

-44.9 KB
Binary file not shown.

assets/sr2a.jpg

-76.2 KB
Binary file not shown.

assets/sr2a2.jpg

-28.3 KB
Binary file not shown.

assets/sr2a3.jpg

-17 KB
Binary file not shown.

assets/sr2a4.jpg

-15.9 KB
Binary file not shown.

assets/sr2p.jpg

-66.6 KB
Binary file not shown.

assets/tof_fail1.jpg

-276 KB
Binary file not shown.

assets/tof_fail3.jpg

-158 KB
Binary file not shown.

assets/willtopic_shark.jpg

-119 KB
Binary file not shown.

docs/tls.md

+28-7
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,45 @@ Unfortunately the standard [ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTC
99

1010
You must replace that library with this [bugfixed version](https://github.com/philbowles/ESPAsyncTCP)
1111

12-
# Code
12+
# Compiling with SSL
1313

14-
You must provide a SHA1 fingerprint to confirm the server identity, and call `serverFingerprint` before connection, e.g.
14+
SSL Features are NOT available by default. This is because they add about 64k to the binary, *even if you don't use them*!
15+
16+
In order to use TLS, you first need to enable SSL in both the [bugfixed library](https://github.com/philbowles/ESPAsyncTCP): Edit `async_config.h`
17+
and PangolinMQTT itself: Edit `config.h`
18+
19+
In both files, find the line which says:
20+
`#define ASYNC_TCP_SSL_ENABLED 0`
21+
22+
and change it to:
23+
`#define ASYNC_TCP_SSL_ENABLED 1`
24+
25+
before compiling.
26+
27+
# Your Code
28+
29+
You must provide a 20-byte SHA1 fingerprint to confirm the server identity, and call `serverFingerprint` before connection, e.g.
1530

1631
```cpp
1732
...
1833
const uint8_t cert[20] = { 0x9a, 0xf1, 0x39, 0x79,0x95,0x26,0x78,0x61,0xad,0x1d,0xb1,0xa5,0x97,0xba,0x65,0x8c,0x20,0x5a,0x9c,0xfa };
1934
...
2035
mqttClient.serverFingerprint(cert);
36+
...
37+
mqttClient.connect(...
2138
...
2239
```
2340
24-
# Example sketches
41+
---
42+
43+
## Find me daily in these FB groups
2544
26-
quickstart bare size: 271052
27-
+ TLS = 334604
28-
diff 63552
45+
* [Pangolin Support](https://www.facebook.com/groups/pangolinmqtt/)
46+
* [ESP8266 & ESP32 Microcontrollers](https://www.facebook.com/groups/2125820374390340/)
47+
* [ESP Developers](https://www.facebook.com/groups/ESP8266/)
48+
* [H4/Plugins support](https://www.facebook.com/groups/h4plugins)
2949
50+
I am always grateful for any $upport on [Patreon](https://www.patreon.com/esparto) :)
3051
3152
32-
Apart from the "QuickStart_X" and STM32 sketches, the examples include a simple `#define ASYNC_TCP_SSL_ENABLED` at the head of the sketch. Set your own `cert` finfingerprint and make sure `ASYNC_TCP_SSL_ENABLED` is defined - the rest happens automatically.
53+
(C) 2020 Phil Bowles

0 commit comments

Comments
 (0)