API reference - Revision history

Bcmwiki: Restructure: platform separation (ESP32 commercial prioritised, Raspberry Pi DIY in own section); verified against firmware/Pi source; complete serial command list

2026-06-08T18:59:35Z

Restructure: platform separation (ESP32 commercial prioritised, Raspberry Pi DIY in own section); verified against firmware/Pi source; complete serial command list

Show changes

Bcmwiki: Reframe: bcMeter (DIY) / source-available

2026-06-08T10:35:02Z

Reframe: bcMeter (DIY) / source-available

← Older revision		Revision as of 10:35, 8 June 2026
Line 3:		Line 3:
	The bcMeter exposes a REST API on port 80. All endpoints are accessible without authentication when connected to the device network. CORS is enabled for all GET requests (<code>allow_origins=["*"]</code>).		The bcMeter exposes a REST API on port 80. All endpoints are accessible without authentication when connected to the device network. CORS is enabled for all GET requests (<code>allow_origins=["*"]</code>).

	The software is ~~open~~ source: [https://github.com/dahljo/bcmeter github.com/dahljo/bcmeter]		The software is source-available — freely available for private, educational and research use (CC BY-NC 4.0): [https://github.com/dahljo/bcmeter github.com/dahljo/bcmeter]

	=== Status & Diagnostics ===		=== Status & Diagnostics ===

Bcmwiki: Update API reference to match current bcmeter-dev codebase: add incidents section to /api/logs, add identify/debug_mobile actions, add /api/maintenance-logs and /api/debug_mobile/status, add wifi/scan/refresh POST, update response schemas, add static routes, remove endpoints not in current codebase (cleanempty/export/factory_reset), add CORS note

2026-03-31T17:41:47Z

Update API reference to match current bcmeter-dev codebase: add incidents section to /api/logs, add identify/debug_mobile actions, add /api/maintenance-logs and /api/debug_mobile/status, add wifi/scan/refresh POST, update response schemas, add static routes, remove endpoints not in current codebase (cleanempty/export/factory_reset), add CORS note

Show changes

Bcmwiki: Fix hostname: bcmeter-XXXX.local (last 4 hex chars of MAC)

2026-03-08T18:38:56Z

Fix hostname: bcmeter-XXXX.local (last 4 hex chars of MAC)

← Older revision		Revision as of 18:38, 8 March 2026
Line 131:		Line 131:
	<pre>		<pre>
	# Sync time first		# Sync time first
	curl "http://bcmeter.local/api/control?action=synctime&ts=$(date +%s)&tz=Europe/Berlin"		curl "http://bcmeter-XXXX.local/api/control?action=synctime&ts=$(date +%s)&tz=Europe/Berlin"

	# Start measurement		# Start measurement
	curl "http://bcmeter.local/api/control?action=start"		curl "http://bcmeter-XXXX.local/api/control?action=start"

	# Poll status		# Poll status
	curl "http://bcmeter.local/api/status"		curl "http://bcmeter-XXXX.local/api/status"

	# Download current data		# Download current data
	curl "http://bcmeter.local/api/csv" -o measurement.csv		curl "http://bcmeter-XXXX.local/api/csv" -o measurement.csv
	</pre>		</pre>

Bcmwiki: Update: V1/V2 naming, remove ESP32/Pi distinction

2026-03-08T13:21:06Z

Update: V1/V2 naming, remove ESP32/Pi distinction

← Older revision		Revision as of 13:21, 8 March 2026
Line 1:		Line 1:
	== API Reference ==		== API Reference ==

	The bcMeter exposes a REST API on port 80. All endpoints are accessible without authentication when connected to the device network. ~~This API~~ is ~~identical between the ESP32 firmware and the~~ [https://github.com/dahljo/bcmeter~~-dev~~ bcmeter~~-dev~~] ~~open-source implementation.~~		The bcMeter exposes a REST API on port 80. All endpoints are accessible without authentication when connected to the device network.

			The software is open source: [https://github.com/dahljo/bcmeter github.com/dahljo/bcmeter]

	=== Status & Diagnostics ===		=== Status & Diagnostics ===
Line 78:		Line 80:
	\| GET \|\| <code>/api/control?action=cleanempty</code> \|\| Remove empty (0 byte) log files		\| GET \|\| <code>/api/control?action=cleanempty</code> \|\| Remove empty (0 byte) log files
	\|-		\|-
	\| GET \|\| <code>/api/control?action=export</code> \|\| Export all logs to SD card ~~(ESP32 only)~~		\| GET \|\| <code>/api/control?action=export</code> \|\| Export all logs to SD card
	\|}		\|}

Bcmwiki: Wiki update: sync with manual and dev docs (2026-03)

2026-03-08T13:10:07Z

Wiki update: sync with manual and dev docs (2026-03)

New page

== API Reference ==

The bcMeter exposes a REST API on port 80. All endpoints are accessible without authentication when connected to the device network. This API is identical between the ESP32 firmware and the [https://github.com/dahljo/bcmeter-dev bcmeter-dev] open-source implementation.

=== Status & Diagnostics ===

{| class="wikitable"
! Method !! Endpoint !! Description
|-
| GET || <code>/api/status</code> || Current measurement state, last sensor readings, error codes, sample count, WiFi mode, firmware version
|-
| GET || <code>/api/system</code> || Hardware info: MAC address, memory, time, last calibration, GPS position, barometric altitude
|-
| GET || <code>/api/logs</code> || Structured health report with sections: hardware, measurement, system, network
|}

=== Measurement Control ===

{| class="wikitable"
! Method !! Endpoint !! Description
|-
| GET || <code>/api/control?action=start</code> || Begin measurement session (requires time sync + calibration). Add <code>&force=1</code> to override preflight checks.
|-
| GET || <code>/api/control?action=stop</code> || Stop measurement and save session file
|-
| GET || <code>/api/control?action=calibrate</code> || Start calibration routine (async — poll <code>/api/calibration</code> for progress)
|-
| GET || <code>/api/calibration</code> || Calibration status: running, elapsed time, log output, success/failure
|-
| GET || <code>/api/control?action=clear_error</code> || Reset error state
|}

=== Configuration ===

{| class="wikitable"
! Method !! Endpoint !! Description
|-
| GET || <code>/api/config</code> || All settings as JSON. Each parameter includes type, value, label, tab, and description.
|-
| POST || <code>/api/config</code> || Update settings. JSON body with key-value pairs. Only changed values need to be sent.
|-
| POST || <code>/api/device/rename</code> || Set device name. Body: <code>{"name": "bcmeter01"}</code>
|-
| GET || <code>/api/control?action=synctime&ts=EPOCH&tz=IANA</code> || Sync device clock. <code>ts</code> = Unix timestamp, <code>tz</code> = IANA timezone string.
|}

=== WiFi Management ===

{| class="wikitable"
! Method !! Endpoint !! Description
|-
| GET || <code>/api/wifi/scan</code> || List nearby networks. Add <code>?refresh=1</code> to trigger a new scan.
|-
| GET || <code>/api/wifi/status</code> || Current connection: mode (sta/ap), SSID, IP address
|-
| POST || <code>/api/wifi/connect</code> || Connect to network. Body: <code>{"ssid": "...", "pass": "...", "hidden": false}</code>
|-
| GET || <code>/api/wifi/connect/status</code> || Connection progress: state, hostname, log messages
|-
| POST || <code>/api/wifi/delete</code> || Clear saved WiFi credentials, switch to AP mode
|-
| GET || <code>/api/ap-security</code> || Hotspot security settings: secured (bool), password
|-
| POST || <code>/api/ap-security</code> || Update hotspot password. Body: <code>{"secured": true, "password": "..."}</code>
|}

=== Data Management ===

{| class="wikitable"
! Method !! Endpoint !! Description
|-
| GET || <code>/api/csv</code> || Current session CSV data. Add <code>?file=FILENAME</code> for archived files.
|-
| GET || <code>/api/files</code> || List stored CSV logs as JSON: <code>[{"name": "...", "size": 1234}, ...]</code>
|-
| GET || <code>/api/control?action=cleardata</code> || Delete all stored log files
|-
| GET || <code>/api/control?action=cleanempty</code> || Remove empty (0 byte) log files
|-
| GET || <code>/api/control?action=export</code> || Export all logs to SD card (ESP32 only)
|}

=== Firmware Updates ===

{| class="wikitable"
! Method !! Endpoint !! Description
|-
| GET || <code>/api/ota/status</code> || Check if update available: version, release notes, apply state/progress
|-
| POST || <code>/api/ota/check</code> || Force check for new firmware
|-
| POST || <code>/api/ota/skip</code> || Skip current available update
|-
| POST || <code>/api/ota/apply</code> || Download and flash firmware update
|-
| POST || <code>/api/update</code> || Direct firmware upload (multipart form-data, .tar.gz)
|}

=== System Operations ===

{| class="wikitable"
! Method !! Endpoint !! Description
|-
| GET || <code>/api/control?action=reboot</code> || Reboot the device
|-
| GET || <code>/api/control?action=shutdown</code> || Safely shut down
|-
| GET || <code>/api/control?action=factory_reset</code> || Erase all data and settings, reboot to factory state
|-
| POST || <code>/api/email/validate</code> || Validate email API key. Body: <code>{"api_key": "..."}</code>
|}

=== Captive Portal ===

These endpoints handle captive portal detection on mobile devices:

{| class="wikitable"
! Endpoint !! Purpose
|-
| <code>/generate_204</code> || Android captive portal check
|-
| <code>/hotspot-detect.html</code> || Apple captive portal check
|-
| <code>/success.txt</code> || Generic connectivity probe
|}

=== Example: Start a Measurement ===

<pre>
# Sync time first
curl "http://bcmeter.local/api/control?action=synctime&ts=$(date +%s)&tz=Europe/Berlin"

# Start measurement
curl "http://bcmeter.local/api/control?action=start"

# Poll status
curl "http://bcmeter.local/api/status"

# Download current data
curl "http://bcmeter.local/api/csv" -o measurement.csv
</pre>