Skip to content

API_REFERENCE.md

Latest commit

 

History

History
110 lines (82 loc) · 1.35 KB

API_REFERENCE.md

File metadata and controls

110 lines (82 loc) · 1.35 KB

ESP32-Mapper WiFi API Reference

Base URL (default): http://192.168.4.1

GET /status

Returns scanner health and metadata.

Response Fields

  • ok (bool)
  • device_id (string)
  • firmware (string)
  • scan_network_types (string)
  • in_progress (bool)
  • last_command (string)
  • last_command_at_ms (number)
  • last_scan_finished_ms (number)
  • last_scan_count (number)
  • uptime_ms (number)
  • ip (string)

POST /configure

Applies runtime scan settings.

Request

{
  "interval_ms": 5000,
  "min_rssi": -88,
  "max_results": 80
}

Response

{
  "ok": true,
  "interval_ms": 5000,
  "min_rssi": -88,
  "max_results": 80
}

POST /scan/start

Starts an asynchronous scan cycle.

Response

{
  "ok": true,
  "started": true,
  "last_command": "start",
  "in_progress": true
}

POST /scan/stop

Stops scan execution.

Response

{
  "ok": true,
  "stopped": true,
  "last_command": "stop",
  "in_progress": false
}

GET /scan/results

Returns current scan state and latest network list.

Network Item Fields

  • ssid
  • bssid
  • rssi
  • channel
  • frequency_mhz
  • security
  • encryption

Error Model

Generic error payload:

{
  "ok": false,
  "error": "not_found"
}

or

{
  "ok": false,
  "error": "invalid_json"
}