mongoose/resources/I-CUBE-Mongoose

Mongoose CubeMX pack

This pack provides an easy to use CubeMX integration.

Mongoose Networking Core

This module installs Mongoose Library itself: mogoose.c, mongoose.h and mongoose_config.h. It is required for any other module to work. Below are the steps to make it work with you CubeMX application:

Configure peripherals

In CubeMX, configure USART (for debug), RNG (for TLS), ETH.

Enable debug logs

Open Core/Src/main.c and add this snippet:

/* USER CODE BEGIN 0 */
int _write(int fd, unsigned char *buf, int len) {
  HAL_UART_Transmit(&huart3, buf, len, HAL_MAX_DELAY);
  return len;
}
/* USER CODE END 0 */

Call Mongoose

Open Core/Src/main.c. Add at the top of the file:

/* USER CODE BEGIN Includes */
#include "mongoose.h"
/* USER CODE END Includes */

Inside main() function:

Inside the `main()` function:

```c
/* USER CODE BEGIN WHILE */
struct mg_mgr mgr;
mg_mgr_init(&mgr);

while (1)
{
  mg_mgr_poll(&mgr, 1);
/* USER CODE END WHILE */

This starts the TCP/IP stack. In the serial console logs, you should see something like this:

0      2 mongoose.c:26153:mg_phy_init   PHY ID: 0x07 0xc131 (LAN87x)
6      2 mongoose.c:5834:mg_mgr_init    Driver: stm32h, MAC: 2a:37:94:03:d5:74
d      3 mongoose.c:5841:mg_mgr_init    MG_IO_SIZE: 512, TLS: builtin
13     3 mongoose.c:5758:mg_listen      1 0 http://0.0.0.0:80
19     1 mongoose.c:6260:onstatechange  Link down
7d6    3 mongoose.c:28424:mg_tcpip_driv Link is 100M full-duplex
7db    3 mongoose.c:6404:tx_dhcp_discov DHCP discover sent. Our MAC: 2a:37:94:03:d5:74
831    3 mongoose.c:6382:tx_dhcp_reques DHCP req sent
836    2 mongoose.c:6559:rx_dhcp_client Lease: 3600 sec (3602)
83c    2 mongoose.c:6249:onstatechange  READY, IP: 192.168.2.31
842    2 mongoose.c:6250:onstatechange         GW: 192.168.2.1
847    2 mongoose.c:6253:onstatechange        MAC: 2a:37:94:03:d5:74

Now, you should be able to ping your device. However, it runs no network services.

Add hello world HTTP server

Let's add the simplest web server possible. After the mg_mgr_init() call, add one more line to start the HTTP listener:

mg_mgr_init(&mgr);
mg_http_listen(&mgr, "http://0.0.0.0:80", http_ev_handler, NULL);

And after the _write() override, add this HTTP event handler function:

static void http_ev_handler(struct mg_connection *c, int ev, void *ev_data) {
  if (ev == MG_EV_HTTP_MSG) {
    mg_http_reply(c, 200, "", "Hi from Mongoose! Tick %lu\r\n", HAL_GetTick());
  }
}

Rebuild, reflash your board, open the device's IP address in the browser, and see the message displayed, something like:

Hi from Mongoose! Tick 38187

Add full device dashboard

Enable "Mongoose Web Device Dashboard" component in CubeMX. Regenerate code. This component installs the following files:

• dashboard.c - a C backend side
• dashboard.html - an HTML frontend side: the Web UI itself
• file_data.c - this file is generated from dashboard.html
• html2c.js - a node.js script that generates file_data.c using this command: node html2c.js dashboard.html -o file_data.c. This script first inlines all external resources into an amalgamated HTML file - so it does not depend on anything external, and then zips it and packs into a Mongoose embedded filesystem. This way it takes the minimum space on flash.

Remove the hello world server if you added it. Modify your while loop to look like this:

/* USER CODE BEGIN WHILE */
struct mg_mgr mgr;
mg_mgr_init(&mgr);
mg_dash_init(&mgr);

while (1)
{
  mg_mgr_poll(&mgr, 1);
  mg_dash_poll(&mgr);
/* USER CODE END WHILE */

Rebuild, reflash your board and enjoy the fully functional device dashboard that you can tailor to your firmware.

To customise your dashboard, edit dashboard.c and dashboard.html. After editing dashboard.html, regenerate file_data.c using this command:

node html2c.js dashboard.html -o file_data.c

For agentic development, use https://github.com/cesanta/mongoose/tree/master/resources/AGENTS.md Use a prompt like this:

Read and apply https://github.com/cesanta/mongoose/tree/master/resources/AGENTS.md

Add MQTT Client

Enable "Mongoose MQTT Client" component in CubeMX. Regenerate code.

Add MQTT init and poll to your while loop:

/* USER CODE BEGIN WHILE */
struct mg_mgr mgr;
mg_mgr_init(&mgr);
mg_mqtt_init(&mgr);

while (1)
{
  mg_mgr_poll(&mgr, 1);
  mg_mqtt_poll(&mgr);
/* USER CODE END WHILE */

Rebuild, reflash your board. This MQTT Client connects to the HiveMQ public MQTT broker - see mongoose_mqtt.c file for details. Also it add a JSON-RPC "ota.update" function via MQTT, so you can update your firmware over MQTT, see https://mongoose.ws/mqtt/