In this project, you will use the Antares Workshop Shield on the Lynx-32 Development Board module. In this Antares Shield Workshop, there are temperature, humidity (DHT11), relay, LED and push button sensors. You will monitor the temperature and humidity according to the specified interval period. The results of the data sent by the sensors can be monitored through the Antares console.
Prerequisites
The materials required follow the General Prerequisites on the previous page. If you have not prepared the requirements on that page, then you can visit the following page.
You can open the programme code in the Arduino IDE via File > Examples > Antares ESP MQTT > Lynx32-Simple-Project > RETRIEVE_DATA_OLED.
Here is the RETRIEVE_DATA_OLED example programme code.
3. Set WiFi Credential and Antares Credential in Program Code
Change the HTTP Protocol parameters in the following variables *ACCESSKEY, *WIFISSID, *PASSWORD, *projectName, and *deviceName. Adjust to the parameters in the Antares console.
The *Access key parameter is obtained from your Antares account page.
Access Key Location on Antares Account Page
The WIFISSID parameter is obtained from the Wi-Fi/Hotspot name that will be used by the Lynx-32 Development Board. An example is shown below.
WIFISSID
The *PASSWORD parameter is obtained from the Wi-Fi password you are currently using.
The parameters *projectName and *deviceName are obtained from the Application Name and Device Name that have been created in the Antares account.
Application Name Display
Device Name Display
4. Compile and Upload Program
Connect the Lynx-32 with your computer and make sure the Communication Port is read.
On Windows operating systems the check can be done via Device Manager. If your Lynx-32 is read then the USB-Serial CH340 appears with the port adjusting the port availability (in this case it reads COM4).
Device Manager Display
Set up the ESP32 board by clicking Tools > Board > esp32 in the Arduino IDE, then make sure the ESP32 Dev Module is used. Select the port according to the communication port that is read (in this case COM4). The result will look like the following image.
Display of Board Specifications and Ports Used
After all the setup is complete, upload the programme by pressing the arrow icon as shown below. Wait for the compile and upload process to finish
Compile Icon for Tick and Upload Icon for Arrow
The Tick icon on the Arduino IDE is just the verify process. Usually used to Compile the programme to find out whether there are errors or not.
The Arrow icon on the Arduino IDE is the verify and upload process. Usually used to Compile the programme as well as Flash the programme to the target board.
If the programme upload is successful, it will look like the following image.
Arduino IDE page image after successful upload
After uploading the programme, you can view the serial monitor to debug the programme. The serial monitor icon is shown in the following image.
Serial Monitor Icon
Set the serial baud rate to 115200 and select BothNL & CR. The result will look like the following image.
Serial Monitor Display
Make sure the serial baud rate matches the value defined in the programme code. If the serial baud rate is not the same between the programme code and the serial monitor, the ASCII characters will not be read properly.
5. MQTTX Software Setup
Open the MQTTX App, then select New Connection
Creating a New Connection
In order to configure MQTTX with Antares broker, adjust the Name, Host and Port as shown below, then click Connect.
Antares MQTT Broker Configuration
If it is connected, there is a notification as shown below
Antares Broker MQTTX Connected
Enter Topic and Payload in the fields in MQTTX.
Topic and Payload pages in MQTTX
Field
Value
Topic
/oneM2M/req/your-access-key/antares-cse/json
Payload
Customise your-access-key, your-application-name, and your-device-name to the names registered to your Antares account. Fill in the "Field" data and "Value" data in "con" as you wish.
In the MQTTX software, enter the Topic and Payload that you want to use. Then click Publish to send the message from MQTTX to the Antares server.
Publish to send the message to the Antares server
6. Sending MQTTX Messages to Antares Server
After the MQTTX software setup is complete, it's time to send the PUBLISH command. The "Test" field is filled with the string "Hello Antares" as the message that will be sent via the MQTT protocol to the Antares server.
If you have finished filling in the "Test" field, then press the Publish button on the MQTTX software, as shown below.
Image of MQTTX Payload content
Publish to send the message to the Antares server
Notification Message Published
7. Check Data in Antares
After uploading the programme successfully, then open the device antares page and see if the data has been successfully sent.
Image of the Antares Console Page When Data is Successfully Received.
The data received by LYNX-32 with the MQTT protocol is in the form of Test variables.
8. View Retrieve Message
Retrieve data from the Antares IoT Platform and display it on the OLED display after connecting to Wi-Fi as shown in the figure below:
#include <AntaresESPMQTT.h> // Import the AntaresESPMQTT library for communication with Antares
#include <Adafruit_SSD1306.h> // Import the Adafruit_SSD1306 library for controlling the OLED display
#define ACCESSKEY "YOUR-ACCESS-KEY" // Antares account access key
#define WIFISSID "YOUR-WIFI-SSID" // Wi-Fi SSID to connect to
#define PASSWORD "YOUR-WIFI-PASSWORD" // Wi-Fi password
#define projectName "YOUR-APPLICATION-NAME" // Name of the application created in Antares
#define deviceName "YOUR-DEVICE-NAME" // Name of the device created in Antares
AntaresESPMQTT antares(ACCESSKEY); // Initialize the AntaresESPMQTT object with the access key
#define SCREEN_WIDTH 128 // OLED display width
#define SCREEN_HEIGHT 64 // OLED display height
#define OLED_RESET -1 // OLED display reset pin
Adafruit_SSD1306 display(SCREEN_WIDTH, SCREEN_HEIGHT, &Wire, OLED_RESET); // Initialize the display object
void callback(char topic[], byte payload[], unsigned int length) {
// Callback function to be executed when a message is received
antares.get(topic, payload, length);
Serial.println("New Message!");
Serial.println("Topic: " + antares.getTopic());
Serial.println("Payload: " + antares.getPayload());
String receivedData = antares.getString("Test");
Serial.println("Received: " + receivedData);
display.clearDisplay();
display.setTextSize(1);
display.setTextColor(SSD1306_WHITE);
display.setCursor(0, 0);
display.println("Received: " + receivedData);
display.display();
}
void setup() {
Serial.begin(115200); // Start serial communication at baud rate 115200
antares.setDebug(true); // Enable debug mode for Antares
antares.wifiConnection(WIFISSID, PASSWORD); // Connect to Wi-Fi using SSID and password
antares.setMqttServer(); // Set up the Antares MQTT server
antares.setCallback(callback); // Set the callback function for MQTT messages
if (!display.begin(SSD1306_SWITCHCAPVCC, 0x3C)) { // Initialize the OLED display
Serial.println(F("SSD1306 allocation failed")); // Display a message if OLED initialization fails
for (;;) ; // Halt the program
}
display.clearDisplay(); // Clear the OLED display
display.setTextSize(1); // Set text size
display.setTextColor(SSD1306_WHITE); // Set text color
display.setCursor(0, 0); // Set text cursor position
display.println("Waiting for data..."); // Display initial message
display.display(); // Show the message on the display
}
void loop() {
antares.checkMqttConnection(); // Check MQTT connection to Antares
}
#define ACCESSKEY "YOUR-ACCESS-KEY" // Replace with your Antares account access key
#define WIFISSID "YOUR-WIFI-SSID" // Replace with your Wi-Fi SSID
#define PASSWORD "YOUR-WIFI-PASSWORD" // Replace with your Wi-Fi password
#define projectName "YOUR-APPLICATION-NAME" // Replace with the Antares application name that was created
#define deviceName "YOUR-DEVICE-NAME" // Replace with the Antares device name that was created
