Skip to content

Commit 6ea40ee

Browse files
committed
updated README.md and library.properties
1 parent 8b95874 commit 6ea40ee

File tree

2 files changed

+18
-12
lines changed

2 files changed

+18
-12
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# MQTT Client library for ESP8266 Arduino
22

3-
This is MQTT client library for ESP8266, using mqtt_msg package from [MQTT client library for Contiki](https://github.com/esar/contiki-mqtt) and use for ESP8266 NON-OS SDK [esp_mqtt](https://github.com/tuanpmt/esp_mqtt)
3+
This is a fork of https://github.com/tuanpmt/ESP8266MQTTClient
4+
5+
This is an MQTT client library for ESP8266, using mqtt_msg package from [MQTT client library for Contiki](https://github.com/esar/contiki-mqtt) for use with the ESP8266 NON-OS SDK [esp_mqtt](https://github.com/tuanpmt/esp_mqtt)
46

57
Features:
68

@@ -12,17 +14,21 @@ Features:
1214

1315
## Status
1416
- Support 3 type of qos (0, 1, 2) and outbox
15-
- only mqtt over TCP
17+
- Supports MQTT over TCP, TLS, Websocket and Secure Websocket
1618

1719
## MQTT URI Scheme
1820

19-
- `mqtt://[username][:password@]hostname[:port][#clientId]`
20-
+ `mqtt` for MQTT over TCP
21+
- `mqtt://hostname[:port]`
22+
+ `mqtt` for MQTT over TCP
23+
+ `mqtts` for MQTT over TLS
2124
+ `ws` for MQTT over Websocket
25+
+ `wss` for MQTT over Secure Websocket
26+
+ port is 1883 by default
27+
+ client_id is `"ESP_" + ESP.getChipId()` by default
2228
- Example:
23-
+ **Full** `mqtt://username:password@test.mosquitto.org:1883`
24-
+ **Websocket** `ws://username:password@test.mosquitto.org:1883/mqtt`
25-
+ **Minimal** `mqtt://test.mosquitto.org`, with `user`, `pass` = NULL, port = 1883, client id = "ESP_" + ESP.getChipId()
29+
+ **Full** `mqtt://test.mosquitto.org:1883`
30+
+ **Websocket** `ws://test.mosquitto.org:1883/mqtt`
31+
+ **Minimal** `mqtt://test.mosquitto.org` (port = 1883)
2632

2733
## API
2834
### Setup
@@ -58,7 +64,7 @@ Features:
5864

5965
## License
6066

61-
Copyright (c) 2016 Tuan PM (https://twitter.com/tuanpmt)
67+
Copyright (c) 2016 Tuan PM (https://twitter.com/tuanpmt)
6268
ESP8266 port (c) 2016 Ivan Grokhotkov ([email protected])
6369

64-
License Apache License
70+
License Apache License

library.properties

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
name=ESP8266MQTTClient
2-
version=1.0.5
2+
version=1.1.0
33
author=Tuan PM
4-
maintainer=Tuan PM
4+
maintainer=LolHens
55
sentence=MQTT Client for ESP8266
66
paragraph=
77
category=Communication
8-
url=https://github.com/tuanpmt/ESP8266MQTTClient
8+
url=https://github.com/LolHens/ESP8266MQTTClient
99
architectures=esp8266

0 commit comments

Comments
 (0)