diff --git a/Message-Queue-Endpoint.md b/Message-Queue-Endpoint.md index 2cf0327..d3e67bf 100644 --- a/Message-Queue-Endpoint.md +++ b/Message-Queue-Endpoint.md @@ -14,19 +14,9 @@ To follow along with the examples, you need: Generally the URN is composed of the company or brand name and a device serial number like so: `urn:dev::` -To run the python example code you also need to install the `paho-mqtt` and the `protobuf` modules. -These can be installed with the following commands: +To run the python example code you also need to install the `paho-mqtt` and the `protobuf` modules. +If you need help on installing this, please see the FAQ at the end. -**Windows command prompt:** -``` -py -m pip install 'paho-mqtt==1.5.0' -py -m pip install 'protobuf==3.11.0' -``` -**Linux terminal:** -``` -python3 -m pip install 'paho-mqtt==1.5.0' -python3 -m pip install 'protobuf==3.11.0' -``` ### Workflow The general workflow for pushing data to the FarmMaps MQTT endpoint consists of: * Preparing your data as a protobuf message @@ -88,4 +78,19 @@ To quote the Google Documentation: > Protocol buffers are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data – think XML, but smaller, faster, and simpler. > You define how you want your data to be structured once, then you can use special generated source code to easily write and read your structured data to and from a variety of data streams and using a variety of languages. -More information can be found in the [protobuf documentation](https://developers.google.com/protocol-buffers/docs/overview). \ No newline at end of file +More information can be found in the [protobuf documentation](https://developers.google.com/protocol-buffers/docs/overview). + +#### How do I install the required Python modules? +This tutorial requires the `paho-mqtt` and `protobuf` modules. +These can be installed with the following commands: + +**Windows command prompt:** +``` +py -m pip install 'paho-mqtt==1.5.0' +py -m pip install 'protobuf==3.11.0' +``` +**Linux terminal:** +``` +python3 -m pip install 'paho-mqtt==1.5.0' +python3 -m pip install 'protobuf==3.11.0' +``` \ No newline at end of file