> For the complete documentation index, see [llms.txt](https://dronebridge.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dronebridge.gitbook.io/docs/dronebridge-for-esp32-drone-light-show-edition/developers-dlse-api-definition/system.md).

# System

Read-only system information and runtime statistics

## Get build and hardware information

> Returns ESP-IDF version, firmware build/version numbers, chip model, MAC address, license status, activation key, and whether serial is tunnelled over JTAG.<br>

```json
{"openapi":"3.0.3","info":{"title":"DroneBridge ESP32 REST API","version":"1.0.0"},"tags":[{"name":"System","description":"Read-only system information and runtime statistics"}],"servers":[{"url":"http://192.168.2.1","description":"Default ESP32 AP address"}],"paths":{"/api/system/info":{"get":{"tags":["System"],"summary":"Get build and hardware information","description":"Returns ESP-IDF version, firmware build/version numbers, chip model, MAC address, license status, activation key, and whether serial is tunnelled over JTAG.\n","operationId":"getSystemInfo","responses":{"200":{"description":"System info retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemInfo"}}}}}}}},"components":{"schemas":{"SystemInfo":{"type":"object","description":"Static build and hardware information","properties":{"idf_version":{"type":"string","description":"ESP-IDF version string"},"db_build_version":{"type":"number","description":"Monotonic build number"},"major_version":{"type":"number"},"minor_version":{"type":"number"},"patch_version":{"type":"number"},"maturity_version":{"type":"string","description":"Release maturity label (e.g. \"release\", \"beta\", \"rc1\")"},"license_type":{"type":"string","description":"Human-readable license type"},"expiration_date":{"type":"string","description":"License expiration date as a formatted string, or \"Never\" for perpetual licenses, or a remaining-time string for trial licenses.\n"},"activation_key":{"type":"string","description":"Base64-encoded activation key for this device"},"esp_chip_model":{"type":"number","description":"Numeric chip id, 5=ESP32C3, 13=ESP32C6, 23=ESP32C5","enum":[5,13,23]},"has_rf_switch":{"type":"number","description":"1 if an RF switch is present on the board, 0 otherwise","enum":[0,1]},"esp_mac":{"type":"string","description":"Primary MAC address of the ESP32 (colon-separated hex)"},"serial_via_JTAG":{"type":"number","description":"1 if serial is tunnelled over JTAG, 0 otherwise","enum":[0,1]}}}}}}
```

## Get runtime statistics

> Returns serial byte counters, TCP/UDP connection counts, connected station details (AP mode) or RSSI/IP (STA mode), flight-controller power and armed state, battery voltage and current, and CPU load.<br>

```json
{"openapi":"3.0.3","info":{"title":"DroneBridge ESP32 REST API","version":"1.0.0"},"tags":[{"name":"System","description":"Read-only system information and runtime statistics"}],"servers":[{"url":"http://192.168.2.1","description":"Default ESP32 AP address"}],"paths":{"/api/system/stats":{"get":{"tags":["System"],"summary":"Get runtime statistics","description":"Returns serial byte counters, TCP/UDP connection counts, connected station details (AP mode) or RSSI/IP (STA mode), flight-controller power and armed state, battery voltage and current, and CPU load.\n","operationId":"getSystemStats","responses":{"200":{"description":"Runtime stats retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemStats"}}}}}}}},"components":{"schemas":{"SystemStats":{"type":"object","description":"Runtime counters and connection status","properties":{"read_bytes":{"type":"number","description":"Total bytes read from the UART since last boot"},"tcp_connected":{"type":"number","description":"Number of currently connected TCP clients"},"udp_connected":{"type":"number","description":"Number of UDP destinations in the active client list"},"udp_clients":{"type":"array","description":"List of active UDP destinations as \"IP:port\" strings","items":{"type":"string"}},"current_client_ip":{"type":"string","description":"IP address of the ESP32 in STA mode (only present when radio_mode == DB_WIFI_MODE_STA)\n"},"esp_rssi":{"type":"number","description":"RSSI of the upstream AP in STA mode (only present when radio_mode == DB_WIFI_MODE_STA)\n"},"connected_sta":{"type":"array","description":"List of associated Wi-Fi stations (only present when radio_mode == DB_WIFI_MODE_AP or DB_WIFI_MODE_AP_LR)\n","items":{"$ref":"#/components/schemas/ConnectedStation"}},"fc_pw_state":{"type":"number","description":"Flight-controller power state. `1` = powered, `0` = unpowered, `-1` = power management disabled.\n"},"fc_armed_state":{"type":"number","description":"UAV armed state as reported by the power-management module. `0` = disarmed, `1` = armed.\n"},"battery_voltage":{"type":"number","description":"Battery voltage in volts (ADC measurement)"},"battery_current":{"type":"number","description":"Battery current in amperes (ADC measurement)"},"cpu_load":{"type":"number","description":"CPU utilisation percentage multiplied by 100 (0–100)"}}},"ConnectedStation":{"type":"object","description":"A single Wi-Fi station associated with the ESP32 AP","properties":{"sta_mac":{"type":"string","description":"MAC address of the station (colon-separated hex)"},"sta_rssi":{"type":"number","description":"RSSI of the station as seen by the AP"}}}}}}
```

## List active UDP client connections

> Returns the list of UDP IP:port pairs the ESP32 is currently forwarding data to.

```json
{"openapi":"3.0.3","info":{"title":"DroneBridge ESP32 REST API","version":"1.0.0"},"tags":[{"name":"System","description":"Read-only system information and runtime statistics"},{"name":"Clients","description":"Manage active UDP client connections"}],"servers":[{"url":"http://192.168.2.1","description":"Default ESP32 AP address"}],"paths":{"/api/system/clients":{"get":{"tags":["System","Clients"],"summary":"List active UDP client connections","description":"Returns the list of UDP IP:port pairs the ESP32 is currently forwarding data to.","operationId":"getSystemClients","responses":{"200":{"description":"Client list retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientList"}}}}}}}},"components":{"schemas":{"ClientList":{"type":"object","description":"Active UDP forwarding destinations","properties":{"udp_clients":{"type":"array","description":"List of \"IP:port\" strings","items":{"type":"string"}}}}}}}
```
