v1.8.0 for ESP32 using WiFi / LwIP Ethernet

### Releases v1.8.0

1. Initial coding to port [AsyncMQTT_Generic](https://github.com/khoih-prog/AsyncMQTT_Generic) to `ESP32/S2/S3/C3` boards using WiFi or `LwIP W5500 / ENC28J60 / LAN8720 Ethernet`
2. Use `allman astyle`
3. Sync with [AsyncMQTT_Generic v1.8.0](https://github.com/khoih-prog/AsyncMQTT_Generic)

Author: khoih-prog

.codespellrc

@@ -0,0 +1,7 @@
+# See: https://github.com/codespell-project/codespell#using-a-config-file
+[codespell]
+# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
+ignore-words-list = ,
+check-filenames =
+check-hidden =
+skip = ./.git,./src,./examples,./Packages_Patches,./LibraryPatches

CONTRIBUTING.md

@@ -0,0 +1,78 @@
+## Contributing to AsyncMQTT_ESP32
+
+### Reporting Bugs
+
+Please report bugs in [AsyncMQTT_ESP32](https://github.com/khoih-prog/AsyncMQTT_ESP32/issues/new) if you find them.
+
+However, before reporting a bug please check through the following:
+
+* [Existing Open Issues](https://github.com/khoih-prog/AsyncMQTT_ESP32/issues) - someone might have already encountered this.
+
+If you don't find anything, please [open a new issue](https://github.com/khoih-prog/AsyncMQTT_ESP32/issues/new).
+
+### How to submit a bug report
+
+Please ensure to specify the following:
+
+* Arduino IDE version (e.g. 1.8.19) or Platform.io version
+* Board Type (e.g. ESP32S3_DEV, ESP32S2_DEV, ESP32C3_DEV)
+* Board Core Version (e.g. ESP32 core v2.0.5)
+* Contextual information (e.g. what you were trying to achieve)
+* Simplest possible steps to reproduce
+* Anything that might be relevant in your opinion, such as:
+  * Operating system (Windows, Ubuntu, etc.) and the output of `uname -a`
+  * Network configuration
+
+
+Please be educated, civilized and constructive. Disrespective posts against [GitHub Code of Conduct](https://docs.github.com/en/site-policy/github-terms/github-event-code-of-conduct) will be ignored and deleted.
+
+
+### Example
+
+```
+Arduino IDE version: 1.8.19
+ESP32S3_DEV board
+ESP32 core v2.0.5
+OS: Ubuntu 20.04 LTS
+Linux xy-Inspiron-3593 5.15.0-56-generic #62~20.04.1-Ubuntu SMP Tue Nov 22 21:24:20 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
+
+Context:
+I encountered a crash while using this library
+
+Steps to reproduce:
+1. ...
+2. ...
+3. ...
+4. ...
+```
+
+---
+
+### Sending Feature Requests
+
+Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
+
+There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/AsyncMQTT_ESP32/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
+
+---
+
+### Sending Pull Requests
+
+Pull Requests with changes and fixes are also welcome!
+
+Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
+
+1. Change directory to the library GitHub
+
+```
+xy@xy-Inspiron-3593:~$ cd Arduino/xy/AsyncMQTT_ESP32_GitHub/
+xy@xy-Inspiron-3593:~/Arduino/xy/AsyncMQTT_ESP32_GitHub$
+```
+
+2. Issue astyle command
+
+```
+xy@xy-Inspiron-3593:~/Arduino/xy/AsyncMQTT_ESP32_GitHub$ bash utils/restyle.sh
+```
+
+

Images/ENC28J60.png

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Khoi Hoang
+Copyright (c) 2019 Khoi Hoang
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Images/ESP32S3_DEV.png

@@ -0,0 +1,29 @@
+# AsyncMQTT_ESP32 Library
+
+[![arduino-library-badge](https://www.ardu-badge.com/badge/AsyncMQTT_ESP32.svg?)](https://www.ardu-badge.com/AsyncMQTT_ESP32)
+[![GitHub release](https://img.shields.io/github/release/khoih-prog/AsyncMQTT_ESP32.svg)](https://github.com/khoih-prog/AsyncMQTT_ESP32/releases)
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
+[![GitHub issues](https://img.shields.io/github/issues/khoih-prog/AsyncMQTT_ESP32.svg)](http://github.com/khoih-prog/AsyncMQTT_ESP32/issues)
+
+
+<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Donate to my libraries using BuyMeACoffee" style="height: 50px !important;width: 181px !important;" ></a>
+<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00" style="height: 20px !important;width: 200px !important;" ></a>
+
+---
+---
+
+## Table of Contents
+
+* [Changelog](#changelog)
+	* [Releases v1.8.0](#releases-v180)
+
+---
+---
+
+## Changelog
+
+### Releases v1.8.0
+
+1. Initial coding to port [AsyncMQTT_Generic](https://github.com/khoih-prog/AsyncMQTT_Generic) to `ESP32/S2/S3/C3` boards using WiFi or `LwIP W5500 / ENC28J60 / LAN8720 Ethernet`
+2. Use `allman astyle`
+3. Sync with [AsyncMQTT_Generic v1.8.0](https://github.com/khoih-prog/AsyncMQTT_Generic)

Images/W5500.png

@@ -0,0 +1,28 @@
+# Getting started
+
+To use AsyncMqttClient, you need:
+
+* An ESP8266 or ESP32
+* The Arduino IDE or equivalent IDE for ESP8266/32
+* Basic knowledge of the Arduino environment (use the IDE, upload a sketch, import libraries, ...)
+
+## Installing AsyncMqttClient
+
+There are two ways to install AsyncMqttClient.
+
+### 1a. For the Arduino IDE
+
+1. Download the [corresponding release](https://github.com/marvinroger/async-mqtt-client/releases/latest)
+2. Load the `.zip` with **Sketch → Include Library → Add .ZIP Library**
+
+AsyncMqttClient has 1 dependency:
+* For ESP8266: [ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP). Download the [.zip](https://github.com/me-no-dev/ESPAsyncTCP/archive/master.zip) and install it with the same method as above.
+* Fors ESP32: [AsyncTCP](https://github.com/me-no-dev/AsyncTCP). Download the [.zip](https://github.com/me-no-dev/AsyncTCP/archive/master.zip) and install it with the same method as above.
+
+## Fully-featured sketch
+
+See [examples/FullyFeatured-ESP8266.ino](../examples/FullyFeatured-ESP8266/FullyFeatured-ESP8266.ino)
+
+**<u>Very important:</u> As a rule of thumb, never use blocking functions in the callbacks (don't use `delay()` or `yield()`).** Otherwise, you may very probably experience unexpected behaviors.
+
+You can go to the [API reference](2.-API-reference.md).

Images/W5500_small.png

@@ -0,0 +1,166 @@
+# API reference
+
+#### AsyncMqttClient()
+
+Instantiate a new AsyncMqttClient object.
+
+### Configuration
+
+#### AsyncMqttClient& setKeepAlive(uint16_t `keepAlive`)
+
+Set the keep alive. Defaults to 15 seconds.
+
+* **`keepAlive`**: Keep alive in seconds
+
+#### AsyncMqttClient& setClientId(const char\* `clientId`)
+
+Set the client ID. Defaults to `esp8266<chip ID on 6 hex characters>`.
+
+* **`clientId`**: Client ID
+
+#### AsyncMqttClient& setCleanSession(bool `cleanSession`)
+
+Whether or not to set the CleanSession flag. Defaults to `true`.
+
+* **`cleanSession`**: clean session wanted or not
+
+#### AsyncMqttClient& setMaxTopicLength(uint16_t `maxTopicLength`)
+
+Set the maximum allowed topic length to receive. If an MQTT packet is received
+with a topic longer than this maximum, the packet will be ignored. Defaults to `128`.
+
+* **`maxTopicLength`**: Maximum allowed topic length to receive
+
+#### AsyncMqttClient& setCredentials(const char\* `username`, const char\* `password` = nullptr)
+
+Set the username/password. Defaults to non-auth.
+
+* **`username`**: Username
+* **`password`**: Password
+
+#### AsyncMqttClient& setWill(const char\* `topic`, uint8_t `qos`, bool `retain`, const char\* `payload` = nullptr, size_t `length` = 0)
+
+Set the Last Will Testament. Defaults to none.
+
+* **`topic`**: Topic of the LWT
+* **`qos`**: QoS of the LWT
+* **`retain`**: Retain flag of the LWT
+* **`payload`**: Payload of the LWT. If unset, the payload will be empty
+* **`length`**: Payload length. If unset or set to 0, the payload will be considered as a string and its size will be calculated using `strlen(payload)`
+
+#### AsyncMqttClient& setServer(IPAddress `ip`, uint16_t `port`)
+
+Set the server.
+
+* **`ip`**: IP of the server
+* **`port`**: Port of the server
+
+#### AsyncMqttClient& setServer(const char\* `host`, uint16_t `port`)
+
+Set the server.
+
+* **`host`**: Host of the server
+* **`port`**: Port of the server
+
+#### AsyncMqttClient& setSecure(bool `secure`)
+
+Whether or not to use SSL. Defaults to `false`.
+
+* **`secure`**: SSL wanted or not.
+
+#### AsyncMqttClient& addServerFingerprint(const uint8_t\* `fingerprint`)
+
+Adds an acceptable server fingerprint (SHA1). This may be called multiple times to permit any one of the specified fingerprints. By default, if no fingerprint is added, any fingerprint is accepted.
+
+* **`fingerprint`**: Fingerprint to add
+
+### Events handlers
+
+#### AsyncMqttClient& onConnect(AsyncMqttClientInternals::OnConnectUserCallback `callback`)
+
+Add a connect event handler.
+
+* **`callback`**: Function to call
+
+#### AsyncMqttClient& onDisconnect(AsyncMqttClientInternals::OnDisconnectUserCallback `callback`)
+
+Add a disconnect event handler.
+
+* **`callback`**: Function to call
+
+#### AsyncMqttClient& onSubscribe(AsyncMqttClientInternals::OnSubscribeUserCallback `callback`)
+
+Add a subscribe acknowledged event handler.
+
+* **`callback`**: Function to call
+
+#### AsyncMqttClient& onUnsubscribe(AsyncMqttClientInternals::OnUnsubscribeUserCallback `callback`)
+
+Add an unsubscribe acknowledged event handler.
+
+* **`callback`**: Function to call
+
+#### AsyncMqttClient& onMessage(AsyncMqttClientInternals::OnMessageUserCallback `callback`)
+
+Add a publish received event handler.
+
+* **`callback`**: Function to call
+
+#### AsyncMqttClient& onPublish(AsyncMqttClientInternals::OnPublishUserCallback `callback`)
+
+Add a publish acknowledged event handler.
+
+* **`callback`**: Function to call
+
+### Operation functions
+
+#### bool connected()
+
+Return if the client is currently connected to the broker or not.
+
+#### void connect()
+
+Connect to the server.
+
+#### void disconnect(bool `force` = false)
+
+Disconnect from the server.
+
+* **`force`**: Whether to force the disconnection. Defaults to `false` (clean disconnection).
+
+#### uint16_t subscribe(const char\* `topic`, uint8_t `qos`)
+
+Subscribe to the given topic at the given QoS.
+
+Return the packet ID or 0 if failed.
+
+* **`topic`**: Topic
+* **`qos`**: QoS
+
+#### uint16_t unsubscribe(const char\* `topic`)
+
+Unsubscribe from the given topic.
+
+Return the packet ID or 0 if failed.
+
+* **`topic`**: Topic
+
+#### uint16_t publish(const char\* `topic`, uint8_t `qos`, bool `retain`, const char\* `payload` = nullptr, size_t `length` = 0, bool dup = false, uint16_t message_id = 0)
+
+Publish a packet.
+
+Return the packet ID (or 1 if QoS 0) or 0 if failed.
+
+* **`topic`**: Topic
+* **`qos`**: QoS
+* **`retain`**: Retain flag
+* **`payload`**: Payload. If unset, the payload will be empty
+* **`length`**: Payload length. If unset or set to 0, the payload will be considered as a string and its size will be calculated using `strlen(payload)`
+* **`dup`**: ~~Duplicate flag. If set or set to 1, the payload will be flagged as a duplicate~~ Setting is not used anymore
+* **`message_id`**: ~~The message ID. If unset or set to 0, the message ID will be automtaically assigned. Use this with the DUP flag to identify which message is being duplicated~~ Setting is not used anymore
+
+#### bool clearQueue()
+
+When disconnected, clears all queued messages
+
+Returns true on success, false on failure (client is no disconnected)