Settings

Read and write device configuration

Get all device settings

get

Returns all internally stored configuration parameters together with their data-type metadata. The exact set of keys mirrors the firmware's settings.csv table that is used to flash the firmware with pre-applied settings.

Responses

200

Settings retrieved successfully

application/json

Response to GET /api/settings.

and

get

/api/settings

HTTPcURLJavaScriptPython

GET /api/settings HTTP/1.1
Host: 192.168.2.1
Accept: */*

200

Settings retrieved successfully

{
  "esp32_mode": 1,
  "ssid": "MyNetwork",
  "ssid_ap": "DroneBridge for ESP32",
  "wifi_pass": "dronebridge",
  "wifi_pass_ap": "dronebridge",
  "ap_ip": "192.168.2.1",
  "ip_sta": "192.168.1.50",
  "ip_sta_gw": "192.168.1.1",
  "ip_sta_netmsk": "255.255.255.0",
  "udp_client_ip": "192.168.2.255",
  "wifi_hostname": "dronebridge",
  "wifi_chan": "number",
  "wifi_en_gn": 0,
  "wifi_dis_udpdet": 0,
  "udp_local_port": 14555,
  "wifi_brcst_nudp": 1,
  "wifi_brcst_port": 14550,
  "radio_ant_selec": 0,
  "radio_ant_sw": 0,
  "radio_ant_en": 0,
  "baud": "number",
  "gpio_tx": 17,
  "gpio_rx": 16,
  "gpio_rts": 1,
  "gpio_cts": 1,
  "rts_thresh": 127,
  "proto": "number",
  "trans_pack_size": 576,
  "serial_timeout": 50,
  "udp_client_port": 0,
  "rep_rssi_dbm": 1,
  "show_det_flash": 1,
  "show_ap_fail_to": 90000,
  "show_pm_en_hb": 1,
  "show_pm_en": 0,
  "show_pm_gpio": 1,
  "show_pm_logic": 0,
  "show_pm_pulse_l": 0,
  "show_pm_qu_gpio": 0,
  "show_pm_en_emcy": 0,
  "show_en_syid_ip": 1,
  "show_man_sysid": 1,
  "adc_v_en": 0,
  "adc_v_gpio": 0,
  "adc_v_multi": 110,
  "adc_a_en": 0,
  "adc_a_gpio": 0,
  "adc_a_multi": 36364
}

Update device settings

post

Accepts a JSON object whose keys are parameter names. Only the keys that are present are updated; all others keep their current values. The device will reboot automatically after persisting the new settings. Returns an error if the drone is currently armed.

Body

application/json

Body for POST /api/settings. Send only the keys you want to change; all others keep their current values. Key names must exactly match the db_name field of the firmware parameter table.

Responses

200

Settings accepted; device will reboot

application/json

Generic status/message response used by several endpoints

statusstring · enumOptionalExample: successPossible values:

msgstringOptionalExample: Settings changed! Rebooting ...

400

Request body too large (≥ 10 240 bytes)

text/plain

422

Drone is armed – settings cannot be changed while armed

application/json

500

Internal server error while receiving data

text/plain

post

/api/settings

HTTPcURLJavaScriptPython

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

{
  "wifi_ssid": "MyDrone",
  "wifi_pass": "secret123"
}

{
  "status": "success",
  "msg": "Settings changed! Rebooting ..."
}