Skip to content

Commit

Permalink
v1.0.6-QOS0: update reamdme.md and library.properties to info about t…
Browse files Browse the repository at this point in the history
…he new esp8266 compatibility
  • Loading branch information
alexCajas committed Oct 23, 2023
1 parent 16bd285 commit 70c596b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.

Expand All @@ -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...
Expand Down
6 changes: 3 additions & 3 deletions library.properties
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name=EmbeddedMqttBroker
version=1.0.5-qos0
version=1.0.6-qos0
author=Alex Cajas <[email protected]>
maintainer=Alex Cajas <[email protected]>
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=*
Expand Down

0 comments on commit 70c596b

Please sign in to comment.