Skip to content

Commit 70c596b

Browse files
committed
v1.0.6-QOS0: update reamdme.md and library.properties to info about the new esp8266 compatibility
1 parent 16bd285 commit 70c596b

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
1-
[![Esp32](https://img.shields.io/badge/platform-ESP32-green)](https://www.espressif.com/en/products/socs/esp32)
1+
[![Esp32](https://img.shields.io/badge/soc-ESP32-green)](https://www.espressif.com/en/products/socs/esp32)
2+
[![Esp8266](https://img.shields.io/badge/soc-ESP8266-green)](https://www.espressif.com/en/products/socs/esp8266)
23
[![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)
34
![QoS](https://img.shields.io/badge/QoS-0-red)
45
[![Arduino](https://img.shields.io/badge/platform-Arduino-green)](https://www.arduino.cc/)
56
![C++](https://img.shields.io/badge/-C%2B%2B-blue)
67
![FreeRTOS](https://img.shields.io/badge/-FreeRTOS-blue)
7-
88
[![Release](https://img.shields.io/github/v/release/alexCajas/EmbeddedMqttBroker)](https://github.com/alexCajas/embeddedMqttBroker/releases/latest)
9-
109
[![arduino-library-badge](https://www.ardu-badge.com/badge/EmbeddedMqttBroker.svg?)](https://www.ardu-badge.com/EmbeddedMqttBroker)
11-
1210
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/alexCajas/library/EmbeddedMqttBroker.svg)](https://registry.platformio.org/libraries/alexCajas/EmbeddedMqttBroker)
1311

1412
# EmbeddedMqttBroker
1513

16-
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.
14+
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.
15+
16+
**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).
17+
1718

1819
## Usage examples sketches
1920

@@ -25,7 +26,7 @@ This is a **Mqtt broker** developed for embedded devices, in **c++** programming
2526

2627
* You can install this, from arduino library manager, searching **embeddedmqttbroker**.
2728

28-
* From platformIO using **alexcajas/EmbeddedMqttBroker@^1.0.1**
29+
* From platformIO using **alexcajas/EmbeddedMqttBroker@^1.0.6**
2930

3031
* Or downloading this repo and [https://github.com/alexCajas/WrapperFreeRTOS] manually.
3132

@@ -34,6 +35,7 @@ This is a **Mqtt broker** developed for embedded devices, in **c++** programming
3435
* main: Here is the last version of the project.
3536
* main-QOS0: Functional and tested version that only implements QOS 0.
3637

38+
3739
## Can't see broker activity outputs on Serial monitor?
3840

3941
* 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...

library.properties

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
name=EmbeddedMqttBroker
2-
version=1.0.5-qos0
2+
version=1.0.6-qos0
33
author=Alex Cajas <alexcajas505@gmail.com>
44
maintainer=Alex Cajas <alexcajas505@gmail.com>
5-
sentence= Mqtt Broker for embedded systems, developed and tested on an Esp32.
6-
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.
5+
sentence= Mqtt Broker for embedded systems, tested on an Esp32 and esp8266.
6+
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.
77
category=Communication
88
url=https://github.com/alexCajas/EmbeddedMqttBroker.git
99
architectures=*

0 commit comments

Comments
 (0)