Clients

Manage active UDP client connections

Add a UDP client connection

post

Registers a new UDP destination (IPv4 address + port). The ESP32 will start forwarding serial data to this endpoint immediately. Optionally persists the entry to NVM so it survives reboots.

Body

application/json

ipstring · ipv4Required

IPv4 address of the UDP destination

Example: 192.168.2.255

portinteger · min: 1 · max: 65535Required

UDP destination port

Example: 14550

savebooleanOptional

If true, persist this client to NVM so it is restored after a reboot. Only one entry can be persisted at a time.

Default: false

Responses

200

Result of the add operation

application/json

Generic status/message response used by several endpoints

statusstring · enumOptionalExample: successPossible values:

msgstringOptionalExample: Settings changed! Rebooting ...

400

Request body too large

text/plain

500

Internal server error while receiving data

text/plain

post

/api/settings/clients/udp

HTTPcURLJavaScriptPython

POST /api/settings/clients/udp HTTP/1.1
Host: 192.168.2.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "ip": "192.168.2.255",
  "port": 14550,
  "save": true
}

{
  "status": "success",
  "msg": "Added UDP connection!"
}

Remove all UDP client connections

delete

Clears the entire in-memory UDP client list and erases the single persisted UDP client from NVM. Ground-control software will need to re-register after this call.

Responses

200

All UDP clients removed successfully

application/json

Generic status/message response used by several endpoints

statusstring · enumOptionalExample: successPossible values:

msgstringOptionalExample: Settings changed! Rebooting ...

delete

/api/settings/clients/clear_udp

HTTPcURLJavaScriptPython

DELETE /api/settings/clients/clear_udp HTTP/1.1
Host: 192.168.2.1
Accept: */*

200

All UDP clients removed successfully

{
  "status": "success",
  "msg": "Removed all UDP clients"
}