Improving README.md #29
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
per1234
requested changes
Feb 9, 2019
Co-Authored-By: umbynos <34278123+umbynos@users.noreply.github.com>
AlbyIanna
reviewed
Feb 14, 2019
README.md
Outdated
|
|
||
| - `disconnect()` stops the MQTT Client | ||
|
|
||
| - The `update()` function checks the connnection with the MQTT broker, retrieve data from it and pushes back data using `writeProperties()`. `update()` is called periodically in the loop of .ino file. |
There was a problem hiding this comment.
@umbynos I'd change the last sentence with something like "update() SHOULD BE called periodically in the loop() function."
AlbyIanna
reviewed
Feb 14, 2019
README.md
Outdated
|
|
||
| - The `update()` function checks the connnection with the MQTT broker, retrieve data from it and pushes back data using `writeProperties()`. `update()` is called periodically in the loop of .ino file. | ||
|
|
||
| - `connected()` simply returns the current status of the MQTT connection. |
There was a problem hiding this comment.
@umbynos is this function returning just true or false or are there more statuses? I think we should write exactly what it's returning
AlbyIanna
reviewed
Feb 14, 2019
README.md
Outdated
|
|
||
| - `reconnect(Client&)` clean up existing MQTT connection, create a new one and initialize it by calling `connect()` | ||
|
|
||
| - `writeProperties(const byte data[], int length)` writes message to the MQTT Broker |
There was a problem hiding this comment.
@umbynos can this definition be more specific?
|
folks, I think this can be merged in |
per1234
requested changes
Feb 20, 2019
|
@ubidefeo I did another review of the updated text and requested some changes. Hopefully umbynos can take a minute to consider these suggestions before this is merged. Thanks for taking action on my previous suggestions! |
Co-Authored-By: umbynos <34278123+umbynos@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I started improving
README.mdupon request of @mattiabertorello. I will include a basic explanation of the Arduino IoT Cloud, and then an explanation of most important functions in the library. Would that be ok?