amr/mqtt
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixed the markdown in README

Browse source
This commit is contained in:
AMRowsell 2018-08-16 19:01:14 +00:00
commit f0d14dc2cb
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -1,6 +1,6 @@
# MQTT Library for ESP8266 SDK # MQTT Library for ESP8266 SDK
written by Alexander Rowsell (MrAureliusR) written by Alexander Rowsell (MrAureliusR)
Released under the terms of the MIT License -- see LICENSE for more detail. Released under the terms of the MIT License -- see [LICENSE](LICENSE) for more detail.
## Summary ## Summary
While working on a series of tutorials for Hackaday, I realized MQTT would be the perfect solution for one of the projects I was presenting. However, I didn't want to use a pre-existing MQTT library - that would be boring, and I wouldn't be able to teach the readers as much. Instead, I started to write one from scratch. While working on a series of tutorials for Hackaday, I realized MQTT would be the perfect solution for one of the projects I was presenting. However, I didn't want to use a pre-existing MQTT library - that would be boring, and I wouldn't be able to teach the readers as much. Instead, I started to write one from scratch.
@ -25,5 +25,5 @@ This is the main structure that contains all the information about the connectio
## API Functions ## API Functions
###mqtt\_connect(mqtt\_session\_t *session, uint8\_t *username, uint8\_t *password) ### `mqtt_connect(mqtt_session_t *session, uint8_t *username, uint8_t *password)`
This function establishes a TCP connection with the server specified in session->ip, on session->port. Most MQTT brokers listen on port 1883 for unencrypted packets, and on 8883 for TLS connections. This API currently only supports unencrypted packets on 1883. However, the port still needs to be specified, in case you use a non standard port. This function establishes a TCP connection with the server specified in session->ip, on session->port. Most MQTT brokers listen on port 1883 for unencrypted packets, and on 8883 for TLS connections. This API currently only supports unencrypted packets on 1883. However, the port still needs to be specified, in case you use a non standard port.