From 70c596b8f756a3d6fec768feaf59c415a6008f30 Mon Sep 17 00:00:00 2001 From: alex cajas Date: Tue, 24 Oct 2023 00:05:21 +0200 Subject: [PATCH] v1.0.6-QOS0: update reamdme.md and library.properties to info about the new esp8266 compatibility --- README.md | 14 ++++++++------ library.properties | 6 +++--- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2228e3e..01b51d8 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,20 @@ -[![Esp32](https://img.shields.io/badge/platform-ESP32-green)](https://www.espressif.com/en/products/socs/esp32) +[![Esp32](https://img.shields.io/badge/soc-ESP32-green)](https://www.espressif.com/en/products/socs/esp32) +[![Esp8266](https://img.shields.io/badge/soc-ESP8266-green)](https://www.espressif.com/en/products/socs/esp8266) [![Mqtt 3.1.1](https://img.shields.io/badge/Mqtt-%203.1.1-yellow)](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/os/mqtt-v3.1.1-errata01-os-complete.html#_Toc442180822) ![QoS](https://img.shields.io/badge/QoS-0-red) [![Arduino](https://img.shields.io/badge/platform-Arduino-green)](https://www.arduino.cc/) ![C++](https://img.shields.io/badge/-C%2B%2B-blue) ![FreeRTOS](https://img.shields.io/badge/-FreeRTOS-blue) - [![Release](https://img.shields.io/github/v/release/alexCajas/EmbeddedMqttBroker)](https://github.com/alexCajas/embeddedMqttBroker/releases/latest) - [![arduino-library-badge](https://www.ardu-badge.com/badge/EmbeddedMqttBroker.svg?)](https://www.ardu-badge.com/EmbeddedMqttBroker) - [![PlatformIO Registry](https://badges.registry.platformio.org/packages/alexCajas/library/EmbeddedMqttBroker.svg)](https://registry.platformio.org/libraries/alexCajas/EmbeddedMqttBroker) # EmbeddedMqttBroker -This is a **Mqtt broker** developed for embedded devices, in **c++** programming language, **FreeRTOS**, **arduino core** and tested in an **Esp32**. **This project include** [https://github.com/alexCajas/WrapperFreeRTOS] to implement concurrent C++ objects. +This is a **Mqtt broker** developed for embedded devices, in **c++** programming language, **FreeRTOS** to use advanced multitasking capabilities and **arduino core**. Tested in an **Esp32** and **esp8266 wemos D1**. **This project include** [https://github.com/alexCajas/WrapperFreeRTOS] to implement concurrent C++ objects. + +**To use this library with esp8266** you have to use [esp8266RTOSArduCore](https://github.com/alexCajas/esp8266RTOSArduCore), it is a arduino core based on [esp8266_rtos_sdk](https://github.com/espressif/ESP8266_RTOS_SDK). **This library is not compatible with the official** [NONOSDK esp8266 arduino core](https://github.com/esp8266/Arduino). + ## Usage examples sketches @@ -25,7 +26,7 @@ This is a **Mqtt broker** developed for embedded devices, in **c++** programming * You can install this, from arduino library manager, searching **embeddedmqttbroker**. -* From platformIO using **alexcajas/EmbeddedMqttBroker@^1.0.1** +* From platformIO using **alexcajas/EmbeddedMqttBroker@^1.0.6** * Or downloading this repo and [https://github.com/alexCajas/WrapperFreeRTOS] manually. @@ -34,6 +35,7 @@ This is a **Mqtt broker** developed for embedded devices, in **c++** programming * main: Here is the last version of the project. * main-QOS0: Functional and tested version that only implements QOS 0. + ## Can't see broker activity outputs on Serial monitor? * Since 6e0b3b8 commit, this library use **esp32-hal-log.h** to show broker activity outputs like new clients id, topis to subscribe, to pusblish etc... diff --git a/library.properties b/library.properties index af5723c..7906c17 100644 --- a/library.properties +++ b/library.properties @@ -1,9 +1,9 @@ name=EmbeddedMqttBroker -version=1.0.5-qos0 +version=1.0.6-qos0 author=Alex Cajas maintainer=Alex Cajas -sentence= Mqtt Broker for embedded systems, developed and tested on an Esp32. -paragraph=This library is developed with arduino core, FreeRTOS and use alexCajas/WrapperFreeRTOS library, to implement concurrent C++ objects. Currently, it supports Mqtt 3.1.1 and QoS 0. QoS 1 and QoS 2 are still under development. You can use this library in other architectures supported by FreeRtos and arduino core, but for now it is only tested on an Esp 32. +sentence= Mqtt Broker for embedded systems, tested on an Esp32 and esp8266. +paragraph=This library is developed with arduino core, FreeRTOS and use alexCajas/WrapperFreeRTOS library, to implement concurrent C++ objects. Currently, it supports Mqtt 3.1.1 and QoS 0. QoS 1 and QoS 2 are still in development. You can use this library in other architectures supported by FreeRtos and arduino core, like esp32 arduino core or esp8266 using esp8266RTOSArduCore. category=Communication url=https://github.com/alexCajas/EmbeddedMqttBroker.git architectures=*