diff --git a/Message-Queue-Endpoint.md b/Message-Queue-Endpoint.md index 2c48196..858a42d 100644 --- a/Message-Queue-Endpoint.md +++ b/Message-Queue-Endpoint.md @@ -4,7 +4,7 @@ The same workflow can be followed for different languages, as long as there's a FarmMaps provides an MQTT endpoint to allow your application to send signals to FarmMaps, and listen for events. These signals are collected in a "message queue". -If you are not familiar with message queues or protobuff, please see the [FAQ](#faq) at the end. +If you are not familiar with anything mentioned, please see the [FAQ](#faq) at the end. ### Prerequisites To follow along with the examples, you need: @@ -15,7 +15,6 @@ 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. -If you need help on installing this, please see the [FAQ](#faq) at the end. ### Workflow The general workflow for pushing data to the FarmMaps MQTT endpoint consists of: @@ -45,11 +44,10 @@ To connect to the MQTT Broker, we'll use the following settings: All settings are required. - -### Example: Pushing Live Tractor Data -To create messages and connect to the broker we will need the following settings: +For preparing the message, we'll use the following settings: **Message settings** + | Parameter | Default | Description | | :---: | :------------------------------------------: | --- | | META_DATA_URL | `https:///` | HTTP adress where a JSON metadata file for the messages is provided (by the data source). | @@ -57,6 +55,11 @@ To create messages and connect to the broker we will need the following settings All settings are required except for the `META_DATA_URL`, this parameter is optional. + +### Example: Pushing Live Tractor Data +To create messages and connect to the broker we will need the following settings: + + ## [FAQ](#faq) #### How do I install the required Python modules? This tutorial requires the `paho-mqtt` and `protobuf` modules.