Skip to content
This repository has been archived by the owner on Feb 4, 2023. It is now read-only.

Commit

Permalink
v1.8.1 to add example AsyncWebServer_MQTT, etc.
Browse files Browse the repository at this point in the history 
### Releases v1.8.1

1. Add `AsyncWebServer_MQTT` for ESP32 example to demo how to use `AsyncWebServer` and `AsyncMQTT_Generic` together
2. Add `AsyncWebServer_MQTT_RP2040W` example to demo how to use `AsyncWebServer_RP2040W` and `AsyncMQTT_Generic` together
3. Improve `README.md` so that links can be used in other sites, such as `PIO`
  • Loading branch information
@khoih-prog
khoih-prog authored Jan 29, 2023
1 parent 0a94e3b commit 48a17e0
Show file tree
Hide file tree
Showing 10 changed files with 133 additions and 95 deletions.
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,32 @@ However, before reporting a bug please check through the following:

If you don't find anything, please [open a new issue](https://github.com/khoih-prog/AsyncMQTT_Generic/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
* `ESP8266`,`ESP32`, `STM32`, `arduino-pico` or `Teensyduino` Core Version (e.g. ESP8266 core v3.0.2, ESP32 v2.0.5, STM32 v2.3.0, arduino-pico v2.6.3 or Teensyduino v1.57)
* `ESP8266`,`ESP32`, `STM32`, `arduino-pico` or `Teensyduino` Core Version (e.g. ESP8266 core v3.1.1, ESP32 v2.0.6, STM32 v2.4.0, arduino-pico v2.7.1 or Teensyduino v1.57)
* 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 as you've always been. 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
ESP32 Core Version 2.0.5
ESP32 Core Version 2.0.6
OS: Ubuntu 20.04 LTS
Linux xy-Inspiron-3593 5.15.0-53-generic #59~20.04.1-Ubuntu SMP Thu Oct 20 15:10:22 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
Linux xy-Inspiron-3593 5.15.0-58-generic #64~20.04.1-Ubuntu SMP Fri Jan 6 16:42:31 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
Context:
I encountered a crash while using this library
Expand Down
162 changes: 87 additions & 75 deletions README.md
View file

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions changelog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@
<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.1](#releases-v181)
* [Releases v1.8.0](#releases-v180)
* [Releases v1.7.0](#releases-v170)
* [Releases v1.6.1](#releases-v161)
Expand All @@ -33,6 +35,12 @@

## Changelog

### Releases v1.8.1

1. Add `AsyncWebServer_MQTT` for ESP32 example to demo how to use `AsyncWebServer` and `AsyncMQTT_Generic` together
2. Add `AsyncWebServer_MQTT_RP2040W` example to demo how to use `AsyncWebServer_RP2040W` and `AsyncMQTT_Generic` together
3. Improve `README.md` so that links can be used in other sites, such as `PIO`

### Releases v1.8.0

1. Add support to ESP32 boards using `LwIP W5500 Ethernet`
Expand Down
14 changes: 10 additions & 4 deletions library.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "AsyncMQTT_Generic",
"version": "1.8.0",
"version": "1.8.1",
"keywords": "communication, iot, automation, async, async-tcp, async-tcp-ssl, async-mqtt, mqtt, async-mqtt-client, esp8266, esp32, stm32, portenta-h7, wt32-eth01, tls, teensy-41, qn-ethernet, lwip, lan8742a, lan8720",
"description": "Arduino Arduino Library for ESP8266, ESP32, Portenta_H7, STM32 and RP2040W asynchronous MQTT client implementation. This library, ported to support ESP32, WT32_ETH01 (ESP32 + LAN8720), (ESP32 + LwIP W5500), (ESP32 + LwIP ENC28J60), ESP8266, Portenta_H7 (Ethernet or WiFi) and STM32 (LAN8742A or LAN8720 Ethernet), Teensy 4.1 using QNEthernet, RASPBERRY_PI_PICO_W with CYW43439 WiFi. Currently supporting TLS/SSL for ESP32 only",
"authors":
Expand Down Expand Up @@ -58,6 +58,12 @@
"version": ">=1.1.0",
"platforms": ["raspberrypi"]
},
{
"owner": "khoih-prog",
"name": "AsyncWebServer_RP2040W",
"version": ">=1.4.1",
"platforms": ["raspberrypi"]
},
{
"owner": "khoih-prog",
"name": "ESPAsync_WiFiManager",
Expand All @@ -73,13 +79,13 @@
{
"owner": "khoih-prog",
"name": "WebServer_ESP32_W5500",
"version": ">=1.5.1",
"version": ">=1.5.3",
"platforms": ["espressif32"]
},
{
"owner": "khoih-prog",
"name": "WebServer_ESP32_ENC",
"version": ">=1.5.1",
"version": ">=1.5.3",
"platforms": ["espressif32"]
},
{
Expand All @@ -101,7 +107,7 @@
],
"license": "MIT",
"frameworks": "*",
"platforms": ["espressif8266", "espressif32", "ststm32"],
"platforms": ["espressif8266", "espressif32", "ststm32", "raspberrypi", "teensy", "avr"],
"examples": "examples/*/*/*.ino",
"headers": ["AsyncMQTT_Generic.h"]
}
2 changes: 1 addition & 1 deletion library.properties
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=AsyncMQTT_Generic
version=1.8.0
version=1.8.1
author=Marvin ROGER,Khoi Hoang <[email protected]>
maintainer=Khoi Hoang <[email protected]>
sentence=Arduino Library for ESP8266, ESP32, Portenta_H7, STM32 and RP2040W asynchronous MQTT client implementation
Expand Down
10 changes: 6 additions & 4 deletions platformio/platformio.ini
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,11 @@ upload_protocol = picotool
lib_deps =
; PlatformIO 4.x
; AsyncTCP_RP2040W@>=1.1.0
; AsyncWebServer_RP2040W@>=1.4.1

; PlatformIO 5.x
khoih-prog/AsyncTCP_RP2040W@>=1.1.0
khoih-prog/AsyncWebServer_RP2040W@>=1.4.1

; ============================================================
; ============================================================
Expand Down Expand Up @@ -185,16 +187,16 @@ lib_deps =
; PlatformIO 4.x
; AsyncTCP@>=1.1.1
; AsyncTCP_SSL@>=1.3.1
; WebServer_ESP32_W5500@>=1.5.1
; WebServer_ESP32_ENC@>=1.5.1
; WebServer_ESP32_W5500@>=1.5.3
; WebServer_ESP32_ENC@>=1.5.3
; ESPAsync_WiFiManager@>=1.15.1

; PlatformIO 5.x
me-no-dev/AsyncTCP@>=1.1.1
khoih-prog/AsyncTCP_SSL@>=1.3.1
khoih-prog/WebServer_WT32_ETH01@>=1.5.1
khoih-prog/WebServer_ESP32_W5500@>=1.5.1
khoih-prog/WebServer_ESP32_ENC@>=1.5.1
khoih-prog/WebServer_ESP32_W5500@>=1.5.3
khoih-prog/WebServer_ESP32_ENC@>=1.5.3
khoih-prog/ESPAsync_WiFiManager@>=1.15.1

; ============================================================
Expand Down
11 changes: 6 additions & 5 deletions src/AsyncMqttClient_Generic.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
Built by Khoi Hoang https://github.com/khoih-prog/AsyncMqttClient_Generic
Version: 1.8.0
Version: 1.8.1
Version Modified By Date Comments
------- ----------- ---------- -----------
1.0.0 K Hoang 10/03/2022 Initial coding to support only ESP32 (with SSL) and ESP8266 (without SSL)
Expand All @@ -25,6 +25,7 @@
1.6.1 K Hoang 17/08/2022 Better workaround for RP2040W WiFi.status() bug using ping() to local gateway
1.7.0 K Hoang 13/09/2022 Fix ESP32 and ESP8266 compile error
1.8.0 K Hoang 30/11/2022 Add support to ESP32 boards using LwIP W5500 or ENC28J60 Ethernet
1.8.1 K Hoang 28/01/2023 Add AsyncWebServer_MQTT and AsyncWebServer_MQTT_RP2040W examples
*****************************************************************************************************************************/

#pragma once
Expand All @@ -43,15 +44,15 @@

/////////////////////////////////////////////////////////

#define ASYNC_MQTT_GENERIC_SHORT_VERSION "AsyncMQTT_Generic v1.8.0"
#define ASYNC_MQTT_GENERIC_SHORT_VERSION "AsyncMQTT_Generic v1.8.1"

/////////////////////////////////////////////////////////

#define ASYNC_MQTT_GENERIC_VERSION_MAJOR 1
#define ASYNC_MQTT_GENERIC_VERSION_MINOR 8
#define ASYNC_MQTT_GENERIC_VERSION_PATCH 0
#define ASYNC_MQTT_GENERIC_VERSION_PATCH 1

#define ASYNC_MQTT_GENERIC_VERSION_INT 1008000
#define ASYNC_MQTT_GENERIC_VERSION_INT 1008001

/////////////////////////////////////////////////////////

Expand Down
3 changes: 2 additions & 1 deletion src/AsyncMqttClient_Generic_Debug.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Built by Khoi Hoang https://github.com/khoih-prog/AsyncMqttClient_Generic
Version: 1.8.0
Version: 1.8.1
Version Modified By Date Comments
------- ----------- ---------- -----------
Expand All @@ -25,6 +25,7 @@
1.6.1 K Hoang 17/08/2022 Better workaround for RP2040W WiFi.status() bug using ping() to local gateway
1.7.0 K Hoang 13/09/2022 Fix ESP32 and ESP8266 compile error
1.8.0 K Hoang 30/11/2022 Add support to ESP32 boards using LwIP W5500 or ENC28J60 Ethernet
1.8.1 K Hoang 28/01/2023 Add AsyncWebServer_MQTT and AsyncWebServer_MQTT_RP2040W examples
*****************************************************************************************************************************/

#pragma once
Expand Down
3 changes: 2 additions & 1 deletion src/AsyncMqttClient_Generic_Impl.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Built by Khoi Hoang https://github.com/khoih-prog/AsyncMqttClient_Generic
Version: 1.8.0
Version: 1.8.1
Version Modified By Date Comments
------- ----------- ---------- -----------
Expand All @@ -25,6 +25,7 @@
1.6.1 K Hoang 17/08/2022 Better workaround for RP2040W WiFi.status() bug using ping() to local gateway
1.7.0 K Hoang 13/09/2022 Fix ESP32 and ESP8266 compile error
1.8.0 K Hoang 30/11/2022 Add support to ESP32 boards using LwIP W5500 or ENC28J60 Ethernet
1.8.1 K Hoang 28/01/2023 Add AsyncWebServer_MQTT and AsyncWebServer_MQTT_RP2040W examples
*****************************************************************************************************************************/

#pragma once
Expand Down
3 changes: 2 additions & 1 deletion src/AsyncMqtt_Generic.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Built by Khoi Hoang https://github.com/khoih-prog/AsyncMqttClient_Generic
Version: 1.8.0
Version: 1.8.1
Version Modified By Date Comments
------- ----------- ---------- -----------
Expand All @@ -25,6 +25,7 @@
1.6.1 K Hoang 17/08/2022 Better workaround for RP2040W WiFi.status() bug using ping() to local gateway
1.7.0 K Hoang 13/09/2022 Fix ESP32 and ESP8266 compile error
1.8.0 K Hoang 30/11/2022 Add support to ESP32 boards using LwIP W5500 or ENC28J60 Ethernet
1.8.1 K Hoang 28/01/2023 Add AsyncWebServer_MQTT and AsyncWebServer_MQTT_RP2040W examples
*****************************************************************************************************************************/

#pragma once
Expand Down

0 comments on commit 48a17e0

Please sign in to comment.