diff --git a/examples/mqtt_arbitrary_buffer/README.md b/examples/mqtt_arbitrary_buffer/README.md index 2dfeb70..b3ad330 100644 --- a/examples/mqtt_arbitrary_buffer/README.md +++ b/examples/mqtt_arbitrary_buffer/README.md @@ -1,4 +1,21 @@ # Adafruit MQTT Library example with support -This example shows how an esp8266 can publish an arbitrary buffer to an MQTT -feed which can then be parsed by a subscribed python client. +This example illustrates Publish an arbitrary data packet using the Adafruit MQTT library to an MQTT feed which can then be parsed by the included python subscriber client. + +To run the python subscriber: + +Install dependents if haven't already +'''bash +cd ../Adafruit_MQTT_Library/examples/mqtt_arbitrary_buffer/python_subscriber +pip install -r requirements.txt +''' + +Run python script with default values +'''bash +python subscriber.py +''' + +Use help to list the modifiable options +'''bash +python subscriber.py -h +'''